add items_count for toolbar to bypase O(N) counting on an inlist
[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    EAPI void         elm_cache_flush_interval_all_set(int size);
1567
1568    /**
1569     * Get the configured cache flush enabled state
1570     *
1571     * This gets the globally configured cache flush state - if it is enabled
1572     * or not. When cache flushing is enabled, elementary will regularly
1573     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1574     * memory and allow usage to re-seed caches and data in memory where it
1575     * can do so. An idle application will thus minimise its memory usage as
1576     * data will be freed from memory and not be re-loaded as it is idle and
1577     * not rendering or doing anything graphically right now.
1578     *
1579     * @return The cache flush state
1580     * @ingroup Caches
1581     *
1582     * @see elm_all_flush()
1583     */
1584    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1585
1586    /**
1587     * Set the configured cache flush enabled state
1588     *
1589     * This sets the globally configured cache flush enabled state.
1590     *
1591     * @param size The cache flush enabled state
1592     * @ingroup Caches
1593     *
1594     * @see elm_all_flush()
1595     */
1596    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1597
1598    /**
1599     * Set the configured cache flush enabled state for all applications on the
1600     * display
1601     *
1602     * This sets the globally configured cache flush enabled state for all
1603     * applications on the display.
1604     *
1605     * @param size The cache flush enabled state
1606     * @ingroup Caches
1607     */
1608    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1609
1610    /**
1611     * Get the configured font cache size
1612     *
1613     * This gets the globally configured font cache size, in bytes.
1614     *
1615     * @return The font cache size
1616     * @ingroup Caches
1617     */
1618    EAPI int          elm_font_cache_get(void);
1619
1620    /**
1621     * Set the configured font cache size
1622     *
1623     * This sets the globally configured font cache size, in bytes
1624     *
1625     * @param size The font cache size
1626     * @ingroup Caches
1627     */
1628    EAPI void         elm_font_cache_set(int size);
1629
1630    /**
1631     * Set the configured font cache size for all applications on the
1632     * display
1633     *
1634     * This sets the globally configured font cache size -- in bytes
1635     * -- for all applications on the display.
1636     *
1637     * @param size The font cache size
1638     * @ingroup Caches
1639     */
1640    EAPI void         elm_font_cache_all_set(int size);
1641
1642    /**
1643     * Get the configured image cache size
1644     *
1645     * This gets the globally configured image cache size, in bytes
1646     *
1647     * @return The image cache size
1648     * @ingroup Caches
1649     */
1650    EAPI int          elm_image_cache_get(void);
1651
1652    /**
1653     * Set the configured image cache size
1654     *
1655     * This sets the globally configured image cache size, in bytes
1656     *
1657     * @param size The image cache size
1658     * @ingroup Caches
1659     */
1660    EAPI void         elm_image_cache_set(int size);
1661
1662    /**
1663     * Set the configured image cache size for all applications on the
1664     * display
1665     *
1666     * This sets the globally configured image cache size -- in bytes
1667     * -- for all applications on the display.
1668     *
1669     * @param size The image cache size
1670     * @ingroup Caches
1671     */
1672    EAPI void         elm_image_cache_all_set(int size);
1673
1674    /**
1675     * Get the configured edje file cache size.
1676     *
1677     * This gets the globally configured edje file cache size, in number
1678     * of files.
1679     *
1680     * @return The edje file cache size
1681     * @ingroup Caches
1682     */
1683    EAPI int          elm_edje_file_cache_get(void);
1684
1685    /**
1686     * Set the configured edje file cache size
1687     *
1688     * This sets the globally configured edje file cache size, in number
1689     * of files.
1690     *
1691     * @param size The edje file cache size
1692     * @ingroup Caches
1693     */
1694    EAPI void         elm_edje_file_cache_set(int size);
1695
1696    /**
1697     * Set the configured edje file cache size for all applications on the
1698     * display
1699     *
1700     * This sets the globally configured edje file cache size -- in number
1701     * of files -- for all applications on the display.
1702     *
1703     * @param size The edje file cache size
1704     * @ingroup Caches
1705     */
1706    EAPI void         elm_edje_file_cache_all_set(int size);
1707
1708    /**
1709     * Get the configured edje collections (groups) cache size.
1710     *
1711     * This gets the globally configured edje collections cache size, in
1712     * number of collections.
1713     *
1714     * @return The edje collections cache size
1715     * @ingroup Caches
1716     */
1717    EAPI int          elm_edje_collection_cache_get(void);
1718
1719    /**
1720     * Set the configured edje collections (groups) cache size
1721     *
1722     * This sets the globally configured edje collections cache size, in
1723     * number of collections.
1724     *
1725     * @param size The edje collections cache size
1726     * @ingroup Caches
1727     */
1728    EAPI void         elm_edje_collection_cache_set(int size);
1729
1730    /**
1731     * Set the configured edje collections (groups) cache size for all
1732     * applications on the display
1733     *
1734     * This sets the globally configured edje collections cache size -- in
1735     * number of collections -- for all applications on the display.
1736     *
1737     * @param size The edje collections cache size
1738     * @ingroup Caches
1739     */
1740    EAPI void         elm_edje_collection_cache_all_set(int size);
1741
1742    /**
1743     * @}
1744     */
1745
1746    /**
1747     * @defgroup Scaling Widget Scaling
1748     *
1749     * Different widgets can be scaled independently. These functions
1750     * allow you to manipulate this scaling on a per-widget basis. The
1751     * object and all its children get their scaling factors multiplied
1752     * by the scale factor set. This is multiplicative, in that if a
1753     * child also has a scale size set it is in turn multiplied by its
1754     * parent's scale size. @c 1.0 means ā€œdon't scaleā€, @c 2.0 is
1755     * double size, @c 0.5 is half, etc.
1756     *
1757     * @ref general_functions_example_page "This" example contemplates
1758     * some of these functions.
1759     */
1760
1761    /**
1762     * Get the global scaling factor
1763     *
1764     * This gets the globally configured scaling factor that is applied to all
1765     * objects.
1766     *
1767     * @return The scaling factor
1768     * @ingroup Scaling
1769     */
1770    EAPI double       elm_scale_get(void);
1771
1772    /**
1773     * Set the global scaling factor
1774     *
1775     * This sets the globally configured scaling factor that is applied to all
1776     * objects.
1777     *
1778     * @param scale The scaling factor to set
1779     * @ingroup Scaling
1780     */
1781    EAPI void         elm_scale_set(double scale);
1782
1783    /**
1784     * Set the global scaling factor for all applications on the display
1785     *
1786     * This sets the globally configured scaling factor that is applied to all
1787     * objects for all applications.
1788     * @param scale The scaling factor to set
1789     * @ingroup Scaling
1790     */
1791    EAPI void         elm_scale_all_set(double scale);
1792
1793    /**
1794     * Set the scaling factor for a given Elementary object
1795     *
1796     * @param obj The Elementary to operate on
1797     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1798     * no scaling)
1799     *
1800     * @ingroup Scaling
1801     */
1802    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1803
1804    /**
1805     * Get the scaling factor for a given Elementary object
1806     *
1807     * @param obj The object
1808     * @return The scaling factor set by elm_object_scale_set()
1809     *
1810     * @ingroup Scaling
1811     */
1812    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1813
1814    /**
1815     * @defgroup Password_last_show Password last input show
1816     *
1817     * Last show feature of password mode enables user to view
1818     * the last input entered for few seconds before masking it.
1819     * These functions allow to set this feature in password mode
1820     * of entry widget and also allow to manipulate the duration
1821     * for which the input has to be visible.
1822     *
1823     * @{
1824     */
1825
1826    /**
1827     * Get show last setting of password mode.
1828     *
1829     * This gets the show last input setting of password mode which might be
1830     * enabled or disabled.
1831     *
1832     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1833     *            if it's disabled.
1834     * @ingroup Password_last_show
1835     */
1836    EAPI Eina_Bool elm_password_show_last_get(void);
1837
1838    /**
1839     * Set show last setting in password mode.
1840     *
1841     * This enables or disables show last setting of password mode.
1842     *
1843     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1844     * @see elm_password_show_last_timeout_set()
1845     * @ingroup Password_last_show
1846     */
1847    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1848
1849    /**
1850     * Get's the timeout value in last show password mode.
1851     *
1852     * This gets the time out value for which the last input entered in password
1853     * mode will be visible.
1854     *
1855     * @return The timeout value of last show password mode.
1856     * @ingroup Password_last_show
1857     */
1858    EAPI double elm_password_show_last_timeout_get(void);
1859
1860    /**
1861     * Set's the timeout value in last show password mode.
1862     *
1863     * This sets the time out value for which the last input entered in password
1864     * mode will be visible.
1865     *
1866     * @param password_show_last_timeout The timeout value.
1867     * @see elm_password_show_last_set()
1868     * @ingroup Password_last_show
1869     */
1870    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1871
1872    /**
1873     * @}
1874     */
1875
1876    /**
1877     * @defgroup UI-Mirroring Selective Widget mirroring
1878     *
1879     * These functions allow you to set ui-mirroring on specific
1880     * widgets or the whole interface. Widgets can be in one of two
1881     * modes, automatic and manual.  Automatic means they'll be changed
1882     * according to the system mirroring mode and manual means only
1883     * explicit changes will matter. You are not supposed to change
1884     * mirroring state of a widget set to automatic, will mostly work,
1885     * but the behavior is not really defined.
1886     *
1887     * @{
1888     */
1889
1890    EAPI Eina_Bool    elm_mirrored_get(void);
1891    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1892
1893    /**
1894     * Get the system mirrored mode. This determines the default mirrored mode
1895     * of widgets.
1896     *
1897     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1898     */
1899    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1900
1901    /**
1902     * Set the system mirrored mode. This determines the default mirrored mode
1903     * of widgets.
1904     *
1905     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1906     */
1907    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1908
1909    /**
1910     * Returns the widget's mirrored mode setting.
1911     *
1912     * @param obj The widget.
1913     * @return mirrored mode setting of the object.
1914     *
1915     **/
1916    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1917
1918    /**
1919     * Sets the widget's mirrored mode setting.
1920     * When widget in automatic mode, it follows the system mirrored mode set by
1921     * elm_mirrored_set().
1922     * @param obj The widget.
1923     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1924     */
1925    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1926
1927    /**
1928     * @}
1929     */
1930
1931    /**
1932     * Set the style to use by a widget
1933     *
1934     * Sets the style name that will define the appearance of a widget. Styles
1935     * vary from widget to widget and may also be defined by other themes
1936     * by means of extensions and overlays.
1937     *
1938     * @param obj The Elementary widget to style
1939     * @param style The style name to use
1940     *
1941     * @see elm_theme_extension_add()
1942     * @see elm_theme_extension_del()
1943     * @see elm_theme_overlay_add()
1944     * @see elm_theme_overlay_del()
1945     *
1946     * @ingroup Styles
1947     */
1948    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1949    /**
1950     * Get the style used by the widget
1951     *
1952     * This gets the style being used for that widget. Note that the string
1953     * pointer is only valid as longas the object is valid and the style doesn't
1954     * change.
1955     *
1956     * @param obj The Elementary widget to query for its style
1957     * @return The style name used
1958     *
1959     * @see elm_object_style_set()
1960     *
1961     * @ingroup Styles
1962     */
1963    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1964
1965    /**
1966     * @defgroup Styles Styles
1967     *
1968     * Widgets can have different styles of look. These generic API's
1969     * set styles of widgets, if they support them (and if the theme(s)
1970     * do).
1971     *
1972     * @ref general_functions_example_page "This" example contemplates
1973     * some of these functions.
1974     */
1975
1976    /**
1977     * Set the disabled state of an Elementary object.
1978     *
1979     * @param obj The Elementary object to operate on
1980     * @param disabled The state to put in in: @c EINA_TRUE for
1981     *        disabled, @c EINA_FALSE for enabled
1982     *
1983     * Elementary objects can be @b disabled, in which state they won't
1984     * receive input and, in general, will be themed differently from
1985     * their normal state, usually greyed out. Useful for contexts
1986     * where you don't want your users to interact with some of the
1987     * parts of you interface.
1988     *
1989     * This sets the state for the widget, either disabling it or
1990     * enabling it back.
1991     *
1992     * @ingroup Styles
1993     */
1994    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1995
1996    /**
1997     * Get the disabled state of an Elementary object.
1998     *
1999     * @param obj The Elementary object to operate on
2000     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
2001     *            if it's enabled (or on errors)
2002     *
2003     * This gets the state of the widget, which might be enabled or disabled.
2004     *
2005     * @ingroup Styles
2006     */
2007    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2008
2009    /**
2010     * @defgroup WidgetNavigation Widget Tree Navigation.
2011     *
2012     * How to check if an Evas Object is an Elementary widget? How to
2013     * get the first elementary widget that is parent of the given
2014     * object?  These are all covered in widget tree navigation.
2015     *
2016     * @ref general_functions_example_page "This" example contemplates
2017     * some of these functions.
2018     */
2019
2020    /**
2021     * Check if the given Evas Object is an Elementary widget.
2022     *
2023     * @param obj the object to query.
2024     * @return @c EINA_TRUE if it is an elementary widget variant,
2025     *         @c EINA_FALSE otherwise
2026     * @ingroup WidgetNavigation
2027     */
2028    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2029
2030    /**
2031     * Get the first parent of the given object that is an Elementary
2032     * widget.
2033     *
2034     * @param obj the Elementary object to query parent from.
2035     * @return the parent object that is an Elementary widget, or @c
2036     *         NULL, if it was not found.
2037     *
2038     * Use this to query for an object's parent widget.
2039     *
2040     * @note Most of Elementary users wouldn't be mixing non-Elementary
2041     * smart objects in the objects tree of an application, as this is
2042     * an advanced usage of Elementary with Evas. So, except for the
2043     * application's window, which is the root of that tree, all other
2044     * objects would have valid Elementary widget parents.
2045     *
2046     * @ingroup WidgetNavigation
2047     */
2048    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2049
2050    /**
2051     * Get the top level parent of an Elementary widget.
2052     *
2053     * @param obj The object to query.
2054     * @return The top level Elementary widget, or @c NULL if parent cannot be
2055     * found.
2056     * @ingroup WidgetNavigation
2057     */
2058    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2059
2060    /**
2061     * Get the string that represents this Elementary widget.
2062     *
2063     * @note Elementary is weird and exposes itself as a single
2064     *       Evas_Object_Smart_Class of type "elm_widget", so
2065     *       evas_object_type_get() always return that, making debug and
2066     *       language bindings hard. This function tries to mitigate this
2067     *       problem, but the solution is to change Elementary to use
2068     *       proper inheritance.
2069     *
2070     * @param obj the object to query.
2071     * @return Elementary widget name, or @c NULL if not a valid widget.
2072     * @ingroup WidgetNavigation
2073     */
2074    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2075
2076    /**
2077     * @defgroup Config Elementary Config
2078     *
2079     * Elementary configuration is formed by a set options bounded to a
2080     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
2081     * "finger size", etc. These are functions with which one syncronizes
2082     * changes made to those values to the configuration storing files, de
2083     * facto. You most probably don't want to use the functions in this
2084     * group unlees you're writing an elementary configuration manager.
2085     *
2086     * @{
2087     */
2088
2089    /**
2090     * Save back Elementary's configuration, so that it will persist on
2091     * future sessions.
2092     *
2093     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2094     * @ingroup Config
2095     *
2096     * This function will take effect -- thus, do I/O -- immediately. Use
2097     * it when you want to apply all configuration changes at once. The
2098     * current configuration set will get saved onto the current profile
2099     * configuration file.
2100     *
2101     */
2102    EAPI Eina_Bool    elm_config_save(void);
2103
2104    /**
2105     * Reload Elementary's configuration, bounded to current selected
2106     * profile.
2107     *
2108     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2109     * @ingroup Config
2110     *
2111     * Useful when you want to force reloading of configuration values for
2112     * a profile. If one removes user custom configuration directories,
2113     * for example, it will force a reload with system values instead.
2114     *
2115     */
2116    EAPI void         elm_config_reload(void);
2117
2118    /**
2119     * @}
2120     */
2121
2122    /**
2123     * @defgroup Profile Elementary Profile
2124     *
2125     * Profiles are pre-set options that affect the whole look-and-feel of
2126     * Elementary-based applications. There are, for example, profiles
2127     * aimed at desktop computer applications and others aimed at mobile,
2128     * touchscreen-based ones. You most probably don't want to use the
2129     * functions in this group unlees you're writing an elementary
2130     * configuration manager.
2131     *
2132     * @{
2133     */
2134
2135    /**
2136     * Get Elementary's profile in use.
2137     *
2138     * This gets the global profile that is applied to all Elementary
2139     * applications.
2140     *
2141     * @return The profile's name
2142     * @ingroup Profile
2143     */
2144    EAPI const char  *elm_profile_current_get(void);
2145
2146    /**
2147     * Get an Elementary's profile directory path in the filesystem. One
2148     * may want to fetch a system profile's dir or an user one (fetched
2149     * inside $HOME).
2150     *
2151     * @param profile The profile's name
2152     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2153     *                or a system one (@c EINA_FALSE)
2154     * @return The profile's directory path.
2155     * @ingroup Profile
2156     *
2157     * @note You must free it with elm_profile_dir_free().
2158     */
2159    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2160
2161    /**
2162     * Free an Elementary's profile directory path, as returned by
2163     * elm_profile_dir_get().
2164     *
2165     * @param p_dir The profile's path
2166     * @ingroup Profile
2167     *
2168     */
2169    EAPI void         elm_profile_dir_free(const char *p_dir);
2170
2171    /**
2172     * Get Elementary's list of available profiles.
2173     *
2174     * @return The profiles list. List node data are the profile name
2175     *         strings.
2176     * @ingroup Profile
2177     *
2178     * @note One must free this list, after usage, with the function
2179     *       elm_profile_list_free().
2180     */
2181    EAPI Eina_List   *elm_profile_list_get(void);
2182
2183    /**
2184     * Free Elementary's list of available profiles.
2185     *
2186     * @param l The profiles list, as returned by elm_profile_list_get().
2187     * @ingroup Profile
2188     *
2189     */
2190    EAPI void         elm_profile_list_free(Eina_List *l);
2191
2192    /**
2193     * Set Elementary's profile.
2194     *
2195     * This sets the global profile that is applied to Elementary
2196     * applications. Just the process the call comes from will be
2197     * affected.
2198     *
2199     * @param profile The profile's name
2200     * @ingroup Profile
2201     *
2202     */
2203    EAPI void         elm_profile_set(const char *profile);
2204
2205    /**
2206     * Set Elementary's profile.
2207     *
2208     * This sets the global profile that is applied to all Elementary
2209     * applications. All running Elementary windows will be affected.
2210     *
2211     * @param profile The profile's name
2212     * @ingroup Profile
2213     *
2214     */
2215    EAPI void         elm_profile_all_set(const char *profile);
2216
2217    /**
2218     * @}
2219     */
2220
2221    /**
2222     * @defgroup Engine Elementary Engine
2223     *
2224     * These are functions setting and querying which rendering engine
2225     * Elementary will use for drawing its windows' pixels.
2226     *
2227     * The following are the available engines:
2228     * @li "software_x11"
2229     * @li "fb"
2230     * @li "directfb"
2231     * @li "software_16_x11"
2232     * @li "software_8_x11"
2233     * @li "xrender_x11"
2234     * @li "opengl_x11"
2235     * @li "software_gdi"
2236     * @li "software_16_wince_gdi"
2237     * @li "sdl"
2238     * @li "software_16_sdl"
2239     * @li "opengl_sdl"
2240     * @li "buffer"
2241     * @li "ews"
2242     * @li "opengl_cocoa"
2243     * @li "psl1ght"
2244     *
2245     * @{
2246     */
2247
2248    /**
2249     * @brief Get Elementary's rendering engine in use.
2250     *
2251     * @return The rendering engine's name
2252     * @note there's no need to free the returned string, here.
2253     *
2254     * This gets the global rendering engine that is applied to all Elementary
2255     * applications.
2256     *
2257     * @see elm_engine_set()
2258     */
2259    EAPI const char  *elm_engine_current_get(void);
2260
2261    /**
2262     * @brief Set Elementary's rendering engine for use.
2263     *
2264     * @param engine The rendering engine's name
2265     *
2266     * This sets global rendering engine that is applied to all Elementary
2267     * applications. Note that it will take effect only to Elementary windows
2268     * created after this is called.
2269     *
2270     * @see elm_win_add()
2271     */
2272    EAPI void         elm_engine_set(const char *engine);
2273
2274    /**
2275     * @}
2276     */
2277
2278    /**
2279     * @defgroup Fonts Elementary Fonts
2280     *
2281     * These are functions dealing with font rendering, selection and the
2282     * like for Elementary applications. One might fetch which system
2283     * fonts are there to use and set custom fonts for individual classes
2284     * of UI items containing text (text classes).
2285     *
2286     * @{
2287     */
2288
2289   typedef struct _Elm_Text_Class
2290     {
2291        const char *name;
2292        const char *desc;
2293     } Elm_Text_Class;
2294
2295   typedef struct _Elm_Font_Overlay
2296     {
2297        const char     *text_class;
2298        const char     *font;
2299        Evas_Font_Size  size;
2300     } Elm_Font_Overlay;
2301
2302   typedef struct _Elm_Font_Properties
2303     {
2304        const char *name;
2305        Eina_List  *styles;
2306     } Elm_Font_Properties;
2307
2308    /**
2309     * Get Elementary's list of supported text classes.
2310     *
2311     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2312     * @ingroup Fonts
2313     *
2314     * Release the list with elm_text_classes_list_free().
2315     */
2316    EAPI const Eina_List     *elm_text_classes_list_get(void);
2317
2318    /**
2319     * Free Elementary's list of supported text classes.
2320     *
2321     * @ingroup Fonts
2322     *
2323     * @see elm_text_classes_list_get().
2324     */
2325    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2326
2327    /**
2328     * Get Elementary's list of font overlays, set with
2329     * elm_font_overlay_set().
2330     *
2331     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2332     * data.
2333     *
2334     * @ingroup Fonts
2335     *
2336     * For each text class, one can set a <b>font overlay</b> for it,
2337     * overriding the default font properties for that class coming from
2338     * the theme in use. There is no need to free this list.
2339     *
2340     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2341     */
2342    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2343
2344    /**
2345     * Set a font overlay for a given Elementary text class.
2346     *
2347     * @param text_class Text class name
2348     * @param font Font name and style string
2349     * @param size Font size
2350     *
2351     * @ingroup Fonts
2352     *
2353     * @p font has to be in the format returned by
2354     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2355     * and elm_font_overlay_unset().
2356     */
2357    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2358
2359    /**
2360     * Unset a font overlay for a given Elementary text class.
2361     *
2362     * @param text_class Text class name
2363     *
2364     * @ingroup Fonts
2365     *
2366     * This will bring back text elements belonging to text class
2367     * @p text_class back to their default font settings.
2368     */
2369    EAPI void                 elm_font_overlay_unset(const char *text_class);
2370
2371    /**
2372     * Apply the changes made with elm_font_overlay_set() and
2373     * elm_font_overlay_unset() on the current Elementary window.
2374     *
2375     * @ingroup Fonts
2376     *
2377     * This applies all font overlays set to all objects in the UI.
2378     */
2379    EAPI void                 elm_font_overlay_apply(void);
2380
2381    /**
2382     * Apply the changes made with elm_font_overlay_set() and
2383     * elm_font_overlay_unset() on all Elementary application windows.
2384     *
2385     * @ingroup Fonts
2386     *
2387     * This applies all font overlays set to all objects in the UI.
2388     */
2389    EAPI void                 elm_font_overlay_all_apply(void);
2390
2391    /**
2392     * Translate a font (family) name string in fontconfig's font names
2393     * syntax into an @c Elm_Font_Properties struct.
2394     *
2395     * @param font The font name and styles string
2396     * @return the font properties struct
2397     *
2398     * @ingroup Fonts
2399     *
2400     * @note The reverse translation can be achived with
2401     * elm_font_fontconfig_name_get(), for one style only (single font
2402     * instance, not family).
2403     */
2404    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2405
2406    /**
2407     * Free font properties return by elm_font_properties_get().
2408     *
2409     * @param efp the font properties struct
2410     *
2411     * @ingroup Fonts
2412     */
2413    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2414
2415    /**
2416     * Translate a font name, bound to a style, into fontconfig's font names
2417     * syntax.
2418     *
2419     * @param name The font (family) name
2420     * @param style The given style (may be @c NULL)
2421     *
2422     * @return the font name and style string
2423     *
2424     * @ingroup Fonts
2425     *
2426     * @note The reverse translation can be achived with
2427     * elm_font_properties_get(), for one style only (single font
2428     * instance, not family).
2429     */
2430    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2431
2432    /**
2433     * Free the font string return by elm_font_fontconfig_name_get().
2434     *
2435     * @param efp the font properties struct
2436     *
2437     * @ingroup Fonts
2438     */
2439    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2440
2441    /**
2442     * Create a font hash table of available system fonts.
2443     *
2444     * One must call it with @p list being the return value of
2445     * evas_font_available_list(). The hash will be indexed by font
2446     * (family) names, being its values @c Elm_Font_Properties blobs.
2447     *
2448     * @param list The list of available system fonts, as returned by
2449     * evas_font_available_list().
2450     * @return the font hash.
2451     *
2452     * @ingroup Fonts
2453     *
2454     * @note The user is supposed to get it populated at least with 3
2455     * default font families (Sans, Serif, Monospace), which should be
2456     * present on most systems.
2457     */
2458    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2459
2460    /**
2461     * Free the hash return by elm_font_available_hash_add().
2462     *
2463     * @param hash the hash to be freed.
2464     *
2465     * @ingroup Fonts
2466     */
2467    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2468
2469    /**
2470     * @}
2471     */
2472
2473    /**
2474     * @defgroup Fingers Fingers
2475     *
2476     * Elementary is designed to be finger-friendly for touchscreens,
2477     * and so in addition to scaling for display resolution, it can
2478     * also scale based on finger "resolution" (or size). You can then
2479     * customize the granularity of the areas meant to receive clicks
2480     * on touchscreens.
2481     *
2482     * Different profiles may have pre-set values for finger sizes.
2483     *
2484     * @ref general_functions_example_page "This" example contemplates
2485     * some of these functions.
2486     *
2487     * @{
2488     */
2489
2490    /**
2491     * Get the configured "finger size"
2492     *
2493     * @return The finger size
2494     *
2495     * This gets the globally configured finger size, <b>in pixels</b>
2496     *
2497     * @ingroup Fingers
2498     */
2499    EAPI Evas_Coord       elm_finger_size_get(void);
2500
2501    /**
2502     * Set the configured finger size
2503     *
2504     * This sets the globally configured finger size in pixels
2505     *
2506     * @param size The finger size
2507     * @ingroup Fingers
2508     */
2509    EAPI void             elm_finger_size_set(Evas_Coord size);
2510
2511    /**
2512     * Set the configured finger size for all applications on the display
2513     *
2514     * This sets the globally configured finger size in pixels for all
2515     * applications on the display
2516     *
2517     * @param size The finger size
2518     * @ingroup Fingers
2519     */
2520    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2521
2522    /**
2523     * @}
2524     */
2525
2526    /**
2527     * @defgroup Focus Focus
2528     *
2529     * An Elementary application has, at all times, one (and only one)
2530     * @b focused object. This is what determines where the input
2531     * events go to within the application's window. Also, focused
2532     * objects can be decorated differently, in order to signal to the
2533     * user where the input is, at a given moment.
2534     *
2535     * Elementary applications also have the concept of <b>focus
2536     * chain</b>: one can cycle through all the windows' focusable
2537     * objects by input (tab key) or programmatically. The default
2538     * focus chain for an application is the one define by the order in
2539     * which the widgets where added in code. One will cycle through
2540     * top level widgets, and, for each one containg sub-objects, cycle
2541     * through them all, before returning to the level
2542     * above. Elementary also allows one to set @b custom focus chains
2543     * for their applications.
2544     *
2545     * Besides the focused decoration a widget may exhibit, when it
2546     * gets focus, Elementary has a @b global focus highlight object
2547     * that can be enabled for a window. If one chooses to do so, this
2548     * extra highlight effect will surround the current focused object,
2549     * too.
2550     *
2551     * @note Some Elementary widgets are @b unfocusable, after
2552     * creation, by their very nature: they are not meant to be
2553     * interacted with input events, but are there just for visual
2554     * purposes.
2555     *
2556     * @ref general_functions_example_page "This" example contemplates
2557     * some of these functions.
2558     */
2559
2560    /**
2561     * Get the enable status of the focus highlight
2562     *
2563     * This gets whether the highlight on focused objects is enabled or not
2564     * @ingroup Focus
2565     */
2566    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2567
2568    /**
2569     * Set the enable status of the focus highlight
2570     *
2571     * Set whether to show or not the highlight on focused objects
2572     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2573     * @ingroup Focus
2574     */
2575    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2576
2577    /**
2578     * Get the enable status of the highlight animation
2579     *
2580     * Get whether the focus highlight, if enabled, will animate its switch from
2581     * one object to the next
2582     * @ingroup Focus
2583     */
2584    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2585
2586    /**
2587     * Set the enable status of the highlight animation
2588     *
2589     * Set whether the focus highlight, if enabled, will animate its switch from
2590     * one object to the next
2591     * @param animate Enable animation if EINA_TRUE, disable otherwise
2592     * @ingroup Focus
2593     */
2594    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2595
2596    /**
2597     * Get the whether an Elementary object has the focus or not.
2598     *
2599     * @param obj The Elementary object to get the information from
2600     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2601     *            not (and on errors).
2602     *
2603     * @see elm_object_focus_set()
2604     *
2605     * @ingroup Focus
2606     */
2607    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2608
2609    /**
2610     * Set/unset focus to a given Elementary object.
2611     *
2612     * @param obj The Elementary object to operate on.
2613     * @param enable @c EINA_TRUE Set focus to a given object,
2614     *               @c EINA_FALSE Unset focus to a given object.
2615     *
2616     * @note When you set focus to this object, if it can handle focus, will
2617     * take the focus away from the one who had it previously and will, for
2618     * now on, be the one receiving input events. Unsetting focus will remove
2619     * the focus from @p obj, passing it back to the previous element in the
2620     * focus chain list.
2621     *
2622     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2623     *
2624     * @ingroup Focus
2625     */
2626    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2627
2628    /**
2629     * Make a given Elementary object the focused one.
2630     *
2631     * @param obj The Elementary object to make focused.
2632     *
2633     * @note This object, if it can handle focus, will take the focus
2634     * away from the one who had it previously and will, for now on, be
2635     * the one receiving input events.
2636     *
2637     * @see elm_object_focus_get()
2638     * @deprecated use elm_object_focus_set() instead.
2639     *
2640     * @ingroup Focus
2641     */
2642    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2643
2644    /**
2645     * Remove the focus from an Elementary object
2646     *
2647     * @param obj The Elementary to take focus from
2648     *
2649     * This removes the focus from @p obj, passing it back to the
2650     * previous element in the focus chain list.
2651     *
2652     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2653     * @deprecated use elm_object_focus_set() instead.
2654     *
2655     * @ingroup Focus
2656     */
2657    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2658
2659    /**
2660     * Set the ability for an Element object to be focused
2661     *
2662     * @param obj The Elementary object to operate on
2663     * @param enable @c EINA_TRUE if the object can be focused, @c
2664     *        EINA_FALSE if not (and on errors)
2665     *
2666     * This sets whether the object @p obj is able to take focus or
2667     * not. Unfocusable objects do nothing when programmatically
2668     * focused, being the nearest focusable parent object the one
2669     * really getting focus. Also, when they receive mouse input, they
2670     * will get the event, but not take away the focus from where it
2671     * was previously.
2672     *
2673     * @ingroup Focus
2674     */
2675    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2676
2677    /**
2678     * Get whether an Elementary object is focusable or not
2679     *
2680     * @param obj The Elementary object to operate on
2681     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2682     *             EINA_FALSE if not (and on errors)
2683     *
2684     * @note Objects which are meant to be interacted with by input
2685     * events are created able to be focused, by default. All the
2686     * others are not.
2687     *
2688     * @ingroup Focus
2689     */
2690    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2691
2692    /**
2693     * Set custom focus chain.
2694     *
2695     * This function overwrites any previous custom focus chain within
2696     * the list of objects. The previous list will be deleted and this list
2697     * will be managed by elementary. After it is set, don't modify it.
2698     *
2699     * @note On focus cycle, only will be evaluated children of this container.
2700     *
2701     * @param obj The container object
2702     * @param objs Chain of objects to pass focus
2703     * @ingroup Focus
2704     */
2705    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2706
2707    /**
2708     * Unset a custom focus chain on a given Elementary widget
2709     *
2710     * @param obj The container object to remove focus chain from
2711     *
2712     * Any focus chain previously set on @p obj (for its child objects)
2713     * is removed entirely after this call.
2714     *
2715     * @ingroup Focus
2716     */
2717    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2718
2719    /**
2720     * Get custom focus chain
2721     *
2722     * @param obj The container object
2723     * @ingroup Focus
2724     */
2725    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2726
2727    /**
2728     * Append object to custom focus chain.
2729     *
2730     * @note If relative_child equal to NULL or not in custom chain, the object
2731     * will be added in end.
2732     *
2733     * @note On focus cycle, only will be evaluated children of this container.
2734     *
2735     * @param obj The container object
2736     * @param child The child to be added in custom chain
2737     * @param relative_child The relative object to position the child
2738     * @ingroup Focus
2739     */
2740    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2741
2742    /**
2743     * Prepend object to custom focus chain.
2744     *
2745     * @note If relative_child equal to NULL or not in custom chain, the object
2746     * will be added in begin.
2747     *
2748     * @note On focus cycle, only will be evaluated children of this container.
2749     *
2750     * @param obj The container object
2751     * @param child The child to be added in custom chain
2752     * @param relative_child The relative object to position the child
2753     * @ingroup Focus
2754     */
2755    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2756
2757    /**
2758     * Give focus to next object in object tree.
2759     *
2760     * Give focus to next object in focus chain of one object sub-tree.
2761     * If the last object of chain already have focus, the focus will go to the
2762     * first object of chain.
2763     *
2764     * @param obj The object root of sub-tree
2765     * @param dir Direction to cycle the focus
2766     *
2767     * @ingroup Focus
2768     */
2769    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2770
2771    /**
2772     * Give focus to near object in one direction.
2773     *
2774     * Give focus to near object in direction of one object.
2775     * If none focusable object in given direction, the focus will not change.
2776     *
2777     * @param obj The reference object
2778     * @param x Horizontal component of direction to focus
2779     * @param y Vertical component of direction to focus
2780     *
2781     * @ingroup Focus
2782     */
2783    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2784
2785    /**
2786     * Make the elementary object and its children to be unfocusable
2787     * (or focusable).
2788     *
2789     * @param obj The Elementary object to operate on
2790     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2791     *        @c EINA_FALSE for focusable.
2792     *
2793     * This sets whether the object @p obj and its children objects
2794     * are able to take focus or not. If the tree is set as unfocusable,
2795     * newest focused object which is not in this tree will get focus.
2796     * This API can be helpful for an object to be deleted.
2797     * When an object will be deleted soon, it and its children may not
2798     * want to get focus (by focus reverting or by other focus controls).
2799     * Then, just use this API before deleting.
2800     *
2801     * @see elm_object_tree_unfocusable_get()
2802     *
2803     * @ingroup Focus
2804     */
2805    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2806
2807    /**
2808     * Get whether an Elementary object and its children are unfocusable or not.
2809     *
2810     * @param obj The Elementary object to get the information from
2811     * @return @c EINA_TRUE, if the tree is unfocussable,
2812     *         @c EINA_FALSE if not (and on errors).
2813     *
2814     * @see elm_object_tree_unfocusable_set()
2815     *
2816     * @ingroup Focus
2817     */
2818    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2819
2820    /**
2821     * @defgroup Scrolling Scrolling
2822     *
2823     * These are functions setting how scrollable views in Elementary
2824     * widgets should behave on user interaction.
2825     *
2826     * @{
2827     */
2828
2829    /**
2830     * Get whether scrollers should bounce when they reach their
2831     * viewport's edge during a scroll.
2832     *
2833     * @return the thumb scroll bouncing state
2834     *
2835     * This is the default behavior for touch screens, in general.
2836     * @ingroup Scrolling
2837     */
2838    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2839
2840    /**
2841     * Set whether scrollers should bounce when they reach their
2842     * viewport's edge during a scroll.
2843     *
2844     * @param enabled the thumb scroll bouncing state
2845     *
2846     * @see elm_thumbscroll_bounce_enabled_get()
2847     * @ingroup Scrolling
2848     */
2849    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2850
2851    /**
2852     * Set whether scrollers should bounce when they reach their
2853     * viewport's edge during a scroll, for all Elementary application
2854     * windows.
2855     *
2856     * @param enabled the thumb scroll bouncing state
2857     *
2858     * @see elm_thumbscroll_bounce_enabled_get()
2859     * @ingroup Scrolling
2860     */
2861    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2862
2863    /**
2864     * Get the amount of inertia a scroller will impose at bounce
2865     * animations.
2866     *
2867     * @return the thumb scroll bounce friction
2868     *
2869     * @ingroup Scrolling
2870     */
2871    EAPI double           elm_scroll_bounce_friction_get(void);
2872
2873    /**
2874     * Set the amount of inertia a scroller will impose at bounce
2875     * animations.
2876     *
2877     * @param friction the thumb scroll bounce friction
2878     *
2879     * @see elm_thumbscroll_bounce_friction_get()
2880     * @ingroup Scrolling
2881     */
2882    EAPI void             elm_scroll_bounce_friction_set(double friction);
2883
2884    /**
2885     * Set the amount of inertia a scroller will impose at bounce
2886     * animations, for all Elementary application windows.
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_all_set(double friction);
2894
2895    /**
2896     * Get the amount of inertia a <b>paged</b> scroller will impose at
2897     * page fitting animations.
2898     *
2899     * @return the page scroll friction
2900     *
2901     * @ingroup Scrolling
2902     */
2903    EAPI double           elm_scroll_page_scroll_friction_get(void);
2904
2905    /**
2906     * Set the amount of inertia a <b>paged</b> scroller will impose at
2907     * page fitting animations.
2908     *
2909     * @param friction the page scroll friction
2910     *
2911     * @see elm_thumbscroll_page_scroll_friction_get()
2912     * @ingroup Scrolling
2913     */
2914    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2915
2916    /**
2917     * Set the amount of inertia a <b>paged</b> scroller will impose at
2918     * page fitting animations, for all Elementary application windows.
2919     *
2920     * @param friction the page scroll friction
2921     *
2922     * @see elm_thumbscroll_page_scroll_friction_get()
2923     * @ingroup Scrolling
2924     */
2925    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2926
2927    /**
2928     * Get the amount of inertia a scroller will impose at region bring
2929     * animations.
2930     *
2931     * @return the bring in scroll friction
2932     *
2933     * @ingroup Scrolling
2934     */
2935    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2936
2937    /**
2938     * Set the amount of inertia a scroller will impose at region bring
2939     * animations.
2940     *
2941     * @param friction the bring in scroll friction
2942     *
2943     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2944     * @ingroup Scrolling
2945     */
2946    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2947
2948    /**
2949     * Set the amount of inertia a scroller will impose at region bring
2950     * animations, for all Elementary application windows.
2951     *
2952     * @param friction the bring in scroll friction
2953     *
2954     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2955     * @ingroup Scrolling
2956     */
2957    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2958
2959    /**
2960     * Get the amount of inertia scrollers will impose at animations
2961     * triggered by Elementary widgets' zooming API.
2962     *
2963     * @return the zoom friction
2964     *
2965     * @ingroup Scrolling
2966     */
2967    EAPI double           elm_scroll_zoom_friction_get(void);
2968
2969    /**
2970     * Set the amount of inertia scrollers will impose at animations
2971     * triggered by Elementary widgets' zooming API.
2972     *
2973     * @param friction the zoom friction
2974     *
2975     * @see elm_thumbscroll_zoom_friction_get()
2976     * @ingroup Scrolling
2977     */
2978    EAPI void             elm_scroll_zoom_friction_set(double friction);
2979
2980    /**
2981     * Set the amount of inertia scrollers will impose at animations
2982     * triggered by Elementary widgets' zooming API, for all Elementary
2983     * application windows.
2984     *
2985     * @param friction the zoom friction
2986     *
2987     * @see elm_thumbscroll_zoom_friction_get()
2988     * @ingroup Scrolling
2989     */
2990    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2991
2992    /**
2993     * Get whether scrollers should be draggable from any point in their
2994     * views.
2995     *
2996     * @return the thumb scroll state
2997     *
2998     * @note This is the default behavior for touch screens, in general.
2999     * @note All other functions namespaced with "thumbscroll" will only
3000     *       have effect if this mode is enabled.
3001     *
3002     * @ingroup Scrolling
3003     */
3004    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
3005
3006    /**
3007     * Set whether scrollers should be draggable from any point in their
3008     * views.
3009     *
3010     * @param enabled the thumb scroll state
3011     *
3012     * @see elm_thumbscroll_enabled_get()
3013     * @ingroup Scrolling
3014     */
3015    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
3016
3017    /**
3018     * Set whether scrollers should be draggable from any point in their
3019     * views, for all Elementary application windows.
3020     *
3021     * @param enabled the thumb scroll state
3022     *
3023     * @see elm_thumbscroll_enabled_get()
3024     * @ingroup Scrolling
3025     */
3026    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
3027
3028    /**
3029     * Get the number of pixels one should travel while dragging a
3030     * scroller's view to actually trigger scrolling.
3031     *
3032     * @return the thumb scroll threshould
3033     *
3034     * One would use higher values for touch screens, in general, because
3035     * of their inherent imprecision.
3036     * @ingroup Scrolling
3037     */
3038    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
3039
3040    /**
3041     * Set the number of pixels one should travel while dragging a
3042     * scroller's view to actually trigger scrolling.
3043     *
3044     * @param threshold the thumb scroll threshould
3045     *
3046     * @see elm_thumbscroll_threshould_get()
3047     * @ingroup Scrolling
3048     */
3049    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
3050
3051    /**
3052     * Set the number of pixels one should travel while dragging a
3053     * scroller's view to actually trigger scrolling, for all Elementary
3054     * application windows.
3055     *
3056     * @param threshold the thumb scroll threshould
3057     *
3058     * @see elm_thumbscroll_threshould_get()
3059     * @ingroup Scrolling
3060     */
3061    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
3062
3063    /**
3064     * Get the minimum speed of mouse cursor movement which will trigger
3065     * list self scrolling animation after a mouse up event
3066     * (pixels/second).
3067     *
3068     * @return the thumb scroll momentum threshould
3069     *
3070     * @ingroup Scrolling
3071     */
3072    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
3073
3074    /**
3075     * Set the minimum speed of mouse cursor movement which will trigger
3076     * list self scrolling animation after a mouse up event
3077     * (pixels/second).
3078     *
3079     * @param threshold the thumb scroll momentum threshould
3080     *
3081     * @see elm_thumbscroll_momentum_threshould_get()
3082     * @ingroup Scrolling
3083     */
3084    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3085
3086    /**
3087     * Set the minimum speed of mouse cursor movement which will trigger
3088     * list self scrolling animation after a mouse up event
3089     * (pixels/second), for all Elementary application windows.
3090     *
3091     * @param threshold the thumb scroll momentum threshould
3092     *
3093     * @see elm_thumbscroll_momentum_threshould_get()
3094     * @ingroup Scrolling
3095     */
3096    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3097
3098    /**
3099     * Get the amount of inertia a scroller will impose at self scrolling
3100     * animations.
3101     *
3102     * @return the thumb scroll friction
3103     *
3104     * @ingroup Scrolling
3105     */
3106    EAPI double           elm_scroll_thumbscroll_friction_get(void);
3107
3108    /**
3109     * Set the amount of inertia a scroller will impose at self scrolling
3110     * animations.
3111     *
3112     * @param friction the thumb scroll friction
3113     *
3114     * @see elm_thumbscroll_friction_get()
3115     * @ingroup Scrolling
3116     */
3117    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
3118
3119    /**
3120     * Set the amount of inertia a scroller will impose at self scrolling
3121     * animations, for all Elementary application windows.
3122     *
3123     * @param friction the thumb scroll friction
3124     *
3125     * @see elm_thumbscroll_friction_get()
3126     * @ingroup Scrolling
3127     */
3128    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
3129
3130    /**
3131     * Get the amount of lag between your actual mouse cursor dragging
3132     * movement and a scroller's view movement itself, while pushing it
3133     * into bounce state manually.
3134     *
3135     * @return the thumb scroll border friction
3136     *
3137     * @ingroup Scrolling
3138     */
3139    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
3140
3141    /**
3142     * Set the amount of lag between your actual mouse cursor dragging
3143     * movement and a scroller's view movement itself, while pushing it
3144     * into bounce state manually.
3145     *
3146     * @param friction the thumb scroll border friction. @c 0.0 for
3147     *        perfect synchrony between two movements, @c 1.0 for maximum
3148     *        lag.
3149     *
3150     * @see elm_thumbscroll_border_friction_get()
3151     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3152     *
3153     * @ingroup Scrolling
3154     */
3155    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
3156
3157    /**
3158     * Set the amount of lag between your actual mouse cursor dragging
3159     * movement and a scroller's view movement itself, while pushing it
3160     * into bounce state manually, for all Elementary application windows.
3161     *
3162     * @param friction the thumb scroll border friction. @c 0.0 for
3163     *        perfect synchrony between two movements, @c 1.0 for maximum
3164     *        lag.
3165     *
3166     * @see elm_thumbscroll_border_friction_get()
3167     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3168     *
3169     * @ingroup Scrolling
3170     */
3171    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
3172
3173    /**
3174     * Get the sensitivity amount which is be multiplied by the length of
3175     * mouse dragging.
3176     *
3177     * @return the thumb scroll sensitivity friction
3178     *
3179     * @ingroup Scrolling
3180     */
3181    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
3182
3183    /**
3184     * Set the sensitivity amount which is be multiplied by the length of
3185     * mouse dragging.
3186     *
3187     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3188     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3189     *        is proper.
3190     *
3191     * @see elm_thumbscroll_sensitivity_friction_get()
3192     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3193     *
3194     * @ingroup Scrolling
3195     */
3196    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3197
3198    /**
3199     * Set the sensitivity amount which is be multiplied by the length of
3200     * mouse dragging, for all Elementary application windows.
3201     *
3202     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3203     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3204     *        is proper.
3205     *
3206     * @see elm_thumbscroll_sensitivity_friction_get()
3207     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3208     *
3209     * @ingroup Scrolling
3210     */
3211    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3212
3213    /**
3214     * @}
3215     */
3216
3217    /**
3218     * @defgroup Scrollhints Scrollhints
3219     *
3220     * Objects when inside a scroller can scroll, but this may not always be
3221     * desirable in certain situations. This allows an object to hint to itself
3222     * and parents to "not scroll" in one of 2 ways. If any child object of a
3223     * scroller has pushed a scroll freeze or hold then it affects all parent
3224     * scrollers until all children have released them.
3225     *
3226     * 1. To hold on scrolling. This means just flicking and dragging may no
3227     * longer scroll, but pressing/dragging near an edge of the scroller will
3228     * still scroll. This is automatically used by the entry object when
3229     * selecting text.
3230     *
3231     * 2. To totally freeze scrolling. This means it stops. until
3232     * popped/released.
3233     *
3234     * @{
3235     */
3236
3237    /**
3238     * Push the scroll hold by 1
3239     *
3240     * This increments the scroll hold count by one. If it is more than 0 it will
3241     * take effect on the parents of the indicated object.
3242     *
3243     * @param obj The object
3244     * @ingroup Scrollhints
3245     */
3246    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3247
3248    /**
3249     * Pop the scroll hold by 1
3250     *
3251     * This decrements the scroll hold count by one. If it is more than 0 it will
3252     * take effect on the parents of the indicated object.
3253     *
3254     * @param obj The object
3255     * @ingroup Scrollhints
3256     */
3257    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3258
3259    /**
3260     * Push the scroll freeze by 1
3261     *
3262     * This increments the scroll freeze count by one. If it is more
3263     * than 0 it will take effect on the parents of the indicated
3264     * object.
3265     *
3266     * @param obj The object
3267     * @ingroup Scrollhints
3268     */
3269    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3270
3271    /**
3272     * Pop the scroll freeze by 1
3273     *
3274     * This decrements the scroll freeze count by one. If it is more
3275     * than 0 it will take effect on the parents of the indicated
3276     * object.
3277     *
3278     * @param obj The object
3279     * @ingroup Scrollhints
3280     */
3281    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3282
3283    /**
3284     * Lock the scrolling of the given widget (and thus all parents)
3285     *
3286     * This locks the given object from scrolling in the X axis (and implicitly
3287     * also locks all parent scrollers too from doing the same).
3288     *
3289     * @param obj The object
3290     * @param lock The lock state (1 == locked, 0 == unlocked)
3291     * @ingroup Scrollhints
3292     */
3293    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3294
3295    /**
3296     * Lock the scrolling of the given widget (and thus all parents)
3297     *
3298     * This locks the given object from scrolling in the Y axis (and implicitly
3299     * also locks all parent scrollers too from doing the same).
3300     *
3301     * @param obj The object
3302     * @param lock The lock state (1 == locked, 0 == unlocked)
3303     * @ingroup Scrollhints
3304     */
3305    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3306
3307    /**
3308     * Get the scrolling lock of the given widget
3309     *
3310     * This gets the lock for X axis scrolling.
3311     *
3312     * @param obj The object
3313     * @ingroup Scrollhints
3314     */
3315    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3316
3317    /**
3318     * Get the scrolling lock of the given widget
3319     *
3320     * This gets the lock for X axis scrolling.
3321     *
3322     * @param obj The object
3323     * @ingroup Scrollhints
3324     */
3325    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3326
3327    /**
3328     * @}
3329     */
3330
3331    /**
3332     * Send a signal to the widget edje object.
3333     *
3334     * This function sends a signal to the edje object of the obj. An
3335     * edje program can respond to a signal by specifying matching
3336     * 'signal' and 'source' fields.
3337     *
3338     * @param obj The object
3339     * @param emission The signal's name.
3340     * @param source The signal's source.
3341     * @ingroup General
3342     */
3343    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3344
3345    /**
3346     * Add a callback for a signal emitted by widget edje object.
3347     *
3348     * This function connects a callback function to a signal emitted by the
3349     * edje object of the obj.
3350     * Globs can occur in either the emission or source name.
3351     *
3352     * @param obj The object
3353     * @param emission The signal's name.
3354     * @param source The signal's source.
3355     * @param func The callback function to be executed when the signal is
3356     * emitted.
3357     * @param data A pointer to data to pass in to the callback function.
3358     * @ingroup General
3359     */
3360    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);
3361
3362    /**
3363     * Remove a signal-triggered callback from a widget edje object.
3364     *
3365     * This function removes a callback, previoulsy attached to a
3366     * signal emitted by the edje object of the obj.  The parameters
3367     * emission, source and func must match exactly those passed to a
3368     * previous call to elm_object_signal_callback_add(). The data
3369     * pointer that was passed to this call will be returned.
3370     *
3371     * @param obj The object
3372     * @param emission The signal's name.
3373     * @param source The signal's source.
3374     * @param func The callback function to be executed when the signal is
3375     * emitted.
3376     * @return The data pointer
3377     * @ingroup General
3378     */
3379    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);
3380
3381    /**
3382     * Add a callback for input events (key up, key down, mouse wheel)
3383     * on a given Elementary widget
3384     *
3385     * @param obj The widget to add an event callback on
3386     * @param func The callback function to be executed when the event
3387     * happens
3388     * @param data Data to pass in to @p func
3389     *
3390     * Every widget in an Elementary interface set to receive focus,
3391     * with elm_object_focus_allow_set(), will propagate @b all of its
3392     * key up, key down and mouse wheel input events up to its parent
3393     * object, and so on. All of the focusable ones in this chain which
3394     * had an event callback set, with this call, will be able to treat
3395     * those events. There are two ways of making the propagation of
3396     * these event upwards in the tree of widgets to @b cease:
3397     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3398     *   the event was @b not processed, so the propagation will go on.
3399     * - The @c event_info pointer passed to @p func will contain the
3400     *   event's structure and, if you OR its @c event_flags inner
3401     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3402     *   one has already handled it, thus killing the event's
3403     *   propagation, too.
3404     *
3405     * @note Your event callback will be issued on those events taking
3406     * place only if no other child widget of @obj has consumed the
3407     * event already.
3408     *
3409     * @note Not to be confused with @c
3410     * evas_object_event_callback_add(), which will add event callbacks
3411     * per type on general Evas objects (no event propagation
3412     * infrastructure taken in account).
3413     *
3414     * @note Not to be confused with @c
3415     * elm_object_signal_callback_add(), which will add callbacks to @b
3416     * signals coming from a widget's theme, not input events.
3417     *
3418     * @note Not to be confused with @c
3419     * edje_object_signal_callback_add(), which does the same as
3420     * elm_object_signal_callback_add(), but directly on an Edje
3421     * object.
3422     *
3423     * @note Not to be confused with @c
3424     * evas_object_smart_callback_add(), which adds callbacks to smart
3425     * objects' <b>smart events</b>, and not input events.
3426     *
3427     * @see elm_object_event_callback_del()
3428     *
3429     * @ingroup General
3430     */
3431    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3432
3433    /**
3434     * Remove an event callback from a widget.
3435     *
3436     * This function removes a callback, previoulsy attached to event emission
3437     * by the @p obj.
3438     * The parameters func and data must match exactly those passed to
3439     * a previous call to elm_object_event_callback_add(). The data pointer that
3440     * was passed to this call will be returned.
3441     *
3442     * @param obj The object
3443     * @param func The callback function to be executed when the event is
3444     * emitted.
3445     * @param data Data to pass in to the callback function.
3446     * @return The data pointer
3447     * @ingroup General
3448     */
3449    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3450
3451    /**
3452     * Adjust size of an element for finger usage.
3453     *
3454     * @param times_w How many fingers should fit horizontally
3455     * @param w Pointer to the width size to adjust
3456     * @param times_h How many fingers should fit vertically
3457     * @param h Pointer to the height size to adjust
3458     *
3459     * This takes width and height sizes (in pixels) as input and a
3460     * size multiple (which is how many fingers you want to place
3461     * within the area, being "finger" the size set by
3462     * elm_finger_size_set()), and adjusts the size to be large enough
3463     * to accommodate the resulting size -- if it doesn't already
3464     * accommodate it. On return the @p w and @p h sizes pointed to by
3465     * these parameters will be modified, on those conditions.
3466     *
3467     * @note This is kind of a low level Elementary call, most useful
3468     * on size evaluation times for widgets. An external user wouldn't
3469     * be calling, most of the time.
3470     *
3471     * @ingroup Fingers
3472     */
3473    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3474
3475    /**
3476     * Get the duration for occuring long press event.
3477     *
3478     * @return Timeout for long press event
3479     * @ingroup Longpress
3480     */
3481    EAPI double           elm_longpress_timeout_get(void);
3482
3483    /**
3484     * Set the duration for occuring long press event.
3485     *
3486     * @param lonpress_timeout Timeout for long press event
3487     * @ingroup Longpress
3488     */
3489    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3490
3491    /**
3492     * @defgroup Debug Debug
3493     * don't use it unless you are sure
3494     *
3495     * @{
3496     */
3497
3498    /**
3499     * Print Tree object hierarchy in stdout
3500     *
3501     * @param obj The root object
3502     * @ingroup Debug
3503     */
3504    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3505
3506    /**
3507     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3508     *
3509     * @param obj The root object
3510     * @param file The path of output file
3511     * @ingroup Debug
3512     */
3513    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3514
3515    /**
3516     * @}
3517     */
3518
3519    /**
3520     * @defgroup Theme Theme
3521     *
3522     * Elementary uses Edje to theme its widgets, naturally. But for the most
3523     * part this is hidden behind a simpler interface that lets the user set
3524     * extensions and choose the style of widgets in a much easier way.
3525     *
3526     * Instead of thinking in terms of paths to Edje files and their groups
3527     * each time you want to change the appearance of a widget, Elementary
3528     * works so you can add any theme file with extensions or replace the
3529     * main theme at one point in the application, and then just set the style
3530     * of widgets with elm_object_style_set() and related functions. Elementary
3531     * will then look in its list of themes for a matching group and apply it,
3532     * and when the theme changes midway through the application, all widgets
3533     * will be updated accordingly.
3534     *
3535     * There are three concepts you need to know to understand how Elementary
3536     * theming works: default theme, extensions and overlays.
3537     *
3538     * Default theme, obviously enough, is the one that provides the default
3539     * look of all widgets. End users can change the theme used by Elementary
3540     * by setting the @c ELM_THEME environment variable before running an
3541     * application, or globally for all programs using the @c elementary_config
3542     * utility. Applications can change the default theme using elm_theme_set(),
3543     * but this can go against the user wishes, so it's not an adviced practice.
3544     *
3545     * Ideally, applications should find everything they need in the already
3546     * provided theme, but there may be occasions when that's not enough and
3547     * custom styles are required to correctly express the idea. For this
3548     * cases, Elementary has extensions.
3549     *
3550     * Extensions allow the application developer to write styles of its own
3551     * to apply to some widgets. This requires knowledge of how each widget
3552     * is themed, as extensions will always replace the entire group used by
3553     * the widget, so important signals and parts need to be there for the
3554     * object to behave properly (see documentation of Edje for details).
3555     * Once the theme for the extension is done, the application needs to add
3556     * it to the list of themes Elementary will look into, using
3557     * elm_theme_extension_add(), and set the style of the desired widgets as
3558     * he would normally with elm_object_style_set().
3559     *
3560     * Overlays, on the other hand, can replace the look of all widgets by
3561     * overriding the default style. Like extensions, it's up to the application
3562     * developer to write the theme for the widgets it wants, the difference
3563     * being that when looking for the theme, Elementary will check first the
3564     * list of overlays, then the set theme and lastly the list of extensions,
3565     * so with overlays it's possible to replace the default view and every
3566     * widget will be affected. This is very much alike to setting the whole
3567     * theme for the application and will probably clash with the end user
3568     * options, not to mention the risk of ending up with not matching styles
3569     * across the program. Unless there's a very special reason to use them,
3570     * overlays should be avoided for the resons exposed before.
3571     *
3572     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3573     * keeps one default internally and every function that receives one of
3574     * these can be called with NULL to refer to this default (except for
3575     * elm_theme_free()). It's possible to create a new instance of a
3576     * ::Elm_Theme to set other theme for a specific widget (and all of its
3577     * children), but this is as discouraged, if not even more so, than using
3578     * overlays. Don't use this unless you really know what you are doing.
3579     *
3580     * But to be less negative about things, you can look at the following
3581     * examples:
3582     * @li @ref theme_example_01 "Using extensions"
3583     * @li @ref theme_example_02 "Using overlays"
3584     *
3585     * @{
3586     */
3587    /**
3588     * @typedef Elm_Theme
3589     *
3590     * Opaque handler for the list of themes Elementary looks for when
3591     * rendering widgets.
3592     *
3593     * Stay out of this unless you really know what you are doing. For most
3594     * cases, sticking to the default is all a developer needs.
3595     */
3596    typedef struct _Elm_Theme Elm_Theme;
3597
3598    /**
3599     * Create a new specific theme
3600     *
3601     * This creates an empty specific theme that only uses the default theme. A
3602     * specific theme has its own private set of extensions and overlays too
3603     * (which are empty by default). Specific themes do not fall back to themes
3604     * of parent objects. They are not intended for this use. Use styles, overlays
3605     * and extensions when needed, but avoid specific themes unless there is no
3606     * other way (example: you want to have a preview of a new theme you are
3607     * selecting in a "theme selector" window. The preview is inside a scroller
3608     * and should display what the theme you selected will look like, but not
3609     * actually apply it yet. The child of the scroller will have a specific
3610     * theme set to show this preview before the user decides to apply it to all
3611     * applications).
3612     */
3613    EAPI Elm_Theme       *elm_theme_new(void);
3614
3615    /**
3616     * Free a specific theme
3617     *
3618     * @param th The theme to free
3619     *
3620     * This frees a theme created with elm_theme_new().
3621     */
3622    EAPI void             elm_theme_free(Elm_Theme *th);
3623
3624    /**
3625     * Copy the theme fom the source to the destination theme
3626     *
3627     * @param th The source theme to copy from
3628     * @param thdst The destination theme to copy data to
3629     *
3630     * This makes a one-time static copy of all the theme config, extensions
3631     * and overlays from @p th to @p thdst. If @p th references a theme, then
3632     * @p thdst is also set to reference it, with all the theme settings,
3633     * overlays and extensions that @p th had.
3634     */
3635    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3636
3637    /**
3638     * Tell the source theme to reference the ref theme
3639     *
3640     * @param th The theme that will do the referencing
3641     * @param thref The theme that is the reference source
3642     *
3643     * This clears @p th to be empty and then sets it to refer to @p thref
3644     * so @p th acts as an override to @p thref, but where its overrides
3645     * don't apply, it will fall through to @p thref for configuration.
3646     */
3647    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3648
3649    /**
3650     * Return the theme referred to
3651     *
3652     * @param th The theme to get the reference from
3653     * @return The referenced theme handle
3654     *
3655     * This gets the theme set as the reference theme by elm_theme_ref_set().
3656     * If no theme is set as a reference, NULL is returned.
3657     */
3658    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3659
3660    /**
3661     * Return the default theme
3662     *
3663     * @return The default theme handle
3664     *
3665     * This returns the internal default theme setup handle that all widgets
3666     * use implicitly unless a specific theme is set. This is also often use
3667     * as a shorthand of NULL.
3668     */
3669    EAPI Elm_Theme       *elm_theme_default_get(void);
3670
3671    /**
3672     * Prepends a theme overlay to the list of overlays
3673     *
3674     * @param th The theme to add to, or if NULL, the default theme
3675     * @param item The Edje file path to be used
3676     *
3677     * Use this if your application needs to provide some custom overlay theme
3678     * (An Edje file that replaces some default styles of widgets) where adding
3679     * new styles, or changing system theme configuration is not possible. Do
3680     * NOT use this instead of a proper system theme configuration. Use proper
3681     * configuration files, profiles, environment variables etc. to set a theme
3682     * so that the theme can be altered by simple confiugration by a user. Using
3683     * this call to achieve that effect is abusing the API and will create lots
3684     * of trouble.
3685     *
3686     * @see elm_theme_extension_add()
3687     */
3688    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3689
3690    /**
3691     * Delete a theme overlay from the list of overlays
3692     *
3693     * @param th The theme to delete from, or if NULL, the default theme
3694     * @param item The name of the theme overlay
3695     *
3696     * @see elm_theme_overlay_add()
3697     */
3698    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3699
3700    /**
3701     * Appends a theme extension to the list of extensions.
3702     *
3703     * @param th The theme to add to, or if NULL, the default theme
3704     * @param item The Edje file path to be used
3705     *
3706     * This is intended when an application needs more styles of widgets or new
3707     * widget themes that the default does not provide (or may not provide). The
3708     * application has "extended" usage by coming up with new custom style names
3709     * for widgets for specific uses, but as these are not "standard", they are
3710     * not guaranteed to be provided by a default theme. This means the
3711     * application is required to provide these extra elements itself in specific
3712     * Edje files. This call adds one of those Edje files to the theme search
3713     * path to be search after the default theme. The use of this call is
3714     * encouraged when default styles do not meet the needs of the application.
3715     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3716     *
3717     * @see elm_object_style_set()
3718     */
3719    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3720
3721    /**
3722     * Deletes a theme extension from the list of extensions.
3723     *
3724     * @param th The theme to delete from, or if NULL, the default theme
3725     * @param item The name of the theme extension
3726     *
3727     * @see elm_theme_extension_add()
3728     */
3729    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3730
3731    /**
3732     * Set the theme search order for the given theme
3733     *
3734     * @param th The theme to set the search order, or if NULL, the default theme
3735     * @param theme Theme search string
3736     *
3737     * This sets the search string for the theme in path-notation from first
3738     * theme to search, to last, delimited by the : character. Example:
3739     *
3740     * "shiny:/path/to/file.edj:default"
3741     *
3742     * See the ELM_THEME environment variable for more information.
3743     *
3744     * @see elm_theme_get()
3745     * @see elm_theme_list_get()
3746     */
3747    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3748
3749    /**
3750     * Return the theme search order
3751     *
3752     * @param th The theme to get the search order, or if NULL, the default theme
3753     * @return The internal search order path
3754     *
3755     * This function returns a colon separated string of theme elements as
3756     * returned by elm_theme_list_get().
3757     *
3758     * @see elm_theme_set()
3759     * @see elm_theme_list_get()
3760     */
3761    EAPI const char      *elm_theme_get(Elm_Theme *th);
3762
3763    /**
3764     * Return a list of theme elements to be used in a theme.
3765     *
3766     * @param th Theme to get the list of theme elements from.
3767     * @return The internal list of theme elements
3768     *
3769     * This returns the internal list of theme elements (will only be valid as
3770     * long as the theme is not modified by elm_theme_set() or theme is not
3771     * freed by elm_theme_free(). This is a list of strings which must not be
3772     * altered as they are also internal. If @p th is NULL, then the default
3773     * theme element list is returned.
3774     *
3775     * A theme element can consist of a full or relative path to a .edj file,
3776     * or a name, without extension, for a theme to be searched in the known
3777     * theme paths for Elemementary.
3778     *
3779     * @see elm_theme_set()
3780     * @see elm_theme_get()
3781     */
3782    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3783
3784    /**
3785     * Return the full patrh for a theme element
3786     *
3787     * @param f The theme element name
3788     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3789     * @return The full path to the file found.
3790     *
3791     * This returns a string you should free with free() on success, NULL on
3792     * failure. This will search for the given theme element, and if it is a
3793     * full or relative path element or a simple searchable name. The returned
3794     * path is the full path to the file, if searched, and the file exists, or it
3795     * is simply the full path given in the element or a resolved path if
3796     * relative to home. The @p in_search_path boolean pointed to is set to
3797     * EINA_TRUE if the file was a searchable file andis in the search path,
3798     * and EINA_FALSE otherwise.
3799     */
3800    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3801
3802    /**
3803     * Flush the current theme.
3804     *
3805     * @param th Theme to flush
3806     *
3807     * This flushes caches that let elementary know where to find theme elements
3808     * in the given theme. If @p th is NULL, then the default theme is flushed.
3809     * Call this function if source theme data has changed in such a way as to
3810     * make any caches Elementary kept invalid.
3811     */
3812    EAPI void             elm_theme_flush(Elm_Theme *th);
3813
3814    /**
3815     * This flushes all themes (default and specific ones).
3816     *
3817     * This will flush all themes in the current application context, by calling
3818     * elm_theme_flush() on each of them.
3819     */
3820    EAPI void             elm_theme_full_flush(void);
3821
3822    /**
3823     * Set the theme for all elementary using applications on the current display
3824     *
3825     * @param theme The name of the theme to use. Format same as the ELM_THEME
3826     * environment variable.
3827     */
3828    EAPI void             elm_theme_all_set(const char *theme);
3829
3830    /**
3831     * Return a list of theme elements in the theme search path
3832     *
3833     * @return A list of strings that are the theme element names.
3834     *
3835     * This lists all available theme files in the standard Elementary search path
3836     * for theme elements, and returns them in alphabetical order as theme
3837     * element names in a list of strings. Free this with
3838     * elm_theme_name_available_list_free() when you are done with the list.
3839     */
3840    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3841
3842    /**
3843     * Free the list returned by elm_theme_name_available_list_new()
3844     *
3845     * This frees the list of themes returned by
3846     * elm_theme_name_available_list_new(). Once freed the list should no longer
3847     * be used. a new list mys be created.
3848     */
3849    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3850
3851    /**
3852     * Set a specific theme to be used for this object and its children
3853     *
3854     * @param obj The object to set the theme on
3855     * @param th The theme to set
3856     *
3857     * This sets a specific theme that will be used for the given object and any
3858     * child objects it has. If @p th is NULL then the theme to be used is
3859     * cleared and the object will inherit its theme from its parent (which
3860     * ultimately will use the default theme if no specific themes are set).
3861     *
3862     * Use special themes with great care as this will annoy users and make
3863     * configuration difficult. Avoid any custom themes at all if it can be
3864     * helped.
3865     */
3866    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3867
3868    /**
3869     * Get the specific theme to be used
3870     *
3871     * @param obj The object to get the specific theme from
3872     * @return The specifc theme set.
3873     *
3874     * This will return a specific theme set, or NULL if no specific theme is
3875     * set on that object. It will not return inherited themes from parents, only
3876     * the specific theme set for that specific object. See elm_object_theme_set()
3877     * for more information.
3878     */
3879    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3880
3881    /**
3882     * Get a data item from a theme
3883     *
3884     * @param th The theme, or NULL for default theme
3885     * @param key The data key to search with
3886     * @return The data value, or NULL on failure
3887     *
3888     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3889     * It works the same way as edje_file_data_get() except that the return is stringshared.
3890     */
3891    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3892
3893    /**
3894     * @}
3895     */
3896
3897    /* win */
3898    /** @defgroup Win Win
3899     *
3900     * @image html img/widget/win/preview-00.png
3901     * @image latex img/widget/win/preview-00.eps
3902     *
3903     * The window class of Elementary.  Contains functions to manipulate
3904     * windows. The Evas engine used to render the window contents is specified
3905     * in the system or user elementary config files (whichever is found last),
3906     * and can be overridden with the ELM_ENGINE environment variable for
3907     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3908     * compilation setup and modules actually installed at runtime) are (listed
3909     * in order of best supported and most likely to be complete and work to
3910     * lowest quality).
3911     *
3912     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3913     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3914     * rendering in X11)
3915     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3916     * exits)
3917     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3918     * rendering)
3919     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3920     * buffer)
3921     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3922     * rendering using SDL as the buffer)
3923     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3924     * GDI with software)
3925     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3926     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3927     * grayscale using dedicated 8bit software engine in X11)
3928     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3929     * X11 using 16bit software engine)
3930     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3931     * (Windows CE rendering via GDI with 16bit software renderer)
3932     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3933     * buffer with 16bit software renderer)
3934     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3935     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3936     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3937     *
3938     * All engines use a simple string to select the engine to render, EXCEPT
3939     * the "shot" engine. This actually encodes the output of the virtual
3940     * screenshot and how long to delay in the engine string. The engine string
3941     * is encoded in the following way:
3942     *
3943     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3944     *
3945     * Where options are separated by a ":" char if more than one option is
3946     * given, with delay, if provided being the first option and file the last
3947     * (order is important). The delay specifies how long to wait after the
3948     * window is shown before doing the virtual "in memory" rendering and then
3949     * save the output to the file specified by the file option (and then exit).
3950     * If no delay is given, the default is 0.5 seconds. If no file is given the
3951     * default output file is "out.png". Repeat option is for continous
3952     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3953     * fixed to "out001.png" Some examples of using the shot engine:
3954     *
3955     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3956     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3957     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3958     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3959     *   ELM_ENGINE="shot:" elementary_test
3960     *
3961     * Signals that you can add callbacks for are:
3962     *
3963     * @li "delete,request": the user requested to close the window. See
3964     * elm_win_autodel_set().
3965     * @li "focus,in": window got focus
3966     * @li "focus,out": window lost focus
3967     * @li "moved": window that holds the canvas was moved
3968     *
3969     * Examples:
3970     * @li @ref win_example_01
3971     *
3972     * @{
3973     */
3974    /**
3975     * Defines the types of window that can be created
3976     *
3977     * These are hints set on the window so that a running Window Manager knows
3978     * how the window should be handled and/or what kind of decorations it
3979     * should have.
3980     *
3981     * Currently, only the X11 backed engines use them.
3982     */
3983    typedef enum _Elm_Win_Type
3984      {
3985         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3986                          window. Almost every window will be created with this
3987                          type. */
3988         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3989         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3990                            window holding desktop icons. */
3991         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3992                         be kept on top of any other window by the Window
3993                         Manager. */
3994         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3995                            similar. */
3996         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3997         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3998                            pallete. */
3999         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
4000         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
4001                                  entry in a menubar is clicked. Typically used
4002                                  with elm_win_override_set(). This hint exists
4003                                  for completion only, as the EFL way of
4004                                  implementing a menu would not normally use a
4005                                  separate window for its contents. */
4006         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
4007                               triggered by right-clicking an object. */
4008         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
4009                            explanatory text that typically appear after the
4010                            mouse cursor hovers over an object for a while.
4011                            Typically used with elm_win_override_set() and also
4012                            not very commonly used in the EFL. */
4013         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
4014                                 battery life or a new E-Mail received. */
4015         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
4016                          usually used in the EFL. */
4017         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
4018                        object being dragged across different windows, or even
4019                        applications. Typically used with
4020                        elm_win_override_set(). */
4021         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
4022                                  buffer. No actual window is created for this
4023                                  type, instead the window and all of its
4024                                  contents will be rendered to an image buffer.
4025                                  This allows to have children window inside a
4026                                  parent one just like any other object would
4027                                  be, and do other things like applying @c
4028                                  Evas_Map effects to it. This is the only type
4029                                  of window that requires the @c parent
4030                                  parameter of elm_win_add() to be a valid @c
4031                                  Evas_Object. */
4032      } Elm_Win_Type;
4033
4034    /**
4035     * The differents layouts that can be requested for the virtual keyboard.
4036     *
4037     * When the application window is being managed by Illume, it may request
4038     * any of the following layouts for the virtual keyboard.
4039     */
4040    typedef enum _Elm_Win_Keyboard_Mode
4041      {
4042         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4043         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4044         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4045         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4046         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4047         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4048         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4049         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4050         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4051         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4052         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4053         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4054         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4055         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4056         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4057         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4058      } Elm_Win_Keyboard_Mode;
4059
4060    /**
4061     * Available commands that can be sent to the Illume manager.
4062     *
4063     * When running under an Illume session, a window may send commands to the
4064     * Illume manager to perform different actions.
4065     */
4066    typedef enum _Elm_Illume_Command
4067      {
4068         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4069                                          window */
4070         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4071                                             in the list */
4072         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4073                                          screen */
4074         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4075      } Elm_Illume_Command;
4076
4077    /**
4078     * Adds a window object. If this is the first window created, pass NULL as
4079     * @p parent.
4080     *
4081     * @param parent Parent object to add the window to, or NULL
4082     * @param name The name of the window
4083     * @param type The window type, one of #Elm_Win_Type.
4084     *
4085     * The @p parent paramter can be @c NULL for every window @p type except
4086     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4087     * which the image object will be created.
4088     *
4089     * @return The created object, or NULL on failure
4090     */
4091    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4092
4093    /**
4094     * Adds a window object with standard setup
4095     *
4096     * @param name The name of the window
4097     * @param title The title for the window
4098     *
4099     * This creates a window like elm_win_add() but also puts in a standard
4100     * background with elm_bg_add(), as well as setting the window title to
4101     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4102     * as the parent widget.
4103     *
4104     * @return The created object, or NULL on failure
4105     *
4106     * @see elm_win_add()
4107     */
4108    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4109
4110    /**
4111     * Add @p subobj as a resize object of window @p obj.
4112     *
4113     *
4114     * Setting an object as a resize object of the window means that the
4115     * @p subobj child's size and position will be controlled by the window
4116     * directly. That is, the object will be resized to match the window size
4117     * and should never be moved or resized manually by the developer.
4118     *
4119     * In addition, resize objects of the window control what the minimum size
4120     * of it will be, as well as whether it can or not be resized by the user.
4121     *
4122     * For the end user to be able to resize a window by dragging the handles
4123     * or borders provided by the Window Manager, or using any other similar
4124     * mechanism, all of the resize objects in the window should have their
4125     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4126     *
4127     * Also notice that the window can get resized to the current size of the
4128     * object if the EVAS_HINT_EXPAND is set @b after the call to
4129     * elm_win_resize_object_add(). So if the object should get resized to the
4130     * size of the window, set this hint @b before adding it as a resize object
4131     * (this happens because the size of the window and the object are evaluated
4132     * as soon as the object is added to the window).
4133     *
4134     * @param obj The window object
4135     * @param subobj The resize object to add
4136     */
4137    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4138
4139    /**
4140     * Delete @p subobj as a resize object of window @p obj.
4141     *
4142     * This function removes the object @p subobj from the resize objects of
4143     * the window @p obj. It will not delete the object itself, which will be
4144     * left unmanaged and should be deleted by the developer, manually handled
4145     * or set as child of some other container.
4146     *
4147     * @param obj The window object
4148     * @param subobj The resize object to add
4149     */
4150    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4151
4152    /**
4153     * Set the title of the window
4154     *
4155     * @param obj The window object
4156     * @param title The title to set
4157     */
4158    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4159
4160    /**
4161     * Get the title of the window
4162     *
4163     * The returned string is an internal one and should not be freed or
4164     * modified. It will also be rendered invalid if a new title is set or if
4165     * the window is destroyed.
4166     *
4167     * @param obj The window object
4168     * @return The title
4169     */
4170    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4171
4172    /**
4173     * Set the window's autodel state.
4174     *
4175     * When closing the window in any way outside of the program control, like
4176     * pressing the X button in the titlebar or using a command from the
4177     * Window Manager, a "delete,request" signal is emitted to indicate that
4178     * this event occurred and the developer can take any action, which may
4179     * include, or not, destroying the window object.
4180     *
4181     * When the @p autodel parameter is set, the window will be automatically
4182     * destroyed when this event occurs, after the signal is emitted.
4183     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4184     * and is up to the program to do so when it's required.
4185     *
4186     * @param obj The window object
4187     * @param autodel If true, the window will automatically delete itself when
4188     * closed
4189     */
4190    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4191
4192    /**
4193     * Get the window's autodel state.
4194     *
4195     * @param obj The window object
4196     * @return If the window will automatically delete itself when closed
4197     *
4198     * @see elm_win_autodel_set()
4199     */
4200    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4201
4202    /**
4203     * Activate a window object.
4204     *
4205     * This function sends a request to the Window Manager to activate the
4206     * window pointed by @p obj. If honored by the WM, the window will receive
4207     * the keyboard focus.
4208     *
4209     * @note This is just a request that a Window Manager may ignore, so calling
4210     * this function does not ensure in any way that the window will be the
4211     * active one after it.
4212     *
4213     * @param obj The window object
4214     */
4215    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4216
4217    /**
4218     * Lower a window object.
4219     *
4220     * Places the window pointed by @p obj at the bottom of the stack, so that
4221     * no other window is covered by it.
4222     *
4223     * If elm_win_override_set() is not set, the Window Manager may ignore this
4224     * request.
4225     *
4226     * @param obj The window object
4227     */
4228    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4229
4230    /**
4231     * Raise a window object.
4232     *
4233     * Places the window pointed by @p obj at the top of the stack, so that it's
4234     * not covered by any other window.
4235     *
4236     * If elm_win_override_set() is not set, the Window Manager may ignore this
4237     * request.
4238     *
4239     * @param obj The window object
4240     */
4241    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4242
4243    /**
4244     * Center a window on its screen
4245     *
4246     * This function centers window @p obj horizontally and/or vertically based on the values
4247     * of @p h and @v.
4248     * @param obj The window object
4249     * @param h If true, center horizontally. If false, do not change horizontal location.
4250     * @param v If true, center vertically. If false, do not change vertical location.
4251     */
4252    EAPI void         elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v) EINA_ARG_NONNULL(1);
4253
4254    /**
4255     * Set the borderless state of a window.
4256     *
4257     * This function requests the Window Manager to not draw any decoration
4258     * around the window.
4259     *
4260     * @param obj The window object
4261     * @param borderless If true, the window is borderless
4262     */
4263    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4264
4265    /**
4266     * Get the borderless state of a window.
4267     *
4268     * @param obj The window object
4269     * @return If true, the window is borderless
4270     */
4271    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4272
4273    /**
4274     * Set the shaped state of a window.
4275     *
4276     * Shaped windows, when supported, will render the parts of the window that
4277     * has no content, transparent.
4278     *
4279     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4280     * background object or cover the entire window in any other way, or the
4281     * parts of the canvas that have no data will show framebuffer artifacts.
4282     *
4283     * @param obj The window object
4284     * @param shaped If true, the window is shaped
4285     *
4286     * @see elm_win_alpha_set()
4287     */
4288    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4289
4290    /**
4291     * Get the shaped state of a window.
4292     *
4293     * @param obj The window object
4294     * @return If true, the window is shaped
4295     *
4296     * @see elm_win_shaped_set()
4297     */
4298    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4299
4300    /**
4301     * Set the alpha channel state of a window.
4302     *
4303     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4304     * possibly making parts of the window completely or partially transparent.
4305     * This is also subject to the underlying system supporting it, like for
4306     * example, running under a compositing manager. If no compositing is
4307     * available, enabling this option will instead fallback to using shaped
4308     * windows, with elm_win_shaped_set().
4309     *
4310     * @param obj The window object
4311     * @param alpha If true, the window has an alpha channel
4312     *
4313     * @see elm_win_alpha_set()
4314     */
4315    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4316
4317    /**
4318     * Get the transparency state of a window.
4319     *
4320     * @param obj The window object
4321     * @return If true, the window is transparent
4322     *
4323     * @see elm_win_transparent_set()
4324     */
4325    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4326
4327    /**
4328     * Set the transparency state of a window.
4329     *
4330     * Use elm_win_alpha_set() instead.
4331     *
4332     * @param obj The window object
4333     * @param transparent If true, the window is transparent
4334     *
4335     * @see elm_win_alpha_set()
4336     */
4337    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4338
4339    /**
4340     * Get the alpha channel state of a window.
4341     *
4342     * @param obj The window object
4343     * @return If true, the window has an alpha channel
4344     */
4345    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4346
4347    /**
4348     * Set the override state of a window.
4349     *
4350     * A window with @p override set to EINA_TRUE will not be managed by the
4351     * Window Manager. This means that no decorations of any kind will be shown
4352     * for it, moving and resizing must be handled by the application, as well
4353     * as the window visibility.
4354     *
4355     * This should not be used for normal windows, and even for not so normal
4356     * ones, it should only be used when there's a good reason and with a lot
4357     * of care. Mishandling override windows may result situations that
4358     * disrupt the normal workflow of the end user.
4359     *
4360     * @param obj The window object
4361     * @param override If true, the window is overridden
4362     */
4363    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4364
4365    /**
4366     * Get the override state of a window.
4367     *
4368     * @param obj The window object
4369     * @return If true, the window is overridden
4370     *
4371     * @see elm_win_override_set()
4372     */
4373    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4374
4375    /**
4376     * Set the fullscreen state of a window.
4377     *
4378     * @param obj The window object
4379     * @param fullscreen If true, the window is fullscreen
4380     */
4381    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4382
4383    /**
4384     * Get the fullscreen state of a window.
4385     *
4386     * @param obj The window object
4387     * @return If true, the window is fullscreen
4388     */
4389    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4390
4391    /**
4392     * Set the maximized state of a window.
4393     *
4394     * @param obj The window object
4395     * @param maximized If true, the window is maximized
4396     */
4397    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4398
4399    /**
4400     * Get the maximized state of a window.
4401     *
4402     * @param obj The window object
4403     * @return If true, the window is maximized
4404     */
4405    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4406
4407    /**
4408     * Set the iconified state of a window.
4409     *
4410     * @param obj The window object
4411     * @param iconified If true, the window is iconified
4412     */
4413    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4414
4415    /**
4416     * Get the iconified state of a window.
4417     *
4418     * @param obj The window object
4419     * @return If true, the window is iconified
4420     */
4421    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4422
4423    /**
4424     * Set the layer of the window.
4425     *
4426     * What this means exactly will depend on the underlying engine used.
4427     *
4428     * In the case of X11 backed engines, the value in @p layer has the
4429     * following meanings:
4430     * @li < 3: The window will be placed below all others.
4431     * @li > 5: The window will be placed above all others.
4432     * @li other: The window will be placed in the default layer.
4433     *
4434     * @param obj The window object
4435     * @param layer The layer of the window
4436     */
4437    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4438
4439    /**
4440     * Get the layer of the window.
4441     *
4442     * @param obj The window object
4443     * @return The layer of the window
4444     *
4445     * @see elm_win_layer_set()
4446     */
4447    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4448
4449    /**
4450     * Set the rotation of the window.
4451     *
4452     * Most engines only work with multiples of 90.
4453     *
4454     * This function is used to set the orientation of the window @p obj to
4455     * match that of the screen. The window itself will be resized to adjust
4456     * to the new geometry of its contents. If you want to keep the window size,
4457     * see elm_win_rotation_with_resize_set().
4458     *
4459     * @param obj The window object
4460     * @param rotation The rotation of the window, in degrees (0-360),
4461     * counter-clockwise.
4462     */
4463    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4464
4465    /**
4466     * Rotates the window and resizes it.
4467     *
4468     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4469     * that they fit inside the current window geometry.
4470     *
4471     * @param obj The window object
4472     * @param layer The rotation of the window in degrees (0-360),
4473     * counter-clockwise.
4474     */
4475    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4476
4477    /**
4478     * Get the rotation of the window.
4479     *
4480     * @param obj The window object
4481     * @return The rotation of the window in degrees (0-360)
4482     *
4483     * @see elm_win_rotation_set()
4484     * @see elm_win_rotation_with_resize_set()
4485     */
4486    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4487
4488    /**
4489     * Set the sticky state of the window.
4490     *
4491     * Hints the Window Manager that the window in @p obj should be left fixed
4492     * at its position even when the virtual desktop it's on moves or changes.
4493     *
4494     * @param obj The window object
4495     * @param sticky If true, the window's sticky state is enabled
4496     */
4497    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4498
4499    /**
4500     * Get the sticky state of the window.
4501     *
4502     * @param obj The window object
4503     * @return If true, the window's sticky state is enabled
4504     *
4505     * @see elm_win_sticky_set()
4506     */
4507    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4508
4509    /**
4510     * Set if this window is an illume conformant window
4511     *
4512     * @param obj The window object
4513     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4514     */
4515    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4516
4517    /**
4518     * Get if this window is an illume conformant window
4519     *
4520     * @param obj The window object
4521     * @return A boolean if this window is illume conformant or not
4522     */
4523    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4524
4525    /**
4526     * Set a window to be an illume quickpanel window
4527     *
4528     * By default window objects are not quickpanel windows.
4529     *
4530     * @param obj The window object
4531     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4532     */
4533    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4534
4535    /**
4536     * Get if this window is a quickpanel or not
4537     *
4538     * @param obj The window object
4539     * @return A boolean if this window is a quickpanel or not
4540     */
4541    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4542
4543    /**
4544     * Set the major priority of a quickpanel window
4545     *
4546     * @param obj The window object
4547     * @param priority The major priority for this quickpanel
4548     */
4549    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4550
4551    /**
4552     * Get the major priority of a quickpanel window
4553     *
4554     * @param obj The window object
4555     * @return The major priority of this quickpanel
4556     */
4557    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4558
4559    /**
4560     * Set the minor priority of a quickpanel window
4561     *
4562     * @param obj The window object
4563     * @param priority The minor priority for this quickpanel
4564     */
4565    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4566
4567    /**
4568     * Get the minor priority of a quickpanel window
4569     *
4570     * @param obj The window object
4571     * @return The minor priority of this quickpanel
4572     */
4573    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4574
4575    /**
4576     * Set which zone this quickpanel should appear in
4577     *
4578     * @param obj The window object
4579     * @param zone The requested zone for this quickpanel
4580     */
4581    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4582
4583    /**
4584     * Get which zone this quickpanel should appear in
4585     *
4586     * @param obj The window object
4587     * @return The requested zone for this quickpanel
4588     */
4589    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4590
4591    /**
4592     * Set the window to be skipped by keyboard focus
4593     *
4594     * This sets the window to be skipped by normal keyboard input. This means
4595     * a window manager will be asked to not focus this window as well as omit
4596     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4597     *
4598     * Call this and enable it on a window BEFORE you show it for the first time,
4599     * otherwise it may have no effect.
4600     *
4601     * Use this for windows that have only output information or might only be
4602     * interacted with by the mouse or fingers, and never for typing input.
4603     * Be careful that this may have side-effects like making the window
4604     * non-accessible in some cases unless the window is specially handled. Use
4605     * this with care.
4606     *
4607     * @param obj The window object
4608     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4609     */
4610    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4611
4612    /**
4613     * Send a command to the windowing environment
4614     *
4615     * This is intended to work in touchscreen or small screen device
4616     * environments where there is a more simplistic window management policy in
4617     * place. This uses the window object indicated to select which part of the
4618     * environment to control (the part that this window lives in), and provides
4619     * a command and an optional parameter structure (use NULL for this if not
4620     * needed).
4621     *
4622     * @param obj The window object that lives in the environment to control
4623     * @param command The command to send
4624     * @param params Optional parameters for the command
4625     */
4626    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4627
4628    /**
4629     * Get the inlined image object handle
4630     *
4631     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4632     * then the window is in fact an evas image object inlined in the parent
4633     * canvas. You can get this object (be careful to not manipulate it as it
4634     * is under control of elementary), and use it to do things like get pixel
4635     * data, save the image to a file, etc.
4636     *
4637     * @param obj The window object to get the inlined image from
4638     * @return The inlined image object, or NULL if none exists
4639     */
4640    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4641
4642    /**
4643     * Determine whether a window has focus
4644     * @param obj The window to query
4645     * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4646     */
4647    EAPI Eina_Bool    elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4648
4649    /**
4650     * Constrain the maximum width and height of a window to the width and height of its screen
4651     *
4652     * When @p constrain is true, @p obj will never resize larger than the screen.
4653     * @param obj The window object
4654     * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4655     */
4656    EAPI void         elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain) EINA_ARG_NONNULL(1);
4657
4658    /**
4659     * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
4660     *
4661     * When this function returns true, @p obj will never resize larger than the screen.
4662     * @param obj The window object
4663     * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4664     */
4665    EAPI Eina_Bool    elm_win_screen_constrain_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4666
4667    /**
4668     * Get screen geometry details for the screen that a window is on
4669     * @param obj The window to query
4670     * @param x where to return the horizontal offset value. May be NULL.
4671     * @param y  where to return the vertical offset value. May be NULL.
4672     * @param w  where to return the width value. May be NULL.
4673     * @param h  where to return the height value. May be NULL.
4674     */
4675    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4676
4677    /**
4678     * Set the enabled status for the focus highlight in a window
4679     *
4680     * This function will enable or disable the focus highlight only for the
4681     * given window, regardless of the global setting for it
4682     *
4683     * @param obj The window where to enable the highlight
4684     * @param enabled The enabled value for the highlight
4685     */
4686    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4687
4688    /**
4689     * Get the enabled value of the focus highlight for this window
4690     *
4691     * @param obj The window in which to check if the focus highlight is enabled
4692     *
4693     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4694     */
4695    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4696
4697    /**
4698     * Set the style for the focus highlight on this window
4699     *
4700     * Sets the style to use for theming the highlight of focused objects on
4701     * the given window. If @p style is NULL, the default will be used.
4702     *
4703     * @param obj The window where to set the style
4704     * @param style The style to set
4705     */
4706    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4707
4708    /**
4709     * Get the style set for the focus highlight object
4710     *
4711     * Gets the style set for this windows highilght object, or NULL if none
4712     * is set.
4713     *
4714     * @param obj The window to retrieve the highlights style from
4715     *
4716     * @return The style set or NULL if none was. Default is used in that case.
4717     */
4718    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4719
4720    /*...
4721     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4722     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4723     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4724     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4725     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4726     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4727     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4728     *
4729     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4730     * (blank mouse, private mouse obj, defaultmouse)
4731     *
4732     */
4733
4734    /**
4735     * Sets the keyboard mode of the window.
4736     *
4737     * @param obj The window object
4738     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4739     */
4740    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4741
4742    /**
4743     * Gets the keyboard mode of the window.
4744     *
4745     * @param obj The window object
4746     * @return The mode, one of #Elm_Win_Keyboard_Mode
4747     */
4748    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4749
4750    /**
4751     * Sets whether the window is a keyboard.
4752     *
4753     * @param obj The window object
4754     * @param is_keyboard If true, the window is a virtual keyboard
4755     */
4756    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4757
4758    /**
4759     * Gets whether the window is a keyboard.
4760     *
4761     * @param obj The window object
4762     * @return If the window is a virtual keyboard
4763     */
4764    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4765
4766    /**
4767     * Get the screen position of a window.
4768     *
4769     * @param obj The window object
4770     * @param x The int to store the x coordinate to
4771     * @param y The int to store the y coordinate to
4772     */
4773    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4774
4775    /**
4776     * @}
4777     */
4778
4779    /**
4780     * @defgroup Inwin Inwin
4781     *
4782     * @image html img/widget/inwin/preview-00.png
4783     * @image latex img/widget/inwin/preview-00.eps
4784     * @image html img/widget/inwin/preview-01.png
4785     * @image latex img/widget/inwin/preview-01.eps
4786     * @image html img/widget/inwin/preview-02.png
4787     * @image latex img/widget/inwin/preview-02.eps
4788     *
4789     * An inwin is a window inside a window that is useful for a quick popup.
4790     * It does not hover.
4791     *
4792     * It works by creating an object that will occupy the entire window, so it
4793     * must be created using an @ref Win "elm_win" as parent only. The inwin
4794     * object can be hidden or restacked below every other object if it's
4795     * needed to show what's behind it without destroying it. If this is done,
4796     * the elm_win_inwin_activate() function can be used to bring it back to
4797     * full visibility again.
4798     *
4799     * There are three styles available in the default theme. These are:
4800     * @li default: The inwin is sized to take over most of the window it's
4801     * placed in.
4802     * @li minimal: The size of the inwin will be the minimum necessary to show
4803     * its contents.
4804     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4805     * possible, but it's sized vertically the most it needs to fit its\
4806     * contents.
4807     *
4808     * Some examples of Inwin can be found in the following:
4809     * @li @ref inwin_example_01
4810     *
4811     * @{
4812     */
4813
4814    /**
4815     * Adds an inwin to the current window
4816     *
4817     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4818     * Never call this function with anything other than the top-most window
4819     * as its parameter, unless you are fond of undefined behavior.
4820     *
4821     * After creating the object, the widget will set itself as resize object
4822     * for the window with elm_win_resize_object_add(), so when shown it will
4823     * appear to cover almost the entire window (how much of it depends on its
4824     * content and the style used). It must not be added into other container
4825     * objects and it needs not be moved or resized manually.
4826     *
4827     * @param parent The parent object
4828     * @return The new object or NULL if it cannot be created
4829     */
4830    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4831
4832    /**
4833     * Activates an inwin object, ensuring its visibility
4834     *
4835     * This function will make sure that the inwin @p obj is completely visible
4836     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4837     * to the front. It also sets the keyboard focus to it, which will be passed
4838     * onto its content.
4839     *
4840     * The object's theme will also receive the signal "elm,action,show" with
4841     * source "elm".
4842     *
4843     * @param obj The inwin to activate
4844     */
4845    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4846
4847    /**
4848     * Set the content of an inwin object.
4849     *
4850     * Once the content object is set, a previously set one will be deleted.
4851     * If you want to keep that old content object, use the
4852     * elm_win_inwin_content_unset() function.
4853     *
4854     * @param obj The inwin object
4855     * @param content The object to set as content
4856     */
4857    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4858
4859    /**
4860     * Get the content of an inwin object.
4861     *
4862     * Return the content object which is set for this widget.
4863     *
4864     * The returned object is valid as long as the inwin is still alive and no
4865     * other content is set on it. Deleting the object will notify the inwin
4866     * about it and this one will be left empty.
4867     *
4868     * If you need to remove an inwin's content to be reused somewhere else,
4869     * see elm_win_inwin_content_unset().
4870     *
4871     * @param obj The inwin object
4872     * @return The content that is being used
4873     */
4874    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4875
4876    /**
4877     * Unset the content of an inwin object.
4878     *
4879     * Unparent and return the content object which was set for this widget.
4880     *
4881     * @param obj The inwin object
4882     * @return The content that was being used
4883     */
4884    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4885
4886    /**
4887     * @}
4888     */
4889    /* X specific calls - won't work on non-x engines (return 0) */
4890
4891    /**
4892     * Get the Ecore_X_Window of an Evas_Object
4893     *
4894     * @param obj The object
4895     *
4896     * @return The Ecore_X_Window of @p obj
4897     *
4898     * @ingroup Win
4899     */
4900    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4901
4902    /* smart callbacks called:
4903     * "delete,request" - the user requested to delete the window
4904     * "focus,in" - window got focus
4905     * "focus,out" - window lost focus
4906     * "moved" - window that holds the canvas was moved
4907     */
4908
4909    /**
4910     * @defgroup Bg Bg
4911     *
4912     * @image html img/widget/bg/preview-00.png
4913     * @image latex img/widget/bg/preview-00.eps
4914     *
4915     * @brief Background object, used for setting a solid color, image or Edje
4916     * group as background to a window or any container object.
4917     *
4918     * The bg object is used for setting a solid background to a window or
4919     * packing into any container object. It works just like an image, but has
4920     * some properties useful to a background, like setting it to tiled,
4921     * centered, scaled or stretched.
4922     *
4923     * Default contents parts of the bg widget that you can use for are:
4924     * @li "overlay" - overlay of the bg
4925     *
4926     * Here is some sample code using it:
4927     * @li @ref bg_01_example_page
4928     * @li @ref bg_02_example_page
4929     * @li @ref bg_03_example_page
4930     */
4931
4932    /* bg */
4933    typedef enum _Elm_Bg_Option
4934      {
4935         ELM_BG_OPTION_CENTER,  /**< center the background */
4936         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4937         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4938         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4939      } Elm_Bg_Option;
4940
4941    /**
4942     * Add a new background to the parent
4943     *
4944     * @param parent The parent object
4945     * @return The new object or NULL if it cannot be created
4946     *
4947     * @ingroup Bg
4948     */
4949    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4950
4951    /**
4952     * Set the file (image or edje) used for the background
4953     *
4954     * @param obj The bg object
4955     * @param file The file path
4956     * @param group Optional key (group in Edje) within the file
4957     *
4958     * This sets the image file used in the background object. The image (or edje)
4959     * will be stretched (retaining aspect if its an image file) to completely fill
4960     * the bg object. This may mean some parts are not visible.
4961     *
4962     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4963     * even if @p file is NULL.
4964     *
4965     * @ingroup Bg
4966     */
4967    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4968
4969    /**
4970     * Get the file (image or edje) used for the background
4971     *
4972     * @param obj The bg object
4973     * @param file The file path
4974     * @param group Optional key (group in Edje) within the file
4975     *
4976     * @ingroup Bg
4977     */
4978    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4979
4980    /**
4981     * Set the option used for the background image
4982     *
4983     * @param obj The bg object
4984     * @param option The desired background option (TILE, SCALE)
4985     *
4986     * This sets the option used for manipulating the display of the background
4987     * image. The image can be tiled or scaled.
4988     *
4989     * @ingroup Bg
4990     */
4991    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4992
4993    /**
4994     * Get the option used for the background image
4995     *
4996     * @param obj The bg object
4997     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4998     *
4999     * @ingroup Bg
5000     */
5001    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5002    /**
5003     * Set the option used for the background color
5004     *
5005     * @param obj The bg object
5006     * @param r
5007     * @param g
5008     * @param b
5009     *
5010     * This sets the color used for the background rectangle. Its range goes
5011     * from 0 to 255.
5012     *
5013     * @ingroup Bg
5014     */
5015    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
5016    /**
5017     * Get the option used for the background color
5018     *
5019     * @param obj The bg object
5020     * @param r
5021     * @param g
5022     * @param b
5023     *
5024     * @ingroup Bg
5025     */
5026    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
5027
5028    /**
5029     * Set the overlay object used for the background object.
5030     *
5031     * @param obj The bg object
5032     * @param overlay The overlay object
5033     *
5034     * This provides a way for elm_bg to have an 'overlay' that will be on top
5035     * of the bg. Once the over object is set, a previously set one will be
5036     * deleted, even if you set the new one to NULL. If you want to keep that
5037     * old content object, use the elm_bg_overlay_unset() function.
5038     *
5039     * @deprecated use elm_object_part_content_set() instead
5040     *
5041     * @ingroup Bg
5042     */
5043
5044    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
5045
5046    /**
5047     * Get the overlay object used for the background object.
5048     *
5049     * @param obj The bg object
5050     * @return The content that is being used
5051     *
5052     * Return the content object which is set for this widget
5053     *
5054     * @deprecated use elm_object_part_content_get() instead
5055     *
5056     * @ingroup Bg
5057     */
5058    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5059
5060    /**
5061     * Get the overlay object used for the background object.
5062     *
5063     * @param obj The bg object
5064     * @return The content that was being used
5065     *
5066     * Unparent and return the overlay object which was set for this widget
5067     *
5068     * @deprecated use elm_object_part_content_unset() instead
5069     *
5070     * @ingroup Bg
5071     */
5072    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5073
5074    /**
5075     * Set the size of the pixmap representation of the image.
5076     *
5077     * This option just makes sense if an image is going to be set in the bg.
5078     *
5079     * @param obj The bg object
5080     * @param w The new width of the image pixmap representation.
5081     * @param h The new height of the image pixmap representation.
5082     *
5083     * This function sets a new size for pixmap representation of the given bg
5084     * image. It allows the image to be loaded already in the specified size,
5085     * reducing the memory usage and load time when loading a big image with load
5086     * size set to a smaller size.
5087     *
5088     * NOTE: this is just a hint, the real size of the pixmap may differ
5089     * depending on the type of image being loaded, being bigger than requested.
5090     *
5091     * @ingroup Bg
5092     */
5093    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5094
5095    /**
5096     * @}
5097     */
5098
5099    /**
5100     * @defgroup Icon Icon
5101     *
5102     * @image html img/widget/icon/preview-00.png
5103     * @image latex img/widget/icon/preview-00.eps
5104     *
5105     * An object that provides standard icon images (delete, edit, arrows, etc.)
5106     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
5107     *
5108     * The icon image requested can be in the elementary theme, or in the
5109     * freedesktop.org paths. It's possible to set the order of preference from
5110     * where the image will be used.
5111     *
5112     * This API is very similar to @ref Image, but with ready to use images.
5113     *
5114     * Default images provided by the theme are described below.
5115     *
5116     * The first list contains icons that were first intended to be used in
5117     * toolbars, but can be used in many other places too:
5118     * @li home
5119     * @li close
5120     * @li apps
5121     * @li arrow_up
5122     * @li arrow_down
5123     * @li arrow_left
5124     * @li arrow_right
5125     * @li chat
5126     * @li clock
5127     * @li delete
5128     * @li edit
5129     * @li refresh
5130     * @li folder
5131     * @li file
5132     *
5133     * Now some icons that were designed to be used in menus (but again, you can
5134     * use them anywhere else):
5135     * @li menu/home
5136     * @li menu/close
5137     * @li menu/apps
5138     * @li menu/arrow_up
5139     * @li menu/arrow_down
5140     * @li menu/arrow_left
5141     * @li menu/arrow_right
5142     * @li menu/chat
5143     * @li menu/clock
5144     * @li menu/delete
5145     * @li menu/edit
5146     * @li menu/refresh
5147     * @li menu/folder
5148     * @li menu/file
5149     *
5150     * And here we have some media player specific icons:
5151     * @li media_player/forward
5152     * @li media_player/info
5153     * @li media_player/next
5154     * @li media_player/pause
5155     * @li media_player/play
5156     * @li media_player/prev
5157     * @li media_player/rewind
5158     * @li media_player/stop
5159     *
5160     * Signals that you can add callbacks for are:
5161     *
5162     * "clicked" - This is called when a user has clicked the icon
5163     *
5164     * An example of usage for this API follows:
5165     * @li @ref tutorial_icon
5166     */
5167
5168    /**
5169     * @addtogroup Icon
5170     * @{
5171     */
5172
5173    typedef enum _Elm_Icon_Type
5174      {
5175         ELM_ICON_NONE,
5176         ELM_ICON_FILE,
5177         ELM_ICON_STANDARD
5178      } Elm_Icon_Type;
5179
5180    /**
5181     * @enum _Elm_Icon_Lookup_Order
5182     * @typedef Elm_Icon_Lookup_Order
5183     *
5184     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5185     * theme, FDO paths, or both?
5186     *
5187     * @ingroup Icon
5188     */
5189    typedef enum _Elm_Icon_Lookup_Order
5190      {
5191         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5192         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5193         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
5194         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
5195      } Elm_Icon_Lookup_Order;
5196
5197    /**
5198     * Add a new icon object to the parent.
5199     *
5200     * @param parent The parent object
5201     * @return The new object or NULL if it cannot be created
5202     *
5203     * @see elm_icon_file_set()
5204     *
5205     * @ingroup Icon
5206     */
5207    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5208
5209    /**
5210     * Set the file that will be used as icon.
5211     *
5212     * @param obj The icon object
5213     * @param file The path to file that will be used as icon image
5214     * @param group The group that the icon belongs to an edje file
5215     *
5216     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5217     *
5218     * @note The icon image set by this function can be changed by
5219     * elm_icon_standard_set().
5220     *
5221     * @see elm_icon_file_get()
5222     *
5223     * @ingroup Icon
5224     */
5225    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5226
5227    /**
5228     * Set a location in memory to be used as an icon
5229     *
5230     * @param obj The icon object
5231     * @param img The binary data that will be used as an image
5232     * @param size The size of binary data @p img
5233     * @param format Optional format of @p img to pass to the image loader
5234     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5235     *
5236     * The @p format string should be something like "png", "jpg", "tga",
5237     * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5238     * the loader performance as it tries the "correct" loader first before
5239     * trying a range of other possible loaders until one succeeds.
5240     * 
5241     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5242     *
5243     * @note The icon image set by this function can be changed by
5244     * elm_icon_standard_set().
5245     *
5246     * @ingroup Icon
5247     */
5248    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);
5249
5250    /**
5251     * Get the file that will be used as icon.
5252     *
5253     * @param obj The icon object
5254     * @param file The path to file that will be used as the icon image
5255     * @param group The group that the icon belongs to, in edje file
5256     *
5257     * @see elm_icon_file_set()
5258     *
5259     * @ingroup Icon
5260     */
5261    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5262
5263    /**
5264     * Set the file that will be used, but use a generated thumbnail.
5265     *
5266     * @param obj The icon object
5267     * @param file The path to file that will be used as icon image
5268     * @param group The group that the icon belongs to an edje file
5269     *
5270     * This functions like elm_icon_file_set() but requires the Ethumb library
5271     * support to be enabled successfully with elm_need_ethumb(). When set
5272     * the file indicated has a thumbnail generated and cached on disk for
5273     * future use or will directly use an existing cached thumbnail if it
5274     * is valid.
5275     * 
5276     * @see elm_icon_file_set()
5277     *
5278     * @ingroup Icon
5279     */
5280    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5281
5282    /**
5283     * Set the icon by icon standards names.
5284     *
5285     * @param obj The icon object
5286     * @param name The icon name
5287     *
5288     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5289     *
5290     * For example, freedesktop.org defines standard icon names such as "home",
5291     * "network", etc. There can be different icon sets to match those icon
5292     * keys. The @p name given as parameter is one of these "keys", and will be
5293     * used to look in the freedesktop.org paths and elementary theme. One can
5294     * change the lookup order with elm_icon_order_lookup_set().
5295     *
5296     * If name is not found in any of the expected locations and it is the
5297     * absolute path of an image file, this image will be used.
5298     *
5299     * @note The icon image set by this function can be changed by
5300     * elm_icon_file_set().
5301     *
5302     * @see elm_icon_standard_get()
5303     * @see elm_icon_file_set()
5304     *
5305     * @ingroup Icon
5306     */
5307    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5308
5309    /**
5310     * Get the icon name set by icon standard names.
5311     *
5312     * @param obj The icon object
5313     * @return The icon name
5314     *
5315     * If the icon image was set using elm_icon_file_set() instead of
5316     * elm_icon_standard_set(), then this function will return @c NULL.
5317     *
5318     * @see elm_icon_standard_set()
5319     *
5320     * @ingroup Icon
5321     */
5322    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5323
5324    /**
5325     * Set the smooth scaling for an icon object.
5326     *
5327     * @param obj The icon object
5328     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5329     * otherwise. Default is @c EINA_TRUE.
5330     *
5331     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5332     * scaling provides a better resulting image, but is slower.
5333     *
5334     * The smooth scaling should be disabled when making animations that change
5335     * the icon size, since they will be faster. Animations that don't require
5336     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5337     * is already scaled, since the scaled icon image will be cached).
5338     *
5339     * @see elm_icon_smooth_get()
5340     *
5341     * @ingroup Icon
5342     */
5343    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5344
5345    /**
5346     * Get whether smooth scaling is enabled for an icon object.
5347     *
5348     * @param obj The icon object
5349     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5350     *
5351     * @see elm_icon_smooth_set()
5352     *
5353     * @ingroup Icon
5354     */
5355    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5356
5357    /**
5358     * Disable scaling of this object.
5359     *
5360     * @param obj The icon object.
5361     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5362     * otherwise. Default is @c EINA_FALSE.
5363     *
5364     * This function disables scaling of the icon object through the function
5365     * elm_object_scale_set(). However, this does not affect the object
5366     * size/resize in any way. For that effect, take a look at
5367     * elm_icon_scale_set().
5368     *
5369     * @see elm_icon_no_scale_get()
5370     * @see elm_icon_scale_set()
5371     * @see elm_object_scale_set()
5372     *
5373     * @ingroup Icon
5374     */
5375    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5376
5377    /**
5378     * Get whether scaling is disabled on the object.
5379     *
5380     * @param obj The icon object
5381     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5382     *
5383     * @see elm_icon_no_scale_set()
5384     *
5385     * @ingroup Icon
5386     */
5387    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5388
5389    /**
5390     * Set if the object is (up/down) resizable.
5391     *
5392     * @param obj The icon object
5393     * @param scale_up A bool to set if the object is resizable up. Default is
5394     * @c EINA_TRUE.
5395     * @param scale_down A bool to set if the object is resizable down. Default
5396     * is @c EINA_TRUE.
5397     *
5398     * This function limits the icon object resize ability. If @p scale_up is set to
5399     * @c EINA_FALSE, the object can't have its height or width resized to a value
5400     * higher than the original icon size. Same is valid for @p scale_down.
5401     *
5402     * @see elm_icon_scale_get()
5403     *
5404     * @ingroup Icon
5405     */
5406    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5407
5408    /**
5409     * Get if the object is (up/down) resizable.
5410     *
5411     * @param obj The icon object
5412     * @param scale_up A bool to set if the object is resizable up
5413     * @param scale_down A bool to set if the object is resizable down
5414     *
5415     * @see elm_icon_scale_set()
5416     *
5417     * @ingroup Icon
5418     */
5419    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5420
5421    /**
5422     * Get the object's image size
5423     *
5424     * @param obj The icon object
5425     * @param w A pointer to store the width in
5426     * @param h A pointer to store the height in
5427     *
5428     * @ingroup Icon
5429     */
5430    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5431
5432    /**
5433     * Set if the icon fill the entire object area.
5434     *
5435     * @param obj The icon object
5436     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5437     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5438     *
5439     * When the icon object is resized to a different aspect ratio from the
5440     * original icon image, the icon image will still keep its aspect. This flag
5441     * tells how the image should fill the object's area. They are: keep the
5442     * entire icon inside the limits of height and width of the object (@p
5443     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5444     * of the object, and the icon will fill the entire object (@p fill_outside
5445     * is @c EINA_TRUE).
5446     *
5447     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5448     * retain property to false. Thus, the icon image will always keep its
5449     * original aspect ratio.
5450     *
5451     * @see elm_icon_fill_outside_get()
5452     * @see elm_image_fill_outside_set()
5453     *
5454     * @ingroup Icon
5455     */
5456    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5457
5458    /**
5459     * Get if the object is filled outside.
5460     *
5461     * @param obj The icon object
5462     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5463     *
5464     * @see elm_icon_fill_outside_set()
5465     *
5466     * @ingroup Icon
5467     */
5468    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5469
5470    /**
5471     * Set the prescale size for the icon.
5472     *
5473     * @param obj The icon object
5474     * @param size The prescale size. This value is used for both width and
5475     * height.
5476     *
5477     * This function sets a new size for pixmap representation of the given
5478     * icon. It allows the icon to be loaded already in the specified size,
5479     * reducing the memory usage and load time when loading a big icon with load
5480     * size set to a smaller size.
5481     *
5482     * It's equivalent to the elm_bg_load_size_set() function for bg.
5483     *
5484     * @note this is just a hint, the real size of the pixmap may differ
5485     * depending on the type of icon being loaded, being bigger than requested.
5486     *
5487     * @see elm_icon_prescale_get()
5488     * @see elm_bg_load_size_set()
5489     *
5490     * @ingroup Icon
5491     */
5492    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5493
5494    /**
5495     * Get the prescale size for the icon.
5496     *
5497     * @param obj The icon object
5498     * @return The prescale size
5499     *
5500     * @see elm_icon_prescale_set()
5501     *
5502     * @ingroup Icon
5503     */
5504    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5505
5506    /**
5507     * Gets the image object of the icon. DO NOT MODIFY THIS.
5508     *
5509     * @param obj The icon object
5510     * @return The internal icon object
5511     *
5512     * @ingroup Icon
5513     */
5514    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5515
5516    /**
5517     * Sets the icon lookup order used by elm_icon_standard_set().
5518     *
5519     * @param obj The icon object
5520     * @param order The icon lookup order (can be one of
5521     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5522     * or ELM_ICON_LOOKUP_THEME)
5523     *
5524     * @see elm_icon_order_lookup_get()
5525     * @see Elm_Icon_Lookup_Order
5526     *
5527     * @ingroup Icon
5528     */
5529    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5530
5531    /**
5532     * Gets the icon lookup order.
5533     *
5534     * @param obj The icon object
5535     * @return The icon lookup order
5536     *
5537     * @see elm_icon_order_lookup_set()
5538     * @see Elm_Icon_Lookup_Order
5539     *
5540     * @ingroup Icon
5541     */
5542    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5543
5544    /**
5545     * Enable or disable preloading of the icon
5546     *
5547     * @param obj The icon object
5548     * @param disable If EINA_TRUE, preloading will be disabled
5549     * @ingroup Icon
5550     */
5551    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5552
5553    /**
5554     * Get if the icon supports animation or not.
5555     *
5556     * @param obj The icon object
5557     * @return @c EINA_TRUE if the icon supports animation,
5558     *         @c EINA_FALSE otherwise.
5559     *
5560     * Return if this elm icon's image can be animated. Currently Evas only
5561     * supports gif animation. If the return value is EINA_FALSE, other
5562     * elm_icon_animated_XXX APIs won't work.
5563     * @ingroup Icon
5564     */
5565    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5566
5567    /**
5568     * Set animation mode of the icon.
5569     *
5570     * @param obj The icon object
5571     * @param anim @c EINA_TRUE if the object do animation job,
5572     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5573     *
5574     * Since the default animation mode is set to EINA_FALSE,
5575     * the icon is shown without animation. Files like animated GIF files
5576     * can animate, and this is supported if you enable animated support
5577     * on the icon.
5578     * Set it to EINA_TRUE when the icon needs to be animated.
5579     * @ingroup Icon
5580     */
5581    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5582
5583    /**
5584     * Get animation mode of the icon.
5585     *
5586     * @param obj The icon object
5587     * @return The animation mode of the icon object
5588     * @see elm_icon_animated_set
5589     * @ingroup Icon
5590     */
5591    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5592
5593    /**
5594     * Set animation play mode of the icon.
5595     *
5596     * @param obj The icon object
5597     * @param play @c EINA_TRUE the object play animation images,
5598     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5599     *
5600     * To play elm icon's animation, set play to EINA_TURE.
5601     * For example, you make gif player using this set/get API and click event.
5602     * This literally lets you control current play or paused state. To have
5603     * this work with animated GIF files for example, you first, before
5604     * setting the file have to use elm_icon_animated_set() to enable animation
5605     * at all on the icon.
5606     *
5607     * 1. Click event occurs
5608     * 2. Check play flag using elm_icon_animaged_play_get
5609     * 3. If elm icon was playing, set play to EINA_FALSE.
5610     *    Then animation will be stopped and vice versa
5611     * @ingroup Icon
5612     */
5613    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5614
5615    /**
5616     * Get animation play mode of the icon.
5617     *
5618     * @param obj The icon object
5619     * @return The play mode of the icon object
5620     *
5621     * @see elm_icon_animated_play_get
5622     * @ingroup Icon
5623     */
5624    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5625
5626    /**
5627     * @}
5628     */
5629
5630    /**
5631     * @defgroup Image Image
5632     *
5633     * @image html img/widget/image/preview-00.png
5634     * @image latex img/widget/image/preview-00.eps
5635
5636     *
5637     * An object that allows one to load an image file to it. It can be used
5638     * anywhere like any other elementary widget.
5639     *
5640     * This widget provides most of the functionality provided from @ref Bg or @ref
5641     * Icon, but with a slightly different API (use the one that fits better your
5642     * needs).
5643     *
5644     * The features not provided by those two other image widgets are:
5645     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5646     * @li change the object orientation with elm_image_orient_set();
5647     * @li and turning the image editable with elm_image_editable_set().
5648     *
5649     * Signals that you can add callbacks for are:
5650     *
5651     * @li @c "clicked" - This is called when a user has clicked the image
5652     *
5653     * An example of usage for this API follows:
5654     * @li @ref tutorial_image
5655     */
5656
5657    /**
5658     * @addtogroup Image
5659     * @{
5660     */
5661
5662    /**
5663     * @enum _Elm_Image_Orient
5664     * @typedef Elm_Image_Orient
5665     *
5666     * Possible orientation options for elm_image_orient_set().
5667     *
5668     * @image html elm_image_orient_set.png
5669     * @image latex elm_image_orient_set.eps width=\textwidth
5670     *
5671     * @ingroup Image
5672     */
5673    typedef enum _Elm_Image_Orient
5674      {
5675         ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5676         ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5677         ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5678         ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5679         ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5680         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5681         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5682         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5683         ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5684         ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5685         ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5686         ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5687      } Elm_Image_Orient;
5688
5689    /**
5690     * Add a new image to the parent.
5691     *
5692     * @param parent The parent object
5693     * @return The new object or NULL if it cannot be created
5694     *
5695     * @see elm_image_file_set()
5696     *
5697     * @ingroup Image
5698     */
5699    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5700
5701    /**
5702     * Set the file that will be used as image.
5703     *
5704     * @param obj The image object
5705     * @param file The path to file that will be used as image
5706     * @param group The group that the image belongs in edje file (if it's an
5707     * edje image)
5708     *
5709     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5710     *
5711     * @see elm_image_file_get()
5712     *
5713     * @ingroup Image
5714     */
5715    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5716
5717    /**
5718     * Get the file that will be used as image.
5719     *
5720     * @param obj The image object
5721     * @param file The path to file
5722     * @param group The group that the image belongs in edje file
5723     *
5724     * @see elm_image_file_set()
5725     *
5726     * @ingroup Image
5727     */
5728    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5729
5730    /**
5731     * Set the smooth effect for an image.
5732     *
5733     * @param obj The image object
5734     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5735     * otherwise. Default is @c EINA_TRUE.
5736     *
5737     * Set the scaling algorithm to be used when scaling the image. Smooth
5738     * scaling provides a better resulting image, but is slower.
5739     *
5740     * The smooth scaling should be disabled when making animations that change
5741     * the image size, since it will be faster. Animations that don't require
5742     * resizing of the image can keep the smooth scaling enabled (even if the
5743     * image is already scaled, since the scaled image will be cached).
5744     *
5745     * @see elm_image_smooth_get()
5746     *
5747     * @ingroup Image
5748     */
5749    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5750
5751    /**
5752     * Get the smooth effect for an image.
5753     *
5754     * @param obj The image object
5755     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5756     *
5757     * @see elm_image_smooth_get()
5758     *
5759     * @ingroup Image
5760     */
5761    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5762
5763    /**
5764     * Gets the current size of the image.
5765     *
5766     * @param obj The image object.
5767     * @param w Pointer to store width, or NULL.
5768     * @param h Pointer to store height, or NULL.
5769     *
5770     * This is the real size of the image, not the size of the object.
5771     *
5772     * On error, neither w and h will be fileld with 0.
5773     *
5774     * @ingroup Image
5775     */
5776    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5777
5778    /**
5779     * Disable scaling of this object.
5780     *
5781     * @param obj The image object.
5782     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5783     * otherwise. Default is @c EINA_FALSE.
5784     *
5785     * This function disables scaling of the elm_image widget through the
5786     * function elm_object_scale_set(). However, this does not affect the widget
5787     * size/resize in any way. For that effect, take a look at
5788     * elm_image_scale_set().
5789     *
5790     * @see elm_image_no_scale_get()
5791     * @see elm_image_scale_set()
5792     * @see elm_object_scale_set()
5793     *
5794     * @ingroup Image
5795     */
5796    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5797
5798    /**
5799     * Get whether scaling is disabled on the object.
5800     *
5801     * @param obj The image object
5802     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5803     *
5804     * @see elm_image_no_scale_set()
5805     *
5806     * @ingroup Image
5807     */
5808    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5809
5810    /**
5811     * Set if the object is (up/down) resizable.
5812     *
5813     * @param obj The image object
5814     * @param scale_up A bool to set if the object is resizable up. Default is
5815     * @c EINA_TRUE.
5816     * @param scale_down A bool to set if the object is resizable down. Default
5817     * is @c EINA_TRUE.
5818     *
5819     * This function limits the image resize ability. If @p scale_up is set to
5820     * @c EINA_FALSE, the object can't have its height or width resized to a value
5821     * higher than the original image size. Same is valid for @p scale_down.
5822     *
5823     * @see elm_image_scale_get()
5824     *
5825     * @ingroup Image
5826     */
5827    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5828
5829    /**
5830     * Get if the object is (up/down) resizable.
5831     *
5832     * @param obj The image object
5833     * @param scale_up A bool to set if the object is resizable up
5834     * @param scale_down A bool to set if the object is resizable down
5835     *
5836     * @see elm_image_scale_set()
5837     *
5838     * @ingroup Image
5839     */
5840    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5841
5842    /**
5843     * Set if the image fills the entire object area, when keeping the aspect ratio.
5844     *
5845     * @param obj The image object
5846     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5847     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5848     *
5849     * When the image should keep its aspect ratio even if resized to another
5850     * aspect ratio, there are two possibilities to resize it: keep the entire
5851     * image inside the limits of height and width of the object (@p fill_outside
5852     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5853     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5854     *
5855     * @note This option will have no effect if
5856     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5857     *
5858     * @see elm_image_fill_outside_get()
5859     * @see elm_image_aspect_ratio_retained_set()
5860     *
5861     * @ingroup Image
5862     */
5863    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5864
5865    /**
5866     * Get if the object is filled outside
5867     *
5868     * @param obj The image object
5869     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5870     *
5871     * @see elm_image_fill_outside_set()
5872     *
5873     * @ingroup Image
5874     */
5875    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5876
5877    /**
5878     * Set the prescale size for the image
5879     *
5880     * @param obj The image object
5881     * @param size The prescale size. This value is used for both width and
5882     * height.
5883     *
5884     * This function sets a new size for pixmap representation of the given
5885     * image. It allows the image to be loaded already in the specified size,
5886     * reducing the memory usage and load time when loading a big image with load
5887     * size set to a smaller size.
5888     *
5889     * It's equivalent to the elm_bg_load_size_set() function for bg.
5890     *
5891     * @note this is just a hint, the real size of the pixmap may differ
5892     * depending on the type of image being loaded, being bigger than requested.
5893     *
5894     * @see elm_image_prescale_get()
5895     * @see elm_bg_load_size_set()
5896     *
5897     * @ingroup Image
5898     */
5899    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5900
5901    /**
5902     * Get the prescale size for the image
5903     *
5904     * @param obj The image object
5905     * @return The prescale size
5906     *
5907     * @see elm_image_prescale_set()
5908     *
5909     * @ingroup Image
5910     */
5911    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5912
5913    /**
5914     * Set the image orientation.
5915     *
5916     * @param obj The image object
5917     * @param orient The image orientation @ref Elm_Image_Orient
5918     *  Default is #ELM_IMAGE_ORIENT_NONE.
5919     *
5920     * This function allows to rotate or flip the given image.
5921     *
5922     * @see elm_image_orient_get()
5923     * @see @ref Elm_Image_Orient
5924     *
5925     * @ingroup Image
5926     */
5927    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5928
5929    /**
5930     * Get the image orientation.
5931     *
5932     * @param obj The image object
5933     * @return The image orientation @ref Elm_Image_Orient
5934     *
5935     * @see elm_image_orient_set()
5936     * @see @ref Elm_Image_Orient
5937     *
5938     * @ingroup Image
5939     */
5940    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5941
5942    /**
5943     * Make the image 'editable'.
5944     *
5945     * @param obj Image object.
5946     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5947     *
5948     * This means the image is a valid drag target for drag and drop, and can be
5949     * cut or pasted too.
5950     *
5951     * @ingroup Image
5952     */
5953    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5954
5955    /**
5956     * Check if the image 'editable'.
5957     *
5958     * @param obj Image object.
5959     * @return Editability.
5960     *
5961     * A return value of EINA_TRUE means the image is a valid drag target
5962     * for drag and drop, and can be cut or pasted too.
5963     *
5964     * @ingroup Image
5965     */
5966    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5967
5968    /**
5969     * Get the basic Evas_Image object from this object (widget).
5970     *
5971     * @param obj The image object to get the inlined image from
5972     * @return The inlined image object, or NULL if none exists
5973     *
5974     * This function allows one to get the underlying @c Evas_Object of type
5975     * Image from this elementary widget. It can be useful to do things like get
5976     * the pixel data, save the image to a file, etc.
5977     *
5978     * @note Be careful to not manipulate it, as it is under control of
5979     * elementary.
5980     *
5981     * @ingroup Image
5982     */
5983    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5984
5985    /**
5986     * Set whether the original aspect ratio of the image should be kept on resize.
5987     *
5988     * @param obj The image object.
5989     * @param retained @c EINA_TRUE if the image should retain the aspect,
5990     * @c EINA_FALSE otherwise.
5991     *
5992     * The original aspect ratio (width / height) of the image is usually
5993     * distorted to match the object's size. Enabling this option will retain
5994     * this original aspect, and the way that the image is fit into the object's
5995     * area depends on the option set by elm_image_fill_outside_set().
5996     *
5997     * @see elm_image_aspect_ratio_retained_get()
5998     * @see elm_image_fill_outside_set()
5999     *
6000     * @ingroup Image
6001     */
6002    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
6003
6004    /**
6005     * Get if the object retains the original aspect ratio.
6006     *
6007     * @param obj The image object.
6008     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
6009     * otherwise.
6010     *
6011     * @ingroup Image
6012     */
6013    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6014
6015    /**
6016     * @}
6017     */
6018
6019    /* glview */
6020    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
6021
6022    typedef enum _Elm_GLView_Mode
6023      {
6024         ELM_GLVIEW_ALPHA   = 1,
6025         ELM_GLVIEW_DEPTH   = 2,
6026         ELM_GLVIEW_STENCIL = 4
6027      } Elm_GLView_Mode;
6028
6029    /**
6030     * Defines a policy for the glview resizing.
6031     *
6032     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
6033     */
6034    typedef enum _Elm_GLView_Resize_Policy
6035      {
6036         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
6037         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
6038      } Elm_GLView_Resize_Policy;
6039
6040    typedef enum _Elm_GLView_Render_Policy
6041      {
6042         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
6043         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
6044      } Elm_GLView_Render_Policy;
6045
6046    /**
6047     * @defgroup GLView
6048     *
6049     * A simple GLView widget that allows GL rendering.
6050     *
6051     * Signals that you can add callbacks for are:
6052     *
6053     * @{
6054     */
6055
6056    /**
6057     * Add a new glview to the parent
6058     *
6059     * @param parent The parent object
6060     * @return The new object or NULL if it cannot be created
6061     *
6062     * @ingroup GLView
6063     */
6064    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6065
6066    /**
6067     * Sets the size of the glview
6068     *
6069     * @param obj The glview object
6070     * @param width width of the glview object
6071     * @param height height of the glview object
6072     *
6073     * @ingroup GLView
6074     */
6075    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6076
6077    /**
6078     * Gets the size of the glview.
6079     *
6080     * @param obj The glview object
6081     * @param width width of the glview object
6082     * @param height height of the glview object
6083     *
6084     * Note that this function returns the actual image size of the
6085     * glview.  This means that when the scale policy is set to
6086     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
6087     * size.
6088     *
6089     * @ingroup GLView
6090     */
6091    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6092
6093    /**
6094     * Gets the gl api struct for gl rendering
6095     *
6096     * @param obj The glview object
6097     * @return The api object or NULL if it cannot be created
6098     *
6099     * @ingroup GLView
6100     */
6101    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6102
6103    /**
6104     * Set the mode of the GLView. Supports Three simple modes.
6105     *
6106     * @param obj The glview object
6107     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
6108     * @return True if set properly.
6109     *
6110     * @ingroup GLView
6111     */
6112    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
6113
6114    /**
6115     * Set the resize policy for the glview object.
6116     *
6117     * @param obj The glview object.
6118     * @param policy The scaling policy.
6119     *
6120     * By default, the resize policy is set to
6121     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
6122     * destroys the previous surface and recreates the newly specified
6123     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
6124     * however, glview only scales the image object and not the underlying
6125     * GL Surface.
6126     *
6127     * @ingroup GLView
6128     */
6129    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
6130
6131    /**
6132     * Set the render policy for the glview object.
6133     *
6134     * @param obj The glview object.
6135     * @param policy The render policy.
6136     *
6137     * By default, the render policy is set to
6138     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
6139     * that during the render loop, glview is only redrawn if it needs
6140     * to be redrawn. (i.e. When it is visible) If the policy is set to
6141     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
6142     * whether it is visible/need redrawing or not.
6143     *
6144     * @ingroup GLView
6145     */
6146    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
6147
6148    /**
6149     * Set the init function that runs once in the main loop.
6150     *
6151     * @param obj The glview object.
6152     * @param func The init function to be registered.
6153     *
6154     * The registered init function gets called once during the render loop.
6155     *
6156     * @ingroup GLView
6157     */
6158    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6159
6160    /**
6161     * Set the render function that runs in the main loop.
6162     *
6163     * @param obj The glview object.
6164     * @param func The delete function to be registered.
6165     *
6166     * The registered del function gets called when GLView object is deleted.
6167     *
6168     * @ingroup GLView
6169     */
6170    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6171
6172    /**
6173     * Set the resize function that gets called when resize happens.
6174     *
6175     * @param obj The glview object.
6176     * @param func The resize function to be registered.
6177     *
6178     * @ingroup GLView
6179     */
6180    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6181
6182    /**
6183     * Set the render function that runs in the main loop.
6184     *
6185     * @param obj The glview object.
6186     * @param func The render function to be registered.
6187     *
6188     * @ingroup GLView
6189     */
6190    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6191
6192    /**
6193     * Notifies that there has been changes in the GLView.
6194     *
6195     * @param obj The glview object.
6196     *
6197     * @ingroup GLView
6198     */
6199    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6200
6201    /**
6202     * @}
6203     */
6204
6205    /* box */
6206    /**
6207     * @defgroup Box Box
6208     *
6209     * @image html img/widget/box/preview-00.png
6210     * @image latex img/widget/box/preview-00.eps width=\textwidth
6211     *
6212     * @image html img/box.png
6213     * @image latex img/box.eps width=\textwidth
6214     *
6215     * A box arranges objects in a linear fashion, governed by a layout function
6216     * that defines the details of this arrangement.
6217     *
6218     * By default, the box will use an internal function to set the layout to
6219     * a single row, either vertical or horizontal. This layout is affected
6220     * by a number of parameters, such as the homogeneous flag set by
6221     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
6222     * elm_box_align_set() and the hints set to each object in the box.
6223     *
6224     * For this default layout, it's possible to change the orientation with
6225     * elm_box_horizontal_set(). The box will start in the vertical orientation,
6226     * placing its elements ordered from top to bottom. When horizontal is set,
6227     * the order will go from left to right. If the box is set to be
6228     * homogeneous, every object in it will be assigned the same space, that
6229     * of the largest object. Padding can be used to set some spacing between
6230     * the cell given to each object. The alignment of the box, set with
6231     * elm_box_align_set(), determines how the bounding box of all the elements
6232     * will be placed within the space given to the box widget itself.
6233     *
6234     * The size hints of each object also affect how they are placed and sized
6235     * within the box. evas_object_size_hint_min_set() will give the minimum
6236     * size the object can have, and the box will use it as the basis for all
6237     * latter calculations. Elementary widgets set their own minimum size as
6238     * needed, so there's rarely any need to use it manually.
6239     *
6240     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
6241     * used to tell whether the object will be allocated the minimum size it
6242     * needs or if the space given to it should be expanded. It's important
6243     * to realize that expanding the size given to the object is not the same
6244     * thing as resizing the object. It could very well end being a small
6245     * widget floating in a much larger empty space. If not set, the weight
6246     * for objects will normally be 0.0 for both axis, meaning the widget will
6247     * not be expanded. To take as much space possible, set the weight to
6248     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
6249     *
6250     * Besides how much space each object is allocated, it's possible to control
6251     * how the widget will be placed within that space using
6252     * evas_object_size_hint_align_set(). By default, this value will be 0.5
6253     * for both axis, meaning the object will be centered, but any value from
6254     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
6255     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6256     * is -1.0, means the object will be resized to fill the entire space it
6257     * was allocated.
6258     *
6259     * In addition, customized functions to define the layout can be set, which
6260     * allow the application developer to organize the objects within the box
6261     * in any number of ways.
6262     *
6263     * The special elm_box_layout_transition() function can be used
6264     * to switch from one layout to another, animating the motion of the
6265     * children of the box.
6266     *
6267     * @note Objects should not be added to box objects using _add() calls.
6268     *
6269     * Some examples on how to use boxes follow:
6270     * @li @ref box_example_01
6271     * @li @ref box_example_02
6272     *
6273     * @{
6274     */
6275    /**
6276     * @typedef Elm_Box_Transition
6277     *
6278     * Opaque handler containing the parameters to perform an animated
6279     * transition of the layout the box uses.
6280     *
6281     * @see elm_box_transition_new()
6282     * @see elm_box_layout_set()
6283     * @see elm_box_layout_transition()
6284     */
6285    typedef struct _Elm_Box_Transition Elm_Box_Transition;
6286
6287    /**
6288     * Add a new box to the parent
6289     *
6290     * By default, the box will be in vertical mode and non-homogeneous.
6291     *
6292     * @param parent The parent object
6293     * @return The new object or NULL if it cannot be created
6294     */
6295    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6296
6297    /**
6298     * Set the horizontal orientation
6299     *
6300     * By default, box object arranges their contents vertically from top to
6301     * bottom.
6302     * By calling this function with @p horizontal as EINA_TRUE, the box will
6303     * become horizontal, arranging contents from left to right.
6304     *
6305     * @note This flag is ignored if a custom layout function is set.
6306     *
6307     * @param obj The box object
6308     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6309     * EINA_FALSE = vertical)
6310     */
6311    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6312
6313    /**
6314     * Get the horizontal orientation
6315     *
6316     * @param obj The box object
6317     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6318     */
6319    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6320
6321    /**
6322     * Set the box to arrange its children homogeneously
6323     *
6324     * If enabled, homogeneous layout makes all items the same size, according
6325     * to the size of the largest of its children.
6326     *
6327     * @note This flag is ignored if a custom layout function is set.
6328     *
6329     * @param obj The box object
6330     * @param homogeneous The homogeneous flag
6331     */
6332    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6333
6334    /**
6335     * Get whether the box is using homogeneous mode or not
6336     *
6337     * @param obj The box object
6338     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6339     */
6340    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6341
6342    /**
6343     * Add an object to the beginning of the pack list
6344     *
6345     * Pack @p subobj into the box @p obj, placing it first in the list of
6346     * children objects. The actual position the object will get on screen
6347     * depends on the layout used. If no custom layout is set, it will be at
6348     * the top or left, depending if the box is vertical or horizontal,
6349     * respectively.
6350     *
6351     * @param obj The box object
6352     * @param subobj The object to add to the box
6353     *
6354     * @see elm_box_pack_end()
6355     * @see elm_box_pack_before()
6356     * @see elm_box_pack_after()
6357     * @see elm_box_unpack()
6358     * @see elm_box_unpack_all()
6359     * @see elm_box_clear()
6360     */
6361    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6362
6363    /**
6364     * Add an object at the end of the pack list
6365     *
6366     * Pack @p subobj into the box @p obj, placing it last in the list of
6367     * children objects. The actual position the object will get on screen
6368     * depends on the layout used. If no custom layout is set, it will be at
6369     * the bottom or right, depending if the box is vertical or horizontal,
6370     * respectively.
6371     *
6372     * @param obj The box object
6373     * @param subobj The object to add to the box
6374     *
6375     * @see elm_box_pack_start()
6376     * @see elm_box_pack_before()
6377     * @see elm_box_pack_after()
6378     * @see elm_box_unpack()
6379     * @see elm_box_unpack_all()
6380     * @see elm_box_clear()
6381     */
6382    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6383
6384    /**
6385     * Adds an object to the box before the indicated object
6386     *
6387     * This will add the @p subobj to the box indicated before the object
6388     * indicated with @p before. If @p before is not already in the box, results
6389     * are undefined. Before means either to the left of the indicated object or
6390     * above it depending on orientation.
6391     *
6392     * @param obj The box object
6393     * @param subobj The object to add to the box
6394     * @param before The object before which to add it
6395     *
6396     * @see elm_box_pack_start()
6397     * @see elm_box_pack_end()
6398     * @see elm_box_pack_after()
6399     * @see elm_box_unpack()
6400     * @see elm_box_unpack_all()
6401     * @see elm_box_clear()
6402     */
6403    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6404
6405    /**
6406     * Adds an object to the box after the indicated object
6407     *
6408     * This will add the @p subobj to the box indicated after the object
6409     * indicated with @p after. If @p after is not already in the box, results
6410     * are undefined. After means either to the right of the indicated object or
6411     * below it depending on orientation.
6412     *
6413     * @param obj The box object
6414     * @param subobj The object to add to the box
6415     * @param after The object after which to add it
6416     *
6417     * @see elm_box_pack_start()
6418     * @see elm_box_pack_end()
6419     * @see elm_box_pack_before()
6420     * @see elm_box_unpack()
6421     * @see elm_box_unpack_all()
6422     * @see elm_box_clear()
6423     */
6424    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6425
6426    /**
6427     * Clear the box of all children
6428     *
6429     * Remove all the elements contained by the box, deleting the respective
6430     * objects.
6431     *
6432     * @param obj The box object
6433     *
6434     * @see elm_box_unpack()
6435     * @see elm_box_unpack_all()
6436     */
6437    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6438
6439    /**
6440     * Unpack a box item
6441     *
6442     * Remove the object given by @p subobj from the box @p obj without
6443     * deleting it.
6444     *
6445     * @param obj The box object
6446     *
6447     * @see elm_box_unpack_all()
6448     * @see elm_box_clear()
6449     */
6450    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6451
6452    /**
6453     * Remove all items from the box, without deleting them
6454     *
6455     * Clear the box from all children, but don't delete the respective objects.
6456     * If no other references of the box children exist, the objects will never
6457     * be deleted, and thus the application will leak the memory. Make sure
6458     * when using this function that you hold a reference to all the objects
6459     * in the box @p obj.
6460     *
6461     * @param obj The box object
6462     *
6463     * @see elm_box_clear()
6464     * @see elm_box_unpack()
6465     */
6466    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6467
6468    /**
6469     * Retrieve a list of the objects packed into the box
6470     *
6471     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6472     * The order of the list corresponds to the packing order the box uses.
6473     *
6474     * You must free this list with eina_list_free() once you are done with it.
6475     *
6476     * @param obj The box object
6477     */
6478    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6479
6480    /**
6481     * Set the space (padding) between the box's elements.
6482     *
6483     * Extra space in pixels that will be added between a box child and its
6484     * neighbors after its containing cell has been calculated. This padding
6485     * is set for all elements in the box, besides any possible padding that
6486     * individual elements may have through their size hints.
6487     *
6488     * @param obj The box object
6489     * @param horizontal The horizontal space between elements
6490     * @param vertical The vertical space between elements
6491     */
6492    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6493
6494    /**
6495     * Get the space (padding) between the box's elements.
6496     *
6497     * @param obj The box object
6498     * @param horizontal The horizontal space between elements
6499     * @param vertical The vertical space between elements
6500     *
6501     * @see elm_box_padding_set()
6502     */
6503    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6504
6505    /**
6506     * Set the alignment of the whole bouding box of contents.
6507     *
6508     * Sets how the bounding box containing all the elements of the box, after
6509     * their sizes and position has been calculated, will be aligned within
6510     * the space given for the whole box widget.
6511     *
6512     * @param obj The box object
6513     * @param horizontal The horizontal alignment of elements
6514     * @param vertical The vertical alignment of elements
6515     */
6516    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6517
6518    /**
6519     * Get the alignment of the whole bouding box of contents.
6520     *
6521     * @param obj The box object
6522     * @param horizontal The horizontal alignment of elements
6523     * @param vertical The vertical alignment of elements
6524     *
6525     * @see elm_box_align_set()
6526     */
6527    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6528
6529    /**
6530     * Force the box to recalculate its children packing.
6531     *
6532     * If any children was added or removed, box will not calculate the
6533     * values immediately rather leaving it to the next main loop
6534     * iteration. While this is great as it would save lots of
6535     * recalculation, whenever you need to get the position of a just
6536     * added item you must force recalculate before doing so.
6537     *
6538     * @param obj The box object.
6539     */
6540    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6541
6542    /**
6543     * Set the layout defining function to be used by the box
6544     *
6545     * Whenever anything changes that requires the box in @p obj to recalculate
6546     * the size and position of its elements, the function @p cb will be called
6547     * to determine what the layout of the children will be.
6548     *
6549     * Once a custom function is set, everything about the children layout
6550     * is defined by it. The flags set by elm_box_horizontal_set() and
6551     * elm_box_homogeneous_set() no longer have any meaning, and the values
6552     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6553     * layout function to decide if they are used and how. These last two
6554     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6555     * passed to @p cb. The @c Evas_Object the function receives is not the
6556     * Elementary widget, but the internal Evas Box it uses, so none of the
6557     * functions described here can be used on it.
6558     *
6559     * Any of the layout functions in @c Evas can be used here, as well as the
6560     * special elm_box_layout_transition().
6561     *
6562     * The final @p data argument received by @p cb is the same @p data passed
6563     * here, and the @p free_data function will be called to free it
6564     * whenever the box is destroyed or another layout function is set.
6565     *
6566     * Setting @p cb to NULL will revert back to the default layout function.
6567     *
6568     * @param obj The box object
6569     * @param cb The callback function used for layout
6570     * @param data Data that will be passed to layout function
6571     * @param free_data Function called to free @p data
6572     *
6573     * @see elm_box_layout_transition()
6574     */
6575    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);
6576
6577    /**
6578     * Special layout function that animates the transition from one layout to another
6579     *
6580     * Normally, when switching the layout function for a box, this will be
6581     * reflected immediately on screen on the next render, but it's also
6582     * possible to do this through an animated transition.
6583     *
6584     * This is done by creating an ::Elm_Box_Transition and setting the box
6585     * layout to this function.
6586     *
6587     * For example:
6588     * @code
6589     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6590     *                            evas_object_box_layout_vertical, // start
6591     *                            NULL, // data for initial layout
6592     *                            NULL, // free function for initial data
6593     *                            evas_object_box_layout_horizontal, // end
6594     *                            NULL, // data for final layout
6595     *                            NULL, // free function for final data
6596     *                            anim_end, // will be called when animation ends
6597     *                            NULL); // data for anim_end function\
6598     * elm_box_layout_set(box, elm_box_layout_transition, t,
6599     *                    elm_box_transition_free);
6600     * @endcode
6601     *
6602     * @note This function can only be used with elm_box_layout_set(). Calling
6603     * it directly will not have the expected results.
6604     *
6605     * @see elm_box_transition_new
6606     * @see elm_box_transition_free
6607     * @see elm_box_layout_set
6608     */
6609    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6610
6611    /**
6612     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6613     *
6614     * If you want to animate the change from one layout to another, you need
6615     * to set the layout function of the box to elm_box_layout_transition(),
6616     * passing as user data to it an instance of ::Elm_Box_Transition with the
6617     * necessary information to perform this animation. The free function to
6618     * set for the layout is elm_box_transition_free().
6619     *
6620     * The parameters to create an ::Elm_Box_Transition sum up to how long
6621     * will it be, in seconds, a layout function to describe the initial point,
6622     * another for the final position of the children and one function to be
6623     * called when the whole animation ends. This last function is useful to
6624     * set the definitive layout for the box, usually the same as the end
6625     * layout for the animation, but could be used to start another transition.
6626     *
6627     * @param start_layout The layout function that will be used to start the animation
6628     * @param start_layout_data The data to be passed the @p start_layout function
6629     * @param start_layout_free_data Function to free @p start_layout_data
6630     * @param end_layout The layout function that will be used to end the animation
6631     * @param end_layout_free_data The data to be passed the @p end_layout function
6632     * @param end_layout_free_data Function to free @p end_layout_data
6633     * @param transition_end_cb Callback function called when animation ends
6634     * @param transition_end_data Data to be passed to @p transition_end_cb
6635     * @return An instance of ::Elm_Box_Transition
6636     *
6637     * @see elm_box_transition_new
6638     * @see elm_box_layout_transition
6639     */
6640    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);
6641
6642    /**
6643     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6644     *
6645     * This function is mostly useful as the @c free_data parameter in
6646     * elm_box_layout_set() when elm_box_layout_transition().
6647     *
6648     * @param data The Elm_Box_Transition instance to be freed.
6649     *
6650     * @see elm_box_transition_new
6651     * @see elm_box_layout_transition
6652     */
6653    EAPI void                elm_box_transition_free(void *data);
6654
6655    /**
6656     * @}
6657     */
6658
6659    /* button */
6660    /**
6661     * @defgroup Button Button
6662     *
6663     * @image html img/widget/button/preview-00.png
6664     * @image latex img/widget/button/preview-00.eps
6665     * @image html img/widget/button/preview-01.png
6666     * @image latex img/widget/button/preview-01.eps
6667     * @image html img/widget/button/preview-02.png
6668     * @image latex img/widget/button/preview-02.eps
6669     *
6670     * This is a push-button. Press it and run some function. It can contain
6671     * a simple label and icon object and it also has an autorepeat feature.
6672     *
6673     * This widgets emits the following signals:
6674     * @li "clicked": the user clicked the button (press/release).
6675     * @li "repeated": the user pressed the button without releasing it.
6676     * @li "pressed": button was pressed.
6677     * @li "unpressed": button was released after being pressed.
6678     * In all three cases, the @c event parameter of the callback will be
6679     * @c NULL.
6680     *
6681     * Also, defined in the default theme, the button has the following styles
6682     * available:
6683     * @li default: a normal button.
6684     * @li anchor: Like default, but the button fades away when the mouse is not
6685     * over it, leaving only the text or icon.
6686     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6687     * continuous look across its options.
6688     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6689     *
6690     * Default contents parts of the button widget that you can use for are:
6691     * @li "icon" - An icon of the button
6692     *
6693     * Default text parts of the button widget that you can use for are:
6694     * @li "default" - Label of the button
6695     *
6696     * Follow through a complete example @ref button_example_01 "here".
6697     * @{
6698     */
6699
6700    /**
6701     * Add a new button to the parent's canvas
6702     *
6703     * @param parent The parent object
6704     * @return The new object or NULL if it cannot be created
6705     */
6706    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6707
6708    /**
6709     * Set the label used in the button
6710     *
6711     * The passed @p label can be NULL to clean any existing text in it and
6712     * leave the button as an icon only object.
6713     *
6714     * @param obj The button object
6715     * @param label The text will be written on the button
6716     * @deprecated use elm_object_text_set() instead.
6717     */
6718    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6719
6720    /**
6721     * Get the label set for the button
6722     *
6723     * The string returned is an internal pointer and should not be freed or
6724     * altered. It will also become invalid when the button is destroyed.
6725     * The string returned, if not NULL, is a stringshare, so if you need to
6726     * keep it around even after the button is destroyed, you can use
6727     * eina_stringshare_ref().
6728     *
6729     * @param obj The button object
6730     * @return The text set to the label, or NULL if nothing is set
6731     * @deprecated use elm_object_text_set() instead.
6732     */
6733    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6734
6735    /**
6736     * Set the icon used for the button
6737     *
6738     * Setting a new icon will delete any other that was previously set, making
6739     * any reference to them invalid. If you need to maintain the previous
6740     * object alive, unset it first with elm_button_icon_unset().
6741     *
6742     * @param obj The button object
6743     * @param icon The icon object for the button
6744     * @deprecated use elm_object_part_content_set() instead.
6745     */
6746    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6747
6748    /**
6749     * Get the icon used for the button
6750     *
6751     * Return the icon object which is set for this widget. If the button is
6752     * destroyed or another icon is set, the returned object will be deleted
6753     * and any reference to it will be invalid.
6754     *
6755     * @param obj The button object
6756     * @return The icon object that is being used
6757     *
6758     * @deprecated use elm_object_part_content_get() instead
6759     */
6760    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6761
6762    /**
6763     * Remove the icon set without deleting it and return the object
6764     *
6765     * This function drops the reference the button holds of the icon object
6766     * and returns this last object. It is used in case you want to remove any
6767     * icon, or set another one, without deleting the actual object. The button
6768     * will be left without an icon set.
6769     *
6770     * @param obj The button object
6771     * @return The icon object that was being used
6772     * @deprecated use elm_object_part_content_unset() instead.
6773     */
6774    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6775
6776    /**
6777     * Turn on/off the autorepeat event generated when the button is kept pressed
6778     *
6779     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6780     * signal when they are clicked.
6781     *
6782     * When on, keeping a button pressed will continuously emit a @c repeated
6783     * signal until the button is released. The time it takes until it starts
6784     * emitting the signal is given by
6785     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6786     * new emission by elm_button_autorepeat_gap_timeout_set().
6787     *
6788     * @param obj The button object
6789     * @param on  A bool to turn on/off the event
6790     */
6791    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6792
6793    /**
6794     * Get whether the autorepeat feature is enabled
6795     *
6796     * @param obj The button object
6797     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6798     *
6799     * @see elm_button_autorepeat_set()
6800     */
6801    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6802
6803    /**
6804     * Set the initial timeout before the autorepeat event is generated
6805     *
6806     * Sets the timeout, in seconds, since the button is pressed until the
6807     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6808     * won't be any delay and the even will be fired the moment the button is
6809     * pressed.
6810     *
6811     * @param obj The button object
6812     * @param t   Timeout in seconds
6813     *
6814     * @see elm_button_autorepeat_set()
6815     * @see elm_button_autorepeat_gap_timeout_set()
6816     */
6817    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6818
6819    /**
6820     * Get the initial timeout before the autorepeat event is generated
6821     *
6822     * @param obj The button object
6823     * @return Timeout in seconds
6824     *
6825     * @see elm_button_autorepeat_initial_timeout_set()
6826     */
6827    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6828
6829    /**
6830     * Set the interval between each generated autorepeat event
6831     *
6832     * After the first @c repeated event is fired, all subsequent ones will
6833     * follow after a delay of @p t seconds for each.
6834     *
6835     * @param obj The button object
6836     * @param t   Interval in seconds
6837     *
6838     * @see elm_button_autorepeat_initial_timeout_set()
6839     */
6840    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6841
6842    /**
6843     * Get the interval between each generated autorepeat event
6844     *
6845     * @param obj The button object
6846     * @return Interval in seconds
6847     */
6848    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6849
6850    /**
6851     * @}
6852     */
6853
6854    /**
6855     * @defgroup File_Selector_Button File Selector Button
6856     *
6857     * @image html img/widget/fileselector_button/preview-00.png
6858     * @image latex img/widget/fileselector_button/preview-00.eps
6859     * @image html img/widget/fileselector_button/preview-01.png
6860     * @image latex img/widget/fileselector_button/preview-01.eps
6861     * @image html img/widget/fileselector_button/preview-02.png
6862     * @image latex img/widget/fileselector_button/preview-02.eps
6863     *
6864     * This is a button that, when clicked, creates an Elementary
6865     * window (or inner window) <b> with a @ref Fileselector "file
6866     * selector widget" within</b>. When a file is chosen, the (inner)
6867     * window is closed and the button emits a signal having the
6868     * selected file as it's @c event_info.
6869     *
6870     * This widget encapsulates operations on its internal file
6871     * selector on its own API. There is less control over its file
6872     * selector than that one would have instatiating one directly.
6873     *
6874     * The following styles are available for this button:
6875     * @li @c "default"
6876     * @li @c "anchor"
6877     * @li @c "hoversel_vertical"
6878     * @li @c "hoversel_vertical_entry"
6879     *
6880     * Smart callbacks one can register to:
6881     * - @c "file,chosen" - the user has selected a path, whose string
6882     *   pointer comes as the @c event_info data (a stringshared
6883     *   string)
6884     *
6885     * Here is an example on its usage:
6886     * @li @ref fileselector_button_example
6887     *
6888     * @see @ref File_Selector_Entry for a similar widget.
6889     * @{
6890     */
6891
6892    /**
6893     * Add a new file selector button widget to the given parent
6894     * Elementary (container) object
6895     *
6896     * @param parent The parent object
6897     * @return a new file selector button widget handle or @c NULL, on
6898     * errors
6899     */
6900    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6901
6902    /**
6903     * Set the label for a given file selector button widget
6904     *
6905     * @param obj The file selector button widget
6906     * @param label The text label to be displayed on @p obj
6907     *
6908     * @deprecated use elm_object_text_set() instead.
6909     */
6910    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6911
6912    /**
6913     * Get the label set for a given file selector button widget
6914     *
6915     * @param obj The file selector button widget
6916     * @return The button label
6917     *
6918     * @deprecated use elm_object_text_set() instead.
6919     */
6920    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6921
6922    /**
6923     * Set the icon on a given file selector button widget
6924     *
6925     * @param obj The file selector button widget
6926     * @param icon The icon object for the button
6927     *
6928     * Once the icon object is set, a previously set one will be
6929     * deleted. If you want to keep the latter, use the
6930     * elm_fileselector_button_icon_unset() function.
6931     *
6932     * @see elm_fileselector_button_icon_get()
6933     */
6934    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6935
6936    /**
6937     * Get the icon set for a given file selector button widget
6938     *
6939     * @param obj The file selector button widget
6940     * @return The icon object currently set on @p obj or @c NULL, if
6941     * none is
6942     *
6943     * @see elm_fileselector_button_icon_set()
6944     */
6945    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6946
6947    /**
6948     * Unset the icon used in a given file selector button widget
6949     *
6950     * @param obj The file selector button widget
6951     * @return The icon object that was being used on @p obj or @c
6952     * NULL, on errors
6953     *
6954     * Unparent and return the icon object which was set for this
6955     * widget.
6956     *
6957     * @see elm_fileselector_button_icon_set()
6958     */
6959    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6960
6961    /**
6962     * Set the title for a given file selector button widget's window
6963     *
6964     * @param obj The file selector button widget
6965     * @param title The title string
6966     *
6967     * This will change the window's title, when the file selector pops
6968     * out after a click on the button. Those windows have the default
6969     * (unlocalized) value of @c "Select a file" as titles.
6970     *
6971     * @note It will only take any effect if the file selector
6972     * button widget is @b not under "inwin mode".
6973     *
6974     * @see elm_fileselector_button_window_title_get()
6975     */
6976    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6977
6978    /**
6979     * Get the title set for a given file selector button widget's
6980     * window
6981     *
6982     * @param obj The file selector button widget
6983     * @return Title of the file selector button's window
6984     *
6985     * @see elm_fileselector_button_window_title_get() for more details
6986     */
6987    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6988
6989    /**
6990     * Set the size of a given file selector button widget's window,
6991     * holding the file selector itself.
6992     *
6993     * @param obj The file selector button widget
6994     * @param width The window's width
6995     * @param height The window's height
6996     *
6997     * @note it will only take any effect if the file selector button
6998     * widget is @b not under "inwin mode". The default size for the
6999     * window (when applicable) is 400x400 pixels.
7000     *
7001     * @see elm_fileselector_button_window_size_get()
7002     */
7003    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7004
7005    /**
7006     * Get the size of a given file selector button widget's window,
7007     * holding the file selector itself.
7008     *
7009     * @param obj The file selector button widget
7010     * @param width Pointer into which to store the width value
7011     * @param height Pointer into which to store the height value
7012     *
7013     * @note Use @c NULL pointers on the size values you're not
7014     * interested in: they'll be ignored by the function.
7015     *
7016     * @see elm_fileselector_button_window_size_set(), for more details
7017     */
7018    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7019
7020    /**
7021     * Set the initial file system path for a given file selector
7022     * button widget
7023     *
7024     * @param obj The file selector button widget
7025     * @param path The path string
7026     *
7027     * It must be a <b>directory</b> path, which will have the contents
7028     * displayed initially in the file selector's view, when invoked
7029     * from @p obj. The default initial path is the @c "HOME"
7030     * environment variable's value.
7031     *
7032     * @see elm_fileselector_button_path_get()
7033     */
7034    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7035
7036    /**
7037     * Get the initial file system path set for a given file selector
7038     * button widget
7039     *
7040     * @param obj The file selector button widget
7041     * @return path The path string
7042     *
7043     * @see elm_fileselector_button_path_set() for more details
7044     */
7045    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7046
7047    /**
7048     * Enable/disable a tree view in the given file selector button
7049     * widget's internal file selector
7050     *
7051     * @param obj The file selector button widget
7052     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7053     * disable
7054     *
7055     * This has the same effect as elm_fileselector_expandable_set(),
7056     * but now applied to a file selector button's internal file
7057     * selector.
7058     *
7059     * @note There's no way to put a file selector button's internal
7060     * file selector in "grid mode", as one may do with "pure" file
7061     * selectors.
7062     *
7063     * @see elm_fileselector_expandable_get()
7064     */
7065    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7066
7067    /**
7068     * Get whether tree view is enabled for the given file selector
7069     * button widget's internal file selector
7070     *
7071     * @param obj The file selector button widget
7072     * @return @c EINA_TRUE if @p obj widget's internal file selector
7073     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7074     *
7075     * @see elm_fileselector_expandable_set() for more details
7076     */
7077    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7078
7079    /**
7080     * Set whether a given file selector button widget's internal file
7081     * selector is to display folders only or the directory contents,
7082     * as well.
7083     *
7084     * @param obj The file selector button widget
7085     * @param only @c EINA_TRUE to make @p obj widget's internal file
7086     * selector only display directories, @c EINA_FALSE to make files
7087     * to be displayed in it too
7088     *
7089     * This has the same effect as elm_fileselector_folder_only_set(),
7090     * but now applied to a file selector button's internal file
7091     * selector.
7092     *
7093     * @see elm_fileselector_folder_only_get()
7094     */
7095    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7096
7097    /**
7098     * Get whether a given file selector button widget's internal file
7099     * selector is displaying folders only or the directory contents,
7100     * as well.
7101     *
7102     * @param obj The file selector button widget
7103     * @return @c EINA_TRUE if @p obj widget's internal file
7104     * selector is only displaying directories, @c EINA_FALSE if files
7105     * are being displayed in it too (and on errors)
7106     *
7107     * @see elm_fileselector_button_folder_only_set() for more details
7108     */
7109    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7110
7111    /**
7112     * Enable/disable the file name entry box where the user can type
7113     * in a name for a file, in a given file selector button widget's
7114     * internal file selector.
7115     *
7116     * @param obj The file selector button widget
7117     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7118     * file selector a "saving dialog", @c EINA_FALSE otherwise
7119     *
7120     * This has the same effect as elm_fileselector_is_save_set(),
7121     * but now applied to a file selector button's internal file
7122     * selector.
7123     *
7124     * @see elm_fileselector_is_save_get()
7125     */
7126    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7127
7128    /**
7129     * Get whether the given file selector button widget's internal
7130     * file selector is in "saving dialog" mode
7131     *
7132     * @param obj The file selector button widget
7133     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7134     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7135     * errors)
7136     *
7137     * @see elm_fileselector_button_is_save_set() for more details
7138     */
7139    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7140
7141    /**
7142     * Set whether a given file selector button widget's internal file
7143     * selector will raise an Elementary "inner window", instead of a
7144     * dedicated Elementary window. By default, it won't.
7145     *
7146     * @param obj The file selector button widget
7147     * @param value @c EINA_TRUE to make it use an inner window, @c
7148     * EINA_TRUE to make it use a dedicated window
7149     *
7150     * @see elm_win_inwin_add() for more information on inner windows
7151     * @see elm_fileselector_button_inwin_mode_get()
7152     */
7153    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7154
7155    /**
7156     * Get whether a given file selector button widget's internal file
7157     * selector will raise an Elementary "inner window", instead of a
7158     * dedicated Elementary window.
7159     *
7160     * @param obj The file selector button widget
7161     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7162     * if it will use a dedicated window
7163     *
7164     * @see elm_fileselector_button_inwin_mode_set() for more details
7165     */
7166    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7167
7168    /**
7169     * @}
7170     */
7171
7172     /**
7173     * @defgroup File_Selector_Entry File Selector Entry
7174     *
7175     * @image html img/widget/fileselector_entry/preview-00.png
7176     * @image latex img/widget/fileselector_entry/preview-00.eps
7177     *
7178     * This is an entry made to be filled with or display a <b>file
7179     * system path string</b>. Besides the entry itself, the widget has
7180     * a @ref File_Selector_Button "file selector button" on its side,
7181     * which will raise an internal @ref Fileselector "file selector widget",
7182     * when clicked, for path selection aided by file system
7183     * navigation.
7184     *
7185     * This file selector may appear in an Elementary window or in an
7186     * inner window. When a file is chosen from it, the (inner) window
7187     * is closed and the selected file's path string is exposed both as
7188     * an smart event and as the new text on the entry.
7189     *
7190     * This widget encapsulates operations on its internal file
7191     * selector on its own API. There is less control over its file
7192     * selector than that one would have instatiating one directly.
7193     *
7194     * Smart callbacks one can register to:
7195     * - @c "changed" - The text within the entry was changed
7196     * - @c "activated" - The entry has had editing finished and
7197     *   changes are to be "committed"
7198     * - @c "press" - The entry has been clicked
7199     * - @c "longpressed" - The entry has been clicked (and held) for a
7200     *   couple seconds
7201     * - @c "clicked" - The entry has been clicked
7202     * - @c "clicked,double" - The entry has been double clicked
7203     * - @c "focused" - The entry has received focus
7204     * - @c "unfocused" - The entry has lost focus
7205     * - @c "selection,paste" - A paste action has occurred on the
7206     *   entry
7207     * - @c "selection,copy" - A copy action has occurred on the entry
7208     * - @c "selection,cut" - A cut action has occurred on the entry
7209     * - @c "unpressed" - The file selector entry's button was released
7210     *   after being pressed.
7211     * - @c "file,chosen" - The user has selected a path via the file
7212     *   selector entry's internal file selector, whose string pointer
7213     *   comes as the @c event_info data (a stringshared string)
7214     *
7215     * Here is an example on its usage:
7216     * @li @ref fileselector_entry_example
7217     *
7218     * @see @ref File_Selector_Button for a similar widget.
7219     * @{
7220     */
7221
7222    /**
7223     * Add a new file selector entry widget to the given parent
7224     * Elementary (container) object
7225     *
7226     * @param parent The parent object
7227     * @return a new file selector entry widget handle or @c NULL, on
7228     * errors
7229     */
7230    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7231
7232    /**
7233     * Set the label for a given file selector entry widget's button
7234     *
7235     * @param obj The file selector entry widget
7236     * @param label The text label to be displayed on @p obj widget's
7237     * button
7238     *
7239     * @deprecated use elm_object_text_set() instead.
7240     */
7241    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7242
7243    /**
7244     * Get the label set for a given file selector entry widget's button
7245     *
7246     * @param obj The file selector entry widget
7247     * @return The widget button's label
7248     *
7249     * @deprecated use elm_object_text_set() instead.
7250     */
7251    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7252
7253    /**
7254     * Set the icon on a given file selector entry widget's button
7255     *
7256     * @param obj The file selector entry widget
7257     * @param icon The icon object for the entry's button
7258     *
7259     * Once the icon object is set, a previously set one will be
7260     * deleted. If you want to keep the latter, use the
7261     * elm_fileselector_entry_button_icon_unset() function.
7262     *
7263     * @see elm_fileselector_entry_button_icon_get()
7264     */
7265    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7266
7267    /**
7268     * Get the icon set for a given file selector entry widget's button
7269     *
7270     * @param obj The file selector entry widget
7271     * @return The icon object currently set on @p obj widget's button
7272     * or @c NULL, if none is
7273     *
7274     * @see elm_fileselector_entry_button_icon_set()
7275     */
7276    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7277
7278    /**
7279     * Unset the icon used in a given file selector entry widget's
7280     * button
7281     *
7282     * @param obj The file selector entry widget
7283     * @return The icon object that was being used on @p obj widget's
7284     * button or @c NULL, on errors
7285     *
7286     * Unparent and return the icon object which was set for this
7287     * widget's button.
7288     *
7289     * @see elm_fileselector_entry_button_icon_set()
7290     */
7291    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7292
7293    /**
7294     * Set the title for a given file selector entry widget's window
7295     *
7296     * @param obj The file selector entry widget
7297     * @param title The title string
7298     *
7299     * This will change the window's title, when the file selector pops
7300     * out after a click on the entry's button. Those windows have the
7301     * default (unlocalized) value of @c "Select a file" as titles.
7302     *
7303     * @note It will only take any effect if the file selector
7304     * entry widget is @b not under "inwin mode".
7305     *
7306     * @see elm_fileselector_entry_window_title_get()
7307     */
7308    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7309
7310    /**
7311     * Get the title set for a given file selector entry widget's
7312     * window
7313     *
7314     * @param obj The file selector entry widget
7315     * @return Title of the file selector entry's window
7316     *
7317     * @see elm_fileselector_entry_window_title_get() for more details
7318     */
7319    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7320
7321    /**
7322     * Set the size of a given file selector entry widget's window,
7323     * holding the file selector itself.
7324     *
7325     * @param obj The file selector entry widget
7326     * @param width The window's width
7327     * @param height The window's height
7328     *
7329     * @note it will only take any effect if the file selector entry
7330     * widget is @b not under "inwin mode". The default size for the
7331     * window (when applicable) is 400x400 pixels.
7332     *
7333     * @see elm_fileselector_entry_window_size_get()
7334     */
7335    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7336
7337    /**
7338     * Get the size of a given file selector entry widget's window,
7339     * holding the file selector itself.
7340     *
7341     * @param obj The file selector entry widget
7342     * @param width Pointer into which to store the width value
7343     * @param height Pointer into which to store the height value
7344     *
7345     * @note Use @c NULL pointers on the size values you're not
7346     * interested in: they'll be ignored by the function.
7347     *
7348     * @see elm_fileselector_entry_window_size_set(), for more details
7349     */
7350    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7351
7352    /**
7353     * Set the initial file system path and the entry's path string for
7354     * a given file selector entry widget
7355     *
7356     * @param obj The file selector entry widget
7357     * @param path The path string
7358     *
7359     * It must be a <b>directory</b> path, which will have the contents
7360     * displayed initially in the file selector's view, when invoked
7361     * from @p obj. The default initial path is the @c "HOME"
7362     * environment variable's value.
7363     *
7364     * @see elm_fileselector_entry_path_get()
7365     */
7366    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7367
7368    /**
7369     * Get the entry's path string for a given file selector entry
7370     * widget
7371     *
7372     * @param obj The file selector entry widget
7373     * @return path The path string
7374     *
7375     * @see elm_fileselector_entry_path_set() for more details
7376     */
7377    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7378
7379    /**
7380     * Enable/disable a tree view in the given file selector entry
7381     * widget's internal file selector
7382     *
7383     * @param obj The file selector entry widget
7384     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7385     * disable
7386     *
7387     * This has the same effect as elm_fileselector_expandable_set(),
7388     * but now applied to a file selector entry's internal file
7389     * selector.
7390     *
7391     * @note There's no way to put a file selector entry's internal
7392     * file selector in "grid mode", as one may do with "pure" file
7393     * selectors.
7394     *
7395     * @see elm_fileselector_expandable_get()
7396     */
7397    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7398
7399    /**
7400     * Get whether tree view is enabled for the given file selector
7401     * entry widget's internal file selector
7402     *
7403     * @param obj The file selector entry widget
7404     * @return @c EINA_TRUE if @p obj widget's internal file selector
7405     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7406     *
7407     * @see elm_fileselector_expandable_set() for more details
7408     */
7409    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7410
7411    /**
7412     * Set whether a given file selector entry widget's internal file
7413     * selector is to display folders only or the directory contents,
7414     * as well.
7415     *
7416     * @param obj The file selector entry widget
7417     * @param only @c EINA_TRUE to make @p obj widget's internal file
7418     * selector only display directories, @c EINA_FALSE to make files
7419     * to be displayed in it too
7420     *
7421     * This has the same effect as elm_fileselector_folder_only_set(),
7422     * but now applied to a file selector entry's internal file
7423     * selector.
7424     *
7425     * @see elm_fileselector_folder_only_get()
7426     */
7427    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7428
7429    /**
7430     * Get whether a given file selector entry widget's internal file
7431     * selector is displaying folders only or the directory contents,
7432     * as well.
7433     *
7434     * @param obj The file selector entry widget
7435     * @return @c EINA_TRUE if @p obj widget's internal file
7436     * selector is only displaying directories, @c EINA_FALSE if files
7437     * are being displayed in it too (and on errors)
7438     *
7439     * @see elm_fileselector_entry_folder_only_set() for more details
7440     */
7441    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7442
7443    /**
7444     * Enable/disable the file name entry box where the user can type
7445     * in a name for a file, in a given file selector entry widget's
7446     * internal file selector.
7447     *
7448     * @param obj The file selector entry widget
7449     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7450     * file selector a "saving dialog", @c EINA_FALSE otherwise
7451     *
7452     * This has the same effect as elm_fileselector_is_save_set(),
7453     * but now applied to a file selector entry's internal file
7454     * selector.
7455     *
7456     * @see elm_fileselector_is_save_get()
7457     */
7458    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7459
7460    /**
7461     * Get whether the given file selector entry widget's internal
7462     * file selector is in "saving dialog" mode
7463     *
7464     * @param obj The file selector entry widget
7465     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7466     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7467     * errors)
7468     *
7469     * @see elm_fileselector_entry_is_save_set() for more details
7470     */
7471    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7472
7473    /**
7474     * Set whether a given file selector entry widget's internal file
7475     * selector will raise an Elementary "inner window", instead of a
7476     * dedicated Elementary window. By default, it won't.
7477     *
7478     * @param obj The file selector entry widget
7479     * @param value @c EINA_TRUE to make it use an inner window, @c
7480     * EINA_TRUE to make it use a dedicated window
7481     *
7482     * @see elm_win_inwin_add() for more information on inner windows
7483     * @see elm_fileselector_entry_inwin_mode_get()
7484     */
7485    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7486
7487    /**
7488     * Get whether a given file selector entry widget's internal file
7489     * selector will raise an Elementary "inner window", instead of a
7490     * dedicated Elementary window.
7491     *
7492     * @param obj The file selector entry widget
7493     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7494     * if it will use a dedicated window
7495     *
7496     * @see elm_fileselector_entry_inwin_mode_set() for more details
7497     */
7498    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7499
7500    /**
7501     * Set the initial file system path for a given file selector entry
7502     * widget
7503     *
7504     * @param obj The file selector entry widget
7505     * @param path The path string
7506     *
7507     * It must be a <b>directory</b> path, which will have the contents
7508     * displayed initially in the file selector's view, when invoked
7509     * from @p obj. The default initial path is the @c "HOME"
7510     * environment variable's value.
7511     *
7512     * @see elm_fileselector_entry_path_get()
7513     */
7514    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7515
7516    /**
7517     * Get the parent directory's path to the latest file selection on
7518     * a given filer selector entry widget
7519     *
7520     * @param obj The file selector object
7521     * @return The (full) path of the directory of the last selection
7522     * on @p obj widget, a @b stringshared string
7523     *
7524     * @see elm_fileselector_entry_path_set()
7525     */
7526    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7527
7528    /**
7529     * @}
7530     */
7531
7532    /**
7533     * @defgroup Scroller Scroller
7534     *
7535     * A scroller holds a single object and "scrolls it around". This means that
7536     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7537     * region around, allowing to move through a much larger object that is
7538     * contained in the scroller. The scroller will always have a small minimum
7539     * size by default as it won't be limited by the contents of the scroller.
7540     *
7541     * Signals that you can add callbacks for are:
7542     * @li "edge,left" - the left edge of the content has been reached
7543     * @li "edge,right" - the right edge of the content has been reached
7544     * @li "edge,top" - the top edge of the content has been reached
7545     * @li "edge,bottom" - the bottom edge of the content has been reached
7546     * @li "scroll" - the content has been scrolled (moved)
7547     * @li "scroll,anim,start" - scrolling animation has started
7548     * @li "scroll,anim,stop" - scrolling animation has stopped
7549     * @li "scroll,drag,start" - dragging the contents around has started
7550     * @li "scroll,drag,stop" - dragging the contents around has stopped
7551     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7552     * user intervetion.
7553     *
7554     * @note When Elemementary is in embedded mode the scrollbars will not be
7555     * dragable, they appear merely as indicators of how much has been scrolled.
7556     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7557     * fingerscroll) won't work.
7558     *
7559     * Default contents parts of the scroller widget that you can use for are:
7560     * @li "default" - A content of the scroller
7561     *
7562     * In @ref tutorial_scroller you'll find an example of how to use most of
7563     * this API.
7564     * @{
7565     */
7566
7567    /**
7568     * @brief Type that controls when scrollbars should appear.
7569     *
7570     * @see elm_scroller_policy_set()
7571     */
7572    typedef enum _Elm_Scroller_Policy
7573      {
7574         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7575         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7576         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7577         ELM_SCROLLER_POLICY_LAST
7578      } Elm_Scroller_Policy;
7579
7580    /**
7581     * @brief Add a new scroller to the parent
7582     *
7583     * @param parent The parent object
7584     * @return The new object or NULL if it cannot be created
7585     */
7586    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7587
7588    /**
7589     * @brief Set the content of the scroller widget (the object to be scrolled around).
7590     *
7591     * @param obj The scroller object
7592     * @param content The new content object
7593     *
7594     * Once the content object is set, a previously set one will be deleted.
7595     * If you want to keep that old content object, use the
7596     * elm_scroller_content_unset() function.
7597     * @deprecated use elm_object_content_set() instead
7598     */
7599    EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7600
7601    /**
7602     * @brief Get the content of the scroller widget
7603     *
7604     * @param obj The slider object
7605     * @return The content that is being used
7606     *
7607     * Return the content object which is set for this widget
7608     *
7609     * @see elm_scroller_content_set()
7610     * @deprecated use elm_object_content_get() instead.
7611     */
7612    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7613
7614    /**
7615     * @brief Unset the content of the scroller widget
7616     *
7617     * @param obj The slider object
7618     * @return The content that was being used
7619     *
7620     * Unparent and return the content object which was set for this widget
7621     *
7622     * @see elm_scroller_content_set()
7623     * @deprecated use elm_object_content_unset() instead.
7624     */
7625    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7626
7627    /**
7628     * @brief Set custom theme elements for the scroller
7629     *
7630     * @param obj The scroller object
7631     * @param widget The widget name to use (default is "scroller")
7632     * @param base The base name to use (default is "base")
7633     */
7634    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7635
7636    /**
7637     * @brief Make the scroller minimum size limited to the minimum size of the content
7638     *
7639     * @param obj The scroller object
7640     * @param w Enable limiting minimum size horizontally
7641     * @param h Enable limiting minimum size vertically
7642     *
7643     * By default the scroller will be as small as its design allows,
7644     * irrespective of its content. This will make the scroller minimum size the
7645     * right size horizontally and/or vertically to perfectly fit its content in
7646     * that direction.
7647     */
7648    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7649
7650    /**
7651     * @brief Show a specific virtual region within the scroller content object
7652     *
7653     * @param obj The scroller object
7654     * @param x X coordinate of the region
7655     * @param y Y coordinate of the region
7656     * @param w Width of the region
7657     * @param h Height of the region
7658     *
7659     * This will ensure all (or part if it does not fit) of the designated
7660     * region in the virtual content object (0, 0 starting at the top-left of the
7661     * virtual content object) is shown within the scroller.
7662     */
7663    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);
7664
7665    /**
7666     * @brief Set the scrollbar visibility policy
7667     *
7668     * @param obj The scroller object
7669     * @param policy_h Horizontal scrollbar policy
7670     * @param policy_v Vertical scrollbar policy
7671     *
7672     * This sets the scrollbar visibility policy for the given scroller.
7673     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7674     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7675     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7676     * respectively for the horizontal and vertical scrollbars.
7677     */
7678    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7679
7680    /**
7681     * @brief Gets scrollbar visibility policy
7682     *
7683     * @param obj The scroller object
7684     * @param policy_h Horizontal scrollbar policy
7685     * @param policy_v Vertical scrollbar policy
7686     *
7687     * @see elm_scroller_policy_set()
7688     */
7689    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7690
7691    /**
7692     * @brief Get the currently visible content region
7693     *
7694     * @param obj The scroller object
7695     * @param x X coordinate of the region
7696     * @param y Y coordinate of the region
7697     * @param w Width of the region
7698     * @param h Height of the region
7699     *
7700     * This gets the current region in the content object that is visible through
7701     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7702     * w, @p h values pointed to.
7703     *
7704     * @note All coordinates are relative to the content.
7705     *
7706     * @see elm_scroller_region_show()
7707     */
7708    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);
7709
7710    /**
7711     * @brief Get the size of the content object
7712     *
7713     * @param obj The scroller object
7714     * @param w Width of the content object.
7715     * @param h Height of the content object.
7716     *
7717     * This gets the size of the content object of the scroller.
7718     */
7719    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7720
7721    /**
7722     * @brief Set bouncing behavior
7723     *
7724     * @param obj The scroller object
7725     * @param h_bounce Allow bounce horizontally
7726     * @param v_bounce Allow bounce vertically
7727     *
7728     * When scrolling, the scroller may "bounce" when reaching an edge of the
7729     * content object. This is a visual way to indicate the end has been reached.
7730     * This is enabled by default for both axis. This API will set if it is enabled
7731     * for the given axis with the boolean parameters for each axis.
7732     */
7733    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7734
7735    /**
7736     * @brief Get the bounce behaviour
7737     *
7738     * @param obj The Scroller object
7739     * @param h_bounce Will the scroller bounce horizontally or not
7740     * @param v_bounce Will the scroller bounce vertically or not
7741     *
7742     * @see elm_scroller_bounce_set()
7743     */
7744    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7745
7746    /**
7747     * @brief Set scroll page size relative to viewport size.
7748     *
7749     * @param obj The scroller object
7750     * @param h_pagerel The horizontal page relative size
7751     * @param v_pagerel The vertical page relative size
7752     *
7753     * The scroller is capable of limiting scrolling by the user to "pages". That
7754     * is to jump by and only show a "whole page" at a time as if the continuous
7755     * area of the scroller content is split into page sized pieces. This sets
7756     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7757     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7758     * axis. This is mutually exclusive with page size
7759     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7760     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7761     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7762     * the other axis.
7763     */
7764    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7765
7766    /**
7767     * @brief Set scroll page size.
7768     *
7769     * @param obj The scroller object
7770     * @param h_pagesize The horizontal page size
7771     * @param v_pagesize The vertical page size
7772     *
7773     * This sets the page size to an absolute fixed value, with 0 turning it off
7774     * for that axis.
7775     *
7776     * @see elm_scroller_page_relative_set()
7777     */
7778    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7779
7780    /**
7781     * @brief Get scroll current page number.
7782     *
7783     * @param obj The scroller object
7784     * @param h_pagenumber The horizontal page number
7785     * @param v_pagenumber The vertical page number
7786     *
7787     * The page number starts from 0. 0 is the first page.
7788     * Current page means the page which meets the top-left of the viewport.
7789     * If there are two or more pages in the viewport, it returns the number of the page
7790     * which meets the top-left of the viewport.
7791     *
7792     * @see elm_scroller_last_page_get()
7793     * @see elm_scroller_page_show()
7794     * @see elm_scroller_page_brint_in()
7795     */
7796    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7797
7798    /**
7799     * @brief Get scroll last page number.
7800     *
7801     * @param obj The scroller object
7802     * @param h_pagenumber The horizontal page number
7803     * @param v_pagenumber The vertical page number
7804     *
7805     * The page number starts from 0. 0 is the first page.
7806     * This returns the last page number among the pages.
7807     *
7808     * @see elm_scroller_current_page_get()
7809     * @see elm_scroller_page_show()
7810     * @see elm_scroller_page_brint_in()
7811     */
7812    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7813
7814    /**
7815     * Show a specific virtual region within the scroller content object by page number.
7816     *
7817     * @param obj The scroller object
7818     * @param h_pagenumber The horizontal page number
7819     * @param v_pagenumber The vertical page number
7820     *
7821     * 0, 0 of the indicated page is located at the top-left of the viewport.
7822     * This will jump to the page directly without animation.
7823     *
7824     * Example of usage:
7825     *
7826     * @code
7827     * sc = elm_scroller_add(win);
7828     * elm_scroller_content_set(sc, content);
7829     * elm_scroller_page_relative_set(sc, 1, 0);
7830     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7831     * elm_scroller_page_show(sc, h_page + 1, v_page);
7832     * @endcode
7833     *
7834     * @see elm_scroller_page_bring_in()
7835     */
7836    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7837
7838    /**
7839     * Show a specific virtual region within the scroller content object by page number.
7840     *
7841     * @param obj The scroller object
7842     * @param h_pagenumber The horizontal page number
7843     * @param v_pagenumber The vertical page number
7844     *
7845     * 0, 0 of the indicated page is located at the top-left of the viewport.
7846     * This will slide to the page with animation.
7847     *
7848     * Example of usage:
7849     *
7850     * @code
7851     * sc = elm_scroller_add(win);
7852     * elm_scroller_content_set(sc, content);
7853     * elm_scroller_page_relative_set(sc, 1, 0);
7854     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7855     * elm_scroller_page_bring_in(sc, h_page, v_page);
7856     * @endcode
7857     *
7858     * @see elm_scroller_page_show()
7859     */
7860    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7861
7862    /**
7863     * @brief Show a specific virtual region within the scroller content object.
7864     *
7865     * @param obj The scroller object
7866     * @param x X coordinate of the region
7867     * @param y Y coordinate of the region
7868     * @param w Width of the region
7869     * @param h Height of the region
7870     *
7871     * This will ensure all (or part if it does not fit) of the designated
7872     * region in the virtual content object (0, 0 starting at the top-left of the
7873     * virtual content object) is shown within the scroller. Unlike
7874     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7875     * to this location (if configuration in general calls for transitions). It
7876     * may not jump immediately to the new location and make take a while and
7877     * show other content along the way.
7878     *
7879     * @see elm_scroller_region_show()
7880     */
7881    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);
7882
7883    /**
7884     * @brief Set event propagation on a scroller
7885     *
7886     * @param obj The scroller object
7887     * @param propagation If propagation is enabled or not
7888     *
7889     * This enables or disabled event propagation from the scroller content to
7890     * the scroller and its parent. By default event propagation is disabled.
7891     */
7892    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7893
7894    /**
7895     * @brief Get event propagation for a scroller
7896     *
7897     * @param obj The scroller object
7898     * @return The propagation state
7899     *
7900     * This gets the event propagation for a scroller.
7901     *
7902     * @see elm_scroller_propagate_events_set()
7903     */
7904    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7905
7906    /**
7907     * @brief Set scrolling gravity on a scroller
7908     *
7909     * @param obj The scroller object
7910     * @param x The scrolling horizontal gravity
7911     * @param y The scrolling vertical gravity
7912     *
7913     * The gravity, defines how the scroller will adjust its view
7914     * when the size of the scroller contents increase.
7915     *
7916     * The scroller will adjust the view to glue itself as follows.
7917     *
7918     *  x=0.0, for showing the left most region of the content.
7919     *  x=1.0, for showing the right most region of the content.
7920     *  y=0.0, for showing the bottom most region of the content.
7921     *  y=1.0, for showing the top most region of the content.
7922     *
7923     * Default values for x and y are 0.0
7924     */
7925    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7926
7927    /**
7928     * @brief Get scrolling gravity values for a scroller
7929     *
7930     * @param obj The scroller object
7931     * @param x The scrolling horizontal gravity
7932     * @param y The scrolling vertical gravity
7933     *
7934     * This gets gravity values for a scroller.
7935     *
7936     * @see elm_scroller_gravity_set()
7937     *
7938     */
7939    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7940
7941    /**
7942     * @}
7943     */
7944
7945    /**
7946     * @defgroup Label Label
7947     *
7948     * @image html img/widget/label/preview-00.png
7949     * @image latex img/widget/label/preview-00.eps
7950     *
7951     * @brief Widget to display text, with simple html-like markup.
7952     *
7953     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7954     * text doesn't fit the geometry of the label it will be ellipsized or be
7955     * cut. Elementary provides several styles for this widget:
7956     * @li default - No animation
7957     * @li marker - Centers the text in the label and make it bold by default
7958     * @li slide_long - The entire text appears from the right of the screen and
7959     * slides until it disappears in the left of the screen(reappering on the
7960     * right again).
7961     * @li slide_short - The text appears in the left of the label and slides to
7962     * the right to show the overflow. When all of the text has been shown the
7963     * position is reset.
7964     * @li slide_bounce - The text appears in the left of the label and slides to
7965     * the right to show the overflow. When all of the text has been shown the
7966     * animation reverses, moving the text to the left.
7967     *
7968     * Custom themes can of course invent new markup tags and style them any way
7969     * they like.
7970     *
7971     * The following signals may be emitted by the label widget:
7972     * @li "language,changed": The program's language changed.
7973     *
7974     * See @ref tutorial_label for a demonstration of how to use a label widget.
7975     * @{
7976     */
7977
7978    /**
7979     * @brief Add a new label to the parent
7980     *
7981     * @param parent The parent object
7982     * @return The new object or NULL if it cannot be created
7983     */
7984    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7985
7986    /**
7987     * @brief Set the label on the label object
7988     *
7989     * @param obj The label object
7990     * @param label The label will be used on the label object
7991     * @deprecated See elm_object_text_set()
7992     */
7993    EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7994
7995    /**
7996     * @brief Get the label used on the label object
7997     *
7998     * @param obj The label object
7999     * @return The string inside the label
8000     * @deprecated See elm_object_text_get()
8001     */
8002    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8003
8004    /**
8005     * @brief Set the wrapping behavior of the label
8006     *
8007     * @param obj The label object
8008     * @param wrap To wrap text or not
8009     *
8010     * By default no wrapping is done. Possible values for @p wrap are:
8011     * @li ELM_WRAP_NONE - No wrapping
8012     * @li ELM_WRAP_CHAR - wrap between characters
8013     * @li ELM_WRAP_WORD - wrap between words
8014     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
8015     */
8016    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8017
8018    /**
8019     * @brief Get the wrapping behavior of the label
8020     *
8021     * @param obj The label object
8022     * @return Wrap type
8023     *
8024     * @see elm_label_line_wrap_set()
8025     */
8026    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8027
8028    /**
8029     * @brief Set wrap width of the label
8030     *
8031     * @param obj The label object
8032     * @param w The wrap width in pixels at a minimum where words need to wrap
8033     *
8034     * This function sets the maximum width size hint of the label.
8035     *
8036     * @warning This is only relevant if the label is inside a container.
8037     */
8038    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
8039
8040    /**
8041     * @brief Get wrap width of the label
8042     *
8043     * @param obj The label object
8044     * @return The wrap width in pixels at a minimum where words need to wrap
8045     *
8046     * @see elm_label_wrap_width_set()
8047     */
8048    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8049
8050    /**
8051     * @brief Set wrap height of the label
8052     *
8053     * @param obj The label object
8054     * @param h The wrap height in pixels at a minimum where words need to wrap
8055     *
8056     * This function sets the maximum height size hint of the label.
8057     *
8058     * @warning This is only relevant if the label is inside a container.
8059     */
8060    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
8061
8062    /**
8063     * @brief get wrap width of the label
8064     *
8065     * @param obj The label object
8066     * @return The wrap height in pixels at a minimum where words need to wrap
8067     */
8068    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8069
8070    /**
8071     * @brief Set the font size on the label object.
8072     *
8073     * @param obj The label object
8074     * @param size font size
8075     *
8076     * @warning NEVER use this. It is for hyper-special cases only. use styles
8077     * instead. e.g. "default", "marker", "slide_long" etc.
8078     */
8079    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
8080
8081    /**
8082     * @brief Set the text color on the label object
8083     *
8084     * @param obj The label object
8085     * @param r Red property background color of The label object
8086     * @param g Green property background color of The label object
8087     * @param b Blue property background color of The label object
8088     * @param a Alpha property background color of The label object
8089     *
8090     * @warning NEVER use this. It is for hyper-special cases only. use styles
8091     * instead. e.g. "default", "marker", "slide_long" etc.
8092     */
8093    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);
8094
8095    /**
8096     * @brief Set the text align on the label object
8097     *
8098     * @param obj The label object
8099     * @param align align mode ("left", "center", "right")
8100     *
8101     * @warning NEVER use this. It is for hyper-special cases only. use styles
8102     * instead. e.g. "default", "marker", "slide_long" etc.
8103     */
8104    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
8105
8106    /**
8107     * @brief Set background color of the label
8108     *
8109     * @param obj The label object
8110     * @param r Red property background color of The label object
8111     * @param g Green property background color of The label object
8112     * @param b Blue property background color of The label object
8113     * @param a Alpha property background alpha of The label object
8114     *
8115     * @warning NEVER use this. It is for hyper-special cases only. use styles
8116     * instead. e.g. "default", "marker", "slide_long" etc.
8117     */
8118    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);
8119
8120    /**
8121     * @brief Set the ellipsis behavior of the label
8122     *
8123     * @param obj The label object
8124     * @param ellipsis To ellipsis text or not
8125     *
8126     * If set to true and the text doesn't fit in the label an ellipsis("...")
8127     * will be shown at the end of the widget.
8128     *
8129     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
8130     * choosen wrap method was ELM_WRAP_WORD.
8131     */
8132    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
8133
8134    /**
8135     * @brief Set the text slide of the label
8136     *
8137     * @param obj The label object
8138     * @param slide To start slide or stop
8139     *
8140     * If set to true, the text of the label will slide/scroll through the length of
8141     * label.
8142     *
8143     * @warning This only works with the themes "slide_short", "slide_long" and
8144     * "slide_bounce".
8145     */
8146    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
8147
8148    /**
8149     * @brief Get the text slide mode of the label
8150     *
8151     * @param obj The label object
8152     * @return slide slide mode value
8153     *
8154     * @see elm_label_slide_set()
8155     */
8156    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8157
8158    /**
8159     * @brief Set the slide duration(speed) of the label
8160     *
8161     * @param obj The label object
8162     * @return The duration in seconds in moving text from slide begin position
8163     * to slide end position
8164     */
8165    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
8166
8167    /**
8168     * @brief Get the slide duration(speed) of the label
8169     *
8170     * @param obj The label object
8171     * @return The duration time in moving text from slide begin position to slide end position
8172     *
8173     * @see elm_label_slide_duration_set()
8174     */
8175    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8176
8177    /**
8178     * @}
8179     */
8180
8181    /**
8182     * @defgroup Toggle Toggle
8183     *
8184     * @image html img/widget/toggle/preview-00.png
8185     * @image latex img/widget/toggle/preview-00.eps
8186     *
8187     * @brief A toggle is a slider which can be used to toggle between
8188     * two values.  It has two states: on and off.
8189     *
8190     * This widget is deprecated. Please use elm_check_add() instead using the
8191     * toggle style like:
8192     *
8193     * @code
8194     * obj = elm_check_add(parent);
8195     * elm_object_style_set(obj, "toggle");
8196     * elm_object_part_text_set(obj, "on", "ON");
8197     * elm_object_part_text_set(obj, "off", "OFF");
8198     * @endcode
8199     *
8200     * Signals that you can add callbacks for are:
8201     * @li "changed" - Whenever the toggle value has been changed.  Is not called
8202     *                 until the toggle is released by the cursor (assuming it
8203     *                 has been triggered by the cursor in the first place).
8204     *
8205     * Default contents parts of the toggle widget that you can use for are:
8206     * @li "icon" - An icon of the toggle
8207     *
8208     * Default text parts of the toggle widget that you can use for are:
8209     * @li "elm.text" - Label of the toggle
8210     *
8211     * @ref tutorial_toggle show how to use a toggle.
8212     * @{
8213     */
8214
8215    /**
8216     * @brief Add a toggle to @p parent.
8217     *
8218     * @param parent The parent object
8219     *
8220     * @return The toggle object
8221     */
8222    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8223
8224    /**
8225     * @brief Sets the label to be displayed with the toggle.
8226     *
8227     * @param obj The toggle object
8228     * @param label The label to be displayed
8229     *
8230     * @deprecated use elm_object_text_set() instead.
8231     */
8232    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8233
8234    /**
8235     * @brief Gets the label of the toggle
8236     *
8237     * @param obj  toggle object
8238     * @return The label of the toggle
8239     *
8240     * @deprecated use elm_object_text_get() instead.
8241     */
8242    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8243
8244    /**
8245     * @brief Set the icon used for the toggle
8246     *
8247     * @param obj The toggle object
8248     * @param icon The icon object for the button
8249     *
8250     * Once the icon object is set, a previously set one will be deleted
8251     * If you want to keep that old content object, use the
8252     * elm_toggle_icon_unset() function.
8253     *
8254     * @deprecated use elm_object_part_content_set() instead.
8255     */
8256    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8257
8258    /**
8259     * @brief Get the icon used for the toggle
8260     *
8261     * @param obj The toggle object
8262     * @return The icon object that is being used
8263     *
8264     * Return the icon object which is set for this widget.
8265     *
8266     * @see elm_toggle_icon_set()
8267     *
8268     * @deprecated use elm_object_part_content_get() instead.
8269     */
8270    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8271
8272    /**
8273     * @brief Unset the icon used for the toggle
8274     *
8275     * @param obj The toggle object
8276     * @return The icon object that was being used
8277     *
8278     * Unparent and return the icon object which was set for this widget.
8279     *
8280     * @see elm_toggle_icon_set()
8281     *
8282     * @deprecated use elm_object_part_content_unset() instead.
8283     */
8284    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8285
8286    /**
8287     * @brief Sets the labels to be associated with the on and off states of the toggle.
8288     *
8289     * @param obj The toggle object
8290     * @param onlabel The label displayed when the toggle is in the "on" state
8291     * @param offlabel The label displayed when the toggle is in the "off" state
8292     *
8293     * @deprecated use elm_object_part_text_set() for "on" and "off" parts
8294     * instead.
8295     */
8296    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
8297
8298    /**
8299     * @brief Gets the labels associated with the on and off states of the
8300     * toggle.
8301     *
8302     * @param obj The toggle object
8303     * @param onlabel A char** to place the onlabel of @p obj into
8304     * @param offlabel A char** to place the offlabel of @p obj into
8305     *
8306     * @deprecated use elm_object_part_text_get() for "on" and "off" parts
8307     * instead.
8308     */
8309    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
8310
8311    /**
8312     * @brief Sets the state of the toggle to @p state.
8313     *
8314     * @param obj The toggle object
8315     * @param state The state of @p obj
8316     *
8317     * @deprecated use elm_check_state_set() instead.
8318     */
8319    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8320
8321    /**
8322     * @brief Gets the state of the toggle to @p state.
8323     *
8324     * @param obj The toggle object
8325     * @return The state of @p obj
8326     *
8327     * @deprecated use elm_check_state_get() instead.
8328     */
8329    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8330
8331    /**
8332     * @brief Sets the state pointer of the toggle to @p statep.
8333     *
8334     * @param obj The toggle object
8335     * @param statep The state pointer of @p obj
8336     *
8337     * @deprecated use elm_check_state_pointer_set() instead.
8338     */
8339    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
8340
8341    /**
8342     * @}
8343     */
8344
8345    /**
8346     * @defgroup Frame Frame
8347     *
8348     * @image html img/widget/frame/preview-00.png
8349     * @image latex img/widget/frame/preview-00.eps
8350     *
8351     * @brief Frame is a widget that holds some content and has a title.
8352     *
8353     * The default look is a frame with a title, but Frame supports multple
8354     * styles:
8355     * @li default
8356     * @li pad_small
8357     * @li pad_medium
8358     * @li pad_large
8359     * @li pad_huge
8360     * @li outdent_top
8361     * @li outdent_bottom
8362     *
8363     * Of all this styles only default shows the title. Frame emits no signals.
8364     *
8365     * Default contents parts of the frame widget that you can use for are:
8366     * @li "default" - A content of the frame
8367     *
8368     * Default text parts of the frame widget that you can use for are:
8369     * @li "elm.text" - Label of the frame
8370     *
8371     * For a detailed example see the @ref tutorial_frame.
8372     *
8373     * @{
8374     */
8375
8376    /**
8377     * @brief Add a new frame to the parent
8378     *
8379     * @param parent The parent object
8380     * @return The new object or NULL if it cannot be created
8381     */
8382    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8383
8384    /**
8385     * @brief Set the frame label
8386     *
8387     * @param obj The frame object
8388     * @param label The label of this frame object
8389     *
8390     * @deprecated use elm_object_text_set() instead.
8391     */
8392    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8393
8394    /**
8395     * @brief Get the frame label
8396     *
8397     * @param obj The frame object
8398     *
8399     * @return The label of this frame objet or NULL if unable to get frame
8400     *
8401     * @deprecated use elm_object_text_get() instead.
8402     */
8403    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8404
8405    /**
8406     * @brief Set the content of the frame widget
8407     *
8408     * Once the content object is set, a previously set one will be deleted.
8409     * If you want to keep that old content object, use the
8410     * elm_frame_content_unset() function.
8411     *
8412     * @param obj The frame object
8413     * @param content The content will be filled in this frame object
8414     *
8415     * @deprecated use elm_object_content_set() instead.
8416     */
8417    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8418
8419    /**
8420     * @brief Get the content of the frame widget
8421     *
8422     * Return the content object which is set for this widget
8423     *
8424     * @param obj The frame object
8425     * @return The content that is being used
8426     *
8427     * @deprecated use elm_object_content_get() instead.
8428     */
8429    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8430
8431    /**
8432     * @brief Unset the content of the frame widget
8433     *
8434     * Unparent and return the content object which was set for this widget
8435     *
8436     * @param obj The frame object
8437     * @return The content that was being used
8438     *
8439     * @deprecated use elm_object_content_unset() instead.
8440     */
8441    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8442
8443    /**
8444     * @}
8445     */
8446
8447    /**
8448     * @defgroup Table Table
8449     *
8450     * A container widget to arrange other widgets in a table where items can
8451     * also span multiple columns or rows - even overlap (and then be raised or
8452     * lowered accordingly to adjust stacking if they do overlap).
8453     *
8454     * For a Table widget the row/column count is not fixed.
8455     * The table widget adjusts itself when subobjects are added to it dynamically.
8456     *
8457     * The followin are examples of how to use a table:
8458     * @li @ref tutorial_table_01
8459     * @li @ref tutorial_table_02
8460     *
8461     * @{
8462     */
8463
8464    /**
8465     * @brief Add a new table to the parent
8466     *
8467     * @param parent The parent object
8468     * @return The new object or NULL if it cannot be created
8469     */
8470    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8471
8472    /**
8473     * @brief Set the homogeneous layout in the table
8474     *
8475     * @param obj The layout object
8476     * @param homogeneous A boolean to set if the layout is homogeneous in the
8477     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8478     */
8479    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8480
8481    /**
8482     * @brief Get the current table homogeneous mode.
8483     *
8484     * @param obj The table object
8485     * @return A boolean to indicating if the layout is homogeneous in the table
8486     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8487     */
8488    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8489
8490    /**
8491     * @brief Set padding between cells.
8492     *
8493     * @param obj The layout object.
8494     * @param horizontal set the horizontal padding.
8495     * @param vertical set the vertical padding.
8496     *
8497     * Default value is 0.
8498     */
8499    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8500
8501    /**
8502     * @brief Get padding between cells.
8503     *
8504     * @param obj The layout object.
8505     * @param horizontal set the horizontal padding.
8506     * @param vertical set the vertical padding.
8507     */
8508    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8509
8510    /**
8511     * @brief Add a subobject on the table with the coordinates passed
8512     *
8513     * @param obj The table object
8514     * @param subobj The subobject to be added to the table
8515     * @param x Row number
8516     * @param y Column number
8517     * @param w rowspan
8518     * @param h colspan
8519     *
8520     * @note All positioning inside the table is relative to rows and columns, so
8521     * a value of 0 for x and y, means the top left cell of the table, and a
8522     * value of 1 for w and h means @p subobj only takes that 1 cell.
8523     */
8524    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8525
8526    /**
8527     * @brief Remove child from table.
8528     *
8529     * @param obj The table object
8530     * @param subobj The subobject
8531     */
8532    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8533
8534    /**
8535     * @brief Faster way to remove all child objects from a table object.
8536     *
8537     * @param obj The table object
8538     * @param clear If true, will delete children, else just remove from table.
8539     */
8540    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8541
8542    /**
8543     * @brief Set the packing location of an existing child of the table
8544     *
8545     * @param subobj The subobject to be modified in the table
8546     * @param x Row number
8547     * @param y Column number
8548     * @param w rowspan
8549     * @param h colspan
8550     *
8551     * Modifies the position of an object already in the table.
8552     *
8553     * @note All positioning inside the table is relative to rows and columns, so
8554     * a value of 0 for x and y, means the top left cell of the table, and a
8555     * value of 1 for w and h means @p subobj only takes that 1 cell.
8556     */
8557    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8558
8559    /**
8560     * @brief Get the packing location of an existing child of the table
8561     *
8562     * @param subobj The subobject to be modified in the table
8563     * @param x Row number
8564     * @param y Column number
8565     * @param w rowspan
8566     * @param h colspan
8567     *
8568     * @see elm_table_pack_set()
8569     */
8570    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8571
8572    /**
8573     * @}
8574     */
8575
8576    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8577    typedef struct Elm_Gen_Item Elm_Gen_Item;
8578    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8579    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8580    typedef char        *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8581    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. */
8582    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. */
8583    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8584    struct _Elm_Gen_Item_Class
8585      {
8586         const char             *item_style;
8587         struct _Elm_Gen_Item_Class_Func
8588           {
8589              Elm_Gen_Item_Text_Get_Cb  text_get;
8590              Elm_Gen_Item_Content_Get_Cb  content_get;
8591              Elm_Gen_Item_State_Get_Cb state_get;
8592              Elm_Gen_Item_Del_Cb       del;
8593           } func;
8594      };
8595    EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8596    EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8597    EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8598    EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8599    EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8600    EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8601    EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8602    EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8603    EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8604    EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8605    EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8606
8607    EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8608    EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8609    EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8610    EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8611    EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8612    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8613    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8614    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8615    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8616    EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8617
8618    /**
8619     * @defgroup Gengrid Gengrid (Generic grid)
8620     *
8621     * This widget aims to position objects in a grid layout while
8622     * actually creating and rendering only the visible ones, using the
8623     * same idea as the @ref Genlist "genlist": the user defines a @b
8624     * class for each item, specifying functions that will be called at
8625     * object creation, deletion, etc. When those items are selected by
8626     * the user, a callback function is issued. Users may interact with
8627     * a gengrid via the mouse (by clicking on items to select them and
8628     * clicking on the grid's viewport and swiping to pan the whole
8629     * view) or via the keyboard, navigating through item with the
8630     * arrow keys.
8631     *
8632     * @section Gengrid_Layouts Gengrid layouts
8633     *
8634     * Gengrid may layout its items in one of two possible layouts:
8635     * - horizontal or
8636     * - vertical.
8637     *
8638     * When in "horizontal mode", items will be placed in @b columns,
8639     * from top to bottom and, when the space for a column is filled,
8640     * another one is started on the right, thus expanding the grid
8641     * horizontally, making for horizontal scrolling. When in "vertical
8642     * mode" , though, items will be placed in @b rows, from left to
8643     * right and, when the space for a row is filled, another one is
8644     * started below, thus expanding the grid vertically (and making
8645     * for vertical scrolling).
8646     *
8647     * @section Gengrid_Items Gengrid items
8648     *
8649     * An item in a gengrid can have 0 or more texts (they can be
8650     * regular text or textblock Evas objects - that's up to the style
8651     * to determine), 0 or more contents (which are simply objects
8652     * swallowed into the gengrid item's theming Edje object) and 0 or
8653     * more <b>boolean states</b>, which have the behavior left to the
8654     * user to define. The Edje part names for each of these properties
8655     * will be looked up, in the theme file for the gengrid, under the
8656     * Edje (string) data items named @c "texts", @c "contents" and @c
8657     * "states", respectively. For each of those properties, if more
8658     * than one part is provided, they must have names listed separated
8659     * by spaces in the data fields. For the default gengrid item
8660     * theme, we have @b one text part (@c "elm.text"), @b two content 
8661     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8662     * no state parts.
8663     *
8664     * A gengrid item may be at one of several styles. Elementary
8665     * provides one by default - "default", but this can be extended by
8666     * system or application custom themes/overlays/extensions (see
8667     * @ref Theme "themes" for more details).
8668     *
8669     * @section Gengrid_Item_Class Gengrid item classes
8670     *
8671     * In order to have the ability to add and delete items on the fly,
8672     * gengrid implements a class (callback) system where the
8673     * application provides a structure with information about that
8674     * type of item (gengrid may contain multiple different items with
8675     * different classes, states and styles). Gengrid will call the
8676     * functions in this struct (methods) when an item is "realized"
8677     * (i.e., created dynamically, while the user is scrolling the
8678     * grid). All objects will simply be deleted when no longer needed
8679     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8680     * contains the following members:
8681     * - @c item_style - This is a constant string and simply defines
8682     * the name of the item style. It @b must be specified and the
8683     * default should be @c "default".
8684     * - @c func.text_get - This function is called when an item
8685     * object is actually created. The @c data parameter will point to
8686     * the same data passed to elm_gengrid_item_append() and related
8687     * item creation functions. The @c obj parameter is the gengrid
8688     * object itself, while the @c part one is the name string of one
8689     * of the existing text parts in the Edje group implementing the
8690     * item's theme. This function @b must return a strdup'()ed string,
8691     * as the caller will free() it when done. See
8692     * #Elm_Gengrid_Item_Text_Get_Cb.
8693     * - @c func.content_get - This function is called when an item object
8694     * is actually created. The @c data parameter will point to the
8695     * same data passed to elm_gengrid_item_append() and related item
8696     * creation functions. The @c obj parameter is the gengrid object
8697     * itself, while the @c part one is the name string of one of the
8698     * existing (content) swallow parts in the Edje group implementing the
8699     * item's theme. It must return @c NULL, when no content is desired,
8700     * or a valid object handle, otherwise. The object will be deleted
8701     * by the gengrid on its deletion or when the item is "unrealized".
8702     * See #Elm_Gengrid_Item_Content_Get_Cb.
8703     * - @c func.state_get - This function is called when an item
8704     * object is actually created. The @c data parameter will point to
8705     * the same data passed to elm_gengrid_item_append() and related
8706     * item creation functions. The @c obj parameter is the gengrid
8707     * object itself, while the @c part one is the name string of one
8708     * of the state parts in the Edje group implementing the item's
8709     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8710     * true/on. Gengrids will emit a signal to its theming Edje object
8711     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8712     * "source" arguments, respectively, when the state is true (the
8713     * default is false), where @c XXX is the name of the (state) part.
8714     * See #Elm_Gengrid_Item_State_Get_Cb.
8715     * - @c func.del - This is called when elm_gengrid_item_del() is
8716     * called on an item or elm_gengrid_clear() is called on the
8717     * gengrid. This is intended for use when gengrid items are
8718     * deleted, so any data attached to the item (e.g. its data
8719     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8720     *
8721     * @section Gengrid_Usage_Hints Usage hints
8722     *
8723     * If the user wants to have multiple items selected at the same
8724     * time, elm_gengrid_multi_select_set() will permit it. If the
8725     * gengrid is single-selection only (the default), then
8726     * elm_gengrid_select_item_get() will return the selected item or
8727     * @c NULL, if none is selected. If the gengrid is under
8728     * multi-selection, then elm_gengrid_selected_items_get() will
8729     * return a list (that is only valid as long as no items are
8730     * modified (added, deleted, selected or unselected) of child items
8731     * on a gengrid.
8732     *
8733     * If an item changes (internal (boolean) state, text or content
8734     * changes), then use elm_gengrid_item_update() to have gengrid
8735     * update the item with the new state. A gengrid will re-"realize"
8736     * the item, thus calling the functions in the
8737     * #Elm_Gengrid_Item_Class set for that item.
8738     *
8739     * To programmatically (un)select an item, use
8740     * elm_gengrid_item_selected_set(). To get its selected state use
8741     * elm_gengrid_item_selected_get(). To make an item disabled
8742     * (unable to be selected and appear differently) use
8743     * elm_gengrid_item_disabled_set() to set this and
8744     * elm_gengrid_item_disabled_get() to get the disabled state.
8745     *
8746     * Grid cells will only have their selection smart callbacks called
8747     * when firstly getting selected. Any further clicks will do
8748     * nothing, unless you enable the "always select mode", with
8749     * elm_gengrid_always_select_mode_set(), thus making every click to
8750     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8751     * turn off the ability to select items entirely in the widget and
8752     * they will neither appear selected nor call the selection smart
8753     * callbacks.
8754     *
8755     * Remember that you can create new styles and add your own theme
8756     * augmentation per application with elm_theme_extension_add(). If
8757     * you absolutely must have a specific style that overrides any
8758     * theme the user or system sets up you can use
8759     * elm_theme_overlay_add() to add such a file.
8760     *
8761     * @section Gengrid_Smart_Events Gengrid smart events
8762     *
8763     * Smart events that you can add callbacks for are:
8764     * - @c "activated" - The user has double-clicked or pressed
8765     *   (enter|return|spacebar) on an item. The @c event_info parameter
8766     *   is the gengrid item that was activated.
8767     * - @c "clicked,double" - The user has double-clicked an item.
8768     *   The @c event_info parameter is the gengrid item that was double-clicked.
8769     * - @c "longpressed" - This is called when the item is pressed for a certain
8770     *   amount of time. By default it's 1 second.
8771     * - @c "selected" - The user has made an item selected. The
8772     *   @c event_info parameter is the gengrid item that was selected.
8773     * - @c "unselected" - The user has made an item unselected. The
8774     *   @c event_info parameter is the gengrid item that was unselected.
8775     * - @c "realized" - This is called when the item in the gengrid
8776     *   has its implementing Evas object instantiated, de facto. @c
8777     *   event_info is the gengrid item that was created. The object
8778     *   may be deleted at any time, so it is highly advised to the
8779     *   caller @b not to use the object pointer returned from
8780     *   elm_gengrid_item_object_get(), because it may point to freed
8781     *   objects.
8782     * - @c "unrealized" - This is called when the implementing Evas
8783     *   object for this item is deleted. @c event_info is the gengrid
8784     *   item that was deleted.
8785     * - @c "changed" - Called when an item is added, removed, resized
8786     *   or moved and when the gengrid is resized or gets "horizontal"
8787     *   property changes.
8788     * - @c "scroll,anim,start" - This is called when scrolling animation has
8789     *   started.
8790     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8791     *   stopped.
8792     * - @c "drag,start,up" - Called when the item in the gengrid has
8793     *   been dragged (not scrolled) up.
8794     * - @c "drag,start,down" - Called when the item in the gengrid has
8795     *   been dragged (not scrolled) down.
8796     * - @c "drag,start,left" - Called when the item in the gengrid has
8797     *   been dragged (not scrolled) left.
8798     * - @c "drag,start,right" - Called when the item in the gengrid has
8799     *   been dragged (not scrolled) right.
8800     * - @c "drag,stop" - Called when the item in the gengrid has
8801     *   stopped being dragged.
8802     * - @c "drag" - Called when the item in the gengrid is being
8803     *   dragged.
8804     * - @c "scroll" - called when the content has been scrolled
8805     *   (moved).
8806     * - @c "scroll,drag,start" - called when dragging the content has
8807     *   started.
8808     * - @c "scroll,drag,stop" - called when dragging the content has
8809     *   stopped.
8810     * - @c "edge,top" - This is called when the gengrid is scrolled until
8811     *   the top edge.
8812     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8813     *   until the bottom edge.
8814     * - @c "edge,left" - This is called when the gengrid is scrolled
8815     *   until the left edge.
8816     * - @c "edge,right" - This is called when the gengrid is scrolled
8817     *   until the right edge.
8818     *
8819     * List of gengrid examples:
8820     * @li @ref gengrid_example
8821     */
8822
8823    /**
8824     * @addtogroup Gengrid
8825     * @{
8826     */
8827
8828    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8829    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8830    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8831    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8832    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8833
8834    /**
8835     * Text fetching class function for Elm_Gen_Item_Class.
8836     * @param data The data passed in the item creation function
8837     * @param obj The base widget object
8838     * @param part The part name of the swallow
8839     * @return The allocated (NOT stringshared) string to set as the text 
8840     */
8841    typedef char        *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8842
8843    /**
8844     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8845     * @param data The data passed in the item creation function
8846     * @param obj The base widget object
8847     * @param part The part name of the swallow
8848     * @return The content object to swallow
8849     */
8850    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8851
8852    /**
8853     * State fetching class function for Elm_Gen_Item_Class.
8854     * @param data The data passed in the item creation function
8855     * @param obj The base widget object
8856     * @param part The part name of the swallow
8857     * @return The hell if I know
8858     */
8859    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8860
8861    /**
8862     * Deletion class function for Elm_Gen_Item_Class.
8863     * @param data The data passed in the item creation function
8864     * @param obj The base widget object
8865     */
8866    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8867
8868    /**
8869     * @struct _Elm_Gengrid_Item_Class
8870     *
8871     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8872     * field details.
8873     */
8874    struct _Elm_Gengrid_Item_Class
8875      {
8876         const char             *item_style;
8877         struct _Elm_Gengrid_Item_Class_Func
8878           {
8879              Elm_Gengrid_Item_Text_Get_Cb    text_get; /**< Text fetching class function for gengrid item classes.*/
8880              Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8881              Elm_Gengrid_Item_State_Get_Cb   state_get; /**< State fetching class function for gengrid item classes. */
8882              Elm_Gengrid_Item_Del_Cb         del; /**< Deletion class function for gengrid item classes. */
8883           } func;
8884      }; /**< #Elm_Gengrid_Item_Class member definitions */
8885    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8886
8887    /**
8888     * Add a new gengrid widget to the given parent Elementary
8889     * (container) object
8890     *
8891     * @param parent The parent object
8892     * @return a new gengrid widget handle or @c NULL, on errors
8893     *
8894     * This function inserts a new gengrid widget on the canvas.
8895     *
8896     * @see elm_gengrid_item_size_set()
8897     * @see elm_gengrid_group_item_size_set()
8898     * @see elm_gengrid_horizontal_set()
8899     * @see elm_gengrid_item_append()
8900     * @see elm_gengrid_item_del()
8901     * @see elm_gengrid_clear()
8902     *
8903     * @ingroup Gengrid
8904     */
8905    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8906
8907    /**
8908     * Set the size for the items of a given gengrid widget
8909     *
8910     * @param obj The gengrid object.
8911     * @param w The items' width.
8912     * @param h The items' height;
8913     *
8914     * A gengrid, after creation, has still no information on the size
8915     * to give to each of its cells. So, you most probably will end up
8916     * with squares one @ref Fingers "finger" wide, the default
8917     * size. Use this function to force a custom size for you items,
8918     * making them as big as you wish.
8919     *
8920     * @see elm_gengrid_item_size_get()
8921     *
8922     * @ingroup Gengrid
8923     */
8924    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8925
8926    /**
8927     * Get the size set for the items of a given gengrid widget
8928     *
8929     * @param obj The gengrid object.
8930     * @param w Pointer to a variable where to store the items' width.
8931     * @param h Pointer to a variable where to store the items' height.
8932     *
8933     * @note Use @c NULL pointers on the size values you're not
8934     * interested in: they'll be ignored by the function.
8935     *
8936     * @see elm_gengrid_item_size_get() for more details
8937     *
8938     * @ingroup Gengrid
8939     */
8940    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8941
8942    /**
8943     * Set the size for the group items of a given gengrid widget
8944     *
8945     * @param obj The gengrid object.
8946     * @param w The group items' width.
8947     * @param h The group items' height;
8948     *
8949     * A gengrid, after creation, has still no information on the size
8950     * to give to each of its cells. So, you most probably will end up
8951     * with squares one @ref Fingers "finger" wide, the default
8952     * size. Use this function to force a custom size for you group items,
8953     * making them as big as you wish.
8954     *
8955     * @see elm_gengrid_group_item_size_get()
8956     *
8957     * @ingroup Gengrid
8958     */
8959    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8960
8961    /**
8962     * Get the size set for the group items of a given gengrid widget
8963     *
8964     * @param obj The gengrid object.
8965     * @param w Pointer to a variable where to store the group items' width.
8966     * @param h Pointer to a variable where to store the group items' height.
8967     *
8968     * @note Use @c NULL pointers on the size values you're not
8969     * interested in: they'll be ignored by the function.
8970     *
8971     * @see elm_gengrid_group_item_size_get() for more details
8972     *
8973     * @ingroup Gengrid
8974     */
8975    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8976
8977    /**
8978     * Set the items grid's alignment within a given gengrid widget
8979     *
8980     * @param obj The gengrid object.
8981     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8982     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8983     *
8984     * This sets the alignment of the whole grid of items of a gengrid
8985     * within its given viewport. By default, those values are both
8986     * 0.5, meaning that the gengrid will have its items grid placed
8987     * exactly in the middle of its viewport.
8988     *
8989     * @note If given alignment values are out of the cited ranges,
8990     * they'll be changed to the nearest boundary values on the valid
8991     * ranges.
8992     *
8993     * @see elm_gengrid_align_get()
8994     *
8995     * @ingroup Gengrid
8996     */
8997    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8998
8999    /**
9000     * Get the items grid's alignment values within a given gengrid
9001     * widget
9002     *
9003     * @param obj The gengrid object.
9004     * @param align_x Pointer to a variable where to store the
9005     * horizontal alignment.
9006     * @param align_y Pointer to a variable where to store the vertical
9007     * alignment.
9008     *
9009     * @note Use @c NULL pointers on the alignment values you're not
9010     * interested in: they'll be ignored by the function.
9011     *
9012     * @see elm_gengrid_align_set() for more details
9013     *
9014     * @ingroup Gengrid
9015     */
9016    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
9017
9018    /**
9019     * Set whether a given gengrid widget is or not able have items
9020     * @b reordered
9021     *
9022     * @param obj The gengrid object
9023     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
9024     * @c EINA_FALSE to turn it off
9025     *
9026     * If a gengrid is set to allow reordering, a click held for more
9027     * than 0.5 over a given item will highlight it specially,
9028     * signalling the gengrid has entered the reordering state. From
9029     * that time on, the user will be able to, while still holding the
9030     * mouse button down, move the item freely in the gengrid's
9031     * viewport, replacing to said item to the locations it goes to.
9032     * The replacements will be animated and, whenever the user
9033     * releases the mouse button, the item being replaced gets a new
9034     * definitive place in the grid.
9035     *
9036     * @see elm_gengrid_reorder_mode_get()
9037     *
9038     * @ingroup Gengrid
9039     */
9040    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
9041
9042    /**
9043     * Get whether a given gengrid widget is or not able have items
9044     * @b reordered
9045     *
9046     * @param obj The gengrid object
9047     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
9048     * off
9049     *
9050     * @see elm_gengrid_reorder_mode_set() for more details
9051     *
9052     * @ingroup Gengrid
9053     */
9054    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9055
9056    /**
9057     * Append a new item in a given gengrid widget.
9058     *
9059     * @param obj The gengrid object.
9060     * @param gic The item class for the item.
9061     * @param data The item data.
9062     * @param func Convenience function called when the item is
9063     * selected.
9064     * @param func_data Data to be passed to @p func.
9065     * @return A handle to the item added or @c NULL, on errors.
9066     *
9067     * This adds an item to the beginning of the gengrid.
9068     *
9069     * @see elm_gengrid_item_prepend()
9070     * @see elm_gengrid_item_insert_before()
9071     * @see elm_gengrid_item_insert_after()
9072     * @see elm_gengrid_item_del()
9073     *
9074     * @ingroup Gengrid
9075     */
9076    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);
9077
9078    /**
9079     * Prepend a new item in a given gengrid widget.
9080     *
9081     * @param obj The gengrid object.
9082     * @param gic The item class for the item.
9083     * @param data The item data.
9084     * @param func Convenience function called when the item is
9085     * selected.
9086     * @param func_data Data to be passed to @p func.
9087     * @return A handle to the item added or @c NULL, on errors.
9088     *
9089     * This adds an item to the end of the gengrid.
9090     *
9091     * @see elm_gengrid_item_append()
9092     * @see elm_gengrid_item_insert_before()
9093     * @see elm_gengrid_item_insert_after()
9094     * @see elm_gengrid_item_del()
9095     *
9096     * @ingroup Gengrid
9097     */
9098    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);
9099
9100    /**
9101     * Insert an item before another in a gengrid widget
9102     *
9103     * @param obj The gengrid object.
9104     * @param gic The item class for the item.
9105     * @param data The item data.
9106     * @param relative The item to place this new one before.
9107     * @param func Convenience function called when the item is
9108     * selected.
9109     * @param func_data Data to be passed to @p func.
9110     * @return A handle to the item added or @c NULL, on errors.
9111     *
9112     * This inserts an item before another in the gengrid.
9113     *
9114     * @see elm_gengrid_item_append()
9115     * @see elm_gengrid_item_prepend()
9116     * @see elm_gengrid_item_insert_after()
9117     * @see elm_gengrid_item_del()
9118     *
9119     * @ingroup Gengrid
9120     */
9121    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);
9122
9123    /**
9124     * Insert an item after another in a gengrid widget
9125     *
9126     * @param obj The gengrid object.
9127     * @param gic The item class for the item.
9128     * @param data The item data.
9129     * @param relative The item to place this new one after.
9130     * @param func Convenience function called when the item is
9131     * selected.
9132     * @param func_data Data to be passed to @p func.
9133     * @return A handle to the item added or @c NULL, on errors.
9134     *
9135     * This inserts an item after another in the gengrid.
9136     *
9137     * @see elm_gengrid_item_append()
9138     * @see elm_gengrid_item_prepend()
9139     * @see elm_gengrid_item_insert_after()
9140     * @see elm_gengrid_item_del()
9141     *
9142     * @ingroup Gengrid
9143     */
9144    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);
9145
9146    /**
9147     * Insert an item in a gengrid widget using a user-defined sort function.
9148     *
9149     * @param obj The gengrid object.
9150     * @param gic The item class for the item.
9151     * @param data The item data.
9152     * @param comp User defined comparison function that defines the sort order based on
9153     * Elm_Gen_Item and its data param.
9154     * @param func Convenience function called when the item is selected.
9155     * @param func_data Data to be passed to @p func.
9156     * @return A handle to the item added or @c NULL, on errors.
9157     *
9158     * This inserts an item in the gengrid based on user defined comparison function.
9159     *
9160     * @see elm_gengrid_item_append()
9161     * @see elm_gengrid_item_prepend()
9162     * @see elm_gengrid_item_insert_after()
9163     * @see elm_gengrid_item_del()
9164     * @see elm_gengrid_item_direct_sorted_insert()
9165     *
9166     * @ingroup Gengrid
9167     */
9168    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);
9169
9170    /**
9171     * Insert an item in a gengrid widget using a user-defined sort function.
9172     *
9173     * @param obj The gengrid object.
9174     * @param gic The item class for the item.
9175     * @param data The item data.
9176     * @param comp User defined comparison function that defines the sort order based on
9177     * Elm_Gen_Item.
9178     * @param func Convenience function called when the item is selected.
9179     * @param func_data Data to be passed to @p func.
9180     * @return A handle to the item added or @c NULL, on errors.
9181     *
9182     * This inserts an item in the gengrid based on user defined comparison function.
9183     *
9184     * @see elm_gengrid_item_append()
9185     * @see elm_gengrid_item_prepend()
9186     * @see elm_gengrid_item_insert_after()
9187     * @see elm_gengrid_item_del()
9188     * @see elm_gengrid_item_sorted_insert()
9189     *
9190     * @ingroup Gengrid
9191     */
9192    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);
9193
9194    /**
9195     * Set whether items on a given gengrid widget are to get their
9196     * selection callbacks issued for @b every subsequent selection
9197     * click on them or just for the first click.
9198     *
9199     * @param obj The gengrid object
9200     * @param always_select @c EINA_TRUE to make items "always
9201     * selected", @c EINA_FALSE, otherwise
9202     *
9203     * By default, grid items will only call their selection callback
9204     * function when firstly getting selected, any subsequent further
9205     * clicks will do nothing. With this call, you make those
9206     * subsequent clicks also to issue the selection callbacks.
9207     *
9208     * @note <b>Double clicks</b> will @b always be reported on items.
9209     *
9210     * @see elm_gengrid_always_select_mode_get()
9211     *
9212     * @ingroup Gengrid
9213     */
9214    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
9215
9216    /**
9217     * Get whether items on a given gengrid widget have their selection
9218     * callbacks issued for @b every subsequent selection click on them
9219     * or just for the first click.
9220     *
9221     * @param obj The gengrid object.
9222     * @return @c EINA_TRUE if the gengrid items are "always selected",
9223     * @c EINA_FALSE, otherwise
9224     *
9225     * @see elm_gengrid_always_select_mode_set() for more details
9226     *
9227     * @ingroup Gengrid
9228     */
9229    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9230
9231    /**
9232     * Set whether items on a given gengrid widget can be selected or not.
9233     *
9234     * @param obj The gengrid object
9235     * @param no_select @c EINA_TRUE to make items selectable,
9236     * @c EINA_FALSE otherwise
9237     *
9238     * This will make items in @p obj selectable or not. In the latter
9239     * case, any user interaction on the gengrid items will neither make
9240     * them appear selected nor them call their selection callback
9241     * functions.
9242     *
9243     * @see elm_gengrid_no_select_mode_get()
9244     *
9245     * @ingroup Gengrid
9246     */
9247    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
9248
9249    /**
9250     * Get whether items on a given gengrid widget can be selected or
9251     * not.
9252     *
9253     * @param obj The gengrid object
9254     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
9255     * otherwise
9256     *
9257     * @see elm_gengrid_no_select_mode_set() for more details
9258     *
9259     * @ingroup Gengrid
9260     */
9261    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9262
9263    /**
9264     * Enable or disable multi-selection in a given gengrid widget
9265     *
9266     * @param obj The gengrid object.
9267     * @param multi @c EINA_TRUE, to enable multi-selection,
9268     * @c EINA_FALSE to disable it.
9269     *
9270     * Multi-selection is the ability to have @b more than one
9271     * item selected, on a given gengrid, simultaneously. When it is
9272     * enabled, a sequence of clicks on different items will make them
9273     * all selected, progressively. A click on an already selected item
9274     * will unselect it. If interacting via the keyboard,
9275     * multi-selection is enabled while holding the "Shift" key.
9276     *
9277     * @note By default, multi-selection is @b disabled on gengrids
9278     *
9279     * @see elm_gengrid_multi_select_get()
9280     *
9281     * @ingroup Gengrid
9282     */
9283    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9284
9285    /**
9286     * Get whether multi-selection is enabled or disabled for a given
9287     * gengrid widget
9288     *
9289     * @param obj The gengrid object.
9290     * @return @c EINA_TRUE, if multi-selection is enabled, @c
9291     * EINA_FALSE otherwise
9292     *
9293     * @see elm_gengrid_multi_select_set() for more details
9294     *
9295     * @ingroup Gengrid
9296     */
9297    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9298
9299    /**
9300     * Enable or disable bouncing effect for a given gengrid widget
9301     *
9302     * @param obj The gengrid object
9303     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
9304     * @c EINA_FALSE to disable it
9305     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
9306     * @c EINA_FALSE to disable it
9307     *
9308     * The bouncing effect occurs whenever one reaches the gengrid's
9309     * edge's while panning it -- it will scroll past its limits a
9310     * little bit and return to the edge again, in a animated for,
9311     * automatically.
9312     *
9313     * @note By default, gengrids have bouncing enabled on both axis
9314     *
9315     * @see elm_gengrid_bounce_get()
9316     *
9317     * @ingroup Gengrid
9318     */
9319    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9320
9321    /**
9322     * Get whether bouncing effects are enabled or disabled, for a
9323     * given gengrid widget, on each axis
9324     *
9325     * @param obj The gengrid object
9326     * @param h_bounce Pointer to a variable where to store the
9327     * horizontal bouncing flag.
9328     * @param v_bounce Pointer to a variable where to store the
9329     * vertical bouncing flag.
9330     *
9331     * @see elm_gengrid_bounce_set() for more details
9332     *
9333     * @ingroup Gengrid
9334     */
9335    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9336
9337    /**
9338     * Set a given gengrid widget's scrolling page size, relative to
9339     * its viewport size.
9340     *
9341     * @param obj The gengrid object
9342     * @param h_pagerel The horizontal page (relative) size
9343     * @param v_pagerel The vertical page (relative) size
9344     *
9345     * The gengrid's scroller is capable of binding scrolling by the
9346     * user to "pages". It means that, while scrolling and, specially
9347     * after releasing the mouse button, the grid will @b snap to the
9348     * nearest displaying page's area. When page sizes are set, the
9349     * grid's continuous content area is split into (equal) page sized
9350     * pieces.
9351     *
9352     * This function sets the size of a page <b>relatively to the
9353     * viewport dimensions</b> of the gengrid, for each axis. A value
9354     * @c 1.0 means "the exact viewport's size", in that axis, while @c
9355     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
9356     * a viewport". Sane usable values are, than, between @c 0.0 and @c
9357     * 1.0. Values beyond those will make it behave behave
9358     * inconsistently. If you only want one axis to snap to pages, use
9359     * the value @c 0.0 for the other one.
9360     *
9361     * There is a function setting page size values in @b absolute
9362     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
9363     * is mutually exclusive to this one.
9364     *
9365     * @see elm_gengrid_page_relative_get()
9366     *
9367     * @ingroup Gengrid
9368     */
9369    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
9370
9371    /**
9372     * Get a given gengrid widget's scrolling page size, relative to
9373     * its viewport size.
9374     *
9375     * @param obj The gengrid object
9376     * @param h_pagerel Pointer to a variable where to store the
9377     * horizontal page (relative) size
9378     * @param v_pagerel Pointer to a variable where to store the
9379     * vertical page (relative) size
9380     *
9381     * @see elm_gengrid_page_relative_set() for more details
9382     *
9383     * @ingroup Gengrid
9384     */
9385    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
9386
9387    /**
9388     * Set a given gengrid widget's scrolling page size
9389     *
9390     * @param obj The gengrid object
9391     * @param h_pagerel The horizontal page size, in pixels
9392     * @param v_pagerel The vertical page size, in pixels
9393     *
9394     * The gengrid's scroller is capable of binding scrolling by the
9395     * user to "pages". It means that, while scrolling and, specially
9396     * after releasing the mouse button, the grid will @b snap to the
9397     * nearest displaying page's area. When page sizes are set, the
9398     * grid's continuous content area is split into (equal) page sized
9399     * pieces.
9400     *
9401     * This function sets the size of a page of the gengrid, in pixels,
9402     * for each axis. Sane usable values are, between @c 0 and the
9403     * dimensions of @p obj, for each axis. Values beyond those will
9404     * make it behave behave inconsistently. If you only want one axis
9405     * to snap to pages, use the value @c 0 for the other one.
9406     *
9407     * There is a function setting page size values in @b relative
9408     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
9409     * use is mutually exclusive to this one.
9410     *
9411     * @ingroup Gengrid
9412     */
9413    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
9414
9415    /**
9416     * @brief Get gengrid current page number.
9417     *
9418     * @param obj The gengrid object
9419     * @param h_pagenumber The horizontal page number
9420     * @param v_pagenumber The vertical page number
9421     *
9422     * The page number starts from 0. 0 is the first page.
9423     * Current page means the page which meet the top-left of the viewport.
9424     * If there are two or more pages in the viewport, it returns the number of page
9425     * which meet the top-left of the viewport.
9426     *
9427     * @see elm_gengrid_last_page_get()
9428     * @see elm_gengrid_page_show()
9429     * @see elm_gengrid_page_brint_in()
9430     */
9431    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9432
9433    /**
9434     * @brief Get scroll last page number.
9435     *
9436     * @param obj The gengrid object
9437     * @param h_pagenumber The horizontal page number
9438     * @param v_pagenumber The vertical page number
9439     *
9440     * The page number starts from 0. 0 is the first page.
9441     * This returns the last page number among the pages.
9442     *
9443     * @see elm_gengrid_current_page_get()
9444     * @see elm_gengrid_page_show()
9445     * @see elm_gengrid_page_brint_in()
9446     */
9447    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9448
9449    /**
9450     * Show a specific virtual region within the gengrid content object by page number.
9451     *
9452     * @param obj The gengrid object
9453     * @param h_pagenumber The horizontal page number
9454     * @param v_pagenumber The vertical page number
9455     *
9456     * 0, 0 of the indicated page is located at the top-left of the viewport.
9457     * This will jump to the page directly without animation.
9458     *
9459     * Example of usage:
9460     *
9461     * @code
9462     * sc = elm_gengrid_add(win);
9463     * elm_gengrid_content_set(sc, content);
9464     * elm_gengrid_page_relative_set(sc, 1, 0);
9465     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
9466     * elm_gengrid_page_show(sc, h_page + 1, v_page);
9467     * @endcode
9468     *
9469     * @see elm_gengrid_page_bring_in()
9470     */
9471    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9472
9473    /**
9474     * Show a specific virtual region within the gengrid content object by page number.
9475     *
9476     * @param obj The gengrid object
9477     * @param h_pagenumber The horizontal page number
9478     * @param v_pagenumber The vertical page number
9479     *
9480     * 0, 0 of the indicated page is located at the top-left of the viewport.
9481     * This will slide to the page with animation.
9482     *
9483     * Example of usage:
9484     *
9485     * @code
9486     * sc = elm_gengrid_add(win);
9487     * elm_gengrid_content_set(sc, content);
9488     * elm_gengrid_page_relative_set(sc, 1, 0);
9489     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9490     * elm_gengrid_page_bring_in(sc, h_page, v_page);
9491     * @endcode
9492     *
9493     * @see elm_gengrid_page_show()
9494     */
9495     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9496
9497    /**
9498     * Set the direction in which a given gengrid widget will expand while
9499     * placing its items.
9500     *
9501     * @param obj The gengrid object.
9502     * @param setting @c EINA_TRUE to make the gengrid expand
9503     * horizontally, @c EINA_FALSE to expand vertically.
9504     *
9505     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9506     * in @b columns, from top to bottom and, when the space for a
9507     * column is filled, another one is started on the right, thus
9508     * expanding the grid horizontally. When in "vertical mode"
9509     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9510     * to right and, when the space for a row is filled, another one is
9511     * started below, thus expanding the grid vertically.
9512     *
9513     * @see elm_gengrid_horizontal_get()
9514     *
9515     * @ingroup Gengrid
9516     */
9517    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9518
9519    /**
9520     * Get for what direction a given gengrid widget will expand while
9521     * placing its items.
9522     *
9523     * @param obj The gengrid object.
9524     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9525     * @c EINA_FALSE if it's set to expand vertically.
9526     *
9527     * @see elm_gengrid_horizontal_set() for more detais
9528     *
9529     * @ingroup Gengrid
9530     */
9531    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9532
9533    /**
9534     * Get the first item in a given gengrid widget
9535     *
9536     * @param obj The gengrid object
9537     * @return The first item's handle or @c NULL, if there are no
9538     * items in @p obj (and on errors)
9539     *
9540     * This returns the first item in the @p obj's internal list of
9541     * items.
9542     *
9543     * @see elm_gengrid_last_item_get()
9544     *
9545     * @ingroup Gengrid
9546     */
9547    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9548
9549    /**
9550     * Get the last item in a given gengrid widget
9551     *
9552     * @param obj The gengrid object
9553     * @return The last item's handle or @c NULL, if there are no
9554     * items in @p obj (and on errors)
9555     *
9556     * This returns the last item in the @p obj's internal list of
9557     * items.
9558     *
9559     * @see elm_gengrid_first_item_get()
9560     *
9561     * @ingroup Gengrid
9562     */
9563    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9564
9565    /**
9566     * Get the @b next item in a gengrid widget's internal list of items,
9567     * given a handle to one of those items.
9568     *
9569     * @param item The gengrid item to fetch next from
9570     * @return The item after @p item, or @c NULL if there's none (and
9571     * on errors)
9572     *
9573     * This returns the item placed after the @p item, on the container
9574     * gengrid.
9575     *
9576     * @see elm_gengrid_item_prev_get()
9577     *
9578     * @ingroup Gengrid
9579     */
9580    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9581
9582    /**
9583     * Get the @b previous item in a gengrid widget's internal list of items,
9584     * given a handle to one of those items.
9585     *
9586     * @param item The gengrid item to fetch previous from
9587     * @return The item before @p item, or @c NULL if there's none (and
9588     * on errors)
9589     *
9590     * This returns the item placed before the @p item, on the container
9591     * gengrid.
9592     *
9593     * @see elm_gengrid_item_next_get()
9594     *
9595     * @ingroup Gengrid
9596     */
9597    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9598
9599    /**
9600     * Get the gengrid object's handle which contains a given gengrid
9601     * item
9602     *
9603     * @param item The item to fetch the container from
9604     * @return The gengrid (parent) object
9605     *
9606     * This returns the gengrid object itself that an item belongs to.
9607     *
9608     * @ingroup Gengrid
9609     */
9610    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9611
9612    /**
9613     * Remove a gengrid item from its parent, deleting it.
9614     *
9615     * @param item The item to be removed.
9616     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9617     *
9618     * @see elm_gengrid_clear(), to remove all items in a gengrid at
9619     * once.
9620     *
9621     * @ingroup Gengrid
9622     */
9623    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9624
9625    /**
9626     * Update the contents of a given gengrid item
9627     *
9628     * @param item The gengrid item
9629     *
9630     * This updates an item by calling all the item class functions
9631     * again to get the contents, texts and states. Use this when the
9632     * original item data has changed and you want the changes to be
9633     * reflected.
9634     *
9635     * @ingroup Gengrid
9636     */
9637    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9638
9639    /**
9640     * Get the Gengrid Item class for the given Gengrid Item.
9641     *
9642     * @param item The gengrid item
9643     *
9644     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9645     * the function pointers and item_style.
9646     *
9647     * @ingroup Gengrid
9648     */
9649    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9650
9651    /**
9652     * Get the Gengrid Item class for the given Gengrid Item.
9653     *
9654     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9655     * the function pointers and item_style.
9656     *
9657     * @param item The gengrid item
9658     * @param gic The gengrid item class describing the function pointers and the item style.
9659     *
9660     * @ingroup Gengrid
9661     */
9662    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9663
9664    /**
9665     * Return the data associated to a given gengrid item
9666     *
9667     * @param item The gengrid item.
9668     * @return the data associated with this item.
9669     *
9670     * This returns the @c data value passed on the
9671     * elm_gengrid_item_append() and related item addition calls.
9672     *
9673     * @see elm_gengrid_item_append()
9674     * @see elm_gengrid_item_data_set()
9675     *
9676     * @ingroup Gengrid
9677     */
9678    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9679
9680    /**
9681     * Set the data associated with a given gengrid item
9682     *
9683     * @param item The gengrid item
9684     * @param data The data pointer to set on it
9685     *
9686     * This @b overrides the @c data value passed on the
9687     * elm_gengrid_item_append() and related item addition calls. This
9688     * function @b won't call elm_gengrid_item_update() automatically,
9689     * so you'd issue it afterwards if you want to have the item
9690     * updated to reflect the new data.
9691     *
9692     * @see elm_gengrid_item_data_get()
9693     * @see elm_gengrid_item_update()
9694     *
9695     * @ingroup Gengrid
9696     */
9697    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9698
9699    /**
9700     * Get a given gengrid item's position, relative to the whole
9701     * gengrid's grid area.
9702     *
9703     * @param item The Gengrid item.
9704     * @param x Pointer to variable to store the item's <b>row number</b>.
9705     * @param y Pointer to variable to store the item's <b>column number</b>.
9706     *
9707     * This returns the "logical" position of the item within the
9708     * gengrid. For example, @c (0, 1) would stand for first row,
9709     * second column.
9710     *
9711     * @ingroup Gengrid
9712     */
9713    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9714
9715    /**
9716     * Set whether a given gengrid item is selected or not
9717     *
9718     * @param item The gengrid item
9719     * @param selected Use @c EINA_TRUE, to make it selected, @c
9720     * EINA_FALSE to make it unselected
9721     *
9722     * This sets the selected state of an item. If multi-selection is
9723     * not enabled on the containing gengrid and @p selected is @c
9724     * EINA_TRUE, any other previously selected items will get
9725     * unselected in favor of this new one.
9726     *
9727     * @see elm_gengrid_item_selected_get()
9728     *
9729     * @ingroup Gengrid
9730     */
9731    EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9732
9733    /**
9734     * Get whether a given gengrid item is selected or not
9735     *
9736     * @param item The gengrid item
9737     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9738     *
9739     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9740     *
9741     * @see elm_gengrid_item_selected_set() for more details
9742     *
9743     * @ingroup Gengrid
9744     */
9745    EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9746
9747    /**
9748     * Get the real Evas object created to implement the view of a
9749     * given gengrid item
9750     *
9751     * @param item The gengrid item.
9752     * @return the Evas object implementing this item's view.
9753     *
9754     * This returns the actual Evas object used to implement the
9755     * specified gengrid item's view. This may be @c NULL, as it may
9756     * not have been created or may have been deleted, at any time, by
9757     * the gengrid. <b>Do not modify this object</b> (move, resize,
9758     * show, hide, etc.), as the gengrid is controlling it. This
9759     * function is for querying, emitting custom signals or hooking
9760     * lower level callbacks for events on that object. Do not delete
9761     * this object under any circumstances.
9762     *
9763     * @see elm_gengrid_item_data_get()
9764     *
9765     * @ingroup Gengrid
9766     */
9767    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9768
9769    /**
9770     * Show the portion of a gengrid's internal grid containing a given
9771     * item, @b immediately.
9772     *
9773     * @param item The item to display
9774     *
9775     * This causes gengrid to @b redraw its viewport's contents to the
9776     * region contining the given @p item item, if it is not fully
9777     * visible.
9778     *
9779     * @see elm_gengrid_item_bring_in()
9780     *
9781     * @ingroup Gengrid
9782     */
9783    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9784
9785    /**
9786     * Animatedly bring in, to the visible area of a gengrid, a given
9787     * item on it.
9788     *
9789     * @param item The gengrid item to display
9790     *
9791     * This causes gengrid to jump to the given @p item and show
9792     * it (by scrolling), if it is not fully visible. This will use
9793     * animation to do so and take a period of time to complete.
9794     *
9795     * @see elm_gengrid_item_show()
9796     *
9797     * @ingroup Gengrid
9798     */
9799    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9800
9801    /**
9802     * Set whether a given gengrid item is disabled or not.
9803     *
9804     * @param item The gengrid item
9805     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9806     * to enable it back.
9807     *
9808     * A disabled item cannot be selected or unselected. It will also
9809     * change its appearance, to signal the user it's disabled.
9810     *
9811     * @see elm_gengrid_item_disabled_get()
9812     *
9813     * @ingroup Gengrid
9814     */
9815    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9816
9817    /**
9818     * Get whether a given gengrid item is disabled or not.
9819     *
9820     * @param item The gengrid item
9821     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9822     * (and on errors).
9823     *
9824     * @see elm_gengrid_item_disabled_set() for more details
9825     *
9826     * @ingroup Gengrid
9827     */
9828    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9829
9830    /**
9831     * Set the text to be shown in a given gengrid item's tooltips.
9832     *
9833     * @param item The gengrid item
9834     * @param text The text to set in the content
9835     *
9836     * This call will setup the text to be used as tooltip to that item
9837     * (analogous to elm_object_tooltip_text_set(), but being item
9838     * tooltips with higher precedence than object tooltips). It can
9839     * have only one tooltip at a time, so any previous tooltip data
9840     * will get removed.
9841     *
9842     * @ingroup Gengrid
9843     */
9844    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9845
9846    /**
9847     * Set the content to be shown in a given gengrid item's tooltip
9848     *
9849     * @param item The gengrid item.
9850     * @param func The function returning the tooltip contents.
9851     * @param data What to provide to @a func as callback data/context.
9852     * @param del_cb Called when data is not needed anymore, either when
9853     *        another callback replaces @p func, the tooltip is unset with
9854     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9855     *        dies. This callback receives as its first parameter the
9856     *        given @p data, being @c event_info the item handle.
9857     *
9858     * This call will setup the tooltip's contents to @p item
9859     * (analogous to elm_object_tooltip_content_cb_set(), but being
9860     * item tooltips with higher precedence than object tooltips). It
9861     * can have only one tooltip at a time, so any previous tooltip
9862     * content will get removed. @p func (with @p data) will be called
9863     * every time Elementary needs to show the tooltip and it should
9864     * return a valid Evas object, which will be fully managed by the
9865     * tooltip system, getting deleted when the tooltip is gone.
9866     *
9867     * @ingroup Gengrid
9868     */
9869    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);
9870
9871    /**
9872     * Unset a tooltip from a given gengrid item
9873     *
9874     * @param item gengrid item to remove a previously set tooltip from.
9875     *
9876     * This call removes any tooltip set on @p item. The callback
9877     * provided as @c del_cb to
9878     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9879     * notify it is not used anymore (and have resources cleaned, if
9880     * need be).
9881     *
9882     * @see elm_gengrid_item_tooltip_content_cb_set()
9883     *
9884     * @ingroup Gengrid
9885     */
9886    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9887
9888    /**
9889     * Set a different @b style for a given gengrid item's tooltip.
9890     *
9891     * @param item gengrid item with tooltip set
9892     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9893     * "default", @c "transparent", etc)
9894     *
9895     * Tooltips can have <b>alternate styles</b> to be displayed on,
9896     * which are defined by the theme set on Elementary. This function
9897     * works analogously as elm_object_tooltip_style_set(), but here
9898     * applied only to gengrid item objects. The default style for
9899     * tooltips is @c "default".
9900     *
9901     * @note before you set a style you should define a tooltip with
9902     *       elm_gengrid_item_tooltip_content_cb_set() or
9903     *       elm_gengrid_item_tooltip_text_set()
9904     *
9905     * @see elm_gengrid_item_tooltip_style_get()
9906     *
9907     * @ingroup Gengrid
9908     */
9909    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9910
9911    /**
9912     * Get the style set a given gengrid item's tooltip.
9913     *
9914     * @param item gengrid item with tooltip already set on.
9915     * @return style the theme style in use, which defaults to
9916     *         "default". If the object does not have a tooltip set,
9917     *         then @c NULL is returned.
9918     *
9919     * @see elm_gengrid_item_tooltip_style_set() for more details
9920     *
9921     * @ingroup Gengrid
9922     */
9923    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9924
9925    /**
9926     * @brief Disable size restrictions on an object's tooltip
9927     * @param item The tooltip's anchor object
9928     * @param disable If EINA_TRUE, size restrictions are disabled
9929     * @return EINA_FALSE on failure, EINA_TRUE on success
9930     *
9931     * This function allows a tooltip to expand beyond its parant window's canvas.
9932     * It will instead be limited only by the size of the display.
9933     */
9934    EAPI Eina_Bool          elm_gengrid_item_tooltip_window_mode_set(Elm_Gengrid_Item *item, Eina_Bool disable);
9935
9936    /**
9937     * @brief Retrieve size restriction state of an object's tooltip
9938     * @param item The tooltip's anchor object
9939     * @return If EINA_TRUE, size restrictions are disabled
9940     *
9941     * This function returns whether a tooltip is allowed to expand beyond
9942     * its parant window's canvas.
9943     * It will instead be limited only by the size of the display.
9944     */
9945    EAPI Eina_Bool          elm_gengrid_item_tooltip_window_mode_get(const Elm_Gengrid_Item *item);
9946
9947    /**
9948     * Set the type of mouse pointer/cursor decoration to be shown,
9949     * when the mouse pointer is over the given gengrid widget item
9950     *
9951     * @param item gengrid item to customize cursor on
9952     * @param cursor the cursor type's name
9953     *
9954     * This function works analogously as elm_object_cursor_set(), but
9955     * here the cursor's changing area is restricted to the item's
9956     * area, and not the whole widget's. Note that that item cursors
9957     * have precedence over widget cursors, so that a mouse over @p
9958     * item will always show cursor @p type.
9959     *
9960     * If this function is called twice for an object, a previously set
9961     * cursor will be unset on the second call.
9962     *
9963     * @see elm_object_cursor_set()
9964     * @see elm_gengrid_item_cursor_get()
9965     * @see elm_gengrid_item_cursor_unset()
9966     *
9967     * @ingroup Gengrid
9968     */
9969    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9970
9971    /**
9972     * Get the type of mouse pointer/cursor decoration set to be shown,
9973     * when the mouse pointer is over the given gengrid widget item
9974     *
9975     * @param item gengrid item with custom cursor set
9976     * @return the cursor type's name or @c NULL, if no custom cursors
9977     * were set to @p item (and on errors)
9978     *
9979     * @see elm_object_cursor_get()
9980     * @see elm_gengrid_item_cursor_set() for more details
9981     * @see elm_gengrid_item_cursor_unset()
9982     *
9983     * @ingroup Gengrid
9984     */
9985    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9986
9987    /**
9988     * Unset any custom mouse pointer/cursor decoration set to be
9989     * shown, when the mouse pointer is over the given gengrid widget
9990     * item, thus making it show the @b default cursor again.
9991     *
9992     * @param item a gengrid item
9993     *
9994     * Use this call to undo any custom settings on this item's cursor
9995     * decoration, bringing it back to defaults (no custom style set).
9996     *
9997     * @see elm_object_cursor_unset()
9998     * @see elm_gengrid_item_cursor_set() for more details
9999     *
10000     * @ingroup Gengrid
10001     */
10002    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10003
10004    /**
10005     * Set a different @b style for a given custom cursor set for a
10006     * gengrid item.
10007     *
10008     * @param item gengrid item with custom cursor set
10009     * @param style the <b>theme style</b> to use (e.g. @c "default",
10010     * @c "transparent", etc)
10011     *
10012     * This function only makes sense when one is using custom mouse
10013     * cursor decorations <b>defined in a theme file</b> , which can
10014     * have, given a cursor name/type, <b>alternate styles</b> on
10015     * it. It works analogously as elm_object_cursor_style_set(), but
10016     * here applied only to gengrid item objects.
10017     *
10018     * @warning Before you set a cursor style you should have defined a
10019     *       custom cursor previously on the item, with
10020     *       elm_gengrid_item_cursor_set()
10021     *
10022     * @see elm_gengrid_item_cursor_engine_only_set()
10023     * @see elm_gengrid_item_cursor_style_get()
10024     *
10025     * @ingroup Gengrid
10026     */
10027    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
10028
10029    /**
10030     * Get the current @b style set for a given gengrid item's custom
10031     * cursor
10032     *
10033     * @param item gengrid item with custom cursor set.
10034     * @return style the cursor style in use. If the object does not
10035     *         have a cursor set, then @c NULL is returned.
10036     *
10037     * @see elm_gengrid_item_cursor_style_set() for more details
10038     *
10039     * @ingroup Gengrid
10040     */
10041    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10042
10043    /**
10044     * Set if the (custom) cursor for a given gengrid item should be
10045     * searched in its theme, also, or should only rely on the
10046     * rendering engine.
10047     *
10048     * @param item item with custom (custom) cursor already set on
10049     * @param engine_only Use @c EINA_TRUE to have cursors looked for
10050     * only on those provided by the rendering engine, @c EINA_FALSE to
10051     * have them searched on the widget's theme, as well.
10052     *
10053     * @note This call is of use only if you've set a custom cursor
10054     * for gengrid items, with elm_gengrid_item_cursor_set().
10055     *
10056     * @note By default, cursors will only be looked for between those
10057     * provided by the rendering engine.
10058     *
10059     * @ingroup Gengrid
10060     */
10061    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10062
10063    /**
10064     * Get if the (custom) cursor for a given gengrid item is being
10065     * searched in its theme, also, or is only relying on the rendering
10066     * engine.
10067     *
10068     * @param item a gengrid item
10069     * @return @c EINA_TRUE, if cursors are being looked for only on
10070     * those provided by the rendering engine, @c EINA_FALSE if they
10071     * are being searched on the widget's theme, as well.
10072     *
10073     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
10074     *
10075     * @ingroup Gengrid
10076     */
10077    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10078
10079    /**
10080     * Remove all items from a given gengrid widget
10081     *
10082     * @param obj The gengrid object.
10083     *
10084     * This removes (and deletes) all items in @p obj, leaving it
10085     * empty.
10086     *
10087     * @see elm_gengrid_item_del(), to remove just one item.
10088     *
10089     * @ingroup Gengrid
10090     */
10091    EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10092
10093    /**
10094     * Get the selected item in a given gengrid widget
10095     *
10096     * @param obj The gengrid object.
10097     * @return The selected item's handleor @c NULL, if none is
10098     * selected at the moment (and on errors)
10099     *
10100     * This returns the selected item in @p obj. If multi selection is
10101     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
10102     * the first item in the list is selected, which might not be very
10103     * useful. For that case, see elm_gengrid_selected_items_get().
10104     *
10105     * @ingroup Gengrid
10106     */
10107    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10108
10109    /**
10110     * Get <b>a list</b> of selected items in a given gengrid
10111     *
10112     * @param obj The gengrid object.
10113     * @return The list of selected items or @c NULL, if none is
10114     * selected at the moment (and on errors)
10115     *
10116     * This returns a list of the selected items, in the order that
10117     * they appear in the grid. This list is only valid as long as no
10118     * more items are selected or unselected (or unselected implictly
10119     * by deletion). The list contains #Elm_Gengrid_Item pointers as
10120     * data, naturally.
10121     *
10122     * @see elm_gengrid_selected_item_get()
10123     *
10124     * @ingroup Gengrid
10125     */
10126    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10127
10128    /**
10129     * @}
10130     */
10131
10132    /**
10133     * @defgroup Clock Clock
10134     *
10135     * @image html img/widget/clock/preview-00.png
10136     * @image latex img/widget/clock/preview-00.eps
10137     *
10138     * This is a @b digital clock widget. In its default theme, it has a
10139     * vintage "flipping numbers clock" appearance, which will animate
10140     * sheets of individual algarisms individually as time goes by.
10141     *
10142     * A newly created clock will fetch system's time (already
10143     * considering local time adjustments) to start with, and will tick
10144     * accondingly. It may or may not show seconds.
10145     *
10146     * Clocks have an @b edition mode. When in it, the sheets will
10147     * display extra arrow indications on the top and bottom and the
10148     * user may click on them to raise or lower the time values. After
10149     * it's told to exit edition mode, it will keep ticking with that
10150     * new time set (it keeps the difference from local time).
10151     *
10152     * Also, when under edition mode, user clicks on the cited arrows
10153     * which are @b held for some time will make the clock to flip the
10154     * sheet, thus editing the time, continuosly and automatically for
10155     * the user. The interval between sheet flips will keep growing in
10156     * time, so that it helps the user to reach a time which is distant
10157     * from the one set.
10158     *
10159     * The time display is, by default, in military mode (24h), but an
10160     * am/pm indicator may be optionally shown, too, when it will
10161     * switch to 12h.
10162     *
10163     * Smart callbacks one can register to:
10164     * - "changed" - the clock's user changed the time
10165     *
10166     * Here is an example on its usage:
10167     * @li @ref clock_example
10168     */
10169
10170    /**
10171     * @addtogroup Clock
10172     * @{
10173     */
10174
10175    /**
10176     * Identifiers for which clock digits should be editable, when a
10177     * clock widget is in edition mode. Values may be ORed together to
10178     * make a mask, naturally.
10179     *
10180     * @see elm_clock_edit_set()
10181     * @see elm_clock_digit_edit_set()
10182     */
10183    typedef enum _Elm_Clock_Digedit
10184      {
10185         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
10186         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
10187         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
10188         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
10189         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
10190         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
10191         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
10192         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
10193      } Elm_Clock_Digedit;
10194
10195    /**
10196     * Add a new clock widget to the given parent Elementary
10197     * (container) object
10198     *
10199     * @param parent The parent object
10200     * @return a new clock widget handle or @c NULL, on errors
10201     *
10202     * This function inserts a new clock widget on the canvas.
10203     *
10204     * @ingroup Clock
10205     */
10206    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10207
10208    /**
10209     * Set a clock widget's time, programmatically
10210     *
10211     * @param obj The clock widget object
10212     * @param hrs The hours to set
10213     * @param min The minutes to set
10214     * @param sec The secondes to set
10215     *
10216     * This function updates the time that is showed by the clock
10217     * widget.
10218     *
10219     *  Values @b must be set within the following ranges:
10220     * - 0 - 23, for hours
10221     * - 0 - 59, for minutes
10222     * - 0 - 59, for seconds,
10223     *
10224     * even if the clock is not in "military" mode.
10225     *
10226     * @warning The behavior for values set out of those ranges is @b
10227     * undefined.
10228     *
10229     * @ingroup Clock
10230     */
10231    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
10232
10233    /**
10234     * Get a clock widget's time values
10235     *
10236     * @param obj The clock object
10237     * @param[out] hrs Pointer to the variable to get the hours value
10238     * @param[out] min Pointer to the variable to get the minutes value
10239     * @param[out] sec Pointer to the variable to get the seconds value
10240     *
10241     * This function gets the time set for @p obj, returning
10242     * it on the variables passed as the arguments to function
10243     *
10244     * @note Use @c NULL pointers on the time values you're not
10245     * interested in: they'll be ignored by the function.
10246     *
10247     * @ingroup Clock
10248     */
10249    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
10250
10251    /**
10252     * Set whether a given clock widget is under <b>edition mode</b> or
10253     * under (default) displaying-only mode.
10254     *
10255     * @param obj The clock object
10256     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
10257     * put it back to "displaying only" mode
10258     *
10259     * This function makes a clock's time to be editable or not <b>by
10260     * user interaction</b>. When in edition mode, clocks @b stop
10261     * ticking, until one brings them back to canonical mode. The
10262     * elm_clock_digit_edit_set() function will influence which digits
10263     * of the clock will be editable. By default, all of them will be
10264     * (#ELM_CLOCK_NONE).
10265     *
10266     * @note am/pm sheets, if being shown, will @b always be editable
10267     * under edition mode.
10268     *
10269     * @see elm_clock_edit_get()
10270     *
10271     * @ingroup Clock
10272     */
10273    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10274
10275    /**
10276     * Retrieve whether a given clock widget is under <b>edition
10277     * mode</b> or under (default) displaying-only mode.
10278     *
10279     * @param obj The clock object
10280     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
10281     * otherwise
10282     *
10283     * This function retrieves whether the clock's time can be edited
10284     * or not by user interaction.
10285     *
10286     * @see elm_clock_edit_set() for more details
10287     *
10288     * @ingroup Clock
10289     */
10290    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10291
10292    /**
10293     * Set what digits of the given clock widget should be editable
10294     * when in edition mode.
10295     *
10296     * @param obj The clock object
10297     * @param digedit Bit mask indicating the digits to be editable
10298     * (values in #Elm_Clock_Digedit).
10299     *
10300     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
10301     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
10302     * EINA_FALSE).
10303     *
10304     * @see elm_clock_digit_edit_get()
10305     *
10306     * @ingroup Clock
10307     */
10308    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
10309
10310    /**
10311     * Retrieve what digits of the given clock widget should be
10312     * editable when in edition mode.
10313     *
10314     * @param obj The clock object
10315     * @return Bit mask indicating the digits to be editable
10316     * (values in #Elm_Clock_Digedit).
10317     *
10318     * @see elm_clock_digit_edit_set() for more details
10319     *
10320     * @ingroup Clock
10321     */
10322    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10323
10324    /**
10325     * Set if the given clock widget must show hours in military or
10326     * am/pm mode
10327     *
10328     * @param obj The clock object
10329     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
10330     * to military mode
10331     *
10332     * This function sets if the clock must show hours in military or
10333     * am/pm mode. In some countries like Brazil the military mode
10334     * (00-24h-format) is used, in opposition to the USA, where the
10335     * am/pm mode is more commonly used.
10336     *
10337     * @see elm_clock_show_am_pm_get()
10338     *
10339     * @ingroup Clock
10340     */
10341    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
10342
10343    /**
10344     * Get if the given clock widget shows hours in military or am/pm
10345     * mode
10346     *
10347     * @param obj The clock object
10348     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
10349     * military
10350     *
10351     * This function gets if the clock shows hours in military or am/pm
10352     * mode.
10353     *
10354     * @see elm_clock_show_am_pm_set() for more details
10355     *
10356     * @ingroup Clock
10357     */
10358    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10359
10360    /**
10361     * Set if the given clock widget must show time with seconds or not
10362     *
10363     * @param obj The clock object
10364     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
10365     *
10366     * This function sets if the given clock must show or not elapsed
10367     * seconds. By default, they are @b not shown.
10368     *
10369     * @see elm_clock_show_seconds_get()
10370     *
10371     * @ingroup Clock
10372     */
10373    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
10374
10375    /**
10376     * Get whether the given clock widget is showing time with seconds
10377     * or not
10378     *
10379     * @param obj The clock object
10380     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
10381     *
10382     * This function gets whether @p obj is showing or not the elapsed
10383     * seconds.
10384     *
10385     * @see elm_clock_show_seconds_set()
10386     *
10387     * @ingroup Clock
10388     */
10389    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10390
10391    /**
10392     * Set the interval on time updates for an user mouse button hold
10393     * on clock widgets' time edition.
10394     *
10395     * @param obj The clock object
10396     * @param interval The (first) interval value in seconds
10397     *
10398     * This interval value is @b decreased while the user holds the
10399     * mouse pointer either incrementing or decrementing a given the
10400     * clock digit's value.
10401     *
10402     * This helps the user to get to a given time distant from the
10403     * current one easier/faster, as it will start to flip quicker and
10404     * quicker on mouse button holds.
10405     *
10406     * The calculation for the next flip interval value, starting from
10407     * the one set with this call, is the previous interval divided by
10408     * 1.05, so it decreases a little bit.
10409     *
10410     * The default starting interval value for automatic flips is
10411     * @b 0.85 seconds.
10412     *
10413     * @see elm_clock_interval_get()
10414     *
10415     * @ingroup Clock
10416     */
10417    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
10418
10419    /**
10420     * Get the interval on time updates for an user mouse button hold
10421     * on clock widgets' time edition.
10422     *
10423     * @param obj The clock object
10424     * @return The (first) interval value, in seconds, set on it
10425     *
10426     * @see elm_clock_interval_set() for more details
10427     *
10428     * @ingroup Clock
10429     */
10430    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10431
10432    /**
10433     * @}
10434     */
10435
10436    /**
10437     * @defgroup Layout Layout
10438     *
10439     * @image html img/widget/layout/preview-00.png
10440     * @image latex img/widget/layout/preview-00.eps width=\textwidth
10441     *
10442     * @image html img/layout-predefined.png
10443     * @image latex img/layout-predefined.eps width=\textwidth
10444     *
10445     * This is a container widget that takes a standard Edje design file and
10446     * wraps it very thinly in a widget.
10447     *
10448     * An Edje design (theme) file has a very wide range of possibilities to
10449     * describe the behavior of elements added to the Layout. Check out the Edje
10450     * documentation and the EDC reference to get more information about what can
10451     * be done with Edje.
10452     *
10453     * Just like @ref List, @ref Box, and other container widgets, any
10454     * object added to the Layout will become its child, meaning that it will be
10455     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
10456     *
10457     * The Layout widget can contain as many Contents, Boxes or Tables as
10458     * described in its theme file. For instance, objects can be added to
10459     * different Tables by specifying the respective Table part names. The same
10460     * is valid for Content and Box.
10461     *
10462     * The objects added as child of the Layout will behave as described in the
10463     * part description where they were added. There are 3 possible types of
10464     * parts where a child can be added:
10465     *
10466     * @section secContent Content (SWALLOW part)
10467     *
10468     * Only one object can be added to the @c SWALLOW part (but you still can
10469     * have many @c SWALLOW parts and one object on each of them). Use the @c
10470     * elm_object_content_set/get/unset functions to set, retrieve and unset
10471     * objects as content of the @c SWALLOW. After being set to this part, the
10472     * object size, position, visibility, clipping and other description
10473     * properties will be totally controlled by the description of the given part
10474     * (inside the Edje theme file).
10475     *
10476     * One can use @c evas_object_size_hint_* functions on the child to have some
10477     * kind of control over its behavior, but the resulting behavior will still
10478     * depend heavily on the @c SWALLOW part description.
10479     *
10480     * The Edje theme also can change the part description, based on signals or
10481     * scripts running inside the theme. This change can also be animated. All of
10482     * this will affect the child object set as content accordingly. The object
10483     * size will be changed if the part size is changed, it will animate move if
10484     * the part is moving, and so on.
10485     *
10486     * The following picture demonstrates a Layout widget with a child object
10487     * added to its @c SWALLOW:
10488     *
10489     * @image html layout_swallow.png
10490     * @image latex layout_swallow.eps width=\textwidth
10491     *
10492     * @section secBox Box (BOX part)
10493     *
10494     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10495     * allows one to add objects to the box and have them distributed along its
10496     * area, accordingly to the specified @a layout property (now by @a layout we
10497     * mean the chosen layouting design of the Box, not the Layout widget
10498     * itself).
10499     *
10500     * A similar effect for having a box with its position, size and other things
10501     * controlled by the Layout theme would be to create an Elementary @ref Box
10502     * widget and add it as a Content in the @c SWALLOW part.
10503     *
10504     * The main difference of using the Layout Box is that its behavior, the box
10505     * properties like layouting format, padding, align, etc. will be all
10506     * controlled by the theme. This means, for example, that a signal could be
10507     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10508     * handled the signal by changing the box padding, or align, or both. Using
10509     * the Elementary @ref Box widget is not necessarily harder or easier, it
10510     * just depends on the circunstances and requirements.
10511     *
10512     * The Layout Box can be used through the @c elm_layout_box_* set of
10513     * functions.
10514     *
10515     * The following picture demonstrates a Layout widget with many child objects
10516     * added to its @c BOX part:
10517     *
10518     * @image html layout_box.png
10519     * @image latex layout_box.eps width=\textwidth
10520     *
10521     * @section secTable Table (TABLE part)
10522     *
10523     * Just like the @ref secBox, the Layout Table is very similar to the
10524     * Elementary @ref Table widget. It allows one to add objects to the Table
10525     * specifying the row and column where the object should be added, and any
10526     * column or row span if necessary.
10527     *
10528     * Again, we could have this design by adding a @ref Table widget to the @c
10529     * SWALLOW part using elm_object_part_content_set(). The same difference happens
10530     * here when choosing to use the Layout Table (a @c TABLE part) instead of
10531     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10532     *
10533     * The Layout Table can be used through the @c elm_layout_table_* set of
10534     * functions.
10535     *
10536     * The following picture demonstrates a Layout widget with many child objects
10537     * added to its @c TABLE part:
10538     *
10539     * @image html layout_table.png
10540     * @image latex layout_table.eps width=\textwidth
10541     *
10542     * @section secPredef Predefined Layouts
10543     *
10544     * Another interesting thing about the Layout widget is that it offers some
10545     * predefined themes that come with the default Elementary theme. These
10546     * themes can be set by the call elm_layout_theme_set(), and provide some
10547     * basic functionality depending on the theme used.
10548     *
10549     * Most of them already send some signals, some already provide a toolbar or
10550     * back and next buttons.
10551     *
10552     * These are available predefined theme layouts. All of them have class = @c
10553     * layout, group = @c application, and style = one of the following options:
10554     *
10555     * @li @c toolbar-content - application with toolbar and main content area
10556     * @li @c toolbar-content-back - application with toolbar and main content
10557     * area with a back button and title area
10558     * @li @c toolbar-content-back-next - application with toolbar and main
10559     * content area with a back and next buttons and title area
10560     * @li @c content-back - application with a main content area with a back
10561     * button and title area
10562     * @li @c content-back-next - application with a main content area with a
10563     * back and next buttons and title area
10564     * @li @c toolbar-vbox - application with toolbar and main content area as a
10565     * vertical box
10566     * @li @c toolbar-table - application with toolbar and main content area as a
10567     * table
10568     *
10569     * @section secExamples Examples
10570     *
10571     * Some examples of the Layout widget can be found here:
10572     * @li @ref layout_example_01
10573     * @li @ref layout_example_02
10574     * @li @ref layout_example_03
10575     * @li @ref layout_example_edc
10576     *
10577     */
10578
10579    /**
10580     * Add a new layout to the parent
10581     *
10582     * @param parent The parent object
10583     * @return The new object or NULL if it cannot be created
10584     *
10585     * @see elm_layout_file_set()
10586     * @see elm_layout_theme_set()
10587     *
10588     * @ingroup Layout
10589     */
10590    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10591
10592    /**
10593     * Set the file that will be used as layout
10594     *
10595     * @param obj The layout object
10596     * @param file The path to file (edj) that will be used as layout
10597     * @param group The group that the layout belongs in edje file
10598     *
10599     * @return (1 = success, 0 = error)
10600     *
10601     * @ingroup Layout
10602     */
10603    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10604
10605    /**
10606     * Set the edje group from the elementary theme that will be used as layout
10607     *
10608     * @param obj The layout object
10609     * @param clas the clas of the group
10610     * @param group the group
10611     * @param style the style to used
10612     *
10613     * @return (1 = success, 0 = error)
10614     *
10615     * @ingroup Layout
10616     */
10617    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10618
10619    /**
10620     * Set the layout content.
10621     *
10622     * @param obj The layout object
10623     * @param swallow The swallow part name in the edje file
10624     * @param content The child that will be added in this layout object
10625     *
10626     * Once the content object is set, a previously set one will be deleted.
10627     * If you want to keep that old content object, use the
10628     * elm_object_part_content_unset() function.
10629     *
10630     * @note In an Edje theme, the part used as a content container is called @c
10631     * SWALLOW. This is why the parameter name is called @p swallow, but it is
10632     * expected to be a part name just like the second parameter of
10633     * elm_layout_box_append().
10634     *
10635     * @see elm_layout_box_append()
10636     * @see elm_object_part_content_get()
10637     * @see elm_object_part_content_unset()
10638     * @see @ref secBox
10639     * @deprecated use elm_object_part_content_set() instead
10640     *
10641     * @ingroup Layout
10642     */
10643    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10644
10645    /**
10646     * Get the child object in the given content part.
10647     *
10648     * @param obj The layout object
10649     * @param swallow The SWALLOW part to get its content
10650     *
10651     * @return The swallowed object or NULL if none or an error occurred
10652     *
10653     * @deprecated use elm_object_part_content_get() instead
10654     *
10655     * @ingroup Layout
10656     */
10657    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10658
10659    /**
10660     * Unset the layout content.
10661     *
10662     * @param obj The layout object
10663     * @param swallow The swallow part name in the edje file
10664     * @return The content that was being used
10665     *
10666     * Unparent and return the content object which was set for this part.
10667     *
10668     * @deprecated use elm_object_part_content_unset() instead
10669     *
10670     * @ingroup Layout
10671     */
10672    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10673
10674    /**
10675     * Set the text of the given part
10676     *
10677     * @param obj The layout object
10678     * @param part The TEXT part where to set the text
10679     * @param text The text to set
10680     *
10681     * @ingroup Layout
10682     * @deprecated use elm_object_part_text_set() instead.
10683     */
10684    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10685
10686    /**
10687     * Get the text set in the given part
10688     *
10689     * @param obj The layout object
10690     * @param part The TEXT part to retrieve the text off
10691     *
10692     * @return The text set in @p part
10693     *
10694     * @ingroup Layout
10695     * @deprecated use elm_object_part_text_get() instead.
10696     */
10697    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10698
10699    /**
10700     * Append child to layout box part.
10701     *
10702     * @param obj the layout object
10703     * @param part the box part to which the object will be appended.
10704     * @param child the child object to append to box.
10705     *
10706     * Once the object is appended, it will become child of the layout. Its
10707     * lifetime will be bound to the layout, whenever the layout dies the child
10708     * will be deleted automatically. One should use elm_layout_box_remove() to
10709     * make this layout forget about the object.
10710     *
10711     * @see elm_layout_box_prepend()
10712     * @see elm_layout_box_insert_before()
10713     * @see elm_layout_box_insert_at()
10714     * @see elm_layout_box_remove()
10715     *
10716     * @ingroup Layout
10717     */
10718    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10719
10720    /**
10721     * Prepend child to layout box part.
10722     *
10723     * @param obj the layout object
10724     * @param part the box part to prepend.
10725     * @param child the child object to prepend to box.
10726     *
10727     * Once the object is prepended, it will become child of the layout. Its
10728     * lifetime will be bound to the layout, whenever the layout dies the child
10729     * will be deleted automatically. One should use elm_layout_box_remove() to
10730     * make this layout forget about the object.
10731     *
10732     * @see elm_layout_box_append()
10733     * @see elm_layout_box_insert_before()
10734     * @see elm_layout_box_insert_at()
10735     * @see elm_layout_box_remove()
10736     *
10737     * @ingroup Layout
10738     */
10739    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10740
10741    /**
10742     * Insert child to layout box part before a reference object.
10743     *
10744     * @param obj the layout object
10745     * @param part the box part to insert.
10746     * @param child the child object to insert into box.
10747     * @param reference another reference object to insert before in box.
10748     *
10749     * Once the object is inserted, it will become child of the layout. Its
10750     * lifetime will be bound to the layout, whenever the layout dies the child
10751     * will be deleted automatically. One should use elm_layout_box_remove() to
10752     * make this layout forget about the object.
10753     *
10754     * @see elm_layout_box_append()
10755     * @see elm_layout_box_prepend()
10756     * @see elm_layout_box_insert_before()
10757     * @see elm_layout_box_remove()
10758     *
10759     * @ingroup Layout
10760     */
10761    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10762
10763    /**
10764     * Insert child to layout box part at a given position.
10765     *
10766     * @param obj the layout object
10767     * @param part the box part to insert.
10768     * @param child the child object to insert into box.
10769     * @param pos the numeric position >=0 to insert the child.
10770     *
10771     * Once the object is inserted, it will become child of the layout. Its
10772     * lifetime will be bound to the layout, whenever the layout dies the child
10773     * will be deleted automatically. One should use elm_layout_box_remove() to
10774     * make this layout forget about the object.
10775     *
10776     * @see elm_layout_box_append()
10777     * @see elm_layout_box_prepend()
10778     * @see elm_layout_box_insert_before()
10779     * @see elm_layout_box_remove()
10780     *
10781     * @ingroup Layout
10782     */
10783    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10784
10785    /**
10786     * Remove a child of the given part box.
10787     *
10788     * @param obj The layout object
10789     * @param part The box part name to remove child.
10790     * @param child The object to remove from box.
10791     * @return The object that was being used, or NULL if not found.
10792     *
10793     * The object will be removed from the box part and its lifetime will
10794     * not be handled by the layout anymore. This is equivalent to
10795     * elm_object_part_content_unset() for box.
10796     *
10797     * @see elm_layout_box_append()
10798     * @see elm_layout_box_remove_all()
10799     *
10800     * @ingroup Layout
10801     */
10802    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10803
10804    /**
10805     * Remove all children of the given part box.
10806     *
10807     * @param obj The layout object
10808     * @param part The box part name to remove child.
10809     * @param clear If EINA_TRUE, then all objects will be deleted as
10810     *        well, otherwise they will just be removed and will be
10811     *        dangling on the canvas.
10812     *
10813     * The objects will be removed from the box part and their lifetime will
10814     * not be handled by the layout anymore. This is equivalent to
10815     * elm_layout_box_remove() for all box children.
10816     *
10817     * @see elm_layout_box_append()
10818     * @see elm_layout_box_remove()
10819     *
10820     * @ingroup Layout
10821     */
10822    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10823
10824    /**
10825     * Insert child to layout table part.
10826     *
10827     * @param obj the layout object
10828     * @param part the box part to pack child.
10829     * @param child_obj the child object to pack into table.
10830     * @param col the column to which the child should be added. (>= 0)
10831     * @param row the row to which the child should be added. (>= 0)
10832     * @param colspan how many columns should be used to store this object. (>=
10833     *        1)
10834     * @param rowspan how many rows should be used to store this object. (>= 1)
10835     *
10836     * Once the object is inserted, it will become child of the table. Its
10837     * lifetime will be bound to the layout, and whenever the layout dies the
10838     * child will be deleted automatically. One should use
10839     * elm_layout_table_remove() to make this layout forget about the object.
10840     *
10841     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10842     * more space than a single cell. For instance, the following code:
10843     * @code
10844     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10845     * @endcode
10846     *
10847     * Would result in an object being added like the following picture:
10848     *
10849     * @image html layout_colspan.png
10850     * @image latex layout_colspan.eps width=\textwidth
10851     *
10852     * @see elm_layout_table_unpack()
10853     * @see elm_layout_table_clear()
10854     *
10855     * @ingroup Layout
10856     */
10857    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);
10858
10859    /**
10860     * Unpack (remove) a child of the given part table.
10861     *
10862     * @param obj The layout object
10863     * @param part The table part name to remove child.
10864     * @param child_obj The object to remove from table.
10865     * @return The object that was being used, or NULL if not found.
10866     *
10867     * The object will be unpacked from the table part and its lifetime
10868     * will not be handled by the layout anymore. This is equivalent to
10869     * elm_object_part_content_unset() for table.
10870     *
10871     * @see elm_layout_table_pack()
10872     * @see elm_layout_table_clear()
10873     *
10874     * @ingroup Layout
10875     */
10876    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10877
10878    /**
10879     * Remove all the child objects of the given part table.
10880     *
10881     * @param obj The layout object
10882     * @param part The table part name to remove child.
10883     * @param clear If EINA_TRUE, then all objects will be deleted as
10884     *        well, otherwise they will just be removed and will be
10885     *        dangling on the canvas.
10886     *
10887     * The objects will be removed from the table part and their lifetime will
10888     * not be handled by the layout anymore. This is equivalent to
10889     * elm_layout_table_unpack() for all table children.
10890     *
10891     * @see elm_layout_table_pack()
10892     * @see elm_layout_table_unpack()
10893     *
10894     * @ingroup Layout
10895     */
10896    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10897
10898    /**
10899     * Get the edje layout
10900     *
10901     * @param obj The layout object
10902     *
10903     * @return A Evas_Object with the edje layout settings loaded
10904     * with function elm_layout_file_set
10905     *
10906     * This returns the edje object. It is not expected to be used to then
10907     * swallow objects via edje_object_part_swallow() for example. Use
10908     * elm_object_part_content_set() instead so child object handling and sizing is
10909     * done properly.
10910     *
10911     * @note This function should only be used if you really need to call some
10912     * low level Edje function on this edje object. All the common stuff (setting
10913     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10914     * with proper elementary functions.
10915     *
10916     * @see elm_object_signal_callback_add()
10917     * @see elm_object_signal_emit()
10918     * @see elm_object_part_text_set()
10919     * @see elm_object_part_content_set()
10920     * @see elm_layout_box_append()
10921     * @see elm_layout_table_pack()
10922     * @see elm_layout_data_get()
10923     *
10924     * @ingroup Layout
10925     */
10926    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10927
10928    /**
10929     * Get the edje data from the given layout
10930     *
10931     * @param obj The layout object
10932     * @param key The data key
10933     *
10934     * @return The edje data string
10935     *
10936     * This function fetches data specified inside the edje theme of this layout.
10937     * This function return NULL if data is not found.
10938     *
10939     * In EDC this comes from a data block within the group block that @p
10940     * obj was loaded from. E.g.
10941     *
10942     * @code
10943     * collections {
10944     *   group {
10945     *     name: "a_group";
10946     *     data {
10947     *       item: "key1" "value1";
10948     *       item: "key2" "value2";
10949     *     }
10950     *   }
10951     * }
10952     * @endcode
10953     *
10954     * @ingroup Layout
10955     */
10956    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10957
10958    /**
10959     * Eval sizing
10960     *
10961     * @param obj The layout object
10962     *
10963     * Manually forces a sizing re-evaluation. This is useful when the minimum
10964     * size required by the edje theme of this layout has changed. The change on
10965     * the minimum size required by the edje theme is not immediately reported to
10966     * the elementary layout, so one needs to call this function in order to tell
10967     * the widget (layout) that it needs to reevaluate its own size.
10968     *
10969     * The minimum size of the theme is calculated based on minimum size of
10970     * parts, the size of elements inside containers like box and table, etc. All
10971     * of this can change due to state changes, and that's when this function
10972     * should be called.
10973     *
10974     * Also note that a standard signal of "size,eval" "elm" emitted from the
10975     * edje object will cause this to happen too.
10976     *
10977     * @ingroup Layout
10978     */
10979    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10980
10981    /**
10982     * Sets a specific cursor for an edje part.
10983     *
10984     * @param obj The layout object.
10985     * @param part_name a part from loaded edje group.
10986     * @param cursor cursor name to use, see Elementary_Cursor.h
10987     *
10988     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10989     *         part not exists or it has "mouse_events: 0".
10990     *
10991     * @ingroup Layout
10992     */
10993    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10994
10995    /**
10996     * Get the cursor to be shown when mouse is over an edje part
10997     *
10998     * @param obj The layout object.
10999     * @param part_name a part from loaded edje group.
11000     * @return the cursor name.
11001     *
11002     * @ingroup Layout
11003     */
11004    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11005
11006    /**
11007     * Unsets a cursor previously set with elm_layout_part_cursor_set().
11008     *
11009     * @param obj The layout object.
11010     * @param part_name a part from loaded edje group, that had a cursor set
11011     *        with elm_layout_part_cursor_set().
11012     *
11013     * @ingroup Layout
11014     */
11015    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11016
11017    /**
11018     * Sets a specific cursor style for an edje part.
11019     *
11020     * @param obj The layout object.
11021     * @param part_name a part from loaded edje group.
11022     * @param style the theme style to use (default, transparent, ...)
11023     *
11024     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11025     *         part not exists or it did not had a cursor set.
11026     *
11027     * @ingroup Layout
11028     */
11029    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
11030
11031    /**
11032     * Gets a specific cursor style for an edje part.
11033     *
11034     * @param obj The layout object.
11035     * @param part_name a part from loaded edje group.
11036     *
11037     * @return the theme style in use, defaults to "default". If the
11038     *         object does not have a cursor set, then NULL is returned.
11039     *
11040     * @ingroup Layout
11041     */
11042    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11043
11044    /**
11045     * Sets if the cursor set should be searched on the theme or should use
11046     * the provided by the engine, only.
11047     *
11048     * @note before you set if should look on theme you should define a
11049     * cursor with elm_layout_part_cursor_set(). By default it will only
11050     * look for cursors provided by the engine.
11051     *
11052     * @param obj The layout object.
11053     * @param part_name a part from loaded edje group.
11054     * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
11055     *        or should also search on widget's theme as well (EINA_FALSE)
11056     *
11057     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11058     *         part not exists or it did not had a cursor set.
11059     *
11060     * @ingroup Layout
11061     */
11062    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);
11063
11064    /**
11065     * Gets a specific cursor engine_only for an edje part.
11066     *
11067     * @param obj The layout object.
11068     * @param part_name a part from loaded edje group.
11069     *
11070     * @return whenever the cursor is just provided by engine or also from theme.
11071     *
11072     * @ingroup Layout
11073     */
11074    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11075
11076 /**
11077  * @def elm_layout_icon_set
11078  * Convenience macro to set the icon object in a layout that follows the
11079  * Elementary naming convention for its parts.
11080  *
11081  * @ingroup Layout
11082  */
11083 #define elm_layout_icon_set(_ly, _obj) \
11084   do { \
11085     const char *sig; \
11086     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
11087     if ((_obj)) sig = "elm,state,icon,visible"; \
11088     else sig = "elm,state,icon,hidden"; \
11089     elm_object_signal_emit((_ly), sig, "elm"); \
11090   } while (0)
11091
11092 /**
11093  * @def elm_layout_icon_get
11094  * Convienience macro to get the icon object from a layout that follows the
11095  * Elementary naming convention for its parts.
11096  *
11097  * @ingroup Layout
11098  */
11099 #define elm_layout_icon_get(_ly) \
11100   elm_object_part_content_get((_ly), "elm.swallow.icon")
11101
11102 /**
11103  * @def elm_layout_end_set
11104  * Convienience macro to set the end object in a layout that follows the
11105  * Elementary naming convention for its parts.
11106  *
11107  * @ingroup Layout
11108  */
11109 #define elm_layout_end_set(_ly, _obj) \
11110   do { \
11111     const char *sig; \
11112     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
11113     if ((_obj)) sig = "elm,state,end,visible"; \
11114     else sig = "elm,state,end,hidden"; \
11115     elm_object_signal_emit((_ly), sig, "elm"); \
11116   } while (0)
11117
11118 /**
11119  * @def elm_layout_end_get
11120  * Convienience macro to get the end object in a layout that follows the
11121  * Elementary naming convention for its parts.
11122  *
11123  * @ingroup Layout
11124  */
11125 #define elm_layout_end_get(_ly) \
11126   elm_object_part_content_get((_ly), "elm.swallow.end")
11127
11128 /**
11129  * @def elm_layout_label_set
11130  * Convienience macro to set the label in a layout that follows the
11131  * Elementary naming convention for its parts.
11132  *
11133  * @ingroup Layout
11134  * @deprecated use elm_object_text_set() instead.
11135  */
11136 #define elm_layout_label_set(_ly, _txt) \
11137   elm_layout_text_set((_ly), "elm.text", (_txt))
11138
11139 /**
11140  * @def elm_layout_label_get
11141  * Convenience macro to get the label in a layout that follows the
11142  * Elementary naming convention for its parts.
11143  *
11144  * @ingroup Layout
11145  * @deprecated use elm_object_text_set() instead.
11146  */
11147 #define elm_layout_label_get(_ly) \
11148   elm_layout_text_get((_ly), "elm.text")
11149
11150    /* smart callbacks called:
11151     * "theme,changed" - when elm theme is changed.
11152     */
11153
11154    /**
11155     * @defgroup Notify Notify
11156     *
11157     * @image html img/widget/notify/preview-00.png
11158     * @image latex img/widget/notify/preview-00.eps
11159     *
11160     * Display a container in a particular region of the parent(top, bottom,
11161     * etc).  A timeout can be set to automatically hide the notify. This is so
11162     * that, after an evas_object_show() on a notify object, if a timeout was set
11163     * on it, it will @b automatically get hidden after that time.
11164     *
11165     * Signals that you can add callbacks for are:
11166     * @li "timeout" - when timeout happens on notify and it's hidden
11167     * @li "block,clicked" - when a click outside of the notify happens
11168     *
11169     * Default contents parts of the notify widget that you can use for are:
11170     * @li "default" - A content of the notify
11171     *
11172     * @ref tutorial_notify show usage of the API.
11173     *
11174     * @{
11175     */
11176
11177    /**
11178     * @brief Possible orient values for notify.
11179     *
11180     * This values should be used in conjunction to elm_notify_orient_set() to
11181     * set the position in which the notify should appear(relative to its parent)
11182     * and in conjunction with elm_notify_orient_get() to know where the notify
11183     * is appearing.
11184     */
11185    typedef enum _Elm_Notify_Orient
11186      {
11187         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
11188         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
11189         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
11190         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
11191         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
11192         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
11193         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
11194         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
11195         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
11196         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
11197      } Elm_Notify_Orient;
11198
11199    /**
11200     * @brief Add a new notify to the parent
11201     *
11202     * @param parent The parent object
11203     * @return The new object or NULL if it cannot be created
11204     */
11205    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11206
11207    /**
11208     * @brief Set the content of the notify widget
11209     *
11210     * @param obj The notify object
11211     * @param content The content will be filled in this notify object
11212     *
11213     * Once the content object is set, a previously set one will be deleted. If
11214     * you want to keep that old content object, use the
11215     * elm_notify_content_unset() function.
11216     *
11217     * @deprecated use elm_object_content_set() instead
11218     *
11219     */
11220    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11221
11222    /**
11223     * @brief Unset the content of the notify widget
11224     *
11225     * @param obj The notify object
11226     * @return The content that was being used
11227     *
11228     * Unparent and return the content object which was set for this widget
11229     *
11230     * @see elm_notify_content_set()
11231     * @deprecated use elm_object_content_unset() instead
11232     *
11233     */
11234    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11235
11236    /**
11237     * @brief Return the content of the notify widget
11238     *
11239     * @param obj The notify object
11240     * @return The content that is being used
11241     *
11242     * @see elm_notify_content_set()
11243     * @deprecated use elm_object_content_get() instead
11244     *
11245     */
11246    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11247
11248    /**
11249     * @brief Set the notify parent
11250     *
11251     * @param obj The notify object
11252     * @param content The new parent
11253     *
11254     * Once the parent object is set, a previously set one will be disconnected
11255     * and replaced.
11256     */
11257    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11258
11259    /**
11260     * @brief Get the notify parent
11261     *
11262     * @param obj The notify object
11263     * @return The parent
11264     *
11265     * @see elm_notify_parent_set()
11266     */
11267    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11268
11269    /**
11270     * @brief Set the orientation
11271     *
11272     * @param obj The notify object
11273     * @param orient The new orientation
11274     *
11275     * Sets the position in which the notify will appear in its parent.
11276     *
11277     * @see @ref Elm_Notify_Orient for possible values.
11278     */
11279    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
11280
11281    /**
11282     * @brief Return the orientation
11283     * @param obj The notify object
11284     * @return The orientation of the notification
11285     *
11286     * @see elm_notify_orient_set()
11287     * @see Elm_Notify_Orient
11288     */
11289    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11290
11291    /**
11292     * @brief Set the time interval after which the notify window is going to be
11293     * hidden.
11294     *
11295     * @param obj The notify object
11296     * @param time The timeout in seconds
11297     *
11298     * This function sets a timeout and starts the timer controlling when the
11299     * notify is hidden. Since calling evas_object_show() on a notify restarts
11300     * the timer controlling when the notify is hidden, setting this before the
11301     * notify is shown will in effect mean starting the timer when the notify is
11302     * shown.
11303     *
11304     * @note Set a value <= 0.0 to disable a running timer.
11305     *
11306     * @note If the value > 0.0 and the notify is previously visible, the
11307     * timer will be started with this value, canceling any running timer.
11308     */
11309    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
11310
11311    /**
11312     * @brief Return the timeout value (in seconds)
11313     * @param obj the notify object
11314     *
11315     * @see elm_notify_timeout_set()
11316     */
11317    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11318
11319    /**
11320     * @brief Sets whether events should be passed to by a click outside
11321     * its area.
11322     *
11323     * @param obj The notify object
11324     * @param repeats EINA_TRUE Events are repeats, else no
11325     *
11326     * When true if the user clicks outside the window the events will be caught
11327     * by the others widgets, else the events are blocked.
11328     *
11329     * @note The default value is EINA_TRUE.
11330     */
11331    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
11332
11333    /**
11334     * @brief Return true if events are repeat below the notify object
11335     * @param obj the notify object
11336     *
11337     * @see elm_notify_repeat_events_set()
11338     */
11339    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11340
11341    /**
11342     * @}
11343     */
11344
11345    /**
11346     * @defgroup Hover Hover
11347     *
11348     * @image html img/widget/hover/preview-00.png
11349     * @image latex img/widget/hover/preview-00.eps
11350     *
11351     * A Hover object will hover over its @p parent object at the @p target
11352     * location. Anything in the background will be given a darker coloring to
11353     * indicate that the hover object is on top (at the default theme). When the
11354     * hover is clicked it is dismissed(hidden), if the contents of the hover are
11355     * clicked that @b doesn't cause the hover to be dismissed.
11356     *
11357     * A Hover object has two parents. One parent that owns it during creation
11358     * and the other parent being the one over which the hover object spans.
11359     *
11360     *
11361     * @note The hover object will take up the entire space of @p target
11362     * object.
11363     *
11364     * Elementary has the following styles for the hover widget:
11365     * @li default
11366     * @li popout
11367     * @li menu
11368     * @li hoversel_vertical
11369     *
11370     * The following are the available position for content:
11371     * @li left
11372     * @li top-left
11373     * @li top
11374     * @li top-right
11375     * @li right
11376     * @li bottom-right
11377     * @li bottom
11378     * @li bottom-left
11379     * @li middle
11380     * @li smart
11381     *
11382     * Signals that you can add callbacks for are:
11383     * @li "clicked" - the user clicked the empty space in the hover to dismiss
11384     * @li "smart,changed" - a content object placed under the "smart"
11385     *                   policy was replaced to a new slot direction.
11386     *
11387     * See @ref tutorial_hover for more information.
11388     *
11389     * @{
11390     */
11391    typedef enum _Elm_Hover_Axis
11392      {
11393         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
11394         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
11395         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
11396         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
11397      } Elm_Hover_Axis;
11398
11399    /**
11400     * @brief Adds a hover object to @p parent
11401     *
11402     * @param parent The parent object
11403     * @return The hover object or NULL if one could not be created
11404     */
11405    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11406
11407    /**
11408     * @brief Sets the target object for the hover.
11409     *
11410     * @param obj The hover object
11411     * @param target The object to center the hover onto.
11412     *
11413     * This function will cause the hover to be centered on the target object.
11414     */
11415    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
11416
11417    /**
11418     * @brief Gets the target object for the hover.
11419     *
11420     * @param obj The hover object
11421     * @return The target object for the hover.
11422     *
11423     * @see elm_hover_target_set()
11424     */
11425    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11426
11427    /**
11428     * @brief Sets the parent object for the hover.
11429     *
11430     * @param obj The hover object
11431     * @param parent The object to locate the hover over.
11432     *
11433     * This function will cause the hover to take up the entire space that the
11434     * parent object fills.
11435     */
11436    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11437
11438    /**
11439     * @brief Gets the parent object for the hover.
11440     *
11441     * @param obj The hover object
11442     * @return The parent object to locate the hover over.
11443     *
11444     * @see elm_hover_parent_set()
11445     */
11446    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11447
11448    /**
11449     * @brief Sets the content of the hover object and the direction in which it
11450     * will pop out.
11451     *
11452     * @param obj The hover object
11453     * @param swallow The direction that the object will be displayed
11454     * at. Accepted values are "left", "top-left", "top", "top-right",
11455     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
11456     * "smart".
11457     * @param content The content to place at @p swallow
11458     *
11459     * Once the content object is set for a given direction, a previously
11460     * set one (on the same direction) will be deleted. If you want to
11461     * keep that old content object, use the elm_hover_content_unset()
11462     * function.
11463     *
11464     * All directions may have contents at the same time, except for
11465     * "smart". This is a special placement hint and its use case
11466     * independs of the calculations coming from
11467     * elm_hover_best_content_location_get(). Its use is for cases when
11468     * one desires only one hover content, but with a dynamic special
11469     * placement within the hover area. The content's geometry, whenever
11470     * it changes, will be used to decide on a best location, not
11471     * extrapolating the hover's parent object view to show it in (still
11472     * being the hover's target determinant of its medium part -- move and
11473     * resize it to simulate finger sizes, for example). If one of the
11474     * directions other than "smart" are used, a previously content set
11475     * using it will be deleted, and vice-versa.
11476     */
11477    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
11478
11479    /**
11480     * @brief Get the content of the hover object, in a given direction.
11481     *
11482     * Return the content object which was set for this widget in the
11483     * @p swallow direction.
11484     *
11485     * @param obj The hover object
11486     * @param swallow The direction that the object was display at.
11487     * @return The content that was being used
11488     *
11489     * @see elm_hover_content_set()
11490     */
11491    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11492
11493    /**
11494     * @brief Unset the content of the hover object, in a given direction.
11495     *
11496     * Unparent and return the content object set at @p swallow direction.
11497     *
11498     * @param obj The hover object
11499     * @param swallow The direction that the object was display at.
11500     * @return The content that was being used.
11501     *
11502     * @see elm_hover_content_set()
11503     */
11504    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11505
11506    /**
11507     * @brief Returns the best swallow location for content in the hover.
11508     *
11509     * @param obj The hover object
11510     * @param pref_axis The preferred orientation axis for the hover object to use
11511     * @return The edje location to place content into the hover or @c
11512     *         NULL, on errors.
11513     *
11514     * Best is defined here as the location at which there is the most available
11515     * space.
11516     *
11517     * @p pref_axis may be one of
11518     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
11519     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
11520     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
11521     * - @c ELM_HOVER_AXIS_BOTH -- both
11522     *
11523     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
11524     * nescessarily be along the horizontal axis("left" or "right"). If
11525     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11526     * be along the vertical axis("top" or "bottom"). Chossing
11527     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11528     * returned position may be in either axis.
11529     *
11530     * @see elm_hover_content_set()
11531     */
11532    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11533
11534    /**
11535     * @}
11536     */
11537
11538    /* entry */
11539    /**
11540     * @defgroup Entry Entry
11541     *
11542     * @image html img/widget/entry/preview-00.png
11543     * @image latex img/widget/entry/preview-00.eps width=\textwidth
11544     * @image html img/widget/entry/preview-01.png
11545     * @image latex img/widget/entry/preview-01.eps width=\textwidth
11546     * @image html img/widget/entry/preview-02.png
11547     * @image latex img/widget/entry/preview-02.eps width=\textwidth
11548     * @image html img/widget/entry/preview-03.png
11549     * @image latex img/widget/entry/preview-03.eps width=\textwidth
11550     *
11551     * An entry is a convenience widget which shows a box that the user can
11552     * enter text into. Entries by default don't scroll, so they grow to
11553     * accomodate the entire text, resizing the parent window as needed. This
11554     * can be changed with the elm_entry_scrollable_set() function.
11555     *
11556     * They can also be single line or multi line (the default) and when set
11557     * to multi line mode they support text wrapping in any of the modes
11558     * indicated by #Elm_Wrap_Type.
11559     *
11560     * Other features include password mode, filtering of inserted text with
11561     * elm_entry_text_filter_append() and related functions, inline "items" and
11562     * formatted markup text.
11563     *
11564     * @section entry-markup Formatted text
11565     *
11566     * The markup tags supported by the Entry are defined by the theme, but
11567     * even when writing new themes or extensions it's a good idea to stick to
11568     * a sane default, to maintain coherency and avoid application breakages.
11569     * Currently defined by the default theme are the following tags:
11570     * @li \<br\>: Inserts a line break.
11571     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11572     * breaks.
11573     * @li \<tab\>: Inserts a tab.
11574     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11575     * enclosed text.
11576     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11577     * @li \<link\>...\</link\>: Underlines the enclosed text.
11578     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11579     *
11580     * @section entry-special Special markups
11581     *
11582     * Besides those used to format text, entries support two special markup
11583     * tags used to insert clickable portions of text or items inlined within
11584     * the text.
11585     *
11586     * @subsection entry-anchors Anchors
11587     *
11588     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11589     * \</a\> tags and an event will be generated when this text is clicked,
11590     * like this:
11591     *
11592     * @code
11593     * This text is outside <a href=anc-01>but this one is an anchor</a>
11594     * @endcode
11595     *
11596     * The @c href attribute in the opening tag gives the name that will be
11597     * used to identify the anchor and it can be any valid utf8 string.
11598     *
11599     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11600     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11601     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11602     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11603     * an anchor.
11604     *
11605     * @subsection entry-items Items
11606     *
11607     * Inlined in the text, any other @c Evas_Object can be inserted by using
11608     * \<item\> tags this way:
11609     *
11610     * @code
11611     * <item size=16x16 vsize=full href=emoticon/haha></item>
11612     * @endcode
11613     *
11614     * Just like with anchors, the @c href identifies each item, but these need,
11615     * in addition, to indicate their size, which is done using any one of
11616     * @c size, @c absize or @c relsize attributes. These attributes take their
11617     * value in the WxH format, where W is the width and H the height of the
11618     * item.
11619     *
11620     * @li absize: Absolute pixel size for the item. Whatever value is set will
11621     * be the item's size regardless of any scale value the object may have
11622     * been set to. The final line height will be adjusted to fit larger items.
11623     * @li size: Similar to @c absize, but it's adjusted to the scale value set
11624     * for the object.
11625     * @li relsize: Size is adjusted for the item to fit within the current
11626     * line height.
11627     *
11628     * Besides their size, items are specificed a @c vsize value that affects
11629     * how their final size and position are calculated. The possible values
11630     * are:
11631     * @li ascent: Item will be placed within the line's baseline and its
11632     * ascent. That is, the height between the line where all characters are
11633     * positioned and the highest point in the line. For @c size and @c absize
11634     * items, the descent value will be added to the total line height to make
11635     * them fit. @c relsize items will be adjusted to fit within this space.
11636     * @li full: Items will be placed between the descent and ascent, or the
11637     * lowest point in the line and its highest.
11638     *
11639     * The next image shows different configurations of items and how
11640     * the previously mentioned options affect their sizes. In all cases,
11641     * the green line indicates the ascent, blue for the baseline and red for
11642     * the descent.
11643     *
11644     * @image html entry_item.png
11645     * @image latex entry_item.eps width=\textwidth
11646     *
11647     * And another one to show how size differs from absize. In the first one,
11648     * the scale value is set to 1.0, while the second one is using one of 2.0.
11649     *
11650     * @image html entry_item_scale.png
11651     * @image latex entry_item_scale.eps width=\textwidth
11652     *
11653     * After the size for an item is calculated, the entry will request an
11654     * object to place in its space. For this, the functions set with
11655     * elm_entry_item_provider_append() and related functions will be called
11656     * in order until one of them returns a @c non-NULL value. If no providers
11657     * are available, or all of them return @c NULL, then the entry falls back
11658     * to one of the internal defaults, provided the name matches with one of
11659     * them.
11660     *
11661     * All of the following are currently supported:
11662     *
11663     * - emoticon/angry
11664     * - emoticon/angry-shout
11665     * - emoticon/crazy-laugh
11666     * - emoticon/evil-laugh
11667     * - emoticon/evil
11668     * - emoticon/goggle-smile
11669     * - emoticon/grumpy
11670     * - emoticon/grumpy-smile
11671     * - emoticon/guilty
11672     * - emoticon/guilty-smile
11673     * - emoticon/haha
11674     * - emoticon/half-smile
11675     * - emoticon/happy-panting
11676     * - emoticon/happy
11677     * - emoticon/indifferent
11678     * - emoticon/kiss
11679     * - emoticon/knowing-grin
11680     * - emoticon/laugh
11681     * - emoticon/little-bit-sorry
11682     * - emoticon/love-lots
11683     * - emoticon/love
11684     * - emoticon/minimal-smile
11685     * - emoticon/not-happy
11686     * - emoticon/not-impressed
11687     * - emoticon/omg
11688     * - emoticon/opensmile
11689     * - emoticon/smile
11690     * - emoticon/sorry
11691     * - emoticon/squint-laugh
11692     * - emoticon/surprised
11693     * - emoticon/suspicious
11694     * - emoticon/tongue-dangling
11695     * - emoticon/tongue-poke
11696     * - emoticon/uh
11697     * - emoticon/unhappy
11698     * - emoticon/very-sorry
11699     * - emoticon/what
11700     * - emoticon/wink
11701     * - emoticon/worried
11702     * - emoticon/wtf
11703     *
11704     * Alternatively, an item may reference an image by its path, using
11705     * the URI form @c file:///path/to/an/image.png and the entry will then
11706     * use that image for the item.
11707     *
11708     * @section entry-files Loading and saving files
11709     *
11710     * Entries have convinience functions to load text from a file and save
11711     * changes back to it after a short delay. The automatic saving is enabled
11712     * by default, but can be disabled with elm_entry_autosave_set() and files
11713     * can be loaded directly as plain text or have any markup in them
11714     * recognized. See elm_entry_file_set() for more details.
11715     *
11716     * @section entry-signals Emitted signals
11717     *
11718     * This widget emits the following signals:
11719     *
11720     * @li "changed": The text within the entry was changed.
11721     * @li "changed,user": The text within the entry was changed because of user interaction.
11722     * @li "activated": The enter key was pressed on a single line entry.
11723     * @li "press": A mouse button has been pressed on the entry.
11724     * @li "longpressed": A mouse button has been pressed and held for a couple
11725     * seconds.
11726     * @li "clicked": The entry has been clicked (mouse press and release).
11727     * @li "clicked,double": The entry has been double clicked.
11728     * @li "clicked,triple": The entry has been triple clicked.
11729     * @li "focused": The entry has received focus.
11730     * @li "unfocused": The entry has lost focus.
11731     * @li "selection,paste": A paste of the clipboard contents was requested.
11732     * @li "selection,copy": A copy of the selected text into the clipboard was
11733     * requested.
11734     * @li "selection,cut": A cut of the selected text into the clipboard was
11735     * requested.
11736     * @li "selection,start": A selection has begun and no previous selection
11737     * existed.
11738     * @li "selection,changed": The current selection has changed.
11739     * @li "selection,cleared": The current selection has been cleared.
11740     * @li "cursor,changed": The cursor has changed position.
11741     * @li "anchor,clicked": An anchor has been clicked. The event_info
11742     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11743     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11744     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11745     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11746     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11747     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11748     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11749     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11750     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11751     * @li "preedit,changed": The preedit string has changed.
11752     * @li "language,changed": Program language changed.
11753     *
11754     * @section entry-examples
11755     *
11756     * An overview of the Entry API can be seen in @ref entry_example_01
11757     *
11758     * @{
11759     */
11760
11761    /**
11762     * @typedef Elm_Entry_Anchor_Info
11763     *
11764     * The info sent in the callback for the "anchor,clicked" signals emitted
11765     * by entries.
11766     */
11767    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11768
11769    /**
11770     * @struct _Elm_Entry_Anchor_Info
11771     *
11772     * The info sent in the callback for the "anchor,clicked" signals emitted
11773     * by entries.
11774     */
11775    struct _Elm_Entry_Anchor_Info
11776      {
11777         const char *name; /**< The name of the anchor, as stated in its href */
11778         int         button; /**< The mouse button used to click on it */
11779         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11780                     y, /**< Anchor geometry, relative to canvas */
11781                     w, /**< Anchor geometry, relative to canvas */
11782                     h; /**< Anchor geometry, relative to canvas */
11783      };
11784
11785    /**
11786     * @typedef Elm_Entry_Filter_Cb
11787     * This callback type is used by entry filters to modify text.
11788     * @param data The data specified as the last param when adding the filter
11789     * @param entry The entry object
11790     * @param text A pointer to the location of the text being filtered. This data can be modified,
11791     * but any additional allocations must be managed by the user.
11792     * @see elm_entry_text_filter_append
11793     * @see elm_entry_text_filter_prepend
11794     */
11795    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11796
11797    /**
11798     * @typedef Elm_Entry_Change_Info
11799     * This corresponds to Edje_Entry_Change_Info. Includes information about
11800     * a change in the entry.
11801     */
11802    typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11803
11804
11805    /**
11806     * This adds an entry to @p parent object.
11807     *
11808     * By default, entries are:
11809     * @li not scrolled
11810     * @li multi-line
11811     * @li word wrapped
11812     * @li autosave is enabled
11813     *
11814     * @param parent The parent object
11815     * @return The new object or NULL if it cannot be created
11816     */
11817    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11818
11819    /**
11820     * Sets the entry to single line mode.
11821     *
11822     * In single line mode, entries don't ever wrap when the text reaches the
11823     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11824     * key will generate an @c "activate" event instead of adding a new line.
11825     *
11826     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11827     * and pressing enter will break the text into a different line
11828     * without generating any events.
11829     *
11830     * @param obj The entry object
11831     * @param single_line If true, the text in the entry
11832     * will be on a single line.
11833     */
11834    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11835
11836    /**
11837     * Gets whether the entry is set to be single line.
11838     *
11839     * @param obj The entry object
11840     * @return single_line If true, the text in the entry is set to display
11841     * on a single line.
11842     *
11843     * @see elm_entry_single_line_set()
11844     */
11845    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11846
11847    /**
11848     * Sets the entry to password mode.
11849     *
11850     * In password mode, entries are implicitly single line and the display of
11851     * any text in them is replaced with asterisks (*).
11852     *
11853     * @param obj The entry object
11854     * @param password If true, password mode is enabled.
11855     */
11856    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11857
11858    /**
11859     * Gets whether the entry is set to password mode.
11860     *
11861     * @param obj The entry object
11862     * @return If true, the entry is set to display all characters
11863     * as asterisks (*).
11864     *
11865     * @see elm_entry_password_set()
11866     */
11867    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11868
11869    /**
11870     * This sets the text displayed within the entry to @p entry.
11871     *
11872     * @param obj The entry object
11873     * @param entry The text to be displayed
11874     *
11875     * @deprecated Use elm_object_text_set() instead.
11876     * @note Using this function bypasses text filters
11877     */
11878    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11879
11880    /**
11881     * This returns the text currently shown in object @p entry.
11882     * See also elm_entry_entry_set().
11883     *
11884     * @param obj The entry object
11885     * @return The currently displayed text or NULL on failure
11886     *
11887     * @deprecated Use elm_object_text_get() instead.
11888     */
11889    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11890
11891    /**
11892     * Appends @p entry to the text of the entry.
11893     *
11894     * Adds the text in @p entry to the end of any text already present in the
11895     * widget.
11896     *
11897     * The appended text is subject to any filters set for the widget.
11898     *
11899     * @param obj The entry object
11900     * @param entry The text to be displayed
11901     *
11902     * @see elm_entry_text_filter_append()
11903     */
11904    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11905
11906    /**
11907     * Gets whether the entry is empty.
11908     *
11909     * Empty means no text at all. If there are any markup tags, like an item
11910     * tag for which no provider finds anything, and no text is displayed, this
11911     * function still returns EINA_FALSE.
11912     *
11913     * @param obj The entry object
11914     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11915     */
11916    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11917
11918    /**
11919     * Gets any selected text within the entry.
11920     *
11921     * If there's any selected text in the entry, this function returns it as
11922     * a string in markup format. NULL is returned if no selection exists or
11923     * if an error occurred.
11924     *
11925     * The returned value points to an internal string and should not be freed
11926     * or modified in any way. If the @p entry object is deleted or its
11927     * contents are changed, the returned pointer should be considered invalid.
11928     *
11929     * @param obj The entry object
11930     * @return The selected text within the entry or NULL on failure
11931     */
11932    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11933
11934    /**
11935     * Returns the actual textblock object of the entry.
11936     *
11937     * This function exposes the internal textblock object that actually
11938     * contains and draws the text. This should be used for low-level
11939     * manipulations that are otherwise not possible.
11940     *
11941     * Changing the textblock directly from here will not notify edje/elm to
11942     * recalculate the textblock size automatically, so any modifications
11943     * done to the textblock returned by this function should be followed by
11944     * a call to elm_entry_calc_force().
11945     *
11946     * The return value is marked as const as an additional warning.
11947     * One should not use the returned object with any of the generic evas
11948     * functions (geometry_get/resize/move and etc), but only with the textblock
11949     * functions; The former will either not work at all, or break the correct
11950     * functionality.
11951     *
11952     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11953     * the internal textblock object. Do NOT cache the returned object, and try
11954     * not to mix calls on this object with regular elm_entry calls (which may
11955     * change the internal textblock object). This applies to all cursors
11956     * returned from textblock calls, and all the other derivative values.
11957     *
11958     * @param obj The entry object
11959     * @return The textblock object.
11960     */
11961    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11962
11963    /**
11964     * Forces calculation of the entry size and text layouting.
11965     *
11966     * This should be used after modifying the textblock object directly. See
11967     * elm_entry_textblock_get() for more information.
11968     *
11969     * @param obj The entry object
11970     *
11971     * @see elm_entry_textblock_get()
11972     */
11973    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11974
11975    /**
11976     * Inserts the given text into the entry at the current cursor position.
11977     *
11978     * This inserts text at the cursor position as if it was typed
11979     * by the user (note that this also allows markup which a user
11980     * can't just "type" as it would be converted to escaped text, so this
11981     * call can be used to insert things like emoticon items or bold push/pop
11982     * tags, other font and color change tags etc.)
11983     *
11984     * If any selection exists, it will be replaced by the inserted text.
11985     *
11986     * The inserted text is subject to any filters set for the widget.
11987     *
11988     * @param obj The entry object
11989     * @param entry The text to insert
11990     *
11991     * @see elm_entry_text_filter_append()
11992     */
11993    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11994
11995    /**
11996     * Set the line wrap type to use on multi-line entries.
11997     *
11998     * Sets the wrap type used by the entry to any of the specified in
11999     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
12000     * line (without inserting a line break or paragraph separator) when it
12001     * reaches the far edge of the widget.
12002     *
12003     * Note that this only makes sense for multi-line entries. A widget set
12004     * to be single line will never wrap.
12005     *
12006     * @param obj The entry object
12007     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
12008     */
12009    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
12010
12011    /**
12012     * Gets the wrap mode the entry was set to use.
12013     *
12014     * @param obj The entry object
12015     * @return Wrap type
12016     *
12017     * @see also elm_entry_line_wrap_set()
12018     */
12019    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12020
12021    /**
12022     * Sets if the entry is to be editable or not.
12023     *
12024     * By default, entries are editable and when focused, any text input by the
12025     * user will be inserted at the current cursor position. But calling this
12026     * function with @p editable as EINA_FALSE will prevent the user from
12027     * inputting text into the entry.
12028     *
12029     * The only way to change the text of a non-editable entry is to use
12030     * elm_object_text_set(), elm_entry_entry_insert() and other related
12031     * functions.
12032     *
12033     * @param obj The entry object
12034     * @param editable If EINA_TRUE, user input will be inserted in the entry,
12035     * if not, the entry is read-only and no user input is allowed.
12036     */
12037    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
12038
12039    /**
12040     * Gets whether the entry is editable or not.
12041     *
12042     * @param obj The entry object
12043     * @return If true, the entry is editable by the user.
12044     * If false, it is not editable by the user
12045     *
12046     * @see elm_entry_editable_set()
12047     */
12048    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12049
12050    /**
12051     * This drops any existing text selection within the entry.
12052     *
12053     * @param obj The entry object
12054     */
12055    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
12056
12057    /**
12058     * This selects all text within the entry.
12059     *
12060     * @param obj The entry object
12061     */
12062    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
12063
12064    /**
12065     * This moves the cursor one place to the right within the entry.
12066     *
12067     * @param obj The entry object
12068     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12069     */
12070    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12071
12072    /**
12073     * This moves the cursor one place to the left within the entry.
12074     *
12075     * @param obj The entry object
12076     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12077     */
12078    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12079
12080    /**
12081     * This moves the cursor one line up within the entry.
12082     *
12083     * @param obj The entry object
12084     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12085     */
12086    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
12087
12088    /**
12089     * This moves the cursor one line down within the entry.
12090     *
12091     * @param obj The entry object
12092     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12093     */
12094    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
12095
12096    /**
12097     * This moves the cursor to the beginning of the entry.
12098     *
12099     * @param obj The entry object
12100     */
12101    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12102
12103    /**
12104     * This moves the cursor to the end of the entry.
12105     *
12106     * @param obj The entry object
12107     */
12108    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12109
12110    /**
12111     * This moves the cursor to the beginning of the current line.
12112     *
12113     * @param obj The entry object
12114     */
12115    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12116
12117    /**
12118     * This moves the cursor to the end of the current line.
12119     *
12120     * @param obj The entry object
12121     */
12122    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12123
12124    /**
12125     * This begins a selection within the entry as though
12126     * the user were holding down the mouse button to make a selection.
12127     *
12128     * @param obj The entry object
12129     */
12130    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12131
12132    /**
12133     * This ends a selection within the entry as though
12134     * the user had just released the mouse button while making a selection.
12135     *
12136     * @param obj The entry object
12137     */
12138    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12139
12140    /**
12141     * Gets whether a format node exists at the current cursor position.
12142     *
12143     * A format node is anything that defines how the text is rendered. It can
12144     * be a visible format node, such as a line break or a paragraph separator,
12145     * or an invisible one, such as bold begin or end tag.
12146     * This function returns whether any format node exists at the current
12147     * cursor position.
12148     *
12149     * @param obj The entry object
12150     * @return EINA_TRUE if the current cursor position contains a format node,
12151     * EINA_FALSE otherwise.
12152     *
12153     * @see elm_entry_cursor_is_visible_format_get()
12154     */
12155    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12156
12157    /**
12158     * Gets if the current cursor position holds a visible format node.
12159     *
12160     * @param obj The entry object
12161     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
12162     * if it's an invisible one or no format exists.
12163     *
12164     * @see elm_entry_cursor_is_format_get()
12165     */
12166    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12167
12168    /**
12169     * Gets the character pointed by the cursor at its current position.
12170     *
12171     * This function returns a string with the utf8 character stored at the
12172     * current cursor position.
12173     * Only the text is returned, any format that may exist will not be part
12174     * of the return value.
12175     *
12176     * @param obj The entry object
12177     * @return The text pointed by the cursors.
12178     */
12179    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12180
12181    /**
12182     * This function returns the geometry of the cursor.
12183     *
12184     * It's useful if you want to draw something on the cursor (or where it is),
12185     * or for example in the case of scrolled entry where you want to show the
12186     * cursor.
12187     *
12188     * @param obj The entry object
12189     * @param x returned geometry
12190     * @param y returned geometry
12191     * @param w returned geometry
12192     * @param h returned geometry
12193     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12194     */
12195    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);
12196
12197    /**
12198     * Sets the cursor position in the entry to the given value
12199     *
12200     * The value in @p pos is the index of the character position within the
12201     * contents of the string as returned by elm_entry_cursor_pos_get().
12202     *
12203     * @param obj The entry object
12204     * @param pos The position of the cursor
12205     */
12206    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
12207
12208    /**
12209     * Retrieves the current position of the cursor in the entry
12210     *
12211     * @param obj The entry object
12212     * @return The cursor position
12213     */
12214    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12215
12216    /**
12217     * This executes a "cut" action on the selected text in the entry.
12218     *
12219     * @param obj The entry object
12220     */
12221    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
12222
12223    /**
12224     * This executes a "copy" action on the selected text in the entry.
12225     *
12226     * @param obj The entry object
12227     */
12228    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
12229
12230    /**
12231     * This executes a "paste" action in the entry.
12232     *
12233     * @param obj The entry object
12234     */
12235    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
12236
12237    /**
12238     * This clears and frees the items in a entry's contextual (longpress)
12239     * menu.
12240     *
12241     * @param obj The entry object
12242     *
12243     * @see elm_entry_context_menu_item_add()
12244     */
12245    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12246
12247    /**
12248     * This adds an item to the entry's contextual menu.
12249     *
12250     * A longpress on an entry will make the contextual menu show up, if this
12251     * hasn't been disabled with elm_entry_context_menu_disabled_set().
12252     * By default, this menu provides a few options like enabling selection mode,
12253     * which is useful on embedded devices that need to be explicit about it,
12254     * and when a selection exists it also shows the copy and cut actions.
12255     *
12256     * With this function, developers can add other options to this menu to
12257     * perform any action they deem necessary.
12258     *
12259     * @param obj The entry object
12260     * @param label The item's text label
12261     * @param icon_file The item's icon file
12262     * @param icon_type The item's icon type
12263     * @param func The callback to execute when the item is clicked
12264     * @param data The data to associate with the item for related functions
12265     */
12266    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);
12267
12268    /**
12269     * This disables the entry's contextual (longpress) menu.
12270     *
12271     * @param obj The entry object
12272     * @param disabled If true, the menu is disabled
12273     */
12274    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12275
12276    /**
12277     * This returns whether the entry's contextual (longpress) menu is
12278     * disabled.
12279     *
12280     * @param obj The entry object
12281     * @return If true, the menu is disabled
12282     */
12283    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12284
12285    /**
12286     * This appends a custom item provider to the list for that entry
12287     *
12288     * This appends the given callback. The list is walked from beginning to end
12289     * with each function called given the item href string in the text. If the
12290     * function returns an object handle other than NULL (it should create an
12291     * object to do this), then this object is used to replace that item. If
12292     * not the next provider is called until one provides an item object, or the
12293     * default provider in entry does.
12294     *
12295     * @param obj The entry object
12296     * @param func The function called to provide the item object
12297     * @param data The data passed to @p func
12298     *
12299     * @see @ref entry-items
12300     */
12301    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);
12302
12303    /**
12304     * This prepends a custom item provider to the list for that entry
12305     *
12306     * This prepends the given callback. See elm_entry_item_provider_append() for
12307     * more information
12308     *
12309     * @param obj The entry object
12310     * @param func The function called to provide the item object
12311     * @param data The data passed to @p func
12312     */
12313    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);
12314
12315    /**
12316     * This removes a custom item provider to the list for that entry
12317     *
12318     * This removes the given callback. See elm_entry_item_provider_append() for
12319     * more information
12320     *
12321     * @param obj The entry object
12322     * @param func The function called to provide the item object
12323     * @param data The data passed to @p func
12324     */
12325    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);
12326
12327    /**
12328     * Append a filter function for text inserted in the entry
12329     *
12330     * Append the given callback to the list. This functions will be called
12331     * whenever any text is inserted into the entry, with the text to be inserted
12332     * as a parameter. The callback function is free to alter the text in any way
12333     * it wants, but it must remember to free the given pointer and update it.
12334     * If the new text is to be discarded, the function can free it and set its
12335     * text parameter to NULL. This will also prevent any following filters from
12336     * being called.
12337     *
12338     * @param obj The entry object
12339     * @param func The function to use as text filter
12340     * @param data User data to pass to @p func
12341     */
12342    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12343
12344    /**
12345     * Prepend a filter function for text insdrted in the entry
12346     *
12347     * Prepend the given callback to the list. See elm_entry_text_filter_append()
12348     * for more information
12349     *
12350     * @param obj The entry object
12351     * @param func The function to use as text filter
12352     * @param data User data to pass to @p func
12353     */
12354    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12355
12356    /**
12357     * Remove a filter from the list
12358     *
12359     * Removes the given callback from the filter list. See
12360     * elm_entry_text_filter_append() for more information.
12361     *
12362     * @param obj The entry object
12363     * @param func The filter function to remove
12364     * @param data The user data passed when adding the function
12365     */
12366    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12367
12368    /**
12369     * This converts a markup (HTML-like) string into UTF-8.
12370     *
12371     * The returned string is a malloc'ed buffer and it should be freed when
12372     * not needed anymore.
12373     *
12374     * @param s The string (in markup) to be converted
12375     * @return The converted string (in UTF-8). It should be freed.
12376     */
12377    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12378
12379    /**
12380     * This converts a UTF-8 string into markup (HTML-like).
12381     *
12382     * The returned string is a malloc'ed buffer and it should be freed when
12383     * not needed anymore.
12384     *
12385     * @param s The string (in UTF-8) to be converted
12386     * @return The converted string (in markup). It should be freed.
12387     */
12388    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12389
12390    /**
12391     * This sets the file (and implicitly loads it) for the text to display and
12392     * then edit. All changes are written back to the file after a short delay if
12393     * the entry object is set to autosave (which is the default).
12394     *
12395     * If the entry had any other file set previously, any changes made to it
12396     * will be saved if the autosave feature is enabled, otherwise, the file
12397     * will be silently discarded and any non-saved changes will be lost.
12398     *
12399     * @param obj The entry object
12400     * @param file The path to the file to load and save
12401     * @param format The file format
12402     */
12403    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12404
12405    /**
12406     * Gets the file being edited by the entry.
12407     *
12408     * This function can be used to retrieve any file set on the entry for
12409     * edition, along with the format used to load and save it.
12410     *
12411     * @param obj The entry object
12412     * @param file The path to the file to load and save
12413     * @param format The file format
12414     */
12415    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12416
12417    /**
12418     * This function writes any changes made to the file set with
12419     * elm_entry_file_set()
12420     *
12421     * @param obj The entry object
12422     */
12423    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12424
12425    /**
12426     * This sets the entry object to 'autosave' the loaded text file or not.
12427     *
12428     * @param obj The entry object
12429     * @param autosave Autosave the loaded file or not
12430     *
12431     * @see elm_entry_file_set()
12432     */
12433    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12434
12435    /**
12436     * This gets the entry object's 'autosave' status.
12437     *
12438     * @param obj The entry object
12439     * @return Autosave the loaded file or not
12440     *
12441     * @see elm_entry_file_set()
12442     */
12443    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12444
12445    /**
12446     * Control pasting of text and images for the widget.
12447     *
12448     * Normally the entry allows both text and images to be pasted.  By setting
12449     * textonly to be true, this prevents images from being pasted.
12450     *
12451     * Note this only changes the behaviour of text.
12452     *
12453     * @param obj The entry object
12454     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
12455     * text+image+other.
12456     */
12457    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12458
12459    /**
12460     * Getting elm_entry text paste/drop mode.
12461     *
12462     * In textonly mode, only text may be pasted or dropped into the widget.
12463     *
12464     * @param obj The entry object
12465     * @return If the widget only accepts text from pastes.
12466     */
12467    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12468
12469    /**
12470     * Enable or disable scrolling in entry
12471     *
12472     * Normally the entry is not scrollable unless you enable it with this call.
12473     *
12474     * @param obj The entry object
12475     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
12476     */
12477    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
12478
12479    /**
12480     * Get the scrollable state of the entry
12481     *
12482     * Normally the entry is not scrollable. This gets the scrollable state
12483     * of the entry. See elm_entry_scrollable_set() for more information.
12484     *
12485     * @param obj The entry object
12486     * @return The scrollable state
12487     */
12488    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
12489
12490    /**
12491     * This sets a widget to be displayed to the left of a scrolled entry.
12492     *
12493     * @param obj The scrolled entry object
12494     * @param icon The widget to display on the left side of the scrolled
12495     * entry.
12496     *
12497     * @note A previously set widget will be destroyed.
12498     * @note If the object being set does not have minimum size hints set,
12499     * it won't get properly displayed.
12500     *
12501     * @see elm_entry_end_set()
12502     */
12503    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
12504
12505    /**
12506     * Gets the leftmost widget of the scrolled entry. This object is
12507     * owned by the scrolled entry and should not be modified.
12508     *
12509     * @param obj The scrolled entry object
12510     * @return the left widget inside the scroller
12511     */
12512    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
12513
12514    /**
12515     * Unset the leftmost widget of the scrolled entry, unparenting and
12516     * returning it.
12517     *
12518     * @param obj The scrolled entry object
12519     * @return the previously set icon sub-object of this entry, on
12520     * success.
12521     *
12522     * @see elm_entry_icon_set()
12523     */
12524    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
12525
12526    /**
12527     * Sets the visibility of the left-side widget of the scrolled entry,
12528     * set by elm_entry_icon_set().
12529     *
12530     * @param obj The scrolled entry object
12531     * @param setting EINA_TRUE if the object should be displayed,
12532     * EINA_FALSE if not.
12533     */
12534    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
12535
12536    /**
12537     * This sets a widget to be displayed to the end of a scrolled entry.
12538     *
12539     * @param obj The scrolled entry object
12540     * @param end The widget to display on the right side of the scrolled
12541     * entry.
12542     *
12543     * @note A previously set widget will be destroyed.
12544     * @note If the object being set does not have minimum size hints set,
12545     * it won't get properly displayed.
12546     *
12547     * @see elm_entry_icon_set
12548     */
12549    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
12550
12551    /**
12552     * Gets the endmost widget of the scrolled entry. This object is owned
12553     * by the scrolled entry and should not be modified.
12554     *
12555     * @param obj The scrolled entry object
12556     * @return the right widget inside the scroller
12557     */
12558    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
12559
12560    /**
12561     * Unset the endmost widget of the scrolled entry, unparenting and
12562     * returning it.
12563     *
12564     * @param obj The scrolled entry object
12565     * @return the previously set icon sub-object of this entry, on
12566     * success.
12567     *
12568     * @see elm_entry_icon_set()
12569     */
12570    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
12571
12572    /**
12573     * Sets the visibility of the end widget of the scrolled entry, set by
12574     * elm_entry_end_set().
12575     *
12576     * @param obj The scrolled entry object
12577     * @param setting EINA_TRUE if the object should be displayed,
12578     * EINA_FALSE if not.
12579     */
12580    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
12581
12582    /**
12583     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
12584     * them).
12585     *
12586     * Setting an entry to single-line mode with elm_entry_single_line_set()
12587     * will automatically disable the display of scrollbars when the entry
12588     * moves inside its scroller.
12589     *
12590     * @param obj The scrolled entry object
12591     * @param h The horizontal scrollbar policy to apply
12592     * @param v The vertical scrollbar policy to apply
12593     */
12594    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
12595
12596    /**
12597     * This enables/disables bouncing within the entry.
12598     *
12599     * This function sets whether the entry will bounce when scrolling reaches
12600     * the end of the contained entry.
12601     *
12602     * @param obj The scrolled entry object
12603     * @param h The horizontal bounce state
12604     * @param v The vertical bounce state
12605     */
12606    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12607
12608    /**
12609     * Get the bounce mode
12610     *
12611     * @param obj The Entry object
12612     * @param h_bounce Allow bounce horizontally
12613     * @param v_bounce Allow bounce vertically
12614     */
12615    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12616
12617    /* pre-made filters for entries */
12618    /**
12619     * @typedef Elm_Entry_Filter_Limit_Size
12620     *
12621     * Data for the elm_entry_filter_limit_size() entry filter.
12622     */
12623    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12624
12625    /**
12626     * @struct _Elm_Entry_Filter_Limit_Size
12627     *
12628     * Data for the elm_entry_filter_limit_size() entry filter.
12629     */
12630    struct _Elm_Entry_Filter_Limit_Size
12631      {
12632         int max_char_count; /**< The maximum number of characters allowed. */
12633         int max_byte_count; /**< The maximum number of bytes allowed*/
12634      };
12635
12636    /**
12637     * Filter inserted text based on user defined character and byte limits
12638     *
12639     * Add this filter to an entry to limit the characters that it will accept
12640     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12641     * The funtion works on the UTF-8 representation of the string, converting
12642     * it from the set markup, thus not accounting for any format in it.
12643     *
12644     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12645     * it as data when setting the filter. In it, it's possible to set limits
12646     * by character count or bytes (any of them is disabled if 0), and both can
12647     * be set at the same time. In that case, it first checks for characters,
12648     * then bytes.
12649     *
12650     * The function will cut the inserted text in order to allow only the first
12651     * number of characters that are still allowed. The cut is made in
12652     * characters, even when limiting by bytes, in order to always contain
12653     * valid ones and avoid half unicode characters making it in.
12654     *
12655     * This filter, like any others, does not apply when setting the entry text
12656     * directly with elm_object_text_set() (or the deprecated
12657     * elm_entry_entry_set()).
12658     */
12659    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12660
12661    /**
12662     * @typedef Elm_Entry_Filter_Accept_Set
12663     *
12664     * Data for the elm_entry_filter_accept_set() entry filter.
12665     */
12666    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12667
12668    /**
12669     * @struct _Elm_Entry_Filter_Accept_Set
12670     *
12671     * Data for the elm_entry_filter_accept_set() entry filter.
12672     */
12673    struct _Elm_Entry_Filter_Accept_Set
12674      {
12675         const char *accepted; /**< Set of characters accepted in the entry. */
12676         const char *rejected; /**< Set of characters rejected from the entry. */
12677      };
12678
12679    /**
12680     * Filter inserted text based on accepted or rejected sets of characters
12681     *
12682     * Add this filter to an entry to restrict the set of accepted characters
12683     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12684     * This structure contains both accepted and rejected sets, but they are
12685     * mutually exclusive.
12686     *
12687     * The @c accepted set takes preference, so if it is set, the filter will
12688     * only work based on the accepted characters, ignoring anything in the
12689     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12690     *
12691     * In both cases, the function filters by matching utf8 characters to the
12692     * raw markup text, so it can be used to remove formatting tags.
12693     *
12694     * This filter, like any others, does not apply when setting the entry text
12695     * directly with elm_object_text_set() (or the deprecated
12696     * elm_entry_entry_set()).
12697     */
12698    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12699    /**
12700     * Set the input panel layout of the entry
12701     *
12702     * @param obj The entry object
12703     * @param layout layout type
12704     */
12705    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12706
12707    /**
12708     * Get the input panel layout of the entry
12709     *
12710     * @param obj The entry object
12711     * @return layout type
12712     *
12713     * @see elm_entry_input_panel_layout_set
12714     */
12715    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12716
12717    /**
12718     * Set the autocapitalization type on the immodule.
12719     *
12720     * @param obj The entry object
12721     * @param autocapital_type The type of autocapitalization
12722     */
12723    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12724
12725    /**
12726     * Retrieve the autocapitalization type on the immodule.
12727     *
12728     * @param obj The entry object
12729     * @return autocapitalization type
12730     */
12731    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12732
12733    /**
12734     * Sets the attribute to show the input panel automatically.
12735     *
12736     * @param obj The entry object
12737     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12738     */
12739    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12740
12741    /**
12742     * Retrieve the attribute to show the input panel automatically.
12743     *
12744     * @param obj The entry object
12745     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12746     */
12747    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12748
12749    /**
12750     * @}
12751     */
12752
12753    /* composite widgets - these basically put together basic widgets above
12754     * in convenient packages that do more than basic stuff */
12755
12756    /* anchorview */
12757    /**
12758     * @defgroup Anchorview Anchorview
12759     *
12760     * @image html img/widget/anchorview/preview-00.png
12761     * @image latex img/widget/anchorview/preview-00.eps
12762     *
12763     * Anchorview is for displaying text that contains markup with anchors
12764     * like <c>\<a href=1234\>something\</\></c> in it.
12765     *
12766     * Besides being styled differently, the anchorview widget provides the
12767     * necessary functionality so that clicking on these anchors brings up a
12768     * popup with user defined content such as "call", "add to contacts" or
12769     * "open web page". This popup is provided using the @ref Hover widget.
12770     *
12771     * This widget is very similar to @ref Anchorblock, so refer to that
12772     * widget for an example. The only difference Anchorview has is that the
12773     * widget is already provided with scrolling functionality, so if the
12774     * text set to it is too large to fit in the given space, it will scroll,
12775     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12776     * text can be displayed.
12777     *
12778     * This widget emits the following signals:
12779     * @li "anchor,clicked": will be called when an anchor is clicked. The
12780     * @p event_info parameter on the callback will be a pointer of type
12781     * ::Elm_Entry_Anchorview_Info.
12782     *
12783     * See @ref Anchorblock for an example on how to use both of them.
12784     *
12785     * @see Anchorblock
12786     * @see Entry
12787     * @see Hover
12788     *
12789     * @{
12790     */
12791
12792    /**
12793     * @typedef Elm_Entry_Anchorview_Info
12794     *
12795     * The info sent in the callback for "anchor,clicked" signals emitted by
12796     * the Anchorview widget.
12797     */
12798    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12799
12800    /**
12801     * @struct _Elm_Entry_Anchorview_Info
12802     *
12803     * The info sent in the callback for "anchor,clicked" signals emitted by
12804     * the Anchorview widget.
12805     */
12806    struct _Elm_Entry_Anchorview_Info
12807      {
12808         const char     *name; /**< Name of the anchor, as indicated in its href
12809                                    attribute */
12810         int             button; /**< The mouse button used to click on it */
12811         Evas_Object    *hover; /**< The hover object to use for the popup */
12812         struct {
12813              Evas_Coord    x, y, w, h;
12814         } anchor, /**< Geometry selection of text used as anchor */
12815           hover_parent; /**< Geometry of the object used as parent by the
12816                              hover */
12817         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12818                                              for content on the left side of
12819                                              the hover. Before calling the
12820                                              callback, the widget will make the
12821                                              necessary calculations to check
12822                                              which sides are fit to be set with
12823                                              content, based on the position the
12824                                              hover is activated and its distance
12825                                              to the edges of its parent object
12826                                              */
12827         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12828                                               the right side of the hover.
12829                                               See @ref hover_left */
12830         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12831                                             of the hover. See @ref hover_left */
12832         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12833                                                below the hover. See @ref
12834                                                hover_left */
12835      };
12836
12837    /**
12838     * Add a new Anchorview object
12839     *
12840     * @param parent The parent object
12841     * @return The new object or NULL if it cannot be created
12842     */
12843    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12844
12845    /**
12846     * Set the text to show in the anchorview
12847     *
12848     * Sets the text of the anchorview to @p text. This text can include markup
12849     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12850     * text that will be specially styled and react to click events, ended with
12851     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12852     * "anchor,clicked" signal that you can attach a callback to with
12853     * evas_object_smart_callback_add(). The name of the anchor given in the
12854     * event info struct will be the one set in the href attribute, in this
12855     * case, anchorname.
12856     *
12857     * Other markup can be used to style the text in different ways, but it's
12858     * up to the style defined in the theme which tags do what.
12859     * @deprecated use elm_object_text_set() instead.
12860     */
12861    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12862
12863    /**
12864     * Get the markup text set for the anchorview
12865     *
12866     * Retrieves the text set on the anchorview, with markup tags included.
12867     *
12868     * @param obj The anchorview object
12869     * @return The markup text set or @c NULL if nothing was set or an error
12870     * occurred
12871     * @deprecated use elm_object_text_set() instead.
12872     */
12873    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12874
12875    /**
12876     * Set the parent of the hover popup
12877     *
12878     * Sets the parent object to use by the hover created by the anchorview
12879     * when an anchor is clicked. See @ref Hover for more details on this.
12880     * If no parent is set, the same anchorview object will be used.
12881     *
12882     * @param obj The anchorview object
12883     * @param parent The object to use as parent for the hover
12884     */
12885    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12886
12887    /**
12888     * Get the parent of the hover popup
12889     *
12890     * Get the object used as parent for the hover created by the anchorview
12891     * widget. See @ref Hover for more details on this.
12892     *
12893     * @param obj The anchorview object
12894     * @return The object used as parent for the hover, NULL if none is set.
12895     */
12896    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12897
12898    /**
12899     * Set the style that the hover should use
12900     *
12901     * When creating the popup hover, anchorview will request that it's
12902     * themed according to @p style.
12903     *
12904     * @param obj The anchorview object
12905     * @param style The style to use for the underlying hover
12906     *
12907     * @see elm_object_style_set()
12908     */
12909    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12910
12911    /**
12912     * Get the style that the hover should use
12913     *
12914     * Get the style the hover created by anchorview will use.
12915     *
12916     * @param obj The anchorview object
12917     * @return The style to use by the hover. NULL means the default is used.
12918     *
12919     * @see elm_object_style_set()
12920     */
12921    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12922
12923    /**
12924     * Ends the hover popup in the anchorview
12925     *
12926     * When an anchor is clicked, the anchorview widget will create a hover
12927     * object to use as a popup with user provided content. This function
12928     * terminates this popup, returning the anchorview to its normal state.
12929     *
12930     * @param obj The anchorview object
12931     */
12932    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12933
12934    /**
12935     * Set bouncing behaviour when the scrolled content reaches an edge
12936     *
12937     * Tell the internal scroller object whether it should bounce or not
12938     * when it reaches the respective edges for each axis.
12939     *
12940     * @param obj The anchorview object
12941     * @param h_bounce Whether to bounce or not in the horizontal axis
12942     * @param v_bounce Whether to bounce or not in the vertical axis
12943     *
12944     * @see elm_scroller_bounce_set()
12945     */
12946    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12947
12948    /**
12949     * Get the set bouncing behaviour of the internal scroller
12950     *
12951     * Get whether the internal scroller should bounce when the edge of each
12952     * axis is reached scrolling.
12953     *
12954     * @param obj The anchorview object
12955     * @param h_bounce Pointer where to store the bounce state of the horizontal
12956     *                 axis
12957     * @param v_bounce Pointer where to store the bounce state of the vertical
12958     *                 axis
12959     *
12960     * @see elm_scroller_bounce_get()
12961     */
12962    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12963
12964    /**
12965     * Appends a custom item provider to the given anchorview
12966     *
12967     * Appends the given function to the list of items providers. This list is
12968     * called, one function at a time, with the given @p data pointer, the
12969     * anchorview object and, in the @p item parameter, the item name as
12970     * referenced in its href string. Following functions in the list will be
12971     * called in order until one of them returns something different to NULL,
12972     * which should be an Evas_Object which will be used in place of the item
12973     * element.
12974     *
12975     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12976     * href=item/name\>\</item\>
12977     *
12978     * @param obj The anchorview object
12979     * @param func The function to add to the list of providers
12980     * @param data User data that will be passed to the callback function
12981     *
12982     * @see elm_entry_item_provider_append()
12983     */
12984    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);
12985
12986    /**
12987     * Prepend a custom item provider to the given anchorview
12988     *
12989     * Like elm_anchorview_item_provider_append(), but it adds the function
12990     * @p func to the beginning of the list, instead of the end.
12991     *
12992     * @param obj The anchorview object
12993     * @param func The function to add to the list of providers
12994     * @param data User data that will be passed to the callback function
12995     */
12996    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);
12997
12998    /**
12999     * Remove a custom item provider from the list of the given anchorview
13000     *
13001     * Removes the function and data pairing that matches @p func and @p data.
13002     * That is, unless the same function and same user data are given, the
13003     * function will not be removed from the list. This allows us to add the
13004     * same callback several times, with different @p data pointers and be
13005     * able to remove them later without conflicts.
13006     *
13007     * @param obj The anchorview object
13008     * @param func The function to remove from the list
13009     * @param data The data matching the function to remove from the list
13010     */
13011    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);
13012
13013    /**
13014     * @}
13015     */
13016
13017    /* anchorblock */
13018    /**
13019     * @defgroup Anchorblock Anchorblock
13020     *
13021     * @image html img/widget/anchorblock/preview-00.png
13022     * @image latex img/widget/anchorblock/preview-00.eps
13023     *
13024     * Anchorblock is for displaying text that contains markup with anchors
13025     * like <c>\<a href=1234\>something\</\></c> in it.
13026     *
13027     * Besides being styled differently, the anchorblock widget provides the
13028     * necessary functionality so that clicking on these anchors brings up a
13029     * popup with user defined content such as "call", "add to contacts" or
13030     * "open web page". This popup is provided using the @ref Hover widget.
13031     *
13032     * This widget emits the following signals:
13033     * @li "anchor,clicked": will be called when an anchor is clicked. The
13034     * @p event_info parameter on the callback will be a pointer of type
13035     * ::Elm_Entry_Anchorblock_Info.
13036     *
13037     * @see Anchorview
13038     * @see Entry
13039     * @see Hover
13040     *
13041     * Since examples are usually better than plain words, we might as well
13042     * try @ref tutorial_anchorblock_example "one".
13043     */
13044
13045    /**
13046     * @addtogroup Anchorblock
13047     * @{
13048     */
13049
13050    /**
13051     * @typedef Elm_Entry_Anchorblock_Info
13052     *
13053     * The info sent in the callback for "anchor,clicked" signals emitted by
13054     * the Anchorblock widget.
13055     */
13056    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
13057
13058    /**
13059     * @struct _Elm_Entry_Anchorblock_Info
13060     *
13061     * The info sent in the callback for "anchor,clicked" signals emitted by
13062     * the Anchorblock widget.
13063     */
13064    struct _Elm_Entry_Anchorblock_Info
13065      {
13066         const char     *name; /**< Name of the anchor, as indicated in its href
13067                                    attribute */
13068         int             button; /**< The mouse button used to click on it */
13069         Evas_Object    *hover; /**< The hover object to use for the popup */
13070         struct {
13071              Evas_Coord    x, y, w, h;
13072         } anchor, /**< Geometry selection of text used as anchor */
13073           hover_parent; /**< Geometry of the object used as parent by the
13074                              hover */
13075         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
13076                                              for content on the left side of
13077                                              the hover. Before calling the
13078                                              callback, the widget will make the
13079                                              necessary calculations to check
13080                                              which sides are fit to be set with
13081                                              content, based on the position the
13082                                              hover is activated and its distance
13083                                              to the edges of its parent object
13084                                              */
13085         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
13086                                               the right side of the hover.
13087                                               See @ref hover_left */
13088         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
13089                                             of the hover. See @ref hover_left */
13090         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
13091                                                below the hover. See @ref
13092                                                hover_left */
13093      };
13094
13095 /**
13096     * Add a new Anchorblock object
13097     *
13098     * @param parent The parent object
13099     * @return The new object or NULL if it cannot be created
13100     */
13101    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13102
13103    /**
13104     * Set the text to show in the anchorblock
13105     *
13106     * Sets the text of the anchorblock to @p text. This text can include markup
13107     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
13108     * of text that will be specially styled and react to click events, ended
13109     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
13110     * "anchor,clicked" signal that you can attach a callback to with
13111     * evas_object_smart_callback_add(). The name of the anchor given in the
13112     * event info struct will be the one set in the href attribute, in this
13113     * case, anchorname.
13114     *
13115     * Other markup can be used to style the text in different ways, but it's
13116     * up to the style defined in the theme which tags do what.
13117     * @deprecated use elm_object_text_set() instead.
13118     */
13119    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
13120
13121    /**
13122     * Get the markup text set for the anchorblock
13123     *
13124     * Retrieves the text set on the anchorblock, with markup tags included.
13125     *
13126     * @param obj The anchorblock object
13127     * @return The markup text set or @c NULL if nothing was set or an error
13128     * occurred
13129     * @deprecated use elm_object_text_set() instead.
13130     */
13131    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13132
13133    /**
13134     * Set the parent of the hover popup
13135     *
13136     * Sets the parent object to use by the hover created by the anchorblock
13137     * when an anchor is clicked. See @ref Hover for more details on this.
13138     *
13139     * @param obj The anchorblock object
13140     * @param parent The object to use as parent for the hover
13141     */
13142    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13143
13144    /**
13145     * Get the parent of the hover popup
13146     *
13147     * Get the object used as parent for the hover created by the anchorblock
13148     * widget. See @ref Hover for more details on this.
13149     * If no parent is set, the same anchorblock object will be used.
13150     *
13151     * @param obj The anchorblock object
13152     * @return The object used as parent for the hover, NULL if none is set.
13153     */
13154    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13155
13156    /**
13157     * Set the style that the hover should use
13158     *
13159     * When creating the popup hover, anchorblock will request that it's
13160     * themed according to @p style.
13161     *
13162     * @param obj The anchorblock object
13163     * @param style The style to use for the underlying hover
13164     *
13165     * @see elm_object_style_set()
13166     */
13167    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13168
13169    /**
13170     * Get the style that the hover should use
13171     *
13172     * Get the style, the hover created by anchorblock will use.
13173     *
13174     * @param obj The anchorblock object
13175     * @return The style to use by the hover. NULL means the default is used.
13176     *
13177     * @see elm_object_style_set()
13178     */
13179    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13180
13181    /**
13182     * Ends the hover popup in the anchorblock
13183     *
13184     * When an anchor is clicked, the anchorblock widget will create a hover
13185     * object to use as a popup with user provided content. This function
13186     * terminates this popup, returning the anchorblock to its normal state.
13187     *
13188     * @param obj The anchorblock object
13189     */
13190    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13191
13192    /**
13193     * Appends a custom item provider to the given anchorblock
13194     *
13195     * Appends the given function to the list of items providers. This list is
13196     * called, one function at a time, with the given @p data pointer, the
13197     * anchorblock object and, in the @p item parameter, the item name as
13198     * referenced in its href string. Following functions in the list will be
13199     * called in order until one of them returns something different to NULL,
13200     * which should be an Evas_Object which will be used in place of the item
13201     * element.
13202     *
13203     * Items in the markup text take the form \<item relsize=16x16 vsize=full
13204     * href=item/name\>\</item\>
13205     *
13206     * @param obj The anchorblock object
13207     * @param func The function to add to the list of providers
13208     * @param data User data that will be passed to the callback function
13209     *
13210     * @see elm_entry_item_provider_append()
13211     */
13212    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);
13213
13214    /**
13215     * Prepend a custom item provider to the given anchorblock
13216     *
13217     * Like elm_anchorblock_item_provider_append(), but it adds the function
13218     * @p func to the beginning of the list, instead of the end.
13219     *
13220     * @param obj The anchorblock object
13221     * @param func The function to add to the list of providers
13222     * @param data User data that will be passed to the callback function
13223     */
13224    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);
13225
13226    /**
13227     * Remove a custom item provider from the list of the given anchorblock
13228     *
13229     * Removes the function and data pairing that matches @p func and @p data.
13230     * That is, unless the same function and same user data are given, the
13231     * function will not be removed from the list. This allows us to add the
13232     * same callback several times, with different @p data pointers and be
13233     * able to remove them later without conflicts.
13234     *
13235     * @param obj The anchorblock object
13236     * @param func The function to remove from the list
13237     * @param data The data matching the function to remove from the list
13238     */
13239    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);
13240
13241    /**
13242     * @}
13243     */
13244
13245    /**
13246     * @defgroup Bubble Bubble
13247     *
13248     * @image html img/widget/bubble/preview-00.png
13249     * @image latex img/widget/bubble/preview-00.eps
13250     * @image html img/widget/bubble/preview-01.png
13251     * @image latex img/widget/bubble/preview-01.eps
13252     * @image html img/widget/bubble/preview-02.png
13253     * @image latex img/widget/bubble/preview-02.eps
13254     *
13255     * @brief The Bubble is a widget to show text similar to how speech is
13256     * represented in comics.
13257     *
13258     * The bubble widget contains 5 important visual elements:
13259     * @li The frame is a rectangle with rounded edjes and an "arrow".
13260     * @li The @p icon is an image to which the frame's arrow points to.
13261     * @li The @p label is a text which appears to the right of the icon if the
13262     * corner is "top_left" or "bottom_left" and is right aligned to the frame
13263     * otherwise.
13264     * @li The @p info is a text which appears to the right of the label. Info's
13265     * font is of a ligther color than label.
13266     * @li The @p content is an evas object that is shown inside the frame.
13267     *
13268     * The position of the arrow, icon, label and info depends on which corner is
13269     * selected. The four available corners are:
13270     * @li "top_left" - Default
13271     * @li "top_right"
13272     * @li "bottom_left"
13273     * @li "bottom_right"
13274     *
13275     * Signals that you can add callbacks for are:
13276     * @li "clicked" - This is called when a user has clicked the bubble.
13277     *
13278     * Default contents parts of the bubble that you can use for are:
13279     * @li "default" - A content of the bubble
13280     * @li "icon" - An icon of the bubble
13281     *
13282     * Default text parts of the button widget that you can use for are:
13283     * @li NULL - Label of the bubble
13284     *
13285          * For an example of using a buble see @ref bubble_01_example_page "this".
13286     *
13287     * @{
13288     */
13289
13290    /**
13291     * Add a new bubble to the parent
13292     *
13293     * @param parent The parent object
13294     * @return The new object or NULL if it cannot be created
13295     *
13296     * This function adds a text bubble to the given parent evas object.
13297     */
13298    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13299
13300    /**
13301     * Set the label of the bubble
13302     *
13303     * @param obj The bubble object
13304     * @param label The string to set in the label
13305     *
13306     * This function sets the title of the bubble. Where this appears depends on
13307     * the selected corner.
13308     * @deprecated use elm_object_text_set() instead.
13309     */
13310    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13311
13312    /**
13313     * Get the label of the bubble
13314     *
13315     * @param obj The bubble object
13316     * @return The string of set in the label
13317     *
13318     * This function gets the title of the bubble.
13319     * @deprecated use elm_object_text_get() instead.
13320     */
13321    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13322
13323    /**
13324     * Set the info of the bubble
13325     *
13326     * @param obj The bubble object
13327     * @param info The given info about the bubble
13328     *
13329     * This function sets the info of the bubble. Where this appears depends on
13330     * the selected corner.
13331     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
13332     */
13333    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
13334
13335    /**
13336     * Get the info of the bubble
13337     *
13338     * @param obj The bubble object
13339     *
13340     * @return The "info" string of the bubble
13341     *
13342     * This function gets the info text.
13343     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
13344     */
13345    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13346
13347    /**
13348     * Set the content to be shown in the bubble
13349     *
13350     * Once the content object is set, a previously set one will be deleted.
13351     * If you want to keep the old content object, use the
13352     * elm_bubble_content_unset() function.
13353     *
13354     * @param obj The bubble object
13355     * @param content The given content of the bubble
13356     *
13357     * This function sets the content shown on the middle of the bubble.
13358     *
13359     * @deprecated use elm_object_content_set() instead
13360     *
13361     */
13362    EINA_DEPRECATED EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13363
13364    /**
13365     * Get the content shown in the bubble
13366     *
13367     * Return the content object which is set for this widget.
13368     *
13369     * @param obj The bubble object
13370     * @return The content that is being used
13371     *
13372     * @deprecated use elm_object_content_get() instead
13373     *
13374     */
13375    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13376
13377    /**
13378     * Unset the content shown in the bubble
13379     *
13380     * Unparent and return the content object which was set for this widget.
13381     *
13382     * @param obj The bubble object
13383     * @return The content that was being used
13384     *
13385     * @deprecated use elm_object_content_unset() instead
13386     *
13387     */
13388    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13389
13390    /**
13391     * Set the icon of the bubble
13392     *
13393     * Once the icon object is set, a previously set one will be deleted.
13394     * If you want to keep the old content object, use the
13395     * elm_icon_content_unset() function.
13396     *
13397     * @param obj The bubble object
13398     * @param icon The given icon for the bubble
13399     *
13400     * @deprecated use elm_object_part_content_set() instead
13401     *
13402     */
13403    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13404
13405    /**
13406     * Get the icon of the bubble
13407     *
13408     * @param obj The bubble object
13409     * @return The icon for the bubble
13410     *
13411     * This function gets the icon shown on the top left of bubble.
13412     *
13413     * @deprecated use elm_object_part_content_get() instead
13414     *
13415     */
13416    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13417
13418    /**
13419     * Unset the icon of the bubble
13420     *
13421     * Unparent and return the icon object which was set for this widget.
13422     *
13423     * @param obj The bubble object
13424     * @return The icon that was being used
13425     *
13426     * @deprecated use elm_object_part_content_unset() instead
13427     *
13428     */
13429    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13430
13431    /**
13432     * Set the corner of the bubble
13433     *
13434     * @param obj The bubble object.
13435     * @param corner The given corner for the bubble.
13436     *
13437     * This function sets the corner of the bubble. The corner will be used to
13438     * determine where the arrow in the frame points to and where label, icon and
13439     * info are shown.
13440     *
13441     * Possible values for corner are:
13442     * @li "top_left" - Default
13443     * @li "top_right"
13444     * @li "bottom_left"
13445     * @li "bottom_right"
13446     */
13447    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
13448
13449    /**
13450     * Get the corner of the bubble
13451     *
13452     * @param obj The bubble object.
13453     * @return The given corner for the bubble.
13454     *
13455     * This function gets the selected corner of the bubble.
13456     */
13457    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13458
13459    /**
13460     * @}
13461     */
13462
13463    /**
13464     * @defgroup Photo Photo
13465     *
13466     * For displaying the photo of a person (contact). Simple, yet
13467     * with a very specific purpose.
13468     *
13469     * Signals that you can add callbacks for are:
13470     *
13471     * "clicked" - This is called when a user has clicked the photo
13472     * "drag,start" - Someone started dragging the image out of the object
13473     * "drag,end" - Dragged item was dropped (somewhere)
13474     *
13475     * @{
13476     */
13477
13478    /**
13479     * Add a new photo to the parent
13480     *
13481     * @param parent The parent object
13482     * @return The new object or NULL if it cannot be created
13483     *
13484     * @ingroup Photo
13485     */
13486    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13487
13488    /**
13489     * Set the file that will be used as photo
13490     *
13491     * @param obj The photo object
13492     * @param file The path to file that will be used as photo
13493     *
13494     * @return (1 = success, 0 = error)
13495     *
13496     * @ingroup Photo
13497     */
13498    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
13499
13500     /**
13501     * Set the file that will be used as thumbnail in the photo.
13502     *
13503     * @param obj The photo object.
13504     * @param file The path to file that will be used as thumb.
13505     * @param group The key used in case of an EET file.
13506     *
13507     * @ingroup Photo
13508     */
13509    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
13510
13511    /**
13512     * Set the size that will be used on the photo
13513     *
13514     * @param obj The photo object
13515     * @param size The size that the photo will be
13516     *
13517     * @ingroup Photo
13518     */
13519    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
13520
13521    /**
13522     * Set if the photo should be completely visible or not.
13523     *
13524     * @param obj The photo object
13525     * @param fill if true the photo will be completely visible
13526     *
13527     * @ingroup Photo
13528     */
13529    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
13530
13531    /**
13532     * Set editability of the photo.
13533     *
13534     * An editable photo can be dragged to or from, and can be cut or
13535     * pasted too.  Note that pasting an image or dropping an item on
13536     * the image will delete the existing content.
13537     *
13538     * @param obj The photo object.
13539     * @param set To set of clear editablity.
13540     */
13541    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
13542
13543    /**
13544     * @}
13545     */
13546
13547    /* gesture layer */
13548    /**
13549     * @defgroup Elm_Gesture_Layer Gesture Layer
13550     * Gesture Layer Usage:
13551     *
13552     * Use Gesture Layer to detect gestures.
13553     * The advantage is that you don't have to implement
13554     * gesture detection, just set callbacks of gesture state.
13555     * By using gesture layer we make standard interface.
13556     *
13557     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
13558     * with a parent object parameter.
13559     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
13560     * call. Usually with same object as target (2nd parameter).
13561     *
13562     * Now you need to tell gesture layer what gestures you follow.
13563     * This is done with @ref elm_gesture_layer_cb_set call.
13564     * By setting the callback you actually saying to gesture layer:
13565     * I would like to know when the gesture @ref Elm_Gesture_Types
13566     * switches to state @ref Elm_Gesture_State.
13567     *
13568     * Next, you need to implement the actual action that follows the input
13569     * in your callback.
13570     *
13571     * Note that if you like to stop being reported about a gesture, just set
13572     * all callbacks referring this gesture to NULL.
13573     * (again with @ref elm_gesture_layer_cb_set)
13574     *
13575     * The information reported by gesture layer to your callback is depending
13576     * on @ref Elm_Gesture_Types:
13577     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
13578     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
13579     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
13580     *
13581     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
13582     * @ref ELM_GESTURE_MOMENTUM.
13583     *
13584     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
13585     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
13586     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
13587     * Note that we consider a flick as a line-gesture that should be completed
13588     * in flick-time-limit as defined in @ref Config.
13589     *
13590     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
13591     *
13592     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
13593     *
13594     *
13595     * Gesture Layer Tweaks:
13596     *
13597     * Note that line, flick, gestures can start without the need to remove fingers from surface.
13598     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
13599     *
13600     * Setting glayer_continues_enable to false in @ref Config will change this behavior
13601     * so gesture starts when user touches (a *DOWN event) touch-surface
13602     * and ends when no fingers touches surface (a *UP event).
13603     */
13604
13605    /**
13606     * @enum _Elm_Gesture_Types
13607     * Enum of supported gesture types.
13608     * @ingroup Elm_Gesture_Layer
13609     */
13610    enum _Elm_Gesture_Types
13611      {
13612         ELM_GESTURE_FIRST = 0,
13613
13614         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
13615         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
13616         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
13617         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
13618
13619         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
13620
13621         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
13622         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
13623
13624         ELM_GESTURE_ZOOM, /**< Zoom */
13625         ELM_GESTURE_ROTATE, /**< Rotate */
13626
13627         ELM_GESTURE_LAST
13628      };
13629
13630    /**
13631     * @typedef Elm_Gesture_Types
13632     * gesture types enum
13633     * @ingroup Elm_Gesture_Layer
13634     */
13635    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
13636
13637    /**
13638     * @enum _Elm_Gesture_State
13639     * Enum of gesture states.
13640     * @ingroup Elm_Gesture_Layer
13641     */
13642    enum _Elm_Gesture_State
13643      {
13644         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
13645         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
13646         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
13647         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
13648         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
13649      };
13650
13651    /**
13652     * @typedef Elm_Gesture_State
13653     * gesture states enum
13654     * @ingroup Elm_Gesture_Layer
13655     */
13656    typedef enum _Elm_Gesture_State Elm_Gesture_State;
13657
13658    /**
13659     * @struct _Elm_Gesture_Taps_Info
13660     * Struct holds taps info for user
13661     * @ingroup Elm_Gesture_Layer
13662     */
13663    struct _Elm_Gesture_Taps_Info
13664      {
13665         Evas_Coord x, y;         /**< Holds center point between fingers */
13666         unsigned int n;          /**< Number of fingers tapped           */
13667         unsigned int timestamp;  /**< event timestamp       */
13668      };
13669
13670    /**
13671     * @typedef Elm_Gesture_Taps_Info
13672     * holds taps info for user
13673     * @ingroup Elm_Gesture_Layer
13674     */
13675    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13676
13677    /**
13678     * @struct _Elm_Gesture_Momentum_Info
13679     * Struct holds momentum info for user
13680     * x1 and y1 are not necessarily in sync
13681     * x1 holds x value of x direction starting point
13682     * and same holds for y1.
13683     * This is noticeable when doing V-shape movement
13684     * @ingroup Elm_Gesture_Layer
13685     */
13686    struct _Elm_Gesture_Momentum_Info
13687      {  /* Report line ends, timestamps, and momentum computed        */
13688         Evas_Coord x1; /**< Final-swipe direction starting point on X */
13689         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13690         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
13691         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
13692
13693         unsigned int tx; /**< Timestamp of start of final x-swipe */
13694         unsigned int ty; /**< Timestamp of start of final y-swipe */
13695
13696         Evas_Coord mx; /**< Momentum on X */
13697         Evas_Coord my; /**< Momentum on Y */
13698
13699         unsigned int n;  /**< Number of fingers */
13700      };
13701
13702    /**
13703     * @typedef Elm_Gesture_Momentum_Info
13704     * holds momentum info for user
13705     * @ingroup Elm_Gesture_Layer
13706     */
13707     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13708
13709    /**
13710     * @struct _Elm_Gesture_Line_Info
13711     * Struct holds line info for user
13712     * @ingroup Elm_Gesture_Layer
13713     */
13714    struct _Elm_Gesture_Line_Info
13715      {  /* Report line ends, timestamps, and momentum computed      */
13716         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13717         double angle;              /**< Angle (direction) of lines  */
13718      };
13719
13720    /**
13721     * @typedef Elm_Gesture_Line_Info
13722     * Holds line info for user
13723     * @ingroup Elm_Gesture_Layer
13724     */
13725     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13726
13727    /**
13728     * @struct _Elm_Gesture_Zoom_Info
13729     * Struct holds zoom info for user
13730     * @ingroup Elm_Gesture_Layer
13731     */
13732    struct _Elm_Gesture_Zoom_Info
13733      {
13734         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
13735         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13736         double zoom;            /**< Zoom value: 1.0 means no zoom             */
13737         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13738      };
13739
13740    /**
13741     * @typedef Elm_Gesture_Zoom_Info
13742     * Holds zoom info for user
13743     * @ingroup Elm_Gesture_Layer
13744     */
13745    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13746
13747    /**
13748     * @struct _Elm_Gesture_Rotate_Info
13749     * Struct holds rotation info for user
13750     * @ingroup Elm_Gesture_Layer
13751     */
13752    struct _Elm_Gesture_Rotate_Info
13753      {
13754         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
13755         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13756         double base_angle; /**< Holds start-angle */
13757         double angle;      /**< Rotation value: 0.0 means no rotation         */
13758         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13759      };
13760
13761    /**
13762     * @typedef Elm_Gesture_Rotate_Info
13763     * Holds rotation info for user
13764     * @ingroup Elm_Gesture_Layer
13765     */
13766    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13767
13768    /**
13769     * @typedef Elm_Gesture_Event_Cb
13770     * User callback used to stream gesture info from gesture layer
13771     * @param data user data
13772     * @param event_info gesture report info
13773     * Returns a flag field to be applied on the causing event.
13774     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13775     * upon the event, in an irreversible way.
13776     *
13777     * @ingroup Elm_Gesture_Layer
13778     */
13779    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13780
13781    /**
13782     * Use function to set callbacks to be notified about
13783     * change of state of gesture.
13784     * When a user registers a callback with this function
13785     * this means this gesture has to be tested.
13786     *
13787     * When ALL callbacks for a gesture are set to NULL
13788     * it means user isn't interested in gesture-state
13789     * and it will not be tested.
13790     *
13791     * @param obj Pointer to gesture-layer.
13792     * @param idx The gesture you would like to track its state.
13793     * @param cb callback function pointer.
13794     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13795     * @param data user info to be sent to callback (usually, Smart Data)
13796     *
13797     * @ingroup Elm_Gesture_Layer
13798     */
13799    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);
13800
13801    /**
13802     * Call this function to get repeat-events settings.
13803     *
13804     * @param obj Pointer to gesture-layer.
13805     *
13806     * @return repeat events settings.
13807     * @see elm_gesture_layer_hold_events_set()
13808     * @ingroup Elm_Gesture_Layer
13809     */
13810    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13811
13812    /**
13813     * This function called in order to make gesture-layer repeat events.
13814     * Set this of you like to get the raw events only if gestures were not detected.
13815     * Clear this if you like gesture layer to fwd events as testing gestures.
13816     *
13817     * @param obj Pointer to gesture-layer.
13818     * @param r Repeat: TRUE/FALSE
13819     *
13820     * @ingroup Elm_Gesture_Layer
13821     */
13822    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13823
13824    /**
13825     * This function sets step-value for zoom action.
13826     * Set step to any positive value.
13827     * Cancel step setting by setting to 0.0
13828     *
13829     * @param obj Pointer to gesture-layer.
13830     * @param s new zoom step value.
13831     *
13832     * @ingroup Elm_Gesture_Layer
13833     */
13834    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13835
13836    /**
13837     * This function sets step-value for rotate action.
13838     * Set step to any positive value.
13839     * Cancel step setting by setting to 0.0
13840     *
13841     * @param obj Pointer to gesture-layer.
13842     * @param s new roatate step value.
13843     *
13844     * @ingroup Elm_Gesture_Layer
13845     */
13846    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13847
13848    /**
13849     * This function called to attach gesture-layer to an Evas_Object.
13850     * @param obj Pointer to gesture-layer.
13851     * @param t Pointer to underlying object (AKA Target)
13852     *
13853     * @return TRUE, FALSE on success, failure.
13854     *
13855     * @ingroup Elm_Gesture_Layer
13856     */
13857    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13858
13859    /**
13860     * Call this function to construct a new gesture-layer object.
13861     * This does not activate the gesture layer. You have to
13862     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13863     *
13864     * @param parent the parent object.
13865     *
13866     * @return Pointer to new gesture-layer object.
13867     *
13868     * @ingroup Elm_Gesture_Layer
13869     */
13870    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13871
13872    /**
13873     * @defgroup Thumb Thumb
13874     *
13875     * @image html img/widget/thumb/preview-00.png
13876     * @image latex img/widget/thumb/preview-00.eps
13877     *
13878     * A thumb object is used for displaying the thumbnail of an image or video.
13879     * You must have compiled Elementary with Ethumb_Client support and the DBus
13880     * service must be present and auto-activated in order to have thumbnails to
13881     * be generated.
13882     *
13883     * Once the thumbnail object becomes visible, it will check if there is a
13884     * previously generated thumbnail image for the file set on it. If not, it
13885     * will start generating this thumbnail.
13886     *
13887     * Different config settings will cause different thumbnails to be generated
13888     * even on the same file.
13889     *
13890     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13891     * Ethumb documentation to change this path, and to see other configuration
13892     * options.
13893     *
13894     * Signals that you can add callbacks for are:
13895     *
13896     * - "clicked" - This is called when a user has clicked the thumb without dragging
13897     *             around.
13898     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13899     * - "press" - This is called when a user has pressed down the thumb.
13900     * - "generate,start" - The thumbnail generation started.
13901     * - "generate,stop" - The generation process stopped.
13902     * - "generate,error" - The generation failed.
13903     * - "load,error" - The thumbnail image loading failed.
13904     *
13905     * available styles:
13906     * - default
13907     * - noframe
13908     *
13909     * An example of use of thumbnail:
13910     *
13911     * - @ref thumb_example_01
13912     */
13913
13914    /**
13915     * @addtogroup Thumb
13916     * @{
13917     */
13918
13919    /**
13920     * @enum _Elm_Thumb_Animation_Setting
13921     * @typedef Elm_Thumb_Animation_Setting
13922     *
13923     * Used to set if a video thumbnail is animating or not.
13924     *
13925     * @ingroup Thumb
13926     */
13927    typedef enum _Elm_Thumb_Animation_Setting
13928      {
13929         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13930         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13931         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13932         ELM_THUMB_ANIMATION_LAST
13933      } Elm_Thumb_Animation_Setting;
13934
13935    /**
13936     * Add a new thumb object to the parent.
13937     *
13938     * @param parent The parent object.
13939     * @return The new object or NULL if it cannot be created.
13940     *
13941     * @see elm_thumb_file_set()
13942     * @see elm_thumb_ethumb_client_get()
13943     *
13944     * @ingroup Thumb
13945     */
13946    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13947
13948    /**
13949     * Reload thumbnail if it was generated before.
13950     *
13951     * @param obj The thumb object to reload
13952     *
13953     * This is useful if the ethumb client configuration changed, like its
13954     * size, aspect or any other property one set in the handle returned
13955     * by elm_thumb_ethumb_client_get().
13956     *
13957     * If the options didn't change, the thumbnail won't be generated again, but
13958     * the old one will still be used.
13959     *
13960     * @see elm_thumb_file_set()
13961     *
13962     * @ingroup Thumb
13963     */
13964    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13965
13966    /**
13967     * Set the file that will be used as thumbnail.
13968     *
13969     * @param obj The thumb object.
13970     * @param file The path to file that will be used as thumb.
13971     * @param key The key used in case of an EET file.
13972     *
13973     * The file can be an image or a video (in that case, acceptable extensions are:
13974     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13975     * function elm_thumb_animate().
13976     *
13977     * @see elm_thumb_file_get()
13978     * @see elm_thumb_reload()
13979     * @see elm_thumb_animate()
13980     *
13981     * @ingroup Thumb
13982     */
13983    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13984
13985    /**
13986     * Get the image or video path and key used to generate the thumbnail.
13987     *
13988     * @param obj The thumb object.
13989     * @param file Pointer to filename.
13990     * @param key Pointer to key.
13991     *
13992     * @see elm_thumb_file_set()
13993     * @see elm_thumb_path_get()
13994     *
13995     * @ingroup Thumb
13996     */
13997    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13998
13999    /**
14000     * Get the path and key to the image or video generated by ethumb.
14001     *
14002     * One just need to make sure that the thumbnail was generated before getting
14003     * its path; otherwise, the path will be NULL. One way to do that is by asking
14004     * for the path when/after the "generate,stop" smart callback is called.
14005     *
14006     * @param obj The thumb object.
14007     * @param file Pointer to thumb path.
14008     * @param key Pointer to thumb key.
14009     *
14010     * @see elm_thumb_file_get()
14011     *
14012     * @ingroup Thumb
14013     */
14014    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
14015
14016    /**
14017     * Set the animation state for the thumb object. If its content is an animated
14018     * video, you may start/stop the animation or tell it to play continuously and
14019     * looping.
14020     *
14021     * @param obj The thumb object.
14022     * @param setting The animation setting.
14023     *
14024     * @see elm_thumb_file_set()
14025     *
14026     * @ingroup Thumb
14027     */
14028    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
14029
14030    /**
14031     * Get the animation state for the thumb object.
14032     *
14033     * @param obj The thumb object.
14034     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
14035     * on errors.
14036     *
14037     * @see elm_thumb_animate_set()
14038     *
14039     * @ingroup Thumb
14040     */
14041    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14042
14043    /**
14044     * Get the ethumb_client handle so custom configuration can be made.
14045     *
14046     * @return Ethumb_Client instance or NULL.
14047     *
14048     * This must be called before the objects are created to be sure no object is
14049     * visible and no generation started.
14050     *
14051     * Example of usage:
14052     *
14053     * @code
14054     * #include <Elementary.h>
14055     * #ifndef ELM_LIB_QUICKLAUNCH
14056     * EAPI_MAIN int
14057     * elm_main(int argc, char **argv)
14058     * {
14059     *    Ethumb_Client *client;
14060     *
14061     *    elm_need_ethumb();
14062     *
14063     *    // ... your code
14064     *
14065     *    client = elm_thumb_ethumb_client_get();
14066     *    if (!client)
14067     *      {
14068     *         ERR("could not get ethumb_client");
14069     *         return 1;
14070     *      }
14071     *    ethumb_client_size_set(client, 100, 100);
14072     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
14073     *    // ... your code
14074     *
14075     *    // Create elm_thumb objects here
14076     *
14077     *    elm_run();
14078     *    elm_shutdown();
14079     *    return 0;
14080     * }
14081     * #endif
14082     * ELM_MAIN()
14083     * @endcode
14084     *
14085     * @note There's only one client handle for Ethumb, so once a configuration
14086     * change is done to it, any other request for thumbnails (for any thumbnail
14087     * object) will use that configuration. Thus, this configuration is global.
14088     *
14089     * @ingroup Thumb
14090     */
14091    EAPI void                        *elm_thumb_ethumb_client_get(void);
14092
14093    /**
14094     * Get the ethumb_client connection state.
14095     *
14096     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
14097     * otherwise.
14098     */
14099    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
14100
14101    /**
14102     * Make the thumbnail 'editable'.
14103     *
14104     * @param obj Thumb object.
14105     * @param set Turn on or off editability. Default is @c EINA_FALSE.
14106     *
14107     * This means the thumbnail is a valid drag target for drag and drop, and can be
14108     * cut or pasted too.
14109     *
14110     * @see elm_thumb_editable_get()
14111     *
14112     * @ingroup Thumb
14113     */
14114    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
14115
14116    /**
14117     * Make the thumbnail 'editable'.
14118     *
14119     * @param obj Thumb object.
14120     * @return Editability.
14121     *
14122     * This means the thumbnail is a valid drag target for drag and drop, and can be
14123     * cut or pasted too.
14124     *
14125     * @see elm_thumb_editable_set()
14126     *
14127     * @ingroup Thumb
14128     */
14129    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14130
14131    /**
14132     * @}
14133     */
14134
14135    /**
14136     * @defgroup Web Web
14137     *
14138     * @image html img/widget/web/preview-00.png
14139     * @image latex img/widget/web/preview-00.eps
14140     *
14141     * A web object is used for displaying web pages (HTML/CSS/JS)
14142     * using WebKit-EFL. You must have compiled Elementary with
14143     * ewebkit support.
14144     *
14145     * Signals that you can add callbacks for are:
14146     * @li "download,request": A file download has been requested. Event info is
14147     * a pointer to a Elm_Web_Download
14148     * @li "editorclient,contents,changed": Editor client's contents changed
14149     * @li "editorclient,selection,changed": Editor client's selection changed
14150     * @li "frame,created": A new frame was created. Event info is an
14151     * Evas_Object which can be handled with WebKit's ewk_frame API
14152     * @li "icon,received": An icon was received by the main frame
14153     * @li "inputmethod,changed": Input method changed. Event info is an
14154     * Eina_Bool indicating whether it's enabled or not
14155     * @li "js,windowobject,clear": JS window object has been cleared
14156     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
14157     * is a char *link[2], where the first string contains the URL the link
14158     * points to, and the second one the title of the link
14159     * @li "link,hover,out": Mouse cursor left the link
14160     * @li "load,document,finished": Loading of a document finished. Event info
14161     * is the frame that finished loading
14162     * @li "load,error": Load failed. Event info is a pointer to
14163     * Elm_Web_Frame_Load_Error
14164     * @li "load,finished": Load finished. Event info is NULL on success, on
14165     * error it's a pointer to Elm_Web_Frame_Load_Error
14166     * @li "load,newwindow,show": A new window was created and is ready to be
14167     * shown
14168     * @li "load,progress": Overall load progress. Event info is a pointer to
14169     * a double containing a value between 0.0 and 1.0
14170     * @li "load,provisional": Started provisional load
14171     * @li "load,started": Loading of a document started
14172     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
14173     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
14174     * the menubar is visible, or EINA_FALSE in case it's not
14175     * @li "menubar,visible,set": Informs menubar visibility. Event info is
14176     * an Eina_Bool indicating the visibility
14177     * @li "popup,created": A dropdown widget was activated, requesting its
14178     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
14179     * @li "popup,willdelete": The web object is ready to destroy the popup
14180     * object created. Event info is a pointer to Elm_Web_Menu
14181     * @li "ready": Page is fully loaded
14182     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
14183     * info is a pointer to Eina_Bool where the visibility state should be set
14184     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
14185     * is an Eina_Bool with the visibility state set
14186     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
14187     * a string with the new text
14188     * @li "statusbar,visible,get": Queries visibility of the status bar.
14189     * Event info is a pointer to Eina_Bool where the visibility state should be
14190     * set.
14191     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
14192     * an Eina_Bool with the visibility value
14193     * @li "title,changed": Title of the main frame changed. Event info is a
14194     * string with the new title
14195     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
14196     * is a pointer to Eina_Bool where the visibility state should be set
14197     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
14198     * info is an Eina_Bool with the visibility state
14199     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
14200     * a string with the text to show
14201     * @li "uri,changed": URI of the main frame changed. Event info is a string
14202     * with the new URI
14203     * @li "view,resized": The web object internal's view changed sized
14204     * @li "windows,close,request": A JavaScript request to close the current
14205     * window was requested
14206     * @li "zoom,animated,end": Animated zoom finished
14207     *
14208     * available styles:
14209     * - default
14210     *
14211     * An example of use of web:
14212     *
14213     * - @ref web_example_01 TBD
14214     */
14215
14216    /**
14217     * @addtogroup Web
14218     * @{
14219     */
14220
14221    /**
14222     * Structure used to report load errors.
14223     *
14224     * Load errors are reported as signal by elm_web. All the strings are
14225     * temporary references and should @b not be used after the signal
14226     * callback returns. If it's required, make copies with strdup() or
14227     * eina_stringshare_add() (they are not even guaranteed to be
14228     * stringshared, so must use eina_stringshare_add() and not
14229     * eina_stringshare_ref()).
14230     */
14231    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
14232
14233    /**
14234     * Structure used to report load errors.
14235     *
14236     * Load errors are reported as signal by elm_web. All the strings are
14237     * temporary references and should @b not be used after the signal
14238     * callback returns. If it's required, make copies with strdup() or
14239     * eina_stringshare_add() (they are not even guaranteed to be
14240     * stringshared, so must use eina_stringshare_add() and not
14241     * eina_stringshare_ref()).
14242     */
14243    struct _Elm_Web_Frame_Load_Error
14244      {
14245         int code; /**< Numeric error code */
14246         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
14247         const char *domain; /**< Error domain name */
14248         const char *description; /**< Error description (already localized) */
14249         const char *failing_url; /**< The URL that failed to load */
14250         Evas_Object *frame; /**< Frame object that produced the error */
14251      };
14252
14253    /**
14254     * The possibles types that the items in a menu can be
14255     */
14256    typedef enum _Elm_Web_Menu_Item_Type
14257      {
14258         ELM_WEB_MENU_SEPARATOR,
14259         ELM_WEB_MENU_GROUP,
14260         ELM_WEB_MENU_OPTION
14261      } Elm_Web_Menu_Item_Type;
14262
14263    /**
14264     * Structure describing the items in a menu
14265     */
14266    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
14267
14268    /**
14269     * Structure describing the items in a menu
14270     */
14271    struct _Elm_Web_Menu_Item
14272      {
14273         const char *text; /**< The text for the item */
14274         Elm_Web_Menu_Item_Type type; /**< The type of the item */
14275      };
14276
14277    /**
14278     * Structure describing the menu of a popup
14279     *
14280     * This structure will be passed as the @c event_info for the "popup,create"
14281     * signal, which is emitted when a dropdown menu is opened. Users wanting
14282     * to handle these popups by themselves should listen to this signal and
14283     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14284     * property as @c EINA_FALSE means that the user will not handle the popup
14285     * and the default implementation will be used.
14286     *
14287     * When the popup is ready to be dismissed, a "popup,willdelete" signal
14288     * will be emitted to notify the user that it can destroy any objects and
14289     * free all data related to it.
14290     *
14291     * @see elm_web_popup_selected_set()
14292     * @see elm_web_popup_destroy()
14293     */
14294    typedef struct _Elm_Web_Menu Elm_Web_Menu;
14295
14296    /**
14297     * Structure describing the menu of a popup
14298     *
14299     * This structure will be passed as the @c event_info for the "popup,create"
14300     * signal, which is emitted when a dropdown menu is opened. Users wanting
14301     * to handle these popups by themselves should listen to this signal and
14302     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14303     * property as @c EINA_FALSE means that the user will not handle the popup
14304     * and the default implementation will be used.
14305     *
14306     * When the popup is ready to be dismissed, a "popup,willdelete" signal
14307     * will be emitted to notify the user that it can destroy any objects and
14308     * free all data related to it.
14309     *
14310     * @see elm_web_popup_selected_set()
14311     * @see elm_web_popup_destroy()
14312     */
14313    struct _Elm_Web_Menu
14314      {
14315         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
14316         int x; /**< The X position of the popup, relative to the elm_web object */
14317         int y; /**< The Y position of the popup, relative to the elm_web object */
14318         int width; /**< Width of the popup menu */
14319         int height; /**< Height of the popup menu */
14320
14321         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. */
14322      };
14323
14324    typedef struct _Elm_Web_Download Elm_Web_Download;
14325    struct _Elm_Web_Download
14326      {
14327         const char *url;
14328      };
14329
14330    /**
14331     * Types of zoom available.
14332     */
14333    typedef enum _Elm_Web_Zoom_Mode
14334      {
14335         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
14336         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
14337         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
14338         ELM_WEB_ZOOM_MODE_LAST
14339      } Elm_Web_Zoom_Mode;
14340
14341    /**
14342     * Opaque handler containing the features (such as statusbar, menubar, etc)
14343     * that are to be set on a newly requested window.
14344     */
14345    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
14346
14347    /**
14348     * Callback type for the create_window hook.
14349     *
14350     * The function parameters are:
14351     * @li @p data User data pointer set when setting the hook function
14352     * @li @p obj The elm_web object requesting the new window
14353     * @li @p js Set to @c EINA_TRUE if the request was originated from
14354     * JavaScript. @c EINA_FALSE otherwise.
14355     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
14356     * the features requested for the new window.
14357     *
14358     * The returned value of the function should be the @c elm_web widget where
14359     * the request will be loaded. That is, if a new window or tab is created,
14360     * the elm_web widget in it should be returned, and @b NOT the window
14361     * object.
14362     * Returning @c NULL should cancel the request.
14363     *
14364     * @see elm_web_window_create_hook_set()
14365     */
14366    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
14367
14368    /**
14369     * Callback type for the JS alert hook.
14370     *
14371     * The function parameters are:
14372     * @li @p data User data pointer set when setting the hook function
14373     * @li @p obj The elm_web object requesting the new window
14374     * @li @p message The message to show in the alert dialog
14375     *
14376     * The function should return the object representing the alert dialog.
14377     * Elm_Web will run a second main loop to handle the dialog and normal
14378     * flow of the application will be restored when the object is deleted, so
14379     * the user should handle the popup properly in order to delete the object
14380     * when the action is finished.
14381     * If the function returns @c NULL the popup will be ignored.
14382     *
14383     * @see elm_web_dialog_alert_hook_set()
14384     */
14385    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
14386
14387    /**
14388     * Callback type for the JS confirm hook.
14389     *
14390     * The function parameters are:
14391     * @li @p data User data pointer set when setting the hook function
14392     * @li @p obj The elm_web object requesting the new window
14393     * @li @p message The message to show in the confirm dialog
14394     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14395     * the user selected @c Ok, @c EINA_FALSE otherwise.
14396     *
14397     * The function should return the object representing the confirm dialog.
14398     * Elm_Web will run a second main loop to handle the dialog and normal
14399     * flow of the application will be restored when the object is deleted, so
14400     * the user should handle the popup properly in order to delete the object
14401     * when the action is finished.
14402     * If the function returns @c NULL the popup will be ignored.
14403     *
14404     * @see elm_web_dialog_confirm_hook_set()
14405     */
14406    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
14407
14408    /**
14409     * Callback type for the JS prompt hook.
14410     *
14411     * The function parameters are:
14412     * @li @p data User data pointer set when setting the hook function
14413     * @li @p obj The elm_web object requesting the new window
14414     * @li @p message The message to show in the prompt dialog
14415     * @li @p def_value The default value to present the user in the entry
14416     * @li @p value Pointer where to store the value given by the user. Must
14417     * be a malloc'ed string or @c NULL if the user cancelled the popup.
14418     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14419     * the user selected @c Ok, @c EINA_FALSE otherwise.
14420     *
14421     * The function should return the object representing the prompt dialog.
14422     * Elm_Web will run a second main loop to handle the dialog and normal
14423     * flow of the application will be restored when the object is deleted, so
14424     * the user should handle the popup properly in order to delete the object
14425     * when the action is finished.
14426     * If the function returns @c NULL the popup will be ignored.
14427     *
14428     * @see elm_web_dialog_prompt_hook_set()
14429     */
14430    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
14431
14432    /**
14433     * Callback type for the JS file selector hook.
14434     *
14435     * The function parameters are:
14436     * @li @p data User data pointer set when setting the hook function
14437     * @li @p obj The elm_web object requesting the new window
14438     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
14439     * @li @p accept_types Mime types accepted
14440     * @li @p selected Pointer where to store the list of malloc'ed strings
14441     * containing the path to each file selected. Must be @c NULL if the file
14442     * dialog is cancelled
14443     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14444     * the user selected @c Ok, @c EINA_FALSE otherwise.
14445     *
14446     * The function should return the object representing the file selector
14447     * dialog.
14448     * Elm_Web will run a second main loop to handle the dialog and normal
14449     * flow of the application will be restored when the object is deleted, so
14450     * the user should handle the popup properly in order to delete the object
14451     * when the action is finished.
14452     * If the function returns @c NULL the popup will be ignored.
14453     *
14454     * @see elm_web_dialog_file selector_hook_set()
14455     */
14456    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);
14457
14458    /**
14459     * Callback type for the JS console message hook.
14460     *
14461     * When a console message is added from JavaScript, any set function to the
14462     * console message hook will be called for the user to handle. There is no
14463     * default implementation of this hook.
14464     *
14465     * The function parameters are:
14466     * @li @p data User data pointer set when setting the hook function
14467     * @li @p obj The elm_web object that originated the message
14468     * @li @p message The message sent
14469     * @li @p line_number The line number
14470     * @li @p source_id Source id
14471     *
14472     * @see elm_web_console_message_hook_set()
14473     */
14474    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
14475
14476    /**
14477     * Add a new web object to the parent.
14478     *
14479     * @param parent The parent object.
14480     * @return The new object or NULL if it cannot be created.
14481     *
14482     * @see elm_web_uri_set()
14483     * @see elm_web_webkit_view_get()
14484     */
14485    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14486
14487    /**
14488     * Get internal ewk_view object from web object.
14489     *
14490     * Elementary may not provide some low level features of EWebKit,
14491     * instead of cluttering the API with proxy methods we opted to
14492     * return the internal reference. Be careful using it as it may
14493     * interfere with elm_web behavior.
14494     *
14495     * @param obj The web object.
14496     * @return The internal ewk_view object or NULL if it does not
14497     *         exist. (Failure to create or Elementary compiled without
14498     *         ewebkit)
14499     *
14500     * @see elm_web_add()
14501     */
14502    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14503
14504    /**
14505     * Sets the function to call when a new window is requested
14506     *
14507     * This hook will be called when a request to create a new window is
14508     * issued from the web page loaded.
14509     * There is no default implementation for this feature, so leaving this
14510     * unset or passing @c NULL in @p func will prevent new windows from
14511     * opening.
14512     *
14513     * @param obj The web object where to set the hook function
14514     * @param func The hook function to be called when a window is requested
14515     * @param data User data
14516     */
14517    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
14518
14519    /**
14520     * Sets the function to call when an alert dialog
14521     *
14522     * This hook will be called when a JavaScript alert dialog is requested.
14523     * If no function is set or @c NULL is passed in @p func, the default
14524     * implementation will take place.
14525     *
14526     * @param obj The web object where to set the hook function
14527     * @param func The callback function to be used
14528     * @param data User data
14529     *
14530     * @see elm_web_inwin_mode_set()
14531     */
14532    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
14533
14534    /**
14535     * Sets the function to call when an confirm dialog
14536     *
14537     * This hook will be called when a JavaScript confirm dialog is requested.
14538     * If no function is set or @c NULL is passed in @p func, the default
14539     * implementation will take place.
14540     *
14541     * @param obj The web object where to set the hook function
14542     * @param func The callback function to be used
14543     * @param data User data
14544     *
14545     * @see elm_web_inwin_mode_set()
14546     */
14547    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
14548
14549    /**
14550     * Sets the function to call when an prompt dialog
14551     *
14552     * This hook will be called when a JavaScript prompt dialog is requested.
14553     * If no function is set or @c NULL is passed in @p func, the default
14554     * implementation will take place.
14555     *
14556     * @param obj The web object where to set the hook function
14557     * @param func The callback function to be used
14558     * @param data User data
14559     *
14560     * @see elm_web_inwin_mode_set()
14561     */
14562    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
14563
14564    /**
14565     * Sets the function to call when an file selector dialog
14566     *
14567     * This hook will be called when a JavaScript file selector dialog is
14568     * 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_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
14579
14580    /**
14581     * Sets the function to call when a console message is emitted from JS
14582     *
14583     * This hook will be called when a console message is emitted from
14584     * JavaScript. There is no default implementation for this feature.
14585     *
14586     * @param obj The web object where to set the hook function
14587     * @param func The callback function to be used
14588     * @param data User data
14589     */
14590    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
14591
14592    /**
14593     * Gets the status of the tab propagation
14594     *
14595     * @param obj The web object to query
14596     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
14597     *
14598     * @see elm_web_tab_propagate_set()
14599     */
14600    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
14601
14602    /**
14603     * Sets whether to use tab propagation
14604     *
14605     * If tab propagation is enabled, whenever the user presses the Tab key,
14606     * Elementary will handle it and switch focus to the next widget.
14607     * The default value is disabled, where WebKit will handle the Tab key to
14608     * cycle focus though its internal objects, jumping to the next widget
14609     * only when that cycle ends.
14610     *
14611     * @param obj The web object
14612     * @param propagate Whether to propagate Tab keys to Elementary or not
14613     */
14614    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
14615
14616    /**
14617     * Sets the URI for the web object
14618     *
14619     * It must be a full URI, with resource included, in the form
14620     * http://www.enlightenment.org or file:///tmp/something.html
14621     *
14622     * @param obj The web object
14623     * @param uri The URI to set
14624     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
14625     */
14626    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
14627
14628    /**
14629     * Gets the current URI for the object
14630     *
14631     * The returned string must not be freed and is guaranteed to be
14632     * stringshared.
14633     *
14634     * @param obj The web object
14635     * @return A stringshared internal string with the current URI, or NULL on
14636     * failure
14637     */
14638    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
14639
14640    /**
14641     * Gets the current title
14642     *
14643     * The returned string must not be freed and is guaranteed to be
14644     * stringshared.
14645     *
14646     * @param obj The web object
14647     * @return A stringshared internal string with the current title, or NULL on
14648     * failure
14649     */
14650    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
14651
14652    /**
14653     * Sets the background color to be used by the web object
14654     *
14655     * This is the color that will be used by default when the loaded page
14656     * does not set it's own. Color values are pre-multiplied.
14657     *
14658     * @param obj The web object
14659     * @param r Red component
14660     * @param g Green component
14661     * @param b Blue component
14662     * @param a Alpha component
14663     */
14664    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
14665
14666    /**
14667     * Gets the background color to be used by the web object
14668     *
14669     * This is the color that will be used by default when the loaded page
14670     * does not set it's own. Color values are pre-multiplied.
14671     *
14672     * @param obj The web object
14673     * @param r Red component
14674     * @param g Green component
14675     * @param b Blue component
14676     * @param a Alpha component
14677     */
14678    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
14679
14680    /**
14681     * Gets a copy of the currently selected text
14682     *
14683     * The string returned must be freed by the user when it's done with it.
14684     *
14685     * @param obj The web object
14686     * @return A newly allocated string, or NULL if nothing is selected or an
14687     * error occurred
14688     */
14689    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
14690
14691    /**
14692     * Tells the web object which index in the currently open popup was selected
14693     *
14694     * When the user handles the popup creation from the "popup,created" signal,
14695     * it needs to tell the web object which item was selected by calling this
14696     * function with the index corresponding to the item.
14697     *
14698     * @param obj The web object
14699     * @param index The index selected
14700     *
14701     * @see elm_web_popup_destroy()
14702     */
14703    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
14704
14705    /**
14706     * Dismisses an open dropdown popup
14707     *
14708     * When the popup from a dropdown widget is to be dismissed, either after
14709     * selecting an option or to cancel it, this function must be called, which
14710     * will later emit an "popup,willdelete" signal to notify the user that
14711     * any memory and objects related to this popup can be freed.
14712     *
14713     * @param obj The web object
14714     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14715     * if there was no menu to destroy
14716     */
14717    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
14718
14719    /**
14720     * Searches the given string in a document.
14721     *
14722     * @param obj The web object where to search the text
14723     * @param string String to search
14724     * @param case_sensitive If search should be case sensitive or not
14725     * @param forward If search is from cursor and on or backwards
14726     * @param wrap If search should wrap at the end
14727     *
14728     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14729     * or failure
14730     */
14731    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14732
14733    /**
14734     * Marks matches of the given string in a document.
14735     *
14736     * @param obj The web object where to search text
14737     * @param string String to match
14738     * @param case_sensitive If match should be case sensitive or not
14739     * @param highlight If matches should be highlighted
14740     * @param limit Maximum amount of matches, or zero to unlimited
14741     *
14742     * @return number of matched @a string
14743     */
14744    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14745
14746    /**
14747     * Clears all marked matches in the document
14748     *
14749     * @param obj The web object
14750     *
14751     * @return EINA_TRUE on success, EINA_FALSE otherwise
14752     */
14753    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
14754
14755    /**
14756     * Sets whether to highlight the matched marks
14757     *
14758     * If enabled, marks set with elm_web_text_matches_mark() will be
14759     * highlighted.
14760     *
14761     * @param obj The web object
14762     * @param highlight Whether to highlight the marks or not
14763     *
14764     * @return EINA_TRUE on success, EINA_FALSE otherwise
14765     */
14766    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14767
14768    /**
14769     * Gets whether highlighting marks is enabled
14770     *
14771     * @param The web object
14772     *
14773     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14774     * otherwise
14775     */
14776    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
14777
14778    /**
14779     * Gets the overall loading progress of the page
14780     *
14781     * Returns the estimated loading progress of the page, with a value between
14782     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14783     * included in the page.
14784     *
14785     * @param The web object
14786     *
14787     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14788     * failure
14789     */
14790    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
14791
14792    /**
14793     * Stops loading the current page
14794     *
14795     * Cancels the loading of the current page in the web object. This will
14796     * cause a "load,error" signal to be emitted, with the is_cancellation
14797     * flag set to EINA_TRUE.
14798     *
14799     * @param obj The web object
14800     *
14801     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14802     */
14803    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
14804
14805    /**
14806     * Requests a reload of the current document in the object
14807     *
14808     * @param obj The web object
14809     *
14810     * @return EINA_TRUE on success, EINA_FALSE otherwise
14811     */
14812    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
14813
14814    /**
14815     * Requests a reload of the current document, avoiding any existing caches
14816     *
14817     * @param obj The web object
14818     *
14819     * @return EINA_TRUE on success, EINA_FALSE otherwise
14820     */
14821    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
14822
14823    /**
14824     * Goes back one step in the browsing history
14825     *
14826     * This is equivalent to calling elm_web_object_navigate(obj, -1);
14827     *
14828     * @param obj The web object
14829     *
14830     * @return EINA_TRUE on success, EINA_FALSE otherwise
14831     *
14832     * @see elm_web_history_enable_set()
14833     * @see elm_web_back_possible()
14834     * @see elm_web_forward()
14835     * @see elm_web_navigate()
14836     */
14837    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
14838
14839    /**
14840     * Goes forward one step in the browsing history
14841     *
14842     * This is equivalent to calling elm_web_object_navigate(obj, 1);
14843     *
14844     * @param obj The web object
14845     *
14846     * @return EINA_TRUE on success, EINA_FALSE otherwise
14847     *
14848     * @see elm_web_history_enable_set()
14849     * @see elm_web_forward_possible()
14850     * @see elm_web_back()
14851     * @see elm_web_navigate()
14852     */
14853    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14854
14855    /**
14856     * Jumps the given number of steps in the browsing history
14857     *
14858     * The @p steps value can be a negative integer to back in history, or a
14859     * positive to move forward.
14860     *
14861     * @param obj The web object
14862     * @param steps The number of steps to jump
14863     *
14864     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14865     * history exists to jump the given number of steps
14866     *
14867     * @see elm_web_history_enable_set()
14868     * @see elm_web_navigate_possible()
14869     * @see elm_web_back()
14870     * @see elm_web_forward()
14871     */
14872    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14873
14874    /**
14875     * Queries whether it's possible to go back in history
14876     *
14877     * @param obj The web object
14878     *
14879     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14880     * otherwise
14881     */
14882    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14883
14884    /**
14885     * Queries whether it's possible to go forward in history
14886     *
14887     * @param obj The web object
14888     *
14889     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14890     * otherwise
14891     */
14892    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14893
14894    /**
14895     * Queries whether it's possible to jump the given number of steps
14896     *
14897     * The @p steps value can be a negative integer to back in history, or a
14898     * positive to move forward.
14899     *
14900     * @param obj The web object
14901     * @param steps The number of steps to check for
14902     *
14903     * @return EINA_TRUE if enough history exists to perform the given jump,
14904     * EINA_FALSE otherwise
14905     */
14906    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14907
14908    /**
14909     * Gets whether browsing history is enabled for the given object
14910     *
14911     * @param obj The web object
14912     *
14913     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14914     */
14915    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14916
14917    /**
14918     * Enables or disables the browsing history
14919     *
14920     * @param obj The web object
14921     * @param enable Whether to enable or disable the browsing history
14922     */
14923    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14924
14925    /**
14926     * Sets the zoom level of the web object
14927     *
14928     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14929     * values meaning zoom in and lower meaning zoom out. This function will
14930     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14931     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14932     *
14933     * @param obj The web object
14934     * @param zoom The zoom level to set
14935     */
14936    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14937
14938    /**
14939     * Gets the current zoom level set on the web object
14940     *
14941     * Note that this is the zoom level set on the web object and not that
14942     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14943     * the two zoom levels should match, but for the other two modes the
14944     * Webkit zoom is calculated internally to match the chosen mode without
14945     * changing the zoom level set for the web object.
14946     *
14947     * @param obj The web object
14948     *
14949     * @return The zoom level set on the object
14950     */
14951    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14952
14953    /**
14954     * Sets the zoom mode to use
14955     *
14956     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14957     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14958     *
14959     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14960     * with the elm_web_zoom_set() function.
14961     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14962     * make sure the entirety of the web object's contents are shown.
14963     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14964     * fit the contents in the web object's size, without leaving any space
14965     * unused.
14966     *
14967     * @param obj The web object
14968     * @param mode The mode to set
14969     */
14970    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14971
14972    /**
14973     * Gets the currently set zoom mode
14974     *
14975     * @param obj The web object
14976     *
14977     * @return The current zoom mode set for the object, or
14978     * ::ELM_WEB_ZOOM_MODE_LAST on error
14979     */
14980    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14981
14982    /**
14983     * Shows the given region in the web object
14984     *
14985     * @param obj The web object
14986     * @param x The x coordinate of the region to show
14987     * @param y The y coordinate of the region to show
14988     * @param w The width of the region to show
14989     * @param h The height of the region to show
14990     */
14991    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14992
14993    /**
14994     * Brings in the region to the visible area
14995     *
14996     * Like elm_web_region_show(), but it animates the scrolling of the object
14997     * to show the area
14998     *
14999     * @param obj The web object
15000     * @param x The x coordinate of the region to show
15001     * @param y The y coordinate of the region to show
15002     * @param w The width of the region to show
15003     * @param h The height of the region to show
15004     */
15005    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
15006
15007    /**
15008     * Sets the default dialogs to use an Inwin instead of a normal window
15009     *
15010     * If set, then the default implementation for the JavaScript dialogs and
15011     * file selector will be opened in an Inwin. Otherwise they will use a
15012     * normal separated window.
15013     *
15014     * @param obj The web object
15015     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
15016     */
15017    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
15018
15019    /**
15020     * Gets whether Inwin mode is set for the current object
15021     *
15022     * @param obj The web object
15023     *
15024     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
15025     */
15026    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
15027
15028    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
15029    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
15030    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);
15031    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
15032
15033    /**
15034     * @}
15035     */
15036
15037    /**
15038     * @defgroup Hoversel Hoversel
15039     *
15040     * @image html img/widget/hoversel/preview-00.png
15041     * @image latex img/widget/hoversel/preview-00.eps
15042     *
15043     * A hoversel is a button that pops up a list of items (automatically
15044     * choosing the direction to display) that have a label and, optionally, an
15045     * icon to select from. It is a convenience widget to avoid the need to do
15046     * all the piecing together yourself. It is intended for a small number of
15047     * items in the hoversel menu (no more than 8), though is capable of many
15048     * more.
15049     *
15050     * Signals that you can add callbacks for are:
15051     * "clicked" - the user clicked the hoversel button and popped up the sel
15052     * "selected" - an item in the hoversel list is selected. event_info is the item
15053     * "dismissed" - the hover is dismissed
15054     *
15055     * Default contents parts of the hoversel widget that you can use for are:
15056     * @li "icon" - An icon of the hoversel
15057     * 
15058     * Default text parts of the hoversel widget that you can use for are:
15059     * @li "default" - Label of the hoversel
15060     *  
15061     * Supported elm_object common APIs.
15062     * @li elm_object_disabled_set
15063     * @li elm_object_text_set
15064     * @li elm_object_part_text_set
15065     * @li elm_object_text_get
15066     * @li elm_object_part_text_get
15067     * @li elm_object_content_set
15068     * @li elm_object_part_content_set
15069     * @li elm_object_content_unset
15070     * @li elm_object_part_content_unset
15071     *
15072     * Supported elm_object_item common APIs.
15073     * @li elm_object_item_text_get
15074     * @li elm_object_item_part_text_get
15075     *
15076     * See @ref tutorial_hoversel for an example.
15077     * @{
15078     */
15079
15080    /**
15081     * @brief Add a new Hoversel object
15082     *
15083     * @param parent The parent object
15084     * @return The new object or NULL if it cannot be created
15085     */
15086    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15087
15088    /**
15089     * @brief This sets the hoversel to expand horizontally.
15090     *
15091     * @param obj The hoversel object
15092     * @param horizontal If true, the hover will expand horizontally to the
15093     * right.
15094     *
15095     * @note The initial button will display horizontally regardless of this
15096     * setting.
15097     */
15098    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15099
15100    /**
15101     * @brief This returns whether the hoversel is set to expand horizontally.
15102     *
15103     * @param obj The hoversel object
15104     * @return If true, the hover will expand horizontally to the right.
15105     *
15106     * @see elm_hoversel_horizontal_set()
15107     */
15108    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15109
15110    /**
15111     * @brief Set the Hover parent
15112     *
15113     * @param obj The hoversel object
15114     * @param parent The parent to use
15115     *
15116     * Sets the hover parent object, the area that will be darkened when the
15117     * hoversel is clicked. Should probably be the window that the hoversel is
15118     * in. See @ref Hover objects for more information.
15119     */
15120    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15121    /**
15122     * @brief Get the Hover parent
15123     *
15124     * @param obj The hoversel object
15125     * @return The used parent
15126     *
15127     * Gets the hover parent object.
15128     *
15129     * @see elm_hoversel_hover_parent_set()
15130     */
15131    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15132
15133    /**
15134     * @brief Set the hoversel button label
15135     *
15136     * @param obj The hoversel object
15137     * @param label The label text.
15138     *
15139     * This sets the label of the button that is always visible (before it is
15140     * clicked and expanded).
15141     *
15142     * @deprecated elm_object_text_set()
15143     */
15144    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15145
15146    /**
15147     * @brief Get the hoversel button label
15148     *
15149     * @param obj The hoversel object
15150     * @return The label text.
15151     *
15152     * @deprecated elm_object_text_get()
15153     */
15154    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15155
15156    /**
15157     * @brief Set the icon of the hoversel button
15158     *
15159     * @param obj The hoversel object
15160     * @param icon The icon object
15161     *
15162     * Sets the icon of the button that is always visible (before it is clicked
15163     * and expanded).  Once the icon object is set, a previously set one will be
15164     * deleted, if you want to keep that old content object, use the
15165     * elm_hoversel_icon_unset() function.
15166     *
15167     * @see elm_object_content_set() for the button widget
15168     * @deprecated Use elm_object_item_part_content_set() instead
15169     */
15170    EINA_DEPRECATED EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15171
15172    /**
15173     * @brief Get the icon of the hoversel button
15174     *
15175     * @param obj The hoversel object
15176     * @return The icon object
15177     *
15178     * Get the icon of the button that is always visible (before it is clicked
15179     * and expanded). Also see elm_object_content_get() for the button widget.
15180     *
15181     * @see elm_hoversel_icon_set()
15182     * @deprecated Use elm_object_item_part_content_get() instead
15183     */
15184    EINA_DEPRECATED EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15185
15186    /**
15187     * @brief Get and unparent the icon of the hoversel button
15188     *
15189     * @param obj The hoversel object
15190     * @return The icon object that was being used
15191     *
15192     * Unparent and return the icon of the button that is always visible
15193     * (before it is clicked and expanded).
15194     *
15195     * @see elm_hoversel_icon_set()
15196     * @see elm_object_content_unset() for the button widget
15197     * @deprecated Use elm_object_item_part_content_unset() instead
15198     */
15199    EINA_DEPRECATED EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15200
15201    /**
15202     * @brief This triggers the hoversel popup from code, the same as if the user
15203     * had clicked the button.
15204     *
15205     * @param obj The hoversel object
15206     */
15207    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
15208
15209    /**
15210     * @brief This dismisses the hoversel popup as if the user had clicked
15211     * outside the hover.
15212     *
15213     * @param obj The hoversel object
15214     */
15215    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
15216
15217    /**
15218     * @brief Returns whether the hoversel is expanded.
15219     *
15220     * @param obj The hoversel object
15221     * @return  This will return EINA_TRUE if the hoversel is expanded or
15222     * EINA_FALSE if it is not expanded.
15223     */
15224    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15225
15226    /**
15227     * @brief This will remove all the children items from the hoversel.
15228     *
15229     * @param obj The hoversel object
15230     *
15231     * @warning Should @b not be called while the hoversel is active; use
15232     * elm_hoversel_expanded_get() to check first.
15233     *
15234     * @see elm_hoversel_item_del_cb_set()
15235     * @see elm_hoversel_item_del()
15236     */
15237    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15238
15239    /**
15240     * @brief Get the list of items within the given hoversel.
15241     *
15242     * @param obj The hoversel object
15243     * @return Returns a list of Elm_Object_Item*
15244     *
15245     * @see elm_hoversel_item_add()
15246     */
15247    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15248
15249    /**
15250     * @brief Add an item to the hoversel button
15251     *
15252     * @param obj The hoversel object
15253     * @param label The text label to use for the item (NULL if not desired)
15254     * @param icon_file An image file path on disk to use for the icon or standard
15255     * icon name (NULL if not desired)
15256     * @param icon_type The icon type if relevant
15257     * @param func Convenience function to call when this item is selected
15258     * @param data Data to pass to item-related functions
15259     * @return A handle to the item added.
15260     *
15261     * This adds an item to the hoversel to show when it is clicked. Note: if you
15262     * need to use an icon from an edje file then use
15263     * elm_hoversel_item_icon_set() right after the this function, and set
15264     * icon_file to NULL here.
15265     *
15266     * For more information on what @p icon_file and @p icon_type are see the
15267     * @ref Icon "icon documentation".
15268     */
15269    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);
15270
15271    /**
15272     * @brief Delete an item from the hoversel
15273     *
15274     * @param it The item to delete
15275     *
15276     * This deletes the item from the hoversel (should not be called while the
15277     * hoversel is active; use elm_hoversel_expanded_get() to check first).
15278     *
15279     * @see elm_hoversel_item_add()
15280     * @see elm_hoversel_item_del_cb_set()
15281     */
15282    EAPI void               elm_hoversel_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15283
15284    /**
15285     * @brief Set the function to be called when an item from the hoversel is
15286     * freed.
15287     *
15288     * @param item The item to set the callback on
15289     * @param func The function called
15290     *
15291     * That function will receive these parameters:
15292     * @li void * item data
15293     * @li Evas_Object * hoversel object
15294     * @li Elm_Object_Item * hoversel item
15295     *
15296     * @see elm_hoversel_item_add()
15297     */
15298    EAPI void               elm_hoversel_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15299
15300    /**
15301     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
15302     * that will be passed to associated function callbacks.
15303     *
15304     * @param it The item to get the data from
15305     * @return The data pointer set with elm_hoversel_item_add()
15306     *
15307     * @see elm_hoversel_item_add()
15308     * @deprecated Use elm_object_item_data_get() instead
15309     */
15310    EINA_DEPRECATED EAPI void              *elm_hoversel_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15311
15312    /**
15313     * @brief This returns the label text of the given hoversel item.
15314     *
15315     * @param it The item to get the label
15316     * @return The label text of the hoversel item
15317     *
15318     * @see elm_hoversel_item_add()
15319     * @deprecated Use elm_object_item_text_get() instead
15320     */
15321    EINA_DEPRECATED EAPI const char        *elm_hoversel_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15322
15323    /**
15324     * @brief This sets the icon for the given hoversel item.
15325     *
15326     * @param item The item to set the icon
15327     * @param icon_file An image file path on disk to use for the icon or standard
15328     * icon name
15329     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
15330     * to NULL if the icon is not an edje file
15331     * @param icon_type The icon type
15332     *
15333     * The icon can be loaded from the standard set, from an image file, or from
15334     * an edje file.
15335     *
15336     * @see elm_hoversel_item_add()
15337     */
15338    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);
15339
15340    /**
15341     * @brief Get the icon object of the hoversel item
15342     *
15343     * @param item The item to get the icon from
15344     * @param icon_file The image file path on disk used for the icon or standard
15345     * icon name
15346     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
15347     * if the icon is not an edje file
15348     * @param icon_type The icon type
15349     *
15350     * @see elm_hoversel_item_icon_set()
15351     * @see elm_hoversel_item_add()
15352     */
15353    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);
15354
15355    /**
15356     * @}
15357     */
15358
15359    /**
15360     * @defgroup Toolbar Toolbar
15361     * @ingroup Elementary
15362     *
15363     * @image html img/widget/toolbar/preview-00.png
15364     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
15365     *
15366     * @image html img/toolbar.png
15367     * @image latex img/toolbar.eps width=\textwidth
15368     *
15369     * A toolbar is a widget that displays a list of items inside
15370     * a box. It can be scrollable, show a menu with items that don't fit
15371     * to toolbar size or even crop them.
15372     *
15373     * Only one item can be selected at a time.
15374     *
15375     * Items can have multiple states, or show menus when selected by the user.
15376     *
15377     * Smart callbacks one can listen to:
15378     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
15379     * - "language,changed" - when the program language changes
15380     *
15381     * Available styles for it:
15382     * - @c "default"
15383     * - @c "transparent" - no background or shadow, just show the content
15384     *
15385     * Default text parts of the toolbar items that you can use for are:
15386     * @li "default" - label of the toolbar item
15387     *  
15388     * Supported elm_object_item common APIs.
15389     * @li elm_object_item_disabled_set
15390     * @li elm_object_item_text_set
15391     * @li elm_object_item_part_text_set
15392     * @li elm_object_item_text_get
15393     * @li elm_object_item_part_text_get
15394     *
15395     * List of examples:
15396     * @li @ref toolbar_example_01
15397     * @li @ref toolbar_example_02
15398     * @li @ref toolbar_example_03
15399     */
15400
15401    /**
15402     * @addtogroup Toolbar
15403     * @{
15404     */
15405
15406    /**
15407     * @enum _Elm_Toolbar_Shrink_Mode
15408     * @typedef Elm_Toolbar_Shrink_Mode
15409     *
15410     * Set toolbar's items display behavior, it can be scrollabel,
15411     * show a menu with exceeding items, or simply hide them.
15412     *
15413     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
15414     * from elm config.
15415     *
15416     * Values <b> don't </b> work as bitmask, only one can be choosen.
15417     *
15418     * @see elm_toolbar_mode_shrink_set()
15419     * @see elm_toolbar_mode_shrink_get()
15420     *
15421     * @ingroup Toolbar
15422     */
15423    typedef enum _Elm_Toolbar_Shrink_Mode
15424      {
15425         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
15426         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
15427         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
15428         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
15429         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
15430      } Elm_Toolbar_Shrink_Mode;
15431
15432    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(). */
15433
15434    /**
15435     * Add a new toolbar widget to the given parent Elementary
15436     * (container) object.
15437     *
15438     * @param parent The parent object.
15439     * @return a new toolbar widget handle or @c NULL, on errors.
15440     *
15441     * This function inserts a new toolbar widget on the canvas.
15442     *
15443     * @ingroup Toolbar
15444     */
15445    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15446
15447    /**
15448     * Set the icon size, in pixels, to be used by toolbar items.
15449     *
15450     * @param obj The toolbar object
15451     * @param icon_size The icon size in pixels
15452     *
15453     * @note Default value is @c 32. It reads value from elm config.
15454     *
15455     * @see elm_toolbar_icon_size_get()
15456     *
15457     * @ingroup Toolbar
15458     */
15459    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
15460
15461    /**
15462     * Get the icon size, in pixels, to be used by toolbar items.
15463     *
15464     * @param obj The toolbar object.
15465     * @return The icon size in pixels.
15466     *
15467     * @see elm_toolbar_icon_size_set() for details.
15468     *
15469     * @ingroup Toolbar
15470     */
15471    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15472
15473    /**
15474     * Sets icon lookup order, for toolbar items' icons.
15475     *
15476     * @param obj The toolbar object.
15477     * @param order The icon lookup order.
15478     *
15479     * Icons added before calling this function will not be affected.
15480     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
15481     *
15482     * @see elm_toolbar_icon_order_lookup_get()
15483     *
15484     * @ingroup Toolbar
15485     */
15486    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
15487
15488    /**
15489     * Gets the icon lookup order.
15490     *
15491     * @param obj The toolbar object.
15492     * @return The icon lookup order.
15493     *
15494     * @see elm_toolbar_icon_order_lookup_set() for details.
15495     *
15496     * @ingroup Toolbar
15497     */
15498    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15499
15500    /**
15501     * Set whether the toolbar should always have an item selected.
15502     *
15503     * @param obj The toolbar object.
15504     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
15505     * disable it.
15506     *
15507     * This will cause the toolbar to always have an item selected, and clicking
15508     * the selected item will not cause a selected event to be emitted. Enabling this mode
15509     * will immediately select the first toolbar item.
15510     *
15511     * Always-selected is disabled by default.
15512     *
15513     * @see elm_toolbar_always_select_mode_get().
15514     *
15515     * @ingroup Toolbar
15516     */
15517    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15518
15519    /**
15520     * Get whether the toolbar should always have an item selected.
15521     *
15522     * @param obj The toolbar object.
15523     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
15524     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
15525     *
15526     * @see elm_toolbar_always_select_mode_set() for details.
15527     *
15528     * @ingroup Toolbar
15529     */
15530    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15531
15532    /**
15533     * Set whether the toolbar items' should be selected by the user or not.
15534     *
15535     * @param obj The toolbar object.
15536     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
15537     * enable it.
15538     *
15539     * This will turn off the ability to select items entirely and they will
15540     * neither appear selected nor emit selected signals. The clicked
15541     * callback function will still be called.
15542     *
15543     * Selection is enabled by default.
15544     *
15545     * @see elm_toolbar_no_select_mode_get().
15546     *
15547     * @ingroup Toolbar
15548     */
15549    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
15550
15551    /**
15552     * Set whether the toolbar items' should be selected by the user or not.
15553     *
15554     * @param obj The toolbar object.
15555     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
15556     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
15557     *
15558     * @see elm_toolbar_no_select_mode_set() for details.
15559     *
15560     * @ingroup Toolbar
15561     */
15562    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15563
15564    /**
15565     * Append item to the toolbar.
15566     *
15567     * @param obj The toolbar object.
15568     * @param icon A string with icon name or the absolute path of an image file.
15569     * @param label The label of the item.
15570     * @param func The function to call when the item is clicked.
15571     * @param data The data to associate with the item for related callbacks.
15572     * @return The created item or @c NULL upon failure.
15573     *
15574     * A new item will be created and appended to the toolbar, i.e., will
15575     * be set as @b last item.
15576     *
15577     * Items created with this method can be deleted with
15578     * elm_toolbar_item_del().
15579     *
15580     * Associated @p data can be properly freed when item is deleted if a
15581     * callback function is set with elm_toolbar_item_del_cb_set().
15582     *
15583     * If a function is passed as argument, it will be called everytime this item
15584     * is selected, i.e., the user clicks over an unselected item.
15585     * If such function isn't needed, just passing
15586     * @c NULL as @p func is enough. The same should be done for @p data.
15587     *
15588     * Toolbar will load icon image from fdo or current theme.
15589     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15590     * If an absolute path is provided it will load it direct from a file.
15591     *
15592     * @see elm_toolbar_item_icon_set()
15593     * @see elm_toolbar_item_del()
15594     * @see elm_toolbar_item_del_cb_set()
15595     *
15596     * @ingroup Toolbar
15597     */
15598    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);
15599
15600    /**
15601     * Prepend item to the toolbar.
15602     *
15603     * @param obj The toolbar object.
15604     * @param icon A string with icon name or the absolute path of an image file.
15605     * @param label The label of the item.
15606     * @param func The function to call when the item is clicked.
15607     * @param data The data to associate with the item for related callbacks.
15608     * @return The created item or @c NULL upon failure.
15609     *
15610     * A new item will be created and prepended to the toolbar, i.e., will
15611     * be set as @b first item.
15612     *
15613     * Items created with this method can be deleted with
15614     * elm_toolbar_item_del().
15615     *
15616     * Associated @p data can be properly freed when item is deleted if a
15617     * callback function is set with elm_toolbar_item_del_cb_set().
15618     *
15619     * If a function is passed as argument, it will be called everytime this item
15620     * is selected, i.e., the user clicks over an unselected item.
15621     * If such function isn't needed, just passing
15622     * @c NULL as @p func is enough. The same should be done for @p data.
15623     *
15624     * Toolbar will load icon image from fdo or current theme.
15625     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15626     * If an absolute path is provided it will load it direct from a file.
15627     *
15628     * @see elm_toolbar_item_icon_set()
15629     * @see elm_toolbar_item_del()
15630     * @see elm_toolbar_item_del_cb_set()
15631     *
15632     * @ingroup Toolbar
15633     */
15634    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);
15635
15636    /**
15637     * Insert a new item into the toolbar object before item @p before.
15638     *
15639     * @param obj The toolbar object.
15640     * @param before The toolbar item to insert before.
15641     * @param icon A string with icon name or the absolute path of an image file.
15642     * @param label The label of the item.
15643     * @param func The function to call when the item is clicked.
15644     * @param data The data to associate with the item for related callbacks.
15645     * @return The created item or @c NULL upon failure.
15646     *
15647     * A new item will be created and added to the toolbar. Its position in
15648     * this toolbar will be just before item @p before.
15649     *
15650     * Items created with this method can be deleted with
15651     * elm_toolbar_item_del().
15652     *
15653     * Associated @p data can be properly freed when item is deleted if a
15654     * callback function is set with elm_toolbar_item_del_cb_set().
15655     *
15656     * If a function is passed as argument, it will be called everytime this item
15657     * is selected, i.e., the user clicks over an unselected item.
15658     * If such function isn't needed, just passing
15659     * @c NULL as @p func is enough. The same should be done for @p data.
15660     *
15661     * Toolbar will load icon image from fdo or current theme.
15662     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15663     * If an absolute path is provided it will load it direct from a file.
15664     *
15665     * @see elm_toolbar_item_icon_set()
15666     * @see elm_toolbar_item_del()
15667     * @see elm_toolbar_item_del_cb_set()
15668     *
15669     * @ingroup Toolbar
15670     */
15671    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);
15672
15673    /**
15674     * Insert a new item into the toolbar object after item @p after.
15675     *
15676     * @param obj The toolbar object.
15677     * @param after The toolbar item to insert after.
15678     * @param icon A string with icon name or the absolute path of an image file.
15679     * @param label The label of the item.
15680     * @param func The function to call when the item is clicked.
15681     * @param data The data to associate with the item for related callbacks.
15682     * @return The created item or @c NULL upon failure.
15683     *
15684     * A new item will be created and added to the toolbar. Its position in
15685     * this toolbar will be just after item @p after.
15686     *
15687     * Items created with this method can be deleted with
15688     * elm_toolbar_item_del().
15689     *
15690     * Associated @p data can be properly freed when item is deleted if a
15691     * callback function is set with elm_toolbar_item_del_cb_set().
15692     *
15693     * If a function is passed as argument, it will be called everytime this item
15694     * is selected, i.e., the user clicks over an unselected item.
15695     * If such function isn't needed, just passing
15696     * @c NULL as @p func is enough. The same should be done for @p data.
15697     *
15698     * Toolbar will load icon image from fdo or current theme.
15699     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15700     * If an absolute path is provided it will load it direct from a file.
15701     *
15702     * @see elm_toolbar_item_icon_set()
15703     * @see elm_toolbar_item_del()
15704     * @see elm_toolbar_item_del_cb_set()
15705     *
15706     * @ingroup Toolbar
15707     */
15708    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);
15709
15710    /**
15711     * Get the first item in the given toolbar widget's list of
15712     * items.
15713     *
15714     * @param obj The toolbar object
15715     * @return The first item or @c NULL, if it has no items (and on
15716     * errors)
15717     *
15718     * @see elm_toolbar_item_append()
15719     * @see elm_toolbar_last_item_get()
15720     *
15721     * @ingroup Toolbar
15722     */
15723    EAPI Elm_Object_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15724
15725    /**
15726     * Get the last item in the given toolbar widget's list of
15727     * items.
15728     *
15729     * @param obj The toolbar object
15730     * @return The last item or @c NULL, if it has no items (and on
15731     * errors)
15732     *
15733     * @see elm_toolbar_item_prepend()
15734     * @see elm_toolbar_first_item_get()
15735     *
15736     * @ingroup Toolbar
15737     */
15738    EAPI Elm_Object_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15739
15740    /**
15741     * Get the item after @p item in toolbar.
15742     *
15743     * @param it The toolbar item.
15744     * @return The item after @p item, or @c NULL if none or on failure.
15745     *
15746     * @note If it is the last item, @c NULL will be returned.
15747     *
15748     * @see elm_toolbar_item_append()
15749     *
15750     * @ingroup Toolbar
15751     */
15752    EAPI Elm_Object_Item       *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15753
15754    /**
15755     * Get the item before @p item in toolbar.
15756     *
15757     * @param item The toolbar item.
15758     * @return The item before @p item, or @c NULL if none or on failure.
15759     *
15760     * @note If it is the first item, @c NULL will be returned.
15761     *
15762     * @see elm_toolbar_item_prepend()
15763     *
15764     * @ingroup Toolbar
15765     */
15766    EAPI Elm_Object_Item       *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15767
15768    /**
15769     * Get the toolbar object from an item.
15770     *
15771     * @param it The item.
15772     * @return The toolbar object.
15773     *
15774     * This returns the toolbar object itself that an item belongs to.
15775     *
15776          * @deprecated use elm_object_item_object_get() instead.
15777     * @ingroup Toolbar
15778     */
15779    EINA_DEPRECATED EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15780
15781    /**
15782     * Set the priority of a toolbar item.
15783     *
15784     * @param it The toolbar item.
15785     * @param priority The item priority. The default is zero.
15786     *
15787     * This is used only when the toolbar shrink mode is set to
15788     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15789     * When space is less than required, items with low priority
15790     * will be removed from the toolbar and added to a dynamically-created menu,
15791     * while items with higher priority will remain on the toolbar,
15792     * with the same order they were added.
15793     *
15794     * @see elm_toolbar_item_priority_get()
15795     *
15796     * @ingroup Toolbar
15797     */
15798    EAPI void                    elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15799
15800    /**
15801     * Get the priority of a toolbar item.
15802     *
15803     * @param it The toolbar item.
15804     * @return The @p item priority, or @c 0 on failure.
15805     *
15806     * @see elm_toolbar_item_priority_set() for details.
15807     *
15808     * @ingroup Toolbar
15809     */
15810    EAPI int                     elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15811
15812    /**
15813     * Get the label of item.
15814     *
15815     * @param it The item of toolbar.
15816     * @return The label of item.
15817     *
15818     * The return value is a pointer to the label associated to @p item when
15819     * it was created, with function elm_toolbar_item_append() or similar,
15820     * or later,
15821     * with function elm_toolbar_item_label_set. If no label
15822     * was passed as argument, it will return @c NULL.
15823     *
15824     * @see elm_toolbar_item_label_set() for more details.
15825     * @see elm_toolbar_item_append()
15826     *
15827          * @deprecated use elm_object_item_text_get() instead.
15828     * @ingroup Toolbar
15829     */
15830    EINA_DEPRECATED EAPI const char             *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15831
15832    /**
15833     * Set the label of item.
15834     *
15835     * @param it The item of toolbar.
15836     * @param text The label of item.
15837     *
15838     * The label to be displayed by the item.
15839     * Label will be placed at icons bottom (if set).
15840     *
15841     * If a label was passed as argument on item creation, with function
15842     * elm_toolbar_item_append() or similar, it will be already
15843     * displayed by the item.
15844     *
15845     * @see elm_toolbar_item_label_get()
15846     * @see elm_toolbar_item_append()
15847     *
15848          * @deprecated use elm_object_item_text_set() instead
15849     * @ingroup Toolbar
15850     */
15851    EINA_DEPRECATED EAPI void                    elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15852
15853    /**
15854     * Return the data associated with a given toolbar widget item.
15855     *
15856     * @param it The toolbar widget item handle.
15857     * @return The data associated with @p item.
15858     *
15859     * @see elm_toolbar_item_data_set()
15860     *
15861     * @deprecated use elm_object_item_data_get() instead.
15862     * @ingroup Toolbar
15863     */
15864    EINA_DEPRECATED EAPI void                   *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15865
15866    /**
15867     * Set the data associated with a given toolbar widget item.
15868     *
15869     * @param it The toolbar widget item handle
15870     * @param data The new data pointer to set to @p item.
15871     *
15872     * This sets new item data on @p item.
15873     *
15874     * @warning The old data pointer won't be touched by this function, so
15875     * the user had better to free that old data himself/herself.
15876     *
15877     * @deprecated use elm_object_item_data_set() instead.
15878     * @ingroup Toolbar
15879     */
15880    EINA_DEPRECATED EAPI void                    elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15881
15882    /**
15883     * Returns a pointer to a toolbar item by its label.
15884     *
15885     * @param obj The toolbar object.
15886     * @param label The label of the item to find.
15887     *
15888     * @return The pointer to the toolbar item matching @p label or @c NULL
15889     * on failure.
15890     *
15891     * @ingroup Toolbar
15892     */
15893    EAPI Elm_Object_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15894
15895    /*
15896     * Get whether the @p item is selected or not.
15897     *
15898     * @param it The toolbar item.
15899     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15900     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15901     *
15902     * @see elm_toolbar_selected_item_set() for details.
15903     * @see elm_toolbar_item_selected_get()
15904     *
15905     * @ingroup Toolbar
15906     */
15907    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15908
15909    /**
15910     * Set the selected state of an item.
15911     *
15912     * @param it The toolbar item
15913     * @param selected The selected state
15914     *
15915     * This sets the selected state of the given item @p it.
15916     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15917     *
15918     * If a new item is selected the previosly selected will be unselected.
15919     * Previoulsy selected item can be get with function
15920     * elm_toolbar_selected_item_get().
15921     *
15922     * Selected items will be highlighted.
15923     *
15924     * @see elm_toolbar_item_selected_get()
15925     * @see elm_toolbar_selected_item_get()
15926     *
15927     * @ingroup Toolbar
15928     */
15929    EAPI void                    elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15930
15931    /**
15932     * Get the selected item.
15933     *
15934     * @param obj The toolbar object.
15935     * @return The selected toolbar item.
15936     *
15937     * The selected item can be unselected with function
15938     * elm_toolbar_item_selected_set().
15939     *
15940     * The selected item always will be highlighted on toolbar.
15941     *
15942     * @see elm_toolbar_selected_items_get()
15943     *
15944     * @ingroup Toolbar
15945     */
15946    EAPI Elm_Object_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15947
15948    /**
15949     * Set the icon associated with @p item.
15950     *
15951     * @param obj The parent of this item.
15952     * @param it The toolbar item.
15953     * @param icon A string with icon name or the absolute path of an image file.
15954     *
15955     * Toolbar will load icon image from fdo or current theme.
15956     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15957     * If an absolute path is provided it will load it direct from a file.
15958     *
15959     * @see elm_toolbar_icon_order_lookup_set()
15960     * @see elm_toolbar_icon_order_lookup_get()
15961     *
15962     * @ingroup Toolbar
15963     */
15964    EAPI void                    elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15965
15966    /**
15967     * Get the string used to set the icon of @p item.
15968     *
15969     * @param it The toolbar item.
15970     * @return The string associated with the icon object.
15971     *
15972     * @see elm_toolbar_item_icon_set() for details.
15973     *
15974     * @ingroup Toolbar
15975     */
15976    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15977
15978    /**
15979     * Get the object of @p item.
15980     *
15981     * @param it The toolbar item.
15982     * @return The object
15983     *
15984     * @ingroup Toolbar
15985     */
15986    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15987
15988    /**
15989     * Get the icon object of @p item.
15990     *
15991     * @param it The toolbar item.
15992     * @return The icon object
15993     *
15994     * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
15995     * or elm_toolbar_item_icon_memfile_set() for details.
15996     *
15997     * @ingroup Toolbar
15998     */
15999    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16000
16001    /**
16002     * Set the icon associated with @p item to an image in a binary buffer.
16003     *
16004     * @param it The toolbar item.
16005     * @param img The binary data that will be used as an image
16006     * @param size The size of binary data @p img
16007     * @param format Optional format of @p img to pass to the image loader
16008     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16009     *
16010     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16011     *
16012     * @note The icon image set by this function can be changed by
16013     * elm_toolbar_item_icon_set().
16014     *
16015     * @ingroup Toolbar
16016     */
16017    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);
16018
16019    /**
16020     * Set the icon associated with @p item to an image in a binary buffer.
16021     *
16022     * @param it The toolbar item.
16023     * @param file The file that contains the image
16024     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16025     *
16026     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16027     *
16028     * @note The icon image set by this function can be changed by
16029     * elm_toolbar_item_icon_set().
16030     *
16031     * @ingroup Toolbar
16032     */
16033    EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
16034
16035    /**
16036     * Delete them item from the toolbar.
16037     *
16038     * @param it The item of toolbar to be deleted.
16039     *
16040     * @see elm_toolbar_item_append()
16041     * @see elm_toolbar_item_del_cb_set()
16042     *
16043     * @ingroup Toolbar
16044     */
16045    EAPI void                    elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16046
16047    /**
16048     * Set the function called when a toolbar item is freed.
16049     *
16050     * @param it The item to set the callback on.
16051     * @param func The function called.
16052     *
16053     * If there is a @p func, then it will be called prior item's memory release.
16054     * That will be called with the following arguments:
16055     * @li item's data;
16056     * @li item's Evas object;
16057     * @li item itself;
16058     *
16059     * This way, a data associated to a toolbar item could be properly freed.
16060     *
16061     * @ingroup Toolbar
16062     */
16063    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16064
16065    /**
16066     * Get a value whether toolbar item is disabled or not.
16067     *
16068     * @param it The item.
16069     * @return The disabled state.
16070     *
16071     * @see elm_toolbar_item_disabled_set() for more details.
16072     *
16073     * @deprecated use elm_object_item_disabled_get() instead.
16074     * @ingroup Toolbar
16075     */
16076    EINA_DEPRECATED EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16077
16078    /**
16079     * Sets the disabled/enabled state of a toolbar item.
16080     *
16081     * @param it The item.
16082     * @param disabled The disabled state.
16083     *
16084     * A disabled item cannot be selected or unselected. It will also
16085     * change its appearance (generally greyed out). This sets the
16086     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16087     * enabled).
16088     *
16089     * @deprecated use elm_object_item_disabled_set() instead.
16090     * @ingroup Toolbar
16091     */
16092    EINA_DEPRECATED EAPI void                    elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16093
16094    /**
16095     * Set or unset item as a separator.
16096     *
16097     * @param it The toolbar item.
16098     * @param setting @c EINA_TRUE to set item @p item as separator or
16099     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16100     *
16101     * Items aren't set as separator by default.
16102     *
16103     * If set as separator it will display separator theme, so won't display
16104     * icons or label.
16105     *
16106     * @see elm_toolbar_item_separator_get()
16107     *
16108     * @ingroup Toolbar
16109     */
16110    EAPI void                    elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
16111
16112    /**
16113     * Get a value whether item is a separator or not.
16114     *
16115     * @param it The toolbar item.
16116     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16117     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16118     *
16119     * @see elm_toolbar_item_separator_set() for details.
16120     *
16121     * @ingroup Toolbar
16122     */
16123    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16124
16125    /**
16126     * Set the shrink state of toolbar @p obj.
16127     *
16128     * @param obj The toolbar object.
16129     * @param shrink_mode Toolbar's items display behavior.
16130     *
16131     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
16132     * but will enforce a minimun size so all the items will fit, won't scroll
16133     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
16134     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
16135     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
16136     *
16137     * @ingroup Toolbar
16138     */
16139    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
16140
16141    /**
16142     * Get the shrink mode of toolbar @p obj.
16143     *
16144     * @param obj The toolbar object.
16145     * @return Toolbar's items display behavior.
16146     *
16147     * @see elm_toolbar_mode_shrink_set() for details.
16148     *
16149     * @ingroup Toolbar
16150     */
16151    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16152
16153    /**
16154     * Enable/disable homogeneous mode.
16155     *
16156     * @param obj The toolbar object
16157     * @param homogeneous Assume the items within the toolbar are of the
16158     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
16159     *
16160     * This will enable the homogeneous mode where items are of the same size.
16161     * @see elm_toolbar_homogeneous_get()
16162     *
16163     * @ingroup Toolbar
16164     */
16165    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16166
16167    /**
16168     * Get whether the homogeneous mode is enabled.
16169     *
16170     * @param obj The toolbar object.
16171     * @return Assume the items within the toolbar are of the same height
16172     * and width (EINA_TRUE = on, EINA_FALSE = off).
16173     *
16174     * @see elm_toolbar_homogeneous_set()
16175     *
16176     * @ingroup Toolbar
16177     */
16178    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16179
16180    /**
16181     * Set the parent object of the toolbar items' menus.
16182     *
16183     * @param obj The toolbar object.
16184     * @param parent The parent of the menu objects.
16185     *
16186     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
16187     *
16188     * For more details about setting the parent for toolbar menus, see
16189     * elm_menu_parent_set().
16190     *
16191     * @see elm_menu_parent_set() for details.
16192     * @see elm_toolbar_item_menu_set() for details.
16193     *
16194     * @ingroup Toolbar
16195     */
16196    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16197
16198    /**
16199     * Get the parent object of the toolbar items' menus.
16200     *
16201     * @param obj The toolbar object.
16202     * @return The parent of the menu objects.
16203     *
16204     * @see elm_toolbar_menu_parent_set() for details.
16205     *
16206     * @ingroup Toolbar
16207     */
16208    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16209
16210    /**
16211     * Set the alignment of the items.
16212     *
16213     * @param obj The toolbar object.
16214     * @param align The new alignment, a float between <tt> 0.0 </tt>
16215     * and <tt> 1.0 </tt>.
16216     *
16217     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
16218     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
16219     * items.
16220     *
16221     * Centered items by default.
16222     *
16223     * @see elm_toolbar_align_get()
16224     *
16225     * @ingroup Toolbar
16226     */
16227    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
16228
16229    /**
16230     * Get the alignment of the items.
16231     *
16232     * @param obj The toolbar object.
16233     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
16234     * <tt> 1.0 </tt>.
16235     *
16236     * @see elm_toolbar_align_set() for details.
16237     *
16238     * @ingroup Toolbar
16239     */
16240    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16241
16242    /**
16243     * Set whether the toolbar item opens a menu.
16244     *
16245     * @param it The toolbar item.
16246     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
16247     *
16248     * A toolbar item can be set to be a menu, using this function.
16249     *
16250     * Once it is set to be a menu, it can be manipulated through the
16251     * menu-like function elm_toolbar_menu_parent_set() and the other
16252     * elm_menu functions, using the Evas_Object @c menu returned by
16253     * elm_toolbar_item_menu_get().
16254     *
16255     * So, items to be displayed in this item's menu should be added with
16256     * elm_menu_item_add().
16257     *
16258     * The following code exemplifies the most basic usage:
16259     * @code
16260     * tb = elm_toolbar_add(win)
16261     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
16262     * elm_toolbar_item_menu_set(item, EINA_TRUE);
16263     * elm_toolbar_menu_parent_set(tb, win);
16264     * menu = elm_toolbar_item_menu_get(item);
16265     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
16266     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
16267     * NULL);
16268     * @endcode
16269     *
16270     * @see elm_toolbar_item_menu_get()
16271     *
16272     * @ingroup Toolbar
16273     */
16274    EAPI void                    elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
16275
16276    /**
16277     * Get toolbar item's menu.
16278     *
16279     * @param it The toolbar item.
16280     * @return Item's menu object or @c NULL on failure.
16281     *
16282     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
16283     * this function will set it.
16284     *
16285     * @see elm_toolbar_item_menu_set() for details.
16286     *
16287     * @ingroup Toolbar
16288     */
16289    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16290
16291    /**
16292     * Add a new state to @p item.
16293     *
16294     * @param it The toolbar item.
16295     * @param icon A string with icon name or the absolute path of an image file.
16296     * @param label The label of the new state.
16297     * @param func The function to call when the item is clicked when this
16298     * state is selected.
16299     * @param data The data to associate with the state.
16300     * @return The toolbar item state, or @c NULL upon failure.
16301     *
16302     * Toolbar will load icon image from fdo or current theme.
16303     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
16304     * If an absolute path is provided it will load it direct from a file.
16305     *
16306     * States created with this function can be removed with
16307     * elm_toolbar_item_state_del().
16308     *
16309     * @see elm_toolbar_item_state_del()
16310     * @see elm_toolbar_item_state_sel()
16311     * @see elm_toolbar_item_state_get()
16312     *
16313     * @ingroup Toolbar
16314     */
16315    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);
16316
16317    /**
16318     * Delete a previoulsy added state to @p item.
16319     *
16320     * @param it The toolbar item.
16321     * @param state The state to be deleted.
16322     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16323     *
16324     * @see elm_toolbar_item_state_add()
16325     */
16326    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16327
16328    /**
16329     * Set @p state as the current state of @p it.
16330     *
16331     * @param it The toolbar item.
16332     * @param state The state to use.
16333     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16334     *
16335     * If @p state is @c NULL, it won't select any state and the default item's
16336     * icon and label will be used. It's the same behaviour than
16337     * elm_toolbar_item_state_unser().
16338     *
16339     * @see elm_toolbar_item_state_unset()
16340     *
16341     * @ingroup Toolbar
16342     */
16343    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16344
16345    /**
16346     * Unset the state of @p it.
16347     *
16348     * @param it The toolbar item.
16349     *
16350     * The default icon and label from this item will be displayed.
16351     *
16352     * @see elm_toolbar_item_state_set() for more details.
16353     *
16354     * @ingroup Toolbar
16355     */
16356    EAPI void                    elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16357
16358    /**
16359     * Get the current state of @p it.
16360     *
16361     * @param it The toolbar item.
16362     * @return The selected state or @c NULL if none is selected or on failure.
16363     *
16364     * @see elm_toolbar_item_state_set() for details.
16365     * @see elm_toolbar_item_state_unset()
16366     * @see elm_toolbar_item_state_add()
16367     *
16368     * @ingroup Toolbar
16369     */
16370    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16371
16372    /**
16373     * Get the state after selected state in toolbar's @p item.
16374     *
16375     * @param it The toolbar item to change state.
16376     * @return The state after current state, or @c NULL on failure.
16377     *
16378     * If last state is selected, this function will return first state.
16379     *
16380     * @see elm_toolbar_item_state_set()
16381     * @see elm_toolbar_item_state_add()
16382     *
16383     * @ingroup Toolbar
16384     */
16385    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16386
16387    /**
16388     * Get the state before selected state in toolbar's @p item.
16389     *
16390     * @param it The toolbar item to change state.
16391     * @return The state before current state, or @c NULL on failure.
16392     *
16393     * If first state is selected, this function will return last state.
16394     *
16395     * @see elm_toolbar_item_state_set()
16396     * @see elm_toolbar_item_state_add()
16397     *
16398     * @ingroup Toolbar
16399     */
16400    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16401
16402    /**
16403     * Set the text to be shown in a given toolbar item's tooltips.
16404     *
16405     * @param it toolbar item.
16406     * @param text The text to set in the content.
16407     *
16408     * Setup the text as tooltip to object. The item can have only one tooltip,
16409     * so any previous tooltip data - set with this function or
16410     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
16411     *
16412     * @see elm_object_tooltip_text_set() for more details.
16413     *
16414     * @ingroup Toolbar
16415     */
16416    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
16417
16418    /**
16419     * Set the content to be shown in the tooltip item.
16420     *
16421     * Setup the tooltip to item. The item can have only one tooltip,
16422     * so any previous tooltip data is removed. @p func(with @p data) will
16423     * be called every time that need show the tooltip and it should
16424     * return a valid Evas_Object. This object is then managed fully by
16425     * tooltip system and is deleted when the tooltip is gone.
16426     *
16427     * @param it the toolbar item being attached a tooltip.
16428     * @param func the function used to create the tooltip contents.
16429     * @param data what to provide to @a func as callback data/context.
16430     * @param del_cb called when data is not needed anymore, either when
16431     *        another callback replaces @a func, the tooltip is unset with
16432     *        elm_toolbar_item_tooltip_unset() or the owner @a item
16433     *        dies. This callback receives as the first parameter the
16434     *        given @a data, and @c event_info is the item.
16435     *
16436     * @see elm_object_tooltip_content_cb_set() for more details.
16437     *
16438     * @ingroup Toolbar
16439     */
16440    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);
16441
16442    /**
16443     * Unset tooltip from item.
16444     *
16445     * @param it toolbar item to remove previously set tooltip.
16446     *
16447     * Remove tooltip from item. The callback provided as del_cb to
16448     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
16449     * it is not used anymore.
16450     *
16451     * @see elm_object_tooltip_unset() for more details.
16452     * @see elm_toolbar_item_tooltip_content_cb_set()
16453     *
16454     * @ingroup Toolbar
16455     */
16456    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16457
16458    /**
16459     * Sets a different style for this item tooltip.
16460     *
16461     * @note before you set a style you should define a tooltip with
16462     *       elm_toolbar_item_tooltip_content_cb_set() or
16463     *       elm_toolbar_item_tooltip_text_set()
16464     *
16465     * @param it toolbar item with tooltip already set.
16466     * @param style the theme style to use (default, transparent, ...)
16467     *
16468     * @see elm_object_tooltip_style_set() for more details.
16469     *
16470     * @ingroup Toolbar
16471     */
16472    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16473
16474    /**
16475     * Get the style for this item tooltip.
16476     *
16477     * @param it toolbar item with tooltip already set.
16478     * @return style the theme style in use, defaults to "default". If the
16479     *         object does not have a tooltip set, then NULL is returned.
16480     *
16481     * @see elm_object_tooltip_style_get() for more details.
16482     * @see elm_toolbar_item_tooltip_style_set()
16483     *
16484     * @ingroup Toolbar
16485     */
16486    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16487
16488    /**
16489     * Set the type of mouse pointer/cursor decoration to be shown,
16490     * when the mouse pointer is over the given toolbar widget item
16491     *
16492     * @param it toolbar item to customize cursor on
16493     * @param cursor the cursor type's name
16494     *
16495     * This function works analogously as elm_object_cursor_set(), but
16496     * here the cursor's changing area is restricted to the item's
16497     * area, and not the whole widget's. Note that that item cursors
16498     * have precedence over widget cursors, so that a mouse over an
16499     * item with custom cursor set will always show @b that cursor.
16500     *
16501     * If this function is called twice for an object, a previously set
16502     * cursor will be unset on the second call.
16503     *
16504     * @see elm_object_cursor_set()
16505     * @see elm_toolbar_item_cursor_get()
16506     * @see elm_toolbar_item_cursor_unset()
16507     *
16508     * @ingroup Toolbar
16509     */
16510    EAPI void             elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
16511
16512    /*
16513     * Get the type of mouse pointer/cursor decoration set to be shown,
16514     * when the mouse pointer is over the given toolbar widget item
16515     *
16516     * @param it toolbar item with custom cursor set
16517     * @return the cursor type's name or @c NULL, if no custom cursors
16518     * were set to @p item (and on errors)
16519     *
16520     * @see elm_object_cursor_get()
16521     * @see elm_toolbar_item_cursor_set()
16522     * @see elm_toolbar_item_cursor_unset()
16523     *
16524     * @ingroup Toolbar
16525     */
16526    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16527
16528    /**
16529     * Unset any custom mouse pointer/cursor decoration set to be
16530     * shown, when the mouse pointer is over the given toolbar widget
16531     * item, thus making it show the @b default cursor again.
16532     *
16533     * @param it a toolbar item
16534     *
16535     * Use this call to undo any custom settings on this item's cursor
16536     * decoration, bringing it back to defaults (no custom style set).
16537     *
16538     * @see elm_object_cursor_unset()
16539     * @see elm_toolbar_item_cursor_set()
16540     *
16541     * @ingroup Toolbar
16542     */
16543    EAPI void             elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16544
16545    /**
16546     * Set a different @b style for a given custom cursor set for a
16547     * toolbar item.
16548     *
16549     * @param it toolbar item with custom cursor set
16550     * @param style the <b>theme style</b> to use (e.g. @c "default",
16551     * @c "transparent", etc)
16552     *
16553     * This function only makes sense when one is using custom mouse
16554     * cursor decorations <b>defined in a theme file</b>, which can have,
16555     * given a cursor name/type, <b>alternate styles</b> on it. It
16556     * works analogously as elm_object_cursor_style_set(), but here
16557     * applyed only to toolbar item objects.
16558     *
16559     * @warning Before you set a cursor style you should have definen a
16560     *       custom cursor previously on the item, with
16561     *       elm_toolbar_item_cursor_set()
16562     *
16563     * @see elm_toolbar_item_cursor_engine_only_set()
16564     * @see elm_toolbar_item_cursor_style_get()
16565     *
16566     * @ingroup Toolbar
16567     */
16568    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16569
16570    /**
16571     * Get the current @b style set for a given toolbar item's custom
16572     * cursor
16573     *
16574     * @param it toolbar item with custom cursor set.
16575     * @return style the cursor style in use. If the object does not
16576     *         have a cursor set, then @c NULL is returned.
16577     *
16578     * @see elm_toolbar_item_cursor_style_set() for more details
16579     *
16580     * @ingroup Toolbar
16581     */
16582    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16583
16584    /**
16585     * Set if the (custom)cursor for a given toolbar item should be
16586     * searched in its theme, also, or should only rely on the
16587     * rendering engine.
16588     *
16589     * @param it item with custom (custom) cursor already set on
16590     * @param engine_only Use @c EINA_TRUE to have cursors looked for
16591     * only on those provided by the rendering engine, @c EINA_FALSE to
16592     * have them searched on the widget's theme, as well.
16593     *
16594     * @note This call is of use only if you've set a custom cursor
16595     * for toolbar items, with elm_toolbar_item_cursor_set().
16596     *
16597     * @note By default, cursors will only be looked for between those
16598     * provided by the rendering engine.
16599     *
16600     * @ingroup Toolbar
16601     */
16602    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16603
16604    /**
16605     * Get if the (custom) cursor for a given toolbar item is being
16606     * searched in its theme, also, or is only relying on the rendering
16607     * engine.
16608     *
16609     * @param it a toolbar item
16610     * @return @c EINA_TRUE, if cursors are being looked for only on
16611     * those provided by the rendering engine, @c EINA_FALSE if they
16612     * are being searched on the widget's theme, as well.
16613     *
16614     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
16615     *
16616     * @ingroup Toolbar
16617     */
16618    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16619
16620    /**
16621     * Change a toolbar's orientation
16622     * @param obj The toolbar object
16623     * @param vertical If @c EINA_TRUE, the toolbar is vertical
16624     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16625     * @ingroup Toolbar
16626     * @deprecated use elm_toolbar_horizontal_set() instead.
16627     */
16628    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
16629
16630    /**
16631     * Change a toolbar's orientation
16632     * @param obj The toolbar object
16633     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
16634     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16635     * @ingroup Toolbar
16636     */
16637    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16638
16639    /**
16640     * Get a toolbar's orientation
16641     * @param obj The toolbar object
16642     * @return If @c EINA_TRUE, the toolbar is vertical
16643     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16644     * @ingroup Toolbar
16645     * @deprecated use elm_toolbar_horizontal_get() instead.
16646     */
16647    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16648
16649    /**
16650     * Get a toolbar's orientation
16651     * @param obj The toolbar object
16652     * @return If @c EINA_TRUE, the toolbar is horizontal
16653     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16654     * @ingroup Toolbar
16655     */
16656    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
16657
16658    /**
16659     * Get the number of items in a toolbar
16660     * @param obj The toolbar object
16661     * @return The number of items in @p obj toolbar
16662     * @ingroup Toolbar
16663     */
16664    EAPI unsigned int elm_toolbar_items_count(const Evas_Object *obj) EINA_ARG_NONNULL(1) EINA_PURE;
16665    /**
16666     * @}
16667     */
16668
16669    /**
16670     * @defgroup Tooltips Tooltips
16671     *
16672     * The Tooltip is an (internal, for now) smart object used to show a
16673     * content in a frame on mouse hover of objects(or widgets), with
16674     * tips/information about them.
16675     *
16676     * @{
16677     */
16678
16679    EAPI double       elm_tooltip_delay_get(void);
16680    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
16681    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
16682    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
16683    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
16684    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
16685 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
16686    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);
16687    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16688    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16689    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16690    EAPI Eina_Bool    elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
16691    EAPI Eina_Bool    elm_object_tooltip_window_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16692
16693    /**
16694     * @}
16695     */
16696
16697    /**
16698     * @defgroup Cursors Cursors
16699     *
16700     * The Elementary cursor is an internal smart object used to
16701     * customize the mouse cursor displayed over objects (or
16702     * widgets). In the most common scenario, the cursor decoration
16703     * comes from the graphical @b engine Elementary is running
16704     * on. Those engines may provide different decorations for cursors,
16705     * and Elementary provides functions to choose them (think of X11
16706     * cursors, as an example).
16707     *
16708     * There's also the possibility of, besides using engine provided
16709     * cursors, also use ones coming from Edje theming files. Both
16710     * globally and per widget, Elementary makes it possible for one to
16711     * make the cursors lookup to be held on engines only or on
16712     * Elementary's theme file, too. To set cursor's hot spot,
16713     * two data items should be added to cursor's theme: "hot_x" and
16714     * "hot_y", that are the offset from upper-left corner of the cursor
16715     * (coordinates 0,0).
16716     *
16717     * @{
16718     */
16719
16720    /**
16721     * Set the cursor to be shown when mouse is over the object
16722     *
16723     * Set the cursor that will be displayed when mouse is over the
16724     * object. The object can have only one cursor set to it, so if
16725     * this function is called twice for an object, the previous set
16726     * will be unset.
16727     * If using X cursors, a definition of all the valid cursor names
16728     * is listed on Elementary_Cursors.h. If an invalid name is set
16729     * the default cursor will be used.
16730     *
16731     * @param obj the object being set a cursor.
16732     * @param cursor the cursor name to be used.
16733     *
16734     * @ingroup Cursors
16735     */
16736    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
16737
16738    /**
16739     * Get the cursor to be shown when mouse is over the object
16740     *
16741     * @param obj an object with cursor already set.
16742     * @return the cursor name.
16743     *
16744     * @ingroup Cursors
16745     */
16746    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16747
16748    /**
16749     * Unset cursor for object
16750     *
16751     * Unset cursor for object, and set the cursor to default if the mouse
16752     * was over this object.
16753     *
16754     * @param obj Target object
16755     * @see elm_object_cursor_set()
16756     *
16757     * @ingroup Cursors
16758     */
16759    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16760
16761    /**
16762     * Sets a different style for this object cursor.
16763     *
16764     * @note before you set a style you should define a cursor with
16765     *       elm_object_cursor_set()
16766     *
16767     * @param obj an object with cursor already set.
16768     * @param style the theme style to use (default, transparent, ...)
16769     *
16770     * @ingroup Cursors
16771     */
16772    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16773
16774    /**
16775     * Get the style for this object cursor.
16776     *
16777     * @param obj an object with cursor already set.
16778     * @return style the theme style in use, defaults to "default". If the
16779     *         object does not have a cursor set, then NULL is returned.
16780     *
16781     * @ingroup Cursors
16782     */
16783    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16784
16785    /**
16786     * Set if the cursor set should be searched on the theme or should use
16787     * the provided by the engine, only.
16788     *
16789     * @note before you set if should look on theme you should define a cursor
16790     * with elm_object_cursor_set(). By default it will only look for cursors
16791     * provided by the engine.
16792     *
16793     * @param obj an object with cursor already set.
16794     * @param engine_only boolean to define it cursors should be looked only
16795     * between the provided by the engine or searched on widget's theme as well.
16796     *
16797     * @ingroup Cursors
16798     */
16799    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16800
16801    /**
16802     * Get the cursor engine only usage for this object cursor.
16803     *
16804     * @param obj an object with cursor already set.
16805     * @return engine_only boolean to define it cursors should be
16806     * looked only between the provided by the engine or searched on
16807     * widget's theme as well. If the object does not have a cursor
16808     * set, then EINA_FALSE is returned.
16809     *
16810     * @ingroup Cursors
16811     */
16812    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16813
16814    /**
16815     * Get the configured cursor engine only usage
16816     *
16817     * This gets the globally configured exclusive usage of engine cursors.
16818     *
16819     * @return 1 if only engine cursors should be used
16820     * @ingroup Cursors
16821     */
16822    EAPI int          elm_cursor_engine_only_get(void);
16823
16824    /**
16825     * Set the configured cursor engine only usage
16826     *
16827     * This sets the globally configured exclusive usage of engine cursors.
16828     * It won't affect cursors set before changing this value.
16829     *
16830     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
16831     * look for them on theme before.
16832     * @return EINA_TRUE if value is valid and setted (0 or 1)
16833     * @ingroup Cursors
16834     */
16835    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
16836
16837    /**
16838     * @}
16839     */
16840
16841    /**
16842     * @defgroup Menu Menu
16843     *
16844     * @image html img/widget/menu/preview-00.png
16845     * @image latex img/widget/menu/preview-00.eps
16846     *
16847     * A menu is a list of items displayed above its parent. When the menu is
16848     * showing its parent is darkened. Each item can have a sub-menu. The menu
16849     * object can be used to display a menu on a right click event, in a toolbar,
16850     * anywhere.
16851     *
16852     * Signals that you can add callbacks for are:
16853     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16854     *
16855     * Default contents parts of the menu items that you can use for are:
16856     * @li "default" - A main content of the menu item
16857     *
16858     * Default text parts of the menu items that you can use for are:
16859     * @li "default" - label in the menu item
16860     *
16861     * @see @ref tutorial_menu
16862     * @{
16863     */
16864
16865    /**
16866     * @brief Add a new menu to the parent
16867     *
16868     * @param parent The parent object.
16869     * @return The new object or NULL if it cannot be created.
16870     */
16871    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16872
16873    /**
16874     * @brief Set the parent for the given menu widget
16875     *
16876     * @param obj The menu object.
16877     * @param parent The new parent.
16878     */
16879    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16880
16881    /**
16882     * @brief Get the parent for the given menu widget
16883     *
16884     * @param obj The menu object.
16885     * @return The parent.
16886     *
16887     * @see elm_menu_parent_set()
16888     */
16889    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16890
16891    /**
16892     * @brief Move the menu to a new position
16893     *
16894     * @param obj The menu object.
16895     * @param x The new position.
16896     * @param y The new position.
16897     *
16898     * Sets the top-left position of the menu to (@p x,@p y).
16899     *
16900     * @note @p x and @p y coordinates are relative to parent.
16901     */
16902    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16903
16904    /**
16905     * @brief Close a opened menu
16906     *
16907     * @param obj the menu object
16908     * @return void
16909     *
16910     * Hides the menu and all it's sub-menus.
16911     */
16912    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16913
16914    /**
16915     * @brief Returns a list of @p item's items.
16916     *
16917     * @param obj The menu object
16918     * @return An Eina_List* of @p item's items
16919     */
16920    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16921
16922    /**
16923     * @brief Get the Evas_Object of an Elm_Object_Item
16924     *
16925     * @param it The menu item object.
16926     * @return The edje object containing the swallowed content
16927     *
16928     * @warning Don't manipulate this object!
16929     *
16930     */
16931    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16932
16933    /**
16934     * @brief Add an item at the end of the given menu widget
16935     *
16936     * @param obj The menu object.
16937     * @param parent The parent menu item (optional)
16938     * @param icon An icon display on the item. The icon will be destryed by the menu.
16939     * @param label The label of the item.
16940     * @param func Function called when the user select the item.
16941     * @param data Data sent by the callback.
16942     * @return Returns the new item.
16943     */
16944    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);
16945
16946    /**
16947     * @brief Add an object swallowed in an item at the end of the given menu
16948     * widget
16949     *
16950     * @param obj The menu object.
16951     * @param parent The parent menu item (optional)
16952     * @param subobj The object to swallow
16953     * @param func Function called when the user select the item.
16954     * @param data Data sent by the callback.
16955     * @return Returns the new item.
16956     *
16957     * Add an evas object as an item to the menu.
16958     */
16959    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);
16960
16961    /**
16962     * @brief Set the label of a menu item
16963     *
16964     * @param it The menu item object.
16965     * @param label The label to set for @p item
16966     *
16967     * @warning Don't use this funcion on items created with
16968     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16969     *
16970     * @deprecated Use elm_object_item_text_set() instead
16971     */
16972    EINA_DEPRECATED EAPI void               elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16973
16974    /**
16975     * @brief Get the label of a menu item
16976     *
16977     * @param it The menu item object.
16978     * @return The label of @p item
16979          * @deprecated Use elm_object_item_text_get() instead
16980     */
16981    EINA_DEPRECATED EAPI const char        *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16982
16983    /**
16984     * @brief Set the icon of a menu item to the standard icon with name @p icon
16985     *
16986     * @param it The menu item object.
16987     * @param icon The icon object to set for the content of @p item
16988     *
16989     * Once this icon is set, any previously set icon will be deleted.
16990     */
16991    EAPI void               elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16992
16993    /**
16994     * @brief Get the string representation from the icon of a menu item
16995     *
16996     * @param it The menu item object.
16997     * @return The string representation of @p item's icon or NULL
16998     *
16999     * @see elm_menu_item_object_icon_name_set()
17000     */
17001    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17002
17003    /**
17004     * @brief Set the content object of a menu item
17005     *
17006     * @param it The menu item object
17007     * @param The content object or NULL
17008     * @return EINA_TRUE on success, else EINA_FALSE
17009     *
17010     * Use this function to change the object swallowed by a menu item, deleting
17011     * any previously swallowed object.
17012     *
17013     * @deprecated Use elm_object_item_content_set() instead
17014     */
17015    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
17016
17017    /**
17018     * @brief Get the content object of a menu item
17019     *
17020     * @param it The menu item object
17021     * @return The content object or NULL
17022     * @note If @p item was added with elm_menu_item_add_object, this
17023     * function will return the object passed, else it will return the
17024     * icon object.
17025     *
17026     * @see elm_menu_item_object_content_set()
17027     *
17028     * @deprecated Use elm_object_item_content_get() instead
17029     */
17030    EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17031
17032    /**
17033     * @brief Set the selected state of @p item.
17034     *
17035     * @param it The menu item object.
17036     * @param selected The selected/unselected state of the item
17037     */
17038    EAPI void               elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
17039
17040    /**
17041     * @brief Get the selected state of @p item.
17042     *
17043     * @param it The menu item object.
17044     * @return The selected/unselected state of the item
17045     *
17046     * @see elm_menu_item_selected_set()
17047     */
17048    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17049
17050    /**
17051     * @brief Set the disabled state of @p item.
17052     *
17053     * @param it The menu item object.
17054     * @param disabled The enabled/disabled state of the item
17055     * @deprecated Use elm_object_item_disabled_set() instead
17056     */
17057    EINA_DEPRECATED EAPI void               elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17058
17059    /**
17060     * @brief Get the disabled state of @p item.
17061     *
17062     * @param it The menu item object.
17063     * @return The enabled/disabled state of the item
17064     *
17065     * @see elm_menu_item_disabled_set()
17066     * @deprecated Use elm_object_item_disabled_get() instead
17067     */
17068    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17069
17070    /**
17071     * @brief Add a separator item to menu @p obj under @p parent.
17072     *
17073     * @param obj The menu object
17074     * @param parent The item to add the separator under
17075     * @return The created item or NULL on failure
17076     *
17077     * This is item is a @ref Separator.
17078     */
17079    EAPI Elm_Object_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
17080
17081    /**
17082     * @brief Returns whether @p item is a separator.
17083     *
17084     * @param it The item to check
17085     * @return If true, @p item is a separator
17086     *
17087     * @see elm_menu_item_separator_add()
17088     */
17089    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17090
17091    /**
17092     * @brief Deletes an item from the menu.
17093     *
17094     * @param it The item to delete.
17095     *
17096     * @see elm_menu_item_add()
17097     */
17098    EAPI void               elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17099
17100    /**
17101     * @brief Set the function called when a menu item is deleted.
17102     *
17103     * @param it The item to set the callback on
17104     * @param func The function called
17105     *
17106     * @see elm_menu_item_add()
17107     * @see elm_menu_item_del()
17108     */
17109    EAPI void               elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17110
17111    /**
17112     * @brief Returns the data associated with menu item @p item.
17113     *
17114     * @param it The item
17115     * @return The data associated with @p item or NULL if none was set.
17116     *
17117     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
17118     *
17119     * @deprecated Use elm_object_item_data_get() instead
17120     */
17121    EINA_DEPRECATED EAPI void              *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17122
17123    /**
17124     * @brief Sets the data to be associated with menu item @p item.
17125     *
17126     * @param it The item
17127     * @param data The data to be associated with @p item
17128     *
17129     * @deprecated Use elm_object_item_data_set() instead
17130     */
17131    EINA_DEPRECATED EAPI void               elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
17132
17133    /**
17134     * @brief Returns a list of @p item's subitems.
17135     *
17136     * @param it The item
17137     * @return An Eina_List* of @p item's subitems
17138     *
17139     * @see elm_menu_add()
17140     */
17141    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17142
17143    /**
17144     * @brief Get the position of a menu item
17145     *
17146     * @param it The menu item
17147     * @return The item's index
17148     *
17149     * This function returns the index position of a menu item in a menu.
17150     * For a sub-menu, this number is relative to the first item in the sub-menu.
17151     *
17152     * @note Index values begin with 0
17153     */
17154    EAPI unsigned int       elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17155
17156    /**
17157     * @brief @brief Return a menu item's owner menu
17158     *
17159     * @param it The menu item
17160     * @return The menu object owning @p item, or NULL on failure
17161     *
17162     * Use this function to get the menu object owning an item.
17163     */
17164    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17165
17166    /**
17167     * @brief Get the selected item in the menu
17168     *
17169     * @param obj The menu object
17170     * @return The selected item, or NULL if none
17171     *
17172     * @see elm_menu_item_selected_get()
17173     * @see elm_menu_item_selected_set()
17174     */
17175    EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17176
17177    /**
17178     * @brief Get the last item in the menu
17179     *
17180     * @param obj The menu object
17181     * @return The last item, or NULL if none
17182     */
17183    EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17184
17185    /**
17186     * @brief Get the first item in the menu
17187     *
17188     * @param obj The menu object
17189     * @return The first item, or NULL if none
17190     */
17191    EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17192
17193    /**
17194     * @brief Get the next item in the menu.
17195     *
17196     * @param it The menu item object.
17197     * @return The item after it, or NULL if none
17198     */
17199    EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17200
17201    /**
17202     * @brief Get the previous item in the menu.
17203     *
17204     * @param it The menu item object.
17205     * @return The item before it, or NULL if none
17206     */
17207    EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17208
17209    /**
17210     * @}
17211     */
17212
17213    /**
17214     * @defgroup List List
17215     * @ingroup Elementary
17216     *
17217     * @image html img/widget/list/preview-00.png
17218     * @image latex img/widget/list/preview-00.eps width=\textwidth
17219     *
17220     * @image html img/list.png
17221     * @image latex img/list.eps width=\textwidth
17222     *
17223     * A list widget is a container whose children are displayed vertically or
17224     * horizontally, in order, and can be selected.
17225     * The list can accept only one or multiple items selection. Also has many
17226     * modes of items displaying.
17227     *
17228     * A list is a very simple type of list widget.  For more robust
17229     * lists, @ref Genlist should probably be used.
17230     *
17231     * Smart callbacks one can listen to:
17232     * - @c "activated" - The user has double-clicked or pressed
17233     *   (enter|return|spacebar) on an item. The @c event_info parameter
17234     *   is the item that was activated.
17235     * - @c "clicked,double" - The user has double-clicked an item.
17236     *   The @c event_info parameter is the item that was double-clicked.
17237     * - "selected" - when the user selected an item
17238     * - "unselected" - when the user unselected an item
17239     * - "longpressed" - an item in the list is long-pressed
17240     * - "edge,top" - the list is scrolled until the top edge
17241     * - "edge,bottom" - the list is scrolled until the bottom edge
17242     * - "edge,left" - the list is scrolled until the left edge
17243     * - "edge,right" - the list is scrolled until the right edge
17244     * - "language,changed" - the program's language changed
17245     *
17246     * Available styles for it:
17247     * - @c "default"
17248     *
17249     * List of examples:
17250     * @li @ref list_example_01
17251     * @li @ref list_example_02
17252     * @li @ref list_example_03
17253     */
17254
17255    /**
17256     * @addtogroup List
17257     * @{
17258     */
17259
17260    /**
17261     * @enum _Elm_List_Mode
17262     * @typedef Elm_List_Mode
17263     *
17264     * Set list's resize behavior, transverse axis scroll and
17265     * items cropping. See each mode's description for more details.
17266     *
17267     * @note Default value is #ELM_LIST_SCROLL.
17268     *
17269     * Values <b> don't </b> work as bitmask, only one can be choosen.
17270     *
17271     * @see elm_list_mode_set()
17272     * @see elm_list_mode_get()
17273     *
17274     * @ingroup List
17275     */
17276    typedef enum _Elm_List_Mode
17277      {
17278         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. */
17279         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). */
17280         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. */
17281         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. */
17282         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
17283      } Elm_List_Mode;
17284
17285    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().  */
17286
17287    /**
17288     * Add a new list widget to the given parent Elementary
17289     * (container) object.
17290     *
17291     * @param parent The parent object.
17292     * @return a new list widget handle or @c NULL, on errors.
17293     *
17294     * This function inserts a new list widget on the canvas.
17295     *
17296     * @ingroup List
17297     */
17298    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17299
17300    /**
17301     * Starts the list.
17302     *
17303     * @param obj The list object
17304     *
17305     * @note Call before running show() on the list object.
17306     * @warning If not called, it won't display the list properly.
17307     *
17308     * @code
17309     * li = elm_list_add(win);
17310     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
17311     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
17312     * elm_list_go(li);
17313     * evas_object_show(li);
17314     * @endcode
17315     *
17316     * @ingroup List
17317     */
17318    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
17319
17320    /**
17321     * Enable or disable multiple items selection on the list object.
17322     *
17323     * @param obj The list object
17324     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
17325     * disable it.
17326     *
17327     * Disabled by default. If disabled, the user can select a single item of
17328     * the list each time. Selected items are highlighted on list.
17329     * If enabled, many items can be selected.
17330     *
17331     * If a selected item is selected again, it will be unselected.
17332     *
17333     * @see elm_list_multi_select_get()
17334     *
17335     * @ingroup List
17336     */
17337    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17338
17339    /**
17340     * Get a value whether multiple items selection is enabled or not.
17341     *
17342     * @see elm_list_multi_select_set() for details.
17343     *
17344     * @param obj The list object.
17345     * @return @c EINA_TRUE means multiple items selection is enabled.
17346     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17347     * @c EINA_FALSE is returned.
17348     *
17349     * @ingroup List
17350     */
17351    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17352
17353    /**
17354     * Set which mode to use for the list object.
17355     *
17356     * @param obj The list object
17357     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17358     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
17359     *
17360     * Set list's resize behavior, transverse axis scroll and
17361     * items cropping. See each mode's description for more details.
17362     *
17363     * @note Default value is #ELM_LIST_SCROLL.
17364     *
17365     * Only one can be set, if a previous one was set, it will be changed
17366     * by the new mode set. Bitmask won't work as well.
17367     *
17368     * @see elm_list_mode_get()
17369     *
17370     * @ingroup List
17371     */
17372    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17373
17374    /**
17375     * Get the mode the list is at.
17376     *
17377     * @param obj The list object
17378     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17379     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
17380     *
17381     * @note see elm_list_mode_set() for more information.
17382     *
17383     * @ingroup List
17384     */
17385    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17386
17387    /**
17388     * Enable or disable horizontal mode on the list object.
17389     *
17390     * @param obj The list object.
17391     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
17392     * disable it, i.e., to enable vertical mode.
17393     *
17394     * @note Vertical mode is set by default.
17395     *
17396     * On horizontal mode items are displayed on list from left to right,
17397     * instead of from top to bottom. Also, the list will scroll horizontally.
17398     * Each item will presents left icon on top and right icon, or end, at
17399     * the bottom.
17400     *
17401     * @see elm_list_horizontal_get()
17402     *
17403     * @ingroup List
17404     */
17405    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17406
17407    /**
17408     * Get a value whether horizontal mode is enabled or not.
17409     *
17410     * @param obj The list object.
17411     * @return @c EINA_TRUE means horizontal mode selection is enabled.
17412     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17413     * @c EINA_FALSE is returned.
17414     *
17415     * @see elm_list_horizontal_set() for details.
17416     *
17417     * @ingroup List
17418     */
17419    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17420
17421    /**
17422     * Enable or disable always select mode on the list object.
17423     *
17424     * @param obj The list object
17425     * @param always_select @c EINA_TRUE to enable always select mode or
17426     * @c EINA_FALSE to disable it.
17427     *
17428     * @note Always select mode is disabled by default.
17429     *
17430     * Default behavior of list items is to only call its callback function
17431     * the first time it's pressed, i.e., when it is selected. If a selected
17432     * item is pressed again, and multi-select is disabled, it won't call
17433     * this function (if multi-select is enabled it will unselect the item).
17434     *
17435     * If always select is enabled, it will call the callback function
17436     * everytime a item is pressed, so it will call when the item is selected,
17437     * and again when a selected item is pressed.
17438     *
17439     * @see elm_list_always_select_mode_get()
17440     * @see elm_list_multi_select_set()
17441     *
17442     * @ingroup List
17443     */
17444    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17445
17446    /**
17447     * Get a value whether always select mode is enabled or not, meaning that
17448     * an item will always call its callback function, even if already selected.
17449     *
17450     * @param obj The list object
17451     * @return @c EINA_TRUE means horizontal mode selection is enabled.
17452     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17453     * @c EINA_FALSE is returned.
17454     *
17455     * @see elm_list_always_select_mode_set() for details.
17456     *
17457     * @ingroup List
17458     */
17459    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17460
17461    /**
17462     * Set bouncing behaviour when the scrolled content reaches an edge.
17463     *
17464     * Tell the internal scroller object whether it should bounce or not
17465     * when it reaches the respective edges for each axis.
17466     *
17467     * @param obj The list object
17468     * @param h_bounce Whether to bounce or not in the horizontal axis.
17469     * @param v_bounce Whether to bounce or not in the vertical axis.
17470     *
17471     * @see elm_scroller_bounce_set()
17472     *
17473     * @ingroup List
17474     */
17475    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17476
17477    /**
17478     * Get the bouncing behaviour of the internal scroller.
17479     *
17480     * Get whether the internal scroller should bounce when the edge of each
17481     * axis is reached scrolling.
17482     *
17483     * @param obj The list object.
17484     * @param h_bounce Pointer where to store the bounce state of the horizontal
17485     * axis.
17486     * @param v_bounce Pointer where to store the bounce state of the vertical
17487     * axis.
17488     *
17489     * @see elm_scroller_bounce_get()
17490     * @see elm_list_bounce_set()
17491     *
17492     * @ingroup List
17493     */
17494    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17495
17496    /**
17497     * Set the scrollbar policy.
17498     *
17499     * @param obj The list object
17500     * @param policy_h Horizontal scrollbar policy.
17501     * @param policy_v Vertical scrollbar policy.
17502     *
17503     * This sets the scrollbar visibility policy for the given scroller.
17504     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
17505     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
17506     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
17507     * This applies respectively for the horizontal and vertical scrollbars.
17508     *
17509     * The both are disabled by default, i.e., are set to
17510     * #ELM_SCROLLER_POLICY_OFF.
17511     *
17512     * @ingroup List
17513     */
17514    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17515
17516    /**
17517     * Get the scrollbar policy.
17518     *
17519     * @see elm_list_scroller_policy_get() for details.
17520     *
17521     * @param obj The list object.
17522     * @param policy_h Pointer where to store horizontal scrollbar policy.
17523     * @param policy_v Pointer where to store vertical scrollbar policy.
17524     *
17525     * @ingroup List
17526     */
17527    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);
17528
17529    /**
17530     * Append a new item to the list object.
17531     *
17532     * @param obj The list object.
17533     * @param label The label of the list item.
17534     * @param icon The icon object to use for the left side of the item. An
17535     * icon can be any Evas object, but usually it is an icon created
17536     * with elm_icon_add().
17537     * @param end The icon object to use for the right side of the item. An
17538     * icon can be any Evas object.
17539     * @param func The function to call when the item is clicked.
17540     * @param data The data to associate with the item for related callbacks.
17541     *
17542     * @return The created item or @c NULL upon failure.
17543     *
17544     * A new item will be created and appended to the list, i.e., will
17545     * be set as @b last item.
17546     *
17547     * Items created with this method can be deleted with
17548     * elm_list_item_del().
17549     *
17550     * Associated @p data can be properly freed when item is deleted if a
17551     * callback function is set with elm_list_item_del_cb_set().
17552     *
17553     * If a function is passed as argument, it will be called everytime this item
17554     * is selected, i.e., the user clicks over an unselected item.
17555     * If always select is enabled it will call this function every time
17556     * user clicks over an item (already selected or not).
17557     * If such function isn't needed, just passing
17558     * @c NULL as @p func is enough. The same should be done for @p data.
17559     *
17560     * Simple example (with no function callback or data associated):
17561     * @code
17562     * li = elm_list_add(win);
17563     * ic = elm_icon_add(win);
17564     * elm_icon_file_set(ic, "path/to/image", NULL);
17565     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
17566     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
17567     * elm_list_go(li);
17568     * evas_object_show(li);
17569     * @endcode
17570     *
17571     * @see elm_list_always_select_mode_set()
17572     * @see elm_list_item_del()
17573     * @see elm_list_item_del_cb_set()
17574     * @see elm_list_clear()
17575     * @see elm_icon_add()
17576     *
17577     * @ingroup List
17578     */
17579    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);
17580
17581    /**
17582     * Prepend a new item to the list object.
17583     *
17584     * @param obj The list object.
17585     * @param label The label of the list item.
17586     * @param icon The icon object to use for the left side of the item. An
17587     * icon can be any Evas object, but usually it is an icon created
17588     * with elm_icon_add().
17589     * @param end The icon object to use for the right side of the item. An
17590     * icon can be any Evas object.
17591     * @param func The function to call when the item is clicked.
17592     * @param data The data to associate with the item for related callbacks.
17593     *
17594     * @return The created item or @c NULL upon failure.
17595     *
17596     * A new item will be created and prepended to the list, i.e., will
17597     * be set as @b first item.
17598     *
17599     * Items created with this method can be deleted with
17600     * elm_list_item_del().
17601     *
17602     * Associated @p data can be properly freed when item is deleted if a
17603     * callback function is set with elm_list_item_del_cb_set().
17604     *
17605     * If a function is passed as argument, it will be called everytime this item
17606     * is selected, i.e., the user clicks over an unselected item.
17607     * If always select is enabled it will call this function every time
17608     * user clicks over an item (already selected or not).
17609     * If such function isn't needed, just passing
17610     * @c NULL as @p func is enough. The same should be done for @p data.
17611     *
17612     * @see elm_list_item_append() for a simple code example.
17613     * @see elm_list_always_select_mode_set()
17614     * @see elm_list_item_del()
17615     * @see elm_list_item_del_cb_set()
17616     * @see elm_list_clear()
17617     * @see elm_icon_add()
17618     *
17619     * @ingroup List
17620     */
17621    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);
17622
17623    /**
17624     * Insert a new item into the list object before item @p before.
17625     *
17626     * @param obj The list object.
17627     * @param before The list item to insert before.
17628     * @param label The label of the list item.
17629     * @param icon The icon object to use for the left side of the item. An
17630     * icon can be any Evas object, but usually it is an icon created
17631     * with elm_icon_add().
17632     * @param end The icon object to use for the right side of the item. An
17633     * icon can be any Evas object.
17634     * @param func The function to call when the item is clicked.
17635     * @param data The data to associate with the item for related callbacks.
17636     *
17637     * @return The created item or @c NULL upon failure.
17638     *
17639     * A new item will be created and added to the list. Its position in
17640     * this list will be just before item @p before.
17641     *
17642     * Items created with this method can be deleted with
17643     * elm_list_item_del().
17644     *
17645     * Associated @p data can be properly freed when item is deleted if a
17646     * callback function is set with elm_list_item_del_cb_set().
17647     *
17648     * If a function is passed as argument, it will be called everytime this item
17649     * is selected, i.e., the user clicks over an unselected item.
17650     * If always select is enabled it will call this function every time
17651     * user clicks over an item (already selected or not).
17652     * If such function isn't needed, just passing
17653     * @c NULL as @p func is enough. The same should be done for @p data.
17654     *
17655     * @see elm_list_item_append() for a simple code example.
17656     * @see elm_list_always_select_mode_set()
17657     * @see elm_list_item_del()
17658     * @see elm_list_item_del_cb_set()
17659     * @see elm_list_clear()
17660     * @see elm_icon_add()
17661     *
17662     * @ingroup List
17663     */
17664    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);
17665
17666    /**
17667     * Insert a new item into the list object after item @p after.
17668     *
17669     * @param obj The list object.
17670     * @param after The list item to insert after.
17671     * @param label The label of the list item.
17672     * @param icon The icon object to use for the left side of the item. An
17673     * icon can be any Evas object, but usually it is an icon created
17674     * with elm_icon_add().
17675     * @param end The icon object to use for the right side of the item. An
17676     * icon can be any Evas object.
17677     * @param func The function to call when the item is clicked.
17678     * @param data The data to associate with the item for related callbacks.
17679     *
17680     * @return The created item or @c NULL upon failure.
17681     *
17682     * A new item will be created and added to the list. Its position in
17683     * this list will be just after item @p after.
17684     *
17685     * Items created with this method can be deleted with
17686     * elm_list_item_del().
17687     *
17688     * Associated @p data can be properly freed when item is deleted if a
17689     * callback function is set with elm_list_item_del_cb_set().
17690     *
17691     * If a function is passed as argument, it will be called everytime this item
17692     * is selected, i.e., the user clicks over an unselected item.
17693     * If always select is enabled it will call this function every time
17694     * user clicks over an item (already selected or not).
17695     * If such function isn't needed, just passing
17696     * @c NULL as @p func is enough. The same should be done for @p data.
17697     *
17698     * @see elm_list_item_append() for a simple code example.
17699     * @see elm_list_always_select_mode_set()
17700     * @see elm_list_item_del()
17701     * @see elm_list_item_del_cb_set()
17702     * @see elm_list_clear()
17703     * @see elm_icon_add()
17704     *
17705     * @ingroup List
17706     */
17707    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);
17708
17709    /**
17710     * Insert a new item into the sorted list object.
17711     *
17712     * @param obj The list object.
17713     * @param label The label of the list item.
17714     * @param icon The icon object to use for the left side of the item. An
17715     * icon can be any Evas object, but usually it is an icon created
17716     * with elm_icon_add().
17717     * @param end The icon object to use for the right side of the item. An
17718     * icon can be any Evas object.
17719     * @param func The function to call when the item is clicked.
17720     * @param data The data to associate with the item for related callbacks.
17721     * @param cmp_func The comparing function to be used to sort list
17722     * items <b>by #Elm_List_Item item handles</b>. This function will
17723     * receive two items and compare them, returning a non-negative integer
17724     * if the second item should be place after the first, or negative value
17725     * if should be placed before.
17726     *
17727     * @return The created item or @c NULL upon failure.
17728     *
17729     * @note This function inserts values into a list object assuming it was
17730     * sorted and the result will be sorted.
17731     *
17732     * A new item will be created and added to the list. Its position in
17733     * this list will be found comparing the new item with previously inserted
17734     * items using function @p cmp_func.
17735     *
17736     * Items created with this method can be deleted with
17737     * elm_list_item_del().
17738     *
17739     * Associated @p data can be properly freed when item is deleted if a
17740     * callback function is set with elm_list_item_del_cb_set().
17741     *
17742     * If a function is passed as argument, it will be called everytime this item
17743     * is selected, i.e., the user clicks over an unselected item.
17744     * If always select is enabled it will call this function every time
17745     * user clicks over an item (already selected or not).
17746     * If such function isn't needed, just passing
17747     * @c NULL as @p func is enough. The same should be done for @p data.
17748     *
17749     * @see elm_list_item_append() for a simple code example.
17750     * @see elm_list_always_select_mode_set()
17751     * @see elm_list_item_del()
17752     * @see elm_list_item_del_cb_set()
17753     * @see elm_list_clear()
17754     * @see elm_icon_add()
17755     *
17756     * @ingroup List
17757     */
17758    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);
17759
17760    /**
17761     * Remove all list's items.
17762     *
17763     * @param obj The list object
17764     *
17765     * @see elm_list_item_del()
17766     * @see elm_list_item_append()
17767     *
17768     * @ingroup List
17769     */
17770    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17771
17772    /**
17773     * Get a list of all the list items.
17774     *
17775     * @param obj The list object
17776     * @return An @c Eina_List of list items, #Elm_List_Item,
17777     * or @c NULL on failure.
17778     *
17779     * @see elm_list_item_append()
17780     * @see elm_list_item_del()
17781     * @see elm_list_clear()
17782     *
17783     * @ingroup List
17784     */
17785    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17786
17787    /**
17788     * Get the selected item.
17789     *
17790     * @param obj The list object.
17791     * @return The selected list item.
17792     *
17793     * The selected item can be unselected with function
17794     * elm_list_item_selected_set().
17795     *
17796     * The selected item always will be highlighted on list.
17797     *
17798     * @see elm_list_selected_items_get()
17799     *
17800     * @ingroup List
17801     */
17802    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17803
17804    /**
17805     * Return a list of the currently selected list items.
17806     *
17807     * @param obj The list object.
17808     * @return An @c Eina_List of list items, #Elm_List_Item,
17809     * or @c NULL on failure.
17810     *
17811     * Multiple items can be selected if multi select is enabled. It can be
17812     * done with elm_list_multi_select_set().
17813     *
17814     * @see elm_list_selected_item_get()
17815     * @see elm_list_multi_select_set()
17816     *
17817     * @ingroup List
17818     */
17819    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17820
17821    /**
17822     * Set the selected state of an item.
17823     *
17824     * @param item The list item
17825     * @param selected The selected state
17826     *
17827     * This sets the selected state of the given item @p it.
17828     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
17829     *
17830     * If a new item is selected the previosly selected will be unselected,
17831     * unless multiple selection is enabled with elm_list_multi_select_set().
17832     * Previoulsy selected item can be get with function
17833     * elm_list_selected_item_get().
17834     *
17835     * Selected items will be highlighted.
17836     *
17837     * @see elm_list_item_selected_get()
17838     * @see elm_list_selected_item_get()
17839     * @see elm_list_multi_select_set()
17840     *
17841     * @ingroup List
17842     */
17843    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17844
17845    /*
17846     * Get whether the @p item is selected or not.
17847     *
17848     * @param item The list item.
17849     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
17850     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
17851     *
17852     * @see elm_list_selected_item_set() for details.
17853     * @see elm_list_item_selected_get()
17854     *
17855     * @ingroup List
17856     */
17857    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17858
17859    /**
17860     * Set or unset item as a separator.
17861     *
17862     * @param it The list item.
17863     * @param setting @c EINA_TRUE to set item @p it as separator or
17864     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
17865     *
17866     * Items aren't set as separator by default.
17867     *
17868     * If set as separator it will display separator theme, so won't display
17869     * icons or label.
17870     *
17871     * @see elm_list_item_separator_get()
17872     *
17873     * @ingroup List
17874     */
17875    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17876
17877    /**
17878     * Get a value whether item is a separator or not.
17879     *
17880     * @see elm_list_item_separator_set() for details.
17881     *
17882     * @param it The list item.
17883     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17884     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17885     *
17886     * @ingroup List
17887     */
17888    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17889
17890    /**
17891     * Show @p item in the list view.
17892     *
17893     * @param item The list item to be shown.
17894     *
17895     * It won't animate list until item is visible. If such behavior is wanted,
17896     * use elm_list_bring_in() intead.
17897     *
17898     * @ingroup List
17899     */
17900    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17901
17902    /**
17903     * Bring in the given item to list view.
17904     *
17905     * @param item The item.
17906     *
17907     * This causes list to jump to the given item @p item and show it
17908     * (by scrolling), if it is not fully visible.
17909     *
17910     * This may use animation to do so and take a period of time.
17911     *
17912     * If animation isn't wanted, elm_list_item_show() can be used.
17913     *
17914     * @ingroup List
17915     */
17916    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17917
17918    /**
17919     * Delete them item from the list.
17920     *
17921     * @param item The item of list to be deleted.
17922     *
17923     * If deleting all list items is required, elm_list_clear()
17924     * should be used instead of getting items list and deleting each one.
17925     *
17926     * @see elm_list_clear()
17927     * @see elm_list_item_append()
17928     * @see elm_list_item_del_cb_set()
17929     *
17930     * @ingroup List
17931     */
17932    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17933
17934    /**
17935     * Set the function called when a list item is freed.
17936     *
17937     * @param item The item to set the callback on
17938     * @param func The function called
17939     *
17940     * If there is a @p func, then it will be called prior item's memory release.
17941     * That will be called with the following arguments:
17942     * @li item's data;
17943     * @li item's Evas object;
17944     * @li item itself;
17945     *
17946     * This way, a data associated to a list item could be properly freed.
17947     *
17948     * @ingroup List
17949     */
17950    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17951
17952    /**
17953     * Get the data associated to the item.
17954     *
17955     * @param item The list item
17956     * @return The data associated to @p item
17957     *
17958     * The return value is a pointer to data associated to @p item when it was
17959     * created, with function elm_list_item_append() or similar. If no data
17960     * was passed as argument, it will return @c NULL.
17961     *
17962     * @see elm_list_item_append()
17963     *
17964     * @ingroup List
17965     */
17966    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17967
17968    /**
17969     * Get the left side icon associated to the item.
17970     *
17971     * @param item The list item
17972     * @return The left side icon associated to @p item
17973     *
17974     * The return value is a pointer to the icon associated to @p item when
17975     * it was
17976     * created, with function elm_list_item_append() or similar, or later
17977     * with function elm_list_item_icon_set(). If no icon
17978     * was passed as argument, it will return @c NULL.
17979     *
17980     * @see elm_list_item_append()
17981     * @see elm_list_item_icon_set()
17982     *
17983     * @ingroup List
17984     */
17985    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17986
17987    /**
17988     * Set the left side icon associated to the item.
17989     *
17990     * @param item The list item
17991     * @param icon The left side icon object to associate with @p item
17992     *
17993     * The icon object to use at left side of the item. An
17994     * icon can be any Evas object, but usually it is an icon created
17995     * with elm_icon_add().
17996     *
17997     * Once the icon object is set, a previously set one will be deleted.
17998     * @warning Setting the same icon for two items will cause the icon to
17999     * dissapear from the first item.
18000     *
18001     * If an icon was passed as argument on item creation, with function
18002     * elm_list_item_append() or similar, it will be already
18003     * associated to the item.
18004     *
18005     * @see elm_list_item_append()
18006     * @see elm_list_item_icon_get()
18007     *
18008     * @ingroup List
18009     */
18010    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
18011
18012    /**
18013     * Get the right side icon associated to the item.
18014     *
18015     * @param item The list item
18016     * @return The right side icon associated to @p item
18017     *
18018     * The return value is a pointer to the icon associated to @p item when
18019     * it was
18020     * created, with function elm_list_item_append() or similar, or later
18021     * with function elm_list_item_icon_set(). If no icon
18022     * was passed as argument, it will return @c NULL.
18023     *
18024     * @see elm_list_item_append()
18025     * @see elm_list_item_icon_set()
18026     *
18027     * @ingroup List
18028     */
18029    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18030
18031    /**
18032     * Set the right side icon associated to the item.
18033     *
18034     * @param item The list item
18035     * @param end The right side icon object to associate with @p item
18036     *
18037     * The icon object to use at right side of the item. An
18038     * icon can be any Evas object, but usually it is an icon created
18039     * with elm_icon_add().
18040     *
18041     * Once the icon object is set, a previously set one will be deleted.
18042     * @warning Setting the same icon for two items will cause the icon to
18043     * dissapear from the first item.
18044     *
18045     * If an icon was passed as argument on item creation, with function
18046     * elm_list_item_append() or similar, it will be already
18047     * associated to the item.
18048     *
18049     * @see elm_list_item_append()
18050     * @see elm_list_item_end_get()
18051     *
18052     * @ingroup List
18053     */
18054    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
18055
18056    /**
18057     * Gets the base object of the item.
18058     *
18059     * @param item The list item
18060     * @return The base object associated with @p item
18061     *
18062     * Base object is the @c Evas_Object that represents that item.
18063     *
18064     * @ingroup List
18065     */
18066    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18067    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18068
18069    /**
18070     * Get the label of item.
18071     *
18072     * @param item The item of list.
18073     * @return The label of item.
18074     *
18075     * The return value is a pointer to the label associated to @p item when
18076     * it was created, with function elm_list_item_append(), or later
18077     * with function elm_list_item_label_set. If no label
18078     * was passed as argument, it will return @c NULL.
18079     *
18080     * @see elm_list_item_label_set() for more details.
18081     * @see elm_list_item_append()
18082     *
18083     * @ingroup List
18084     */
18085    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18086
18087    /**
18088     * Set the label of item.
18089     *
18090     * @param item The item of list.
18091     * @param text The label of item.
18092     *
18093     * The label to be displayed by the item.
18094     * Label will be placed between left and right side icons (if set).
18095     *
18096     * If a label was passed as argument on item creation, with function
18097     * elm_list_item_append() or similar, it will be already
18098     * displayed by the item.
18099     *
18100     * @see elm_list_item_label_get()
18101     * @see elm_list_item_append()
18102     *
18103     * @ingroup List
18104     */
18105    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18106
18107    /**
18108     * Get the item before @p it in list.
18109     *
18110     * @param it The list item.
18111     * @return The item before @p it, or @c NULL if none or on failure.
18112     *
18113     * @note If it is the first item, @c NULL will be returned.
18114     *
18115     * @see elm_list_item_append()
18116     * @see elm_list_items_get()
18117     *
18118     * @ingroup List
18119     */
18120    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18121
18122    /**
18123     * Get the item after @p it in list.
18124     *
18125     * @param it The list item.
18126     * @return The item after @p it, or @c NULL if none or on failure.
18127     *
18128     * @note If it is the last item, @c NULL will be returned.
18129     *
18130     * @see elm_list_item_append()
18131     * @see elm_list_items_get()
18132     *
18133     * @ingroup List
18134     */
18135    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18136
18137    /**
18138     * Sets the disabled/enabled state of a list item.
18139     *
18140     * @param it The item.
18141     * @param disabled The disabled state.
18142     *
18143     * A disabled item cannot be selected or unselected. It will also
18144     * change its appearance (generally greyed out). This sets the
18145     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
18146     * enabled).
18147     *
18148     * @ingroup List
18149     */
18150    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18151
18152    /**
18153     * Get a value whether list item is disabled or not.
18154     *
18155     * @param it The item.
18156     * @return The disabled state.
18157     *
18158     * @see elm_list_item_disabled_set() for more details.
18159     *
18160     * @ingroup List
18161     */
18162    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18163
18164    /**
18165     * Set the text to be shown in a given list item's tooltips.
18166     *
18167     * @param item Target item.
18168     * @param text The text to set in the content.
18169     *
18170     * Setup the text as tooltip to object. The item can have only one tooltip,
18171     * so any previous tooltip data - set with this function or
18172     * elm_list_item_tooltip_content_cb_set() - is removed.
18173     *
18174     * @see elm_object_tooltip_text_set() for more details.
18175     *
18176     * @ingroup List
18177     */
18178    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18179
18180    /**
18181     * @brief Disable size restrictions on an object's tooltip
18182     * @param item The tooltip's anchor object
18183     * @param disable If EINA_TRUE, size restrictions are disabled
18184     * @return EINA_FALSE on failure, EINA_TRUE on success
18185     *
18186     * This function allows a tooltip to expand beyond its parant window's canvas.
18187     * It will instead be limited only by the size of the display.
18188     */
18189    EAPI Eina_Bool        elm_list_item_tooltip_window_mode_set(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
18190    /**
18191     * @brief Retrieve size restriction state of an object's tooltip
18192     * @param obj The tooltip's anchor object
18193     * @return If EINA_TRUE, size restrictions are disabled
18194     *
18195     * This function returns whether a tooltip is allowed to expand beyond
18196     * its parant window's canvas.
18197     * It will instead be limited only by the size of the display.
18198     */
18199    EAPI Eina_Bool        elm_list_item_tooltip_window_mode_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18200
18201    /**
18202     * Set the content to be shown in the tooltip item.
18203     *
18204     * Setup the tooltip to item. The item can have only one tooltip,
18205     * so any previous tooltip data is removed. @p func(with @p data) will
18206     * be called every time that need show the tooltip and it should
18207     * return a valid Evas_Object. This object is then managed fully by
18208     * tooltip system and is deleted when the tooltip is gone.
18209     *
18210     * @param item the list item being attached a tooltip.
18211     * @param func the function used to create the tooltip contents.
18212     * @param data what to provide to @a func as callback data/context.
18213     * @param del_cb called when data is not needed anymore, either when
18214     *        another callback replaces @a func, the tooltip is unset with
18215     *        elm_list_item_tooltip_unset() or the owner @a item
18216     *        dies. This callback receives as the first parameter the
18217     *        given @a data, and @c event_info is the item.
18218     *
18219     * @see elm_object_tooltip_content_cb_set() for more details.
18220     *
18221     * @ingroup List
18222     */
18223    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);
18224
18225    /**
18226     * Unset tooltip from item.
18227     *
18228     * @param item list item to remove previously set tooltip.
18229     *
18230     * Remove tooltip from item. The callback provided as del_cb to
18231     * elm_list_item_tooltip_content_cb_set() will be called to notify
18232     * it is not used anymore.
18233     *
18234     * @see elm_object_tooltip_unset() for more details.
18235     * @see elm_list_item_tooltip_content_cb_set()
18236     *
18237     * @ingroup List
18238     */
18239    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18240
18241    /**
18242     * Sets a different style for this item tooltip.
18243     *
18244     * @note before you set a style you should define a tooltip with
18245     *       elm_list_item_tooltip_content_cb_set() or
18246     *       elm_list_item_tooltip_text_set()
18247     *
18248     * @param item list item with tooltip already set.
18249     * @param style the theme style to use (default, transparent, ...)
18250     *
18251     * @see elm_object_tooltip_style_set() for more details.
18252     *
18253     * @ingroup List
18254     */
18255    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18256
18257    /**
18258     * Get the style for this item tooltip.
18259     *
18260     * @param item list item with tooltip already set.
18261     * @return style the theme style in use, defaults to "default". If the
18262     *         object does not have a tooltip set, then NULL is returned.
18263     *
18264     * @see elm_object_tooltip_style_get() for more details.
18265     * @see elm_list_item_tooltip_style_set()
18266     *
18267     * @ingroup List
18268     */
18269    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18270
18271    /**
18272     * Set the type of mouse pointer/cursor decoration to be shown,
18273     * when the mouse pointer is over the given list widget item
18274     *
18275     * @param item list item to customize cursor on
18276     * @param cursor the cursor type's name
18277     *
18278     * This function works analogously as elm_object_cursor_set(), but
18279     * here the cursor's changing area is restricted to the item's
18280     * area, and not the whole widget's. Note that that item cursors
18281     * have precedence over widget cursors, so that a mouse over an
18282     * item with custom cursor set will always show @b that cursor.
18283     *
18284     * If this function is called twice for an object, a previously set
18285     * cursor will be unset on the second call.
18286     *
18287     * @see elm_object_cursor_set()
18288     * @see elm_list_item_cursor_get()
18289     * @see elm_list_item_cursor_unset()
18290     *
18291     * @ingroup List
18292     */
18293    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18294
18295    /*
18296     * Get the type of mouse pointer/cursor decoration set to be shown,
18297     * when the mouse pointer is over the given list widget item
18298     *
18299     * @param item list item with custom cursor set
18300     * @return the cursor type's name or @c NULL, if no custom cursors
18301     * were set to @p item (and on errors)
18302     *
18303     * @see elm_object_cursor_get()
18304     * @see elm_list_item_cursor_set()
18305     * @see elm_list_item_cursor_unset()
18306     *
18307     * @ingroup List
18308     */
18309    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18310
18311    /**
18312     * Unset any custom mouse pointer/cursor decoration set to be
18313     * shown, when the mouse pointer is over the given list widget
18314     * item, thus making it show the @b default cursor again.
18315     *
18316     * @param item a list item
18317     *
18318     * Use this call to undo any custom settings on this item's cursor
18319     * decoration, bringing it back to defaults (no custom style set).
18320     *
18321     * @see elm_object_cursor_unset()
18322     * @see elm_list_item_cursor_set()
18323     *
18324     * @ingroup List
18325     */
18326    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18327
18328    /**
18329     * Set a different @b style for a given custom cursor set for a
18330     * list item.
18331     *
18332     * @param item list item with custom cursor set
18333     * @param style the <b>theme style</b> to use (e.g. @c "default",
18334     * @c "transparent", etc)
18335     *
18336     * This function only makes sense when one is using custom mouse
18337     * cursor decorations <b>defined in a theme file</b>, which can have,
18338     * given a cursor name/type, <b>alternate styles</b> on it. It
18339     * works analogously as elm_object_cursor_style_set(), but here
18340     * applyed only to list item objects.
18341     *
18342     * @warning Before you set a cursor style you should have definen a
18343     *       custom cursor previously on the item, with
18344     *       elm_list_item_cursor_set()
18345     *
18346     * @see elm_list_item_cursor_engine_only_set()
18347     * @see elm_list_item_cursor_style_get()
18348     *
18349     * @ingroup List
18350     */
18351    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18352
18353    /**
18354     * Get the current @b style set for a given list item's custom
18355     * cursor
18356     *
18357     * @param item list item with custom cursor set.
18358     * @return style the cursor style in use. If the object does not
18359     *         have a cursor set, then @c NULL is returned.
18360     *
18361     * @see elm_list_item_cursor_style_set() for more details
18362     *
18363     * @ingroup List
18364     */
18365    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18366
18367    /**
18368     * Set if the (custom)cursor for a given list item should be
18369     * searched in its theme, also, or should only rely on the
18370     * rendering engine.
18371     *
18372     * @param item item with custom (custom) cursor already set on
18373     * @param engine_only Use @c EINA_TRUE to have cursors looked for
18374     * only on those provided by the rendering engine, @c EINA_FALSE to
18375     * have them searched on the widget's theme, as well.
18376     *
18377     * @note This call is of use only if you've set a custom cursor
18378     * for list items, with elm_list_item_cursor_set().
18379     *
18380     * @note By default, cursors will only be looked for between those
18381     * provided by the rendering engine.
18382     *
18383     * @ingroup List
18384     */
18385    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18386
18387    /**
18388     * Get if the (custom) cursor for a given list item is being
18389     * searched in its theme, also, or is only relying on the rendering
18390     * engine.
18391     *
18392     * @param item a list item
18393     * @return @c EINA_TRUE, if cursors are being looked for only on
18394     * those provided by the rendering engine, @c EINA_FALSE if they
18395     * are being searched on the widget's theme, as well.
18396     *
18397     * @see elm_list_item_cursor_engine_only_set(), for more details
18398     *
18399     * @ingroup List
18400     */
18401    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18402
18403    /**
18404     * @}
18405     */
18406
18407    /**
18408     * @defgroup Slider Slider
18409     * @ingroup Elementary
18410     *
18411     * @image html img/widget/slider/preview-00.png
18412     * @image latex img/widget/slider/preview-00.eps width=\textwidth
18413     *
18414     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
18415     * something within a range.
18416     *
18417     * A slider can be horizontal or vertical. It can contain an Icon and has a
18418     * primary label as well as a units label (that is formatted with floating
18419     * point values and thus accepts a printf-style format string, like
18420     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
18421     * else (like on the slider itself) that also accepts a format string like
18422     * units. Label, Icon Unit and Indicator strings/objects are optional.
18423     *
18424     * A slider may be inverted which means values invert, with high vales being
18425     * on the left or top and low values on the right or bottom (as opposed to
18426     * normally being low on the left or top and high on the bottom and right).
18427     *
18428     * The slider should have its minimum and maximum values set by the
18429     * application with  elm_slider_min_max_set() and value should also be set by
18430     * the application before use with  elm_slider_value_set(). The span of the
18431     * slider is its length (horizontally or vertically). This will be scaled by
18432     * the object or applications scaling factor. At any point code can query the
18433     * slider for its value with elm_slider_value_get().
18434     *
18435     * Smart callbacks one can listen to:
18436     * - "changed" - Whenever the slider value is changed by the user.
18437     * - "slider,drag,start" - dragging the slider indicator around has started.
18438     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
18439     * - "delay,changed" - A short time after the value is changed by the user.
18440     * This will be called only when the user stops dragging for
18441     * a very short period or when they release their
18442     * finger/mouse, so it avoids possibly expensive reactions to
18443     * the value change.
18444     *
18445     * Available styles for it:
18446     * - @c "default"
18447     *
18448     * Default contents parts of the slider widget that you can use for are:
18449     * @li "icon" - An icon of the slider
18450     * @li "end" - A end part content of the slider
18451     *
18452     * Default text parts of the silder widget that you can use for are:
18453     * @li "default" - Label of the silder
18454     * Here is an example on its usage:
18455     * @li @ref slider_example
18456     */
18457
18458    /**
18459     * @addtogroup Slider
18460     * @{
18461     */
18462
18463    /**
18464     * Add a new slider widget to the given parent Elementary
18465     * (container) object.
18466     *
18467     * @param parent The parent object.
18468     * @return a new slider widget handle or @c NULL, on errors.
18469     *
18470     * This function inserts a new slider widget on the canvas.
18471     *
18472     * @ingroup Slider
18473     */
18474    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18475
18476    /**
18477     * Set the label of a given slider widget
18478     *
18479     * @param obj The progress bar object
18480     * @param label The text label string, in UTF-8
18481     *
18482     * @ingroup Slider
18483     * @deprecated use elm_object_text_set() instead.
18484     */
18485    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18486
18487    /**
18488     * Get the label of a given slider widget
18489     *
18490     * @param obj The progressbar object
18491     * @return The text label string, in UTF-8
18492     *
18493     * @ingroup Slider
18494     * @deprecated use elm_object_text_get() instead.
18495     */
18496    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18497
18498    /**
18499     * Set the icon object of the slider object.
18500     *
18501     * @param obj The slider object.
18502     * @param icon The icon object.
18503     *
18504     * On horizontal mode, icon is placed at left, and on vertical mode,
18505     * placed at top.
18506     *
18507     * @note Once the icon object is set, a previously set one will be deleted.
18508     * If you want to keep that old content object, use the
18509     * elm_slider_icon_unset() function.
18510     *
18511     * @warning If the object being set does not have minimum size hints set,
18512     * it won't get properly displayed.
18513     *
18514     * @ingroup Slider
18515     * @deprecated use elm_object_part_content_set() instead.
18516     */
18517    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18518
18519    /**
18520     * Unset an icon set on a given slider widget.
18521     *
18522     * @param obj The slider object.
18523     * @return The icon object that was being used, if any was set, or
18524     * @c NULL, otherwise (and on errors).
18525     *
18526     * On horizontal mode, icon is placed at left, and on vertical mode,
18527     * placed at top.
18528     *
18529     * This call will unparent and return the icon object which was set
18530     * for this widget, previously, on success.
18531     *
18532     * @see elm_slider_icon_set() for more details
18533     * @see elm_slider_icon_get()
18534     * @deprecated use elm_object_part_content_unset() instead.
18535     *
18536     * @ingroup Slider
18537     */
18538    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18539
18540    /**
18541     * Retrieve the icon object set for a given slider widget.
18542     *
18543     * @param obj The slider object.
18544     * @return The icon object's handle, if @p obj had one set, or @c NULL,
18545     * otherwise (and on errors).
18546     *
18547     * On horizontal mode, icon is placed at left, and on vertical mode,
18548     * placed at top.
18549     *
18550     * @see elm_slider_icon_set() for more details
18551     * @see elm_slider_icon_unset()
18552     *
18553     * @deprecated use elm_object_part_content_get() instead.
18554     *
18555     * @ingroup Slider
18556     */
18557    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18558
18559    /**
18560     * Set the end object of the slider object.
18561     *
18562     * @param obj The slider object.
18563     * @param end The end object.
18564     *
18565     * On horizontal mode, end is placed at left, and on vertical mode,
18566     * placed at bottom.
18567     *
18568     * @note Once the icon object is set, a previously set one will be deleted.
18569     * If you want to keep that old content object, use the
18570     * elm_slider_end_unset() function.
18571     *
18572     * @warning If the object being set does not have minimum size hints set,
18573     * it won't get properly displayed.
18574     *
18575     * @deprecated use elm_object_part_content_set() instead.
18576     *
18577     * @ingroup Slider
18578     */
18579    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
18580
18581    /**
18582     * Unset an end object set on a given slider widget.
18583     *
18584     * @param obj The slider object.
18585     * @return The end object that was being used, if any was set, or
18586     * @c NULL, otherwise (and on errors).
18587     *
18588     * On horizontal mode, end is placed at left, and on vertical mode,
18589     * placed at bottom.
18590     *
18591     * This call will unparent and return the icon object which was set
18592     * for this widget, previously, on success.
18593     *
18594     * @see elm_slider_end_set() for more details.
18595     * @see elm_slider_end_get()
18596     *
18597     * @deprecated use elm_object_part_content_unset() instead
18598     * instead.
18599     *
18600     * @ingroup Slider
18601     */
18602    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18603
18604    /**
18605     * Retrieve the end object set for a given slider widget.
18606     *
18607     * @param obj The slider object.
18608     * @return The end object's handle, if @p obj had one set, or @c NULL,
18609     * otherwise (and on errors).
18610     *
18611     * On horizontal mode, icon is placed at right, and on vertical mode,
18612     * placed at bottom.
18613     *
18614     * @see elm_slider_end_set() for more details.
18615     * @see elm_slider_end_unset()
18616     *
18617     *
18618     * @deprecated use elm_object_part_content_get() instead
18619     * instead.
18620     *
18621     * @ingroup Slider
18622     */
18623    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18624
18625    /**
18626     * Set the (exact) length of the bar region of a given slider widget.
18627     *
18628     * @param obj The slider object.
18629     * @param size The length of the slider's bar region.
18630     *
18631     * This sets the minimum width (when in horizontal mode) or height
18632     * (when in vertical mode) of the actual bar area of the slider
18633     * @p obj. This in turn affects the object's minimum size. Use
18634     * this when you're not setting other size hints expanding on the
18635     * given direction (like weight and alignment hints) and you would
18636     * like it to have a specific size.
18637     *
18638     * @note Icon, end, label, indicator and unit text around @p obj
18639     * will require their
18640     * own space, which will make @p obj to require more the @p size,
18641     * actually.
18642     *
18643     * @see elm_slider_span_size_get()
18644     *
18645     * @ingroup Slider
18646     */
18647    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
18648
18649    /**
18650     * Get the length set for the bar region of a given slider widget
18651     *
18652     * @param obj The slider object.
18653     * @return The length of the slider's bar region.
18654     *
18655     * If that size was not set previously, with
18656     * elm_slider_span_size_set(), this call will return @c 0.
18657     *
18658     * @ingroup Slider
18659     */
18660    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18661
18662    /**
18663     * Set the format string for the unit label.
18664     *
18665     * @param obj The slider object.
18666     * @param format The format string for the unit display.
18667     *
18668     * Unit label is displayed all the time, if set, after slider's bar.
18669     * In horizontal mode, at right and in vertical mode, at bottom.
18670     *
18671     * If @c NULL, unit label won't be visible. If not it sets the format
18672     * string for the label text. To the label text is provided a floating point
18673     * value, so the label text can display up to 1 floating point value.
18674     * Note that this is optional.
18675     *
18676     * Use a format string such as "%1.2f meters" for example, and it will
18677     * display values like: "3.14 meters" for a value equal to 3.14159.
18678     *
18679     * Default is unit label disabled.
18680     *
18681     * @see elm_slider_indicator_format_get()
18682     *
18683     * @ingroup Slider
18684     */
18685    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
18686
18687    /**
18688     * Get the unit label format of the slider.
18689     *
18690     * @param obj The slider object.
18691     * @return The unit label format string in UTF-8.
18692     *
18693     * Unit label is displayed all the time, if set, after slider's bar.
18694     * In horizontal mode, at right and in vertical mode, at bottom.
18695     *
18696     * @see elm_slider_unit_format_set() for more
18697     * information on how this works.
18698     *
18699     * @ingroup Slider
18700     */
18701    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18702
18703    /**
18704     * Set the format string for the indicator label.
18705     *
18706     * @param obj The slider object.
18707     * @param indicator The format string for the indicator display.
18708     *
18709     * The slider may display its value somewhere else then unit label,
18710     * for example, above the slider knob that is dragged around. This function
18711     * sets the format string used for this.
18712     *
18713     * If @c NULL, indicator label won't be visible. If not it sets the format
18714     * string for the label text. To the label text is provided a floating point
18715     * value, so the label text can display up to 1 floating point value.
18716     * Note that this is optional.
18717     *
18718     * Use a format string such as "%1.2f meters" for example, and it will
18719     * display values like: "3.14 meters" for a value equal to 3.14159.
18720     *
18721     * Default is indicator label disabled.
18722     *
18723     * @see elm_slider_indicator_format_get()
18724     *
18725     * @ingroup Slider
18726     */
18727    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
18728
18729    /**
18730     * Get the indicator label format of the slider.
18731     *
18732     * @param obj The slider object.
18733     * @return The indicator label format string in UTF-8.
18734     *
18735     * The slider may display its value somewhere else then unit label,
18736     * for example, above the slider knob that is dragged around. This function
18737     * gets the format string used for this.
18738     *
18739     * @see elm_slider_indicator_format_set() for more
18740     * information on how this works.
18741     *
18742     * @ingroup Slider
18743     */
18744    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18745
18746    /**
18747     * Set the format function pointer for the indicator label
18748     *
18749     * @param obj The slider object.
18750     * @param func The indicator format function.
18751     * @param free_func The freeing function for the format string.
18752     *
18753     * Set the callback function to format the indicator string.
18754     *
18755     * @see elm_slider_indicator_format_set() for more info on how this works.
18756     *
18757     * @ingroup Slider
18758     */
18759   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);
18760
18761   /**
18762    * Set the format function pointer for the units label
18763    *
18764    * @param obj The slider object.
18765    * @param func The units format function.
18766    * @param free_func The freeing function for the format string.
18767    *
18768    * Set the callback function to format the indicator string.
18769    *
18770    * @see elm_slider_units_format_set() for more info on how this works.
18771    *
18772    * @ingroup Slider
18773    */
18774   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);
18775
18776   /**
18777    * Set the orientation of a given slider widget.
18778    *
18779    * @param obj The slider object.
18780    * @param horizontal Use @c EINA_TRUE to make @p obj to be
18781    * @b horizontal, @c EINA_FALSE to make it @b vertical.
18782    *
18783    * Use this function to change how your slider is to be
18784    * disposed: vertically or horizontally.
18785    *
18786    * By default it's displayed horizontally.
18787    *
18788    * @see elm_slider_horizontal_get()
18789    *
18790    * @ingroup Slider
18791    */
18792    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18793
18794    /**
18795     * Retrieve the orientation of a given slider widget
18796     *
18797     * @param obj The slider object.
18798     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
18799     * @c EINA_FALSE if it's @b vertical (and on errors).
18800     *
18801     * @see elm_slider_horizontal_set() for more details.
18802     *
18803     * @ingroup Slider
18804     */
18805    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18806
18807    /**
18808     * Set the minimum and maximum values for the slider.
18809     *
18810     * @param obj The slider object.
18811     * @param min The minimum value.
18812     * @param max The maximum value.
18813     *
18814     * Define the allowed range of values to be selected by the user.
18815     *
18816     * If actual value is less than @p min, it will be updated to @p min. If it
18817     * is bigger then @p max, will be updated to @p max. Actual value can be
18818     * get with elm_slider_value_get().
18819     *
18820     * By default, min is equal to 0.0, and max is equal to 1.0.
18821     *
18822     * @warning Maximum must be greater than minimum, otherwise behavior
18823     * is undefined.
18824     *
18825     * @see elm_slider_min_max_get()
18826     *
18827     * @ingroup Slider
18828     */
18829    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
18830
18831    /**
18832     * Get the minimum and maximum values of the slider.
18833     *
18834     * @param obj The slider object.
18835     * @param min Pointer where to store the minimum value.
18836     * @param max Pointer where to store the maximum value.
18837     *
18838     * @note If only one value is needed, the other pointer can be passed
18839     * as @c NULL.
18840     *
18841     * @see elm_slider_min_max_set() for details.
18842     *
18843     * @ingroup Slider
18844     */
18845    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
18846
18847    /**
18848     * Set the value the slider displays.
18849     *
18850     * @param obj The slider object.
18851     * @param val The value to be displayed.
18852     *
18853     * Value will be presented on the unit label following format specified with
18854     * elm_slider_unit_format_set() and on indicator with
18855     * elm_slider_indicator_format_set().
18856     *
18857     * @warning The value must to be between min and max values. This values
18858     * are set by elm_slider_min_max_set().
18859     *
18860     * @see elm_slider_value_get()
18861     * @see elm_slider_unit_format_set()
18862     * @see elm_slider_indicator_format_set()
18863     * @see elm_slider_min_max_set()
18864     *
18865     * @ingroup Slider
18866     */
18867    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18868
18869    /**
18870     * Get the value displayed by the spinner.
18871     *
18872     * @param obj The spinner object.
18873     * @return The value displayed.
18874     *
18875     * @see elm_spinner_value_set() for details.
18876     *
18877     * @ingroup Slider
18878     */
18879    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18880
18881    /**
18882     * Invert a given slider widget's displaying values order
18883     *
18884     * @param obj The slider object.
18885     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18886     * @c EINA_FALSE to bring it back to default, non-inverted values.
18887     *
18888     * A slider may be @b inverted, in which state it gets its
18889     * values inverted, with high vales being on the left or top and
18890     * low values on the right or bottom, as opposed to normally have
18891     * the low values on the former and high values on the latter,
18892     * respectively, for horizontal and vertical modes.
18893     *
18894     * @see elm_slider_inverted_get()
18895     *
18896     * @ingroup Slider
18897     */
18898    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18899
18900    /**
18901     * Get whether a given slider widget's displaying values are
18902     * inverted or not.
18903     *
18904     * @param obj The slider object.
18905     * @return @c EINA_TRUE, if @p obj has inverted values,
18906     * @c EINA_FALSE otherwise (and on errors).
18907     *
18908     * @see elm_slider_inverted_set() for more details.
18909     *
18910     * @ingroup Slider
18911     */
18912    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18913
18914    /**
18915     * Set whether to enlarge slider indicator (augmented knob) or not.
18916     *
18917     * @param obj The slider object.
18918     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18919     * let the knob always at default size.
18920     *
18921     * By default, indicator will be bigger while dragged by the user.
18922     *
18923     * @warning It won't display values set with
18924     * elm_slider_indicator_format_set() if you disable indicator.
18925     *
18926     * @ingroup Slider
18927     */
18928    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18929
18930    /**
18931     * Get whether a given slider widget's enlarging indicator or not.
18932     *
18933     * @param obj The slider object.
18934     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18935     * @c EINA_FALSE otherwise (and on errors).
18936     *
18937     * @see elm_slider_indicator_show_set() for details.
18938     *
18939     * @ingroup Slider
18940     */
18941    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18942
18943    /**
18944     * @}
18945     */
18946
18947    /**
18948     * @addtogroup Actionslider Actionslider
18949     *
18950     * @image html img/widget/actionslider/preview-00.png
18951     * @image latex img/widget/actionslider/preview-00.eps
18952     *
18953     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18954     * properties. The user drags and releases the indicator, to choose a label.
18955     *
18956     * Labels occupy the following positions.
18957     * a. Left
18958     * b. Right
18959     * c. Center
18960     *
18961     * Positions can be enabled or disabled.
18962     *
18963     * Magnets can be set on the above positions.
18964     *
18965     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18966     *
18967     * @note By default all positions are set as enabled.
18968     *
18969     * Signals that you can add callbacks for are:
18970     *
18971     * "selected" - when user selects an enabled position (the label is passed
18972     *              as event info)".
18973     * @n
18974     * "pos_changed" - when the indicator reaches any of the positions("left",
18975     *                 "right" or "center").
18976     *
18977     * See an example of actionslider usage @ref actionslider_example_page "here"
18978     * @{
18979     */
18980    typedef enum _Elm_Actionslider_Pos
18981      {
18982         ELM_ACTIONSLIDER_NONE = 0,
18983         ELM_ACTIONSLIDER_LEFT = 1 << 0,
18984         ELM_ACTIONSLIDER_CENTER = 1 << 1,
18985         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18986         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18987      } Elm_Actionslider_Pos;
18988
18989    /**
18990     * Add a new actionslider to the parent.
18991     *
18992     * @param parent The parent object
18993     * @return The new actionslider object or NULL if it cannot be created
18994     */
18995    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18996
18997    /**
18998     * Set actionslider labels.
18999     *
19000     * @param obj The actionslider object
19001     * @param left_label The label to be set on the left.
19002     * @param center_label The label to be set on the center.
19003     * @param right_label The label to be set on the right.
19004     * @deprecated use elm_object_text_set() instead.
19005     */
19006    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);
19007
19008    /**
19009     * Get actionslider labels.
19010     *
19011     * @param obj The actionslider object
19012     * @param left_label A char** to place the left_label of @p obj into.
19013     * @param center_label A char** to place the center_label of @p obj into.
19014     * @param right_label A char** to place the right_label of @p obj into.
19015     * @deprecated use elm_object_text_set() instead.
19016     */
19017    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);
19018
19019    /**
19020     * Get actionslider selected label.
19021     *
19022     * @param obj The actionslider object
19023     * @return The selected label
19024     */
19025    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19026
19027    /**
19028     * Set actionslider indicator position.
19029     *
19030     * @param obj The actionslider object.
19031     * @param pos The position of the indicator.
19032     */
19033    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19034
19035    /**
19036     * Get actionslider indicator position.
19037     *
19038     * @param obj The actionslider object.
19039     * @return The position of the indicator.
19040     */
19041    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19042
19043    /**
19044     * Set actionslider magnet position. To make multiple positions magnets @c or
19045     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
19046     *
19047     * @param obj The actionslider object.
19048     * @param pos Bit mask indicating the magnet positions.
19049     */
19050    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19051
19052    /**
19053     * Get actionslider magnet position.
19054     *
19055     * @param obj The actionslider object.
19056     * @return The positions with magnet property.
19057     */
19058    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19059
19060    /**
19061     * Set actionslider enabled position. To set multiple positions as enabled @c or
19062     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
19063     *
19064     * @note All the positions are enabled by default.
19065     *
19066     * @param obj The actionslider object.
19067     * @param pos Bit mask indicating the enabled positions.
19068     */
19069    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19070
19071    /**
19072     * Get actionslider enabled position.
19073     *
19074     * @param obj The actionslider object.
19075     * @return The enabled positions.
19076     */
19077    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19078
19079    /**
19080     * Set the label used on the indicator.
19081     *
19082     * @param obj The actionslider object
19083     * @param label The label to be set on the indicator.
19084     * @deprecated use elm_object_text_set() instead.
19085     */
19086    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19087
19088    /**
19089     * Get the label used on the indicator object.
19090     *
19091     * @param obj The actionslider object
19092     * @return The indicator label
19093     * @deprecated use elm_object_text_get() instead.
19094     */
19095    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
19096
19097    /**
19098     * @}
19099     */
19100
19101    /**
19102     * @defgroup Genlist Genlist
19103     *
19104     * @image html img/widget/genlist/preview-00.png
19105     * @image latex img/widget/genlist/preview-00.eps
19106     * @image html img/genlist.png
19107     * @image latex img/genlist.eps
19108     *
19109     * This widget aims to have more expansive list than the simple list in
19110     * Elementary that could have more flexible items and allow many more entries
19111     * while still being fast and low on memory usage. At the same time it was
19112     * also made to be able to do tree structures. But the price to pay is more
19113     * complexity when it comes to usage. If all you want is a simple list with
19114     * icons and a single text, use the normal @ref List object.
19115     *
19116     * Genlist has a fairly large API, mostly because it's relatively complex,
19117     * trying to be both expansive, powerful and efficient. First we will begin
19118     * an overview on the theory behind genlist.
19119     *
19120     * @section Genlist_Item_Class Genlist item classes - creating items
19121     *
19122     * In order to have the ability to add and delete items on the fly, genlist
19123     * implements a class (callback) system where the application provides a
19124     * structure with information about that type of item (genlist may contain
19125     * multiple different items with different classes, states and styles).
19126     * Genlist will call the functions in this struct (methods) when an item is
19127     * "realized" (i.e., created dynamically, while the user is scrolling the
19128     * grid). All objects will simply be deleted when no longer needed with
19129     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
19130     * following members:
19131     * - @c item_style - This is a constant string and simply defines the name
19132     *   of the item style. It @b must be specified and the default should be @c
19133     *   "default".
19134     *
19135     * - @c func - A struct with pointers to functions that will be called when
19136     *   an item is going to be actually created. All of them receive a @c data
19137     *   parameter that will point to the same data passed to
19138     *   elm_genlist_item_append() and related item creation functions, and a @c
19139     *   obj parameter that points to the genlist object itself.
19140     *
19141     * The function pointers inside @c func are @c text_get, @c content_get, @c
19142     * state_get and @c del. The 3 first functions also receive a @c part
19143     * parameter described below. A brief description of these functions follows:
19144     *
19145     * - @c text_get - The @c part parameter is the name string of one of the
19146     *   existing text parts in the Edje group implementing the item's theme.
19147     *   This function @b must return a strdup'()ed string, as the caller will
19148     *   free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
19149     * - @c content_get - The @c part parameter is the name string of one of the
19150     *   existing (content) swallow parts in the Edje group implementing the item's
19151     *   theme. It must return @c NULL, when no content is desired, or a valid
19152     *   object handle, otherwise.  The object will be deleted by the genlist on
19153     *   its deletion or when the item is "unrealized".  See
19154     *   #Elm_Genlist_Item_Content_Get_Cb.
19155     * - @c func.state_get - The @c part parameter is the name string of one of
19156     *   the state parts in the Edje group implementing the item's theme. Return
19157     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
19158     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
19159     *   and @c "elm" as "emission" and "source" arguments, respectively, when
19160     *   the state is true (the default is false), where @c XXX is the name of
19161     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
19162     * - @c func.del - This is intended for use when genlist items are deleted,
19163     *   so any data attached to the item (e.g. its data parameter on creation)
19164     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
19165     *
19166     * available item styles:
19167     * - default
19168     * - default_style - The text part is a textblock
19169     *
19170     * @image html img/widget/genlist/preview-04.png
19171     * @image latex img/widget/genlist/preview-04.eps
19172     *
19173     * - double_label
19174     *
19175     * @image html img/widget/genlist/preview-01.png
19176     * @image latex img/widget/genlist/preview-01.eps
19177     *
19178     * - icon_top_text_bottom
19179     *
19180     * @image html img/widget/genlist/preview-02.png
19181     * @image latex img/widget/genlist/preview-02.eps
19182     *
19183     * - group_index
19184     *
19185     * @image html img/widget/genlist/preview-03.png
19186     * @image latex img/widget/genlist/preview-03.eps
19187     *
19188     * @section Genlist_Items Structure of items
19189     *
19190     * An item in a genlist can have 0 or more texts (they can be regular
19191     * text or textblock Evas objects - that's up to the style to determine), 0
19192     * or more contents (which are simply objects swallowed into the genlist item's
19193     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
19194     * behavior left to the user to define. The Edje part names for each of
19195     * these properties will be looked up, in the theme file for the genlist,
19196     * under the Edje (string) data items named @c "labels", @c "contents" and @c
19197     * "states", respectively. For each of those properties, if more than one
19198     * part is provided, they must have names listed separated by spaces in the
19199     * data fields. For the default genlist item theme, we have @b one text 
19200     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
19201     * "elm.swallow.end") and @b no state parts.
19202     *
19203     * A genlist item may be at one of several styles. Elementary provides one
19204     * by default - "default", but this can be extended by system or application
19205     * custom themes/overlays/extensions (see @ref Theme "themes" for more
19206     * details).
19207     *
19208     * @section Genlist_Manipulation Editing and Navigating
19209     *
19210     * Items can be added by several calls. All of them return a @ref
19211     * Elm_Genlist_Item handle that is an internal member inside the genlist.
19212     * They all take a data parameter that is meant to be used for a handle to
19213     * the applications internal data (eg the struct with the original item
19214     * data). The parent parameter is the parent genlist item this belongs to if
19215     * it is a tree or an indexed group, and NULL if there is no parent. The
19216     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
19217     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
19218     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
19219     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
19220     * is set then this item is group index item that is displayed at the top
19221     * until the next group comes. The func parameter is a convenience callback
19222     * that is called when the item is selected and the data parameter will be
19223     * the func_data parameter, obj be the genlist object and event_info will be
19224     * the genlist item.
19225     *
19226     * elm_genlist_item_append() adds an item to the end of the list, or if
19227     * there is a parent, to the end of all the child items of the parent.
19228     * elm_genlist_item_prepend() is the same but adds to the beginning of
19229     * the list or children list. elm_genlist_item_insert_before() inserts at
19230     * item before another item and elm_genlist_item_insert_after() inserts after
19231     * the indicated item.
19232     *
19233     * The application can clear the list with elm_genlist_clear() which deletes
19234     * all the items in the list and elm_genlist_item_del() will delete a specific
19235     * item. elm_genlist_item_subitems_clear() will clear all items that are
19236     * children of the indicated parent item.
19237     *
19238     * To help inspect list items you can jump to the item at the top of the list
19239     * with elm_genlist_first_item_get() which will return the item pointer, and
19240     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
19241     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
19242     * and previous items respectively relative to the indicated item. Using
19243     * these calls you can walk the entire item list/tree. Note that as a tree
19244     * the items are flattened in the list, so elm_genlist_item_parent_get() will
19245     * let you know which item is the parent (and thus know how to skip them if
19246     * wanted).
19247     *
19248     * @section Genlist_Muti_Selection Multi-selection
19249     *
19250     * If the application wants multiple items to be able to be selected,
19251     * elm_genlist_multi_select_set() can enable this. If the list is
19252     * single-selection only (the default), then elm_genlist_selected_item_get()
19253     * will return the selected item, if any, or NULL if none is selected. If the
19254     * list is multi-select then elm_genlist_selected_items_get() will return a
19255     * list (that is only valid as long as no items are modified (added, deleted,
19256     * selected or unselected)).
19257     *
19258     * @section Genlist_Usage_Hints Usage hints
19259     *
19260     * There are also convenience functions. elm_genlist_item_genlist_get() will
19261     * return the genlist object the item belongs to. elm_genlist_item_show()
19262     * will make the scroller scroll to show that specific item so its visible.
19263     * elm_genlist_item_data_get() returns the data pointer set by the item
19264     * creation functions.
19265     *
19266     * If an item changes (state of boolean changes, text or contents change),
19267     * then use elm_genlist_item_update() to have genlist update the item with
19268     * the new state. Genlist will re-realize the item thus call the functions
19269     * in the _Elm_Genlist_Item_Class for that item.
19270     *
19271     * To programmatically (un)select an item use elm_genlist_item_selected_set().
19272     * To get its selected state use elm_genlist_item_selected_get(). Similarly
19273     * to expand/contract an item and get its expanded state, use
19274     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
19275     * again to make an item disabled (unable to be selected and appear
19276     * differently) use elm_genlist_item_disabled_set() to set this and
19277     * elm_genlist_item_disabled_get() to get the disabled state.
19278     *
19279     * In general to indicate how the genlist should expand items horizontally to
19280     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
19281     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
19282     * mode means that if items are too wide to fit, the scroller will scroll
19283     * horizontally. Otherwise items are expanded to fill the width of the
19284     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
19285     * to the viewport width and limited to that size. This can be combined with
19286     * a different style that uses edjes' ellipsis feature (cutting text off like
19287     * this: "tex...").
19288     *
19289     * Items will only call their selection func and callback when first becoming
19290     * selected. Any further clicks will do nothing, unless you enable always
19291     * select with elm_genlist_always_select_mode_set(). This means even if
19292     * selected, every click will make the selected callbacks be called.
19293     * elm_genlist_no_select_mode_set() will turn off the ability to select
19294     * items entirely and they will neither appear selected nor call selected
19295     * callback functions.
19296     *
19297     * Remember that you can create new styles and add your own theme augmentation
19298     * per application with elm_theme_extension_add(). If you absolutely must
19299     * have a specific style that overrides any theme the user or system sets up
19300     * you can use elm_theme_overlay_add() to add such a file.
19301     *
19302     * @section Genlist_Implementation Implementation
19303     *
19304     * Evas tracks every object you create. Every time it processes an event
19305     * (mouse move, down, up etc.) it needs to walk through objects and find out
19306     * what event that affects. Even worse every time it renders display updates,
19307     * in order to just calculate what to re-draw, it needs to walk through many
19308     * many many objects. Thus, the more objects you keep active, the more
19309     * overhead Evas has in just doing its work. It is advisable to keep your
19310     * active objects to the minimum working set you need. Also remember that
19311     * object creation and deletion carries an overhead, so there is a
19312     * middle-ground, which is not easily determined. But don't keep massive lists
19313     * of objects you can't see or use. Genlist does this with list objects. It
19314     * creates and destroys them dynamically as you scroll around. It groups them
19315     * into blocks so it can determine the visibility etc. of a whole block at
19316     * once as opposed to having to walk the whole list. This 2-level list allows
19317     * for very large numbers of items to be in the list (tests have used up to
19318     * 2,000,000 items). Also genlist employs a queue for adding items. As items
19319     * may be different sizes, every item added needs to be calculated as to its
19320     * size and thus this presents a lot of overhead on populating the list, this
19321     * genlist employs a queue. Any item added is queued and spooled off over
19322     * time, actually appearing some time later, so if your list has many members
19323     * you may find it takes a while for them to all appear, with your process
19324     * consuming a lot of CPU while it is busy spooling.
19325     *
19326     * Genlist also implements a tree structure, but it does so with callbacks to
19327     * the application, with the application filling in tree structures when
19328     * requested (allowing for efficient building of a very deep tree that could
19329     * even be used for file-management). See the above smart signal callbacks for
19330     * details.
19331     *
19332     * @section Genlist_Smart_Events Genlist smart events
19333     *
19334     * Signals that you can add callbacks for are:
19335     * - @c "activated" - The user has double-clicked or pressed
19336     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
19337     *   item that was activated.
19338     * - @c "clicked,double" - The user has double-clicked an item.  The @c
19339     *   event_info parameter is the item that was double-clicked.
19340     * - @c "selected" - This is called when a user has made an item selected.
19341     *   The event_info parameter is the genlist item that was selected.
19342     * - @c "unselected" - This is called when a user has made an item
19343     *   unselected. The event_info parameter is the genlist item that was
19344     *   unselected.
19345     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
19346     *   called and the item is now meant to be expanded. The event_info
19347     *   parameter is the genlist item that was indicated to expand.  It is the
19348     *   job of this callback to then fill in the child items.
19349     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
19350     *   called and the item is now meant to be contracted. The event_info
19351     *   parameter is the genlist item that was indicated to contract. It is the
19352     *   job of this callback to then delete the child items.
19353     * - @c "expand,request" - This is called when a user has indicated they want
19354     *   to expand a tree branch item. The callback should decide if the item can
19355     *   expand (has any children) and then call elm_genlist_item_expanded_set()
19356     *   appropriately to set the state. The event_info parameter is the genlist
19357     *   item that was indicated to expand.
19358     * - @c "contract,request" - This is called when a user has indicated they
19359     *   want to contract a tree branch item. The callback should decide if the
19360     *   item can contract (has any children) and then call
19361     *   elm_genlist_item_expanded_set() appropriately to set the state. The
19362     *   event_info parameter is the genlist item that was indicated to contract.
19363     * - @c "realized" - This is called when the item in the list is created as a
19364     *   real evas object. event_info parameter is the genlist item that was
19365     *   created. The object may be deleted at any time, so it is up to the
19366     *   caller to not use the object pointer from elm_genlist_item_object_get()
19367     *   in a way where it may point to freed objects.
19368     * - @c "unrealized" - This is called just before an item is unrealized.
19369     *   After this call content objects provided will be deleted and the item
19370     *   object itself delete or be put into a floating cache.
19371     * - @c "drag,start,up" - This is called when the item in the list has been
19372     *   dragged (not scrolled) up.
19373     * - @c "drag,start,down" - This is called when the item in the list has been
19374     *   dragged (not scrolled) down.
19375     * - @c "drag,start,left" - This is called when the item in the list has been
19376     *   dragged (not scrolled) left.
19377     * - @c "drag,start,right" - This is called when the item in the list has
19378     *   been dragged (not scrolled) right.
19379     * - @c "drag,stop" - This is called when the item in the list has stopped
19380     *   being dragged.
19381     * - @c "drag" - This is called when the item in the list is being dragged.
19382     * - @c "longpressed" - This is called when the item is pressed for a certain
19383     *   amount of time. By default it's 1 second.
19384     * - @c "scroll,anim,start" - This is called when scrolling animation has
19385     *   started.
19386     * - @c "scroll,anim,stop" - This is called when scrolling animation has
19387     *   stopped.
19388     * - @c "scroll,drag,start" - This is called when dragging the content has
19389     *   started.
19390     * - @c "scroll,drag,stop" - This is called when dragging the content has
19391     *   stopped.
19392     * - @c "edge,top" - This is called when the genlist is scrolled until
19393     *   the top edge.
19394     * - @c "edge,bottom" - This is called when the genlist is scrolled
19395     *   until the bottom edge.
19396     * - @c "edge,left" - This is called when the genlist is scrolled
19397     *   until the left edge.
19398     * - @c "edge,right" - This is called when the genlist is scrolled
19399     *   until the right edge.
19400     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
19401     *   swiped left.
19402     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
19403     *   swiped right.
19404     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
19405     *   swiped up.
19406     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
19407     *   swiped down.
19408     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
19409     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
19410     *   multi-touch pinched in.
19411     * - @c "swipe" - This is called when the genlist is swiped.
19412     * - @c "moved" - This is called when a genlist item is moved.
19413     * - @c "language,changed" - This is called when the program's language is
19414     *   changed.
19415     *
19416     * @section Genlist_Examples Examples
19417     *
19418     * Here is a list of examples that use the genlist, trying to show some of
19419     * its capabilities:
19420     * - @ref genlist_example_01
19421     * - @ref genlist_example_02
19422     * - @ref genlist_example_03
19423     * - @ref genlist_example_04
19424     * - @ref genlist_example_05
19425     */
19426
19427    /**
19428     * @addtogroup Genlist
19429     * @{
19430     */
19431
19432    /**
19433     * @enum _Elm_Genlist_Item_Flags
19434     * @typedef Elm_Genlist_Item_Flags
19435     *
19436     * Defines if the item is of any special type (has subitems or it's the
19437     * index of a group), or is just a simple item.
19438     *
19439     * @ingroup Genlist
19440     */
19441    typedef enum _Elm_Genlist_Item_Flags
19442      {
19443         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
19444         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
19445         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
19446      } Elm_Genlist_Item_Flags;
19447    typedef enum _Elm_Genlist_Item_Field_Flags
19448      {
19449         ELM_GENLIST_ITEM_FIELD_ALL = 0,
19450         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
19451         ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
19452         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
19453      } Elm_Genlist_Item_Field_Flags;
19454    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
19455    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
19456    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19457    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19458    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
19459
19460    /**
19461     * Text fetching class function for Elm_Gen_Item_Class.
19462     * @param data The data passed in the item creation function
19463     * @param obj The base widget object
19464     * @param part The part name of the swallow
19465     * @return The allocated (NOT stringshared) string to set as the text
19466     */
19467    typedef char        *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19468
19469    /**
19470     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
19471     * @param data The data passed in the item creation function
19472     * @param obj The base widget object
19473     * @param part The part name of the swallow
19474     * @return The content object to swallow
19475     */
19476    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
19477
19478    /**
19479     * State fetching class function for Elm_Gen_Item_Class.
19480     * @param data The data passed in the item creation function
19481     * @param obj The base widget object
19482     * @param part The part name of the swallow
19483     * @return The hell if I know
19484     */
19485    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19486
19487    /**
19488     * Deletion class function for Elm_Gen_Item_Class.
19489     * @param data The data passed in the item creation function
19490     * @param obj The base widget object
19491     */
19492    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj);
19493
19494    /**
19495     * @struct _Elm_Genlist_Item_Class
19496     *
19497     * Genlist item class definition structs.
19498     *
19499     * This struct contains the style and fetching functions that will define the
19500     * contents of each item.
19501     *
19502     * @see @ref Genlist_Item_Class
19503     */
19504    struct _Elm_Genlist_Item_Class
19505      {
19506         const char                *item_style; /**< style of this class. */
19507         struct Elm_Genlist_Item_Class_Func
19508           {
19509              Elm_Genlist_Item_Text_Get_Cb    text_get; /**< Text fetching class function for genlist item classes.*/
19510              Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
19511              Elm_Genlist_Item_State_Get_Cb   state_get; /**< State fetching class function for genlist item classes. */
19512              Elm_Genlist_Item_Del_Cb         del; /**< Deletion class function for genlist item classes. */
19513           } func;
19514      };
19515    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
19516    /**
19517     * Add a new genlist widget to the given parent Elementary
19518     * (container) object
19519     *
19520     * @param parent The parent object
19521     * @return a new genlist widget handle or @c NULL, on errors
19522     *
19523     * This function inserts a new genlist widget on the canvas.
19524     *
19525     * @see elm_genlist_item_append()
19526     * @see elm_genlist_item_del()
19527     * @see elm_genlist_clear()
19528     *
19529     * @ingroup Genlist
19530     */
19531    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19532
19533    /**
19534     * Remove all items from a given genlist widget.
19535     *
19536     * @param obj The genlist object
19537     *
19538     * This removes (and deletes) all items in @p obj, leaving it empty.
19539     *
19540     * @see elm_genlist_item_del(), to remove just one item.
19541     *
19542     * @ingroup Genlist
19543     */
19544    EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19545
19546    /**
19547     * Enable or disable multi-selection in the genlist
19548     *
19549     * @param obj The genlist object
19550     * @param multi Multi-select enable/disable. Default is disabled.
19551     *
19552     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
19553     * the list. This allows more than 1 item to be selected. To retrieve the list
19554     * of selected items, use elm_genlist_selected_items_get().
19555     *
19556     * @see elm_genlist_selected_items_get()
19557     * @see elm_genlist_multi_select_get()
19558     *
19559     * @ingroup Genlist
19560     */
19561    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
19562
19563    /**
19564     * Gets if multi-selection in genlist is enabled or disabled.
19565     *
19566     * @param obj The genlist object
19567     * @return Multi-select enabled/disabled
19568     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
19569     *
19570     * @see elm_genlist_multi_select_set()
19571     *
19572     * @ingroup Genlist
19573     */
19574    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19575
19576    /**
19577     * This sets the horizontal stretching mode.
19578     *
19579     * @param obj The genlist object
19580     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
19581     *
19582     * This sets the mode used for sizing items horizontally. Valid modes
19583     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
19584     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
19585     * the scroller will scroll horizontally. Otherwise items are expanded
19586     * to fill the width of the viewport of the scroller. If it is
19587     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
19588     * limited to that size.
19589     *
19590     * @see elm_genlist_horizontal_get()
19591     *
19592     * @ingroup Genlist
19593     */
19594    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19595    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19596
19597    /**
19598     * Gets the horizontal stretching mode.
19599     *
19600     * @param obj The genlist object
19601     * @return The mode to use
19602     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
19603     *
19604     * @see elm_genlist_horizontal_set()
19605     *
19606     * @ingroup Genlist
19607     */
19608    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19609    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19610
19611    /**
19612     * Set the always select mode.
19613     *
19614     * @param obj The genlist object
19615     * @param always_select The always select mode (@c EINA_TRUE = on, @c
19616     * EINA_FALSE = off). Default is @c EINA_FALSE.
19617     *
19618     * Items will only call their selection func and callback when first
19619     * becoming selected. Any further clicks will do nothing, unless you
19620     * enable always select with elm_genlist_always_select_mode_set().
19621     * This means that, even if selected, every click will make the selected
19622     * callbacks be called.
19623     *
19624     * @see elm_genlist_always_select_mode_get()
19625     *
19626     * @ingroup Genlist
19627     */
19628    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
19629
19630    /**
19631     * Get the always select mode.
19632     *
19633     * @param obj The genlist object
19634     * @return The always select mode
19635     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19636     *
19637     * @see elm_genlist_always_select_mode_set()
19638     *
19639     * @ingroup Genlist
19640     */
19641    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19642
19643    /**
19644     * Enable/disable the no select mode.
19645     *
19646     * @param obj The genlist object
19647     * @param no_select The no select mode
19648     * (EINA_TRUE = on, EINA_FALSE = off)
19649     *
19650     * This will turn off the ability to select items entirely and they
19651     * will neither appear selected nor call selected callback functions.
19652     *
19653     * @see elm_genlist_no_select_mode_get()
19654     *
19655     * @ingroup Genlist
19656     */
19657    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
19658
19659    /**
19660     * Gets whether the no select mode is enabled.
19661     *
19662     * @param obj The genlist object
19663     * @return The no select mode
19664     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19665     *
19666     * @see elm_genlist_no_select_mode_set()
19667     *
19668     * @ingroup Genlist
19669     */
19670    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19671
19672    /**
19673     * Enable/disable compress mode.
19674     *
19675     * @param obj The genlist object
19676     * @param compress The compress mode
19677     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
19678     *
19679     * This will enable the compress mode where items are "compressed"
19680     * horizontally to fit the genlist scrollable viewport width. This is
19681     * special for genlist.  Do not rely on
19682     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
19683     * work as genlist needs to handle it specially.
19684     *
19685     * @see elm_genlist_compress_mode_get()
19686     *
19687     * @ingroup Genlist
19688     */
19689    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
19690
19691    /**
19692     * Get whether the compress mode is enabled.
19693     *
19694     * @param obj The genlist object
19695     * @return The compress mode
19696     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19697     *
19698     * @see elm_genlist_compress_mode_set()
19699     *
19700     * @ingroup Genlist
19701     */
19702    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19703
19704    /**
19705     * Enable/disable height-for-width mode.
19706     *
19707     * @param obj The genlist object
19708     * @param setting The height-for-width mode (@c EINA_TRUE = on,
19709     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
19710     *
19711     * With height-for-width mode the item width will be fixed (restricted
19712     * to a minimum of) to the list width when calculating its size in
19713     * order to allow the height to be calculated based on it. This allows,
19714     * for instance, text block to wrap lines if the Edje part is
19715     * configured with "text.min: 0 1".
19716     *
19717     * @note This mode will make list resize slower as it will have to
19718     *       recalculate every item height again whenever the list width
19719     *       changes!
19720     *
19721     * @note When height-for-width mode is enabled, it also enables
19722     *       compress mode (see elm_genlist_compress_mode_set()) and
19723     *       disables homogeneous (see elm_genlist_homogeneous_set()).
19724     *
19725     * @ingroup Genlist
19726     */
19727    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
19728
19729    /**
19730     * Get whether the height-for-width mode is enabled.
19731     *
19732     * @param obj The genlist object
19733     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
19734     * off)
19735     *
19736     * @ingroup Genlist
19737     */
19738    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19739
19740    /**
19741     * Enable/disable horizontal and vertical bouncing effect.
19742     *
19743     * @param obj The genlist object
19744     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
19745     * EINA_FALSE = off). Default is @c EINA_FALSE.
19746     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
19747     * EINA_FALSE = off). Default is @c EINA_TRUE.
19748     *
19749     * This will enable or disable the scroller bouncing effect for the
19750     * genlist. See elm_scroller_bounce_set() for details.
19751     *
19752     * @see elm_scroller_bounce_set()
19753     * @see elm_genlist_bounce_get()
19754     *
19755     * @ingroup Genlist
19756     */
19757    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
19758
19759    /**
19760     * Get whether the horizontal and vertical bouncing effect is enabled.
19761     *
19762     * @param obj The genlist object
19763     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
19764     * option is set.
19765     * @param v_bounce Pointer to a bool to receive if the bounce vertically
19766     * option is set.
19767     *
19768     * @see elm_genlist_bounce_set()
19769     *
19770     * @ingroup Genlist
19771     */
19772    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
19773
19774    /**
19775     * Enable/disable homogeneous mode.
19776     *
19777     * @param obj The genlist object
19778     * @param homogeneous Assume the items within the genlist are of the
19779     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
19780     * EINA_FALSE.
19781     *
19782     * This will enable the homogeneous mode where items are of the same
19783     * height and width so that genlist may do the lazy-loading at its
19784     * maximum (which increases the performance for scrolling the list). This
19785     * implies 'compressed' mode.
19786     *
19787     * @see elm_genlist_compress_mode_set()
19788     * @see elm_genlist_homogeneous_get()
19789     *
19790     * @ingroup Genlist
19791     */
19792    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
19793
19794    /**
19795     * Get whether the homogeneous mode is enabled.
19796     *
19797     * @param obj The genlist object
19798     * @return Assume the items within the genlist are of the same height
19799     * and width (EINA_TRUE = on, EINA_FALSE = off)
19800     *
19801     * @see elm_genlist_homogeneous_set()
19802     *
19803     * @ingroup Genlist
19804     */
19805    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19806
19807    /**
19808     * Set the maximum number of items within an item block
19809     *
19810     * @param obj The genlist object
19811     * @param n   Maximum number of items within an item block. Default is 32.
19812     *
19813     * This will configure the block count to tune to the target with
19814     * particular performance matrix.
19815     *
19816     * A block of objects will be used to reduce the number of operations due to
19817     * many objects in the screen. It can determine the visibility, or if the
19818     * object has changed, it theme needs to be updated, etc. doing this kind of
19819     * calculation to the entire block, instead of per object.
19820     *
19821     * The default value for the block count is enough for most lists, so unless
19822     * you know you will have a lot of objects visible in the screen at the same
19823     * time, don't try to change this.
19824     *
19825     * @see elm_genlist_block_count_get()
19826     * @see @ref Genlist_Implementation
19827     *
19828     * @ingroup Genlist
19829     */
19830    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
19831
19832    /**
19833     * Get the maximum number of items within an item block
19834     *
19835     * @param obj The genlist object
19836     * @return Maximum number of items within an item block
19837     *
19838     * @see elm_genlist_block_count_set()
19839     *
19840     * @ingroup Genlist
19841     */
19842    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19843
19844    /**
19845     * Set the timeout in seconds for the longpress event.
19846     *
19847     * @param obj The genlist object
19848     * @param timeout timeout in seconds. Default is 1.
19849     *
19850     * This option will change how long it takes to send an event "longpressed"
19851     * after the mouse down signal is sent to the list. If this event occurs, no
19852     * "clicked" event will be sent.
19853     *
19854     * @see elm_genlist_longpress_timeout_set()
19855     *
19856     * @ingroup Genlist
19857     */
19858    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19859
19860    /**
19861     * Get the timeout in seconds for the longpress event.
19862     *
19863     * @param obj The genlist object
19864     * @return timeout in seconds
19865     *
19866     * @see elm_genlist_longpress_timeout_get()
19867     *
19868     * @ingroup Genlist
19869     */
19870    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19871
19872    /**
19873     * Append a new item in a given genlist widget.
19874     *
19875     * @param obj The genlist object
19876     * @param itc The item class for the item
19877     * @param data The item data
19878     * @param parent The parent item, or NULL if none
19879     * @param flags Item flags
19880     * @param func Convenience function called when the item is selected
19881     * @param func_data Data passed to @p func above.
19882     * @return A handle to the item added or @c NULL if not possible
19883     *
19884     * This adds the given item to the end of the list or the end of
19885     * the children list if the @p parent is given.
19886     *
19887     * @see elm_genlist_item_prepend()
19888     * @see elm_genlist_item_insert_before()
19889     * @see elm_genlist_item_insert_after()
19890     * @see elm_genlist_item_del()
19891     *
19892     * @ingroup Genlist
19893     */
19894    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);
19895
19896    /**
19897     * Prepend a new item in a given genlist widget.
19898     *
19899     * @param obj The genlist object
19900     * @param itc The item class for the item
19901     * @param data The item data
19902     * @param parent The parent item, or NULL if none
19903     * @param flags Item flags
19904     * @param func Convenience function called when the item is selected
19905     * @param func_data Data passed to @p func above.
19906     * @return A handle to the item added or NULL if not possible
19907     *
19908     * This adds an item to the beginning of the list or beginning of the
19909     * children of the parent if given.
19910     *
19911     * @see elm_genlist_item_append()
19912     * @see elm_genlist_item_insert_before()
19913     * @see elm_genlist_item_insert_after()
19914     * @see elm_genlist_item_del()
19915     *
19916     * @ingroup Genlist
19917     */
19918    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);
19919
19920    /**
19921     * Insert an item before another in a genlist widget
19922     *
19923     * @param obj The genlist object
19924     * @param itc The item class for the item
19925     * @param data The item data
19926     * @param before The item to place this new one before.
19927     * @param flags Item flags
19928     * @param func Convenience function called when the item is selected
19929     * @param func_data Data passed to @p func above.
19930     * @return A handle to the item added or @c NULL if not possible
19931     *
19932     * This inserts an item before another in the list. It will be in the
19933     * same tree level or group as the item it is inserted before.
19934     *
19935     * @see elm_genlist_item_append()
19936     * @see elm_genlist_item_prepend()
19937     * @see elm_genlist_item_insert_after()
19938     * @see elm_genlist_item_del()
19939     *
19940     * @ingroup Genlist
19941     */
19942    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);
19943
19944    /**
19945     * Insert an item after another in a genlist widget
19946     *
19947     * @param obj The genlist object
19948     * @param itc The item class for the item
19949     * @param data The item data
19950     * @param after The item to place this new one after.
19951     * @param flags Item flags
19952     * @param func Convenience function called when the item is selected
19953     * @param func_data Data passed to @p func above.
19954     * @return A handle to the item added or @c NULL if not possible
19955     *
19956     * This inserts an item after another in the list. It will be in the
19957     * same tree level or group as the item it is inserted after.
19958     *
19959     * @see elm_genlist_item_append()
19960     * @see elm_genlist_item_prepend()
19961     * @see elm_genlist_item_insert_before()
19962     * @see elm_genlist_item_del()
19963     *
19964     * @ingroup Genlist
19965     */
19966    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);
19967
19968    /**
19969     * Insert a new item into the sorted genlist object
19970     *
19971     * @param obj The genlist object
19972     * @param itc The item class for the item
19973     * @param data The item data
19974     * @param parent The parent item, or NULL if none
19975     * @param flags Item flags
19976     * @param comp The function called for the sort
19977     * @param func Convenience function called when item selected
19978     * @param func_data Data passed to @p func above.
19979     * @return A handle to the item added or NULL if not possible
19980     *
19981     * @ingroup Genlist
19982     */
19983    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);
19984    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);
19985
19986    /* operations to retrieve existing items */
19987    /**
19988     * Get the selectd item in the genlist.
19989     *
19990     * @param obj The genlist object
19991     * @return The selected item, or NULL if none is selected.
19992     *
19993     * This gets the selected item in the list (if multi-selection is enabled, only
19994     * the item that was first selected in the list is returned - which is not very
19995     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19996     * used).
19997     *
19998     * If no item is selected, NULL is returned.
19999     *
20000     * @see elm_genlist_selected_items_get()
20001     *
20002     * @ingroup Genlist
20003     */
20004    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20005
20006    /**
20007     * Get a list of selected items in the genlist.
20008     *
20009     * @param obj The genlist object
20010     * @return The list of selected items, or NULL if none are selected.
20011     *
20012     * It returns a list of the selected items. This list pointer is only valid so
20013     * long as the selection doesn't change (no items are selected or unselected, or
20014     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
20015     * pointers. The order of the items in this list is the order which they were
20016     * selected, i.e. the first item in this list is the first item that was
20017     * selected, and so on.
20018     *
20019     * @note If not in multi-select mode, consider using function
20020     * elm_genlist_selected_item_get() instead.
20021     *
20022     * @see elm_genlist_multi_select_set()
20023     * @see elm_genlist_selected_item_get()
20024     *
20025     * @ingroup Genlist
20026     */
20027    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20028
20029    /**
20030     * Get the mode item style of items in the genlist
20031     * @param obj The genlist object
20032     * @return The mode item style string, or NULL if none is specified
20033     *
20034     * This is a constant string and simply defines the name of the
20035     * style that will be used for mode animations. It can be
20036     * @c NULL if you don't plan to use Genlist mode. See
20037     * elm_genlist_item_mode_set() for more info.
20038     *
20039     * @ingroup Genlist
20040     */
20041    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20042
20043    /**
20044     * Set the mode item style of items in the genlist
20045     * @param obj The genlist object
20046     * @param style The mode item style string, or NULL if none is desired
20047     *
20048     * This is a constant string and simply defines the name of the
20049     * style that will be used for mode animations. It can be
20050     * @c NULL if you don't plan to use Genlist mode. See
20051     * elm_genlist_item_mode_set() for more info.
20052     *
20053     * @ingroup Genlist
20054     */
20055    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
20056
20057    /**
20058     * Get a list of realized items in genlist
20059     *
20060     * @param obj The genlist object
20061     * @return The list of realized items, nor NULL if none are realized.
20062     *
20063     * This returns a list of the realized items in the genlist. The list
20064     * contains Elm_Genlist_Item pointers. The list must be freed by the
20065     * caller when done with eina_list_free(). The item pointers in the
20066     * list are only valid so long as those items are not deleted or the
20067     * genlist is not deleted.
20068     *
20069     * @see elm_genlist_realized_items_update()
20070     *
20071     * @ingroup Genlist
20072     */
20073    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20074
20075    /**
20076     * Get the item that is at the x, y canvas coords.
20077     *
20078     * @param obj The gelinst object.
20079     * @param x The input x coordinate
20080     * @param y The input y coordinate
20081     * @param posret The position relative to the item returned here
20082     * @return The item at the coordinates or NULL if none
20083     *
20084     * This returns the item at the given coordinates (which are canvas
20085     * relative, not object-relative). If an item is at that coordinate,
20086     * that item handle is returned, and if @p posret is not NULL, the
20087     * integer pointed to is set to a value of -1, 0 or 1, depending if
20088     * the coordinate is on the upper portion of that item (-1), on the
20089     * middle section (0) or on the lower part (1). If NULL is returned as
20090     * an item (no item found there), then posret may indicate -1 or 1
20091     * based if the coordinate is above or below all items respectively in
20092     * the genlist.
20093     *
20094     * @ingroup Genlist
20095     */
20096    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);
20097
20098    /**
20099     * Get the first item in the genlist
20100     *
20101     * This returns the first item in the list.
20102     *
20103     * @param obj The genlist object
20104     * @return The first item, or NULL if none
20105     *
20106     * @ingroup Genlist
20107     */
20108    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20109
20110    /**
20111     * Get the last item in the genlist
20112     *
20113     * This returns the last item in the list.
20114     *
20115     * @return The last item, or NULL if none
20116     *
20117     * @ingroup Genlist
20118     */
20119    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20120
20121    /**
20122     * Set the scrollbar policy
20123     *
20124     * @param obj The genlist object
20125     * @param policy_h Horizontal scrollbar policy.
20126     * @param policy_v Vertical scrollbar policy.
20127     *
20128     * This sets the scrollbar visibility policy for the given genlist
20129     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
20130     * made visible if it is needed, and otherwise kept hidden.
20131     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
20132     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
20133     * respectively for the horizontal and vertical scrollbars. Default is
20134     * #ELM_SMART_SCROLLER_POLICY_AUTO
20135     *
20136     * @see elm_genlist_scroller_policy_get()
20137     *
20138     * @ingroup Genlist
20139     */
20140    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
20141
20142    /**
20143     * Get the scrollbar policy
20144     *
20145     * @param obj The genlist object
20146     * @param policy_h Pointer to store the horizontal scrollbar policy.
20147     * @param policy_v Pointer to store the vertical scrollbar policy.
20148     *
20149     * @see elm_genlist_scroller_policy_set()
20150     *
20151     * @ingroup Genlist
20152     */
20153    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);
20154
20155    /**
20156     * Get the @b next item in a genlist widget's internal list of items,
20157     * given a handle to one of those items.
20158     *
20159     * @param item The genlist item to fetch next from
20160     * @return The item after @p item, or @c NULL if there's none (and
20161     * on errors)
20162     *
20163     * This returns the item placed after the @p item, on the container
20164     * genlist.
20165     *
20166     * @see elm_genlist_item_prev_get()
20167     *
20168     * @ingroup Genlist
20169     */
20170    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20171
20172    /**
20173     * Get the @b previous item in a genlist widget's internal list of items,
20174     * given a handle to one of those items.
20175     *
20176     * @param item The genlist item to fetch previous from
20177     * @return The item before @p item, or @c NULL if there's none (and
20178     * on errors)
20179     *
20180     * This returns the item placed before the @p item, on the container
20181     * genlist.
20182     *
20183     * @see elm_genlist_item_next_get()
20184     *
20185     * @ingroup Genlist
20186     */
20187    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20188
20189    /**
20190     * Get the genlist object's handle which contains a given genlist
20191     * item
20192     *
20193     * @param item The item to fetch the container from
20194     * @return The genlist (parent) object
20195     *
20196     * This returns the genlist object itself that an item belongs to.
20197     *
20198     * @ingroup Genlist
20199     */
20200    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20201
20202    /**
20203     * Get the parent item of the given item
20204     *
20205     * @param it The item
20206     * @return The parent of the item or @c NULL if it has no parent.
20207     *
20208     * This returns the item that was specified as parent of the item @p it on
20209     * elm_genlist_item_append() and insertion related functions.
20210     *
20211     * @ingroup Genlist
20212     */
20213    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20214
20215    /**
20216     * Remove all sub-items (children) of the given item
20217     *
20218     * @param it The item
20219     *
20220     * This removes all items that are children (and their descendants) of the
20221     * given item @p it.
20222     *
20223     * @see elm_genlist_clear()
20224     * @see elm_genlist_item_del()
20225     *
20226     * @ingroup Genlist
20227     */
20228    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20229
20230    /**
20231     * Set whether a given genlist item is selected or not
20232     *
20233     * @param it The item
20234     * @param selected Use @c EINA_TRUE, to make it selected, @c
20235     * EINA_FALSE to make it unselected
20236     *
20237     * This sets the selected state of an item. If multi selection is
20238     * not enabled on the containing genlist and @p selected is @c
20239     * EINA_TRUE, any other previously selected items will get
20240     * unselected in favor of this new one.
20241     *
20242     * @see elm_genlist_item_selected_get()
20243     *
20244     * @ingroup Genlist
20245     */
20246    EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20247
20248    /**
20249     * Get whether a given genlist item is selected or not
20250     *
20251     * @param it The item
20252     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20253     *
20254     * @see elm_genlist_item_selected_set() for more details
20255     *
20256     * @ingroup Genlist
20257     */
20258    EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20259
20260    /**
20261     * Sets the expanded state of an item.
20262     *
20263     * @param it The item
20264     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
20265     *
20266     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
20267     * expanded or not.
20268     *
20269     * The theme will respond to this change visually, and a signal "expanded" or
20270     * "contracted" will be sent from the genlist with a pointer to the item that
20271     * has been expanded/contracted.
20272     *
20273     * Calling this function won't show or hide any child of this item (if it is
20274     * a parent). You must manually delete and create them on the callbacks fo
20275     * the "expanded" or "contracted" signals.
20276     *
20277     * @see elm_genlist_item_expanded_get()
20278     *
20279     * @ingroup Genlist
20280     */
20281    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
20282
20283    /**
20284     * Get the expanded state of an item
20285     *
20286     * @param it The item
20287     * @return The expanded state
20288     *
20289     * This gets the expanded state of an item.
20290     *
20291     * @see elm_genlist_item_expanded_set()
20292     *
20293     * @ingroup Genlist
20294     */
20295    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20296
20297    /**
20298     * Get the depth of expanded item
20299     *
20300     * @param it The genlist item object
20301     * @return The depth of expanded item
20302     *
20303     * @ingroup Genlist
20304     */
20305    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20306
20307    /**
20308     * Set whether a given genlist item is disabled or not.
20309     *
20310     * @param it The item
20311     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
20312     * to enable it back.
20313     *
20314     * A disabled item cannot be selected or unselected. It will also
20315     * change its appearance, to signal the user it's disabled.
20316     *
20317     * @see elm_genlist_item_disabled_get()
20318     *
20319     * @ingroup Genlist
20320     */
20321    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20322
20323    /**
20324     * Get whether a given genlist item is disabled or not.
20325     *
20326     * @param it The item
20327     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
20328     * (and on errors).
20329     *
20330     * @see elm_genlist_item_disabled_set() for more details
20331     *
20332     * @ingroup Genlist
20333     */
20334    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20335
20336    /**
20337     * Sets the display only state of an item.
20338     *
20339     * @param it The item
20340     * @param display_only @c EINA_TRUE if the item is display only, @c
20341     * EINA_FALSE otherwise.
20342     *
20343     * A display only item cannot be selected or unselected. It is for
20344     * display only and not selecting or otherwise clicking, dragging
20345     * etc. by the user, thus finger size rules will not be applied to
20346     * this item.
20347     *
20348     * It's good to set group index items to display only state.
20349     *
20350     * @see elm_genlist_item_display_only_get()
20351     *
20352     * @ingroup Genlist
20353     */
20354    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
20355
20356    /**
20357     * Get the display only state of an item
20358     *
20359     * @param it The item
20360     * @return @c EINA_TRUE if the item is display only, @c
20361     * EINA_FALSE otherwise.
20362     *
20363     * @see elm_genlist_item_display_only_set()
20364     *
20365     * @ingroup Genlist
20366     */
20367    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20368
20369    /**
20370     * Show the portion of a genlist's internal list containing a given
20371     * item, immediately.
20372     *
20373     * @param it The item to display
20374     *
20375     * This causes genlist to jump to the given item @p it and show it (by
20376     * immediately scrolling to that position), if it is not fully visible.
20377     *
20378     * @see elm_genlist_item_bring_in()
20379     * @see elm_genlist_item_top_show()
20380     * @see elm_genlist_item_middle_show()
20381     *
20382     * @ingroup Genlist
20383     */
20384    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20385
20386    /**
20387     * Animatedly bring in, to the visible are of a genlist, a given
20388     * item on it.
20389     *
20390     * @param it The item to display
20391     *
20392     * This causes genlist to jump to the given item @p it and show it (by
20393     * animatedly scrolling), if it is not fully visible. This may use animation
20394     * to do so and take a period of time
20395     *
20396     * @see elm_genlist_item_show()
20397     * @see elm_genlist_item_top_bring_in()
20398     * @see elm_genlist_item_middle_bring_in()
20399     *
20400     * @ingroup Genlist
20401     */
20402    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20403
20404    /**
20405     * Show the portion of a genlist's internal list containing a given
20406     * item, immediately.
20407     *
20408     * @param it The item to display
20409     *
20410     * This causes genlist to jump to the given item @p it and show it (by
20411     * immediately scrolling to that position), if it is not fully visible.
20412     *
20413     * The item will be positioned at the top of the genlist viewport.
20414     *
20415     * @see elm_genlist_item_show()
20416     * @see elm_genlist_item_top_bring_in()
20417     *
20418     * @ingroup Genlist
20419     */
20420    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20421
20422    /**
20423     * Animatedly bring in, to the visible are of a genlist, a given
20424     * item on it.
20425     *
20426     * @param it The item
20427     *
20428     * This causes genlist to jump to the given item @p it and show it (by
20429     * animatedly scrolling), if it is not fully visible. This may use animation
20430     * to do so and take a period of time
20431     *
20432     * The item will be positioned at the top of the genlist viewport.
20433     *
20434     * @see elm_genlist_item_bring_in()
20435     * @see elm_genlist_item_top_show()
20436     *
20437     * @ingroup Genlist
20438     */
20439    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20440
20441    /**
20442     * Show the portion of a genlist's internal list containing a given
20443     * item, immediately.
20444     *
20445     * @param it The item to display
20446     *
20447     * This causes genlist to jump to the given item @p it and show it (by
20448     * immediately scrolling to that position), if it is not fully visible.
20449     *
20450     * The item will be positioned at the middle of the genlist viewport.
20451     *
20452     * @see elm_genlist_item_show()
20453     * @see elm_genlist_item_middle_bring_in()
20454     *
20455     * @ingroup Genlist
20456     */
20457    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20458
20459    /**
20460     * Animatedly bring in, to the visible are of a genlist, a given
20461     * item on it.
20462     *
20463     * @param it The item
20464     *
20465     * This causes genlist to jump to the given item @p it and show it (by
20466     * animatedly scrolling), if it is not fully visible. This may use animation
20467     * to do so and take a period of time
20468     *
20469     * The item will be positioned at the middle of the genlist viewport.
20470     *
20471     * @see elm_genlist_item_bring_in()
20472     * @see elm_genlist_item_middle_show()
20473     *
20474     * @ingroup Genlist
20475     */
20476    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20477
20478    /**
20479     * Remove a genlist item from the its parent, deleting it.
20480     *
20481     * @param item The item to be removed.
20482     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
20483     *
20484     * @see elm_genlist_clear(), to remove all items in a genlist at
20485     * once.
20486     *
20487     * @ingroup Genlist
20488     */
20489    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20490
20491    /**
20492     * Return the data associated to a given genlist item
20493     *
20494     * @param item The genlist item.
20495     * @return the data associated to this item.
20496     *
20497     * This returns the @c data value passed on the
20498     * elm_genlist_item_append() and related item addition calls.
20499     *
20500     * @see elm_genlist_item_append()
20501     * @see elm_genlist_item_data_set()
20502     *
20503     * @ingroup Genlist
20504     */
20505    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20506
20507    /**
20508     * Set the data associated to a given genlist item
20509     *
20510     * @param item The genlist item
20511     * @param data The new data pointer to set on it
20512     *
20513     * This @b overrides the @c data value passed on the
20514     * elm_genlist_item_append() and related item addition calls. This
20515     * function @b won't call elm_genlist_item_update() automatically,
20516     * so you'd issue it afterwards if you want to hove the item
20517     * updated to reflect the that new data.
20518     *
20519     * @see elm_genlist_item_data_get()
20520     *
20521     * @ingroup Genlist
20522     */
20523    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
20524
20525    /**
20526     * Tells genlist to "orphan" contents fetchs by the item class
20527     *
20528     * @param it The item
20529     *
20530     * This instructs genlist to release references to contents in the item,
20531     * meaning that they will no longer be managed by genlist and are
20532     * floating "orphans" that can be re-used elsewhere if the user wants
20533     * to.
20534     *
20535     * @ingroup Genlist
20536     */
20537    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20538    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20539
20540    /**
20541     * Get the real Evas object created to implement the view of a
20542     * given genlist item
20543     *
20544     * @param item The genlist item.
20545     * @return the Evas object implementing this item's view.
20546     *
20547     * This returns the actual Evas object used to implement the
20548     * specified genlist item's view. This may be @c NULL, as it may
20549     * not have been created or may have been deleted, at any time, by
20550     * the genlist. <b>Do not modify this object</b> (move, resize,
20551     * show, hide, etc.), as the genlist is controlling it. This
20552     * function is for querying, emitting custom signals or hooking
20553     * lower level callbacks for events on that object. Do not delete
20554     * this object under any circumstances.
20555     *
20556     * @see elm_genlist_item_data_get()
20557     *
20558     * @ingroup Genlist
20559     */
20560    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20561
20562    /**
20563     * Update the contents of an item
20564     *
20565     * @param it The item
20566     *
20567     * This updates an item by calling all the item class functions again
20568     * to get the contents, texts and states. Use this when the original
20569     * item data has changed and the changes are desired to be reflected.
20570     *
20571     * Use elm_genlist_realized_items_update() to update all already realized
20572     * items.
20573     *
20574     * @see elm_genlist_realized_items_update()
20575     *
20576     * @ingroup Genlist
20577     */
20578    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20579
20580    /**
20581     * Promote an item to the top of the list
20582     *
20583     * @param it The item
20584     *
20585     * @ingroup Genlist
20586     */
20587    EAPI void               elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20588
20589    /**
20590     * Demote an item to the end of the list
20591     *
20592     * @param it The item
20593     *
20594     * @ingroup Genlist
20595     */
20596    EAPI void               elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20597
20598    /**
20599     * Update the part of an item
20600     *
20601     * @param it The item
20602     * @param parts The name of item's part
20603     * @param itf The flags of item's part type
20604     *
20605     * This updates an item's part by calling item's fetching functions again
20606     * to get the contents, texts and states. Use this when the original
20607     * item data has changed and the changes are desired to be reflected.
20608     * Second parts argument is used for globbing to match '*', '?', and '.'
20609     * It can be used at updating multi fields.
20610     *
20611     * Use elm_genlist_realized_items_update() to update an item's all
20612     * property.
20613     *
20614     * @see elm_genlist_item_update()
20615     *
20616     * @ingroup Genlist
20617     */
20618    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
20619
20620    /**
20621     * Update the item class of an item
20622     *
20623     * @param it The item
20624     * @param itc The item class for the item
20625     *
20626     * This sets another class fo the item, changing the way that it is
20627     * displayed. After changing the item class, elm_genlist_item_update() is
20628     * called on the item @p it.
20629     *
20630     * @ingroup Genlist
20631     */
20632    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
20633    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20634
20635    /**
20636     * Set the text to be shown in a given genlist item's tooltips.
20637     *
20638     * @param item The genlist item
20639     * @param text The text to set in the content
20640     *
20641     * This call will setup the text to be used as tooltip to that item
20642     * (analogous to elm_object_tooltip_text_set(), but being item
20643     * tooltips with higher precedence than object tooltips). It can
20644     * have only one tooltip at a time, so any previous tooltip data
20645     * will get removed.
20646     *
20647     * In order to set a content or something else as a tooltip, look at
20648     * elm_genlist_item_tooltip_content_cb_set().
20649     *
20650     * @ingroup Genlist
20651     */
20652    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
20653
20654    /**
20655     * Set the content to be shown in a given genlist item's tooltips
20656     *
20657     * @param item The genlist item.
20658     * @param func The function returning the tooltip contents.
20659     * @param data What to provide to @a func as callback data/context.
20660     * @param del_cb Called when data is not needed anymore, either when
20661     *        another callback replaces @p func, the tooltip is unset with
20662     *        elm_genlist_item_tooltip_unset() or the owner @p item
20663     *        dies. This callback receives as its first parameter the
20664     *        given @p data, being @c event_info the item handle.
20665     *
20666     * This call will setup the tooltip's contents to @p item
20667     * (analogous to elm_object_tooltip_content_cb_set(), but being
20668     * item tooltips with higher precedence than object tooltips). It
20669     * can have only one tooltip at a time, so any previous tooltip
20670     * content will get removed. @p func (with @p data) will be called
20671     * every time Elementary needs to show the tooltip and it should
20672     * return a valid Evas object, which will be fully managed by the
20673     * tooltip system, getting deleted when the tooltip is gone.
20674     *
20675     * In order to set just a text as a tooltip, look at
20676     * elm_genlist_item_tooltip_text_set().
20677     *
20678     * @ingroup Genlist
20679     */
20680    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);
20681
20682    /**
20683     * Unset a tooltip from a given genlist item
20684     *
20685     * @param item genlist item to remove a previously set tooltip from.
20686     *
20687     * This call removes any tooltip set on @p item. The callback
20688     * provided as @c del_cb to
20689     * elm_genlist_item_tooltip_content_cb_set() will be called to
20690     * notify it is not used anymore (and have resources cleaned, if
20691     * need be).
20692     *
20693     * @see elm_genlist_item_tooltip_content_cb_set()
20694     *
20695     * @ingroup Genlist
20696     */
20697    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20698
20699    /**
20700     * Set a different @b style for a given genlist item's tooltip.
20701     *
20702     * @param item genlist item with tooltip set
20703     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
20704     * "default", @c "transparent", etc)
20705     *
20706     * Tooltips can have <b>alternate styles</b> to be displayed on,
20707     * which are defined by the theme set on Elementary. This function
20708     * works analogously as elm_object_tooltip_style_set(), but here
20709     * applied only to genlist item objects. The default style for
20710     * tooltips is @c "default".
20711     *
20712     * @note before you set a style you should define a tooltip with
20713     *       elm_genlist_item_tooltip_content_cb_set() or
20714     *       elm_genlist_item_tooltip_text_set()
20715     *
20716     * @see elm_genlist_item_tooltip_style_get()
20717     *
20718     * @ingroup Genlist
20719     */
20720    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20721
20722    /**
20723     * Get the style set a given genlist item's tooltip.
20724     *
20725     * @param item genlist item with tooltip already set on.
20726     * @return style the theme style in use, which defaults to
20727     *         "default". If the object does not have a tooltip set,
20728     *         then @c NULL is returned.
20729     *
20730     * @see elm_genlist_item_tooltip_style_set() for more details
20731     *
20732     * @ingroup Genlist
20733     */
20734    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20735
20736    /**
20737     * @brief Disable size restrictions on an object's tooltip
20738     * @param item The tooltip's anchor object
20739     * @param disable If EINA_TRUE, size restrictions are disabled
20740     * @return EINA_FALSE on failure, EINA_TRUE on success
20741     *
20742     * This function allows a tooltip to expand beyond its parant window's canvas.
20743     * It will instead be limited only by the size of the display.
20744     */
20745    EAPI Eina_Bool          elm_genlist_item_tooltip_window_mode_set(Elm_Genlist_Item *item, Eina_Bool disable);
20746
20747    /**
20748     * @brief Retrieve size restriction state of an object's tooltip
20749     * @param item The tooltip's anchor object
20750     * @return If EINA_TRUE, size restrictions are disabled
20751     *
20752     * This function returns whether a tooltip is allowed to expand beyond
20753     * its parant window's canvas.
20754     * It will instead be limited only by the size of the display.
20755     */
20756    EAPI Eina_Bool          elm_genlist_item_tooltip_window_mode_get(const Elm_Genlist_Item *item);
20757
20758    /**
20759     * Set the type of mouse pointer/cursor decoration to be shown,
20760     * when the mouse pointer is over the given genlist widget item
20761     *
20762     * @param item genlist item to customize cursor on
20763     * @param cursor the cursor type's name
20764     *
20765     * This function works analogously as elm_object_cursor_set(), but
20766     * here the cursor's changing area is restricted to the item's
20767     * area, and not the whole widget's. Note that that item cursors
20768     * have precedence over widget cursors, so that a mouse over @p
20769     * item will always show cursor @p type.
20770     *
20771     * If this function is called twice for an object, a previously set
20772     * cursor will be unset on the second call.
20773     *
20774     * @see elm_object_cursor_set()
20775     * @see elm_genlist_item_cursor_get()
20776     * @see elm_genlist_item_cursor_unset()
20777     *
20778     * @ingroup Genlist
20779     */
20780    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
20781
20782    /**
20783     * Get the type of mouse pointer/cursor decoration set to be shown,
20784     * when the mouse pointer is over the given genlist widget item
20785     *
20786     * @param item genlist item with custom cursor set
20787     * @return the cursor type's name or @c NULL, if no custom cursors
20788     * were set to @p item (and on errors)
20789     *
20790     * @see elm_object_cursor_get()
20791     * @see elm_genlist_item_cursor_set() for more details
20792     * @see elm_genlist_item_cursor_unset()
20793     *
20794     * @ingroup Genlist
20795     */
20796    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20797
20798    /**
20799     * Unset any custom mouse pointer/cursor decoration set to be
20800     * shown, when the mouse pointer is over the given genlist widget
20801     * item, thus making it show the @b default cursor again.
20802     *
20803     * @param item a genlist item
20804     *
20805     * Use this call to undo any custom settings on this item's cursor
20806     * decoration, bringing it back to defaults (no custom style set).
20807     *
20808     * @see elm_object_cursor_unset()
20809     * @see elm_genlist_item_cursor_set() for more details
20810     *
20811     * @ingroup Genlist
20812     */
20813    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20814
20815    /**
20816     * Set a different @b style for a given custom cursor set for a
20817     * genlist item.
20818     *
20819     * @param item genlist item with custom cursor set
20820     * @param style the <b>theme style</b> to use (e.g. @c "default",
20821     * @c "transparent", etc)
20822     *
20823     * This function only makes sense when one is using custom mouse
20824     * cursor decorations <b>defined in a theme file</b> , which can
20825     * have, given a cursor name/type, <b>alternate styles</b> on
20826     * it. It works analogously as elm_object_cursor_style_set(), but
20827     * here applied only to genlist item objects.
20828     *
20829     * @warning Before you set a cursor style you should have defined a
20830     *       custom cursor previously on the item, with
20831     *       elm_genlist_item_cursor_set()
20832     *
20833     * @see elm_genlist_item_cursor_engine_only_set()
20834     * @see elm_genlist_item_cursor_style_get()
20835     *
20836     * @ingroup Genlist
20837     */
20838    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20839
20840    /**
20841     * Get the current @b style set for a given genlist item's custom
20842     * cursor
20843     *
20844     * @param item genlist item with custom cursor set.
20845     * @return style the cursor style in use. If the object does not
20846     *         have a cursor set, then @c NULL is returned.
20847     *
20848     * @see elm_genlist_item_cursor_style_set() for more details
20849     *
20850     * @ingroup Genlist
20851     */
20852    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20853
20854    /**
20855     * Set if the (custom) cursor for a given genlist item should be
20856     * searched in its theme, also, or should only rely on the
20857     * rendering engine.
20858     *
20859     * @param item item with custom (custom) cursor already set on
20860     * @param engine_only Use @c EINA_TRUE to have cursors looked for
20861     * only on those provided by the rendering engine, @c EINA_FALSE to
20862     * have them searched on the widget's theme, as well.
20863     *
20864     * @note This call is of use only if you've set a custom cursor
20865     * for genlist items, with elm_genlist_item_cursor_set().
20866     *
20867     * @note By default, cursors will only be looked for between those
20868     * provided by the rendering engine.
20869     *
20870     * @ingroup Genlist
20871     */
20872    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
20873
20874    /**
20875     * Get if the (custom) cursor for a given genlist item is being
20876     * searched in its theme, also, or is only relying on the rendering
20877     * engine.
20878     *
20879     * @param item a genlist item
20880     * @return @c EINA_TRUE, if cursors are being looked for only on
20881     * those provided by the rendering engine, @c EINA_FALSE if they
20882     * are being searched on the widget's theme, as well.
20883     *
20884     * @see elm_genlist_item_cursor_engine_only_set(), for more details
20885     *
20886     * @ingroup Genlist
20887     */
20888    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20889
20890    /**
20891     * Get the index of the item. It is only valid once displayed.
20892     *
20893     * @param item a genlist item
20894     * @return the position inside the list of item.
20895     *
20896     * @ingroup Genlist
20897     */
20898    EAPI int elm_genlist_item_index_get(Elm_Gen_Item *it);
20899
20900    /**
20901     * Update the contents of all realized items.
20902     *
20903     * @param obj The genlist object.
20904     *
20905     * This updates all realized items by calling all the item class functions again
20906     * to get the contents, texts and states. Use this when the original
20907     * item data has changed and the changes are desired to be reflected.
20908     *
20909     * To update just one item, use elm_genlist_item_update().
20910     *
20911     * @see elm_genlist_realized_items_get()
20912     * @see elm_genlist_item_update()
20913     *
20914     * @ingroup Genlist
20915     */
20916    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
20917
20918    /**
20919     * Activate a genlist mode on an item
20920     *
20921     * @param item The genlist item
20922     * @param mode Mode name
20923     * @param mode_set Boolean to define set or unset mode.
20924     *
20925     * A genlist mode is a different way of selecting an item. Once a mode is
20926     * activated on an item, any other selected item is immediately unselected.
20927     * This feature provides an easy way of implementing a new kind of animation
20928     * for selecting an item, without having to entirely rewrite the item style
20929     * theme. However, the elm_genlist_selected_* API can't be used to get what
20930     * item is activate for a mode.
20931     *
20932     * The current item style will still be used, but applying a genlist mode to
20933     * an item will select it using a different kind of animation.
20934     *
20935     * The current active item for a mode can be found by
20936     * elm_genlist_mode_item_get().
20937     *
20938     * The characteristics of genlist mode are:
20939     * - Only one mode can be active at any time, and for only one item.
20940     * - Genlist handles deactivating other items when one item is activated.
20941     * - A mode is defined in the genlist theme (edc), and more modes can easily
20942     *   be added.
20943     * - A mode style and the genlist item style are different things. They
20944     *   can be combined to provide a default style to the item, with some kind
20945     *   of animation for that item when the mode is activated.
20946     *
20947     * When a mode is activated on an item, a new view for that item is created.
20948     * The theme of this mode defines the animation that will be used to transit
20949     * the item from the old view to the new view. This second (new) view will be
20950     * active for that item while the mode is active on the item, and will be
20951     * destroyed after the mode is totally deactivated from that item.
20952     *
20953     * @see elm_genlist_mode_get()
20954     * @see elm_genlist_mode_item_get()
20955     *
20956     * @ingroup Genlist
20957     */
20958    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
20959
20960    /**
20961     * Get the last (or current) genlist mode used.
20962     *
20963     * @param obj The genlist object
20964     *
20965     * This function just returns the name of the last used genlist mode. It will
20966     * be the current mode if it's still active.
20967     *
20968     * @see elm_genlist_item_mode_set()
20969     * @see elm_genlist_mode_item_get()
20970     *
20971     * @ingroup Genlist
20972     */
20973    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20974
20975    /**
20976     * Get active genlist mode item
20977     *
20978     * @param obj The genlist object
20979     * @return The active item for that current mode. Or @c NULL if no item is
20980     * activated with any mode.
20981     *
20982     * This function returns the item that was activated with a mode, by the
20983     * function elm_genlist_item_mode_set().
20984     *
20985     * @see elm_genlist_item_mode_set()
20986     * @see elm_genlist_mode_get()
20987     *
20988     * @ingroup Genlist
20989     */
20990    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20991
20992    /**
20993     * Set reorder mode
20994     *
20995     * @param obj The genlist object
20996     * @param reorder_mode The reorder mode
20997     * (EINA_TRUE = on, EINA_FALSE = off)
20998     *
20999     * @ingroup Genlist
21000     */
21001    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
21002
21003    /**
21004     * Get the reorder mode
21005     *
21006     * @param obj The genlist object
21007     * @return The reorder mode
21008     * (EINA_TRUE = on, EINA_FALSE = off)
21009     *
21010     * @ingroup Genlist
21011     */
21012    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21013
21014    /**
21015     * @}
21016     */
21017
21018    /**
21019     * @defgroup Check Check
21020     *
21021     * @image html img/widget/check/preview-00.png
21022     * @image latex img/widget/check/preview-00.eps
21023     * @image html img/widget/check/preview-01.png
21024     * @image latex img/widget/check/preview-01.eps
21025     * @image html img/widget/check/preview-02.png
21026     * @image latex img/widget/check/preview-02.eps
21027     *
21028     * @brief The check widget allows for toggling a value between true and
21029     * false.
21030     *
21031     * Check objects are a lot like radio objects in layout and functionality
21032     * except they do not work as a group, but independently and only toggle the
21033     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
21034     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
21035     * returns the current state. For convenience, like the radio objects, you
21036     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
21037     * for it to modify.
21038     *
21039     * Signals that you can add callbacks for are:
21040     * "changed" - This is called whenever the user changes the state of one of
21041     *             the check object(event_info is NULL).
21042     *
21043     * Default contents parts of the check widget that you can use for are:
21044     * @li "icon" - An icon of the check
21045     *
21046     * Default text parts of the check widget that you can use for are:
21047     * @li "elm.text" - Label of the check
21048     *
21049     * @ref tutorial_check should give you a firm grasp of how to use this widget
21050     * .
21051     * @{
21052     */
21053    /**
21054     * @brief Add a new Check object
21055     *
21056     * @param parent The parent object
21057     * @return The new object or NULL if it cannot be created
21058     */
21059    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21060
21061    /**
21062     * @brief Set the text label of the check object
21063     *
21064     * @param obj The check object
21065     * @param label The text label string in UTF-8
21066     *
21067     * @deprecated use elm_object_text_set() instead.
21068     */
21069    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21070
21071    /**
21072     * @brief Get the text label of the check object
21073     *
21074     * @param obj The check object
21075     * @return The text label string in UTF-8
21076     *
21077     * @deprecated use elm_object_text_get() instead.
21078     */
21079    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21080
21081    /**
21082     * @brief Set the icon object of the check object
21083     *
21084     * @param obj The check object
21085     * @param icon The icon object
21086     *
21087     * Once the icon object is set, a previously set one will be deleted.
21088     * If you want to keep that old content object, use the
21089     * elm_object_content_unset() function.
21090     *
21091     * @deprecated use elm_object_part_content_set() instead.
21092     *
21093     */
21094    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21095
21096    /**
21097     * @brief Get the icon object of the check object
21098     *
21099     * @param obj The check object
21100     * @return The icon object
21101     *
21102     * @deprecated use elm_object_part_content_get() instead.
21103     *
21104     */
21105    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21106
21107    /**
21108     * @brief Unset the icon used for the check object
21109     *
21110     * @param obj The check object
21111     * @return The icon object that was being used
21112     *
21113     * Unparent and return the icon object which was set for this widget.
21114     *
21115     * @deprecated use elm_object_part_content_unset() instead.
21116     *
21117     */
21118    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21119
21120    /**
21121     * @brief Set the on/off state of the check object
21122     *
21123     * @param obj The check object
21124     * @param state The state to use (1 == on, 0 == off)
21125     *
21126     * This sets the state of the check. If set
21127     * with elm_check_state_pointer_set() the state of that variable is also
21128     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
21129     */
21130    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21131
21132    /**
21133     * @brief Get the state of the check object
21134     *
21135     * @param obj The check object
21136     * @return The boolean state
21137     */
21138    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21139
21140    /**
21141     * @brief Set a convenience pointer to a boolean to change
21142     *
21143     * @param obj The check object
21144     * @param statep Pointer to the boolean to modify
21145     *
21146     * This sets a pointer to a boolean, that, in addition to the check objects
21147     * state will also be modified directly. To stop setting the object pointed
21148     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
21149     * then when this is called, the check objects state will also be modified to
21150     * reflect the value of the boolean @p statep points to, just like calling
21151     * elm_check_state_set().
21152     */
21153    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
21154    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
21155    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);
21156
21157    /**
21158     * @}
21159     */
21160
21161    /**
21162     * @defgroup Radio Radio
21163     *
21164     * @image html img/widget/radio/preview-00.png
21165     * @image latex img/widget/radio/preview-00.eps
21166     *
21167     * @brief Radio is a widget that allows for 1 or more options to be displayed
21168     * and have the user choose only 1 of them.
21169     *
21170     * A radio object contains an indicator, an optional Label and an optional
21171     * icon object. While it's possible to have a group of only one radio they,
21172     * are normally used in groups of 2 or more. To add a radio to a group use
21173     * elm_radio_group_add(). The radio object(s) will select from one of a set
21174     * of integer values, so any value they are configuring needs to be mapped to
21175     * a set of integers. To configure what value that radio object represents,
21176     * use  elm_radio_state_value_set() to set the integer it represents. To set
21177     * the value the whole group(which one is currently selected) is to indicate
21178     * use elm_radio_value_set() on any group member, and to get the groups value
21179     * use elm_radio_value_get(). For convenience the radio objects are also able
21180     * to directly set an integer(int) to the value that is selected. To specify
21181     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
21182     * The radio objects will modify this directly. That implies the pointer must
21183     * point to valid memory for as long as the radio objects exist.
21184     *
21185     * Signals that you can add callbacks for are:
21186     * @li changed - This is called whenever the user changes the state of one of
21187     * the radio objects within the group of radio objects that work together.
21188     *
21189     * Default contents parts of the radio widget that you can use for are:
21190     * @li "icon" - An icon of the radio
21191     *
21192     * @ref tutorial_radio show most of this API in action.
21193     * @{
21194     */
21195
21196    /**
21197     * @brief Add a new radio to the parent
21198     *
21199     * @param parent The parent object
21200     * @return The new object or NULL if it cannot be created
21201     */
21202    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21203
21204    /**
21205     * @brief Set the text label of the radio object
21206     *
21207     * @param obj The radio object
21208     * @param label The text label string in UTF-8
21209     *
21210     * @deprecated use elm_object_text_set() instead.
21211     */
21212    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21213
21214    /**
21215     * @brief Get the text label of the radio object
21216     *
21217     * @param obj The radio object
21218     * @return The text label string in UTF-8
21219     *
21220     * @deprecated use elm_object_text_set() instead.
21221     */
21222    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21223
21224    /**
21225     * @brief Set the icon object of the radio object
21226     *
21227     * @param obj The radio object
21228     * @param icon The icon object
21229     *
21230     * Once the icon object is set, a previously set one will be deleted. If you
21231     * want to keep that old content object, use the elm_radio_icon_unset()
21232     * function.
21233     *
21234     * @deprecated use elm_object_part_content_set() instead.
21235     *
21236     */
21237    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21238
21239    /**
21240     * @brief Get the icon object of the radio object
21241     *
21242     * @param obj The radio object
21243     * @return The icon object
21244     *
21245     * @see elm_radio_icon_set()
21246     *
21247     * @deprecated use elm_object_part_content_get() instead.
21248     *
21249     */
21250    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21251
21252    /**
21253     * @brief Unset the icon used for the radio object
21254     *
21255     * @param obj The radio object
21256     * @return The icon object that was being used
21257     *
21258     * Unparent and return the icon object which was set for this widget.
21259     *
21260     * @see elm_radio_icon_set()
21261     * @deprecated use elm_object_part_content_unset() instead.
21262     *
21263     */
21264    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21265
21266    /**
21267     * @brief Add this radio to a group of other radio objects
21268     *
21269     * @param obj The radio object
21270     * @param group Any object whose group the @p obj is to join.
21271     *
21272     * Radio objects work in groups. Each member should have a different integer
21273     * value assigned. In order to have them work as a group, they need to know
21274     * about each other. This adds the given radio object to the group of which
21275     * the group object indicated is a member.
21276     */
21277    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
21278
21279    /**
21280     * @brief Set the integer value that this radio object represents
21281     *
21282     * @param obj The radio object
21283     * @param value The value to use if this radio object is selected
21284     *
21285     * This sets the value of the radio.
21286     */
21287    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21288
21289    /**
21290     * @brief Get the integer value that this radio object represents
21291     *
21292     * @param obj The radio object
21293     * @return The value used if this radio object is selected
21294     *
21295     * This gets the value of the radio.
21296     *
21297     * @see elm_radio_value_set()
21298     */
21299    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21300
21301    /**
21302     * @brief Set the value of the radio.
21303     *
21304     * @param obj The radio object
21305     * @param value The value to use for the group
21306     *
21307     * This sets the value of the radio group and will also set the value if
21308     * pointed to, to the value supplied, but will not call any callbacks.
21309     */
21310    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21311
21312    /**
21313     * @brief Get the state of the radio object
21314     *
21315     * @param obj The radio object
21316     * @return The integer state
21317     */
21318    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21319
21320    /**
21321     * @brief Set a convenience pointer to a integer to change
21322     *
21323     * @param obj The radio object
21324     * @param valuep Pointer to the integer to modify
21325     *
21326     * This sets a pointer to a integer, that, in addition to the radio objects
21327     * state will also be modified directly. To stop setting the object pointed
21328     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
21329     * when this is called, the radio objects state will also be modified to
21330     * reflect the value of the integer valuep points to, just like calling
21331     * elm_radio_value_set().
21332     */
21333    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
21334
21335    /**
21336     * @}
21337     */
21338
21339    /**
21340     * @defgroup Pager Pager
21341     *
21342     * @image html img/widget/pager/preview-00.png
21343     * @image latex img/widget/pager/preview-00.eps
21344     *
21345     * @brief Widget that allows flipping between one or more ā€œpagesā€
21346     * of objects.
21347     *
21348     * The flipping between pages of objects is animated. All content
21349     * in the pager is kept in a stack, being the last content added
21350     * (visible one) on the top of that stack.
21351     *
21352     * Objects can be pushed or popped from the stack or deleted as
21353     * well. Pushes and pops will animate the widget accordingly to its
21354     * style (a pop will also delete the child object once the
21355     * animation is finished). Any object already in the pager can be
21356     * promoted to the top (from its current stacking position) through
21357     * the use of elm_pager_content_promote(). New objects are pushed
21358     * to the top with elm_pager_content_push(). When the top item is
21359     * no longer wanted, simply pop it with elm_pager_content_pop() and
21360     * it will also be deleted. If an object is no longer needed and is
21361     * not the top item, just delete it as normal. You can query which
21362     * objects are the top and bottom with
21363     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
21364     *
21365     * Signals that you can add callbacks for are:
21366     * - @c "show,finished" - when a new page is actually shown on the top
21367     * - @c "hide,finished" - when a previous page is hidden
21368     *
21369     * Only after the first of that signals the child object is
21370     * guaranteed to be visible, as in @c evas_object_visible_get().
21371     *
21372     * This widget has the following styles available:
21373     * - @c "default"
21374     * - @c "fade"
21375     * - @c "fade_translucide"
21376     * - @c "fade_invisible"
21377     *
21378     * @note These styles affect only the flipping animations on the
21379     * default theme; the appearance when not animating is unaffected
21380     * by them.
21381     *
21382     * @ref tutorial_pager gives a good overview of the usage of the API.
21383     * @{
21384     */
21385
21386    /**
21387     * Add a new pager to the parent
21388     *
21389     * @param parent The parent object
21390     * @return The new object or NULL if it cannot be created
21391     *
21392     * @ingroup Pager
21393     */
21394    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21395
21396    /**
21397     * @brief Push an object to the top of the pager stack (and show it).
21398     *
21399     * @param obj The pager object
21400     * @param content The object to push
21401     *
21402     * The object pushed becomes a child of the pager, it will be controlled and
21403     * deleted when the pager is deleted.
21404     *
21405     * @note If the content is already in the stack use
21406     * elm_pager_content_promote().
21407     * @warning Using this function on @p content already in the stack results in
21408     * undefined behavior.
21409     */
21410    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21411
21412    /**
21413     * @brief Pop the object that is on top of the stack
21414     *
21415     * @param obj The pager object
21416     *
21417     * This pops the object that is on the top(visible) of the pager, makes it
21418     * disappear, then deletes the object. The object that was underneath it on
21419     * the stack will become visible.
21420     */
21421    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
21422
21423    /**
21424     * @brief Moves an object already in the pager stack to the top of the stack.
21425     *
21426     * @param obj The pager object
21427     * @param content The object to promote
21428     *
21429     * This will take the @p content and move it to the top of the stack as
21430     * if it had been pushed there.
21431     *
21432     * @note If the content isn't already in the stack use
21433     * elm_pager_content_push().
21434     * @warning Using this function on @p content not already in the stack
21435     * results in undefined behavior.
21436     */
21437    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21438
21439    /**
21440     * @brief Return the object at the bottom of the pager stack
21441     *
21442     * @param obj The pager object
21443     * @return The bottom object or NULL if none
21444     */
21445    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21446
21447    /**
21448     * @brief  Return the object at the top of the pager stack
21449     *
21450     * @param obj The pager object
21451     * @return The top object or NULL if none
21452     */
21453    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21454
21455    /**
21456     * @}
21457     */
21458
21459    /**
21460     * @defgroup Slideshow Slideshow
21461     *
21462     * @image html img/widget/slideshow/preview-00.png
21463     * @image latex img/widget/slideshow/preview-00.eps
21464     *
21465     * This widget, as the name indicates, is a pre-made image
21466     * slideshow panel, with API functions acting on (child) image
21467     * items presentation. Between those actions, are:
21468     * - advance to next/previous image
21469     * - select the style of image transition animation
21470     * - set the exhibition time for each image
21471     * - start/stop the slideshow
21472     *
21473     * The transition animations are defined in the widget's theme,
21474     * consequently new animations can be added without having to
21475     * update the widget's code.
21476     *
21477     * @section Slideshow_Items Slideshow items
21478     *
21479     * For slideshow items, just like for @ref Genlist "genlist" ones,
21480     * the user defines a @b classes, specifying functions that will be
21481     * called on the item's creation and deletion times.
21482     *
21483     * The #Elm_Slideshow_Item_Class structure contains the following
21484     * members:
21485     *
21486     * - @c func.get - When an item is displayed, this function is
21487     *   called, and it's where one should create the item object, de
21488     *   facto. For example, the object can be a pure Evas image object
21489     *   or an Elementary @ref Photocam "photocam" widget. See
21490     *   #SlideshowItemGetFunc.
21491     * - @c func.del - When an item is no more displayed, this function
21492     *   is called, where the user must delete any data associated to
21493     *   the item. See #SlideshowItemDelFunc.
21494     *
21495     * @section Slideshow_Caching Slideshow caching
21496     *
21497     * The slideshow provides facilities to have items adjacent to the
21498     * one being displayed <b>already "realized"</b> (i.e. loaded) for
21499     * you, so that the system does not have to decode image data
21500     * anymore at the time it has to actually switch images on its
21501     * viewport. The user is able to set the numbers of items to be
21502     * cached @b before and @b after the current item, in the widget's
21503     * item list.
21504     *
21505     * Smart events one can add callbacks for are:
21506     *
21507     * - @c "changed" - when the slideshow switches its view to a new
21508     *   item. event_info parameter in callback contains the current visible item
21509     * - @c "transition,end" - when a slide transition ends. event_info parameter
21510     *   in callback contains the current visible item
21511     *
21512     * List of examples for the slideshow widget:
21513     * @li @ref slideshow_example
21514     */
21515
21516    /**
21517     * @addtogroup Slideshow
21518     * @{
21519     */
21520
21521    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
21522    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
21523    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
21524    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
21525
21526    /**
21527     * @struct _Elm_Slideshow_Item_Class
21528     *
21529     * Slideshow item class definition. See @ref Slideshow_Items for
21530     * field details.
21531     */
21532    struct _Elm_Slideshow_Item_Class
21533      {
21534         struct _Elm_Slideshow_Item_Class_Func
21535           {
21536              SlideshowItemGetFunc get;
21537              SlideshowItemDelFunc del;
21538           } func;
21539      }; /**< #Elm_Slideshow_Item_Class member definitions */
21540
21541    /**
21542     * Add a new slideshow widget to the given parent Elementary
21543     * (container) object
21544     *
21545     * @param parent The parent object
21546     * @return A new slideshow widget handle or @c NULL, on errors
21547     *
21548     * This function inserts a new slideshow widget on the canvas.
21549     *
21550     * @ingroup Slideshow
21551     */
21552    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21553
21554    /**
21555     * Add (append) a new item in a given slideshow widget.
21556     *
21557     * @param obj The slideshow object
21558     * @param itc The item class for the item
21559     * @param data The item's data
21560     * @return A handle to the item added or @c NULL, on errors
21561     *
21562     * Add a new item to @p obj's internal list of items, appending it.
21563     * The item's class must contain the function really fetching the
21564     * image object to show for this item, which could be an Evas image
21565     * object or an Elementary photo, for example. The @p data
21566     * parameter is going to be passed to both class functions of the
21567     * item.
21568     *
21569     * @see #Elm_Slideshow_Item_Class
21570     * @see elm_slideshow_item_sorted_insert()
21571     * @see elm_object_item_data_set()
21572     *
21573     * @ingroup Slideshow
21574     */
21575    EAPI Elm_Object_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
21576
21577    /**
21578     * Insert a new item into the given slideshow widget, using the @p func
21579     * function to sort items (by item handles).
21580     *
21581     * @param obj The slideshow object
21582     * @param itc The item class for the item
21583     * @param data The item's data
21584     * @param func The comparing function to be used to sort slideshow
21585     * items <b>by #Elm_Slideshow_Item item handles</b>
21586     * @return Returns The slideshow item handle, on success, or
21587     * @c NULL, on errors
21588     *
21589     * Add a new item to @p obj's internal list of items, in a position
21590     * determined by the @p func comparing function. The item's class
21591     * must contain the function really fetching the image object to
21592     * show for this item, which could be an Evas image object or an
21593     * Elementary photo, for example. The @p data parameter is going to
21594     * be passed to both class functions of the item.
21595     *
21596     * @see #Elm_Slideshow_Item_Class
21597     * @see elm_slideshow_item_add()
21598     *
21599     * @ingroup Slideshow
21600     */
21601    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);
21602
21603    /**
21604     * Display a given slideshow widget's item, programmatically.
21605     *
21606     * @param it The item to display on @p obj's viewport
21607     *
21608     * The change between the current item and @p item will use the
21609     * transition @p obj is set to use (@see
21610     * elm_slideshow_transition_set()).
21611     *
21612     * @ingroup Slideshow
21613     */
21614    EAPI void                elm_slideshow_show(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21615
21616    /**
21617     * Slide to the @b next item, in a given slideshow widget
21618     *
21619     * @param obj The slideshow object
21620     *
21621     * The sliding animation @p obj is set to use will be the
21622     * transition effect used, after this call is issued.
21623     *
21624     * @note If the end of the slideshow's internal list of items is
21625     * reached, it'll wrap around to the list's beginning, again.
21626     *
21627     * @ingroup Slideshow
21628     */
21629    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21630
21631    /**
21632     * Slide to the @b previous item, in a given slideshow widget
21633     *
21634     * @param obj The slideshow object
21635     *
21636     * The sliding animation @p obj is set to use will be the
21637     * transition effect used, after this call is issued.
21638     *
21639     * @note If the beginning of the slideshow's internal list of items
21640     * is reached, it'll wrap around to the list's end, again.
21641     *
21642     * @ingroup Slideshow
21643     */
21644    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
21645
21646    /**
21647     * Returns the list of sliding transition/effect names available, for a
21648     * given slideshow widget.
21649     *
21650     * @param obj The slideshow object
21651     * @return The list of transitions (list of @b stringshared strings
21652     * as data)
21653     *
21654     * The transitions, which come from @p obj's theme, must be an EDC
21655     * data item named @c "transitions" on the theme file, with (prefix)
21656     * names of EDC programs actually implementing them.
21657     *
21658     * The available transitions for slideshows on the default theme are:
21659     * - @c "fade" - the current item fades out, while the new one
21660     *   fades in to the slideshow's viewport.
21661     * - @c "black_fade" - the current item fades to black, and just
21662     *   then, the new item will fade in.
21663     * - @c "horizontal" - the current item slides horizontally, until
21664     *   it gets out of the slideshow's viewport, while the new item
21665     *   comes from the left to take its place.
21666     * - @c "vertical" - the current item slides vertically, until it
21667     *   gets out of the slideshow's viewport, while the new item comes
21668     *   from the bottom to take its place.
21669     * - @c "square" - the new item starts to appear from the middle of
21670     *   the current one, but with a tiny size, growing until its
21671     *   target (full) size and covering the old one.
21672     *
21673     * @warning The stringshared strings get no new references
21674     * exclusive to the user grabbing the list, here, so if you'd like
21675     * to use them out of this call's context, you'd better @c
21676     * eina_stringshare_ref() them.
21677     *
21678     * @see elm_slideshow_transition_set()
21679     *
21680     * @ingroup Slideshow
21681     */
21682    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21683
21684    /**
21685     * Set the current slide transition/effect in use for a given
21686     * slideshow widget
21687     *
21688     * @param obj The slideshow object
21689     * @param transition The new transition's name string
21690     *
21691     * If @p transition is implemented in @p obj's theme (i.e., is
21692     * contained in the list returned by
21693     * elm_slideshow_transitions_get()), this new sliding effect will
21694     * be used on the widget.
21695     *
21696     * @see elm_slideshow_transitions_get() for more details
21697     *
21698     * @ingroup Slideshow
21699     */
21700    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
21701
21702    /**
21703     * Get the current slide transition/effect in use for a given
21704     * slideshow widget
21705     *
21706     * @param obj The slideshow object
21707     * @return The current transition's name
21708     *
21709     * @see elm_slideshow_transition_set() for more details
21710     *
21711     * @ingroup Slideshow
21712     */
21713    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21714
21715    /**
21716     * Set the interval between each image transition on a given
21717     * slideshow widget, <b>and start the slideshow, itself</b>
21718     *
21719     * @param obj The slideshow object
21720     * @param timeout The new displaying timeout for images
21721     *
21722     * After this call, the slideshow widget will start cycling its
21723     * view, sequentially and automatically, with the images of the
21724     * items it has. The time between each new image displayed is going
21725     * to be @p timeout, in @b seconds. If a different timeout was set
21726     * previously and an slideshow was in progress, it will continue
21727     * with the new time between transitions, after this call.
21728     *
21729     * @note A value less than or equal to 0 on @p timeout will disable
21730     * the widget's internal timer, thus halting any slideshow which
21731     * could be happening on @p obj.
21732     *
21733     * @see elm_slideshow_timeout_get()
21734     *
21735     * @ingroup Slideshow
21736     */
21737    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
21738
21739    /**
21740     * Get the interval set for image transitions on a given slideshow
21741     * widget.
21742     *
21743     * @param obj The slideshow object
21744     * @return Returns the timeout set on it
21745     *
21746     * @see elm_slideshow_timeout_set() for more details
21747     *
21748     * @ingroup Slideshow
21749     */
21750    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21751
21752    /**
21753     * Set if, after a slideshow is started, for a given slideshow
21754     * widget, its items should be displayed cyclically or not.
21755     *
21756     * @param obj The slideshow object
21757     * @param loop Use @c EINA_TRUE to make it cycle through items or
21758     * @c EINA_FALSE for it to stop at the end of @p obj's internal
21759     * list of items
21760     *
21761     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
21762     * ignore what is set by this functions, i.e., they'll @b always
21763     * cycle through items. This affects only the "automatic"
21764     * slideshow, as set by elm_slideshow_timeout_set().
21765     *
21766     * @see elm_slideshow_loop_get()
21767     *
21768     * @ingroup Slideshow
21769     */
21770    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
21771
21772    /**
21773     * Get if, after a slideshow is started, for a given slideshow
21774     * widget, its items are to be displayed cyclically or not.
21775     *
21776     * @param obj The slideshow object
21777     * @return @c EINA_TRUE, if the items in @p obj will be cycled
21778     * through or @c EINA_FALSE, otherwise
21779     *
21780     * @see elm_slideshow_loop_set() for more details
21781     *
21782     * @ingroup Slideshow
21783     */
21784    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21785
21786    /**
21787     * Remove all items from a given slideshow widget
21788     *
21789     * @param obj The slideshow object
21790     *
21791     * This removes (and deletes) all items in @p obj, leaving it
21792     * empty.
21793     *
21794     * @see elm_slideshow_item_del(), to remove just one item.
21795     *
21796     * @ingroup Slideshow
21797     */
21798    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21799
21800    /**
21801     * Get the internal list of items in a given slideshow widget.
21802     *
21803     * @param obj The slideshow object
21804     * @return The list of items (#Elm_Object_Item as data) or
21805     * @c NULL on errors.
21806     *
21807     * This list is @b not to be modified in any way and must not be
21808     * freed. Use the list members with functions like
21809     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
21810     *
21811     * @warning This list is only valid until @p obj object's internal
21812     * items list is changed. It should be fetched again with another
21813     * call to this function when changes happen.
21814     *
21815     * @ingroup Slideshow
21816     */
21817    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21818
21819    /**
21820     * Delete a given item from a slideshow widget.
21821     *
21822     * @param it The slideshow item
21823     *
21824     * @ingroup Slideshow
21825     */
21826    EAPI void                elm_slideshow_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21827
21828    /**
21829     * Return the data associated with a given slideshow item
21830     *
21831     * @param it The slideshow item
21832     * @return Returns the data associated to this item
21833     *
21834     * @deprecated use elm_object_item_data_get() instead
21835     * @ingroup Slideshow
21836     */
21837    EINA_DEPRECATED EAPI void               *elm_slideshow_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21838
21839    /**
21840     * Returns the currently displayed item, in a given slideshow widget
21841     *
21842     * @param obj The slideshow object
21843     * @return A handle to the item being displayed in @p obj or
21844     * @c NULL, if none is (and on errors)
21845     *
21846     * @ingroup Slideshow
21847     */
21848    EAPI Elm_Object_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21849
21850    /**
21851     * Get the real Evas object created to implement the view of a
21852     * given slideshow item
21853     *
21854     * @param item The slideshow item.
21855     * @return the Evas object implementing this item's view.
21856     *
21857     * This returns the actual Evas object used to implement the
21858     * specified slideshow item's view. This may be @c NULL, as it may
21859     * not have been created or may have been deleted, at any time, by
21860     * the slideshow. <b>Do not modify this object</b> (move, resize,
21861     * show, hide, etc.), as the slideshow is controlling it. This
21862     * function is for querying, emitting custom signals or hooking
21863     * lower level callbacks for events on that object. Do not delete
21864     * this object under any circumstances.
21865     *
21866     * @see elm_slideshow_item_data_get()
21867     *
21868     * @ingroup Slideshow
21869     */
21870    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Object_Item* it) EINA_ARG_NONNULL(1);
21871
21872    /**
21873     * Get the the item, in a given slideshow widget, placed at
21874     * position @p nth, in its internal items list
21875     *
21876     * @param obj The slideshow object
21877     * @param nth The number of the item to grab a handle to (0 being
21878     * the first)
21879     * @return The item stored in @p obj at position @p nth or @c NULL,
21880     * if there's no item with that index (and on errors)
21881     *
21882     * @ingroup Slideshow
21883     */
21884    EAPI Elm_Object_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
21885
21886    /**
21887     * Set the current slide layout in use for a given slideshow widget
21888     *
21889     * @param obj The slideshow object
21890     * @param layout The new layout's name string
21891     *
21892     * If @p layout is implemented in @p obj's theme (i.e., is contained
21893     * in the list returned by elm_slideshow_layouts_get()), this new
21894     * images layout will be used on the widget.
21895     *
21896     * @see elm_slideshow_layouts_get() for more details
21897     *
21898     * @ingroup Slideshow
21899     */
21900    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
21901
21902    /**
21903     * Get the current slide layout in use for a given slideshow widget
21904     *
21905     * @param obj The slideshow object
21906     * @return The current layout's name
21907     *
21908     * @see elm_slideshow_layout_set() for more details
21909     *
21910     * @ingroup Slideshow
21911     */
21912    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21913
21914    /**
21915     * Returns the list of @b layout names available, for a given
21916     * slideshow widget.
21917     *
21918     * @param obj The slideshow object
21919     * @return The list of layouts (list of @b stringshared strings
21920     * as data)
21921     *
21922     * Slideshow layouts will change how the widget is to dispose each
21923     * image item in its viewport, with regard to cropping, scaling,
21924     * etc.
21925     *
21926     * The layouts, which come from @p obj's theme, must be an EDC
21927     * data item name @c "layouts" on the theme file, with (prefix)
21928     * names of EDC programs actually implementing them.
21929     *
21930     * The available layouts for slideshows on the default theme are:
21931     * - @c "fullscreen" - item images with original aspect, scaled to
21932     *   touch top and down slideshow borders or, if the image's heigh
21933     *   is not enough, left and right slideshow borders.
21934     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
21935     *   one, but always leaving 10% of the slideshow's dimensions of
21936     *   distance between the item image's borders and the slideshow
21937     *   borders, for each axis.
21938     *
21939     * @warning The stringshared strings get no new references
21940     * exclusive to the user grabbing the list, here, so if you'd like
21941     * to use them out of this call's context, you'd better @c
21942     * eina_stringshare_ref() them.
21943     *
21944     * @see elm_slideshow_layout_set()
21945     *
21946     * @ingroup Slideshow
21947     */
21948    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21949
21950    /**
21951     * Set the number of items to cache, on a given slideshow widget,
21952     * <b>before the current item</b>
21953     *
21954     * @param obj The slideshow object
21955     * @param count Number of items to cache before the current one
21956     *
21957     * The default value for this property is @c 2. See
21958     * @ref Slideshow_Caching "slideshow caching" for more details.
21959     *
21960     * @see elm_slideshow_cache_before_get()
21961     *
21962     * @ingroup Slideshow
21963     */
21964    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21965
21966    /**
21967     * Retrieve the number of items to cache, on a given slideshow widget,
21968     * <b>before the current item</b>
21969     *
21970     * @param obj The slideshow object
21971     * @return The number of items set to be cached before the current one
21972     *
21973     * @see elm_slideshow_cache_before_set() for more details
21974     *
21975     * @ingroup Slideshow
21976     */
21977    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21978
21979    /**
21980     * Set the number of items to cache, on a given slideshow widget,
21981     * <b>after the current item</b>
21982     *
21983     * @param obj The slideshow object
21984     * @param count Number of items to cache after the current one
21985     *
21986     * The default value for this property is @c 2. See
21987     * @ref Slideshow_Caching "slideshow caching" for more details.
21988     *
21989     * @see elm_slideshow_cache_after_get()
21990     *
21991     * @ingroup Slideshow
21992     */
21993    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21994
21995    /**
21996     * Retrieve the number of items to cache, on a given slideshow widget,
21997     * <b>after the current item</b>
21998     *
21999     * @param obj The slideshow object
22000     * @return The number of items set to be cached after the current one
22001     *
22002     * @see elm_slideshow_cache_after_set() for more details
22003     *
22004     * @ingroup Slideshow
22005     */
22006    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22007
22008    /**
22009     * Get the number of items stored in a given slideshow widget
22010     *
22011     * @param obj The slideshow object
22012     * @return The number of items on @p obj, at the moment of this call
22013     *
22014     * @ingroup Slideshow
22015     */
22016    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22017
22018    /**
22019     * @}
22020     */
22021
22022    /**
22023     * @defgroup Fileselector File Selector
22024     *
22025     * @image html img/widget/fileselector/preview-00.png
22026     * @image latex img/widget/fileselector/preview-00.eps
22027     *
22028     * A file selector is a widget that allows a user to navigate
22029     * through a file system, reporting file selections back via its
22030     * API.
22031     *
22032     * It contains shortcut buttons for home directory (@c ~) and to
22033     * jump one directory upwards (..), as well as cancel/ok buttons to
22034     * confirm/cancel a given selection. After either one of those two
22035     * former actions, the file selector will issue its @c "done" smart
22036     * callback.
22037     *
22038     * There's a text entry on it, too, showing the name of the current
22039     * selection. There's the possibility of making it editable, so it
22040     * is useful on file saving dialogs on applications, where one
22041     * gives a file name to save contents to, in a given directory in
22042     * the system. This custom file name will be reported on the @c
22043     * "done" smart callback (explained in sequence).
22044     *
22045     * Finally, it has a view to display file system items into in two
22046     * possible forms:
22047     * - list
22048     * - grid
22049     *
22050     * If Elementary is built with support of the Ethumb thumbnailing
22051     * library, the second form of view will display preview thumbnails
22052     * of files which it supports.
22053     *
22054     * Smart callbacks one can register to:
22055     *
22056     * - @c "selected" - the user has clicked on a file (when not in
22057     *      folders-only mode) or directory (when in folders-only mode)
22058     * - @c "directory,open" - the list has been populated with new
22059     *      content (@c event_info is a pointer to the directory's
22060     *      path, a @b stringshared string)
22061     * - @c "done" - the user has clicked on the "ok" or "cancel"
22062     *      buttons (@c event_info is a pointer to the selection's
22063     *      path, a @b stringshared string)
22064     *
22065     * Here is an example on its usage:
22066     * @li @ref fileselector_example
22067     */
22068
22069    /**
22070     * @addtogroup Fileselector
22071     * @{
22072     */
22073
22074    /**
22075     * Defines how a file selector widget is to layout its contents
22076     * (file system entries).
22077     */
22078    typedef enum _Elm_Fileselector_Mode
22079      {
22080         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
22081         ELM_FILESELECTOR_GRID, /**< layout as a grid */
22082         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
22083      } Elm_Fileselector_Mode;
22084
22085    /**
22086     * Add a new file selector widget to the given parent Elementary
22087     * (container) object
22088     *
22089     * @param parent The parent object
22090     * @return a new file selector widget handle or @c NULL, on errors
22091     *
22092     * This function inserts a new file selector widget on the canvas.
22093     *
22094     * @ingroup Fileselector
22095     */
22096    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22097
22098    /**
22099     * Enable/disable the file name entry box where the user can type
22100     * in a name for a file, in a given file selector widget
22101     *
22102     * @param obj The file selector object
22103     * @param is_save @c EINA_TRUE to make the file selector a "saving
22104     * dialog", @c EINA_FALSE otherwise
22105     *
22106     * Having the entry editable is useful on file saving dialogs on
22107     * applications, where one gives a file name to save contents to,
22108     * in a given directory in the system. This custom file name will
22109     * be reported on the @c "done" smart callback.
22110     *
22111     * @see elm_fileselector_is_save_get()
22112     *
22113     * @ingroup Fileselector
22114     */
22115    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
22116
22117    /**
22118     * Get whether the given file selector is in "saving dialog" mode
22119     *
22120     * @param obj The file selector object
22121     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
22122     * mode, @c EINA_FALSE otherwise (and on errors)
22123     *
22124     * @see elm_fileselector_is_save_set() for more details
22125     *
22126     * @ingroup Fileselector
22127     */
22128    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22129
22130    /**
22131     * Enable/disable folder-only view for a given file selector widget
22132     *
22133     * @param obj The file selector object
22134     * @param only @c EINA_TRUE to make @p obj only display
22135     * directories, @c EINA_FALSE to make files to be displayed in it
22136     * too
22137     *
22138     * If enabled, the widget's view will only display folder items,
22139     * naturally.
22140     *
22141     * @see elm_fileselector_folder_only_get()
22142     *
22143     * @ingroup Fileselector
22144     */
22145    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
22146
22147    /**
22148     * Get whether folder-only view is set for a given file selector
22149     * widget
22150     *
22151     * @param obj The file selector object
22152     * @return only @c EINA_TRUE if @p obj is only displaying
22153     * directories, @c EINA_FALSE if files are being displayed in it
22154     * too (and on errors)
22155     *
22156     * @see elm_fileselector_folder_only_get()
22157     *
22158     * @ingroup Fileselector
22159     */
22160    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22161
22162    /**
22163     * Enable/disable the "ok" and "cancel" buttons on a given file
22164     * selector widget
22165     *
22166     * @param obj The file selector object
22167     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
22168     *
22169     * @note A file selector without those buttons will never emit the
22170     * @c "done" smart event, and is only usable if one is just hooking
22171     * to the other two events.
22172     *
22173     * @see elm_fileselector_buttons_ok_cancel_get()
22174     *
22175     * @ingroup Fileselector
22176     */
22177    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
22178
22179    /**
22180     * Get whether the "ok" and "cancel" buttons on a given file
22181     * selector widget are being shown.
22182     *
22183     * @param obj The file selector object
22184     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
22185     * otherwise (and on errors)
22186     *
22187     * @see elm_fileselector_buttons_ok_cancel_set() for more details
22188     *
22189     * @ingroup Fileselector
22190     */
22191    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22192
22193    /**
22194     * Enable/disable a tree view in the given file selector widget,
22195     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
22196     *
22197     * @param obj The file selector object
22198     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
22199     * disable
22200     *
22201     * In a tree view, arrows are created on the sides of directories,
22202     * allowing them to expand in place.
22203     *
22204     * @note If it's in other mode, the changes made by this function
22205     * will only be visible when one switches back to "list" mode.
22206     *
22207     * @see elm_fileselector_expandable_get()
22208     *
22209     * @ingroup Fileselector
22210     */
22211    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
22212
22213    /**
22214     * Get whether tree view is enabled for the given file selector
22215     * widget
22216     *
22217     * @param obj The file selector object
22218     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
22219     * otherwise (and or errors)
22220     *
22221     * @see elm_fileselector_expandable_set() for more details
22222     *
22223     * @ingroup Fileselector
22224     */
22225    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22226
22227    /**
22228     * Set, programmatically, the @b directory that a given file
22229     * selector widget will display contents from
22230     *
22231     * @param obj The file selector object
22232     * @param path The path to display in @p obj
22233     *
22234     * This will change the @b directory that @p obj is displaying. It
22235     * will also clear the text entry area on the @p obj object, which
22236     * displays select files' names.
22237     *
22238     * @see elm_fileselector_path_get()
22239     *
22240     * @ingroup Fileselector
22241     */
22242    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22243
22244    /**
22245     * Get the parent directory's path that a given file selector
22246     * widget is displaying
22247     *
22248     * @param obj The file selector object
22249     * @return The (full) path of the directory the file selector is
22250     * displaying, a @b stringshared string
22251     *
22252     * @see elm_fileselector_path_set()
22253     *
22254     * @ingroup Fileselector
22255     */
22256    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22257
22258    /**
22259     * Set, programmatically, the currently selected file/directory in
22260     * the given file selector widget
22261     *
22262     * @param obj The file selector object
22263     * @param path The (full) path to a file or directory
22264     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
22265     * latter case occurs if the directory or file pointed to do not
22266     * exist.
22267     *
22268     * @see elm_fileselector_selected_get()
22269     *
22270     * @ingroup Fileselector
22271     */
22272    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22273
22274    /**
22275     * Get the currently selected item's (full) path, in the given file
22276     * selector widget
22277     *
22278     * @param obj The file selector object
22279     * @return The absolute path of the selected item, a @b
22280     * stringshared string
22281     *
22282     * @note Custom editions on @p obj object's text entry, if made,
22283     * will appear on the return string of this function, naturally.
22284     *
22285     * @see elm_fileselector_selected_set() for more details
22286     *
22287     * @ingroup Fileselector
22288     */
22289    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22290
22291    /**
22292     * Set the mode in which a given file selector widget will display
22293     * (layout) file system entries in its view
22294     *
22295     * @param obj The file selector object
22296     * @param mode The mode of the fileselector, being it one of
22297     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
22298     * first one, naturally, will display the files in a list. The
22299     * latter will make the widget to display its entries in a grid
22300     * form.
22301     *
22302     * @note By using elm_fileselector_expandable_set(), the user may
22303     * trigger a tree view for that list.
22304     *
22305     * @note If Elementary is built with support of the Ethumb
22306     * thumbnailing library, the second form of view will display
22307     * preview thumbnails of files which it supports. You must have
22308     * elm_need_ethumb() called in your Elementary for thumbnailing to
22309     * work, though.
22310     *
22311     * @see elm_fileselector_expandable_set().
22312     * @see elm_fileselector_mode_get().
22313     *
22314     * @ingroup Fileselector
22315     */
22316    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
22317
22318    /**
22319     * Get the mode in which a given file selector widget is displaying
22320     * (layouting) file system entries in its view
22321     *
22322     * @param obj The fileselector object
22323     * @return The mode in which the fileselector is at
22324     *
22325     * @see elm_fileselector_mode_set() for more details
22326     *
22327     * @ingroup Fileselector
22328     */
22329    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22330
22331    /**
22332     * @}
22333     */
22334
22335    /**
22336     * @defgroup Progressbar Progress bar
22337     *
22338     * The progress bar is a widget for visually representing the
22339     * progress status of a given job/task.
22340     *
22341     * A progress bar may be horizontal or vertical. It may display an
22342     * icon besides it, as well as primary and @b units labels. The
22343     * former is meant to label the widget as a whole, while the
22344     * latter, which is formatted with floating point values (and thus
22345     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
22346     * units"</c>), is meant to label the widget's <b>progress
22347     * value</b>. Label, icon and unit strings/objects are @b optional
22348     * for progress bars.
22349     *
22350     * A progress bar may be @b inverted, in which state it gets its
22351     * values inverted, with high values being on the left or top and
22352     * low values on the right or bottom, as opposed to normally have
22353     * the low values on the former and high values on the latter,
22354     * respectively, for horizontal and vertical modes.
22355     *
22356     * The @b span of the progress, as set by
22357     * elm_progressbar_span_size_set(), is its length (horizontally or
22358     * vertically), unless one puts size hints on the widget to expand
22359     * on desired directions, by any container. That length will be
22360     * scaled by the object or applications scaling factor. At any
22361     * point code can query the progress bar for its value with
22362     * elm_progressbar_value_get().
22363     *
22364     * Available widget styles for progress bars:
22365     * - @c "default"
22366     * - @c "wheel" (simple style, no text, no progression, only
22367     *      "pulse" effect is available)
22368     *
22369     * Default contents parts of the progressbar widget that you can use for are:
22370     * @li "icon" - An icon of the progressbar
22371     *
22372     * Here is an example on its usage:
22373     * @li @ref progressbar_example
22374     */
22375
22376    /**
22377     * Add a new progress bar widget to the given parent Elementary
22378     * (container) object
22379     *
22380     * @param parent The parent object
22381     * @return a new progress bar widget handle or @c NULL, on errors
22382     *
22383     * This function inserts a new progress bar widget on the canvas.
22384     *
22385     * @ingroup Progressbar
22386     */
22387    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22388
22389    /**
22390     * Set whether a given progress bar widget is at "pulsing mode" or
22391     * not.
22392     *
22393     * @param obj The progress bar object
22394     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
22395     * @c EINA_FALSE to put it back to its default one
22396     *
22397     * By default, progress bars will display values from the low to
22398     * high value boundaries. There are, though, contexts in which the
22399     * state of progression of a given task is @b unknown.  For those,
22400     * one can set a progress bar widget to a "pulsing state", to give
22401     * the user an idea that some computation is being held, but
22402     * without exact progress values. In the default theme it will
22403     * animate its bar with the contents filling in constantly and back
22404     * to non-filled, in a loop. To start and stop this pulsing
22405     * animation, one has to explicitly call elm_progressbar_pulse().
22406     *
22407     * @see elm_progressbar_pulse_get()
22408     * @see elm_progressbar_pulse()
22409     *
22410     * @ingroup Progressbar
22411     */
22412    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
22413
22414    /**
22415     * Get whether a given progress bar widget is at "pulsing mode" or
22416     * not.
22417     *
22418     * @param obj The progress bar object
22419     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
22420     * if it's in the default one (and on errors)
22421     *
22422     * @ingroup Progressbar
22423     */
22424    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22425
22426    /**
22427     * Start/stop a given progress bar "pulsing" animation, if its
22428     * under that mode
22429     *
22430     * @param obj The progress bar object
22431     * @param state @c EINA_TRUE, to @b start the pulsing animation,
22432     * @c EINA_FALSE to @b stop it
22433     *
22434     * @note This call won't do anything if @p obj is not under "pulsing mode".
22435     *
22436     * @see elm_progressbar_pulse_set() for more details.
22437     *
22438     * @ingroup Progressbar
22439     */
22440    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
22441
22442    /**
22443     * Set the progress value (in percentage) on a given progress bar
22444     * widget
22445     *
22446     * @param obj The progress bar object
22447     * @param val The progress value (@b must be between @c 0.0 and @c
22448     * 1.0)
22449     *
22450     * Use this call to set progress bar levels.
22451     *
22452     * @note If you passes a value out of the specified range for @p
22453     * val, it will be interpreted as the @b closest of the @b boundary
22454     * values in the range.
22455     *
22456     * @ingroup Progressbar
22457     */
22458    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22459
22460    /**
22461     * Get the progress value (in percentage) on a given progress bar
22462     * widget
22463     *
22464     * @param obj The progress bar object
22465     * @return The value of the progressbar
22466     *
22467     * @see elm_progressbar_value_set() for more details
22468     *
22469     * @ingroup Progressbar
22470     */
22471    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22472
22473    /**
22474     * Set the label of a given progress bar widget
22475     *
22476     * @param obj The progress bar object
22477     * @param label The text label string, in UTF-8
22478     *
22479     * @ingroup Progressbar
22480     * @deprecated use elm_object_text_set() instead.
22481     */
22482    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
22483
22484    /**
22485     * Get the label of a given progress bar widget
22486     *
22487     * @param obj The progressbar object
22488     * @return The text label string, in UTF-8
22489     *
22490     * @ingroup Progressbar
22491     * @deprecated use elm_object_text_set() instead.
22492     */
22493    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22494
22495    /**
22496     * Set the icon object of a given progress bar widget
22497     *
22498     * @param obj The progress bar object
22499     * @param icon The icon object
22500     *
22501     * Use this call to decorate @p obj with an icon next to it.
22502     *
22503     * @note Once the icon object is set, a previously set one will be
22504     * deleted. If you want to keep that old content object, use the
22505     * elm_progressbar_icon_unset() function.
22506     *
22507     * @see elm_progressbar_icon_get()
22508     * @deprecated use elm_object_part_content_set() instead.
22509     *
22510     * @ingroup Progressbar
22511     */
22512    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
22513
22514    /**
22515     * Retrieve the icon object set for a given progress bar widget
22516     *
22517     * @param obj The progress bar object
22518     * @return The icon object's handle, if @p obj had one set, or @c NULL,
22519     * otherwise (and on errors)
22520     *
22521     * @see elm_progressbar_icon_set() for more details
22522     * @deprecated use elm_object_part_content_get() instead.
22523     *
22524     * @ingroup Progressbar
22525     */
22526    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22527
22528    /**
22529     * Unset an icon set on a given progress bar widget
22530     *
22531     * @param obj The progress bar object
22532     * @return The icon object that was being used, if any was set, or
22533     * @c NULL, otherwise (and on errors)
22534     *
22535     * This call will unparent and return the icon object which was set
22536     * for this widget, previously, on success.
22537     *
22538     * @see elm_progressbar_icon_set() for more details
22539     * @deprecated use elm_object_part_content_unset() instead.
22540     *
22541     * @ingroup Progressbar
22542     */
22543    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22544
22545    /**
22546     * Set the (exact) length of the bar region of a given progress bar
22547     * widget
22548     *
22549     * @param obj The progress bar object
22550     * @param size The length of the progress bar's bar region
22551     *
22552     * This sets the minimum width (when in horizontal mode) or height
22553     * (when in vertical mode) of the actual bar area of the progress
22554     * bar @p obj. This in turn affects the object's minimum size. Use
22555     * this when you're not setting other size hints expanding on the
22556     * given direction (like weight and alignment hints) and you would
22557     * like it to have a specific size.
22558     *
22559     * @note Icon, label and unit text around @p obj will require their
22560     * own space, which will make @p obj to require more the @p size,
22561     * actually.
22562     *
22563     * @see elm_progressbar_span_size_get()
22564     *
22565     * @ingroup Progressbar
22566     */
22567    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
22568
22569    /**
22570     * Get the length set for the bar region of a given progress bar
22571     * widget
22572     *
22573     * @param obj The progress bar object
22574     * @return The length of the progress bar's bar region
22575     *
22576     * If that size was not set previously, with
22577     * elm_progressbar_span_size_set(), this call will return @c 0.
22578     *
22579     * @ingroup Progressbar
22580     */
22581    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22582
22583    /**
22584     * Set the format string for a given progress bar widget's units
22585     * label
22586     *
22587     * @param obj The progress bar object
22588     * @param format The format string for @p obj's units label
22589     *
22590     * If @c NULL is passed on @p format, it will make @p obj's units
22591     * area to be hidden completely. If not, it'll set the <b>format
22592     * string</b> for the units label's @b text. The units label is
22593     * provided a floating point value, so the units text is up display
22594     * at most one floating point falue. Note that the units label is
22595     * optional. Use a format string such as "%1.2f meters" for
22596     * example.
22597     *
22598     * @note The default format string for a progress bar is an integer
22599     * percentage, as in @c "%.0f %%".
22600     *
22601     * @see elm_progressbar_unit_format_get()
22602     *
22603     * @ingroup Progressbar
22604     */
22605    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
22606
22607    /**
22608     * Retrieve the format string set for a given progress bar widget's
22609     * units label
22610     *
22611     * @param obj The progress bar object
22612     * @return The format set string for @p obj's units label or
22613     * @c NULL, if none was set (and on errors)
22614     *
22615     * @see elm_progressbar_unit_format_set() for more details
22616     *
22617     * @ingroup Progressbar
22618     */
22619    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22620
22621    /**
22622     * Set the orientation of a given progress bar widget
22623     *
22624     * @param obj The progress bar object
22625     * @param horizontal Use @c EINA_TRUE to make @p obj to be
22626     * @b horizontal, @c EINA_FALSE to make it @b vertical
22627     *
22628     * Use this function to change how your progress bar is to be
22629     * disposed: vertically or horizontally.
22630     *
22631     * @see elm_progressbar_horizontal_get()
22632     *
22633     * @ingroup Progressbar
22634     */
22635    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22636
22637    /**
22638     * Retrieve the orientation of a given progress bar widget
22639     *
22640     * @param obj The progress bar object
22641     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22642     * @c EINA_FALSE if it's @b vertical (and on errors)
22643     *
22644     * @see elm_progressbar_horizontal_set() for more details
22645     *
22646     * @ingroup Progressbar
22647     */
22648    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22649
22650    /**
22651     * Invert a given progress bar widget's displaying values order
22652     *
22653     * @param obj The progress bar object
22654     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
22655     * @c EINA_FALSE to bring it back to default, non-inverted values.
22656     *
22657     * A progress bar may be @b inverted, in which state it gets its
22658     * values inverted, with high values being on the left or top and
22659     * low values on the right or bottom, as opposed to normally have
22660     * the low values on the former and high values on the latter,
22661     * respectively, for horizontal and vertical modes.
22662     *
22663     * @see elm_progressbar_inverted_get()
22664     *
22665     * @ingroup Progressbar
22666     */
22667    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
22668
22669    /**
22670     * Get whether a given progress bar widget's displaying values are
22671     * inverted or not
22672     *
22673     * @param obj The progress bar object
22674     * @return @c EINA_TRUE, if @p obj has inverted values,
22675     * @c EINA_FALSE otherwise (and on errors)
22676     *
22677     * @see elm_progressbar_inverted_set() for more details
22678     *
22679     * @ingroup Progressbar
22680     */
22681    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22682
22683    /**
22684     * @defgroup Separator Separator
22685     *
22686     * @brief Separator is a very thin object used to separate other objects.
22687     *
22688     * A separator can be vertical or horizontal.
22689     *
22690     * @ref tutorial_separator is a good example of how to use a separator.
22691     * @{
22692     */
22693    /**
22694     * @brief Add a separator object to @p parent
22695     *
22696     * @param parent The parent object
22697     *
22698     * @return The separator object, or NULL upon failure
22699     */
22700    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22701    /**
22702     * @brief Set the horizontal mode of a separator object
22703     *
22704     * @param obj The separator object
22705     * @param horizontal If true, the separator is horizontal
22706     */
22707    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22708    /**
22709     * @brief Get the horizontal mode of a separator object
22710     *
22711     * @param obj The separator object
22712     * @return If true, the separator is horizontal
22713     *
22714     * @see elm_separator_horizontal_set()
22715     */
22716    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22717    /**
22718     * @}
22719     */
22720
22721    /**
22722     * @defgroup Spinner Spinner
22723     * @ingroup Elementary
22724     *
22725     * @image html img/widget/spinner/preview-00.png
22726     * @image latex img/widget/spinner/preview-00.eps
22727     *
22728     * A spinner is a widget which allows the user to increase or decrease
22729     * numeric values using arrow buttons, or edit values directly, clicking
22730     * over it and typing the new value.
22731     *
22732     * By default the spinner will not wrap and has a label
22733     * of "%.0f" (just showing the integer value of the double).
22734     *
22735     * A spinner has a label that is formatted with floating
22736     * point values and thus accepts a printf-style format string, like
22737     * ā€œ%1.2f unitsā€.
22738     *
22739     * It also allows specific values to be replaced by pre-defined labels.
22740     *
22741     * Smart callbacks one can register to:
22742     *
22743     * - "changed" - Whenever the spinner value is changed.
22744     * - "delay,changed" - A short time after the value is changed by the user.
22745     *    This will be called only when the user stops dragging for a very short
22746     *    period or when they release their finger/mouse, so it avoids possibly
22747     *    expensive reactions to the value change.
22748     *
22749     * Available styles for it:
22750     * - @c "default";
22751     * - @c "vertical": up/down buttons at the right side and text left aligned.
22752     *
22753     * Here is an example on its usage:
22754     * @ref spinner_example
22755     */
22756
22757    /**
22758     * @addtogroup Spinner
22759     * @{
22760     */
22761
22762    /**
22763     * Add a new spinner widget to the given parent Elementary
22764     * (container) object.
22765     *
22766     * @param parent The parent object.
22767     * @return a new spinner widget handle or @c NULL, on errors.
22768     *
22769     * This function inserts a new spinner widget on the canvas.
22770     *
22771     * @ingroup Spinner
22772     *
22773     */
22774    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22775
22776    /**
22777     * Set the format string of the displayed label.
22778     *
22779     * @param obj The spinner object.
22780     * @param fmt The format string for the label display.
22781     *
22782     * If @c NULL, this sets the format to "%.0f". If not it sets the format
22783     * string for the label text. The label text is provided a floating point
22784     * value, so the label text can display up to 1 floating point value.
22785     * Note that this is optional.
22786     *
22787     * Use a format string such as "%1.2f meters" for example, and it will
22788     * display values like: "3.14 meters" for a value equal to 3.14159.
22789     *
22790     * Default is "%0.f".
22791     *
22792     * @see elm_spinner_label_format_get()
22793     *
22794     * @ingroup Spinner
22795     */
22796    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
22797
22798    /**
22799     * Get the label format of the spinner.
22800     *
22801     * @param obj The spinner object.
22802     * @return The text label format string in UTF-8.
22803     *
22804     * @see elm_spinner_label_format_set() for details.
22805     *
22806     * @ingroup Spinner
22807     */
22808    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22809
22810    /**
22811     * Set the minimum and maximum values for the spinner.
22812     *
22813     * @param obj The spinner object.
22814     * @param min The minimum value.
22815     * @param max The maximum value.
22816     *
22817     * Define the allowed range of values to be selected by the user.
22818     *
22819     * If actual value is less than @p min, it will be updated to @p min. If it
22820     * is bigger then @p max, will be updated to @p max. Actual value can be
22821     * get with elm_spinner_value_get().
22822     *
22823     * By default, min is equal to 0, and max is equal to 100.
22824     *
22825     * @warning Maximum must be greater than minimum.
22826     *
22827     * @see elm_spinner_min_max_get()
22828     *
22829     * @ingroup Spinner
22830     */
22831    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
22832
22833    /**
22834     * Get the minimum and maximum values of the spinner.
22835     *
22836     * @param obj The spinner object.
22837     * @param min Pointer where to store the minimum value.
22838     * @param max Pointer where to store the maximum value.
22839     *
22840     * @note If only one value is needed, the other pointer can be passed
22841     * as @c NULL.
22842     *
22843     * @see elm_spinner_min_max_set() for details.
22844     *
22845     * @ingroup Spinner
22846     */
22847    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
22848
22849    /**
22850     * Set the step used to increment or decrement the spinner value.
22851     *
22852     * @param obj The spinner object.
22853     * @param step The step value.
22854     *
22855     * This value will be incremented or decremented to the displayed value.
22856     * It will be incremented while the user keep right or top arrow pressed,
22857     * and will be decremented while the user keep left or bottom arrow pressed.
22858     *
22859     * The interval to increment / decrement can be set with
22860     * elm_spinner_interval_set().
22861     *
22862     * By default step value is equal to 1.
22863     *
22864     * @see elm_spinner_step_get()
22865     *
22866     * @ingroup Spinner
22867     */
22868    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
22869
22870    /**
22871     * Get the step used to increment or decrement the spinner value.
22872     *
22873     * @param obj The spinner object.
22874     * @return The step value.
22875     *
22876     * @see elm_spinner_step_get() for more details.
22877     *
22878     * @ingroup Spinner
22879     */
22880    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22881
22882    /**
22883     * Set the value the spinner displays.
22884     *
22885     * @param obj The spinner object.
22886     * @param val The value to be displayed.
22887     *
22888     * Value will be presented on the label following format specified with
22889     * elm_spinner_format_set().
22890     *
22891     * @warning The value must to be between min and max values. This values
22892     * are set by elm_spinner_min_max_set().
22893     *
22894     * @see elm_spinner_value_get().
22895     * @see elm_spinner_format_set().
22896     * @see elm_spinner_min_max_set().
22897     *
22898     * @ingroup Spinner
22899     */
22900    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22901
22902    /**
22903     * Get the value displayed by the spinner.
22904     *
22905     * @param obj The spinner object.
22906     * @return The value displayed.
22907     *
22908     * @see elm_spinner_value_set() for details.
22909     *
22910     * @ingroup Spinner
22911     */
22912    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22913
22914    /**
22915     * Set whether the spinner should wrap when it reaches its
22916     * minimum or maximum value.
22917     *
22918     * @param obj The spinner object.
22919     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
22920     * disable it.
22921     *
22922     * Disabled by default. If disabled, when the user tries to increment the
22923     * value,
22924     * but displayed value plus step value is bigger than maximum value,
22925     * the spinner
22926     * won't allow it. The same happens when the user tries to decrement it,
22927     * but the value less step is less than minimum value.
22928     *
22929     * When wrap is enabled, in such situations it will allow these changes,
22930     * but will get the value that would be less than minimum and subtracts
22931     * from maximum. Or add the value that would be more than maximum to
22932     * the minimum.
22933     *
22934     * E.g.:
22935     * @li min value = 10
22936     * @li max value = 50
22937     * @li step value = 20
22938     * @li displayed value = 20
22939     *
22940     * When the user decrement value (using left or bottom arrow), it will
22941     * displays @c 40, because max - (min - (displayed - step)) is
22942     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
22943     *
22944     * @see elm_spinner_wrap_get().
22945     *
22946     * @ingroup Spinner
22947     */
22948    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
22949
22950    /**
22951     * Get whether the spinner should wrap when it reaches its
22952     * minimum or maximum value.
22953     *
22954     * @param obj The spinner object
22955     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
22956     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22957     *
22958     * @see elm_spinner_wrap_set() for details.
22959     *
22960     * @ingroup Spinner
22961     */
22962    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22963
22964    /**
22965     * Set whether the spinner can be directly edited by the user or not.
22966     *
22967     * @param obj The spinner object.
22968     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
22969     * don't allow users to edit it directly.
22970     *
22971     * Spinner objects can have edition @b disabled, in which state they will
22972     * be changed only by arrows.
22973     * Useful for contexts
22974     * where you don't want your users to interact with it writting the value.
22975     * Specially
22976     * when using special values, the user can see real value instead
22977     * of special label on edition.
22978     *
22979     * It's enabled by default.
22980     *
22981     * @see elm_spinner_editable_get()
22982     *
22983     * @ingroup Spinner
22984     */
22985    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22986
22987    /**
22988     * Get whether the spinner can be directly edited by the user or not.
22989     *
22990     * @param obj The spinner object.
22991     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
22992     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22993     *
22994     * @see elm_spinner_editable_set() for details.
22995     *
22996     * @ingroup Spinner
22997     */
22998    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22999
23000    /**
23001     * Set a special string to display in the place of the numerical value.
23002     *
23003     * @param obj The spinner object.
23004     * @param value The value to be replaced.
23005     * @param label The label to be used.
23006     *
23007     * It's useful for cases when a user should select an item that is
23008     * better indicated by a label than a value. For example, weekdays or months.
23009     *
23010     * E.g.:
23011     * @code
23012     * sp = elm_spinner_add(win);
23013     * elm_spinner_min_max_set(sp, 1, 3);
23014     * elm_spinner_special_value_add(sp, 1, "January");
23015     * elm_spinner_special_value_add(sp, 2, "February");
23016     * elm_spinner_special_value_add(sp, 3, "March");
23017     * evas_object_show(sp);
23018     * @endcode
23019     *
23020     * @ingroup Spinner
23021     */
23022    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
23023
23024    /**
23025     * Set the interval on time updates for an user mouse button hold
23026     * on spinner widgets' arrows.
23027     *
23028     * @param obj The spinner object.
23029     * @param interval The (first) interval value in seconds.
23030     *
23031     * This interval value is @b decreased while the user holds the
23032     * mouse pointer either incrementing or decrementing spinner's value.
23033     *
23034     * This helps the user to get to a given value distant from the
23035     * current one easier/faster, as it will start to change quicker and
23036     * quicker on mouse button holds.
23037     *
23038     * The calculation for the next change interval value, starting from
23039     * the one set with this call, is the previous interval divided by
23040     * @c 1.05, so it decreases a little bit.
23041     *
23042     * The default starting interval value for automatic changes is
23043     * @c 0.85 seconds.
23044     *
23045     * @see elm_spinner_interval_get()
23046     *
23047     * @ingroup Spinner
23048     */
23049    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23050
23051    /**
23052     * Get the interval on time updates for an user mouse button hold
23053     * on spinner widgets' arrows.
23054     *
23055     * @param obj The spinner object.
23056     * @return The (first) interval value, in seconds, set on it.
23057     *
23058     * @see elm_spinner_interval_set() for more details.
23059     *
23060     * @ingroup Spinner
23061     */
23062    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23063
23064    /**
23065     * @}
23066     */
23067
23068    /**
23069     * @defgroup Index Index
23070     *
23071     * @image html img/widget/index/preview-00.png
23072     * @image latex img/widget/index/preview-00.eps
23073     *
23074     * An index widget gives you an index for fast access to whichever
23075     * group of other UI items one might have. It's a list of text
23076     * items (usually letters, for alphabetically ordered access).
23077     *
23078     * Index widgets are by default hidden and just appear when the
23079     * user clicks over it's reserved area in the canvas. In its
23080     * default theme, it's an area one @ref Fingers "finger" wide on
23081     * the right side of the index widget's container.
23082     *
23083     * When items on the index are selected, smart callbacks get
23084     * called, so that its user can make other container objects to
23085     * show a given area or child object depending on the index item
23086     * selected. You'd probably be using an index together with @ref
23087     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
23088     * "general grids".
23089     *
23090     * Smart events one  can add callbacks for are:
23091     * - @c "changed" - When the selected index item changes. @c
23092     *      event_info is the selected item's data pointer.
23093     * - @c "delay,changed" - When the selected index item changes, but
23094     *      after a small idling period. @c event_info is the selected
23095     *      item's data pointer.
23096     * - @c "selected" - When the user releases a mouse button and
23097     *      selects an item. @c event_info is the selected item's data
23098     *      pointer.
23099     * - @c "level,up" - when the user moves a finger from the first
23100     *      level to the second level
23101     * - @c "level,down" - when the user moves a finger from the second
23102     *      level to the first level
23103     *
23104     * The @c "delay,changed" event is so that it'll wait a small time
23105     * before actually reporting those events and, moreover, just the
23106     * last event happening on those time frames will actually be
23107     * reported.
23108     *
23109     * Here are some examples on its usage:
23110     * @li @ref index_example_01
23111     * @li @ref index_example_02
23112     */
23113
23114    /**
23115     * @addtogroup Index
23116     * @{
23117     */
23118
23119    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
23120
23121    /**
23122     * Add a new index widget to the given parent Elementary
23123     * (container) object
23124     *
23125     * @param parent The parent object
23126     * @return a new index widget handle or @c NULL, on errors
23127     *
23128     * This function inserts a new index widget on the canvas.
23129     *
23130     * @ingroup Index
23131     */
23132    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23133
23134    /**
23135     * Set whether a given index widget is or not visible,
23136     * programatically.
23137     *
23138     * @param obj The index object
23139     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
23140     *
23141     * Not to be confused with visible as in @c evas_object_show() --
23142     * visible with regard to the widget's auto hiding feature.
23143     *
23144     * @see elm_index_active_get()
23145     *
23146     * @ingroup Index
23147     */
23148    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
23149
23150    /**
23151     * Get whether a given index widget is currently visible or not.
23152     *
23153     * @param obj The index object
23154     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
23155     *
23156     * @see elm_index_active_set() for more details
23157     *
23158     * @ingroup Index
23159     */
23160    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23161
23162    /**
23163     * Set the items level for a given index widget.
23164     *
23165     * @param obj The index object.
23166     * @param level @c 0 or @c 1, the currently implemented levels.
23167     *
23168     * @see elm_index_item_level_get()
23169     *
23170     * @ingroup Index
23171     */
23172    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23173
23174    /**
23175     * Get the items level set for a given index widget.
23176     *
23177     * @param obj The index object.
23178     * @return @c 0 or @c 1, which are the levels @p obj might be at.
23179     *
23180     * @see elm_index_item_level_set() for more information
23181     *
23182     * @ingroup Index
23183     */
23184    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23185
23186    /**
23187     * Returns the last selected item, for a given index widget.
23188     *
23189     * @param obj The index object.
23190     * @return The last item @b selected on @p obj (or @c NULL, on errors).
23191     *
23192     * @ingroup Index
23193     */
23194    EAPI Elm_Index_Item *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23195
23196    /**
23197     * Append a new item on a given index widget.
23198     *
23199     * @param obj The index object.
23200     * @param letter Letter under which the item should be indexed
23201     * @param item The item data to set for the index's item
23202     *
23203     * Despite the most common usage of the @p letter argument is for
23204     * single char strings, one could use arbitrary strings as index
23205     * entries.
23206     *
23207     * @c item will be the pointer returned back on @c "changed", @c
23208     * "delay,changed" and @c "selected" smart events.
23209     *
23210     * @ingroup Index
23211     */
23212    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23213
23214    /**
23215     * Prepend a new item on a given index widget.
23216     *
23217     * @param obj The index object.
23218     * @param letter Letter under which the item should be indexed
23219     * @param item The item data to set for the index's item
23220     *
23221     * Despite the most common usage of the @p letter argument is for
23222     * single char strings, one could use arbitrary strings as index
23223     * entries.
23224     *
23225     * @c item will be the pointer returned back on @c "changed", @c
23226     * "delay,changed" and @c "selected" smart events.
23227     *
23228     * @ingroup Index
23229     */
23230    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23231
23232    /**
23233     * Append a new item, on a given index widget, <b>after the item
23234     * having @p relative as data</b>.
23235     *
23236     * @param obj The index object.
23237     * @param letter Letter under which the item should be indexed
23238     * @param item The item data to set for the index's item
23239     * @param relative The index item to be the predecessor of this new one
23240     *
23241     * Despite the most common usage of the @p letter argument is for
23242     * single char strings, one could use arbitrary strings as index
23243     * entries.
23244     *
23245     * @c item will be the pointer returned back on @c "changed", @c
23246     * "delay,changed" and @c "selected" smart events.
23247     *
23248     * @note If @p relative is @c NULL this function will behave as
23249     * elm_index_item_append().
23250     *
23251     * @ingroup Index
23252     */
23253    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);
23254
23255    /**
23256     * Prepend a new item, on a given index widget, <b>after the item
23257     * having @p relative as data</b>.
23258     *
23259     * @param obj The index object.
23260     * @param letter Letter under which the item should be indexed
23261     * @param item The item data to set for the index's item
23262     * @param relative The index item to be the successor of this new one
23263     *
23264     * Despite the most common usage of the @p letter argument is for
23265     * single char strings, one could use arbitrary strings as index
23266     * entries.
23267     *
23268     * @c item will be the pointer returned back on @c "changed", @c
23269     * "delay,changed" and @c "selected" smart events.
23270     *
23271     * @note If @p relative is @c NULL this function will behave as
23272     * elm_index_item_prepend().
23273     *
23274     * @ingroup Index
23275     */
23276    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);
23277
23278    /**
23279     * Insert a new item into the given index widget, using @p cmp_func
23280     * function to sort items (by item handles).
23281     *
23282     * @param obj The index object.
23283     * @param letter Letter under which the item should be indexed
23284     * @param item The item data to set for the index's item
23285     * @param cmp_func The comparing function to be used to sort index
23286     * items <b>by #Elm_Index_Item item handles</b>
23287     * @param cmp_data_func A @b fallback function to be called for the
23288     * sorting of index items <b>by item data</b>). It will be used
23289     * when @p cmp_func returns @c 0 (equality), which means an index
23290     * item with provided item data already exists. To decide which
23291     * data item should be pointed to by the index item in question, @p
23292     * cmp_data_func will be used. If @p cmp_data_func returns a
23293     * non-negative value, the previous index item data will be
23294     * replaced by the given @p item pointer. If the previous data need
23295     * to be freed, it should be done by the @p cmp_data_func function,
23296     * because all references to it will be lost. If this function is
23297     * not provided (@c NULL is given), index items will be @b
23298     * duplicated, if @p cmp_func returns @c 0.
23299     *
23300     * Despite the most common usage of the @p letter argument is for
23301     * single char strings, one could use arbitrary strings as index
23302     * entries.
23303     *
23304     * @c item will be the pointer returned back on @c "changed", @c
23305     * "delay,changed" and @c "selected" smart events.
23306     *
23307     * @ingroup Index
23308     */
23309    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);
23310
23311    /**
23312     * Remove an item from a given index widget, <b>to be referenced by
23313     * it's data value</b>.
23314     *
23315     * @param obj The index object
23316     * @param item The item to be removed from @p obj
23317     *
23318     * If a deletion callback is set, via elm_index_item_del_cb_set(),
23319     * that callback function will be called by this one.
23320     *
23321     * @ingroup Index
23322     */
23323    EAPI void            elm_index_item_del(Evas_Object *obj, Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23324
23325    /**
23326     * Find a given index widget's item, <b>using item data</b>.
23327     *
23328     * @param obj The index object
23329     * @param item The item data pointed to by the desired index item
23330     * @return The index item handle, if found, or @c NULL otherwise
23331     *
23332     * @ingroup Index
23333     */
23334    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
23335
23336    /**
23337     * Removes @b all items from a given index widget.
23338     *
23339     * @param obj The index object.
23340     *
23341     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
23342     * that callback function will be called for each item in @p obj.
23343     *
23344     * @ingroup Index
23345     */
23346    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23347
23348    /**
23349     * Go to a given items level on a index widget
23350     *
23351     * @param obj The index object
23352     * @param level The index level (one of @c 0 or @c 1)
23353     *
23354     * @ingroup Index
23355     */
23356    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23357
23358    /**
23359     * Return the data associated with a given index widget item
23360     *
23361     * @param it The index widget item handle
23362     * @return The data associated with @p it
23363     *
23364     * @see elm_index_item_data_set()
23365     *
23366     * @ingroup Index
23367     */
23368    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23369
23370    /**
23371     * Set the data associated with a given index widget item
23372     *
23373     * @param it The index widget item handle
23374     * @param data The new data pointer to set to @p it
23375     *
23376     * This sets new item data on @p it.
23377     *
23378     * @warning The old data pointer won't be touched by this function, so
23379     * the user had better to free that old data himself/herself.
23380     *
23381     * @ingroup Index
23382     */
23383    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
23384
23385    /**
23386     * Set the function to be called when a given index widget item is freed.
23387     *
23388     * @param it The item to set the callback on
23389     * @param func The function to call on the item's deletion
23390     *
23391     * When called, @p func will have both @c data and @c event_info
23392     * arguments with the @p it item's data value and, naturally, the
23393     * @c obj argument with a handle to the parent index widget.
23394     *
23395     * @ingroup Index
23396     */
23397    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
23398
23399    /**
23400     * Get the letter (string) set on a given index widget item.
23401     *
23402     * @param it The index item handle
23403     * @return The letter string set on @p it
23404     *
23405     * @ingroup Index
23406     */
23407    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23408
23409    /**
23410     * @}
23411     */
23412
23413    /**
23414     * @defgroup Photocam Photocam
23415     *
23416     * @image html img/widget/photocam/preview-00.png
23417     * @image latex img/widget/photocam/preview-00.eps
23418     *
23419     * This is a widget specifically for displaying high-resolution digital
23420     * camera photos giving speedy feedback (fast load), low memory footprint
23421     * and zooming and panning as well as fitting logic. It is entirely focused
23422     * on jpeg images, and takes advantage of properties of the jpeg format (via
23423     * evas loader features in the jpeg loader).
23424     *
23425     * Signals that you can add callbacks for are:
23426     * @li "clicked" - This is called when a user has clicked the photo without
23427     *                 dragging around.
23428     * @li "press" - This is called when a user has pressed down on the photo.
23429     * @li "longpressed" - This is called when a user has pressed down on the
23430     *                     photo for a long time without dragging around.
23431     * @li "clicked,double" - This is called when a user has double-clicked the
23432     *                        photo.
23433     * @li "load" - Photo load begins.
23434     * @li "loaded" - This is called when the image file load is complete for the
23435     *                first view (low resolution blurry version).
23436     * @li "load,detail" - Photo detailed data load begins.
23437     * @li "loaded,detail" - This is called when the image file load is complete
23438     *                      for the detailed image data (full resolution needed).
23439     * @li "zoom,start" - Zoom animation started.
23440     * @li "zoom,stop" - Zoom animation stopped.
23441     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
23442     * @li "scroll" - the content has been scrolled (moved)
23443     * @li "scroll,anim,start" - scrolling animation has started
23444     * @li "scroll,anim,stop" - scrolling animation has stopped
23445     * @li "scroll,drag,start" - dragging the contents around has started
23446     * @li "scroll,drag,stop" - dragging the contents around has stopped
23447     *
23448     * @ref tutorial_photocam shows the API in action.
23449     * @{
23450     */
23451
23452    /**
23453     * @brief Types of zoom available.
23454     */
23455    typedef enum _Elm_Photocam_Zoom_Mode
23456      {
23457         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
23458         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
23459         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
23460         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN, /**< Unzoom until photo fits in photocam */
23461         ELM_PHOTOCAM_ZOOM_MODE_LAST
23462      } Elm_Photocam_Zoom_Mode;
23463
23464    /**
23465     * @brief Add a new Photocam object
23466     *
23467     * @param parent The parent object
23468     * @return The new object or NULL if it cannot be created
23469     */
23470    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23471
23472    /**
23473     * @brief Set the photo file to be shown
23474     *
23475     * @param obj The photocam object
23476     * @param file The photo file
23477     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
23478     *
23479     * This sets (and shows) the specified file (with a relative or absolute
23480     * path) and will return a load error (same error that
23481     * evas_object_image_load_error_get() will return). The image will change and
23482     * adjust its size at this point and begin a background load process for this
23483     * photo that at some time in the future will be displayed at the full
23484     * quality needed.
23485     */
23486    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
23487
23488    /**
23489     * @brief Returns the path of the current image file
23490     *
23491     * @param obj The photocam object
23492     * @return Returns the path
23493     *
23494     * @see elm_photocam_file_set()
23495     */
23496    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23497
23498    /**
23499     * @brief Set the zoom level of the photo
23500     *
23501     * @param obj The photocam object
23502     * @param zoom The zoom level to set
23503     *
23504     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
23505     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
23506     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
23507     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
23508     * 16, 32, etc.).
23509     */
23510    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
23511
23512    /**
23513     * @brief Get the zoom level of the photo
23514     *
23515     * @param obj The photocam object
23516     * @return The current zoom level
23517     *
23518     * This returns the current zoom level of the photocam object. Note that if
23519     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
23520     * (which is the default), the zoom level may be changed at any time by the
23521     * photocam object itself to account for photo size and photocam viewpoer
23522     * size.
23523     *
23524     * @see elm_photocam_zoom_set()
23525     * @see elm_photocam_zoom_mode_set()
23526     */
23527    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23528
23529    /**
23530     * @brief Set the zoom mode
23531     *
23532     * @param obj The photocam object
23533     * @param mode The desired mode
23534     *
23535     * This sets the zoom mode to manual or one of several automatic levels.
23536     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
23537     * elm_photocam_zoom_set() and will stay at that level until changed by code
23538     * or until zoom mode is changed. This is the default mode. The Automatic
23539     * modes will allow the photocam object to automatically adjust zoom mode
23540     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
23541     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
23542     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
23543     * pixels within the frame are left unfilled.
23544     */
23545    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23546
23547    /**
23548     * @brief Get the zoom mode
23549     *
23550     * @param obj The photocam object
23551     * @return The current zoom mode
23552     *
23553     * This gets the current zoom mode of the photocam object.
23554     *
23555     * @see elm_photocam_zoom_mode_set()
23556     */
23557    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23558
23559    /**
23560     * @brief Get the current image pixel width and height
23561     *
23562     * @param obj The photocam object
23563     * @param w A pointer to the width return
23564     * @param h A pointer to the height return
23565     *
23566     * This gets the current photo pixel width and height (for the original).
23567     * The size will be returned in the integers @p w and @p h that are pointed
23568     * to.
23569     */
23570    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
23571
23572    /**
23573     * @brief Get the area of the image that is currently shown
23574     *
23575     * @param obj
23576     * @param x A pointer to the X-coordinate of region
23577     * @param y A pointer to the Y-coordinate of region
23578     * @param w A pointer to the width
23579     * @param h A pointer to the height
23580     *
23581     * @see elm_photocam_image_region_show()
23582     * @see elm_photocam_image_region_bring_in()
23583     */
23584    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
23585
23586    /**
23587     * @brief Set the viewed portion of the image
23588     *
23589     * @param obj The photocam object
23590     * @param x X-coordinate of region in image original pixels
23591     * @param y Y-coordinate of region in image original pixels
23592     * @param w Width of region in image original pixels
23593     * @param h Height of region in image original pixels
23594     *
23595     * This shows the region of the image without using animation.
23596     */
23597    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23598
23599    /**
23600     * @brief Bring in the viewed portion of the image
23601     *
23602     * @param obj The photocam object
23603     * @param x X-coordinate of region in image original pixels
23604     * @param y Y-coordinate of region in image original pixels
23605     * @param w Width of region in image original pixels
23606     * @param h Height of region in image original pixels
23607     *
23608     * This shows the region of the image using animation.
23609     */
23610    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23611
23612    /**
23613     * @brief Set the paused state for photocam
23614     *
23615     * @param obj The photocam object
23616     * @param paused The pause state to set
23617     *
23618     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
23619     * photocam. The default is off. This will stop zooming using animation on
23620     * zoom levels changes and change instantly. This will stop any existing
23621     * animations that are running.
23622     */
23623    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23624
23625    /**
23626     * @brief Get the paused state for photocam
23627     *
23628     * @param obj The photocam object
23629     * @return The current paused state
23630     *
23631     * This gets the current paused state for the photocam object.
23632     *
23633     * @see elm_photocam_paused_set()
23634     */
23635    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23636
23637    /**
23638     * @brief Get the internal low-res image used for photocam
23639     *
23640     * @param obj The photocam object
23641     * @return The internal image object handle, or NULL if none exists
23642     *
23643     * This gets the internal image object inside photocam. Do not modify it. It
23644     * is for inspection only, and hooking callbacks to. Nothing else. It may be
23645     * deleted at any time as well.
23646     */
23647    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23648
23649    /**
23650     * @brief Set the photocam scrolling bouncing.
23651     *
23652     * @param obj The photocam object
23653     * @param h_bounce bouncing for horizontal
23654     * @param v_bounce bouncing for vertical
23655     */
23656    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23657
23658    /**
23659     * @brief Get the photocam scrolling bouncing.
23660     *
23661     * @param obj The photocam object
23662     * @param h_bounce bouncing for horizontal
23663     * @param v_bounce bouncing for vertical
23664     *
23665     * @see elm_photocam_bounce_set()
23666     */
23667    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23668
23669    /**
23670     * @}
23671     */
23672
23673    /**
23674     * @defgroup Map Map
23675     * @ingroup Elementary
23676     *
23677     * @image html img/widget/map/preview-00.png
23678     * @image latex img/widget/map/preview-00.eps
23679     *
23680     * This is a widget specifically for displaying a map. It uses basically
23681     * OpenStreetMap provider http://www.openstreetmap.org/,
23682     * but custom providers can be added.
23683     *
23684     * It supports some basic but yet nice features:
23685     * @li zoom and scroll
23686     * @li markers with content to be displayed when user clicks over it
23687     * @li group of markers
23688     * @li routes
23689     *
23690     * Smart callbacks one can listen to:
23691     *
23692     * - "clicked" - This is called when a user has clicked the map without
23693     *   dragging around.
23694     * - "press" - This is called when a user has pressed down on the map.
23695     * - "longpressed" - This is called when a user has pressed down on the map
23696     *   for a long time without dragging around.
23697     * - "clicked,double" - This is called when a user has double-clicked
23698     *   the map.
23699     * - "load,detail" - Map detailed data load begins.
23700     * - "loaded,detail" - This is called when all currently visible parts of
23701     *   the map are loaded.
23702     * - "zoom,start" - Zoom animation started.
23703     * - "zoom,stop" - Zoom animation stopped.
23704     * - "zoom,change" - Zoom changed when using an auto zoom mode.
23705     * - "scroll" - the content has been scrolled (moved).
23706     * - "scroll,anim,start" - scrolling animation has started.
23707     * - "scroll,anim,stop" - scrolling animation has stopped.
23708     * - "scroll,drag,start" - dragging the contents around has started.
23709     * - "scroll,drag,stop" - dragging the contents around has stopped.
23710     * - "downloaded" - This is called when all currently required map images
23711     *   are downloaded.
23712     * - "route,load" - This is called when route request begins.
23713     * - "route,loaded" - This is called when route request ends.
23714     * - "name,load" - This is called when name request begins.
23715     * - "name,loaded- This is called when name request ends.
23716     *
23717     * Available style for map widget:
23718     * - @c "default"
23719     *
23720     * Available style for markers:
23721     * - @c "radio"
23722     * - @c "radio2"
23723     * - @c "empty"
23724     *
23725     * Available style for marker bubble:
23726     * - @c "default"
23727     *
23728     * List of examples:
23729     * @li @ref map_example_01
23730     * @li @ref map_example_02
23731     * @li @ref map_example_03
23732     */
23733
23734    /**
23735     * @addtogroup Map
23736     * @{
23737     */
23738
23739    /**
23740     * @enum _Elm_Map_Zoom_Mode
23741     * @typedef Elm_Map_Zoom_Mode
23742     *
23743     * Set map's zoom behavior. It can be set to manual or automatic.
23744     *
23745     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
23746     *
23747     * Values <b> don't </b> work as bitmask, only one can be choosen.
23748     *
23749     * @note Valid sizes are 2^zoom, consequently the map may be smaller
23750     * than the scroller view.
23751     *
23752     * @see elm_map_zoom_mode_set()
23753     * @see elm_map_zoom_mode_get()
23754     *
23755     * @ingroup Map
23756     */
23757    typedef enum _Elm_Map_Zoom_Mode
23758      {
23759         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
23760         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
23761         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
23762         ELM_MAP_ZOOM_MODE_LAST
23763      } Elm_Map_Zoom_Mode;
23764
23765    /**
23766     * @enum _Elm_Map_Route_Sources
23767     * @typedef Elm_Map_Route_Sources
23768     *
23769     * Set route service to be used. By default used source is
23770     * #ELM_MAP_ROUTE_SOURCE_YOURS.
23771     *
23772     * @see elm_map_route_source_set()
23773     * @see elm_map_route_source_get()
23774     *
23775     * @ingroup Map
23776     */
23777    typedef enum _Elm_Map_Route_Sources
23778      {
23779         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
23780         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. */
23781         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
23782         ELM_MAP_ROUTE_SOURCE_LAST
23783      } Elm_Map_Route_Sources;
23784
23785    typedef enum _Elm_Map_Name_Sources
23786      {
23787         ELM_MAP_NAME_SOURCE_NOMINATIM,
23788         ELM_MAP_NAME_SOURCE_LAST
23789      } Elm_Map_Name_Sources;
23790
23791    /**
23792     * @enum _Elm_Map_Route_Type
23793     * @typedef Elm_Map_Route_Type
23794     *
23795     * Set type of transport used on route.
23796     *
23797     * @see elm_map_route_add()
23798     *
23799     * @ingroup Map
23800     */
23801    typedef enum _Elm_Map_Route_Type
23802      {
23803         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
23804         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
23805         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
23806         ELM_MAP_ROUTE_TYPE_LAST
23807      } Elm_Map_Route_Type;
23808
23809    /**
23810     * @enum _Elm_Map_Route_Method
23811     * @typedef Elm_Map_Route_Method
23812     *
23813     * Set the routing method, what should be priorized, time or distance.
23814     *
23815     * @see elm_map_route_add()
23816     *
23817     * @ingroup Map
23818     */
23819    typedef enum _Elm_Map_Route_Method
23820      {
23821         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
23822         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
23823         ELM_MAP_ROUTE_METHOD_LAST
23824      } Elm_Map_Route_Method;
23825
23826    typedef enum _Elm_Map_Name_Method
23827      {
23828         ELM_MAP_NAME_METHOD_SEARCH,
23829         ELM_MAP_NAME_METHOD_REVERSE,
23830         ELM_MAP_NAME_METHOD_LAST
23831      } Elm_Map_Name_Method;
23832
23833    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(). */
23834    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(). */
23835    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(). */
23836    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(). */
23837    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
23838    typedef struct _Elm_Map_Track           Elm_Map_Track;
23839
23840    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. */
23841    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
23842    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
23843    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
23844
23845    typedef char        *(*ElmMapModuleSourceFunc) (void);
23846    typedef int          (*ElmMapModuleZoomMinFunc) (void);
23847    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
23848    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
23849    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
23850    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
23851    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
23852    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
23853    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
23854
23855    /**
23856     * Add a new map widget to the given parent Elementary (container) object.
23857     *
23858     * @param parent The parent object.
23859     * @return a new map widget handle or @c NULL, on errors.
23860     *
23861     * This function inserts a new map widget on the canvas.
23862     *
23863     * @ingroup Map
23864     */
23865    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23866
23867    /**
23868     * Set the zoom level of the map.
23869     *
23870     * @param obj The map object.
23871     * @param zoom The zoom level to set.
23872     *
23873     * This sets the zoom level.
23874     *
23875     * It will respect limits defined by elm_map_source_zoom_min_set() and
23876     * elm_map_source_zoom_max_set().
23877     *
23878     * By default these values are 0 (world map) and 18 (maximum zoom).
23879     *
23880     * This function should be used when zoom mode is set to
23881     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
23882     * with elm_map_zoom_mode_set().
23883     *
23884     * @see elm_map_zoom_mode_set().
23885     * @see elm_map_zoom_get().
23886     *
23887     * @ingroup Map
23888     */
23889    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23890
23891    /**
23892     * Get the zoom level of the map.
23893     *
23894     * @param obj The map object.
23895     * @return The current zoom level.
23896     *
23897     * This returns the current zoom level of the map object.
23898     *
23899     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
23900     * (which is the default), the zoom level may be changed at any time by the
23901     * map object itself to account for map size and map viewport size.
23902     *
23903     * @see elm_map_zoom_set() for details.
23904     *
23905     * @ingroup Map
23906     */
23907    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23908
23909    /**
23910     * Set the zoom mode used by the map object.
23911     *
23912     * @param obj The map object.
23913     * @param mode The zoom mode of the map, being it one of
23914     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23915     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23916     *
23917     * This sets the zoom mode to manual or one of the automatic levels.
23918     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
23919     * elm_map_zoom_set() and will stay at that level until changed by code
23920     * or until zoom mode is changed. This is the default mode.
23921     *
23922     * The Automatic modes will allow the map object to automatically
23923     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
23924     * adjust zoom so the map fits inside the scroll frame with no pixels
23925     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
23926     * ensure no pixels within the frame are left unfilled. Do not forget that
23927     * the valid sizes are 2^zoom, consequently the map may be smaller than
23928     * the scroller view.
23929     *
23930     * @see elm_map_zoom_set()
23931     *
23932     * @ingroup Map
23933     */
23934    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23935
23936    /**
23937     * Get the zoom mode used by the map object.
23938     *
23939     * @param obj The map object.
23940     * @return The zoom mode of the map, being it one of
23941     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23942     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23943     *
23944     * This function returns the current zoom mode used by the map object.
23945     *
23946     * @see elm_map_zoom_mode_set() for more details.
23947     *
23948     * @ingroup Map
23949     */
23950    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23951
23952    /**
23953     * Get the current coordinates of the map.
23954     *
23955     * @param obj The map object.
23956     * @param lon Pointer where to store longitude.
23957     * @param lat Pointer where to store latitude.
23958     *
23959     * This gets the current center coordinates of the map object. It can be
23960     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
23961     *
23962     * @see elm_map_geo_region_bring_in()
23963     * @see elm_map_geo_region_show()
23964     *
23965     * @ingroup Map
23966     */
23967    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
23968
23969    /**
23970     * Animatedly bring in given coordinates to the center of the map.
23971     *
23972     * @param obj The map object.
23973     * @param lon Longitude to center at.
23974     * @param lat Latitude to center at.
23975     *
23976     * This causes map to jump to the given @p lat and @p lon coordinates
23977     * and show it (by scrolling) in the center of the viewport, if it is not
23978     * already centered. This will use animation to do so and take a period
23979     * of time to complete.
23980     *
23981     * @see elm_map_geo_region_show() for a function to avoid animation.
23982     * @see elm_map_geo_region_get()
23983     *
23984     * @ingroup Map
23985     */
23986    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23987
23988    /**
23989     * Show the given coordinates at the center of the map, @b immediately.
23990     *
23991     * @param obj The map object.
23992     * @param lon Longitude to center at.
23993     * @param lat Latitude to center at.
23994     *
23995     * This causes map to @b redraw its viewport's contents to the
23996     * region contining the given @p lat and @p lon, that will be moved to the
23997     * center of the map.
23998     *
23999     * @see elm_map_geo_region_bring_in() for a function to move with animation.
24000     * @see elm_map_geo_region_get()
24001     *
24002     * @ingroup Map
24003     */
24004    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24005
24006    /**
24007     * Pause or unpause the map.
24008     *
24009     * @param obj The map object.
24010     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
24011     * to unpause it.
24012     *
24013     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24014     * for map.
24015     *
24016     * The default is off.
24017     *
24018     * This will stop zooming using animation, changing zoom levels will
24019     * change instantly. This will stop any existing animations that are running.
24020     *
24021     * @see elm_map_paused_get()
24022     *
24023     * @ingroup Map
24024     */
24025    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24026
24027    /**
24028     * Get a value whether map is paused or not.
24029     *
24030     * @param obj The map object.
24031     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
24032     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24033     *
24034     * This gets the current paused state for the map object.
24035     *
24036     * @see elm_map_paused_set() for details.
24037     *
24038     * @ingroup Map
24039     */
24040    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24041
24042    /**
24043     * Set to show markers during zoom level changes or not.
24044     *
24045     * @param obj The map object.
24046     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
24047     * to show them.
24048     *
24049     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24050     * for map.
24051     *
24052     * The default is off.
24053     *
24054     * This will stop zooming using animation, changing zoom levels will
24055     * change instantly. This will stop any existing animations that are running.
24056     *
24057     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24058     * for the markers.
24059     *
24060     * The default  is off.
24061     *
24062     * Enabling it will force the map to stop displaying the markers during
24063     * zoom level changes. Set to on if you have a large number of markers.
24064     *
24065     * @see elm_map_paused_markers_get()
24066     *
24067     * @ingroup Map
24068     */
24069    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24070
24071    /**
24072     * Get a value whether markers will be displayed on zoom level changes or not
24073     *
24074     * @param obj The map object.
24075     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
24076     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
24077     *
24078     * This gets the current markers paused state for the map object.
24079     *
24080     * @see elm_map_paused_markers_set() for details.
24081     *
24082     * @ingroup Map
24083     */
24084    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24085
24086    /**
24087     * Get the information of downloading status.
24088     *
24089     * @param obj The map object.
24090     * @param try_num Pointer where to store number of tiles being downloaded.
24091     * @param finish_num Pointer where to store number of tiles successfully
24092     * downloaded.
24093     *
24094     * This gets the current downloading status for the map object, the number
24095     * of tiles being downloaded and the number of tiles already downloaded.
24096     *
24097     * @ingroup Map
24098     */
24099    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
24100
24101    /**
24102     * Convert a pixel coordinate (x,y) into a geographic coordinate
24103     * (longitude, latitude).
24104     *
24105     * @param obj The map object.
24106     * @param x the coordinate.
24107     * @param y the coordinate.
24108     * @param size the size in pixels of the map.
24109     * The map is a square and generally his size is : pow(2.0, zoom)*256.
24110     * @param lon Pointer where to store the longitude that correspond to x.
24111     * @param lat Pointer where to store the latitude that correspond to y.
24112     *
24113     * @note Origin pixel point is the top left corner of the viewport.
24114     * Map zoom and size are taken on account.
24115     *
24116     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
24117     *
24118     * @ingroup Map
24119     */
24120    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);
24121
24122    /**
24123     * Convert a geographic coordinate (longitude, latitude) into a pixel
24124     * coordinate (x, y).
24125     *
24126     * @param obj The map object.
24127     * @param lon the longitude.
24128     * @param lat the latitude.
24129     * @param size the size in pixels of the map. The map is a square
24130     * and generally his size is : pow(2.0, zoom)*256.
24131     * @param x Pointer where to store the horizontal pixel coordinate that
24132     * correspond to the longitude.
24133     * @param y Pointer where to store the vertical pixel coordinate that
24134     * correspond to the latitude.
24135     *
24136     * @note Origin pixel point is the top left corner of the viewport.
24137     * Map zoom and size are taken on account.
24138     *
24139     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
24140     *
24141     * @ingroup Map
24142     */
24143    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);
24144
24145    /**
24146     * Convert a geographic coordinate (longitude, latitude) into a name
24147     * (address).
24148     *
24149     * @param obj The map object.
24150     * @param lon the longitude.
24151     * @param lat the latitude.
24152     * @return name A #Elm_Map_Name handle for this coordinate.
24153     *
24154     * To get the string for this address, elm_map_name_address_get()
24155     * should be used.
24156     *
24157     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
24158     *
24159     * @ingroup Map
24160     */
24161    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24162
24163    /**
24164     * Convert a name (address) into a geographic coordinate
24165     * (longitude, latitude).
24166     *
24167     * @param obj The map object.
24168     * @param name The address.
24169     * @return name A #Elm_Map_Name handle for this address.
24170     *
24171     * To get the longitude and latitude, elm_map_name_region_get()
24172     * should be used.
24173     *
24174     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
24175     *
24176     * @ingroup Map
24177     */
24178    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
24179
24180    /**
24181     * Convert a pixel coordinate into a rotated pixel coordinate.
24182     *
24183     * @param obj The map object.
24184     * @param x horizontal coordinate of the point to rotate.
24185     * @param y vertical coordinate of the point to rotate.
24186     * @param cx rotation's center horizontal position.
24187     * @param cy rotation's center vertical position.
24188     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
24189     * @param xx Pointer where to store rotated x.
24190     * @param yy Pointer where to store rotated y.
24191     *
24192     * @ingroup Map
24193     */
24194    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);
24195
24196    /**
24197     * Add a new marker to the map object.
24198     *
24199     * @param obj The map object.
24200     * @param lon The longitude of the marker.
24201     * @param lat The latitude of the marker.
24202     * @param clas The class, to use when marker @b isn't grouped to others.
24203     * @param clas_group The class group, to use when marker is grouped to others
24204     * @param data The data passed to the callbacks.
24205     *
24206     * @return The created marker or @c NULL upon failure.
24207     *
24208     * A marker will be created and shown in a specific point of the map, defined
24209     * by @p lon and @p lat.
24210     *
24211     * It will be displayed using style defined by @p class when this marker
24212     * is displayed alone (not grouped). A new class can be created with
24213     * elm_map_marker_class_new().
24214     *
24215     * If the marker is grouped to other markers, it will be displayed with
24216     * style defined by @p class_group. Markers with the same group are grouped
24217     * if they are close. A new group class can be created with
24218     * elm_map_marker_group_class_new().
24219     *
24220     * Markers created with this method can be deleted with
24221     * elm_map_marker_remove().
24222     *
24223     * A marker can have associated content to be displayed by a bubble,
24224     * when a user click over it, as well as an icon. These objects will
24225     * be fetch using class' callback functions.
24226     *
24227     * @see elm_map_marker_class_new()
24228     * @see elm_map_marker_group_class_new()
24229     * @see elm_map_marker_remove()
24230     *
24231     * @ingroup Map
24232     */
24233    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);
24234
24235    /**
24236     * Set the maximum numbers of markers' content to be displayed in a group.
24237     *
24238     * @param obj The map object.
24239     * @param max The maximum numbers of items displayed in a bubble.
24240     *
24241     * A bubble will be displayed when the user clicks over the group,
24242     * and will place the content of markers that belong to this group
24243     * inside it.
24244     *
24245     * A group can have a long list of markers, consequently the creation
24246     * of the content of the bubble can be very slow.
24247     *
24248     * In order to avoid this, a maximum number of items is displayed
24249     * in a bubble.
24250     *
24251     * By default this number is 30.
24252     *
24253     * Marker with the same group class are grouped if they are close.
24254     *
24255     * @see elm_map_marker_add()
24256     *
24257     * @ingroup Map
24258     */
24259    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
24260
24261    /**
24262     * Remove a marker from the map.
24263     *
24264     * @param marker The marker to remove.
24265     *
24266     * @see elm_map_marker_add()
24267     *
24268     * @ingroup Map
24269     */
24270    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24271
24272    /**
24273     * Get the current coordinates of the marker.
24274     *
24275     * @param marker marker.
24276     * @param lat Pointer where to store the marker's latitude.
24277     * @param lon Pointer where to store the marker's longitude.
24278     *
24279     * These values are set when adding markers, with function
24280     * elm_map_marker_add().
24281     *
24282     * @see elm_map_marker_add()
24283     *
24284     * @ingroup Map
24285     */
24286    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
24287
24288    /**
24289     * Animatedly bring in given marker to the center of the map.
24290     *
24291     * @param marker The marker to center at.
24292     *
24293     * This causes map to jump to the given @p marker's coordinates
24294     * and show it (by scrolling) in the center of the viewport, if it is not
24295     * already centered. This will use animation to do so and take a period
24296     * of time to complete.
24297     *
24298     * @see elm_map_marker_show() for a function to avoid animation.
24299     * @see elm_map_marker_region_get()
24300     *
24301     * @ingroup Map
24302     */
24303    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24304
24305    /**
24306     * Show the given marker at the center of the map, @b immediately.
24307     *
24308     * @param marker The marker to center at.
24309     *
24310     * This causes map to @b redraw its viewport's contents to the
24311     * region contining the given @p marker's coordinates, that will be
24312     * moved to the center of the map.
24313     *
24314     * @see elm_map_marker_bring_in() for a function to move with animation.
24315     * @see elm_map_markers_list_show() if more than one marker need to be
24316     * displayed.
24317     * @see elm_map_marker_region_get()
24318     *
24319     * @ingroup Map
24320     */
24321    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24322
24323    /**
24324     * Move and zoom the map to display a list of markers.
24325     *
24326     * @param markers A list of #Elm_Map_Marker handles.
24327     *
24328     * The map will be centered on the center point of the markers in the list.
24329     * Then the map will be zoomed in order to fit the markers using the maximum
24330     * zoom which allows display of all the markers.
24331     *
24332     * @warning All the markers should belong to the same map object.
24333     *
24334     * @see elm_map_marker_show() to show a single marker.
24335     * @see elm_map_marker_bring_in()
24336     *
24337     * @ingroup Map
24338     */
24339    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
24340
24341    /**
24342     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
24343     *
24344     * @param marker The marker wich content should be returned.
24345     * @return Return the evas object if it exists, else @c NULL.
24346     *
24347     * To set callback function #ElmMapMarkerGetFunc for the marker class,
24348     * elm_map_marker_class_get_cb_set() should be used.
24349     *
24350     * This content is what will be inside the bubble that will be displayed
24351     * when an user clicks over the marker.
24352     *
24353     * This returns the actual Evas object used to be placed inside
24354     * the bubble. This may be @c NULL, as it may
24355     * not have been created or may have been deleted, at any time, by
24356     * the map. <b>Do not modify this object</b> (move, resize,
24357     * show, hide, etc.), as the map is controlling it. This
24358     * function is for querying, emitting custom signals or hooking
24359     * lower level callbacks for events on that object. Do not delete
24360     * this object under any circumstances.
24361     *
24362     * @ingroup Map
24363     */
24364    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24365
24366    /**
24367     * Update the marker
24368     *
24369     * @param marker The marker to be updated.
24370     *
24371     * If a content is set to this marker, it will call function to delete it,
24372     * #ElmMapMarkerDelFunc, and then will fetch the content again with
24373     * #ElmMapMarkerGetFunc.
24374     *
24375     * These functions are set for the marker class with
24376     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
24377     *
24378     * @ingroup Map
24379     */
24380    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24381
24382    /**
24383     * Close all the bubbles opened by the user.
24384     *
24385     * @param obj The map object.
24386     *
24387     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
24388     * when the user clicks on a marker.
24389     *
24390     * This functions is set for the marker class with
24391     * elm_map_marker_class_get_cb_set().
24392     *
24393     * @ingroup Map
24394     */
24395    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
24396
24397    /**
24398     * Create a new group class.
24399     *
24400     * @param obj The map object.
24401     * @return Returns the new group class.
24402     *
24403     * Each marker must be associated to a group class. Markers in the same
24404     * group are grouped if they are close.
24405     *
24406     * The group class defines the style of the marker when a marker is grouped
24407     * to others markers. When it is alone, another class will be used.
24408     *
24409     * A group class will need to be provided when creating a marker with
24410     * elm_map_marker_add().
24411     *
24412     * Some properties and functions can be set by class, as:
24413     * - style, with elm_map_group_class_style_set()
24414     * - data - to be associated to the group class. It can be set using
24415     *   elm_map_group_class_data_set().
24416     * - min zoom to display markers, set with
24417     *   elm_map_group_class_zoom_displayed_set().
24418     * - max zoom to group markers, set using
24419     *   elm_map_group_class_zoom_grouped_set().
24420     * - visibility - set if markers will be visible or not, set with
24421     *   elm_map_group_class_hide_set().
24422     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
24423     *   It can be set using elm_map_group_class_icon_cb_set().
24424     *
24425     * @see elm_map_marker_add()
24426     * @see elm_map_group_class_style_set()
24427     * @see elm_map_group_class_data_set()
24428     * @see elm_map_group_class_zoom_displayed_set()
24429     * @see elm_map_group_class_zoom_grouped_set()
24430     * @see elm_map_group_class_hide_set()
24431     * @see elm_map_group_class_icon_cb_set()
24432     *
24433     * @ingroup Map
24434     */
24435    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24436
24437    /**
24438     * Set the marker's style of a group class.
24439     *
24440     * @param clas The group class.
24441     * @param style The style to be used by markers.
24442     *
24443     * Each marker must be associated to a group class, and will use the style
24444     * defined by such class when grouped to other markers.
24445     *
24446     * The following styles are provided by default theme:
24447     * @li @c radio - blue circle
24448     * @li @c radio2 - green circle
24449     * @li @c empty
24450     *
24451     * @see elm_map_group_class_new() for more details.
24452     * @see elm_map_marker_add()
24453     *
24454     * @ingroup Map
24455     */
24456    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24457
24458    /**
24459     * Set the icon callback function of a group class.
24460     *
24461     * @param clas The group class.
24462     * @param icon_get The callback function that will return the icon.
24463     *
24464     * Each marker must be associated to a group class, and it can display a
24465     * custom icon. The function @p icon_get must return this icon.
24466     *
24467     * @see elm_map_group_class_new() for more details.
24468     * @see elm_map_marker_add()
24469     *
24470     * @ingroup Map
24471     */
24472    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24473
24474    /**
24475     * Set the data associated to the group class.
24476     *
24477     * @param clas The group class.
24478     * @param data The new user data.
24479     *
24480     * This data will be passed for callback functions, like icon get callback,
24481     * that can be set with elm_map_group_class_icon_cb_set().
24482     *
24483     * If a data was previously set, the object will lose the pointer for it,
24484     * so if needs to be freed, you must do it yourself.
24485     *
24486     * @see elm_map_group_class_new() for more details.
24487     * @see elm_map_group_class_icon_cb_set()
24488     * @see elm_map_marker_add()
24489     *
24490     * @ingroup Map
24491     */
24492    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
24493
24494    /**
24495     * Set the minimum zoom from where the markers are displayed.
24496     *
24497     * @param clas The group class.
24498     * @param zoom The minimum zoom.
24499     *
24500     * Markers only will be displayed when the map is displayed at @p zoom
24501     * or bigger.
24502     *
24503     * @see elm_map_group_class_new() for more details.
24504     * @see elm_map_marker_add()
24505     *
24506     * @ingroup Map
24507     */
24508    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24509
24510    /**
24511     * Set the zoom from where the markers are no more grouped.
24512     *
24513     * @param clas The group class.
24514     * @param zoom The maximum zoom.
24515     *
24516     * Markers only will be grouped when the map is displayed at
24517     * less than @p zoom.
24518     *
24519     * @see elm_map_group_class_new() for more details.
24520     * @see elm_map_marker_add()
24521     *
24522     * @ingroup Map
24523     */
24524    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24525
24526    /**
24527     * Set if the markers associated to the group class @clas are hidden or not.
24528     *
24529     * @param clas The group class.
24530     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
24531     * to show them.
24532     *
24533     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
24534     * is to show them.
24535     *
24536     * @ingroup Map
24537     */
24538    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
24539
24540    /**
24541     * Create a new marker class.
24542     *
24543     * @param obj The map object.
24544     * @return Returns the new group class.
24545     *
24546     * Each marker must be associated to a class.
24547     *
24548     * The marker class defines the style of the marker when a marker is
24549     * displayed alone, i.e., not grouped to to others markers. When grouped
24550     * it will use group class style.
24551     *
24552     * A marker class will need to be provided when creating a marker with
24553     * elm_map_marker_add().
24554     *
24555     * Some properties and functions can be set by class, as:
24556     * - style, with elm_map_marker_class_style_set()
24557     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
24558     *   It can be set using elm_map_marker_class_icon_cb_set().
24559     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
24560     *   Set using elm_map_marker_class_get_cb_set().
24561     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
24562     *   Set using elm_map_marker_class_del_cb_set().
24563     *
24564     * @see elm_map_marker_add()
24565     * @see elm_map_marker_class_style_set()
24566     * @see elm_map_marker_class_icon_cb_set()
24567     * @see elm_map_marker_class_get_cb_set()
24568     * @see elm_map_marker_class_del_cb_set()
24569     *
24570     * @ingroup Map
24571     */
24572    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24573
24574    /**
24575     * Set the marker's style of a marker class.
24576     *
24577     * @param clas The marker class.
24578     * @param style The style to be used by markers.
24579     *
24580     * Each marker must be associated to a marker class, and will use the style
24581     * defined by such class when alone, i.e., @b not grouped to other markers.
24582     *
24583     * The following styles are provided by default theme:
24584     * @li @c radio
24585     * @li @c radio2
24586     * @li @c empty
24587     *
24588     * @see elm_map_marker_class_new() for more details.
24589     * @see elm_map_marker_add()
24590     *
24591     * @ingroup Map
24592     */
24593    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24594
24595    /**
24596     * Set the icon callback function of a marker class.
24597     *
24598     * @param clas The marker class.
24599     * @param icon_get The callback function that will return the icon.
24600     *
24601     * Each marker must be associated to a marker class, and it can display a
24602     * custom icon. The function @p icon_get must return this icon.
24603     *
24604     * @see elm_map_marker_class_new() for more details.
24605     * @see elm_map_marker_add()
24606     *
24607     * @ingroup Map
24608     */
24609    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24610
24611    /**
24612     * Set the bubble content callback function of a marker class.
24613     *
24614     * @param clas The marker class.
24615     * @param get The callback function that will return the content.
24616     *
24617     * Each marker must be associated to a marker class, and it can display a
24618     * a content on a bubble that opens when the user click over the marker.
24619     * The function @p get must return this content object.
24620     *
24621     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
24622     * can be used.
24623     *
24624     * @see elm_map_marker_class_new() for more details.
24625     * @see elm_map_marker_class_del_cb_set()
24626     * @see elm_map_marker_add()
24627     *
24628     * @ingroup Map
24629     */
24630    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
24631
24632    /**
24633     * Set the callback function used to delete bubble content of a marker class.
24634     *
24635     * @param clas The marker class.
24636     * @param del The callback function that will delete the content.
24637     *
24638     * Each marker must be associated to a marker class, and it can display a
24639     * a content on a bubble that opens when the user click over the marker.
24640     * The function to return such content can be set with
24641     * elm_map_marker_class_get_cb_set().
24642     *
24643     * If this content must be freed, a callback function need to be
24644     * set for that task with this function.
24645     *
24646     * If this callback is defined it will have to delete (or not) the
24647     * object inside, but if the callback is not defined the object will be
24648     * destroyed with evas_object_del().
24649     *
24650     * @see elm_map_marker_class_new() for more details.
24651     * @see elm_map_marker_class_get_cb_set()
24652     * @see elm_map_marker_add()
24653     *
24654     * @ingroup Map
24655     */
24656    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
24657
24658    /**
24659     * Get the list of available sources.
24660     *
24661     * @param obj The map object.
24662     * @return The source names list.
24663     *
24664     * It will provide a list with all available sources, that can be set as
24665     * current source with elm_map_source_name_set(), or get with
24666     * elm_map_source_name_get().
24667     *
24668     * Available sources:
24669     * @li "Mapnik"
24670     * @li "Osmarender"
24671     * @li "CycleMap"
24672     * @li "Maplint"
24673     *
24674     * @see elm_map_source_name_set() for more details.
24675     * @see elm_map_source_name_get()
24676     *
24677     * @ingroup Map
24678     */
24679    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24680
24681    /**
24682     * Set the source of the map.
24683     *
24684     * @param obj The map object.
24685     * @param source The source to be used.
24686     *
24687     * Map widget retrieves images that composes the map from a web service.
24688     * This web service can be set with this method.
24689     *
24690     * A different service can return a different maps with different
24691     * information and it can use different zoom values.
24692     *
24693     * The @p source_name need to match one of the names provided by
24694     * elm_map_source_names_get().
24695     *
24696     * The current source can be get using elm_map_source_name_get().
24697     *
24698     * @see elm_map_source_names_get()
24699     * @see elm_map_source_name_get()
24700     *
24701     *
24702     * @ingroup Map
24703     */
24704    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
24705
24706    /**
24707     * Get the name of currently used source.
24708     *
24709     * @param obj The map object.
24710     * @return Returns the name of the source in use.
24711     *
24712     * @see elm_map_source_name_set() for more details.
24713     *
24714     * @ingroup Map
24715     */
24716    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24717
24718    /**
24719     * Set the source of the route service to be used by the map.
24720     *
24721     * @param obj The map object.
24722     * @param source The route service to be used, being it one of
24723     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
24724     * and #ELM_MAP_ROUTE_SOURCE_ORS.
24725     *
24726     * Each one has its own algorithm, so the route retrieved may
24727     * differ depending on the source route. Now, only the default is working.
24728     *
24729     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
24730     * http://www.yournavigation.org/.
24731     *
24732     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
24733     * assumptions. Its routing core is based on Contraction Hierarchies.
24734     *
24735     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
24736     *
24737     * @see elm_map_route_source_get().
24738     *
24739     * @ingroup Map
24740     */
24741    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
24742
24743    /**
24744     * Get the current route source.
24745     *
24746     * @param obj The map object.
24747     * @return The source of the route service used by the map.
24748     *
24749     * @see elm_map_route_source_set() for details.
24750     *
24751     * @ingroup Map
24752     */
24753    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24754
24755    /**
24756     * Set the minimum zoom of the source.
24757     *
24758     * @param obj The map object.
24759     * @param zoom New minimum zoom value to be used.
24760     *
24761     * By default, it's 0.
24762     *
24763     * @ingroup Map
24764     */
24765    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24766
24767    /**
24768     * Get the minimum zoom of the source.
24769     *
24770     * @param obj The map object.
24771     * @return Returns the minimum zoom of the source.
24772     *
24773     * @see elm_map_source_zoom_min_set() for details.
24774     *
24775     * @ingroup Map
24776     */
24777    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24778
24779    /**
24780     * Set the maximum zoom of the source.
24781     *
24782     * @param obj The map object.
24783     * @param zoom New maximum zoom value to be used.
24784     *
24785     * By default, it's 18.
24786     *
24787     * @ingroup Map
24788     */
24789    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24790
24791    /**
24792     * Get the maximum zoom of the source.
24793     *
24794     * @param obj The map object.
24795     * @return Returns the maximum zoom of the source.
24796     *
24797     * @see elm_map_source_zoom_min_set() for details.
24798     *
24799     * @ingroup Map
24800     */
24801    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24802
24803    /**
24804     * Set the user agent used by the map object to access routing services.
24805     *
24806     * @param obj The map object.
24807     * @param user_agent The user agent to be used by the map.
24808     *
24809     * User agent is a client application implementing a network protocol used
24810     * in communications within a clientā€“server distributed computing system
24811     *
24812     * The @p user_agent identification string will transmitted in a header
24813     * field @c User-Agent.
24814     *
24815     * @see elm_map_user_agent_get()
24816     *
24817     * @ingroup Map
24818     */
24819    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
24820
24821    /**
24822     * Get the user agent used by the map object.
24823     *
24824     * @param obj The map object.
24825     * @return The user agent identification string used by the map.
24826     *
24827     * @see elm_map_user_agent_set() for details.
24828     *
24829     * @ingroup Map
24830     */
24831    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24832
24833    /**
24834     * Add a new route to the map object.
24835     *
24836     * @param obj The map object.
24837     * @param type The type of transport to be considered when tracing a route.
24838     * @param method The routing method, what should be priorized.
24839     * @param flon The start longitude.
24840     * @param flat The start latitude.
24841     * @param tlon The destination longitude.
24842     * @param tlat The destination latitude.
24843     *
24844     * @return The created route or @c NULL upon failure.
24845     *
24846     * A route will be traced by point on coordinates (@p flat, @p flon)
24847     * to point on coordinates (@p tlat, @p tlon), using the route service
24848     * set with elm_map_route_source_set().
24849     *
24850     * It will take @p type on consideration to define the route,
24851     * depending if the user will be walking or driving, the route may vary.
24852     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
24853     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
24854     *
24855     * Another parameter is what the route should priorize, the minor distance
24856     * or the less time to be spend on the route. So @p method should be one
24857     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
24858     *
24859     * Routes created with this method can be deleted with
24860     * elm_map_route_remove(), colored with elm_map_route_color_set(),
24861     * and distance can be get with elm_map_route_distance_get().
24862     *
24863     * @see elm_map_route_remove()
24864     * @see elm_map_route_color_set()
24865     * @see elm_map_route_distance_get()
24866     * @see elm_map_route_source_set()
24867     *
24868     * @ingroup Map
24869     */
24870    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);
24871
24872    /**
24873     * Remove a route from the map.
24874     *
24875     * @param route The route to remove.
24876     *
24877     * @see elm_map_route_add()
24878     *
24879     * @ingroup Map
24880     */
24881    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24882
24883    /**
24884     * Set the route color.
24885     *
24886     * @param route The route object.
24887     * @param r Red channel value, from 0 to 255.
24888     * @param g Green channel value, from 0 to 255.
24889     * @param b Blue channel value, from 0 to 255.
24890     * @param a Alpha channel value, from 0 to 255.
24891     *
24892     * It uses an additive color model, so each color channel represents
24893     * how much of each primary colors must to be used. 0 represents
24894     * ausence of this color, so if all of the three are set to 0,
24895     * the color will be black.
24896     *
24897     * These component values should be integers in the range 0 to 255,
24898     * (single 8-bit byte).
24899     *
24900     * This sets the color used for the route. By default, it is set to
24901     * solid red (r = 255, g = 0, b = 0, a = 255).
24902     *
24903     * For alpha channel, 0 represents completely transparent, and 255, opaque.
24904     *
24905     * @see elm_map_route_color_get()
24906     *
24907     * @ingroup Map
24908     */
24909    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24910
24911    /**
24912     * Get the route color.
24913     *
24914     * @param route The route object.
24915     * @param r Pointer where to store the red channel value.
24916     * @param g Pointer where to store the green channel value.
24917     * @param b Pointer where to store the blue channel value.
24918     * @param a Pointer where to store the alpha channel value.
24919     *
24920     * @see elm_map_route_color_set() for details.
24921     *
24922     * @ingroup Map
24923     */
24924    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24925
24926    /**
24927     * Get the route distance in kilometers.
24928     *
24929     * @param route The route object.
24930     * @return The distance of route (unit : km).
24931     *
24932     * @ingroup Map
24933     */
24934    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24935
24936    /**
24937     * Get the information of route nodes.
24938     *
24939     * @param route The route object.
24940     * @return Returns a string with the nodes of route.
24941     *
24942     * @ingroup Map
24943     */
24944    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24945
24946    /**
24947     * Get the information of route waypoint.
24948     *
24949     * @param route the route object.
24950     * @return Returns a string with information about waypoint of route.
24951     *
24952     * @ingroup Map
24953     */
24954    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24955
24956    /**
24957     * Get the address of the name.
24958     *
24959     * @param name The name handle.
24960     * @return Returns the address string of @p name.
24961     *
24962     * This gets the coordinates of the @p name, created with one of the
24963     * conversion functions.
24964     *
24965     * @see elm_map_utils_convert_name_into_coord()
24966     * @see elm_map_utils_convert_coord_into_name()
24967     *
24968     * @ingroup Map
24969     */
24970    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24971
24972    /**
24973     * Get the current coordinates of the name.
24974     *
24975     * @param name The name handle.
24976     * @param lat Pointer where to store the latitude.
24977     * @param lon Pointer where to store The longitude.
24978     *
24979     * This gets the coordinates of the @p name, created with one of the
24980     * conversion functions.
24981     *
24982     * @see elm_map_utils_convert_name_into_coord()
24983     * @see elm_map_utils_convert_coord_into_name()
24984     *
24985     * @ingroup Map
24986     */
24987    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
24988
24989    /**
24990     * Remove a name from the map.
24991     *
24992     * @param name The name to remove.
24993     *
24994     * Basically the struct handled by @p name will be freed, so convertions
24995     * between address and coordinates will be lost.
24996     *
24997     * @see elm_map_utils_convert_name_into_coord()
24998     * @see elm_map_utils_convert_coord_into_name()
24999     *
25000     * @ingroup Map
25001     */
25002    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
25003
25004    /**
25005     * Rotate the map.
25006     *
25007     * @param obj The map object.
25008     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
25009     * @param cx Rotation's center horizontal position.
25010     * @param cy Rotation's center vertical position.
25011     *
25012     * @see elm_map_rotate_get()
25013     *
25014     * @ingroup Map
25015     */
25016    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
25017
25018    /**
25019     * Get the rotate degree of the map
25020     *
25021     * @param obj The map object
25022     * @param degree Pointer where to store degrees from 0.0 to 360.0
25023     * to rotate arount Z axis.
25024     * @param cx Pointer where to store rotation's center horizontal position.
25025     * @param cy Pointer where to store rotation's center vertical position.
25026     *
25027     * @see elm_map_rotate_set() to set map rotation.
25028     *
25029     * @ingroup Map
25030     */
25031    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);
25032
25033    /**
25034     * Enable or disable mouse wheel to be used to zoom in / out the map.
25035     *
25036     * @param obj The map object.
25037     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
25038     * to enable it.
25039     *
25040     * Mouse wheel can be used for the user to zoom in or zoom out the map.
25041     *
25042     * It's disabled by default.
25043     *
25044     * @see elm_map_wheel_disabled_get()
25045     *
25046     * @ingroup Map
25047     */
25048    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25049
25050    /**
25051     * Get a value whether mouse wheel is enabled or not.
25052     *
25053     * @param obj The map object.
25054     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
25055     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25056     *
25057     * Mouse wheel can be used for the user to zoom in or zoom out the map.
25058     *
25059     * @see elm_map_wheel_disabled_set() for details.
25060     *
25061     * @ingroup Map
25062     */
25063    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25064
25065 #ifdef ELM_EMAP
25066    /**
25067     * Add a track on the map
25068     *
25069     * @param obj The map object.
25070     * @param emap The emap route object.
25071     * @return The route object. This is an elm object of type Route.
25072     *
25073     * @see elm_route_add() for details.
25074     *
25075     * @ingroup Map
25076     */
25077    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
25078 #endif
25079
25080    /**
25081     * Remove a track from the map
25082     *
25083     * @param obj The map object.
25084     * @param route The track to remove.
25085     *
25086     * @ingroup Map
25087     */
25088    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
25089
25090    /**
25091     * @}
25092     */
25093
25094    /* Route */
25095    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
25096 #ifdef ELM_EMAP
25097    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
25098 #endif
25099    EAPI double elm_route_lon_min_get(Evas_Object *obj);
25100    EAPI double elm_route_lat_min_get(Evas_Object *obj);
25101    EAPI double elm_route_lon_max_get(Evas_Object *obj);
25102    EAPI double elm_route_lat_max_get(Evas_Object *obj);
25103
25104
25105    /**
25106     * @defgroup Panel Panel
25107     *
25108     * @image html img/widget/panel/preview-00.png
25109     * @image latex img/widget/panel/preview-00.eps
25110     *
25111     * @brief A panel is a type of animated container that contains subobjects.
25112     * It can be expanded or contracted by clicking the button on it's edge.
25113     *
25114     * Orientations are as follows:
25115     * @li ELM_PANEL_ORIENT_TOP
25116     * @li ELM_PANEL_ORIENT_LEFT
25117     * @li ELM_PANEL_ORIENT_RIGHT
25118     *
25119     * Default contents parts of the panel widget that you can use for are:
25120     * @li "default" - A content of the panel
25121     *
25122     * @ref tutorial_panel shows one way to use this widget.
25123     * @{
25124     */
25125    typedef enum _Elm_Panel_Orient
25126      {
25127         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
25128         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
25129         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
25130         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
25131      } Elm_Panel_Orient;
25132
25133    /**
25134     * @brief Adds a panel object
25135     *
25136     * @param parent The parent object
25137     *
25138     * @return The panel object, or NULL on failure
25139     */
25140    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25141
25142    /**
25143     * @brief Sets the orientation of the panel
25144     *
25145     * @param parent The parent object
25146     * @param orient The panel orientation. Can be one of the following:
25147     * @li ELM_PANEL_ORIENT_TOP
25148     * @li ELM_PANEL_ORIENT_LEFT
25149     * @li ELM_PANEL_ORIENT_RIGHT
25150     *
25151     * Sets from where the panel will (dis)appear.
25152     */
25153    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
25154
25155    /**
25156     * @brief Get the orientation of the panel.
25157     *
25158     * @param obj The panel object
25159     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
25160     */
25161    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25162
25163    /**
25164     * @brief Set the content of the panel.
25165     *
25166     * @param obj The panel object
25167     * @param content The panel content
25168     *
25169     * Once the content object is set, a previously set one will be deleted.
25170     * If you want to keep that old content object, use the
25171     * elm_panel_content_unset() function.
25172     *
25173     * @deprecated use elm_object_content_set() instead
25174     *
25175     */
25176    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25177
25178    /**
25179     * @brief Get the content of the panel.
25180     *
25181     * @param obj The panel object
25182     * @return The content that is being used
25183     *
25184     * Return the content object which is set for this widget.
25185     *
25186     * @see elm_panel_content_set()
25187     *
25188     * @deprecated use elm_object_content_get() instead
25189     *
25190     */
25191    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25192
25193    /**
25194     * @brief Unset the content of the panel.
25195     *
25196     * @param obj The panel object
25197     * @return The content that was being used
25198     *
25199     * Unparent and return the content object which was set for this widget.
25200     *
25201     * @see elm_panel_content_set()
25202     *
25203     * @deprecated use elm_object_content_unset() instead
25204     *
25205     */
25206    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25207
25208    /**
25209     * @brief Set the state of the panel.
25210     *
25211     * @param obj The panel object
25212     * @param hidden If true, the panel will run the animation to contract
25213     */
25214    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
25215
25216    /**
25217     * @brief Get the state of the panel.
25218     *
25219     * @param obj The panel object
25220     * @param hidden If true, the panel is in the "hide" state
25221     */
25222    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25223
25224    /**
25225     * @brief Toggle the hidden state of the panel from code
25226     *
25227     * @param obj The panel object
25228     */
25229    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
25230
25231    /**
25232     * @}
25233     */
25234
25235    /**
25236     * @defgroup Panes Panes
25237     * @ingroup Elementary
25238     *
25239     * @image html img/widget/panes/preview-00.png
25240     * @image latex img/widget/panes/preview-00.eps width=\textwidth
25241     *
25242     * @image html img/panes.png
25243     * @image latex img/panes.eps width=\textwidth
25244     *
25245     * The panes adds a dragable bar between two contents. When dragged
25246     * this bar will resize contents size.
25247     *
25248     * Panes can be displayed vertically or horizontally, and contents
25249     * size proportion can be customized (homogeneous by default).
25250     *
25251     * Smart callbacks one can listen to:
25252     * - "press" - The panes has been pressed (button wasn't released yet).
25253     * - "unpressed" - The panes was released after being pressed.
25254     * - "clicked" - The panes has been clicked>
25255     * - "clicked,double" - The panes has been double clicked
25256     *
25257     * Available styles for it:
25258     * - @c "default"
25259     *
25260     * Default contents parts of the panes widget that you can use for are:
25261     * @li "left" - A leftside content of the panes
25262     * @li "right" - A rightside content of the panes
25263     *
25264     * If panes is displayed vertically, left content will be displayed at
25265     * top.
25266     *
25267     * Here is an example on its usage:
25268     * @li @ref panes_example
25269     */
25270
25271    /**
25272     * @addtogroup Panes
25273     * @{
25274     */
25275
25276    /**
25277     * Add a new panes widget to the given parent Elementary
25278     * (container) object.
25279     *
25280     * @param parent The parent object.
25281     * @return a new panes widget handle or @c NULL, on errors.
25282     *
25283     * This function inserts a new panes widget on the canvas.
25284     *
25285     * @ingroup Panes
25286     */
25287    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25288
25289    /**
25290     * Set the left content of the panes widget.
25291     *
25292     * @param obj The panes object.
25293     * @param content The new left content object.
25294     *
25295     * Once the content object is set, a previously set one will be deleted.
25296     * If you want to keep that old content object, use the
25297     * elm_panes_content_left_unset() function.
25298     *
25299     * If panes is displayed vertically, left content will be displayed at
25300     * top.
25301     *
25302     * @see elm_panes_content_left_get()
25303     * @see elm_panes_content_right_set() to set content on the other side.
25304     *
25305     * @deprecated use elm_object_part_content_set() instead
25306     *
25307     * @ingroup Panes
25308     */
25309    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25310
25311    /**
25312     * Set the right content of the panes widget.
25313     *
25314     * @param obj The panes object.
25315     * @param content The new right content object.
25316     *
25317     * Once the content object is set, a previously set one will be deleted.
25318     * If you want to keep that old content object, use the
25319     * elm_panes_content_right_unset() function.
25320     *
25321     * If panes is displayed vertically, left content will be displayed at
25322     * bottom.
25323     *
25324     * @see elm_panes_content_right_get()
25325     * @see elm_panes_content_left_set() to set content on the other side.
25326     *
25327     * @deprecated use elm_object_part_content_set() instead
25328     *
25329     * @ingroup Panes
25330     */
25331    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25332
25333    /**
25334     * Get the left content of the panes.
25335     *
25336     * @param obj The panes object.
25337     * @return The left content object that is being used.
25338     *
25339     * Return the left content object which is set for this widget.
25340     *
25341     * @see elm_panes_content_left_set() for details.
25342     *
25343     * @deprecated use elm_object_part_content_get() instead
25344     *
25345     * @ingroup Panes
25346     */
25347    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25348
25349    /**
25350     * Get the right content of the panes.
25351     *
25352     * @param obj The panes object
25353     * @return The right content object that is being used
25354     *
25355     * Return the right content object which is set for this widget.
25356     *
25357     * @see elm_panes_content_right_set() for details.
25358     *
25359     * @deprecated use elm_object_part_content_get() instead
25360     *
25361     * @ingroup Panes
25362     */
25363    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25364
25365    /**
25366     * Unset the left content used for the panes.
25367     *
25368     * @param obj The panes object.
25369     * @return The left content object that was being used.
25370     *
25371     * Unparent and return the left content object which was set for this widget.
25372     *
25373     * @see elm_panes_content_left_set() for details.
25374     * @see elm_panes_content_left_get().
25375     *
25376     * @deprecated use elm_object_part_content_unset() instead
25377     *
25378     * @ingroup Panes
25379     */
25380    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25381
25382    /**
25383     * Unset the right content used for the panes.
25384     *
25385     * @param obj The panes object.
25386     * @return The right content object that was being used.
25387     *
25388     * Unparent and return the right content object which was set for this
25389     * widget.
25390     *
25391     * @see elm_panes_content_right_set() for details.
25392     * @see elm_panes_content_right_get().
25393     *
25394     * @deprecated use elm_object_part_content_unset() instead
25395     *
25396     * @ingroup Panes
25397     */
25398    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25399
25400    /**
25401     * Get the size proportion of panes widget's left side.
25402     *
25403     * @param obj The panes object.
25404     * @return float value between 0.0 and 1.0 representing size proportion
25405     * of left side.
25406     *
25407     * @see elm_panes_content_left_size_set() for more details.
25408     *
25409     * @ingroup Panes
25410     */
25411    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25412
25413    /**
25414     * Set the size proportion of panes widget's left side.
25415     *
25416     * @param obj The panes object.
25417     * @param size Value between 0.0 and 1.0 representing size proportion
25418     * of left side.
25419     *
25420     * By default it's homogeneous, i.e., both sides have the same size.
25421     *
25422     * If something different is required, it can be set with this function.
25423     * For example, if the left content should be displayed over
25424     * 75% of the panes size, @p size should be passed as @c 0.75.
25425     * This way, right content will be resized to 25% of panes size.
25426     *
25427     * If displayed vertically, left content is displayed at top, and
25428     * right content at bottom.
25429     *
25430     * @note This proportion will change when user drags the panes bar.
25431     *
25432     * @see elm_panes_content_left_size_get()
25433     *
25434     * @ingroup Panes
25435     */
25436    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
25437
25438   /**
25439    * Set the orientation of a given panes widget.
25440    *
25441    * @param obj The panes object.
25442    * @param horizontal Use @c EINA_TRUE to make @p obj to be
25443    * @b horizontal, @c EINA_FALSE to make it @b vertical.
25444    *
25445    * Use this function to change how your panes is to be
25446    * disposed: vertically or horizontally.
25447    *
25448    * By default it's displayed horizontally.
25449    *
25450    * @see elm_panes_horizontal_get()
25451    *
25452    * @ingroup Panes
25453    */
25454    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25455
25456    /**
25457     * Retrieve the orientation of a given panes widget.
25458     *
25459     * @param obj The panes object.
25460     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
25461     * @c EINA_FALSE if it's @b vertical (and on errors).
25462     *
25463     * @see elm_panes_horizontal_set() for more details.
25464     *
25465     * @ingroup Panes
25466     */
25467    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25468    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
25469    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25470
25471    /**
25472     * @}
25473     */
25474
25475    /**
25476     * @defgroup Flip Flip
25477     *
25478     * @image html img/widget/flip/preview-00.png
25479     * @image latex img/widget/flip/preview-00.eps
25480     *
25481     * This widget holds 2 content objects(Evas_Object): one on the front and one
25482     * on the back. It allows you to flip from front to back and vice-versa using
25483     * various animations.
25484     *
25485     * If either the front or back contents are not set the flip will treat that
25486     * as transparent. So if you wore to set the front content but not the back,
25487     * and then call elm_flip_go() you would see whatever is below the flip.
25488     *
25489     * For a list of supported animations see elm_flip_go().
25490     *
25491     * Signals that you can add callbacks for are:
25492     * "animate,begin" - when a flip animation was started
25493     * "animate,done" - when a flip animation is finished
25494     *
25495     * @ref tutorial_flip show how to use most of the API.
25496     *
25497     * @{
25498     */
25499    typedef enum _Elm_Flip_Mode
25500      {
25501         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
25502         ELM_FLIP_ROTATE_X_CENTER_AXIS,
25503         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
25504         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
25505         ELM_FLIP_CUBE_LEFT,
25506         ELM_FLIP_CUBE_RIGHT,
25507         ELM_FLIP_CUBE_UP,
25508         ELM_FLIP_CUBE_DOWN,
25509         ELM_FLIP_PAGE_LEFT,
25510         ELM_FLIP_PAGE_RIGHT,
25511         ELM_FLIP_PAGE_UP,
25512         ELM_FLIP_PAGE_DOWN
25513      } Elm_Flip_Mode;
25514    typedef enum _Elm_Flip_Interaction
25515      {
25516         ELM_FLIP_INTERACTION_NONE,
25517         ELM_FLIP_INTERACTION_ROTATE,
25518         ELM_FLIP_INTERACTION_CUBE,
25519         ELM_FLIP_INTERACTION_PAGE
25520      } Elm_Flip_Interaction;
25521    typedef enum _Elm_Flip_Direction
25522      {
25523         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
25524         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
25525         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
25526         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
25527      } Elm_Flip_Direction;
25528
25529    /**
25530     * @brief Add a new flip to the parent
25531     *
25532     * @param parent The parent object
25533     * @return The new object or NULL if it cannot be created
25534     */
25535    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25536
25537    /**
25538     * @brief Set the front content of the flip widget.
25539     *
25540     * @param obj The flip object
25541     * @param content The new front content object
25542     *
25543     * Once the content object is set, a previously set one will be deleted.
25544     * If you want to keep that old content object, use the
25545     * elm_flip_content_front_unset() function.
25546     */
25547    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25548
25549    /**
25550     * @brief Set the back content of the flip widget.
25551     *
25552     * @param obj The flip object
25553     * @param content The new back content object
25554     *
25555     * Once the content object is set, a previously set one will be deleted.
25556     * If you want to keep that old content object, use the
25557     * elm_flip_content_back_unset() function.
25558     */
25559    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25560
25561    /**
25562     * @brief Get the front content used for the flip
25563     *
25564     * @param obj The flip object
25565     * @return The front content object that is being used
25566     *
25567     * Return the front content object which is set for this widget.
25568     */
25569    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25570
25571    /**
25572     * @brief Get the back content used for the flip
25573     *
25574     * @param obj The flip object
25575     * @return The back content object that is being used
25576     *
25577     * Return the back content object which is set for this widget.
25578     */
25579    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25580
25581    /**
25582     * @brief Unset the front content used for the flip
25583     *
25584     * @param obj The flip object
25585     * @return The front content object that was being used
25586     *
25587     * Unparent and return the front content object which was set for this widget.
25588     */
25589    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25590
25591    /**
25592     * @brief Unset the back content used for the flip
25593     *
25594     * @param obj The flip object
25595     * @return The back content object that was being used
25596     *
25597     * Unparent and return the back content object which was set for this widget.
25598     */
25599    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25600
25601    /**
25602     * @brief Get flip front visibility state
25603     *
25604     * @param obj The flip objct
25605     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
25606     * showing.
25607     */
25608    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25609
25610    /**
25611     * @brief Set flip perspective
25612     *
25613     * @param obj The flip object
25614     * @param foc The coordinate to set the focus on
25615     * @param x The X coordinate
25616     * @param y The Y coordinate
25617     *
25618     * @warning This function currently does nothing.
25619     */
25620    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
25621
25622    /**
25623     * @brief Runs the flip animation
25624     *
25625     * @param obj The flip object
25626     * @param mode The mode type
25627     *
25628     * Flips the front and back contents using the @p mode animation. This
25629     * efectively hides the currently visible content and shows the hidden one.
25630     *
25631     * There a number of possible animations to use for the flipping:
25632     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
25633     * around a horizontal axis in the middle of its height, the other content
25634     * is shown as the other side of the flip.
25635     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
25636     * around a vertical axis in the middle of its width, the other content is
25637     * shown as the other side of the flip.
25638     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
25639     * around a diagonal axis in the middle of its width, the other content is
25640     * shown as the other side of the flip.
25641     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
25642     * around a diagonal axis in the middle of its height, the other content is
25643     * shown as the other side of the flip.
25644     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
25645     * as if the flip was a cube, the other content is show as the right face of
25646     * the cube.
25647     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
25648     * right as if the flip was a cube, the other content is show as the left
25649     * face of the cube.
25650     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
25651     * flip was a cube, the other content is show as the bottom face of the cube.
25652     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
25653     * the flip was a cube, the other content is show as the upper face of the
25654     * cube.
25655     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
25656     * if the flip was a book, the other content is shown as the page below that.
25657     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
25658     * as if the flip was a book, the other content is shown as the page below
25659     * that.
25660     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
25661     * flip was a book, the other content is shown as the page below that.
25662     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
25663     * flip was a book, the other content is shown as the page below that.
25664     *
25665     * @image html elm_flip.png
25666     * @image latex elm_flip.eps width=\textwidth
25667     */
25668    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
25669
25670    /**
25671     * @brief Set the interactive flip mode
25672     *
25673     * @param obj The flip object
25674     * @param mode The interactive flip mode to use
25675     *
25676     * This sets if the flip should be interactive (allow user to click and
25677     * drag a side of the flip to reveal the back page and cause it to flip).
25678     * By default a flip is not interactive. You may also need to set which
25679     * sides of the flip are "active" for flipping and how much space they use
25680     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
25681     * and elm_flip_interacton_direction_hitsize_set()
25682     *
25683     * The four avilable mode of interaction are:
25684     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
25685     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
25686     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
25687     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
25688     *
25689     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
25690     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
25691     * happen, those can only be acheived with elm_flip_go();
25692     */
25693    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
25694
25695    /**
25696     * @brief Get the interactive flip mode
25697     *
25698     * @param obj The flip object
25699     * @return The interactive flip mode
25700     *
25701     * Returns the interactive flip mode set by elm_flip_interaction_set()
25702     */
25703    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
25704
25705    /**
25706     * @brief Set which directions of the flip respond to interactive flip
25707     *
25708     * @param obj The flip object
25709     * @param dir The direction to change
25710     * @param enabled If that direction is enabled or not
25711     *
25712     * By default all directions are disabled, so you may want to enable the
25713     * desired directions for flipping if you need interactive flipping. You must
25714     * call this function once for each direction that should be enabled.
25715     *
25716     * @see elm_flip_interaction_set()
25717     */
25718    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
25719
25720    /**
25721     * @brief Get the enabled state of that flip direction
25722     *
25723     * @param obj The flip object
25724     * @param dir The direction to check
25725     * @return If that direction is enabled or not
25726     *
25727     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
25728     *
25729     * @see elm_flip_interaction_set()
25730     */
25731    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
25732
25733    /**
25734     * @brief Set the amount of the flip that is sensitive to interactive flip
25735     *
25736     * @param obj The flip object
25737     * @param dir The direction to modify
25738     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
25739     *
25740     * Set the amount of the flip that is sensitive to interactive flip, with 0
25741     * representing no area in the flip and 1 representing the entire flip. There
25742     * is however a consideration to be made in that the area will never be
25743     * smaller than the finger size set(as set in your Elementary configuration).
25744     *
25745     * @see elm_flip_interaction_set()
25746     */
25747    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
25748
25749    /**
25750     * @brief Get the amount of the flip that is sensitive to interactive flip
25751     *
25752     * @param obj The flip object
25753     * @param dir The direction to check
25754     * @return The size set for that direction
25755     *
25756     * Returns the amount os sensitive area set by
25757     * elm_flip_interacton_direction_hitsize_set().
25758     */
25759    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
25760
25761    /**
25762     * @}
25763     */
25764
25765    /* scrolledentry */
25766    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25767    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
25768    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25769    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
25770    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25771    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25772    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25773    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25774    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25775    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25776    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25777    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
25778    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
25779    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25780    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
25781    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
25782    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25783    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25784    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
25785    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
25786    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25787    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25788    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25789    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25790    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
25791    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
25792    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25793    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25794    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25795    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25796    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25797    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
25798    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
25799    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
25800    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25801    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);
25802    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25803    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25804    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);
25805    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25806    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);
25807    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
25808    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25809    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25810    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25811    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
25812    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25813    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25814    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25815    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);
25816    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);
25817    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);
25818    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);
25819    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);
25820    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);
25821    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
25822    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
25823    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
25824    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
25825    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25826    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
25827    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
25828
25829    /**
25830     * @defgroup Conformant Conformant
25831     * @ingroup Elementary
25832     *
25833     * @image html img/widget/conformant/preview-00.png
25834     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
25835     *
25836     * @image html img/conformant.png
25837     * @image latex img/conformant.eps width=\textwidth
25838     *
25839     * The aim is to provide a widget that can be used in elementary apps to
25840     * account for space taken up by the indicator, virtual keypad & softkey
25841     * windows when running the illume2 module of E17.
25842     *
25843     * So conformant content will be sized and positioned considering the
25844     * space required for such stuff, and when they popup, as a keyboard
25845     * shows when an entry is selected, conformant content won't change.
25846     *
25847     * Available styles for it:
25848     * - @c "default"
25849     *
25850     * Default contents parts of the conformant widget that you can use for are:
25851     * @li "default" - A content of the conformant
25852     *
25853     * See how to use this widget in this example:
25854     * @ref conformant_example
25855     */
25856
25857    /**
25858     * @addtogroup Conformant
25859     * @{
25860     */
25861
25862    /**
25863     * Add a new conformant widget to the given parent Elementary
25864     * (container) object.
25865     *
25866     * @param parent The parent object.
25867     * @return A new conformant widget handle or @c NULL, on errors.
25868     *
25869     * This function inserts a new conformant widget on the canvas.
25870     *
25871     * @ingroup Conformant
25872     */
25873    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25874
25875    /**
25876     * Set the content of the conformant widget.
25877     *
25878     * @param obj The conformant object.
25879     * @param content The content to be displayed by the conformant.
25880     *
25881     * Content will be sized and positioned considering the space required
25882     * to display a virtual keyboard. So it won't fill all the conformant
25883     * size. This way is possible to be sure that content won't resize
25884     * or be re-positioned after the keyboard is displayed.
25885     *
25886     * Once the content object is set, a previously set one will be deleted.
25887     * If you want to keep that old content object, use the
25888     * elm_object_content_unset() function.
25889     *
25890     * @see elm_object_content_unset()
25891     * @see elm_object_content_get()
25892     *
25893     * @deprecated use elm_object_content_set() instead
25894     *
25895     * @ingroup Conformant
25896     */
25897    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25898
25899    /**
25900     * Get the content of the conformant widget.
25901     *
25902     * @param obj The conformant object.
25903     * @return The content that is being used.
25904     *
25905     * Return the content object which is set for this widget.
25906     * It won't be unparent from conformant. For that, use
25907     * elm_object_content_unset().
25908     *
25909     * @see elm_object_content_set().
25910     * @see elm_object_content_unset()
25911     *
25912     * @deprecated use elm_object_content_get() instead
25913     *
25914     * @ingroup Conformant
25915     */
25916    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25917
25918    /**
25919     * Unset the content of the conformant widget.
25920     *
25921     * @param obj The conformant object.
25922     * @return The content that was being used.
25923     *
25924     * Unparent and return the content object which was set for this widget.
25925     *
25926     * @see elm_object_content_set().
25927     *
25928     * @deprecated use elm_object_content_unset() instead
25929     *
25930     * @ingroup Conformant
25931     */
25932    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25933
25934    /**
25935     * Returns the Evas_Object that represents the content area.
25936     *
25937     * @param obj The conformant object.
25938     * @return The content area of the widget.
25939     *
25940     * @ingroup Conformant
25941     */
25942    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25943
25944    /**
25945     * @}
25946     */
25947
25948    /**
25949     * @defgroup Mapbuf Mapbuf
25950     * @ingroup Elementary
25951     *
25952     * @image html img/widget/mapbuf/preview-00.png
25953     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
25954     *
25955     * This holds one content object and uses an Evas Map of transformation
25956     * points to be later used with this content. So the content will be
25957     * moved, resized, etc as a single image. So it will improve performance
25958     * when you have a complex interafce, with a lot of elements, and will
25959     * need to resize or move it frequently (the content object and its
25960     * children).
25961     *
25962     * Default contents parts of the mapbuf widget that you can use for are:
25963     * @li "default" - A content of the mapbuf
25964     *
25965     * To enable map, elm_mapbuf_enabled_set() should be used.
25966     *
25967     * See how to use this widget in this example:
25968     * @ref mapbuf_example
25969     */
25970
25971    /**
25972     * @addtogroup Mapbuf
25973     * @{
25974     */
25975
25976    /**
25977     * Add a new mapbuf widget to the given parent Elementary
25978     * (container) object.
25979     *
25980     * @param parent The parent object.
25981     * @return A new mapbuf widget handle or @c NULL, on errors.
25982     *
25983     * This function inserts a new mapbuf widget on the canvas.
25984     *
25985     * @ingroup Mapbuf
25986     */
25987    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25988
25989    /**
25990     * Set the content of the mapbuf.
25991     *
25992     * @param obj The mapbuf object.
25993     * @param content The content that will be filled in this mapbuf object.
25994     *
25995     * Once the content object is set, a previously set one will be deleted.
25996     * If you want to keep that old content object, use the
25997     * elm_mapbuf_content_unset() function.
25998     *
25999     * To enable map, elm_mapbuf_enabled_set() should be used.
26000     *
26001     * @deprecated use elm_object_content_set() instead
26002     *
26003     * @ingroup Mapbuf
26004     */
26005    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
26006
26007    /**
26008     * Get the content of the mapbuf.
26009     *
26010     * @param obj The mapbuf object.
26011     * @return The content that is being used.
26012     *
26013     * Return the content object which is set for this widget.
26014     *
26015     * @see elm_mapbuf_content_set() for details.
26016     *
26017     * @deprecated use elm_object_content_get() instead
26018     *
26019     * @ingroup Mapbuf
26020     */
26021    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26022
26023    /**
26024     * Unset the content of the mapbuf.
26025     *
26026     * @param obj The mapbuf object.
26027     * @return The content that was being used.
26028     *
26029     * Unparent and return the content object which was set for this widget.
26030     *
26031     * @see elm_mapbuf_content_set() for details.
26032     *
26033     * @deprecated use elm_object_content_unset() instead
26034     *
26035     * @ingroup Mapbuf
26036     */
26037    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26038
26039    /**
26040     * Enable or disable the map.
26041     *
26042     * @param obj The mapbuf object.
26043     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
26044     *
26045     * This enables the map that is set or disables it. On enable, the object
26046     * geometry will be saved, and the new geometry will change (position and
26047     * size) to reflect the map geometry set.
26048     *
26049     * Also, when enabled, alpha and smooth states will be used, so if the
26050     * content isn't solid, alpha should be enabled, for example, otherwise
26051     * a black retangle will fill the content.
26052     *
26053     * When disabled, the stored map will be freed and geometry prior to
26054     * enabling the map will be restored.
26055     *
26056     * It's disabled by default.
26057     *
26058     * @see elm_mapbuf_alpha_set()
26059     * @see elm_mapbuf_smooth_set()
26060     *
26061     * @ingroup Mapbuf
26062     */
26063    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26064
26065    /**
26066     * Get a value whether map is enabled or not.
26067     *
26068     * @param obj The mapbuf object.
26069     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
26070     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26071     *
26072     * @see elm_mapbuf_enabled_set() for details.
26073     *
26074     * @ingroup Mapbuf
26075     */
26076    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26077
26078    /**
26079     * Enable or disable smooth map rendering.
26080     *
26081     * @param obj The mapbuf object.
26082     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
26083     * to disable it.
26084     *
26085     * This sets smoothing for map rendering. If the object is a type that has
26086     * its own smoothing settings, then both the smooth settings for this object
26087     * and the map must be turned off.
26088     *
26089     * By default smooth maps are enabled.
26090     *
26091     * @ingroup Mapbuf
26092     */
26093    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
26094
26095    /**
26096     * Get a value whether smooth map rendering is enabled or not.
26097     *
26098     * @param obj The mapbuf object.
26099     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
26100     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26101     *
26102     * @see elm_mapbuf_smooth_set() for details.
26103     *
26104     * @ingroup Mapbuf
26105     */
26106    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26107
26108    /**
26109     * Set or unset alpha flag for map rendering.
26110     *
26111     * @param obj The mapbuf object.
26112     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
26113     * to disable it.
26114     *
26115     * This sets alpha flag for map rendering. If the object is a type that has
26116     * its own alpha settings, then this will take precedence. Only image objects
26117     * have this currently. It stops alpha blending of the map area, and is
26118     * useful if you know the object and/or all sub-objects is 100% solid.
26119     *
26120     * Alpha is enabled by default.
26121     *
26122     * @ingroup Mapbuf
26123     */
26124    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
26125
26126    /**
26127     * Get a value whether alpha blending is enabled or not.
26128     *
26129     * @param obj The mapbuf object.
26130     * @return @c EINA_TRUE means alpha blending 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_alpha_set() for details.
26134     *
26135     * @ingroup Mapbuf
26136     */
26137    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26138
26139    /**
26140     * @}
26141     */
26142
26143    /**
26144     * @defgroup Flipselector Flip Selector
26145     *
26146     * @image html img/widget/flipselector/preview-00.png
26147     * @image latex img/widget/flipselector/preview-00.eps
26148     *
26149     * A flip selector is a widget to show a set of @b text items, one
26150     * at a time, with the same sheet switching style as the @ref Clock
26151     * "clock" widget, when one changes the current displaying sheet
26152     * (thus, the "flip" in the name).
26153     *
26154     * User clicks to flip sheets which are @b held for some time will
26155     * make the flip selector to flip continuosly and automatically for
26156     * the user. The interval between flips will keep growing in time,
26157     * so that it helps the user to reach an item which is distant from
26158     * the current selection.
26159     *
26160     * Smart callbacks one can register to:
26161     * - @c "selected" - when the widget's selected text item is changed
26162     * - @c "overflowed" - when the widget's current selection is changed
26163     *   from the first item in its list to the last
26164     * - @c "underflowed" - when the widget's current selection is changed
26165     *   from the last item in its list to the first
26166     *
26167     * Available styles for it:
26168     * - @c "default"
26169     *
26170          * To set/get the label of the flipselector item, you can use
26171          * elm_object_item_text_set/get APIs.
26172          * Once the text is set, a previously set one will be deleted.
26173          *
26174     * Here is an example on its usage:
26175     * @li @ref flipselector_example
26176     */
26177
26178    /**
26179     * @addtogroup Flipselector
26180     * @{
26181     */
26182
26183    /**
26184     * Add a new flip selector widget to the given parent Elementary
26185     * (container) widget
26186     *
26187     * @param parent The parent object
26188     * @return a new flip selector widget handle or @c NULL, on errors
26189     *
26190     * This function inserts a new flip selector widget on the canvas.
26191     *
26192     * @ingroup Flipselector
26193     */
26194    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26195
26196    /**
26197     * Programmatically select the next item of a flip selector widget
26198     *
26199     * @param obj The flipselector object
26200     *
26201     * @note The selection will be animated. Also, if it reaches the
26202     * end of its list of member items, it will continue with the first
26203     * one onwards.
26204     *
26205     * @ingroup Flipselector
26206     */
26207    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
26208
26209    /**
26210     * Programmatically select the previous item of a flip selector
26211     * widget
26212     *
26213     * @param obj The flipselector object
26214     *
26215     * @note The selection will be animated.  Also, if it reaches the
26216     * beginning of its list of member items, it will continue with the
26217     * last one backwards.
26218     *
26219     * @ingroup Flipselector
26220     */
26221    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
26222
26223    /**
26224     * Append a (text) item to a flip selector widget
26225     *
26226     * @param obj The flipselector object
26227     * @param label The (text) label of the new item
26228     * @param func Convenience callback function to take place when
26229     * item is selected
26230     * @param data Data passed to @p func, above
26231     * @return A handle to the item added or @c NULL, on errors
26232     *
26233     * The widget's list of labels to show will be appended with the
26234     * given value. If the user wishes so, a callback function pointer
26235     * can be passed, which will get called when this same item is
26236     * selected.
26237     *
26238     * @note The current selection @b won't be modified by appending an
26239     * element to the list.
26240     *
26241     * @note The maximum length of the text label is going to be
26242     * determined <b>by the widget's theme</b>. Strings larger than
26243     * that value are going to be @b truncated.
26244     *
26245     * @ingroup Flipselector
26246     */
26247    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26248
26249    /**
26250     * Prepend a (text) item to a flip selector widget
26251     *
26252     * @param obj The flipselector object
26253     * @param label The (text) label of the new item
26254     * @param func Convenience callback function to take place when
26255     * item is selected
26256     * @param data Data passed to @p func, above
26257     * @return A handle to the item added or @c NULL, on errors
26258     *
26259     * The widget's list of labels to show will be prepended with the
26260     * given value. If the user wishes so, a callback function pointer
26261     * can be passed, which will get called when this same item is
26262     * selected.
26263     *
26264     * @note The current selection @b won't be modified by prepending
26265     * an element to the list.
26266     *
26267     * @note The maximum length of the text label is going to be
26268     * determined <b>by the widget's theme</b>. Strings larger than
26269     * that value are going to be @b truncated.
26270     *
26271     * @ingroup Flipselector
26272     */
26273    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26274
26275    /**
26276     * Get the internal list of items in a given flip selector widget.
26277     *
26278     * @param obj The flipselector object
26279     * @return The list of items (#Elm_Object_Item as data) or
26280     * @c NULL on errors.
26281     *
26282     * This list is @b not to be modified in any way and must not be
26283     * freed. Use the list members with functions like
26284     * elm_object_item_text_set(),
26285     * elm_object_item_text_get(),
26286     * elm_flipselector_item_del(),
26287     * elm_flipselector_item_selected_get(),
26288     * elm_flipselector_item_selected_set().
26289     *
26290     * @warning This list is only valid until @p obj object's internal
26291     * items list is changed. It should be fetched again with another
26292     * call to this function when changes happen.
26293     *
26294     * @ingroup Flipselector
26295     */
26296    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26297
26298    /**
26299     * Get the first item in the given flip selector widget's list of
26300     * items.
26301     *
26302     * @param obj The flipselector object
26303     * @return The first item or @c NULL, if it has no items (and on
26304     * errors)
26305     *
26306     * @see elm_flipselector_item_append()
26307     * @see elm_flipselector_last_item_get()
26308     *
26309     * @ingroup Flipselector
26310     */
26311    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26312
26313    /**
26314     * Get the last item in the given flip selector widget's list of
26315     * items.
26316     *
26317     * @param obj The flipselector object
26318     * @return The last item or @c NULL, if it has no items (and on
26319     * errors)
26320     *
26321     * @see elm_flipselector_item_prepend()
26322     * @see elm_flipselector_first_item_get()
26323     *
26324     * @ingroup Flipselector
26325     */
26326    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26327
26328    /**
26329     * Get the currently selected item in a flip selector widget.
26330     *
26331     * @param obj The flipselector object
26332     * @return The selected item or @c NULL, if the widget has no items
26333     * (and on erros)
26334     *
26335     * @ingroup Flipselector
26336     */
26337    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26338
26339    /**
26340     * Set whether a given flip selector widget's item should be the
26341     * currently selected one.
26342     *
26343     * @param it The flip selector item
26344     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
26345     *
26346     * This sets whether @p item is or not the selected (thus, under
26347     * display) one. If @p item is different than one under display,
26348     * the latter will be unselected. If the @p item is set to be
26349     * unselected, on the other hand, the @b first item in the widget's
26350     * internal members list will be the new selected one.
26351     *
26352     * @see elm_flipselector_item_selected_get()
26353     *
26354     * @ingroup Flipselector
26355     */
26356    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
26357
26358    /**
26359     * Get whether a given flip selector widget's item is the currently
26360     * selected one.
26361     *
26362     * @param it The flip selector item
26363     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
26364     * (or on errors).
26365     *
26366     * @see elm_flipselector_item_selected_set()
26367     *
26368     * @ingroup Flipselector
26369     */
26370    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26371
26372    /**
26373     * Delete a given item from a flip selector widget.
26374     *
26375     * @param it The item to delete
26376     *
26377     * @ingroup Flipselector
26378     */
26379    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26380
26381    /**
26382     * Get the label of a given flip selector widget's item.
26383     *
26384     * @param it The item to get label from
26385     * @return The text label of @p item or @c NULL, on errors
26386     *
26387     * @see elm_object_item_text_set()
26388     *
26389     * @deprecated see elm_object_item_text_get() instead
26390     * @ingroup Flipselector
26391     */
26392    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26393
26394    /**
26395     * Set the label of a given flip selector widget's item.
26396     *
26397     * @param it The item to set label on
26398     * @param label The text label string, in UTF-8 encoding
26399     *
26400     * @see elm_object_item_text_get()
26401     *
26402          * @deprecated see elm_object_item_text_set() instead
26403     * @ingroup Flipselector
26404     */
26405    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26406
26407    /**
26408     * Gets the item before @p item in a flip selector widget's
26409     * internal list of items.
26410     *
26411     * @param it The item to fetch previous from
26412     * @return The item before the @p item, in its parent's list. If
26413     *         there is no previous item for @p item or there's an
26414     *         error, @c NULL is returned.
26415     *
26416     * @see elm_flipselector_item_next_get()
26417     *
26418     * @ingroup Flipselector
26419     */
26420    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26421
26422    /**
26423     * Gets the item after @p item in a flip selector widget's
26424     * internal list of items.
26425     *
26426     * @param it The item to fetch next from
26427     * @return The item after the @p item, in its parent's list. If
26428     *         there is no next item for @p item or there's an
26429     *         error, @c NULL is returned.
26430     *
26431     * @see elm_flipselector_item_next_get()
26432     *
26433     * @ingroup Flipselector
26434     */
26435    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26436
26437    /**
26438     * Set the interval on time updates for an user mouse button hold
26439     * on a flip selector widget.
26440     *
26441     * @param obj The flip selector object
26442     * @param interval The (first) interval value in seconds
26443     *
26444     * This interval value is @b decreased while the user holds the
26445     * mouse pointer either flipping up or flipping doww a given flip
26446     * selector.
26447     *
26448     * This helps the user to get to a given item distant from the
26449     * current one easier/faster, as it will start to flip quicker and
26450     * quicker on mouse button holds.
26451     *
26452     * The calculation for the next flip interval value, starting from
26453     * the one set with this call, is the previous interval divided by
26454     * 1.05, so it decreases a little bit.
26455     *
26456     * The default starting interval value for automatic flips is
26457     * @b 0.85 seconds.
26458     *
26459     * @see elm_flipselector_interval_get()
26460     *
26461     * @ingroup Flipselector
26462     */
26463    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26464
26465    /**
26466     * Get the interval on time updates for an user mouse button hold
26467     * on a flip selector widget.
26468     *
26469     * @param obj The flip selector object
26470     * @return The (first) interval value, in seconds, set on it
26471     *
26472     * @see elm_flipselector_interval_set() for more details
26473     *
26474     * @ingroup Flipselector
26475     */
26476    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26477    /**
26478     * @}
26479     */
26480
26481    /**
26482     * @addtogroup Calendar
26483     * @{
26484     */
26485
26486    /**
26487     * @enum _Elm_Calendar_Mark_Repeat
26488     * @typedef Elm_Calendar_Mark_Repeat
26489     *
26490     * Event periodicity, used to define if a mark should be repeated
26491     * @b beyond event's day. It's set when a mark is added.
26492     *
26493     * So, for a mark added to 13th May with periodicity set to WEEKLY,
26494     * there will be marks every week after this date. Marks will be displayed
26495     * at 13th, 20th, 27th, 3rd June ...
26496     *
26497     * Values don't work as bitmask, only one can be choosen.
26498     *
26499     * @see elm_calendar_mark_add()
26500     *
26501     * @ingroup Calendar
26502     */
26503    typedef enum _Elm_Calendar_Mark_Repeat
26504      {
26505         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
26506         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
26507         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
26508         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*/
26509         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. */
26510      } Elm_Calendar_Mark_Repeat;
26511
26512    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(). */
26513
26514    /**
26515     * Add a new calendar widget to the given parent Elementary
26516     * (container) object.
26517     *
26518     * @param parent The parent object.
26519     * @return a new calendar widget handle or @c NULL, on errors.
26520     *
26521     * This function inserts a new calendar widget on the canvas.
26522     *
26523     * @ref calendar_example_01
26524     *
26525     * @ingroup Calendar
26526     */
26527    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26528
26529    /**
26530     * Get weekdays names displayed by the calendar.
26531     *
26532     * @param obj The calendar object.
26533     * @return Array of seven strings to be used as weekday names.
26534     *
26535     * By default, weekdays abbreviations get from system are displayed:
26536     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26537     * The first string is related to Sunday, the second to Monday...
26538     *
26539     * @see elm_calendar_weekdays_name_set()
26540     *
26541     * @ref calendar_example_05
26542     *
26543     * @ingroup Calendar
26544     */
26545    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26546
26547    /**
26548     * Set weekdays names to be displayed by the calendar.
26549     *
26550     * @param obj The calendar object.
26551     * @param weekdays Array of seven strings to be used as weekday names.
26552     * @warning It must have 7 elements, or it will access invalid memory.
26553     * @warning The strings must be NULL terminated ('@\0').
26554     *
26555     * By default, weekdays abbreviations get from system are displayed:
26556     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26557     *
26558     * The first string should be related to Sunday, the second to Monday...
26559     *
26560     * The usage should be like this:
26561     * @code
26562     *   const char *weekdays[] =
26563     *   {
26564     *      "Sunday", "Monday", "Tuesday", "Wednesday",
26565     *      "Thursday", "Friday", "Saturday"
26566     *   };
26567     *   elm_calendar_weekdays_names_set(calendar, weekdays);
26568     * @endcode
26569     *
26570     * @see elm_calendar_weekdays_name_get()
26571     *
26572     * @ref calendar_example_02
26573     *
26574     * @ingroup Calendar
26575     */
26576    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
26577
26578    /**
26579     * Set the minimum and maximum values for the year
26580     *
26581     * @param obj The calendar object
26582     * @param min The minimum year, greater than 1901;
26583     * @param max The maximum year;
26584     *
26585     * Maximum must be greater than minimum, except if you don't wan't to set
26586     * maximum year.
26587     * Default values are 1902 and -1.
26588     *
26589     * If the maximum year is a negative value, it will be limited depending
26590     * on the platform architecture (year 2037 for 32 bits);
26591     *
26592     * @see elm_calendar_min_max_year_get()
26593     *
26594     * @ref calendar_example_03
26595     *
26596     * @ingroup Calendar
26597     */
26598    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
26599
26600    /**
26601     * Get the minimum and maximum values for the year
26602     *
26603     * @param obj The calendar object.
26604     * @param min The minimum year.
26605     * @param max The maximum year.
26606     *
26607     * Default values are 1902 and -1.
26608     *
26609     * @see elm_calendar_min_max_year_get() for more details.
26610     *
26611     * @ref calendar_example_05
26612     *
26613     * @ingroup Calendar
26614     */
26615    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
26616
26617    /**
26618     * Enable or disable day selection
26619     *
26620     * @param obj The calendar object.
26621     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
26622     * disable it.
26623     *
26624     * Enabled by default. If disabled, the user still can select months,
26625     * but not days. Selected days are highlighted on calendar.
26626     * It should be used if you won't need such selection for the widget usage.
26627     *
26628     * When a day is selected, or month is changed, smart callbacks for
26629     * signal "changed" will be called.
26630     *
26631     * @see elm_calendar_day_selection_enable_get()
26632     *
26633     * @ref calendar_example_04
26634     *
26635     * @ingroup Calendar
26636     */
26637    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26638
26639    /**
26640     * Get a value whether day selection is enabled or not.
26641     *
26642     * @see elm_calendar_day_selection_enable_set() for details.
26643     *
26644     * @param obj The calendar object.
26645     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
26646     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
26647     *
26648     * @ref calendar_example_05
26649     *
26650     * @ingroup Calendar
26651     */
26652    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26653
26654
26655    /**
26656     * Set selected date to be highlighted on calendar.
26657     *
26658     * @param obj The calendar object.
26659     * @param selected_time A @b tm struct to represent the selected date.
26660     *
26661     * Set the selected date, changing the displayed month if needed.
26662     * Selected date changes when the user goes to next/previous month or
26663     * select a day pressing over it on calendar.
26664     *
26665     * @see elm_calendar_selected_time_get()
26666     *
26667     * @ref calendar_example_04
26668     *
26669     * @ingroup Calendar
26670     */
26671    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
26672
26673    /**
26674     * Get selected date.
26675     *
26676     * @param obj The calendar object
26677     * @param selected_time A @b tm struct to point to selected date
26678     * @return EINA_FALSE means an error ocurred and returned time shouldn't
26679     * be considered.
26680     *
26681     * Get date selected by the user or set by function
26682     * elm_calendar_selected_time_set().
26683     * Selected date changes when the user goes to next/previous month or
26684     * select a day pressing over it on calendar.
26685     *
26686     * @see elm_calendar_selected_time_get()
26687     *
26688     * @ref calendar_example_05
26689     *
26690     * @ingroup Calendar
26691     */
26692    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
26693
26694    /**
26695     * Set a function to format the string that will be used to display
26696     * month and year;
26697     *
26698     * @param obj The calendar object
26699     * @param format_function Function to set the month-year string given
26700     * the selected date
26701     *
26702     * By default it uses strftime with "%B %Y" format string.
26703     * It should allocate the memory that will be used by the string,
26704     * that will be freed by the widget after usage.
26705     * A pointer to the string and a pointer to the time struct will be provided.
26706     *
26707     * Example:
26708     * @code
26709     * static char *
26710     * _format_month_year(struct tm *selected_time)
26711     * {
26712     *    char buf[32];
26713     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
26714     *    return strdup(buf);
26715     * }
26716     *
26717     * elm_calendar_format_function_set(calendar, _format_month_year);
26718     * @endcode
26719     *
26720     * @ref calendar_example_02
26721     *
26722     * @ingroup Calendar
26723     */
26724    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
26725
26726    /**
26727     * Add a new mark to the calendar
26728     *
26729     * @param obj The calendar object
26730     * @param mark_type A string used to define the type of mark. It will be
26731     * emitted to the theme, that should display a related modification on these
26732     * days representation.
26733     * @param mark_time A time struct to represent the date of inclusion of the
26734     * mark. For marks that repeats it will just be displayed after the inclusion
26735     * date in the calendar.
26736     * @param repeat Repeat the event following this periodicity. Can be a unique
26737     * mark (that don't repeat), daily, weekly, monthly or annually.
26738     * @return The created mark or @p NULL upon failure.
26739     *
26740     * Add a mark that will be drawn in the calendar respecting the insertion
26741     * time and periodicity. It will emit the type as signal to the widget theme.
26742     * Default theme supports "holiday" and "checked", but it can be extended.
26743     *
26744     * It won't immediately update the calendar, drawing the marks.
26745     * For this, call elm_calendar_marks_draw(). However, when user selects
26746     * next or previous month calendar forces marks drawn.
26747     *
26748     * Marks created with this method can be deleted with
26749     * elm_calendar_mark_del().
26750     *
26751     * Example
26752     * @code
26753     * struct tm selected_time;
26754     * time_t current_time;
26755     *
26756     * current_time = time(NULL) + 5 * 84600;
26757     * localtime_r(&current_time, &selected_time);
26758     * elm_calendar_mark_add(cal, "holiday", selected_time,
26759     *     ELM_CALENDAR_ANNUALLY);
26760     *
26761     * current_time = time(NULL) + 1 * 84600;
26762     * localtime_r(&current_time, &selected_time);
26763     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
26764     *
26765     * elm_calendar_marks_draw(cal);
26766     * @endcode
26767     *
26768     * @see elm_calendar_marks_draw()
26769     * @see elm_calendar_mark_del()
26770     *
26771     * @ref calendar_example_06
26772     *
26773     * @ingroup Calendar
26774     */
26775    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);
26776
26777    /**
26778     * Delete mark from the calendar.
26779     *
26780     * @param mark The mark to be deleted.
26781     *
26782     * If deleting all calendar marks is required, elm_calendar_marks_clear()
26783     * should be used instead of getting marks list and deleting each one.
26784     *
26785     * @see elm_calendar_mark_add()
26786     *
26787     * @ref calendar_example_06
26788     *
26789     * @ingroup Calendar
26790     */
26791    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
26792
26793    /**
26794     * Remove all calendar's marks
26795     *
26796     * @param obj The calendar object.
26797     *
26798     * @see elm_calendar_mark_add()
26799     * @see elm_calendar_mark_del()
26800     *
26801     * @ingroup Calendar
26802     */
26803    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26804
26805    /**
26806     * Get a list of all the calendar marks.
26807     *
26808     * @param obj The calendar object.
26809     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
26810     *
26811     * @see elm_calendar_mark_add()
26812     * @see elm_calendar_mark_del()
26813     * @see elm_calendar_marks_clear()
26814     *
26815     * @ingroup Calendar
26816     */
26817    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26818
26819    /**
26820     * Draw calendar marks.
26821     *
26822     * @param obj The calendar object.
26823     *
26824     * Should be used after adding, removing or clearing marks.
26825     * It will go through the entire marks list updating the calendar.
26826     * If lots of marks will be added, add all the marks and then call
26827     * this function.
26828     *
26829     * When the month is changed, i.e. user selects next or previous month,
26830     * marks will be drawed.
26831     *
26832     * @see elm_calendar_mark_add()
26833     * @see elm_calendar_mark_del()
26834     * @see elm_calendar_marks_clear()
26835     *
26836     * @ref calendar_example_06
26837     *
26838     * @ingroup Calendar
26839     */
26840    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
26841
26842    /**
26843     * Set a day text color to the same that represents Saturdays.
26844     *
26845     * @param obj The calendar object.
26846     * @param pos The text position. Position is the cell counter, from left
26847     * to right, up to down. It starts on 0 and ends on 41.
26848     *
26849     * @deprecated use elm_calendar_mark_add() instead like:
26850     *
26851     * @code
26852     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
26853     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26854     * @endcode
26855     *
26856     * @see elm_calendar_mark_add()
26857     *
26858     * @ingroup Calendar
26859     */
26860    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26861
26862    /**
26863     * Set a day text color to the same that represents Sundays.
26864     *
26865     * @param obj The calendar object.
26866     * @param pos The text position. Position is the cell counter, from left
26867     * to right, up to down. It starts on 0 and ends on 41.
26868
26869     * @deprecated use elm_calendar_mark_add() instead like:
26870     *
26871     * @code
26872     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
26873     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26874     * @endcode
26875     *
26876     * @see elm_calendar_mark_add()
26877     *
26878     * @ingroup Calendar
26879     */
26880    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26881
26882    /**
26883     * Set a day text color to the same that represents Weekdays.
26884     *
26885     * @param obj The calendar object
26886     * @param pos The text position. Position is the cell counter, from left
26887     * to right, up to down. It starts on 0 and ends on 41.
26888     *
26889     * @deprecated use elm_calendar_mark_add() instead like:
26890     *
26891     * @code
26892     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
26893     *
26894     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
26895     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26896     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
26897     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26898     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
26899     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26900     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
26901     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26902     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
26903     * @endcode
26904     *
26905     * @see elm_calendar_mark_add()
26906     *
26907     * @ingroup Calendar
26908     */
26909    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26910
26911    /**
26912     * Set the interval on time updates for an user mouse button hold
26913     * on calendar widgets' month selection.
26914     *
26915     * @param obj The calendar object
26916     * @param interval The (first) interval value in seconds
26917     *
26918     * This interval value is @b decreased while the user holds the
26919     * mouse pointer either selecting next or previous month.
26920     *
26921     * This helps the user to get to a given month distant from the
26922     * current one easier/faster, as it will start to change quicker and
26923     * quicker on mouse button holds.
26924     *
26925     * The calculation for the next change interval value, starting from
26926     * the one set with this call, is the previous interval divided by
26927     * 1.05, so it decreases a little bit.
26928     *
26929     * The default starting interval value for automatic changes is
26930     * @b 0.85 seconds.
26931     *
26932     * @see elm_calendar_interval_get()
26933     *
26934     * @ingroup Calendar
26935     */
26936    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26937
26938    /**
26939     * Get the interval on time updates for an user mouse button hold
26940     * on calendar widgets' month selection.
26941     *
26942     * @param obj The calendar object
26943     * @return The (first) interval value, in seconds, set on it
26944     *
26945     * @see elm_calendar_interval_set() for more details
26946     *
26947     * @ingroup Calendar
26948     */
26949    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26950
26951    /**
26952     * @}
26953     */
26954
26955    /**
26956     * @defgroup Diskselector Diskselector
26957     * @ingroup Elementary
26958     *
26959     * @image html img/widget/diskselector/preview-00.png
26960     * @image latex img/widget/diskselector/preview-00.eps
26961     *
26962     * A diskselector is a kind of list widget. It scrolls horizontally,
26963     * and can contain label and icon objects. Three items are displayed
26964     * with the selected one in the middle.
26965     *
26966     * It can act like a circular list with round mode and labels can be
26967     * reduced for a defined length for side items.
26968     *
26969     * Smart callbacks one can listen to:
26970     * - "selected" - when item is selected, i.e. scroller stops.
26971     *
26972     * Available styles for it:
26973     * - @c "default"
26974     *
26975     * List of examples:
26976     * @li @ref diskselector_example_01
26977     * @li @ref diskselector_example_02
26978     */
26979
26980    /**
26981     * @addtogroup Diskselector
26982     * @{
26983     */
26984
26985    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(). */
26986
26987    /**
26988     * Add a new diskselector widget to the given parent Elementary
26989     * (container) object.
26990     *
26991     * @param parent The parent object.
26992     * @return a new diskselector widget handle or @c NULL, on errors.
26993     *
26994     * This function inserts a new diskselector widget on the canvas.
26995     *
26996     * @ingroup Diskselector
26997     */
26998    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26999
27000    /**
27001     * Enable or disable round mode.
27002     *
27003     * @param obj The diskselector object.
27004     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
27005     * disable it.
27006     *
27007     * Disabled by default. If round mode is enabled the items list will
27008     * work like a circle list, so when the user reaches the last item,
27009     * the first one will popup.
27010     *
27011     * @see elm_diskselector_round_get()
27012     *
27013     * @ingroup Diskselector
27014     */
27015    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
27016
27017    /**
27018     * Get a value whether round mode is enabled or not.
27019     *
27020     * @see elm_diskselector_round_set() for details.
27021     *
27022     * @param obj The diskselector object.
27023     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
27024     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
27025     *
27026     * @ingroup Diskselector
27027     */
27028    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27029
27030    /**
27031     * Get the side labels max length.
27032     *
27033     * @deprecated use elm_diskselector_side_label_length_get() instead:
27034     *
27035     * @param obj The diskselector object.
27036     * @return The max length defined for side labels, or 0 if not a valid
27037     * diskselector.
27038     *
27039     * @ingroup Diskselector
27040     */
27041    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27042
27043    /**
27044     * Set the side labels max length.
27045     *
27046     * @deprecated use elm_diskselector_side_label_length_set() instead:
27047     *
27048     * @param obj The diskselector object.
27049     * @param len The max length defined for side labels.
27050     *
27051     * @ingroup Diskselector
27052     */
27053    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27054
27055    /**
27056     * Get the side labels max length.
27057     *
27058     * @see elm_diskselector_side_label_length_set() for details.
27059     *
27060     * @param obj The diskselector object.
27061     * @return The max length defined for side labels, or 0 if not a valid
27062     * diskselector.
27063     *
27064     * @ingroup Diskselector
27065     */
27066    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27067
27068    /**
27069     * Set the side labels max length.
27070     *
27071     * @param obj The diskselector object.
27072     * @param len The max length defined for side labels.
27073     *
27074     * Length is the number of characters of items' label that will be
27075     * visible when it's set on side positions. It will just crop
27076     * the string after defined size. E.g.:
27077     *
27078     * An item with label "January" would be displayed on side position as
27079     * "Jan" if max length is set to 3, or "Janu", if this property
27080     * is set to 4.
27081     *
27082     * When it's selected, the entire label will be displayed, except for
27083     * width restrictions. In this case label will be cropped and "..."
27084     * will be concatenated.
27085     *
27086     * Default side label max length is 3.
27087     *
27088     * This property will be applyed over all items, included before or
27089     * later this function call.
27090     *
27091     * @ingroup Diskselector
27092     */
27093    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27094
27095    /**
27096     * Set the number of items to be displayed.
27097     *
27098     * @param obj The diskselector object.
27099     * @param num The number of items the diskselector will display.
27100     *
27101     * Default value is 3, and also it's the minimun. If @p num is less
27102     * than 3, it will be set to 3.
27103     *
27104     * Also, it can be set on theme, using data item @c display_item_num
27105     * on group "elm/diskselector/item/X", where X is style set.
27106     * E.g.:
27107     *
27108     * group { name: "elm/diskselector/item/X";
27109     * data {
27110     *     item: "display_item_num" "5";
27111     *     }
27112     *
27113     * @ingroup Diskselector
27114     */
27115    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
27116
27117    /**
27118     * Get the number of items in the diskselector object.
27119     *
27120     * @param obj The diskselector object.
27121     *
27122     * @ingroup Diskselector
27123     */
27124    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27125
27126    /**
27127     * Set bouncing behaviour when the scrolled content reaches an edge.
27128     *
27129     * Tell the internal scroller object whether it should bounce or not
27130     * when it reaches the respective edges for each axis.
27131     *
27132     * @param obj The diskselector object.
27133     * @param h_bounce Whether to bounce or not in the horizontal axis.
27134     * @param v_bounce Whether to bounce or not in the vertical axis.
27135     *
27136     * @see elm_scroller_bounce_set()
27137     *
27138     * @ingroup Diskselector
27139     */
27140    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
27141
27142    /**
27143     * Get the bouncing behaviour of the internal scroller.
27144     *
27145     * Get whether the internal scroller should bounce when the edge of each
27146     * axis is reached scrolling.
27147     *
27148     * @param obj The diskselector object.
27149     * @param h_bounce Pointer where to store the bounce state of the horizontal
27150     * axis.
27151     * @param v_bounce Pointer where to store the bounce state of the vertical
27152     * axis.
27153     *
27154     * @see elm_scroller_bounce_get()
27155     * @see elm_diskselector_bounce_set()
27156     *
27157     * @ingroup Diskselector
27158     */
27159    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
27160
27161    /**
27162     * Get the scrollbar policy.
27163     *
27164     * @see elm_diskselector_scroller_policy_get() for details.
27165     *
27166     * @param obj The diskselector object.
27167     * @param policy_h Pointer where to store horizontal scrollbar policy.
27168     * @param policy_v Pointer where to store vertical scrollbar policy.
27169     *
27170     * @ingroup Diskselector
27171     */
27172    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);
27173
27174    /**
27175     * Set the scrollbar policy.
27176     *
27177     * @param obj The diskselector object.
27178     * @param policy_h Horizontal scrollbar policy.
27179     * @param policy_v Vertical scrollbar policy.
27180     *
27181     * This sets the scrollbar visibility policy for the given scroller.
27182     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
27183     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
27184     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
27185     * This applies respectively for the horizontal and vertical scrollbars.
27186     *
27187     * The both are disabled by default, i.e., are set to
27188     * #ELM_SCROLLER_POLICY_OFF.
27189     *
27190     * @ingroup Diskselector
27191     */
27192    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
27193
27194    /**
27195     * Remove all diskselector's items.
27196     *
27197     * @param obj The diskselector object.
27198     *
27199     * @see elm_diskselector_item_del()
27200     * @see elm_diskselector_item_append()
27201     *
27202     * @ingroup Diskselector
27203     */
27204    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27205
27206    /**
27207     * Get a list of all the diskselector items.
27208     *
27209     * @param obj The diskselector object.
27210     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
27211     * or @c NULL on failure.
27212     *
27213     * @see elm_diskselector_item_append()
27214     * @see elm_diskselector_item_del()
27215     * @see elm_diskselector_clear()
27216     *
27217     * @ingroup Diskselector
27218     */
27219    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27220
27221    /**
27222     * Appends a new item to the diskselector object.
27223     *
27224     * @param obj The diskselector object.
27225     * @param label The label of the diskselector item.
27226     * @param icon The icon object to use at left side of the item. An
27227     * icon can be any Evas object, but usually it is an icon created
27228     * with elm_icon_add().
27229     * @param func The function to call when the item is selected.
27230     * @param data The data to associate with the item for related callbacks.
27231     *
27232     * @return The created item or @c NULL upon failure.
27233     *
27234     * A new item will be created and appended to the diskselector, i.e., will
27235     * be set as last item. Also, if there is no selected item, it will
27236     * be selected. This will always happens for the first appended item.
27237     *
27238     * If no icon is set, label will be centered on item position, otherwise
27239     * the icon will be placed at left of the label, that will be shifted
27240     * to the right.
27241     *
27242     * Items created with this method can be deleted with
27243     * elm_diskselector_item_del().
27244     *
27245     * Associated @p data can be properly freed when item is deleted if a
27246     * callback function is set with elm_diskselector_item_del_cb_set().
27247     *
27248     * If a function is passed as argument, it will be called everytime this item
27249     * is selected, i.e., the user stops the diskselector with this
27250     * item on center position. If such function isn't needed, just passing
27251     * @c NULL as @p func is enough. The same should be done for @p data.
27252     *
27253     * Simple example (with no function callback or data associated):
27254     * @code
27255     * disk = elm_diskselector_add(win);
27256     * ic = elm_icon_add(win);
27257     * elm_icon_file_set(ic, "path/to/image", NULL);
27258     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27259     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
27260     * @endcode
27261     *
27262     * @see elm_diskselector_item_del()
27263     * @see elm_diskselector_item_del_cb_set()
27264     * @see elm_diskselector_clear()
27265     * @see elm_icon_add()
27266     *
27267     * @ingroup Diskselector
27268     */
27269    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);
27270
27271
27272    /**
27273     * Delete them item from the diskselector.
27274     *
27275     * @param it The item of diskselector to be deleted.
27276     *
27277     * If deleting all diskselector items is required, elm_diskselector_clear()
27278     * should be used instead of getting items list and deleting each one.
27279     *
27280     * @see elm_diskselector_clear()
27281     * @see elm_diskselector_item_append()
27282     * @see elm_diskselector_item_del_cb_set()
27283     *
27284     * @ingroup Diskselector
27285     */
27286    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27287
27288    /**
27289     * Set the function called when a diskselector item is freed.
27290     *
27291     * @param it The item to set the callback on
27292     * @param func The function called
27293     *
27294     * If there is a @p func, then it will be called prior item's memory release.
27295     * That will be called with the following arguments:
27296     * @li item's data;
27297     * @li item's Evas object;
27298     * @li item itself;
27299     *
27300     * This way, a data associated to a diskselector item could be properly
27301     * freed.
27302     *
27303     * @ingroup Diskselector
27304     */
27305    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
27306
27307    /**
27308     * Get the data associated to the item.
27309     *
27310     * @param it The diskselector item
27311     * @return The data associated to @p it
27312     *
27313     * The return value is a pointer to data associated to @p item when it was
27314     * created, with function elm_diskselector_item_append(). If no data
27315     * was passed as argument, it will return @c NULL.
27316     *
27317     * @see elm_diskselector_item_append()
27318     *
27319     * @ingroup Diskselector
27320     */
27321    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27322
27323    /**
27324     * Set the icon associated to the item.
27325     *
27326     * @param it The diskselector item
27327     * @param icon The icon object to associate with @p it
27328     *
27329     * The icon object to use at left side of the item. An
27330     * icon can be any Evas object, but usually it is an icon created
27331     * with elm_icon_add().
27332     *
27333     * Once the icon object is set, a previously set one will be deleted.
27334     * @warning Setting the same icon for two items will cause the icon to
27335     * dissapear from the first item.
27336     *
27337     * If an icon was passed as argument on item creation, with function
27338     * elm_diskselector_item_append(), it will be already
27339     * associated to the item.
27340     *
27341     * @see elm_diskselector_item_append()
27342     * @see elm_diskselector_item_icon_get()
27343     *
27344     * @ingroup Diskselector
27345     */
27346    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
27347
27348    /**
27349     * Get the icon associated to the item.
27350     *
27351     * @param it The diskselector item
27352     * @return The icon associated to @p it
27353     *
27354     * The return value is a pointer to the icon associated to @p item when it was
27355     * created, with function elm_diskselector_item_append(), or later
27356     * with function elm_diskselector_item_icon_set. If no icon
27357     * was passed as argument, it will return @c NULL.
27358     *
27359     * @see elm_diskselector_item_append()
27360     * @see elm_diskselector_item_icon_set()
27361     *
27362     * @ingroup Diskselector
27363     */
27364    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27365
27366    /**
27367     * Set the label of item.
27368     *
27369     * @param it The item of diskselector.
27370     * @param label The label of item.
27371     *
27372     * The label to be displayed by the item.
27373     *
27374     * If no icon is set, label will be centered on item position, otherwise
27375     * the icon will be placed at left of the label, that will be shifted
27376     * to the right.
27377     *
27378     * An item with label "January" would be displayed on side position as
27379     * "Jan" if max length is set to 3 with function
27380     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
27381     * is set to 4.
27382     *
27383     * When this @p item is selected, the entire label will be displayed,
27384     * except for width restrictions.
27385     * In this case label will be cropped and "..." will be concatenated,
27386     * but only for display purposes. It will keep the entire string, so
27387     * if diskselector is resized the remaining characters will be displayed.
27388     *
27389     * If a label was passed as argument on item creation, with function
27390     * elm_diskselector_item_append(), it will be already
27391     * displayed by the item.
27392     *
27393     * @see elm_diskselector_side_label_lenght_set()
27394     * @see elm_diskselector_item_label_get()
27395     * @see elm_diskselector_item_append()
27396     *
27397     * @ingroup Diskselector
27398     */
27399    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
27400
27401    /**
27402     * Get the label of item.
27403     *
27404     * @param it The item of diskselector.
27405     * @return The label of item.
27406     *
27407     * The return value is a pointer to the label associated to @p item when it was
27408     * created, with function elm_diskselector_item_append(), or later
27409     * with function elm_diskselector_item_label_set. If no label
27410     * was passed as argument, it will return @c NULL.
27411     *
27412     * @see elm_diskselector_item_label_set() for more details.
27413     * @see elm_diskselector_item_append()
27414     *
27415     * @ingroup Diskselector
27416     */
27417    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27418
27419    /**
27420     * Get the selected item.
27421     *
27422     * @param obj The diskselector object.
27423     * @return The selected diskselector item.
27424     *
27425     * The selected item can be unselected with function
27426     * elm_diskselector_item_selected_set(), and the first item of
27427     * diskselector will be selected.
27428     *
27429     * The selected item always will be centered on diskselector, with
27430     * full label displayed, i.e., max lenght set to side labels won't
27431     * apply on the selected item. More details on
27432     * elm_diskselector_side_label_length_set().
27433     *
27434     * @ingroup Diskselector
27435     */
27436    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27437
27438    /**
27439     * Set the selected state of an item.
27440     *
27441     * @param it The diskselector item
27442     * @param selected The selected state
27443     *
27444     * This sets the selected state of the given item @p it.
27445     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27446     *
27447     * If a new item is selected the previosly selected will be unselected.
27448     * Previoulsy selected item can be get with function
27449     * elm_diskselector_selected_item_get().
27450     *
27451     * If the item @p it is unselected, the first item of diskselector will
27452     * be selected.
27453     *
27454     * Selected items will be visible on center position of diskselector.
27455     * So if it was on another position before selected, or was invisible,
27456     * diskselector will animate items until the selected item reaches center
27457     * position.
27458     *
27459     * @see elm_diskselector_item_selected_get()
27460     * @see elm_diskselector_selected_item_get()
27461     *
27462     * @ingroup Diskselector
27463     */
27464    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
27465
27466    /*
27467     * Get whether the @p item is selected or not.
27468     *
27469     * @param it The diskselector item.
27470     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
27471     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
27472     *
27473     * @see elm_diskselector_selected_item_set() for details.
27474     * @see elm_diskselector_item_selected_get()
27475     *
27476     * @ingroup Diskselector
27477     */
27478    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27479
27480    /**
27481     * Get the first item of the diskselector.
27482     *
27483     * @param obj The diskselector object.
27484     * @return The first item, or @c NULL if none.
27485     *
27486     * The list of items follows append order. So it will return the first
27487     * item appended to the widget that wasn't deleted.
27488     *
27489     * @see elm_diskselector_item_append()
27490     * @see elm_diskselector_items_get()
27491     *
27492     * @ingroup Diskselector
27493     */
27494    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27495
27496    /**
27497     * Get the last item of the diskselector.
27498     *
27499     * @param obj The diskselector object.
27500     * @return The last item, or @c NULL if none.
27501     *
27502     * The list of items follows append order. So it will return last first
27503     * item appended to the widget that wasn't deleted.
27504     *
27505     * @see elm_diskselector_item_append()
27506     * @see elm_diskselector_items_get()
27507     *
27508     * @ingroup Diskselector
27509     */
27510    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27511
27512    /**
27513     * Get the item before @p item in diskselector.
27514     *
27515     * @param it The diskselector item.
27516     * @return The item before @p item, or @c NULL if none or on failure.
27517     *
27518     * The list of items follows append order. So it will return item appended
27519     * just before @p item and that wasn't deleted.
27520     *
27521     * If it is the first item, @c NULL will be returned.
27522     * First item can be get by elm_diskselector_first_item_get().
27523     *
27524     * @see elm_diskselector_item_append()
27525     * @see elm_diskselector_items_get()
27526     *
27527     * @ingroup Diskselector
27528     */
27529    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27530
27531    /**
27532     * Get the item after @p item in diskselector.
27533     *
27534     * @param it The diskselector item.
27535     * @return The item after @p item, or @c NULL if none or on failure.
27536     *
27537     * The list of items follows append order. So it will return item appended
27538     * just after @p item and that wasn't deleted.
27539     *
27540     * If it is the last item, @c NULL will be returned.
27541     * Last item can be get by elm_diskselector_last_item_get().
27542     *
27543     * @see elm_diskselector_item_append()
27544     * @see elm_diskselector_items_get()
27545     *
27546     * @ingroup Diskselector
27547     */
27548    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27549
27550    /**
27551     * Set the text to be shown in the diskselector item.
27552     *
27553     * @param item Target item
27554     * @param text The text to set in the content
27555     *
27556     * Setup the text as tooltip to object. The item can have only one tooltip,
27557     * so any previous tooltip data is removed.
27558     *
27559     * @see elm_object_tooltip_text_set() for more details.
27560     *
27561     * @ingroup Diskselector
27562     */
27563    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
27564
27565    /**
27566     * Set the content to be shown in the tooltip item.
27567     *
27568     * Setup the tooltip to item. The item can have only one tooltip,
27569     * so any previous tooltip data is removed. @p func(with @p data) will
27570     * be called every time that need show the tooltip and it should
27571     * return a valid Evas_Object. This object is then managed fully by
27572     * tooltip system and is deleted when the tooltip is gone.
27573     *
27574     * @param item the diskselector item being attached a tooltip.
27575     * @param func the function used to create the tooltip contents.
27576     * @param data what to provide to @a func as callback data/context.
27577     * @param del_cb called when data is not needed anymore, either when
27578     *        another callback replaces @p func, the tooltip is unset with
27579     *        elm_diskselector_item_tooltip_unset() or the owner @a item
27580     *        dies. This callback receives as the first parameter the
27581     *        given @a data, and @c event_info is the item.
27582     *
27583     * @see elm_object_tooltip_content_cb_set() for more details.
27584     *
27585     * @ingroup Diskselector
27586     */
27587    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);
27588
27589    /**
27590     * Unset tooltip from item.
27591     *
27592     * @param item diskselector item to remove previously set tooltip.
27593     *
27594     * Remove tooltip from item. The callback provided as del_cb to
27595     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
27596     * it is not used anymore.
27597     *
27598     * @see elm_object_tooltip_unset() for more details.
27599     * @see elm_diskselector_item_tooltip_content_cb_set()
27600     *
27601     * @ingroup Diskselector
27602     */
27603    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27604
27605    /**
27606     * Sets a different style for this item tooltip.
27607     *
27608     * @note before you set a style you should define a tooltip with
27609     *       elm_diskselector_item_tooltip_content_cb_set() or
27610     *       elm_diskselector_item_tooltip_text_set()
27611     *
27612     * @param item diskselector item with tooltip already set.
27613     * @param style the theme style to use (default, transparent, ...)
27614     *
27615     * @see elm_object_tooltip_style_set() for more details.
27616     *
27617     * @ingroup Diskselector
27618     */
27619    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27620
27621    /**
27622     * Get the style for this item tooltip.
27623     *
27624     * @param item diskselector item with tooltip already set.
27625     * @return style the theme style in use, defaults to "default". If the
27626     *         object does not have a tooltip set, then NULL is returned.
27627     *
27628     * @see elm_object_tooltip_style_get() for more details.
27629     * @see elm_diskselector_item_tooltip_style_set()
27630     *
27631     * @ingroup Diskselector
27632     */
27633    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27634
27635    /**
27636     * Set the cursor to be shown when mouse is over the diskselector item
27637     *
27638     * @param item Target item
27639     * @param cursor the cursor name to be used.
27640     *
27641     * @see elm_object_cursor_set() for more details.
27642     *
27643     * @ingroup Diskselector
27644     */
27645    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
27646
27647    /**
27648     * Get the cursor to be shown when mouse is over the diskselector item
27649     *
27650     * @param item diskselector item with cursor already set.
27651     * @return the cursor name.
27652     *
27653     * @see elm_object_cursor_get() for more details.
27654     * @see elm_diskselector_cursor_set()
27655     *
27656     * @ingroup Diskselector
27657     */
27658    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27659
27660    /**
27661     * Unset the cursor to be shown when mouse is over the diskselector item
27662     *
27663     * @param item Target item
27664     *
27665     * @see elm_object_cursor_unset() for more details.
27666     * @see elm_diskselector_cursor_set()
27667     *
27668     * @ingroup Diskselector
27669     */
27670    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27671
27672    /**
27673     * Sets a different style for this item cursor.
27674     *
27675     * @note before you set a style you should define a cursor with
27676     *       elm_diskselector_item_cursor_set()
27677     *
27678     * @param item diskselector item with cursor already set.
27679     * @param style the theme style to use (default, transparent, ...)
27680     *
27681     * @see elm_object_cursor_style_set() for more details.
27682     *
27683     * @ingroup Diskselector
27684     */
27685    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27686
27687    /**
27688     * Get the style for this item cursor.
27689     *
27690     * @param item diskselector item with cursor already set.
27691     * @return style the theme style in use, defaults to "default". If the
27692     *         object does not have a cursor set, then @c NULL is returned.
27693     *
27694     * @see elm_object_cursor_style_get() for more details.
27695     * @see elm_diskselector_item_cursor_style_set()
27696     *
27697     * @ingroup Diskselector
27698     */
27699    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27700
27701
27702    /**
27703     * Set if the cursor set should be searched on the theme or should use
27704     * the provided by the engine, only.
27705     *
27706     * @note before you set if should look on theme you should define a cursor
27707     * with elm_diskselector_item_cursor_set().
27708     * By default it will only look for cursors provided by the engine.
27709     *
27710     * @param item widget item with cursor already set.
27711     * @param engine_only boolean to define if cursors set with
27712     * elm_diskselector_item_cursor_set() should be searched only
27713     * between cursors provided by the engine or searched on widget's
27714     * theme as well.
27715     *
27716     * @see elm_object_cursor_engine_only_set() for more details.
27717     *
27718     * @ingroup Diskselector
27719     */
27720    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
27721
27722    /**
27723     * Get the cursor engine only usage for this item cursor.
27724     *
27725     * @param item widget item with cursor already set.
27726     * @return engine_only boolean to define it cursors should be looked only
27727     * between the provided by the engine or searched on widget's theme as well.
27728     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
27729     *
27730     * @see elm_object_cursor_engine_only_get() for more details.
27731     * @see elm_diskselector_item_cursor_engine_only_set()
27732     *
27733     * @ingroup Diskselector
27734     */
27735    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27736
27737    /**
27738     * @}
27739     */
27740
27741    /**
27742     * @defgroup Colorselector Colorselector
27743     *
27744     * @{
27745     *
27746     * @image html img/widget/colorselector/preview-00.png
27747     * @image latex img/widget/colorselector/preview-00.eps
27748     *
27749     * @brief Widget for user to select a color.
27750     *
27751     * Signals that you can add callbacks for are:
27752     * "changed" - When the color value changes(event_info is NULL).
27753     *
27754     * See @ref tutorial_colorselector.
27755     */
27756    /**
27757     * @brief Add a new colorselector to the parent
27758     *
27759     * @param parent The parent object
27760     * @return The new object or NULL if it cannot be created
27761     *
27762     * @ingroup Colorselector
27763     */
27764    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27765    /**
27766     * Set a color for the colorselector
27767     *
27768     * @param obj   Colorselector object
27769     * @param r     r-value of color
27770     * @param g     g-value of color
27771     * @param b     b-value of color
27772     * @param a     a-value of color
27773     *
27774     * @ingroup Colorselector
27775     */
27776    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
27777    /**
27778     * Get a color from the colorselector
27779     *
27780     * @param obj   Colorselector object
27781     * @param r     integer pointer for r-value of color
27782     * @param g     integer pointer for g-value of color
27783     * @param b     integer pointer for b-value of color
27784     * @param a     integer pointer for a-value of color
27785     *
27786     * @ingroup Colorselector
27787     */
27788    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
27789    /**
27790     * @}
27791     */
27792
27793    /**
27794     * @defgroup Ctxpopup Ctxpopup
27795     *
27796     * @image html img/widget/ctxpopup/preview-00.png
27797     * @image latex img/widget/ctxpopup/preview-00.eps
27798     *
27799     * @brief Context popup widet.
27800     *
27801     * A ctxpopup is a widget that, when shown, pops up a list of items.
27802     * It automatically chooses an area inside its parent object's view
27803     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
27804     * optimally fit into it. In the default theme, it will also point an
27805     * arrow to it's top left position at the time one shows it. Ctxpopup
27806     * items have a label and/or an icon. It is intended for a small
27807     * number of items (hence the use of list, not genlist).
27808     *
27809     * @note Ctxpopup is a especialization of @ref Hover.
27810     *
27811     * Signals that you can add callbacks for are:
27812     * "dismissed" - the ctxpopup was dismissed
27813     *
27814     * Default contents parts of the ctxpopup widget that you can use for are:
27815     * @li "default" - A content of the ctxpopup
27816     *
27817     * Default contents parts of the ctxpopup items that you can use for are:
27818     * @li "icon" - An icon in the title area
27819     *
27820     * Default text parts of the ctxpopup items that you can use for are:
27821     * @li "default" - Title label in the title area
27822     *
27823     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
27824     * @{
27825     */
27826
27827    /**
27828     * @addtogroup Ctxpopup
27829     * @{
27830     */
27831
27832    typedef enum _Elm_Ctxpopup_Direction
27833      {
27834         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
27835                                           area */
27836         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
27837                                            the clicked area */
27838         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
27839                                           the clicked area */
27840         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
27841                                         area */
27842         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
27843      } Elm_Ctxpopup_Direction;
27844
27845    /**
27846     * @brief Add a new Ctxpopup object to the parent.
27847     *
27848     * @param parent Parent object
27849     * @return New object or @c NULL, if it cannot be created
27850     *
27851     * @ingroup Ctxpopup
27852     */
27853    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27854
27855    /**
27856     * @brief Set the Ctxpopup's parent
27857     *
27858     * @param obj The ctxpopup object
27859     * @param area The parent to use
27860     *
27861     * Set the parent object.
27862     *
27863     * @note elm_ctxpopup_add() will automatically call this function
27864     * with its @c parent argument.
27865     *
27866     * @see elm_ctxpopup_add()
27867     * @see elm_hover_parent_set()
27868     *
27869     * @ingroup Ctxpopup
27870     */
27871    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
27872
27873    /**
27874     * @brief Get the Ctxpopup's parent
27875     *
27876     * @param obj The ctxpopup object
27877     *
27878     * @see elm_ctxpopup_hover_parent_set() for more information
27879     *
27880     * @ingroup Ctxpopup
27881     */
27882    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27883
27884    /**
27885     * @brief Clear all items in the given ctxpopup object.
27886     *
27887     * @param obj Ctxpopup object
27888     *
27889     * @ingroup Ctxpopup
27890     */
27891    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27892
27893    /**
27894     * @brief Change the ctxpopup's orientation to horizontal or vertical.
27895     *
27896     * @param obj Ctxpopup object
27897     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
27898     *
27899     * @ingroup Ctxpopup
27900     */
27901    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
27902
27903    /**
27904     * @brief Get the value of current ctxpopup object's orientation.
27905     *
27906     * @param obj Ctxpopup object
27907     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
27908     *
27909     * @see elm_ctxpopup_horizontal_set()
27910     *
27911     * @ingroup Ctxpopup
27912     */
27913    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27914
27915    /**
27916     * @brief Add a new item to a ctxpopup object.
27917     *
27918     * @param obj Ctxpopup object
27919     * @param icon Icon to be set on new item
27920     * @param label The Label of the new item
27921     * @param func Convenience function called when item selected
27922     * @param data Data passed to @p func
27923     * @return A handle to the item added or @c NULL, on errors
27924     *
27925     * @warning Ctxpopup can't hold both an item list and a content at the same
27926     * time. When an item is added, any previous content will be removed.
27927     *
27928     * @see elm_ctxpopup_content_set()
27929     *
27930     * @ingroup Ctxpopup
27931     */
27932    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);
27933
27934    /**
27935     * @brief Delete the given item in a ctxpopup object.
27936     *
27937     * @param it Ctxpopup item to be deleted
27938     *
27939     * @see elm_ctxpopup_item_append()
27940     *
27941     * @ingroup Ctxpopup
27942     */
27943    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27944
27945    /**
27946     * @brief Set the ctxpopup item's state as disabled or enabled.
27947     *
27948     * @param it Ctxpopup item to be enabled/disabled
27949     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
27950     *
27951     * When disabled the item is greyed out to indicate it's state.
27952     * @deprecated use elm_object_item_disabled_set() instead
27953     *
27954     * @ingroup Ctxpopup
27955     */
27956    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
27957
27958    /**
27959     * @brief Get the ctxpopup item's disabled/enabled state.
27960     *
27961     * @param it Ctxpopup item to be enabled/disabled
27962     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
27963     *
27964     * @see elm_ctxpopup_item_disabled_set()
27965     * @deprecated use elm_object_item_disabled_get() instead
27966     *
27967     * @ingroup Ctxpopup
27968     */
27969    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27970
27971    /**
27972     * @brief Get the icon object for the given ctxpopup item.
27973     *
27974     * @param it Ctxpopup item
27975     * @return icon object or @c NULL, if the item does not have icon or an error
27976     * occurred
27977     *
27978     * @see elm_ctxpopup_item_append()
27979     * @see elm_ctxpopup_item_icon_set()
27980     *
27981     * @deprecated use elm_object_item_part_content_get() instead
27982     *
27983     * @ingroup Ctxpopup
27984     */
27985    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27986
27987    /**
27988     * @brief Sets the side icon associated with the ctxpopup item
27989     *
27990     * @param it Ctxpopup item
27991     * @param icon Icon object to be set
27992     *
27993     * Once the icon object is set, a previously set one will be deleted.
27994     * @warning Setting the same icon for two items will cause the icon to
27995     * dissapear from the first item.
27996     *
27997     * @see elm_ctxpopup_item_append()
27998     *
27999     * @deprecated use elm_object_item_part_content_set() instead
28000     *
28001     * @ingroup Ctxpopup
28002     */
28003    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28004
28005    /**
28006     * @brief Get the label for the given ctxpopup item.
28007     *
28008     * @param it Ctxpopup item
28009     * @return label string or @c NULL, if the item does not have label or an
28010     * error occured
28011     *
28012     * @see elm_ctxpopup_item_append()
28013     * @see elm_ctxpopup_item_label_set()
28014     *
28015     * @deprecated use elm_object_item_text_get() instead
28016     *
28017     * @ingroup Ctxpopup
28018     */
28019    EINA_DEPRECATED EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28020
28021    /**
28022     * @brief (Re)set the label on the given ctxpopup item.
28023     *
28024     * @param it Ctxpopup item
28025     * @param label String to set as label
28026     *
28027     * @deprecated use elm_object_item_text_set() instead
28028     *
28029     * @ingroup Ctxpopup
28030     */
28031    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
28032
28033    /**
28034     * @brief Set an elm widget as the content of the ctxpopup.
28035     *
28036     * @param obj Ctxpopup object
28037     * @param content Content to be swallowed
28038     *
28039     * If the content object is already set, a previous one will bedeleted. If
28040     * you want to keep that old content object, use the
28041     * elm_ctxpopup_content_unset() function.
28042     *
28043     * @warning Ctxpopup can't hold both a item list and a content at the same
28044     * time. When a content is set, any previous items will be removed.
28045     *
28046     * @deprecated use elm_object_content_set() instead
28047     *
28048     * @ingroup Ctxpopup
28049     */
28050    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
28051
28052    /**
28053     * @brief Unset the ctxpopup content
28054     *
28055     * @param obj Ctxpopup object
28056     * @return The content that was being used
28057     *
28058     * Unparent and return the content object which was set for this widget.
28059     *
28060     * @deprecated use elm_object_content_unset()
28061     *
28062     * @see elm_ctxpopup_content_set()
28063     *
28064     * @deprecated use elm_object_content_unset() instead
28065     *
28066     * @ingroup Ctxpopup
28067     */
28068    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
28069
28070    /**
28071     * @brief Set the direction priority of a ctxpopup.
28072     *
28073     * @param obj Ctxpopup object
28074     * @param first 1st priority of direction
28075     * @param second 2nd priority of direction
28076     * @param third 3th priority of direction
28077     * @param fourth 4th priority of direction
28078     *
28079     * This functions gives a chance to user to set the priority of ctxpopup
28080     * showing direction. This doesn't guarantee the ctxpopup will appear in the
28081     * requested direction.
28082     *
28083     * @see Elm_Ctxpopup_Direction
28084     *
28085     * @ingroup Ctxpopup
28086     */
28087    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);
28088
28089    /**
28090     * @brief Get the direction priority of a ctxpopup.
28091     *
28092     * @param obj Ctxpopup object
28093     * @param first 1st priority of direction to be returned
28094     * @param second 2nd priority of direction to be returned
28095     * @param third 3th priority of direction to be returned
28096     * @param fourth 4th priority of direction to be returned
28097     *
28098     * @see elm_ctxpopup_direction_priority_set() for more information.
28099     *
28100     * @ingroup Ctxpopup
28101     */
28102    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);
28103
28104    /**
28105     * @brief Get the current direction of a ctxpopup.
28106     *
28107     * @param obj Ctxpopup object
28108     * @return current direction of a ctxpopup
28109     *
28110     * @warning Once the ctxpopup showed up, the direction would be determined
28111     *
28112     * @ingroup Ctxpopup
28113     */
28114    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28115
28116    /**
28117     * @}
28118     */
28119
28120    /* transit */
28121    /**
28122     *
28123     * @defgroup Transit Transit
28124     * @ingroup Elementary
28125     *
28126     * Transit is designed to apply various animated transition effects to @c
28127     * Evas_Object, such like translation, rotation, etc. For using these
28128     * effects, create an @ref Elm_Transit and add the desired transition effects.
28129     *
28130     * Once the effects are added into transit, they will be automatically
28131     * managed (their callback will be called until the duration is ended, and
28132     * they will be deleted on completion).
28133     *
28134     * Example:
28135     * @code
28136     * Elm_Transit *trans = elm_transit_add();
28137     * elm_transit_object_add(trans, obj);
28138     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
28139     * elm_transit_duration_set(transit, 1);
28140     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
28141     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
28142     * elm_transit_repeat_times_set(transit, 3);
28143     * @endcode
28144     *
28145     * Some transition effects are used to change the properties of objects. They
28146     * are:
28147     * @li @ref elm_transit_effect_translation_add
28148     * @li @ref elm_transit_effect_color_add
28149     * @li @ref elm_transit_effect_rotation_add
28150     * @li @ref elm_transit_effect_wipe_add
28151     * @li @ref elm_transit_effect_zoom_add
28152     * @li @ref elm_transit_effect_resizing_add
28153     *
28154     * Other transition effects are used to make one object disappear and another
28155     * object appear on its old place. These effects are:
28156     *
28157     * @li @ref elm_transit_effect_flip_add
28158     * @li @ref elm_transit_effect_resizable_flip_add
28159     * @li @ref elm_transit_effect_fade_add
28160     * @li @ref elm_transit_effect_blend_add
28161     *
28162     * It's also possible to make a transition chain with @ref
28163     * elm_transit_chain_transit_add.
28164     *
28165     * @warning We strongly recommend to use elm_transit just when edje can not do
28166     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
28167     * animations can be manipulated inside the theme.
28168     *
28169     * List of examples:
28170     * @li @ref transit_example_01_explained
28171     * @li @ref transit_example_02_explained
28172     * @li @ref transit_example_03_c
28173     * @li @ref transit_example_04_c
28174     *
28175     * @{
28176     */
28177
28178    /**
28179     * @enum Elm_Transit_Tween_Mode
28180     *
28181     * The type of acceleration used in the transition.
28182     */
28183    typedef enum
28184      {
28185         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
28186         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
28187                                              over time, then decrease again
28188                                              and stop slowly */
28189         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
28190                                              speed over time */
28191         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
28192                                             over time */
28193      } Elm_Transit_Tween_Mode;
28194
28195    /**
28196     * @enum Elm_Transit_Effect_Flip_Axis
28197     *
28198     * The axis where flip effect should be applied.
28199     */
28200    typedef enum
28201      {
28202         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
28203         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
28204      } Elm_Transit_Effect_Flip_Axis;
28205
28206    /**
28207     * @enum Elm_Transit_Effect_Wipe_Dir
28208     *
28209     * The direction where the wipe effect should occur.
28210     */
28211    typedef enum
28212      {
28213         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
28214         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
28215         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
28216         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
28217      } Elm_Transit_Effect_Wipe_Dir;
28218
28219    /** @enum Elm_Transit_Effect_Wipe_Type
28220     *
28221     * Whether the wipe effect should show or hide the object.
28222     */
28223    typedef enum
28224      {
28225         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
28226                                              animation */
28227         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
28228                                             animation */
28229      } Elm_Transit_Effect_Wipe_Type;
28230
28231    /**
28232     * @typedef Elm_Transit
28233     *
28234     * The Transit created with elm_transit_add(). This type has the information
28235     * about the objects which the transition will be applied, and the
28236     * transition effects that will be used. It also contains info about
28237     * duration, number of repetitions, auto-reverse, etc.
28238     */
28239    typedef struct _Elm_Transit Elm_Transit;
28240    typedef void Elm_Transit_Effect;
28241
28242    /**
28243     * @typedef Elm_Transit_Effect_Transition_Cb
28244     *
28245     * Transition callback called for this effect on each transition iteration.
28246     */
28247    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
28248
28249    /**
28250     * Elm_Transit_Effect_End_Cb
28251     *
28252     * Transition callback called for this effect when the transition is over.
28253     */
28254    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
28255
28256    /**
28257     * Elm_Transit_Del_Cb
28258     *
28259     * A callback called when the transit is deleted.
28260     */
28261    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
28262
28263    /**
28264     * Add new transit.
28265     *
28266     * @note Is not necessary to delete the transit object, it will be deleted at
28267     * the end of its operation.
28268     * @note The transit will start playing when the program enter in the main loop, is not
28269     * necessary to give a start to the transit.
28270     *
28271     * @return The transit object.
28272     *
28273     * @ingroup Transit
28274     */
28275    EAPI Elm_Transit                *elm_transit_add(void);
28276
28277    /**
28278     * Stops the animation and delete the @p transit object.
28279     *
28280     * Call this function if you wants to stop the animation before the duration
28281     * time. Make sure the @p transit object is still alive with
28282     * elm_transit_del_cb_set() function.
28283     * All added effects will be deleted, calling its repective data_free_cb
28284     * functions. The function setted by elm_transit_del_cb_set() will be called.
28285     *
28286     * @see elm_transit_del_cb_set()
28287     *
28288     * @param transit The transit object to be deleted.
28289     *
28290     * @ingroup Transit
28291     * @warning Just call this function if you are sure the transit is alive.
28292     */
28293    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28294
28295    /**
28296     * Add a new effect to the transit.
28297     *
28298     * @note The cb function and the data are the key to the effect. If you try to
28299     * add an already added effect, nothing is done.
28300     * @note After the first addition of an effect in @p transit, if its
28301     * effect list become empty again, the @p transit will be killed by
28302     * elm_transit_del(transit) function.
28303     *
28304     * Exemple:
28305     * @code
28306     * Elm_Transit *transit = elm_transit_add();
28307     * elm_transit_effect_add(transit,
28308     *                        elm_transit_effect_blend_op,
28309     *                        elm_transit_effect_blend_context_new(),
28310     *                        elm_transit_effect_blend_context_free);
28311     * @endcode
28312     *
28313     * @param transit The transit object.
28314     * @param transition_cb The operation function. It is called when the
28315     * animation begins, it is the function that actually performs the animation.
28316     * It is called with the @p data, @p transit and the time progression of the
28317     * animation (a double value between 0.0 and 1.0).
28318     * @param effect The context data of the effect.
28319     * @param end_cb The function to free the context data, it will be called
28320     * at the end of the effect, it must finalize the animation and free the
28321     * @p data.
28322     *
28323     * @ingroup Transit
28324     * @warning The transit free the context data at the and of the transition with
28325     * the data_free_cb function, do not use the context data in another transit.
28326     */
28327    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);
28328
28329    /**
28330     * Delete an added effect.
28331     *
28332     * This function will remove the effect from the @p transit, calling the
28333     * data_free_cb to free the @p data.
28334     *
28335     * @see elm_transit_effect_add()
28336     *
28337     * @note If the effect is not found, nothing is done.
28338     * @note If the effect list become empty, this function will call
28339     * elm_transit_del(transit), that is, it will kill the @p transit.
28340     *
28341     * @param transit The transit object.
28342     * @param transition_cb The operation function.
28343     * @param effect The context data of the effect.
28344     *
28345     * @ingroup Transit
28346     */
28347    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);
28348
28349    /**
28350     * Add new object to apply the effects.
28351     *
28352     * @note After the first addition of an object in @p transit, if its
28353     * object list become empty again, the @p transit will be killed by
28354     * elm_transit_del(transit) function.
28355     * @note If the @p obj belongs to another transit, the @p obj will be
28356     * removed from it and it will only belong to the @p transit. If the old
28357     * transit stays without objects, it will die.
28358     * @note When you add an object into the @p transit, its state from
28359     * evas_object_pass_events_get(obj) is saved, and it is applied when the
28360     * transit ends, if you change this state whith evas_object_pass_events_set()
28361     * after add the object, this state will change again when @p transit stops to
28362     * run.
28363     *
28364     * @param transit The transit object.
28365     * @param obj Object to be animated.
28366     *
28367     * @ingroup Transit
28368     * @warning It is not allowed to add a new object after transit begins to go.
28369     */
28370    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28371
28372    /**
28373     * Removes an added object from the transit.
28374     *
28375     * @note If the @p obj is not in the @p transit, nothing is done.
28376     * @note If the list become empty, this function will call
28377     * elm_transit_del(transit), that is, it will kill the @p transit.
28378     *
28379     * @param transit The transit object.
28380     * @param obj Object to be removed from @p transit.
28381     *
28382     * @ingroup Transit
28383     * @warning It is not allowed to remove objects after transit begins to go.
28384     */
28385    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28386
28387    /**
28388     * Get the objects of the transit.
28389     *
28390     * @param transit The transit object.
28391     * @return a Eina_List with the objects from the transit.
28392     *
28393     * @ingroup Transit
28394     */
28395    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28396
28397    /**
28398     * Enable/disable keeping up the objects states.
28399     * If it is not kept, the objects states will be reset when transition ends.
28400     *
28401     * @note @p transit can not be NULL.
28402     * @note One state includes geometry, color, map data.
28403     *
28404     * @param transit The transit object.
28405     * @param state_keep Keeping or Non Keeping.
28406     *
28407     * @ingroup Transit
28408     */
28409    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
28410
28411    /**
28412     * Get a value whether the objects states will be reset or not.
28413     *
28414     * @note @p transit can not be NULL
28415     *
28416     * @see elm_transit_objects_final_state_keep_set()
28417     *
28418     * @param transit The transit object.
28419     * @return EINA_TRUE means the states of the objects will be reset.
28420     * If @p transit is NULL, EINA_FALSE is returned
28421     *
28422     * @ingroup Transit
28423     */
28424    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28425
28426    /**
28427     * Set the event enabled when transit is operating.
28428     *
28429     * If @p enabled is EINA_TRUE, the objects of the transit will receives
28430     * events from mouse and keyboard during the animation.
28431     * @note When you add an object with elm_transit_object_add(), its state from
28432     * evas_object_pass_events_get(obj) is saved, and it is applied when the
28433     * transit ends, if you change this state with evas_object_pass_events_set()
28434     * after adding the object, this state will change again when @p transit stops
28435     * to run.
28436     *
28437     * @param transit The transit object.
28438     * @param enabled Events are received when enabled is @c EINA_TRUE, and
28439     * ignored otherwise.
28440     *
28441     * @ingroup Transit
28442     */
28443    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
28444
28445    /**
28446     * Get the value of event enabled status.
28447     *
28448     * @see elm_transit_event_enabled_set()
28449     *
28450     * @param transit The Transit object
28451     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
28452     * EINA_FALSE is returned
28453     *
28454     * @ingroup Transit
28455     */
28456    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28457
28458    /**
28459     * Set the user-callback function when the transit is deleted.
28460     *
28461     * @note Using this function twice will overwrite the first function setted.
28462     * @note the @p transit object will be deleted after call @p cb function.
28463     *
28464     * @param transit The transit object.
28465     * @param cb Callback function pointer. This function will be called before
28466     * the deletion of the transit.
28467     * @param data Callback funtion user data. It is the @p op parameter.
28468     *
28469     * @ingroup Transit
28470     */
28471    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
28472
28473    /**
28474     * Set reverse effect automatically.
28475     *
28476     * If auto reverse is setted, after running the effects with the progress
28477     * parameter from 0 to 1, it will call the effecs again with the progress
28478     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
28479     * where the duration was setted with the function elm_transit_add and
28480     * the repeat with the function elm_transit_repeat_times_set().
28481     *
28482     * @param transit The transit object.
28483     * @param reverse EINA_TRUE means the auto_reverse is on.
28484     *
28485     * @ingroup Transit
28486     */
28487    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
28488
28489    /**
28490     * Get if the auto reverse is on.
28491     *
28492     * @see elm_transit_auto_reverse_set()
28493     *
28494     * @param transit The transit object.
28495     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
28496     * EINA_FALSE is returned
28497     *
28498     * @ingroup Transit
28499     */
28500    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28501
28502    /**
28503     * Set the transit repeat count. Effect will be repeated by repeat count.
28504     *
28505     * This function sets the number of repetition the transit will run after
28506     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
28507     * If the @p repeat is a negative number, it will repeat infinite times.
28508     *
28509     * @note If this function is called during the transit execution, the transit
28510     * will run @p repeat times, ignoring the times it already performed.
28511     *
28512     * @param transit The transit object
28513     * @param repeat Repeat count
28514     *
28515     * @ingroup Transit
28516     */
28517    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
28518
28519    /**
28520     * Get the transit repeat count.
28521     *
28522     * @see elm_transit_repeat_times_set()
28523     *
28524     * @param transit The Transit object.
28525     * @return The repeat count. If @p transit is NULL
28526     * 0 is returned
28527     *
28528     * @ingroup Transit
28529     */
28530    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28531
28532    /**
28533     * Set the transit animation acceleration type.
28534     *
28535     * This function sets the tween mode of the transit that can be:
28536     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
28537     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
28538     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
28539     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
28540     *
28541     * @param transit The transit object.
28542     * @param tween_mode The tween type.
28543     *
28544     * @ingroup Transit
28545     */
28546    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
28547
28548    /**
28549     * Get the transit animation acceleration type.
28550     *
28551     * @note @p transit can not be NULL
28552     *
28553     * @param transit The transit object.
28554     * @return The tween type. If @p transit is NULL
28555     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
28556     *
28557     * @ingroup Transit
28558     */
28559    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28560
28561    /**
28562     * Set the transit animation time
28563     *
28564     * @note @p transit can not be NULL
28565     *
28566     * @param transit The transit object.
28567     * @param duration The animation time.
28568     *
28569     * @ingroup Transit
28570     */
28571    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
28572
28573    /**
28574     * Get the transit animation time
28575     *
28576     * @note @p transit can not be NULL
28577     *
28578     * @param transit The transit object.
28579     *
28580     * @return The transit animation time.
28581     *
28582     * @ingroup Transit
28583     */
28584    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28585
28586    /**
28587     * Starts the transition.
28588     * Once this API is called, the transit begins to measure the time.
28589     *
28590     * @note @p transit can not be NULL
28591     *
28592     * @param transit The transit object.
28593     *
28594     * @ingroup Transit
28595     */
28596    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28597
28598    /**
28599     * Pause/Resume the transition.
28600     *
28601     * If you call elm_transit_go again, the transit will be started from the
28602     * beginning, and will be unpaused.
28603     *
28604     * @note @p transit can not be NULL
28605     *
28606     * @param transit The transit object.
28607     * @param paused Whether the transition should be paused or not.
28608     *
28609     * @ingroup Transit
28610     */
28611    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
28612
28613    /**
28614     * Get the value of paused status.
28615     *
28616     * @see elm_transit_paused_set()
28617     *
28618     * @note @p transit can not be NULL
28619     *
28620     * @param transit The transit object.
28621     * @return EINA_TRUE means transition is paused. If @p transit is NULL
28622     * EINA_FALSE is returned
28623     *
28624     * @ingroup Transit
28625     */
28626    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28627
28628    /**
28629     * Get the time progression of the animation (a double value between 0.0 and 1.0).
28630     *
28631     * The value returned is a fraction (current time / total time). It
28632     * represents the progression position relative to the total.
28633     *
28634     * @note @p transit can not be NULL
28635     *
28636     * @param transit The transit object.
28637     *
28638     * @return The time progression value. If @p transit is NULL
28639     * 0 is returned
28640     *
28641     * @ingroup Transit
28642     */
28643    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28644
28645    /**
28646     * Makes the chain relationship between two transits.
28647     *
28648     * @note @p transit can not be NULL. Transit would have multiple chain transits.
28649     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
28650     *
28651     * @param transit The transit object.
28652     * @param chain_transit The chain transit object. This transit will be operated
28653     *        after transit is done.
28654     *
28655     * This function adds @p chain_transit transition to a chain after the @p
28656     * transit, and will be started as soon as @p transit ends. See @ref
28657     * transit_example_02_explained for a full example.
28658     *
28659     * @ingroup Transit
28660     */
28661    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
28662
28663    /**
28664     * Cut off the chain relationship between two transits.
28665     *
28666     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
28667     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
28668     *
28669     * @param transit The transit object.
28670     * @param chain_transit The chain transit object.
28671     *
28672     * This function remove the @p chain_transit transition from the @p transit.
28673     *
28674     * @ingroup Transit
28675     */
28676    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
28677
28678    /**
28679     * Get the current chain transit list.
28680     *
28681     * @note @p transit can not be NULL.
28682     *
28683     * @param transit The transit object.
28684     * @return chain transit list.
28685     *
28686     * @ingroup Transit
28687     */
28688    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
28689
28690    /**
28691     * Add the Resizing Effect to Elm_Transit.
28692     *
28693     * @note This API is one of the facades. It creates resizing effect context
28694     * and add it's required APIs to elm_transit_effect_add.
28695     *
28696     * @see elm_transit_effect_add()
28697     *
28698     * @param transit Transit object.
28699     * @param from_w Object width size when effect begins.
28700     * @param from_h Object height size when effect begins.
28701     * @param to_w Object width size when effect ends.
28702     * @param to_h Object height size when effect ends.
28703     * @return Resizing effect context data.
28704     *
28705     * @ingroup Transit
28706     */
28707    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);
28708
28709    /**
28710     * Add the Translation Effect to Elm_Transit.
28711     *
28712     * @note This API is one of the facades. It creates translation effect context
28713     * and add it's required APIs to elm_transit_effect_add.
28714     *
28715     * @see elm_transit_effect_add()
28716     *
28717     * @param transit Transit object.
28718     * @param from_dx X Position variation when effect begins.
28719     * @param from_dy Y Position variation when effect begins.
28720     * @param to_dx X Position variation when effect ends.
28721     * @param to_dy Y Position variation when effect ends.
28722     * @return Translation effect context data.
28723     *
28724     * @ingroup Transit
28725     * @warning It is highly recommended just create a transit with this effect when
28726     * the window that the objects of the transit belongs has already been created.
28727     * This is because this effect needs the geometry information about the objects,
28728     * and if the window was not created yet, it can get a wrong information.
28729     */
28730    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);
28731
28732    /**
28733     * Add the Zoom Effect to Elm_Transit.
28734     *
28735     * @note This API is one of the facades. It creates zoom effect context
28736     * and add it's required APIs to elm_transit_effect_add.
28737     *
28738     * @see elm_transit_effect_add()
28739     *
28740     * @param transit Transit object.
28741     * @param from_rate Scale rate when effect begins (1 is current rate).
28742     * @param to_rate Scale rate when effect ends.
28743     * @return Zoom effect context data.
28744     *
28745     * @ingroup Transit
28746     * @warning It is highly recommended just create a transit with this effect when
28747     * the window that the objects of the transit belongs has already been created.
28748     * This is because this effect needs the geometry information about the objects,
28749     * and if the window was not created yet, it can get a wrong information.
28750     */
28751    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
28752
28753    /**
28754     * Add the Flip Effect to Elm_Transit.
28755     *
28756     * @note This API is one of the facades. It creates flip effect context
28757     * and add it's required APIs to elm_transit_effect_add.
28758     * @note This effect is applied to each pair of objects in the order they are listed
28759     * in the transit list of objects. The first object in the pair will be the
28760     * "front" object and the second will be the "back" object.
28761     *
28762     * @see elm_transit_effect_add()
28763     *
28764     * @param transit Transit object.
28765     * @param axis Flipping Axis(X or Y).
28766     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28767     * @return Flip effect context data.
28768     *
28769     * @ingroup Transit
28770     * @warning It is highly recommended just create a transit with this effect when
28771     * the window that the objects of the transit belongs has already been created.
28772     * This is because this effect needs the geometry information about the objects,
28773     * and if the window was not created yet, it can get a wrong information.
28774     */
28775    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28776
28777    /**
28778     * Add the Resizable Flip Effect to Elm_Transit.
28779     *
28780     * @note This API is one of the facades. It creates resizable flip effect context
28781     * and add it's required APIs to elm_transit_effect_add.
28782     * @note This effect is applied to each pair of objects in the order they are listed
28783     * in the transit list of objects. The first object in the pair will be the
28784     * "front" object and the second will be the "back" object.
28785     *
28786     * @see elm_transit_effect_add()
28787     *
28788     * @param transit Transit object.
28789     * @param axis Flipping Axis(X or Y).
28790     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28791     * @return Resizable flip effect context data.
28792     *
28793     * @ingroup Transit
28794     * @warning It is highly recommended just create a transit with this effect when
28795     * the window that the objects of the transit belongs has already been created.
28796     * This is because this effect needs the geometry information about the objects,
28797     * and if the window was not created yet, it can get a wrong information.
28798     */
28799    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28800
28801    /**
28802     * Add the Wipe Effect to Elm_Transit.
28803     *
28804     * @note This API is one of the facades. It creates wipe effect context
28805     * and add it's required APIs to elm_transit_effect_add.
28806     *
28807     * @see elm_transit_effect_add()
28808     *
28809     * @param transit Transit object.
28810     * @param type Wipe type. Hide or show.
28811     * @param dir Wipe Direction.
28812     * @return Wipe effect context data.
28813     *
28814     * @ingroup Transit
28815     * @warning It is highly recommended just create a transit with this effect when
28816     * the window that the objects of the transit belongs has already been created.
28817     * This is because this effect needs the geometry information about the objects,
28818     * and if the window was not created yet, it can get a wrong information.
28819     */
28820    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
28821
28822    /**
28823     * Add the Color Effect to Elm_Transit.
28824     *
28825     * @note This API is one of the facades. It creates color effect context
28826     * and add it's required APIs to elm_transit_effect_add.
28827     *
28828     * @see elm_transit_effect_add()
28829     *
28830     * @param transit        Transit object.
28831     * @param  from_r        RGB R when effect begins.
28832     * @param  from_g        RGB G when effect begins.
28833     * @param  from_b        RGB B when effect begins.
28834     * @param  from_a        RGB A when effect begins.
28835     * @param  to_r          RGB R when effect ends.
28836     * @param  to_g          RGB G when effect ends.
28837     * @param  to_b          RGB B when effect ends.
28838     * @param  to_a          RGB A when effect ends.
28839     * @return               Color effect context data.
28840     *
28841     * @ingroup Transit
28842     */
28843    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);
28844
28845    /**
28846     * Add the Fade Effect to Elm_Transit.
28847     *
28848     * @note This API is one of the facades. It creates fade effect context
28849     * and add it's required APIs to elm_transit_effect_add.
28850     * @note This effect is applied to each pair of objects in the order they are listed
28851     * in the transit list of objects. The first object in the pair will be the
28852     * "before" object and the second will be the "after" object.
28853     *
28854     * @see elm_transit_effect_add()
28855     *
28856     * @param transit Transit object.
28857     * @return Fade effect context data.
28858     *
28859     * @ingroup Transit
28860     * @warning It is highly recommended just create a transit with this effect when
28861     * the window that the objects of the transit belongs has already been created.
28862     * This is because this effect needs the color information about the objects,
28863     * and if the window was not created yet, it can get a wrong information.
28864     */
28865    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
28866
28867    /**
28868     * Add the Blend Effect to Elm_Transit.
28869     *
28870     * @note This API is one of the facades. It creates blend effect context
28871     * and add it's required APIs to elm_transit_effect_add.
28872     * @note This effect is applied to each pair of objects in the order they are listed
28873     * in the transit list of objects. The first object in the pair will be the
28874     * "before" object and the second will be the "after" object.
28875     *
28876     * @see elm_transit_effect_add()
28877     *
28878     * @param transit Transit object.
28879     * @return Blend effect context data.
28880     *
28881     * @ingroup Transit
28882     * @warning It is highly recommended just create a transit with this effect when
28883     * the window that the objects of the transit belongs has already been created.
28884     * This is because this effect needs the color information about the objects,
28885     * and if the window was not created yet, it can get a wrong information.
28886     */
28887    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
28888
28889    /**
28890     * Add the Rotation Effect to Elm_Transit.
28891     *
28892     * @note This API is one of the facades. It creates rotation effect context
28893     * and add it's required APIs to elm_transit_effect_add.
28894     *
28895     * @see elm_transit_effect_add()
28896     *
28897     * @param transit Transit object.
28898     * @param from_degree Degree when effect begins.
28899     * @param to_degree Degree when effect is ends.
28900     * @return Rotation effect context data.
28901     *
28902     * @ingroup Transit
28903     * @warning It is highly recommended just create a transit with this effect when
28904     * the window that the objects of the transit belongs has already been created.
28905     * This is because this effect needs the geometry information about the objects,
28906     * and if the window was not created yet, it can get a wrong information.
28907     */
28908    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
28909
28910    /**
28911     * Add the ImageAnimation Effect to Elm_Transit.
28912     *
28913     * @note This API is one of the facades. It creates image animation effect context
28914     * and add it's required APIs to elm_transit_effect_add.
28915     * The @p images parameter is a list images paths. This list and
28916     * its contents will be deleted at the end of the effect by
28917     * elm_transit_effect_image_animation_context_free() function.
28918     *
28919     * Example:
28920     * @code
28921     * char buf[PATH_MAX];
28922     * Eina_List *images = NULL;
28923     * Elm_Transit *transi = elm_transit_add();
28924     *
28925     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
28926     * images = eina_list_append(images, eina_stringshare_add(buf));
28927     *
28928     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
28929     * images = eina_list_append(images, eina_stringshare_add(buf));
28930     * elm_transit_effect_image_animation_add(transi, images);
28931     *
28932     * @endcode
28933     *
28934     * @see elm_transit_effect_add()
28935     *
28936     * @param transit Transit object.
28937     * @param images Eina_List of images file paths. This list and
28938     * its contents will be deleted at the end of the effect by
28939     * elm_transit_effect_image_animation_context_free() function.
28940     * @return Image Animation effect context data.
28941     *
28942     * @ingroup Transit
28943     */
28944    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
28945    /**
28946     * @}
28947     */
28948
28949    typedef struct _Elm_Store                      Elm_Store;
28950    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
28951    typedef struct _Elm_Store_Item                 Elm_Store_Item;
28952    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
28953    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
28954    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
28955    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
28956    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
28957    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
28958    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
28959    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
28960
28961    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
28962    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
28963    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
28964    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
28965
28966    typedef enum
28967      {
28968         ELM_STORE_ITEM_MAPPING_NONE = 0,
28969         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
28970         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
28971         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
28972         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
28973         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
28974         // can add more here as needed by common apps
28975         ELM_STORE_ITEM_MAPPING_LAST
28976      } Elm_Store_Item_Mapping_Type;
28977
28978    struct _Elm_Store_Item_Mapping_Icon
28979      {
28980         // FIXME: allow edje file icons
28981         int                   w, h;
28982         Elm_Icon_Lookup_Order lookup_order;
28983         Eina_Bool             standard_name : 1;
28984         Eina_Bool             no_scale : 1;
28985         Eina_Bool             smooth : 1;
28986         Eina_Bool             scale_up : 1;
28987         Eina_Bool             scale_down : 1;
28988      };
28989
28990    struct _Elm_Store_Item_Mapping_Empty
28991      {
28992         Eina_Bool             dummy;
28993      };
28994
28995    struct _Elm_Store_Item_Mapping_Photo
28996      {
28997         int                   size;
28998      };
28999
29000    struct _Elm_Store_Item_Mapping_Custom
29001      {
29002         Elm_Store_Item_Mapping_Cb func;
29003      };
29004
29005    struct _Elm_Store_Item_Mapping
29006      {
29007         Elm_Store_Item_Mapping_Type     type;
29008         const char                     *part;
29009         int                             offset;
29010         union
29011           {
29012              Elm_Store_Item_Mapping_Empty  empty;
29013              Elm_Store_Item_Mapping_Icon   icon;
29014              Elm_Store_Item_Mapping_Photo  photo;
29015              Elm_Store_Item_Mapping_Custom custom;
29016              // add more types here
29017           } details;
29018      };
29019
29020    struct _Elm_Store_Item_Info
29021      {
29022         Elm_Genlist_Item_Class       *item_class;
29023         const Elm_Store_Item_Mapping *mapping;
29024         void                         *data;
29025         char                         *sort_id;
29026      };
29027
29028    struct _Elm_Store_Item_Info_Filesystem
29029      {
29030         Elm_Store_Item_Info  base;
29031         char                *path;
29032      };
29033
29034 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
29035 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
29036
29037    EAPI void                    elm_store_free(Elm_Store *st);
29038
29039    EAPI Elm_Store              *elm_store_filesystem_new(void);
29040    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
29041    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29042    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29043
29044    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
29045
29046    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
29047    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29048    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29049    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29050    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
29051    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29052
29053    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29054    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
29055    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29056    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
29057    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29058    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29059    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29060
29061    /**
29062     * @defgroup SegmentControl SegmentControl
29063     * @ingroup Elementary
29064     *
29065     * @image html img/widget/segment_control/preview-00.png
29066     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
29067     *
29068     * @image html img/segment_control.png
29069     * @image latex img/segment_control.eps width=\textwidth
29070     *
29071     * Segment control widget is a horizontal control made of multiple segment
29072     * items, each segment item functioning similar to discrete two state button.
29073     * A segment control groups the items together and provides compact
29074     * single button with multiple equal size segments.
29075     *
29076     * Segment item size is determined by base widget
29077     * size and the number of items added.
29078     * Only one segment item can be at selected state. A segment item can display
29079     * combination of Text and any Evas_Object like Images or other widget.
29080     *
29081     * Smart callbacks one can listen to:
29082     * - "changed" - When the user clicks on a segment item which is not
29083     *   previously selected and get selected. The event_info parameter is the
29084     *   segment item pointer.
29085     *
29086     * Available styles for it:
29087     * - @c "default"
29088     *
29089     * Here is an example on its usage:
29090     * @li @ref segment_control_example
29091     */
29092
29093    /**
29094     * @addtogroup SegmentControl
29095     * @{
29096     */
29097
29098    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
29099
29100    /**
29101     * Add a new segment control widget to the given parent Elementary
29102     * (container) object.
29103     *
29104     * @param parent The parent object.
29105     * @return a new segment control widget handle or @c NULL, on errors.
29106     *
29107     * This function inserts a new segment control widget on the canvas.
29108     *
29109     * @ingroup SegmentControl
29110     */
29111    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29112
29113    /**
29114     * Append a new item to the segment control object.
29115     *
29116     * @param obj The segment control object.
29117     * @param icon The icon object to use for the left side of the item. An
29118     * icon can be any Evas object, but usually it is an icon created
29119     * with elm_icon_add().
29120     * @param label The label of the item.
29121     *        Note that, NULL is different from empty string "".
29122     * @return The created item or @c NULL upon failure.
29123     *
29124     * A new item will be created and appended to the segment control, i.e., will
29125     * be set as @b last item.
29126     *
29127     * If it should be inserted at another position,
29128     * elm_segment_control_item_insert_at() should be used instead.
29129     *
29130     * Items created with this function can be deleted with function
29131     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29132     *
29133     * @note @p label set to @c NULL is different from empty string "".
29134     * If an item
29135     * only has icon, it will be displayed bigger and centered. If it has
29136     * icon and label, even that an empty string, icon will be smaller and
29137     * positioned at left.
29138     *
29139     * Simple example:
29140     * @code
29141     * sc = elm_segment_control_add(win);
29142     * ic = elm_icon_add(win);
29143     * elm_icon_file_set(ic, "path/to/image", NULL);
29144     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
29145     * elm_segment_control_item_add(sc, ic, "label");
29146     * evas_object_show(sc);
29147     * @endcode
29148     *
29149     * @see elm_segment_control_item_insert_at()
29150     * @see elm_segment_control_item_del()
29151     *
29152     * @ingroup SegmentControl
29153     */
29154    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
29155
29156    /**
29157     * Insert a new item to the segment control object at specified position.
29158     *
29159     * @param obj The segment control object.
29160     * @param icon The icon object to use for the left side of the item. An
29161     * icon can be any Evas object, but usually it is an icon created
29162     * with elm_icon_add().
29163     * @param label The label of the item.
29164     * @param index Item position. Value should be between 0 and items count.
29165     * @return The created item or @c NULL upon failure.
29166
29167     * Index values must be between @c 0, when item will be prepended to
29168     * segment control, and items count, that can be get with
29169     * elm_segment_control_item_count_get(), case when item will be appended
29170     * to segment control, just like elm_segment_control_item_add().
29171     *
29172     * Items created with this function can be deleted with function
29173     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29174     *
29175     * @note @p label set to @c NULL is different from empty string "".
29176     * If an item
29177     * only has icon, it will be displayed bigger and centered. If it has
29178     * icon and label, even that an empty string, icon will be smaller and
29179     * positioned at left.
29180     *
29181     * @see elm_segment_control_item_add()
29182     * @see elm_segment_control_item_count_get()
29183     * @see elm_segment_control_item_del()
29184     *
29185     * @ingroup SegmentControl
29186     */
29187    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);
29188
29189    /**
29190     * Remove a segment control item from its parent, deleting it.
29191     *
29192     * @param it The item to be removed.
29193     *
29194     * Items can be added with elm_segment_control_item_add() or
29195     * elm_segment_control_item_insert_at().
29196     *
29197     * @ingroup SegmentControl
29198     */
29199    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29200
29201    /**
29202     * Remove a segment control item at given index from its parent,
29203     * deleting it.
29204     *
29205     * @param obj The segment control object.
29206     * @param index The position of the segment control item to be deleted.
29207     *
29208     * Items can be added with elm_segment_control_item_add() or
29209     * elm_segment_control_item_insert_at().
29210     *
29211     * @ingroup SegmentControl
29212     */
29213    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29214
29215    /**
29216     * Get the Segment items count from segment control.
29217     *
29218     * @param obj The segment control object.
29219     * @return Segment items count.
29220     *
29221     * It will just return the number of items added to segment control @p obj.
29222     *
29223     * @ingroup SegmentControl
29224     */
29225    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29226
29227    /**
29228     * Get the item placed at specified index.
29229     *
29230     * @param obj The segment control object.
29231     * @param index The index of the segment item.
29232     * @return The segment control item or @c NULL on failure.
29233     *
29234     * Index is the position of an item in segment control widget. Its
29235     * range is from @c 0 to <tt> count - 1 </tt>.
29236     * Count is the number of items, that can be get with
29237     * elm_segment_control_item_count_get().
29238     *
29239     * @ingroup SegmentControl
29240     */
29241    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29242
29243    /**
29244     * Get the label of item.
29245     *
29246     * @param obj The segment control object.
29247     * @param index The index of the segment item.
29248     * @return The label of the item at @p index.
29249     *
29250     * The return value is a pointer to the label associated to the item when
29251     * it was created, with function elm_segment_control_item_add(), or later
29252     * with function elm_segment_control_item_label_set. If no label
29253     * was passed as argument, it will return @c NULL.
29254     *
29255     * @see elm_segment_control_item_label_set() for more details.
29256     * @see elm_segment_control_item_add()
29257     *
29258     * @ingroup SegmentControl
29259     */
29260    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29261
29262    /**
29263     * Set the label of item.
29264     *
29265     * @param it The item of segment control.
29266     * @param text The label of item.
29267     *
29268     * The label to be displayed by the item.
29269     * Label will be at right of the icon (if set).
29270     *
29271     * If a label was passed as argument on item creation, with function
29272     * elm_control_segment_item_add(), it will be already
29273     * displayed by the item.
29274     *
29275     * @see elm_segment_control_item_label_get()
29276     * @see elm_segment_control_item_add()
29277     *
29278     * @ingroup SegmentControl
29279     */
29280    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
29281
29282    /**
29283     * Get the icon associated to the item.
29284     *
29285     * @param obj The segment control object.
29286     * @param index The index of the segment item.
29287     * @return The left side icon associated to the item at @p index.
29288     *
29289     * The return value is a pointer to the icon associated to the item when
29290     * it was created, with function elm_segment_control_item_add(), or later
29291     * with function elm_segment_control_item_icon_set(). If no icon
29292     * was passed as argument, it will return @c NULL.
29293     *
29294     * @see elm_segment_control_item_add()
29295     * @see elm_segment_control_item_icon_set()
29296     *
29297     * @ingroup SegmentControl
29298     */
29299    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29300
29301    /**
29302     * Set the icon associated to the item.
29303     *
29304     * @param it The segment control item.
29305     * @param icon The icon object to associate with @p it.
29306     *
29307     * The icon object to use at left side of the item. An
29308     * icon can be any Evas object, but usually it is an icon created
29309     * with elm_icon_add().
29310     *
29311     * Once the icon object is set, a previously set one will be deleted.
29312     * @warning Setting the same icon for two items will cause the icon to
29313     * dissapear from the first item.
29314     *
29315     * If an icon was passed as argument on item creation, with function
29316     * elm_segment_control_item_add(), it will be already
29317     * associated to the item.
29318     *
29319     * @see elm_segment_control_item_add()
29320     * @see elm_segment_control_item_icon_get()
29321     *
29322     * @ingroup SegmentControl
29323     */
29324    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
29325
29326    /**
29327     * Get the index of an item.
29328     *
29329     * @param it The segment control item.
29330     * @return The position of item in segment control widget.
29331     *
29332     * Index is the position of an item in segment control widget. Its
29333     * range is from @c 0 to <tt> count - 1 </tt>.
29334     * Count is the number of items, that can be get with
29335     * elm_segment_control_item_count_get().
29336     *
29337     * @ingroup SegmentControl
29338     */
29339    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29340
29341    /**
29342     * Get the base object of the item.
29343     *
29344     * @param it The segment control item.
29345     * @return The base object associated with @p it.
29346     *
29347     * Base object is the @c Evas_Object that represents that item.
29348     *
29349     * @ingroup SegmentControl
29350     */
29351    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29352
29353    /**
29354     * Get the selected item.
29355     *
29356     * @param obj The segment control object.
29357     * @return The selected item or @c NULL if none of segment items is
29358     * selected.
29359     *
29360     * The selected item can be unselected with function
29361     * elm_segment_control_item_selected_set().
29362     *
29363     * The selected item always will be highlighted on segment control.
29364     *
29365     * @ingroup SegmentControl
29366     */
29367    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29368
29369    /**
29370     * Set the selected state of an item.
29371     *
29372     * @param it The segment control item
29373     * @param select The selected state
29374     *
29375     * This sets the selected state of the given item @p it.
29376     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
29377     *
29378     * If a new item is selected the previosly selected will be unselected.
29379     * Previoulsy selected item can be get with function
29380     * elm_segment_control_item_selected_get().
29381     *
29382     * The selected item always will be highlighted on segment control.
29383     *
29384     * @see elm_segment_control_item_selected_get()
29385     *
29386     * @ingroup SegmentControl
29387     */
29388    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
29389
29390    /**
29391     * @}
29392     */
29393
29394    /**
29395     * @defgroup Grid Grid
29396     *
29397     * The grid is a grid layout widget that lays out a series of children as a
29398     * fixed "grid" of widgets using a given percentage of the grid width and
29399     * height each using the child object.
29400     *
29401     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
29402     * widgets size itself. The default is 100 x 100, so that means the
29403     * position and sizes of children will effectively be percentages (0 to 100)
29404     * of the width or height of the grid widget
29405     *
29406     * @{
29407     */
29408
29409    /**
29410     * Add a new grid to the parent
29411     *
29412     * @param parent The parent object
29413     * @return The new object or NULL if it cannot be created
29414     *
29415     * @ingroup Grid
29416     */
29417    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
29418
29419    /**
29420     * Set the virtual size of the grid
29421     *
29422     * @param obj The grid object
29423     * @param w The virtual width of the grid
29424     * @param h The virtual height of the grid
29425     *
29426     * @ingroup Grid
29427     */
29428    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
29429
29430    /**
29431     * Get the virtual size of the grid
29432     *
29433     * @param obj The grid object
29434     * @param w Pointer to integer to store the virtual width of the grid
29435     * @param h Pointer to integer to store the virtual height of the grid
29436     *
29437     * @ingroup Grid
29438     */
29439    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
29440
29441    /**
29442     * Pack child at given position and size
29443     *
29444     * @param obj The grid object
29445     * @param subobj The child to pack
29446     * @param x The virtual x coord at which to pack it
29447     * @param y The virtual y coord at which to pack it
29448     * @param w The virtual width at which to pack it
29449     * @param h The virtual height at which to pack it
29450     *
29451     * @ingroup Grid
29452     */
29453    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
29454
29455    /**
29456     * Unpack a child from a grid object
29457     *
29458     * @param obj The grid object
29459     * @param subobj The child to unpack
29460     *
29461     * @ingroup Grid
29462     */
29463    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
29464
29465    /**
29466     * Faster way to remove all child objects from a grid object.
29467     *
29468     * @param obj The grid object
29469     * @param clear If true, it will delete just removed children
29470     *
29471     * @ingroup Grid
29472     */
29473    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
29474
29475    /**
29476     * Set packing of an existing child at to position and size
29477     *
29478     * @param subobj The child to set packing of
29479     * @param x The virtual x coord at which to pack it
29480     * @param y The virtual y coord at which to pack it
29481     * @param w The virtual width at which to pack it
29482     * @param h The virtual height at which to pack it
29483     *
29484     * @ingroup Grid
29485     */
29486    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
29487
29488    /**
29489     * get packing of a child
29490     *
29491     * @param subobj The child to query
29492     * @param x Pointer to integer to store the virtual x coord
29493     * @param y Pointer to integer to store the virtual y coord
29494     * @param w Pointer to integer to store the virtual width
29495     * @param h Pointer to integer to store the virtual height
29496     *
29497     * @ingroup Grid
29498     */
29499    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
29500
29501    /**
29502     * @}
29503     */
29504
29505    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
29506    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
29507    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
29508    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
29509    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
29510    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
29511
29512    /**
29513     * @defgroup Video Video
29514     *
29515     * @addtogroup Video
29516     * @{
29517     *
29518     * Elementary comes with two object that help design application that need
29519     * to display video. The main one, Elm_Video, display a video by using Emotion.
29520     * It does embedded the video inside an Edje object, so you can do some
29521     * animation depending on the video state change. It does also implement a
29522     * ressource management policy to remove this burden from the application writer.
29523     *
29524     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
29525     * It take care of updating its content according to Emotion event and provide a
29526     * way to theme itself. It also does automatically raise the priority of the
29527     * linked Elm_Video so it will use the video decoder if available. It also does
29528     * activate the remember function on the linked Elm_Video object.
29529     *
29530     * Signals that you can add callback for are :
29531     *
29532     * "forward,clicked" - the user clicked the forward button.
29533     * "info,clicked" - the user clicked the info button.
29534     * "next,clicked" - the user clicked the next button.
29535     * "pause,clicked" - the user clicked the pause button.
29536     * "play,clicked" - the user clicked the play button.
29537     * "prev,clicked" - the user clicked the prev button.
29538     * "rewind,clicked" - the user clicked the rewind button.
29539     * "stop,clicked" - the user clicked the stop button.
29540     *
29541     * Default contents parts of the player widget that you can use for are:
29542     * @li "video" - A video of the player
29543     *
29544     */
29545
29546    /**
29547     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
29548     *
29549     * @param parent The parent object
29550     * @return a new player widget handle or @c NULL, on errors.
29551     *
29552     * This function inserts a new player widget on the canvas.
29553     *
29554     * @see elm_object_part_content_set()
29555     *
29556     * @ingroup Video
29557     */
29558    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
29559
29560    /**
29561     * @brief Link a Elm_Payer with an Elm_Video object.
29562     *
29563     * @param player the Elm_Player object.
29564     * @param video The Elm_Video object.
29565     *
29566     * This mean that action on the player widget will affect the
29567     * video object and the state of the video will be reflected in
29568     * the player itself.
29569     *
29570     * @see elm_player_add()
29571     * @see elm_video_add()
29572     * @deprecated use elm_object_part_content_set() instead
29573     *
29574     * @ingroup Video
29575     */
29576    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
29577
29578    /**
29579     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
29580     *
29581     * @param parent The parent object
29582     * @return a new video widget handle or @c NULL, on errors.
29583     *
29584     * This function inserts a new video widget on the canvas.
29585     *
29586     * @seeelm_video_file_set()
29587     * @see elm_video_uri_set()
29588     *
29589     * @ingroup Video
29590     */
29591    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
29592
29593    /**
29594     * @brief Define the file that will be the video source.
29595     *
29596     * @param video The video object to define the file for.
29597     * @param filename The file to target.
29598     *
29599     * This function will explicitly define a filename as a source
29600     * for the video of the Elm_Video object.
29601     *
29602     * @see elm_video_uri_set()
29603     * @see elm_video_add()
29604     * @see elm_player_add()
29605     *
29606     * @ingroup Video
29607     */
29608    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
29609
29610    /**
29611     * @brief Define the uri that will be the video source.
29612     *
29613     * @param video The video object to define the file for.
29614     * @param uri The uri to target.
29615     *
29616     * This function will define an uri as a source for the video of the
29617     * Elm_Video object. URI could be remote source of video, like http:// or local source
29618     * like for example WebCam who are most of the time v4l2:// (but that depend and
29619     * you should use Emotion API to request and list the available Webcam on your system).
29620     *
29621     * @see elm_video_file_set()
29622     * @see elm_video_add()
29623     * @see elm_player_add()
29624     *
29625     * @ingroup Video
29626     */
29627    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
29628
29629    /**
29630     * @brief Get the underlying Emotion object.
29631     *
29632     * @param video The video object to proceed the request on.
29633     * @return the underlying Emotion object.
29634     *
29635     * @ingroup Video
29636     */
29637    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
29638
29639    /**
29640     * @brief Start to play the video
29641     *
29642     * @param video The video object to proceed the request on.
29643     *
29644     * Start to play the video and cancel all suspend state.
29645     *
29646     * @ingroup Video
29647     */
29648    EAPI void elm_video_play(Evas_Object *video);
29649
29650    /**
29651     * @brief Pause the video
29652     *
29653     * @param video The video object to proceed the request on.
29654     *
29655     * Pause the video and start a timer to trigger suspend mode.
29656     *
29657     * @ingroup Video
29658     */
29659    EAPI void elm_video_pause(Evas_Object *video);
29660
29661    /**
29662     * @brief Stop the video
29663     *
29664     * @param video The video object to proceed the request on.
29665     *
29666     * Stop the video and put the emotion in deep sleep mode.
29667     *
29668     * @ingroup Video
29669     */
29670    EAPI void elm_video_stop(Evas_Object *video);
29671
29672    /**
29673     * @brief Is the video actually playing.
29674     *
29675     * @param video The video object to proceed the request on.
29676     * @return EINA_TRUE if the video is actually playing.
29677     *
29678     * You should consider watching event on the object instead of polling
29679     * the object state.
29680     *
29681     * @ingroup Video
29682     */
29683    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
29684
29685    /**
29686     * @brief Is it possible to seek inside the video.
29687     *
29688     * @param video The video object to proceed the request on.
29689     * @return EINA_TRUE if is possible to seek inside the video.
29690     *
29691     * @ingroup Video
29692     */
29693    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
29694
29695    /**
29696     * @brief Is the audio muted.
29697     *
29698     * @param video The video object to proceed the request on.
29699     * @return EINA_TRUE if the audio is muted.
29700     *
29701     * @ingroup Video
29702     */
29703    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
29704
29705    /**
29706     * @brief Change the mute state of the Elm_Video object.
29707     *
29708     * @param video The video object to proceed the request on.
29709     * @param mute The new mute state.
29710     *
29711     * @ingroup Video
29712     */
29713    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
29714
29715    /**
29716     * @brief Get the audio level of the current video.
29717     *
29718     * @param video The video object to proceed the request on.
29719     * @return the current audio level.
29720     *
29721     * @ingroup Video
29722     */
29723    EAPI double elm_video_audio_level_get(const Evas_Object *video);
29724
29725    /**
29726     * @brief Set the audio level of anElm_Video object.
29727     *
29728     * @param video The video object to proceed the request on.
29729     * @param volume The new audio volume.
29730     *
29731     * @ingroup Video
29732     */
29733    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
29734
29735    EAPI double elm_video_play_position_get(const Evas_Object *video);
29736    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
29737    EAPI double elm_video_play_length_get(const Evas_Object *video);
29738    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
29739    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
29740    EAPI const char *elm_video_title_get(const Evas_Object *video);
29741    /**
29742     * @}
29743     */
29744
29745    /**
29746     * @defgroup Naviframe Naviframe
29747     * @ingroup Elementary
29748     *
29749     * @brief Naviframe is a kind of view manager for the applications.
29750     *
29751     * Naviframe provides functions to switch different pages with stack
29752     * mechanism. It means if one page(item) needs to be changed to the new one,
29753     * then naviframe would push the new page to it's internal stack. Of course,
29754     * it can be back to the previous page by popping the top page. Naviframe
29755     * provides some transition effect while the pages are switching (same as
29756     * pager).
29757     *
29758     * Since each item could keep the different styles, users could keep the
29759     * same look & feel for the pages or different styles for the items in it's
29760     * application.
29761     *
29762     * Signals that you can add callback for are:
29763     * @li "transition,finished" - When the transition is finished in changing
29764     *     the item
29765     * @li "title,clicked" - User clicked title area
29766     *
29767     * Default contents parts of the naviframe items that you can use for are:
29768     * @li "default" - A main content of the page
29769     * @li "icon" - An icon in the title area
29770     * @li "prev_btn" - A button to go to the previous page
29771     * @li "next_btn" - A button to go to the next page
29772     *
29773     * Default text parts of the naviframe items that you can use for are:
29774     * @li "default" - Title label in the title area
29775     * @li "subtitle" - Sub-title label in the title area
29776     *
29777     * Supported elm_object common APIs.
29778     * @li elm_object_signal_emit
29779     *
29780     * Supported elm_object_item common APIs.
29781     * @li elm_object_item_text_set
29782     * @li elm_object_item_part_text_set
29783     * @li elm_object_item_text_get
29784     * @li elm_object_item_part_text_get
29785     * @li elm_object_item_content_set
29786     * @li elm_object_item_part_content_set
29787     * @li elm_object_item_content_get
29788     * @li elm_object_item_part_content_get
29789     * @li elm_object_item_content_unset
29790     * @li elm_object_item_part_content_unset
29791     * @li elm_object_item_signal_emit
29792     *
29793     * @ref tutorial_naviframe gives a good overview of the usage of the API.
29794     */
29795
29796    /**
29797     * @addtogroup Naviframe
29798     * @{
29799     */
29800
29801    /**
29802     * @brief Add a new Naviframe object to the parent.
29803     *
29804     * @param parent Parent object
29805     * @return New object or @c NULL, if it cannot be created
29806     *
29807     * @ingroup Naviframe
29808     */
29809    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29810
29811    /**
29812     * @brief Push a new item to the top of the naviframe stack (and show it).
29813     *
29814     * @param obj The naviframe object
29815     * @param title_label The label in the title area. The name of the title
29816     *        label part is "elm.text.title"
29817     * @param prev_btn The button to go to the previous item. If it is NULL,
29818     *        then naviframe will create a back button automatically. The name of
29819     *        the prev_btn part is "elm.swallow.prev_btn"
29820     * @param next_btn The button to go to the next item. Or It could be just an
29821     *        extra function button. The name of the next_btn part is
29822     *        "elm.swallow.next_btn"
29823     * @param content The main content object. The name of content part is
29824     *        "elm.swallow.content"
29825     * @param item_style The current item style name. @c NULL would be default.
29826     * @return The created item or @c NULL upon failure.
29827     *
29828     * The item pushed becomes one page of the naviframe, this item will be
29829     * deleted when it is popped.
29830     *
29831     * @see also elm_naviframe_item_style_set()
29832     * @see also elm_naviframe_item_insert_before()
29833     * @see also elm_naviframe_item_insert_after()
29834     *
29835     * The following styles are available for this item:
29836     * @li @c "default"
29837     *
29838     * @ingroup Naviframe
29839     */
29840    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);
29841
29842    /**
29843     * @brief Insert a new item into the naviframe before item @p before.
29844     *
29845     * @param before The naviframe item to insert before.
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 is inserted into the naviframe straight away without any
29860     * transition operations. This item will be deleted when it is popped.
29861     *
29862     * @see also elm_naviframe_item_style_set()
29863     * @see also elm_naviframe_item_push()
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_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);
29872
29873    /**
29874     * @brief Insert a new item into the naviframe after item @p after.
29875     *
29876     * @param after The naviframe item to insert after.
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_before()
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_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);
29903
29904    /**
29905     * @brief Pop an item that is on top of the stack
29906     *
29907     * @param obj The naviframe object
29908     * @return @c NULL or the content object(if the
29909     *         elm_naviframe_content_preserve_on_pop_get is true).
29910     *
29911     * This pops an item that is on the top(visible) of the naviframe, makes it
29912     * disappear, then deletes the item. The item that was underneath it on the
29913     * stack will become visible.
29914     *
29915     * @see also elm_naviframe_content_preserve_on_pop_get()
29916     *
29917     * @ingroup Naviframe
29918     */
29919    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29920
29921    /**
29922     * @brief Pop the items between the top and the above one on the given item.
29923     *
29924     * @param it The naviframe item
29925     *
29926     * @ingroup Naviframe
29927     */
29928    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29929
29930    /**
29931     * Promote an item already in the naviframe stack to the top of the stack
29932     *
29933     * @param it The naviframe item
29934     *
29935     * This will take the indicated item and promote it to the top of the stack
29936     * as if it had been pushed there. The item must already be inside the
29937     * naviframe stack to work.
29938     *
29939     */
29940    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29941
29942    /**
29943     * @brief Delete the given item instantly.
29944     *
29945     * @param it The naviframe item
29946     *
29947     * This just deletes the given item from the naviframe item list instantly.
29948     * So this would not emit any signals for view transitions but just change
29949     * the current view if the given item is a top one.
29950     *
29951     * @ingroup Naviframe
29952     */
29953    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29954
29955    /**
29956     * @brief preserve the content objects when items are popped.
29957     *
29958     * @param obj The naviframe object
29959     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29960     *
29961     * @see also elm_naviframe_content_preserve_on_pop_get()
29962     *
29963     * @ingroup Naviframe
29964     */
29965    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29966
29967    /**
29968     * @brief Get a value whether preserve mode is enabled or not.
29969     *
29970     * @param obj The naviframe object
29971     * @return If @c EINA_TRUE, preserve mode is enabled
29972     *
29973     * @see also elm_naviframe_content_preserve_on_pop_set()
29974     *
29975     * @ingroup Naviframe
29976     */
29977    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29978
29979    /**
29980     * @brief Get a top item on the naviframe stack
29981     *
29982     * @param obj The naviframe object
29983     * @return The top item on the naviframe stack or @c NULL, if the stack is
29984     *         empty
29985     *
29986     * @ingroup Naviframe
29987     */
29988    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29989
29990    /**
29991     * @brief Get a bottom item on the naviframe stack
29992     *
29993     * @param obj The naviframe object
29994     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29995     *         empty
29996     *
29997     * @ingroup Naviframe
29998     */
29999    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30000
30001    /**
30002     * @brief Set an item style
30003     *
30004     * @param obj The naviframe item
30005     * @param item_style The current item style name. @c NULL would be default
30006     *
30007     * The following styles are available for this item:
30008     * @li @c "default"
30009     *
30010     * @see also elm_naviframe_item_style_get()
30011     *
30012     * @ingroup Naviframe
30013     */
30014    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
30015
30016    /**
30017     * @brief Get an item style
30018     *
30019     * @param obj The naviframe item
30020     * @return The current item style name
30021     *
30022     * @see also elm_naviframe_item_style_set()
30023     *
30024     * @ingroup Naviframe
30025     */
30026    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30027
30028    /**
30029     * @brief Show/Hide the title area
30030     *
30031     * @param it The naviframe item
30032     * @param visible If @c EINA_TRUE, title area will be visible, hidden
30033     *        otherwise
30034     *
30035     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
30036     *
30037     * @see also elm_naviframe_item_title_visible_get()
30038     *
30039     * @ingroup Naviframe
30040     */
30041    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
30042
30043    /**
30044     * @brief Get a value whether title area is visible or not.
30045     *
30046     * @param it The naviframe item
30047     * @return If @c EINA_TRUE, title area is visible
30048     *
30049     * @see also elm_naviframe_item_title_visible_set()
30050     *
30051     * @ingroup Naviframe
30052     */
30053    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30054
30055    /**
30056     * @brief Set creating prev button automatically or not
30057     *
30058     * @param obj The naviframe object
30059     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
30060     *        be created internally when you pass the @c NULL to the prev_btn
30061     *        parameter in elm_naviframe_item_push
30062     *
30063     * @see also elm_naviframe_item_push()
30064     *
30065     * @ingroup Naviframe
30066     */
30067    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
30068
30069    /**
30070     * @brief Get a value whether prev button(back button) will be auto pushed or
30071     *        not.
30072     *
30073     * @param obj The naviframe object
30074     * @return If @c EINA_TRUE, prev button will be auto pushed.
30075     *
30076     * @see also elm_naviframe_item_push()
30077     *           elm_naviframe_prev_btn_auto_pushed_set()
30078     *
30079     * @ingroup Naviframe
30080     */
30081    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30082
30083    /**
30084     * @brief Get a list of all the naviframe items.
30085     *
30086     * @param obj The naviframe object
30087     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
30088     * or @c NULL on failure.
30089     *
30090     * @ingroup Naviframe
30091     */
30092    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30093
30094    /**
30095     * @brief Set the event enabled when pushing/popping items
30096     *
30097     * If @c enabled is EINA_TRUE, the contents of the naviframe item will
30098     * receives events from mouse and keyboard during view changing such as
30099     * item push/pop.
30100     *
30101     * @param obj The naviframe object
30102     * @param enabled Events are received when enabled is @c EINA_TRUE, and
30103     * ignored otherwise.
30104     *
30105     * @warning Events will be blocked by calling evas_object_freeze_events_set()
30106     * internally. So don't call the API whiling pushing/popping items.
30107     *
30108     * @see elm_naviframe_event_enabled_get()
30109     * @see evas_object_freeze_events_set()
30110     *
30111     * @ingroup Naviframe
30112     */
30113    EAPI void                elm_naviframe_event_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
30114
30115    /**
30116     * @brief Get the value of event enabled status.
30117     *
30118     * @param obj The naviframe object
30119     * @return EINA_TRUE, when event is enabled
30120     *
30121     * @see elm_naviframe_event_enabled_set()
30122     *
30123     * @ingroup Naviframe
30124     */
30125    EAPI Eina_Bool           elm_naviframe_event_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30126
30127    /**
30128     * @}
30129     */
30130
30131    /**
30132     * @defgroup Multibuttonentry Multibuttonentry
30133     *
30134     * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
30135     * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
30136     * a new button is added to the next row. When a text button is pressed, it will become focused.
30137     * Backspace removes the focus.
30138     * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
30139     *
30140     * Smart callbacks one can register:
30141     * - @c "item,selected" - when item is selected. May be called on backspace key.
30142     * - @c "item,added" - when a new multibuttonentry item is added.
30143     * - @c "item,deleted" - when a multibuttonentry item is deleted.
30144     * - @c "item,clicked" - selected item of multibuttonentry is clicked.
30145     * - @c "clicked" - when multibuttonentry is clicked.
30146     * - @c "focused" - when multibuttonentry is focused.
30147     * - @c "unfocused" - when multibuttonentry is unfocused.
30148     * - @c "expanded" - when multibuttonentry is expanded.
30149     * - @c "shrank" - when multibuttonentry is shrank.
30150     * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
30151     *
30152     * Here is an example on its usage:
30153     * @li @ref multibuttonentry_example
30154     */
30155
30156    /**
30157     * @addtogroup Multibuttonentry
30158     * @{
30159     */
30160
30161    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
30162    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
30163
30164    /**
30165     * @brief Add a new multibuttonentry to the parent
30166     *
30167     * @param parent The parent object
30168     * @return The new object or NULL if it cannot be created
30169     *
30170     */
30171    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30172
30173    /**
30174     * Get the label
30175     *
30176     * @param obj The multibuttonentry object
30177     * @return The label, or NULL if none
30178     *
30179     */
30180    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30181
30182    /**
30183     * Set the label
30184     *
30185     * @param obj The multibuttonentry object
30186     * @param label The text label string
30187     *
30188     */
30189    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
30190
30191    /**
30192     * Get the entry of the multibuttonentry object
30193     *
30194     * @param obj The multibuttonentry object
30195     * @return The entry object, or NULL if none
30196     *
30197     */
30198    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30199
30200    /**
30201     * Get the guide text
30202     *
30203     * @param obj The multibuttonentry object
30204     * @return The guide text, or NULL if none
30205     *
30206     */
30207    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30208
30209    /**
30210     * Set the guide text
30211     *
30212     * @param obj The multibuttonentry object
30213     * @param label The guide text string
30214     *
30215     */
30216    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
30217
30218    /**
30219     * Get the value of shrink_mode state.
30220     *
30221     * @param obj The multibuttonentry object
30222     * @param the value of shrink mode state.
30223     *
30224     */
30225    EAPI int                        elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30226
30227    /**
30228     * Set/Unset the multibuttonentry to shrink mode state of single line
30229     *
30230     * @param obj The multibuttonentry object
30231     * @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.
30232     *
30233     */
30234    EAPI void                       elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
30235
30236    /**
30237     * Prepend a new item to the multibuttonentry
30238     *
30239     * @param obj The multibuttonentry object
30240     * @param label The label of new item
30241     * @param data The ponter to the data to be attached
30242     * @return A handle to the item added or NULL if not possible
30243     *
30244     */
30245    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30246
30247    /**
30248     * Append a new item to the multibuttonentry
30249     *
30250     * @param obj The multibuttonentry object
30251     * @param label The label of new item
30252     * @param data The ponter to the data to be attached
30253     * @return A handle to the item added or NULL if not possible
30254     *
30255     */
30256    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30257
30258    /**
30259     * Add a new item to the multibuttonentry before the indicated object
30260     *
30261     * reference.
30262     * @param obj The multibuttonentry object
30263     * @param before The item before which to add it
30264     * @param label The label of new item
30265     * @param data The ponter to the data to be attached
30266     * @return A handle to the item added or NULL if not possible
30267     *
30268     */
30269    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);
30270
30271    /**
30272     * Add a new item to the multibuttonentry after the indicated object
30273     *
30274     * @param obj The multibuttonentry object
30275     * @param after The item after which to add it
30276     * @param label The label of new item
30277     * @param data The ponter to the data to be attached
30278     * @return A handle to the item added or NULL if not possible
30279     *
30280     */
30281    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);
30282
30283    /**
30284     * Get a list of items in the multibuttonentry
30285     *
30286     * @param obj The multibuttonentry object
30287     * @return The list of items, or NULL if none
30288     *
30289     */
30290    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30291
30292    /**
30293     * Get the first item in the multibuttonentry
30294     *
30295     * @param obj The multibuttonentry object
30296     * @return The first item, or NULL if none
30297     *
30298     */
30299    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30300
30301    /**
30302     * Get the last item in the multibuttonentry
30303     *
30304     * @param obj The multibuttonentry object
30305     * @return The last item, or NULL if none
30306     *
30307     */
30308    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30309
30310    /**
30311     * Get the selected item in the multibuttonentry
30312     *
30313     * @param obj The multibuttonentry object
30314     * @return The selected item, or NULL if none
30315     *
30316     */
30317    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30318
30319    /**
30320     * Set the selected state of an item
30321     *
30322     * @param item The item
30323     * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30324     *
30325     */
30326    EAPI void                       elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
30327
30328    /**
30329     * unselect all items.
30330     *
30331     * @param obj The multibuttonentry object
30332     *
30333     */
30334    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
30335
30336    /**
30337     * Delete a given item
30338     *
30339     * @param item The item
30340     *
30341     */
30342    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30343
30344    /**
30345     * Remove all items in the multibuttonentry.
30346     *
30347     * @param obj The multibuttonentry object
30348     *
30349     */
30350    EAPI void                       elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
30351
30352    /**
30353     * Get the label of a given item
30354     *
30355     * @param item The item
30356     * @return The label of a given item, or NULL if none
30357     *
30358     */
30359    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30360
30361    /**
30362     * Set the label of a given item
30363     *
30364     * @param item The item
30365     * @param label The text label string
30366     *
30367     */
30368    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
30369
30370    /**
30371     * Get the previous item in the multibuttonentry
30372     *
30373     * @param item The item
30374     * @return The item before the item @p item
30375     *
30376     */
30377    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30378
30379    /**
30380     * Get the next item in the multibuttonentry
30381     *
30382     * @param item The item
30383     * @return The item after the item @p item
30384     *
30385     */
30386    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30387
30388    /**
30389     * Append a item filter function for text inserted in the Multibuttonentry
30390     *
30391     * Append the given callback to the list. This functions will be called
30392     * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
30393     * as a parameter. The callback function is free to alter the text in any way
30394     * it wants, but it must remember to free the given pointer and update it.
30395     * If the new text is to be discarded, the function can free it and set it text
30396     * parameter to NULL. This will also prevent any following filters from being
30397     * called.
30398     *
30399     * @param obj The multibuttonentryentry object
30400     * @param func The function to use as item filter
30401     * @param data User data to pass to @p func
30402     *
30403     */
30404    EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30405
30406    /**
30407     * Prepend a filter function for text inserted in the Multibuttentry
30408     *
30409     * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
30410     * for more information
30411     *
30412     * @param obj The multibuttonentry object
30413     * @param func The function to use as text filter
30414     * @param data User data to pass to @p func
30415     *
30416     */
30417    EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30418
30419    /**
30420     * Remove a filter from the list
30421     *
30422     * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
30423     * for more information.
30424     *
30425     * @param obj The multibuttonentry object
30426     * @param func The filter function to remove
30427     * @param data The user data passed when adding the function
30428     *
30429     */
30430    EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30431
30432    /**
30433     * @}
30434     */
30435
30436    /**
30437     * @addtogroup CopyPaste
30438     * @{
30439     */
30440
30441    typedef struct _Elm_Selection_Data Elm_Selection_Data;
30442    typedef Eina_Bool (*Elm_Drop_Cb) (void *d, Evas_Object *o, Elm_Selection_Data *data);
30443
30444    typedef enum _Elm_Sel_Type
30445    {
30446       ELM_SEL_TYPE_PRIMARY,
30447       ELM_SEL_TYPE_SECONDARY,
30448       ELM_SEL_TYPE_CLIPBOARD,
30449       ELM_SEL_TYPE_XDND,
30450
30451       ELM_SEL_TYPE_MAX,
30452    } Elm_Sel_Type;
30453
30454    typedef enum _Elm_Sel_Format
30455    {
30456       /** Targets: for matching every atom requesting */
30457       ELM_SEL_FORMAT_TARGETS  = -1,
30458       /** they come from outside of elm */
30459       ELM_SEL_FORMAT_NONE     = 0x0,
30460       /** Plain unformated text: Used for things that don't want rich markup */
30461       ELM_SEL_FORMAT_TEXT     = 0x01,
30462       /** Edje textblock markup, including inline images */
30463       ELM_SEL_FORMAT_MARKUP   = 0x02,
30464       /** Images */
30465       ELM_SEL_FORMAT_IMAGE    = 0x04,
30466       /** Vcards */
30467       ELM_SEL_FORMAT_VCARD    = 0x08,
30468       /** Raw HTMLish things for widgets that want that stuff (hello webkit!) */
30469       ELM_SEL_FORMAT_HTML     = 0x10,
30470
30471       ELM_SEL_FORMAT_MAX
30472    } Elm_Sel_Format;
30473
30474    struct _Elm_Selection_Data
30475    {
30476       int                   x, y;
30477       Elm_Sel_Format   format;
30478       void                 *data;
30479       size_t                len;
30480    };
30481
30482    /**
30483     * @brief Set a data of a widget to copy and paste.
30484     *
30485     * Append the given callback to the list. This functions will be called
30486     * called.
30487     *
30488     * @param selection selection type for copying and pasting
30489     * @param widget The source widget pointer
30490     * @param format Type of selection format
30491     * @param buf The pointer of data source
30492     * @return If EINA_TRUE, setting data is success.
30493     *
30494     * @ingroup CopyPaste
30495     *
30496     */
30497
30498    EAPI Eina_Bool            elm_cnp_selection_set(Elm_Sel_Type selection, Evas_Object *widget, Elm_Sel_Format format, const void *buf, size_t buflen);
30499
30500    /**
30501     * @brief Retrive the data from the widget which is set for copying and pasting.
30502     *
30503     * Getting the data from the widget which is set for copying and pasting.
30504     * Mainly the widget is elm_entry. If then @p datacb and @p udata are
30505     * can be NULL. If not, @p datacb and @p udata are used for retriving data.
30506     *
30507     * @see also elm_cnp_selection_set()
30508     *
30509     * @param selection selection type for copying and pasting
30510     * @param widget The source widget pointer
30511     * @param datacb The user data callback if the target widget isn't elm_entry
30512     * @param udata The user data pointer for @p datacb
30513     * @return If EINA_TRUE, getting data is success.
30514     *
30515     * @ingroup CopyPaste
30516     *
30517     */
30518
30519    EAPI Eina_Bool            elm_cnp_selection_get(Elm_Sel_Type selection, Elm_Sel_Format format, Evas_Object *widget, Elm_Drop_Cb datacb, void *udata);
30520
30521    /**
30522     * @brief Clear the data in the widget which is set for copying and pasting.
30523     *
30524     * Clear the data in the widget. Normally this function isn't need to call.
30525     *
30526     * @see also elm_cnp_selection_set()
30527     *
30528     * @param selection selection type for copying and pasting
30529     * @param widget The source widget pointer
30530     * @return If EINA_TRUE, clearing data is success.
30531     *
30532     * @ingroup CopyPaste
30533     *
30534     */
30535
30536    EAPI Eina_Bool            elm_cnp_selection_clear(Elm_Sel_Type selection, Evas_Object *widget);
30537
30538    /**
30539     * @}
30540     */
30541
30542 #ifdef __cplusplus
30543 }
30544 #endif
30545
30546 #endif