New pager smart callback: show,finished.
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.8.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    return 0;
237 }
238 ELM_MAIN()
239 @endcode
240    *
241    */
242
243 /**
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
294
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
297  */
298
299 #ifndef ELEMENTARY_H
300 #define ELEMENTARY_H
301
302 /**
303  * @file Elementary.h
304  * @brief Elementary's API
305  *
306  * Elementary API.
307  */
308
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
320 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
321
322 /* Standard headers for standard system calls etc. */
323 #include <stdio.h>
324 #include <stdlib.h>
325 #include <unistd.h>
326 #include <string.h>
327 #include <sys/types.h>
328 #include <sys/stat.h>
329 #include <sys/time.h>
330 #include <sys/param.h>
331 #include <math.h>
332 #include <fnmatch.h>
333 #include <limits.h>
334 #include <ctype.h>
335 #include <time.h>
336 #ifdef ELM_DIRENT_H
337 # include <dirent.h>
338 #endif
339 #include <pwd.h>
340 #include <errno.h>
341
342 #ifdef ELM_UNIX
343 # include <locale.h>
344 # ifdef ELM_LIBINTL_H
345 #  include <libintl.h>
346 # endif
347 # include <signal.h>
348 # include <grp.h>
349 # include <glob.h>
350 #endif
351
352 #ifdef ELM_ALLOCA_H
353 # include <alloca.h>
354 #endif
355
356 #if defined (ELM_WIN32) || defined (ELM_WINCE)
357 # include <malloc.h>
358 # ifndef alloca
359 #  define alloca _alloca
360 # endif
361 #endif
362
363
364 /* EFL headers */
365 #include <Eina.h>
366 #include <Eet.h>
367 #include <Evas.h>
368 // disabled - evas 1.1 won't have this.
369 //#include <Evas_GL.h>
370 #include <Ecore.h>
371 #include <Ecore_Evas.h>
372 #include <Ecore_File.h>
373 @ELEMENTARY_ECORE_IMF_INC@
374 @ELEMENTARY_ECORE_CON_INC@
375 #include <Edje.h>
376
377 #ifdef ELM_EDBUS
378 # include <E_DBus.h>
379 #endif
380
381 #ifdef ELM_EFREET
382 # include <Efreet.h>
383 # include <Efreet_Mime.h>
384 # include <Efreet_Trash.h>
385 #endif
386
387 #ifdef ELM_ETHUMB
388 # include <Ethumb_Client.h>
389 #endif
390
391 #ifdef ELM_EMAP
392 # include <EMap.h>
393 #endif
394
395 #ifdef EAPI
396 # undef EAPI
397 #endif
398
399 #ifdef _WIN32
400 # ifdef ELEMENTARY_BUILD
401 #  ifdef DLL_EXPORT
402 #   define EAPI __declspec(dllexport)
403 #  else
404 #   define EAPI
405 #  endif /* ! DLL_EXPORT */
406 # else
407 #  define EAPI __declspec(dllimport)
408 # endif /* ! EFL_EVAS_BUILD */
409 #else
410 # ifdef __GNUC__
411 #  if __GNUC__ >= 4
412 #   define EAPI __attribute__ ((visibility("default")))
413 #  else
414 #   define EAPI
415 #  endif
416 # else
417 #  define EAPI
418 # endif
419 #endif /* ! _WIN32 */
420
421 #ifdef _WIN32
422 # define EAPI_MAIN
423 #else
424 # define EAPI_MAIN EAPI
425 #endif
426
427 /* allow usage from c++ */
428 #ifdef __cplusplus
429 extern "C" {
430 #endif
431
432 #define ELM_VERSION_MAJOR @VMAJ@
433 #define ELM_VERSION_MINOR @VMIN@
434
435    typedef struct _Elm_Version
436      {
437         int major;
438         int minor;
439         int micro;
440         int revision;
441      } Elm_Version;
442
443    EAPI extern Elm_Version *elm_version;
444
445 /* handy macros */
446 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
447 #define ELM_PI 3.14159265358979323846
448
449    /**
450     * @defgroup General General
451     *
452     * @brief General Elementary API. Functions that don't relate to
453     * Elementary objects specifically.
454     *
455     * Here are documented functions which init/shutdown the library,
456     * that apply to generic Elementary objects, that deal with
457     * configuration, et cetera.
458     *
459     * @ref general_functions_example_page "This" example contemplates
460     * some of these functions.
461     */
462
463    /**
464     * @addtogroup General
465     * @{
466     */
467
468   /**
469    * Defines couple of standard Evas_Object layers to be used
470    * with evas_object_layer_set().
471    *
472    * @note whenever extending with new values, try to keep some padding
473    *       to siblings so there is room for further extensions.
474    */
475   typedef enum _Elm_Object_Layer
476     {
477        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
478        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
479        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
480        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
481        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
482        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
483     } Elm_Object_Layer;
484
485 /**************************************************************************/
486    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
487
488    /**
489     * Emitted when the application has reconfigured elementary settings due
490     * to an external configuration tool asking it to.
491     */
492    EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
493
494    /**
495     * Emitted when any Elementary's policy value is changed.
496     */
497    EAPI extern int ELM_EVENT_POLICY_CHANGED;
498
499    /**
500     * @typedef Elm_Event_Policy_Changed
501     *
502     * Data on the event when an Elementary policy has changed
503     */
504     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
505
506    /**
507     * @struct _Elm_Event_Policy_Changed
508     *
509     * Data on the event when an Elementary policy has changed
510     */
511     struct _Elm_Event_Policy_Changed
512      {
513         unsigned int policy; /**< the policy identifier */
514         int          new_value; /**< value the policy had before the change */
515         int          old_value; /**< new value the policy got */
516     };
517
518    /**
519     * Policy identifiers.
520     */
521     typedef enum _Elm_Policy
522     {
523         ELM_POLICY_QUIT, /**< under which circumstances the application
524                           * should quit automatically. @see
525                           * Elm_Policy_Quit.
526                           */
527         ELM_POLICY_LAST
528     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
529  */
530
531    typedef enum _Elm_Policy_Quit
532      {
533         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
534                                    * automatically */
535         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
536                                             * application's last
537                                             * window is closed */
538      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
539
540    typedef enum _Elm_Focus_Direction
541      {
542         ELM_FOCUS_PREVIOUS,
543         ELM_FOCUS_NEXT
544      } Elm_Focus_Direction;
545
546    typedef enum _Elm_Text_Format
547      {
548         ELM_TEXT_FORMAT_PLAIN_UTF8,
549         ELM_TEXT_FORMAT_MARKUP_UTF8
550      } Elm_Text_Format;
551
552    /**
553     * Line wrapping types.
554     */
555    typedef enum _Elm_Wrap_Type
556      {
557         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
558         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
559         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
560         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
561         ELM_WRAP_LAST
562      } Elm_Wrap_Type;
563
564    typedef enum
565      {
566         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
567         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
568         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
569         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
570         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
571         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
572         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
573         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
574         ELM_INPUT_PANEL_LAYOUT_INVALID
575      } Elm_Input_Panel_Layout;
576
577    typedef enum
578      {
579         ELM_AUTOCAPITAL_TYPE_NONE,
580         ELM_AUTOCAPITAL_TYPE_WORD,
581         ELM_AUTOCAPITAL_TYPE_SENTENCE,
582         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
583      } Elm_Autocapital_Type;
584
585    /**
586     * @typedef Elm_Object_Item
587     * An Elementary Object item handle.
588     * @ingroup General
589     */
590    typedef struct _Elm_Object_Item Elm_Object_Item;
591
592
593    /**
594     * Called back when a widget's tooltip is activated and needs content.
595     * @param data user-data given to elm_object_tooltip_content_cb_set()
596     * @param obj owner widget.
597     * @param tooltip The tooltip object (affix content to this!)
598     */
599    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
600
601    /**
602     * Called back when a widget's item tooltip is activated and needs content.
603     * @param data user-data given to elm_object_tooltip_content_cb_set()
604     * @param obj owner widget.
605     * @param tooltip The tooltip object (affix content to this!)
606     * @param item context dependent item. As an example, if tooltip was
607     *        set on Elm_List_Item, then it is of this type.
608     */
609    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
610
611    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. */
612
613 #ifndef ELM_LIB_QUICKLAUNCH
614 #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 */
615 #else
616 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
617 #endif
618
619 /**************************************************************************/
620    /* General calls */
621
622    /**
623     * Initialize Elementary
624     *
625     * @param[in] argc System's argument count value
626     * @param[in] argv System's pointer to array of argument strings
627     * @return The init counter value.
628     *
629     * This function initializes Elementary and increments a counter of
630     * the number of calls to it. It returns the new counter's value.
631     *
632     * @warning This call is exported only for use by the @c ELM_MAIN()
633     * macro. There is no need to use this if you use this macro (which
634     * is highly advisable). An elm_main() should contain the entry
635     * point code for your application, having the same prototype as
636     * elm_init(), and @b not being static (putting the @c EAPI symbol
637     * in front of its type declaration is advisable). The @c
638     * ELM_MAIN() call should be placed just after it.
639     *
640     * Example:
641     * @dontinclude bg_example_01.c
642     * @skip static void
643     * @until ELM_MAIN
644     *
645     * See the full @ref bg_example_01_c "example".
646     *
647     * @see elm_shutdown().
648     * @ingroup General
649     */
650    EAPI int          elm_init(int argc, char **argv);
651
652    /**
653     * Shut down Elementary
654     *
655     * @return The init counter value.
656     *
657     * This should be called at the end of your application, just
658     * before it ceases to do any more processing. This will clean up
659     * any permanent resources your application may have allocated via
660     * Elementary that would otherwise persist.
661     *
662     * @see elm_init() for an example
663     *
664     * @ingroup General
665     */
666    EAPI int          elm_shutdown(void);
667
668    /**
669     * Run Elementary's main loop
670     *
671     * This call should be issued just after all initialization is
672     * completed. This function will not return until elm_exit() is
673     * called. It will keep looping, running the main
674     * (event/processing) loop for Elementary.
675     *
676     * @see elm_init() for an example
677     *
678     * @ingroup General
679     */
680    EAPI void         elm_run(void);
681
682    /**
683     * Exit Elementary's main loop
684     *
685     * If this call is issued, it will flag the main loop to cease
686     * processing and return back to its parent function (usually your
687     * elm_main() function).
688     *
689     * @see elm_init() for an example. There, just after a request to
690     * close the window comes, the main loop will be left.
691     *
692     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
693     * applications, you'll be able to get this function called automatically for you.
694     *
695     * @ingroup General
696     */
697    EAPI void         elm_exit(void);
698
699    /**
700     * Provide information in order to make Elementary determine the @b
701     * run time location of the software in question, so other data files
702     * such as images, sound files, executable utilities, libraries,
703     * modules and locale files can be found.
704     *
705     * @param mainfunc This is your application's main function name,
706     *        whose binary's location is to be found. Providing @c NULL
707     *        will make Elementary not to use it
708     * @param dom This will be used as the application's "domain", in the
709     *        form of a prefix to any environment variables that may
710     *        override prefix detection and the directory name, inside the
711     *        standard share or data directories, where the software's
712     *        data files will be looked for.
713     * @param checkfile This is an (optional) magic file's path to check
714     *        for existence (and it must be located in the data directory,
715     *        under the share directory provided above). Its presence will
716     *        help determine the prefix found was correct. Pass @c NULL if
717     *        the check is not to be done.
718     *
719     * This function allows one to re-locate the application somewhere
720     * else after compilation, if the developer wishes for easier
721     * distribution of pre-compiled binaries.
722     *
723     * The prefix system is designed to locate where the given software is
724     * installed (under a common path prefix) at run time and then report
725     * specific locations of this prefix and common directories inside
726     * this prefix like the binary, library, data and locale directories,
727     * through the @c elm_app_*_get() family of functions.
728     *
729     * Call elm_app_info_set() early on before you change working
730     * directory or anything about @c argv[0], so it gets accurate
731     * information.
732     *
733     * It will then try and trace back which file @p mainfunc comes from,
734     * if provided, to determine the application's prefix directory.
735     *
736     * The @p dom parameter provides a string prefix to prepend before
737     * environment variables, allowing a fallback to @b specific
738     * environment variables to locate the software. You would most
739     * probably provide a lowercase string there, because it will also
740     * serve as directory domain, explained next. For environment
741     * variables purposes, this string is made uppercase. For example if
742     * @c "myapp" is provided as the prefix, then the program would expect
743     * @c "MYAPP_PREFIX" as a master environment variable to specify the
744     * exact install prefix for the software, or more specific environment
745     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
746     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
747     * the user or scripts before launching. If not provided (@c NULL),
748     * environment variables will not be used to override compiled-in
749     * defaults or auto detections.
750     *
751     * The @p dom string also provides a subdirectory inside the system
752     * shared data directory for data files. For example, if the system
753     * directory is @c /usr/local/share, then this directory name is
754     * appended, creating @c /usr/local/share/myapp, if it @p was @c
755     * "myapp". It is expected that the application installs data files in
756     * this directory.
757     *
758     * The @p checkfile is a file name or path of something inside the
759     * share or data directory to be used to test that the prefix
760     * detection worked. For example, your app will install a wallpaper
761     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
762     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
763     * checkfile string.
764     *
765     * @see elm_app_compile_bin_dir_set()
766     * @see elm_app_compile_lib_dir_set()
767     * @see elm_app_compile_data_dir_set()
768     * @see elm_app_compile_locale_set()
769     * @see elm_app_prefix_dir_get()
770     * @see elm_app_bin_dir_get()
771     * @see elm_app_lib_dir_get()
772     * @see elm_app_data_dir_get()
773     * @see elm_app_locale_dir_get()
774     */
775    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
776
777    /**
778     * Provide information on the @b fallback application's binaries
779     * directory, in scenarios where they get overriden by
780     * elm_app_info_set().
781     *
782     * @param dir The path to the default binaries directory (compile time
783     * one)
784     *
785     * @note Elementary will as well use this path to determine actual
786     * names of binaries' directory paths, maybe changing it to be @c
787     * something/local/bin instead of @c something/bin, only, for
788     * example.
789     *
790     * @warning You should call this function @b before
791     * elm_app_info_set().
792     */
793    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
794
795    /**
796     * Provide information on the @b fallback application's libraries
797     * directory, on scenarios where they get overriden by
798     * elm_app_info_set().
799     *
800     * @param dir The path to the default libraries directory (compile
801     * time one)
802     *
803     * @note Elementary will as well use this path to determine actual
804     * names of libraries' directory paths, maybe changing it to be @c
805     * something/lib32 or @c something/lib64 instead of @c something/lib,
806     * only, for example.
807     *
808     * @warning You should call this function @b before
809     * elm_app_info_set().
810     */
811    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
812
813    /**
814     * Provide information on the @b fallback application's data
815     * directory, on scenarios where they get overriden by
816     * elm_app_info_set().
817     *
818     * @param dir The path to the default data directory (compile time
819     * one)
820     *
821     * @note Elementary will as well use this path to determine actual
822     * names of data directory paths, maybe changing it to be @c
823     * something/local/share instead of @c something/share, only, for
824     * example.
825     *
826     * @warning You should call this function @b before
827     * elm_app_info_set().
828     */
829    EAPI void         elm_app_compile_data_dir_set(const char *dir);
830
831    /**
832     * Provide information on the @b fallback application's locale
833     * directory, on scenarios where they get overriden by
834     * elm_app_info_set().
835     *
836     * @param dir The path to the default locale directory (compile time
837     * one)
838     *
839     * @warning You should call this function @b before
840     * elm_app_info_set().
841     */
842    EAPI void         elm_app_compile_locale_set(const char *dir);
843
844    /**
845     * Retrieve the application's run time prefix directory, as set by
846     * elm_app_info_set() and the way (environment) the application was
847     * run from.
848     *
849     * @return The directory prefix the application is actually using.
850     */
851    EAPI const char  *elm_app_prefix_dir_get(void);
852
853    /**
854     * Retrieve the application's run time binaries prefix directory, as
855     * set by elm_app_info_set() and the way (environment) the application
856     * was run from.
857     *
858     * @return The binaries directory prefix the application is actually
859     * using.
860     */
861    EAPI const char  *elm_app_bin_dir_get(void);
862
863    /**
864     * Retrieve the application's run time libraries prefix directory, as
865     * set by elm_app_info_set() and the way (environment) the application
866     * was run from.
867     *
868     * @return The libraries directory prefix the application is actually
869     * using.
870     */
871    EAPI const char  *elm_app_lib_dir_get(void);
872
873    /**
874     * Retrieve the application's run time data prefix directory, as
875     * set by elm_app_info_set() and the way (environment) the application
876     * was run from.
877     *
878     * @return The data directory prefix the application is actually
879     * using.
880     */
881    EAPI const char  *elm_app_data_dir_get(void);
882
883    /**
884     * Retrieve the application's run time locale prefix directory, as
885     * set by elm_app_info_set() and the way (environment) the application
886     * was run from.
887     *
888     * @return The locale directory prefix the application is actually
889     * using.
890     */
891    EAPI const char  *elm_app_locale_dir_get(void);
892
893    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
894    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
895    EAPI int          elm_quicklaunch_init(int argc, char **argv);
896    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
897    EAPI int          elm_quicklaunch_sub_shutdown(void);
898    EAPI int          elm_quicklaunch_shutdown(void);
899    EAPI void         elm_quicklaunch_seed(void);
900    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
901    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
902    EAPI void         elm_quicklaunch_cleanup(void);
903    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
904    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
905
906    EAPI Eina_Bool    elm_need_efreet(void);
907    EAPI Eina_Bool    elm_need_e_dbus(void);
908
909    /**
910     * This must be called before any other function that deals with
911     * elm_thumb objects or ethumb_client instances.
912     *
913     * @ingroup Thumb
914     */
915    EAPI Eina_Bool    elm_need_ethumb(void);
916
917    /**
918     * This must be called before any other function that deals with
919     * elm_web objects or ewk_view instances.
920     *
921     * @ingroup Web
922     */
923    EAPI Eina_Bool    elm_need_web(void);
924
925    /**
926     * Set a new policy's value (for a given policy group/identifier).
927     *
928     * @param policy policy identifier, as in @ref Elm_Policy.
929     * @param value policy value, which depends on the identifier
930     *
931     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
932     *
933     * Elementary policies define applications' behavior,
934     * somehow. These behaviors are divided in policy groups (see
935     * #Elm_Policy enumeration). This call will emit the Ecore event
936     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
937     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
938     * then.
939     *
940     * @note Currently, we have only one policy identifier/group
941     * (#ELM_POLICY_QUIT), which has two possible values.
942     *
943     * @ingroup General
944     */
945    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
946
947    /**
948     * Gets the policy value for given policy identifier.
949     *
950     * @param policy policy identifier, as in #Elm_Policy.
951     * @return The currently set policy value, for that
952     * identifier. Will be @c 0 if @p policy passed is invalid.
953     *
954     * @ingroup General
955     */
956    EAPI int          elm_policy_get(unsigned int policy);
957
958    /**
959     * Change the language of the current application
960     *
961     * The @p lang passed must be the full name of the locale to use, for
962     * example "en_US.utf8" or "es_ES@euro".
963     *
964     * Changing language with this function will make Elementary run through
965     * all its widgets, translating strings set with
966     * elm_object_domain_translatable_text_part_set(). This way, an entire
967     * UI can have its language changed without having to restart the program.
968     *
969     * For more complex cases, like having formatted strings that need
970     * translation, widgets will also emit a "language,changed" signal that
971     * the user can listen to to manually translate the text.
972     *
973     * @param lang Language to set, must be the full name of the locale
974     *
975     * @ingroup General
976     */
977    EAPI void         elm_language_set(const char *lang);
978
979    /**
980     * Set a label of an object
981     *
982     * @param obj The Elementary object
983     * @param part The text part name to set (NULL for the default label)
984     * @param label The new text of the label
985     *
986     * @note Elementary objects may have many labels (e.g. Action Slider)
987     * @deprecated Use elm_object_part_text_set() instead.
988     * @ingroup General
989     */
990    EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
991
992    /**
993     * Set a label of an object
994     *
995     * @param obj The Elementary object
996     * @param part The text part name to set (NULL for the default label)
997     * @param label The new text of the label
998     *
999     * @note Elementary objects may have many labels (e.g. Action Slider)
1000     *
1001     * @ingroup General
1002     */
1003    EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1004
1005 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1006
1007    /**
1008     * Get a label of an object
1009     *
1010     * @param obj The Elementary object
1011     * @param part The text part name to get (NULL for the default label)
1012     * @return text of the label or NULL for any error
1013     *
1014     * @note Elementary objects may have many labels (e.g. Action Slider)
1015     * @deprecated Use elm_object_part_text_get() instead.
1016     * @ingroup General
1017     */
1018    EINA_DEPRECATED EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1019
1020    /**
1021     * Get a label of an object
1022     *
1023     * @param obj The Elementary object
1024     * @param part The text part name to get (NULL for the default label)
1025     * @return text of the label or NULL for any error
1026     *
1027     * @note Elementary objects may have many labels (e.g. Action Slider)
1028     *
1029     * @ingroup General
1030     */
1031    EAPI const char  *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1032
1033 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1034
1035    /**
1036     * Set the text for an objects' part, marking it as translatable.
1037     *
1038     * The string to set as @p text must be the original one. Do not pass the
1039     * return of @c gettext() here. Elementary will translate the string
1040     * internally and set it on the object using elm_object_part_text_set(),
1041     * also storing the original string so that it can be automatically
1042     * translated when the language is changed with elm_language_set().
1043     *
1044     * The @p domain will be stored along to find the translation in the
1045     * correct catalog. It can be NULL, in which case it will use whatever
1046     * domain was set by the application with @c textdomain(). This is useful
1047     * in case you are building a library on top of Elementary that will have
1048     * its own translatable strings, that should not be mixed with those of
1049     * programs using the library.
1050     *
1051     * @param obj The object containing the text part
1052     * @param part The name of the part to set
1053     * @param domain The translation domain to use
1054     * @param text The original, non-translated text to set
1055     *
1056     * @ingroup General
1057     */
1058    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1059
1060 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1061
1062 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1063
1064    /**
1065     * Gets the original string set as translatable for an object
1066     *
1067     * When setting translated strings, the function elm_object_part_text_get()
1068     * will return the translation returned by @c gettext(). To get the
1069     * original string use this function.
1070     *
1071     * @param obj The object
1072     * @param part The name of the part that was set
1073     *
1074     * @return The original, untranslated string
1075     *
1076     * @ingroup General
1077     */
1078    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1079
1080 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1081
1082    /**
1083     * Set a content of an object
1084     *
1085     * @param obj The Elementary object
1086     * @param part The content part name to set (NULL for the default content)
1087     * @param content The new content of the object
1088     *
1089     * @note Elementary objects may have many contents
1090     * @deprecated Use elm_object_part_content_set instead.
1091     * @ingroup General
1092     */
1093    EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1094
1095    /**
1096     * Set a content of an object
1097     *
1098     * @param obj The Elementary object
1099     * @param part The content part name to set (NULL for the default content)
1100     * @param content The new content of the object
1101     *
1102     * @note Elementary objects may have many contents
1103     *
1104     * @ingroup General
1105     */
1106    EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1107
1108 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1109
1110    /**
1111     * Get a content of an object
1112     *
1113     * @param obj The Elementary object
1114     * @param item The content part name to get (NULL for the default content)
1115     * @return content of the object or NULL for any error
1116     *
1117     * @note Elementary objects may have many contents
1118     * @deprecated Use elm_object_part_content_get instead.
1119     * @ingroup General
1120     */
1121    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1122
1123    /**
1124     * Get a content of an object
1125     *
1126     * @param obj The Elementary object
1127     * @param item The content part name to get (NULL for the default content)
1128     * @return content of the object or NULL for any error
1129     *
1130     * @note Elementary objects may have many contents
1131     *
1132     * @ingroup General
1133     */
1134    EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1135
1136 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1137
1138    /**
1139     * Unset a content of an object
1140     *
1141     * @param obj The Elementary object
1142     * @param item The content part name to unset (NULL for the default content)
1143     *
1144     * @note Elementary objects may have many contents
1145     * @deprecated Use elm_object_part_content_unset instead.
1146     * @ingroup General
1147     */
1148    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1149
1150    /**
1151     * Unset a content of an object
1152     *
1153     * @param obj The Elementary object
1154     * @param item The content part name to unset (NULL for the default content)
1155     *
1156     * @note Elementary objects may have many contents
1157     *
1158     * @ingroup General
1159     */
1160    EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1161
1162 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1163
1164    /**
1165     * Set the text to read out when in accessibility mode
1166     *
1167     * @param obj The object which is to be described
1168     * @param txt The text that describes the widget to people with poor or no vision
1169     *
1170     * @ingroup General
1171     */
1172    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1173
1174    /**
1175     * Get the widget object's handle which contains a given item
1176     *
1177     * @param item The Elementary object item
1178     * @return The widget object
1179     *
1180     * @note This returns the widget object itself that an item belongs to.
1181     *
1182     * @ingroup General
1183     */
1184    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1185
1186    /**
1187     * Set a content of an object item
1188     *
1189     * @param it The Elementary object item
1190     * @param part The content part name to set (NULL for the default content)
1191     * @param content The new content of the object item
1192     *
1193     * @note Elementary object items may have many contents
1194     * @deprecated Use elm_object_item_part_content_set instead.
1195     * @ingroup General
1196     */
1197    EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1198
1199    /**
1200     * Set a content of an object item
1201     *
1202     * @param it The Elementary object item
1203     * @param part The content part name to set (NULL for the default content)
1204     * @param content The new content of the object item
1205     *
1206     * @note Elementary object items may have many contents
1207     *
1208     * @ingroup General
1209     */
1210    EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1211
1212 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1213
1214    /**
1215     * Get a content of an object item
1216     *
1217     * @param it The Elementary object item
1218     * @param part The content part name to unset (NULL for the default content)
1219     * @return content of the object item or NULL for any error
1220     *
1221     * @note Elementary object items may have many contents
1222     * @deprecated Use elm_object_item_part_content_get instead.
1223     * @ingroup General
1224     */
1225    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1226
1227    /**
1228     * Get a content of an object item
1229     *
1230     * @param it The Elementary object item
1231     * @param part The content part name to unset (NULL for the default content)
1232     * @return content of the object item or NULL for any error
1233     *
1234     * @note Elementary object items may have many contents
1235     *
1236     * @ingroup General
1237     */
1238    EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1239
1240 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1241
1242    /**
1243     * Unset a content of an object item
1244     *
1245     * @param it The Elementary object item
1246     * @param part The content part name to unset (NULL for the default content)
1247     *
1248     * @note Elementary object items may have many contents
1249     * @deprecated Use elm_object_item_part_content_unset instead.
1250     * @ingroup General
1251     */
1252    EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1253
1254    /**
1255     * Unset a content of an object item
1256     *
1257     * @param it The Elementary object item
1258     * @param part The content part name to unset (NULL for the default content)
1259     *
1260     * @note Elementary object items may have many contents
1261     *
1262     * @ingroup General
1263     */
1264    EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1265
1266 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1267
1268    /**
1269     * Set a label of an object item
1270     *
1271     * @param it The Elementary object item
1272     * @param part The text part name to set (NULL for the default label)
1273     * @param label The new text of the label
1274     *
1275     * @note Elementary object items may have many labels
1276     * @deprecated Use elm_object_item_part_text_set instead.
1277     * @ingroup General
1278     */
1279    EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1280
1281    /**
1282     * Set a label of an object item
1283     *
1284     * @param it The Elementary object item
1285     * @param part The text part name to set (NULL for the default label)
1286     * @param label The new text of the label
1287     *
1288     * @note Elementary object items may have many labels
1289     *
1290     * @ingroup General
1291     */
1292    EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1293
1294 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1295
1296    /**
1297     * Get a label of an object item
1298     *
1299     * @param it The Elementary object item
1300     * @param part The text part name to get (NULL for the default label)
1301     * @return text of the label or NULL for any error
1302     *
1303     * @note Elementary object items may have many labels
1304     * @deprecated Use elm_object_item_part_text_get instead.
1305     * @ingroup General
1306     */
1307    EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1308    /**
1309     * Get a label of an object item
1310     *
1311     * @param it The Elementary object item
1312     * @param part The text part name to get (NULL for the default label)
1313     * @return text of the label or NULL for any error
1314     *
1315     * @note Elementary object items may have many labels
1316     *
1317     * @ingroup General
1318     */
1319    EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1320
1321 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1322
1323    /**
1324     * Set the text to read out when in accessibility mode
1325     *
1326     * @param it The object item which is to be described
1327     * @param txt The text that describes the widget to people with poor or no vision
1328     *
1329     * @ingroup General
1330     */
1331    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1332
1333    /**
1334     * Get the data associated with an object item
1335     * @param it The Elementary object item
1336     * @return The data associated with @p it
1337     *
1338     * @ingroup General
1339     */
1340    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1341
1342    /**
1343     * Set the data associated with an object item
1344     * @param it The Elementary object item
1345     * @param data The data to be associated with @p it
1346     *
1347     * @ingroup General
1348     */
1349    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1350
1351    /**
1352     * Send a signal to the edje object of the widget item.
1353     *
1354     * This function sends a signal to the edje object of the obj item. An
1355     * edje program can respond to a signal by specifying matching
1356     * 'signal' and 'source' fields.
1357     *
1358     * @param it The Elementary object item
1359     * @param emission The signal's name.
1360     * @param source The signal's source.
1361     * @ingroup General
1362     */
1363    EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1364
1365    /**
1366     * Set the disabled state of an widget item.
1367     *
1368     * @param obj The Elementary object item
1369     * @param disabled The state to put in in: @c EINA_TRUE for
1370     *        disabled, @c EINA_FALSE for enabled
1371     *
1372     * Elementary object item can be @b disabled, in which state they won't
1373     * receive input and, in general, will be themed differently from
1374     * their normal state, usually greyed out. Useful for contexts
1375     * where you don't want your users to interact with some of the
1376     * parts of you interface.
1377     *
1378     * This sets the state for the widget item, either disabling it or
1379     * enabling it back.
1380     *
1381     * @ingroup Styles
1382     */
1383    EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1384
1385    /**
1386     * Get the disabled state of an widget item.
1387     *
1388     * @param obj The Elementary object
1389     * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1390     *            if it's enabled (or on errors)
1391     *
1392     * This gets the state of the widget, which might be enabled or disabled.
1393     *
1394     * @ingroup Styles
1395     */
1396    EAPI Eina_Bool    elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1397
1398    /**
1399     * @}
1400     */
1401
1402    /**
1403     * @defgroup Caches Caches
1404     *
1405     * These are functions which let one fine-tune some cache values for
1406     * Elementary applications, thus allowing for performance adjustments.
1407     *
1408     * @{
1409     */
1410
1411    /**
1412     * @brief Flush all caches.
1413     *
1414     * Frees all data that was in cache and is not currently being used to reduce
1415     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1416     * to calling all of the following functions:
1417     * @li edje_file_cache_flush()
1418     * @li edje_collection_cache_flush()
1419     * @li eet_clearcache()
1420     * @li evas_image_cache_flush()
1421     * @li evas_font_cache_flush()
1422     * @li evas_render_dump()
1423     * @note Evas caches are flushed for every canvas associated with a window.
1424     *
1425     * @ingroup Caches
1426     */
1427    EAPI void         elm_all_flush(void);
1428
1429    /**
1430     * Get the configured cache flush interval time
1431     *
1432     * This gets the globally configured cache flush interval time, in
1433     * ticks
1434     *
1435     * @return The cache flush interval time
1436     * @ingroup Caches
1437     *
1438     * @see elm_all_flush()
1439     */
1440    EAPI int          elm_cache_flush_interval_get(void);
1441
1442    /**
1443     * Set the configured cache flush interval time
1444     *
1445     * This sets the globally configured cache flush interval time, in ticks
1446     *
1447     * @param size The cache flush interval time
1448     * @ingroup Caches
1449     *
1450     * @see elm_all_flush()
1451     */
1452    EAPI void         elm_cache_flush_interval_set(int size);
1453
1454    /**
1455     * Set the configured cache flush interval time for all applications on the
1456     * display
1457     *
1458     * This sets the globally configured cache flush interval time -- in ticks
1459     * -- for all applications on the display.
1460     *
1461     * @param size The cache flush interval time
1462     * @ingroup Caches
1463     */
1464    EAPI void         elm_cache_flush_interval_all_set(int size);
1465
1466    /**
1467     * Get the configured cache flush enabled state
1468     *
1469     * This gets the globally configured cache flush state - if it is enabled
1470     * or not. When cache flushing is enabled, elementary will regularly
1471     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1472     * memory and allow usage to re-seed caches and data in memory where it
1473     * can do so. An idle application will thus minimise its memory usage as
1474     * data will be freed from memory and not be re-loaded as it is idle and
1475     * not rendering or doing anything graphically right now.
1476     *
1477     * @return The cache flush state
1478     * @ingroup Caches
1479     *
1480     * @see elm_all_flush()
1481     */
1482    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1483
1484    /**
1485     * Set the configured cache flush enabled state
1486     *
1487     * This sets the globally configured cache flush enabled state.
1488     *
1489     * @param size The cache flush enabled state
1490     * @ingroup Caches
1491     *
1492     * @see elm_all_flush()
1493     */
1494    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1495
1496    /**
1497     * Set the configured cache flush enabled state for all applications on the
1498     * display
1499     *
1500     * This sets the globally configured cache flush enabled state for all
1501     * applications on the display.
1502     *
1503     * @param size The cache flush enabled state
1504     * @ingroup Caches
1505     */
1506    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1507
1508    /**
1509     * Get the configured font cache size
1510     *
1511     * This gets the globally configured font cache size, in bytes.
1512     *
1513     * @return The font cache size
1514     * @ingroup Caches
1515     */
1516    EAPI int          elm_font_cache_get(void);
1517
1518    /**
1519     * Set the configured font cache size
1520     *
1521     * This sets the globally configured font cache size, in bytes
1522     *
1523     * @param size The font cache size
1524     * @ingroup Caches
1525     */
1526    EAPI void         elm_font_cache_set(int size);
1527
1528    /**
1529     * Set the configured font cache size for all applications on the
1530     * display
1531     *
1532     * This sets the globally configured font cache size -- in bytes
1533     * -- for all applications on the display.
1534     *
1535     * @param size The font cache size
1536     * @ingroup Caches
1537     */
1538    EAPI void         elm_font_cache_all_set(int size);
1539
1540    /**
1541     * Get the configured image cache size
1542     *
1543     * This gets the globally configured image cache size, in bytes
1544     *
1545     * @return The image cache size
1546     * @ingroup Caches
1547     */
1548    EAPI int          elm_image_cache_get(void);
1549
1550    /**
1551     * Set the configured image cache size
1552     *
1553     * This sets the globally configured image cache size, in bytes
1554     *
1555     * @param size The image cache size
1556     * @ingroup Caches
1557     */
1558    EAPI void         elm_image_cache_set(int size);
1559
1560    /**
1561     * Set the configured image cache size for all applications on the
1562     * display
1563     *
1564     * This sets the globally configured image cache size -- in bytes
1565     * -- for all applications on the display.
1566     *
1567     * @param size The image cache size
1568     * @ingroup Caches
1569     */
1570    EAPI void         elm_image_cache_all_set(int size);
1571
1572    /**
1573     * Get the configured edje file cache size.
1574     *
1575     * This gets the globally configured edje file cache size, in number
1576     * of files.
1577     *
1578     * @return The edje file cache size
1579     * @ingroup Caches
1580     */
1581    EAPI int          elm_edje_file_cache_get(void);
1582
1583    /**
1584     * Set the configured edje file cache size
1585     *
1586     * This sets the globally configured edje file cache size, in number
1587     * of files.
1588     *
1589     * @param size The edje file cache size
1590     * @ingroup Caches
1591     */
1592    EAPI void         elm_edje_file_cache_set(int size);
1593
1594    /**
1595     * Set the configured edje file cache size for all applications on the
1596     * display
1597     *
1598     * This sets the globally configured edje file cache size -- in number
1599     * of files -- for all applications on the display.
1600     *
1601     * @param size The edje file cache size
1602     * @ingroup Caches
1603     */
1604    EAPI void         elm_edje_file_cache_all_set(int size);
1605
1606    /**
1607     * Get the configured edje collections (groups) cache size.
1608     *
1609     * This gets the globally configured edje collections cache size, in
1610     * number of collections.
1611     *
1612     * @return The edje collections cache size
1613     * @ingroup Caches
1614     */
1615    EAPI int          elm_edje_collection_cache_get(void);
1616
1617    /**
1618     * Set the configured edje collections (groups) cache size
1619     *
1620     * This sets the globally configured edje collections cache size, in
1621     * number of collections.
1622     *
1623     * @param size The edje collections cache size
1624     * @ingroup Caches
1625     */
1626    EAPI void         elm_edje_collection_cache_set(int size);
1627
1628    /**
1629     * Set the configured edje collections (groups) cache size for all
1630     * applications on the display
1631     *
1632     * This sets the globally configured edje collections cache size -- in
1633     * number of collections -- for all applications on the display.
1634     *
1635     * @param size The edje collections cache size
1636     * @ingroup Caches
1637     */
1638    EAPI void         elm_edje_collection_cache_all_set(int size);
1639
1640    /**
1641     * @}
1642     */
1643
1644    /**
1645     * @defgroup Scaling Widget Scaling
1646     *
1647     * Different widgets can be scaled independently. These functions
1648     * allow you to manipulate this scaling on a per-widget basis. The
1649     * object and all its children get their scaling factors multiplied
1650     * by the scale factor set. This is multiplicative, in that if a
1651     * child also has a scale size set it is in turn multiplied by its
1652     * parent's scale size. @c 1.0 means ā€œdon't scaleā€, @c 2.0 is
1653     * double size, @c 0.5 is half, etc.
1654     *
1655     * @ref general_functions_example_page "This" example contemplates
1656     * some of these functions.
1657     */
1658
1659    /**
1660     * Get the global scaling factor
1661     *
1662     * This gets the globally configured scaling factor that is applied to all
1663     * objects.
1664     *
1665     * @return The scaling factor
1666     * @ingroup Scaling
1667     */
1668    EAPI double       elm_scale_get(void);
1669
1670    /**
1671     * Set the global scaling factor
1672     *
1673     * This sets the globally configured scaling factor that is applied to all
1674     * objects.
1675     *
1676     * @param scale The scaling factor to set
1677     * @ingroup Scaling
1678     */
1679    EAPI void         elm_scale_set(double scale);
1680
1681    /**
1682     * Set the global scaling factor for all applications on the display
1683     *
1684     * This sets the globally configured scaling factor that is applied to all
1685     * objects for all applications.
1686     * @param scale The scaling factor to set
1687     * @ingroup Scaling
1688     */
1689    EAPI void         elm_scale_all_set(double scale);
1690
1691    /**
1692     * Set the scaling factor for a given Elementary object
1693     *
1694     * @param obj The Elementary to operate on
1695     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1696     * no scaling)
1697     *
1698     * @ingroup Scaling
1699     */
1700    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1701
1702    /**
1703     * Get the scaling factor for a given Elementary object
1704     *
1705     * @param obj The object
1706     * @return The scaling factor set by elm_object_scale_set()
1707     *
1708     * @ingroup Scaling
1709     */
1710    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1711
1712    /**
1713     * @defgroup Password_last_show Password last input show
1714     *
1715     * Last show feature of password mode enables user to view
1716     * the last input entered for few seconds before masking it.
1717     * These functions allow to set this feature in password mode
1718     * of entry widget and also allow to manipulate the duration
1719     * for which the input has to be visible.
1720     *
1721     * @{
1722     */
1723
1724    /**
1725     * Get show last setting of password mode.
1726     *
1727     * This gets the show last input setting of password mode which might be
1728     * enabled or disabled.
1729     *
1730     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1731     *            if it's disabled.
1732     * @ingroup Password_last_show
1733     */
1734    EAPI Eina_Bool elm_password_show_last_get(void);
1735
1736    /**
1737     * Set show last setting in password mode.
1738     *
1739     * This enables or disables show last setting of password mode.
1740     *
1741     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1742     * @see elm_password_show_last_timeout_set()
1743     * @ingroup Password_last_show
1744     */
1745    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1746
1747    /**
1748     * Get's the timeout value in last show password mode.
1749     *
1750     * This gets the time out value for which the last input entered in password
1751     * mode will be visible.
1752     *
1753     * @return The timeout value of last show password mode.
1754     * @ingroup Password_last_show
1755     */
1756    EAPI double elm_password_show_last_timeout_get(void);
1757
1758    /**
1759     * Set's the timeout value in last show password mode.
1760     *
1761     * This sets the time out value for which the last input entered in password
1762     * mode will be visible.
1763     *
1764     * @param password_show_last_timeout The timeout value.
1765     * @see elm_password_show_last_set()
1766     * @ingroup Password_last_show
1767     */
1768    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1769
1770    /**
1771     * @}
1772     */
1773
1774    /**
1775     * @defgroup UI-Mirroring Selective Widget mirroring
1776     *
1777     * These functions allow you to set ui-mirroring on specific
1778     * widgets or the whole interface. Widgets can be in one of two
1779     * modes, automatic and manual.  Automatic means they'll be changed
1780     * according to the system mirroring mode and manual means only
1781     * explicit changes will matter. You are not supposed to change
1782     * mirroring state of a widget set to automatic, will mostly work,
1783     * but the behavior is not really defined.
1784     *
1785     * @{
1786     */
1787
1788    EAPI Eina_Bool    elm_mirrored_get(void);
1789    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1790
1791    /**
1792     * Get the system mirrored mode. This determines the default mirrored mode
1793     * of widgets.
1794     *
1795     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1796     */
1797    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1798
1799    /**
1800     * Set the system mirrored mode. This determines the default mirrored mode
1801     * of widgets.
1802     *
1803     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1804     */
1805    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1806
1807    /**
1808     * Returns the widget's mirrored mode setting.
1809     *
1810     * @param obj The widget.
1811     * @return mirrored mode setting of the object.
1812     *
1813     **/
1814    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1815
1816    /**
1817     * Sets the widget's mirrored mode setting.
1818     * When widget in automatic mode, it follows the system mirrored mode set by
1819     * elm_mirrored_set().
1820     * @param obj The widget.
1821     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1822     */
1823    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1824
1825    /**
1826     * @}
1827     */
1828
1829    /**
1830     * Set the style to use by a widget
1831     *
1832     * Sets the style name that will define the appearance of a widget. Styles
1833     * vary from widget to widget and may also be defined by other themes
1834     * by means of extensions and overlays.
1835     *
1836     * @param obj The Elementary widget to style
1837     * @param style The style name to use
1838     *
1839     * @see elm_theme_extension_add()
1840     * @see elm_theme_extension_del()
1841     * @see elm_theme_overlay_add()
1842     * @see elm_theme_overlay_del()
1843     *
1844     * @ingroup Styles
1845     */
1846    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1847    /**
1848     * Get the style used by the widget
1849     *
1850     * This gets the style being used for that widget. Note that the string
1851     * pointer is only valid as longas the object is valid and the style doesn't
1852     * change.
1853     *
1854     * @param obj The Elementary widget to query for its style
1855     * @return The style name used
1856     *
1857     * @see elm_object_style_set()
1858     *
1859     * @ingroup Styles
1860     */
1861    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1862
1863    /**
1864     * @defgroup Styles Styles
1865     *
1866     * Widgets can have different styles of look. These generic API's
1867     * set styles of widgets, if they support them (and if the theme(s)
1868     * do).
1869     *
1870     * @ref general_functions_example_page "This" example contemplates
1871     * some of these functions.
1872     */
1873
1874    /**
1875     * Set the disabled state of an Elementary object.
1876     *
1877     * @param obj The Elementary object to operate on
1878     * @param disabled The state to put in in: @c EINA_TRUE for
1879     *        disabled, @c EINA_FALSE for enabled
1880     *
1881     * Elementary objects can be @b disabled, in which state they won't
1882     * receive input and, in general, will be themed differently from
1883     * their normal state, usually greyed out. Useful for contexts
1884     * where you don't want your users to interact with some of the
1885     * parts of you interface.
1886     *
1887     * This sets the state for the widget, either disabling it or
1888     * enabling it back.
1889     *
1890     * @ingroup Styles
1891     */
1892    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1893
1894    /**
1895     * Get the disabled state of an Elementary object.
1896     *
1897     * @param obj The Elementary object to operate on
1898     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1899     *            if it's enabled (or on errors)
1900     *
1901     * This gets the state of the widget, which might be enabled or disabled.
1902     *
1903     * @ingroup Styles
1904     */
1905    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1906
1907    /**
1908     * @defgroup WidgetNavigation Widget Tree Navigation.
1909     *
1910     * How to check if an Evas Object is an Elementary widget? How to
1911     * get the first elementary widget that is parent of the given
1912     * object?  These are all covered in widget tree navigation.
1913     *
1914     * @ref general_functions_example_page "This" example contemplates
1915     * some of these functions.
1916     */
1917
1918    /**
1919     * Check if the given Evas Object is an Elementary widget.
1920     *
1921     * @param obj the object to query.
1922     * @return @c EINA_TRUE if it is an elementary widget variant,
1923     *         @c EINA_FALSE otherwise
1924     * @ingroup WidgetNavigation
1925     */
1926    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1927
1928    /**
1929     * Get the first parent of the given object that is an Elementary
1930     * widget.
1931     *
1932     * @param obj the Elementary object to query parent from.
1933     * @return the parent object that is an Elementary widget, or @c
1934     *         NULL, if it was not found.
1935     *
1936     * Use this to query for an object's parent widget.
1937     *
1938     * @note Most of Elementary users wouldn't be mixing non-Elementary
1939     * smart objects in the objects tree of an application, as this is
1940     * an advanced usage of Elementary with Evas. So, except for the
1941     * application's window, which is the root of that tree, all other
1942     * objects would have valid Elementary widget parents.
1943     *
1944     * @ingroup WidgetNavigation
1945     */
1946    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1947
1948    /**
1949     * Get the top level parent of an Elementary widget.
1950     *
1951     * @param obj The object to query.
1952     * @return The top level Elementary widget, or @c NULL if parent cannot be
1953     * found.
1954     * @ingroup WidgetNavigation
1955     */
1956    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1957
1958    /**
1959     * Get the string that represents this Elementary widget.
1960     *
1961     * @note Elementary is weird and exposes itself as a single
1962     *       Evas_Object_Smart_Class of type "elm_widget", so
1963     *       evas_object_type_get() always return that, making debug and
1964     *       language bindings hard. This function tries to mitigate this
1965     *       problem, but the solution is to change Elementary to use
1966     *       proper inheritance.
1967     *
1968     * @param obj the object to query.
1969     * @return Elementary widget name, or @c NULL if not a valid widget.
1970     * @ingroup WidgetNavigation
1971     */
1972    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1973
1974    /**
1975     * @defgroup Config Elementary Config
1976     *
1977     * Elementary configuration is formed by a set options bounded to a
1978     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1979     * "finger size", etc. These are functions with which one syncronizes
1980     * changes made to those values to the configuration storing files, de
1981     * facto. You most probably don't want to use the functions in this
1982     * group unlees you're writing an elementary configuration manager.
1983     *
1984     * @{
1985     */
1986
1987    /**
1988     * Save back Elementary's configuration, so that it will persist on
1989     * future sessions.
1990     *
1991     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1992     * @ingroup Config
1993     *
1994     * This function will take effect -- thus, do I/O -- immediately. Use
1995     * it when you want to apply all configuration changes at once. The
1996     * current configuration set will get saved onto the current profile
1997     * configuration file.
1998     *
1999     */
2000    EAPI Eina_Bool    elm_config_save(void);
2001
2002    /**
2003     * Reload Elementary's configuration, bounded to current selected
2004     * profile.
2005     *
2006     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2007     * @ingroup Config
2008     *
2009     * Useful when you want to force reloading of configuration values for
2010     * a profile. If one removes user custom configuration directories,
2011     * for example, it will force a reload with system values instead.
2012     *
2013     */
2014    EAPI void         elm_config_reload(void);
2015
2016    /**
2017     * @}
2018     */
2019
2020    /**
2021     * @defgroup Profile Elementary Profile
2022     *
2023     * Profiles are pre-set options that affect the whole look-and-feel of
2024     * Elementary-based applications. There are, for example, profiles
2025     * aimed at desktop computer applications and others aimed at mobile,
2026     * touchscreen-based ones. You most probably don't want to use the
2027     * functions in this group unlees you're writing an elementary
2028     * configuration manager.
2029     *
2030     * @{
2031     */
2032
2033    /**
2034     * Get Elementary's profile in use.
2035     *
2036     * This gets the global profile that is applied to all Elementary
2037     * applications.
2038     *
2039     * @return The profile's name
2040     * @ingroup Profile
2041     */
2042    EAPI const char  *elm_profile_current_get(void);
2043
2044    /**
2045     * Get an Elementary's profile directory path in the filesystem. One
2046     * may want to fetch a system profile's dir or an user one (fetched
2047     * inside $HOME).
2048     *
2049     * @param profile The profile's name
2050     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2051     *                or a system one (@c EINA_FALSE)
2052     * @return The profile's directory path.
2053     * @ingroup Profile
2054     *
2055     * @note You must free it with elm_profile_dir_free().
2056     */
2057    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2058
2059    /**
2060     * Free an Elementary's profile directory path, as returned by
2061     * elm_profile_dir_get().
2062     *
2063     * @param p_dir The profile's path
2064     * @ingroup Profile
2065     *
2066     */
2067    EAPI void         elm_profile_dir_free(const char *p_dir);
2068
2069    /**
2070     * Get Elementary's list of available profiles.
2071     *
2072     * @return The profiles list. List node data are the profile name
2073     *         strings.
2074     * @ingroup Profile
2075     *
2076     * @note One must free this list, after usage, with the function
2077     *       elm_profile_list_free().
2078     */
2079    EAPI Eina_List   *elm_profile_list_get(void);
2080
2081    /**
2082     * Free Elementary's list of available profiles.
2083     *
2084     * @param l The profiles list, as returned by elm_profile_list_get().
2085     * @ingroup Profile
2086     *
2087     */
2088    EAPI void         elm_profile_list_free(Eina_List *l);
2089
2090    /**
2091     * Set Elementary's profile.
2092     *
2093     * This sets the global profile that is applied to Elementary
2094     * applications. Just the process the call comes from will be
2095     * affected.
2096     *
2097     * @param profile The profile's name
2098     * @ingroup Profile
2099     *
2100     */
2101    EAPI void         elm_profile_set(const char *profile);
2102
2103    /**
2104     * Set Elementary's profile.
2105     *
2106     * This sets the global profile that is applied to all Elementary
2107     * applications. All running Elementary windows will be affected.
2108     *
2109     * @param profile The profile's name
2110     * @ingroup Profile
2111     *
2112     */
2113    EAPI void         elm_profile_all_set(const char *profile);
2114
2115    /**
2116     * @}
2117     */
2118
2119    /**
2120     * @defgroup Engine Elementary Engine
2121     *
2122     * These are functions setting and querying which rendering engine
2123     * Elementary will use for drawing its windows' pixels.
2124     *
2125     * The following are the available engines:
2126     * @li "software_x11"
2127     * @li "fb"
2128     * @li "directfb"
2129     * @li "software_16_x11"
2130     * @li "software_8_x11"
2131     * @li "xrender_x11"
2132     * @li "opengl_x11"
2133     * @li "software_gdi"
2134     * @li "software_16_wince_gdi"
2135     * @li "sdl"
2136     * @li "software_16_sdl"
2137     * @li "opengl_sdl"
2138     * @li "buffer"
2139     * @li "ews"
2140     * @li "opengl_cocoa"
2141     * @li "psl1ght"
2142     *
2143     * @{
2144     */
2145
2146    /**
2147     * @brief Get Elementary's rendering engine in use.
2148     *
2149     * @return The rendering engine's name
2150     * @note there's no need to free the returned string, here.
2151     *
2152     * This gets the global rendering engine that is applied to all Elementary
2153     * applications.
2154     *
2155     * @see elm_engine_set()
2156     */
2157    EAPI const char  *elm_engine_current_get(void);
2158
2159    /**
2160     * @brief Set Elementary's rendering engine for use.
2161     *
2162     * @param engine The rendering engine's name
2163     *
2164     * This sets global rendering engine that is applied to all Elementary
2165     * applications. Note that it will take effect only to Elementary windows
2166     * created after this is called.
2167     *
2168     * @see elm_win_add()
2169     */
2170    EAPI void         elm_engine_set(const char *engine);
2171
2172    /**
2173     * @}
2174     */
2175
2176    /**
2177     * @defgroup Fonts Elementary Fonts
2178     *
2179     * These are functions dealing with font rendering, selection and the
2180     * like for Elementary applications. One might fetch which system
2181     * fonts are there to use and set custom fonts for individual classes
2182     * of UI items containing text (text classes).
2183     *
2184     * @{
2185     */
2186
2187   typedef struct _Elm_Text_Class
2188     {
2189        const char *name;
2190        const char *desc;
2191     } Elm_Text_Class;
2192
2193   typedef struct _Elm_Font_Overlay
2194     {
2195        const char     *text_class;
2196        const char     *font;
2197        Evas_Font_Size  size;
2198     } Elm_Font_Overlay;
2199
2200   typedef struct _Elm_Font_Properties
2201     {
2202        const char *name;
2203        Eina_List  *styles;
2204     } Elm_Font_Properties;
2205
2206    /**
2207     * Get Elementary's list of supported text classes.
2208     *
2209     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2210     * @ingroup Fonts
2211     *
2212     * Release the list with elm_text_classes_list_free().
2213     */
2214    EAPI const Eina_List     *elm_text_classes_list_get(void);
2215
2216    /**
2217     * Free Elementary's list of supported text classes.
2218     *
2219     * @ingroup Fonts
2220     *
2221     * @see elm_text_classes_list_get().
2222     */
2223    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2224
2225    /**
2226     * Get Elementary's list of font overlays, set with
2227     * elm_font_overlay_set().
2228     *
2229     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2230     * data.
2231     *
2232     * @ingroup Fonts
2233     *
2234     * For each text class, one can set a <b>font overlay</b> for it,
2235     * overriding the default font properties for that class coming from
2236     * the theme in use. There is no need to free this list.
2237     *
2238     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2239     */
2240    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2241
2242    /**
2243     * Set a font overlay for a given Elementary text class.
2244     *
2245     * @param text_class Text class name
2246     * @param font Font name and style string
2247     * @param size Font size
2248     *
2249     * @ingroup Fonts
2250     *
2251     * @p font has to be in the format returned by
2252     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2253     * and elm_font_overlay_unset().
2254     */
2255    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2256
2257    /**
2258     * Unset a font overlay for a given Elementary text class.
2259     *
2260     * @param text_class Text class name
2261     *
2262     * @ingroup Fonts
2263     *
2264     * This will bring back text elements belonging to text class
2265     * @p text_class back to their default font settings.
2266     */
2267    EAPI void                 elm_font_overlay_unset(const char *text_class);
2268
2269    /**
2270     * Apply the changes made with elm_font_overlay_set() and
2271     * elm_font_overlay_unset() on the current Elementary window.
2272     *
2273     * @ingroup Fonts
2274     *
2275     * This applies all font overlays set to all objects in the UI.
2276     */
2277    EAPI void                 elm_font_overlay_apply(void);
2278
2279    /**
2280     * Apply the changes made with elm_font_overlay_set() and
2281     * elm_font_overlay_unset() on all Elementary application windows.
2282     *
2283     * @ingroup Fonts
2284     *
2285     * This applies all font overlays set to all objects in the UI.
2286     */
2287    EAPI void                 elm_font_overlay_all_apply(void);
2288
2289    /**
2290     * Translate a font (family) name string in fontconfig's font names
2291     * syntax into an @c Elm_Font_Properties struct.
2292     *
2293     * @param font The font name and styles string
2294     * @return the font properties struct
2295     *
2296     * @ingroup Fonts
2297     *
2298     * @note The reverse translation can be achived with
2299     * elm_font_fontconfig_name_get(), for one style only (single font
2300     * instance, not family).
2301     */
2302    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2303
2304    /**
2305     * Free font properties return by elm_font_properties_get().
2306     *
2307     * @param efp the font properties struct
2308     *
2309     * @ingroup Fonts
2310     */
2311    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2312
2313    /**
2314     * Translate a font name, bound to a style, into fontconfig's font names
2315     * syntax.
2316     *
2317     * @param name The font (family) name
2318     * @param style The given style (may be @c NULL)
2319     *
2320     * @return the font name and style string
2321     *
2322     * @ingroup Fonts
2323     *
2324     * @note The reverse translation can be achived with
2325     * elm_font_properties_get(), for one style only (single font
2326     * instance, not family).
2327     */
2328    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2329
2330    /**
2331     * Free the font string return by elm_font_fontconfig_name_get().
2332     *
2333     * @param efp the font properties struct
2334     *
2335     * @ingroup Fonts
2336     */
2337    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2338
2339    /**
2340     * Create a font hash table of available system fonts.
2341     *
2342     * One must call it with @p list being the return value of
2343     * evas_font_available_list(). The hash will be indexed by font
2344     * (family) names, being its values @c Elm_Font_Properties blobs.
2345     *
2346     * @param list The list of available system fonts, as returned by
2347     * evas_font_available_list().
2348     * @return the font hash.
2349     *
2350     * @ingroup Fonts
2351     *
2352     * @note The user is supposed to get it populated at least with 3
2353     * default font families (Sans, Serif, Monospace), which should be
2354     * present on most systems.
2355     */
2356    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2357
2358    /**
2359     * Free the hash return by elm_font_available_hash_add().
2360     *
2361     * @param hash the hash to be freed.
2362     *
2363     * @ingroup Fonts
2364     */
2365    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2366
2367    /**
2368     * @}
2369     */
2370
2371    /**
2372     * @defgroup Fingers Fingers
2373     *
2374     * Elementary is designed to be finger-friendly for touchscreens,
2375     * and so in addition to scaling for display resolution, it can
2376     * also scale based on finger "resolution" (or size). You can then
2377     * customize the granularity of the areas meant to receive clicks
2378     * on touchscreens.
2379     *
2380     * Different profiles may have pre-set values for finger sizes.
2381     *
2382     * @ref general_functions_example_page "This" example contemplates
2383     * some of these functions.
2384     *
2385     * @{
2386     */
2387
2388    /**
2389     * Get the configured "finger size"
2390     *
2391     * @return The finger size
2392     *
2393     * This gets the globally configured finger size, <b>in pixels</b>
2394     *
2395     * @ingroup Fingers
2396     */
2397    EAPI Evas_Coord       elm_finger_size_get(void);
2398
2399    /**
2400     * Set the configured finger size
2401     *
2402     * This sets the globally configured finger size in pixels
2403     *
2404     * @param size The finger size
2405     * @ingroup Fingers
2406     */
2407    EAPI void             elm_finger_size_set(Evas_Coord size);
2408
2409    /**
2410     * Set the configured finger size for all applications on the display
2411     *
2412     * This sets the globally configured finger size in pixels for all
2413     * applications on the display
2414     *
2415     * @param size The finger size
2416     * @ingroup Fingers
2417     */
2418    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2419
2420    /**
2421     * @}
2422     */
2423
2424    /**
2425     * @defgroup Focus Focus
2426     *
2427     * An Elementary application has, at all times, one (and only one)
2428     * @b focused object. This is what determines where the input
2429     * events go to within the application's window. Also, focused
2430     * objects can be decorated differently, in order to signal to the
2431     * user where the input is, at a given moment.
2432     *
2433     * Elementary applications also have the concept of <b>focus
2434     * chain</b>: one can cycle through all the windows' focusable
2435     * objects by input (tab key) or programmatically. The default
2436     * focus chain for an application is the one define by the order in
2437     * which the widgets where added in code. One will cycle through
2438     * top level widgets, and, for each one containg sub-objects, cycle
2439     * through them all, before returning to the level
2440     * above. Elementary also allows one to set @b custom focus chains
2441     * for their applications.
2442     *
2443     * Besides the focused decoration a widget may exhibit, when it
2444     * gets focus, Elementary has a @b global focus highlight object
2445     * that can be enabled for a window. If one chooses to do so, this
2446     * extra highlight effect will surround the current focused object,
2447     * too.
2448     *
2449     * @note Some Elementary widgets are @b unfocusable, after
2450     * creation, by their very nature: they are not meant to be
2451     * interacted with input events, but are there just for visual
2452     * purposes.
2453     *
2454     * @ref general_functions_example_page "This" example contemplates
2455     * some of these functions.
2456     */
2457
2458    /**
2459     * Get the enable status of the focus highlight
2460     *
2461     * This gets whether the highlight on focused objects is enabled or not
2462     * @ingroup Focus
2463     */
2464    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2465
2466    /**
2467     * Set the enable status of the focus highlight
2468     *
2469     * Set whether to show or not the highlight on focused objects
2470     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2471     * @ingroup Focus
2472     */
2473    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2474
2475    /**
2476     * Get the enable status of the highlight animation
2477     *
2478     * Get whether the focus highlight, if enabled, will animate its switch from
2479     * one object to the next
2480     * @ingroup Focus
2481     */
2482    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2483
2484    /**
2485     * Set the enable status of the highlight animation
2486     *
2487     * Set whether the focus highlight, if enabled, will animate its switch from
2488     * one object to the next
2489     * @param animate Enable animation if EINA_TRUE, disable otherwise
2490     * @ingroup Focus
2491     */
2492    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2493
2494    /**
2495     * Get the whether an Elementary object has the focus or not.
2496     *
2497     * @param obj The Elementary object to get the information from
2498     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2499     *            not (and on errors).
2500     *
2501     * @see elm_object_focus_set()
2502     *
2503     * @ingroup Focus
2504     */
2505    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2506
2507    /**
2508     * Set/unset focus to a given Elementary object.
2509     *
2510     * @param obj The Elementary object to operate on.
2511     * @param enable @c EINA_TRUE Set focus to a given object,
2512     *               @c EINA_FALSE Unset focus to a given object.
2513     *
2514     * @note When you set focus to this object, if it can handle focus, will
2515     * take the focus away from the one who had it previously and will, for
2516     * now on, be the one receiving input events. Unsetting focus will remove
2517     * the focus from @p obj, passing it back to the previous element in the
2518     * focus chain list.
2519     *
2520     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2521     *
2522     * @ingroup Focus
2523     */
2524    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2525
2526    /**
2527     * Make a given Elementary object the focused one.
2528     *
2529     * @param obj The Elementary object to make focused.
2530     *
2531     * @note This object, if it can handle focus, will take the focus
2532     * away from the one who had it previously and will, for now on, be
2533     * the one receiving input events.
2534     *
2535     * @see elm_object_focus_get()
2536     * @deprecated use elm_object_focus_set() instead.
2537     *
2538     * @ingroup Focus
2539     */
2540    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2541
2542    /**
2543     * Remove the focus from an Elementary object
2544     *
2545     * @param obj The Elementary to take focus from
2546     *
2547     * This removes the focus from @p obj, passing it back to the
2548     * previous element in the focus chain list.
2549     *
2550     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2551     * @deprecated use elm_object_focus_set() instead.
2552     *
2553     * @ingroup Focus
2554     */
2555    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2556
2557    /**
2558     * Set the ability for an Element object to be focused
2559     *
2560     * @param obj The Elementary object to operate on
2561     * @param enable @c EINA_TRUE if the object can be focused, @c
2562     *        EINA_FALSE if not (and on errors)
2563     *
2564     * This sets whether the object @p obj is able to take focus or
2565     * not. Unfocusable objects do nothing when programmatically
2566     * focused, being the nearest focusable parent object the one
2567     * really getting focus. Also, when they receive mouse input, they
2568     * will get the event, but not take away the focus from where it
2569     * was previously.
2570     *
2571     * @ingroup Focus
2572     */
2573    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2574
2575    /**
2576     * Get whether an Elementary object is focusable or not
2577     *
2578     * @param obj The Elementary object to operate on
2579     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2580     *             EINA_FALSE if not (and on errors)
2581     *
2582     * @note Objects which are meant to be interacted with by input
2583     * events are created able to be focused, by default. All the
2584     * others are not.
2585     *
2586     * @ingroup Focus
2587     */
2588    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2589
2590    /**
2591     * Set custom focus chain.
2592     *
2593     * This function overwrites any previous custom focus chain within
2594     * the list of objects. The previous list will be deleted and this list
2595     * will be managed by elementary. After it is set, don't modify it.
2596     *
2597     * @note On focus cycle, only will be evaluated children of this container.
2598     *
2599     * @param obj The container object
2600     * @param objs Chain of objects to pass focus
2601     * @ingroup Focus
2602     */
2603    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2604
2605    /**
2606     * Unset a custom focus chain on a given Elementary widget
2607     *
2608     * @param obj The container object to remove focus chain from
2609     *
2610     * Any focus chain previously set on @p obj (for its child objects)
2611     * is removed entirely after this call.
2612     *
2613     * @ingroup Focus
2614     */
2615    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2616
2617    /**
2618     * Get custom focus chain
2619     *
2620     * @param obj The container object
2621     * @ingroup Focus
2622     */
2623    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2624
2625    /**
2626     * Append object to custom focus chain.
2627     *
2628     * @note If relative_child equal to NULL or not in custom chain, the object
2629     * will be added in end.
2630     *
2631     * @note On focus cycle, only will be evaluated children of this container.
2632     *
2633     * @param obj The container object
2634     * @param child The child to be added in custom chain
2635     * @param relative_child The relative object to position the child
2636     * @ingroup Focus
2637     */
2638    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2639
2640    /**
2641     * Prepend object to custom focus chain.
2642     *
2643     * @note If relative_child equal to NULL or not in custom chain, the object
2644     * will be added in begin.
2645     *
2646     * @note On focus cycle, only will be evaluated children of this container.
2647     *
2648     * @param obj The container object
2649     * @param child The child to be added in custom chain
2650     * @param relative_child The relative object to position the child
2651     * @ingroup Focus
2652     */
2653    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2654
2655    /**
2656     * Give focus to next object in object tree.
2657     *
2658     * Give focus to next object in focus chain of one object sub-tree.
2659     * If the last object of chain already have focus, the focus will go to the
2660     * first object of chain.
2661     *
2662     * @param obj The object root of sub-tree
2663     * @param dir Direction to cycle the focus
2664     *
2665     * @ingroup Focus
2666     */
2667    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2668
2669    /**
2670     * Give focus to near object in one direction.
2671     *
2672     * Give focus to near object in direction of one object.
2673     * If none focusable object in given direction, the focus will not change.
2674     *
2675     * @param obj The reference object
2676     * @param x Horizontal component of direction to focus
2677     * @param y Vertical component of direction to focus
2678     *
2679     * @ingroup Focus
2680     */
2681    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2682
2683    /**
2684     * Make the elementary object and its children to be unfocusable
2685     * (or focusable).
2686     *
2687     * @param obj The Elementary object to operate on
2688     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2689     *        @c EINA_FALSE for focusable.
2690     *
2691     * This sets whether the object @p obj and its children objects
2692     * are able to take focus or not. If the tree is set as unfocusable,
2693     * newest focused object which is not in this tree will get focus.
2694     * This API can be helpful for an object to be deleted.
2695     * When an object will be deleted soon, it and its children may not
2696     * want to get focus (by focus reverting or by other focus controls).
2697     * Then, just use this API before deleting.
2698     *
2699     * @see elm_object_tree_unfocusable_get()
2700     *
2701     * @ingroup Focus
2702     */
2703    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2704
2705    /**
2706     * Get whether an Elementary object and its children are unfocusable or not.
2707     *
2708     * @param obj The Elementary object to get the information from
2709     * @return @c EINA_TRUE, if the tree is unfocussable,
2710     *         @c EINA_FALSE if not (and on errors).
2711     *
2712     * @see elm_object_tree_unfocusable_set()
2713     *
2714     * @ingroup Focus
2715     */
2716    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2717
2718    /**
2719     * @defgroup Scrolling Scrolling
2720     *
2721     * These are functions setting how scrollable views in Elementary
2722     * widgets should behave on user interaction.
2723     *
2724     * @{
2725     */
2726
2727    /**
2728     * Get whether scrollers should bounce when they reach their
2729     * viewport's edge during a scroll.
2730     *
2731     * @return the thumb scroll bouncing state
2732     *
2733     * This is the default behavior for touch screens, in general.
2734     * @ingroup Scrolling
2735     */
2736    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2737
2738    /**
2739     * Set whether scrollers should bounce when they reach their
2740     * viewport's edge during a scroll.
2741     *
2742     * @param enabled the thumb scroll bouncing state
2743     *
2744     * @see elm_thumbscroll_bounce_enabled_get()
2745     * @ingroup Scrolling
2746     */
2747    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2748
2749    /**
2750     * Set whether scrollers should bounce when they reach their
2751     * viewport's edge during a scroll, for all Elementary application
2752     * windows.
2753     *
2754     * @param enabled the thumb scroll bouncing state
2755     *
2756     * @see elm_thumbscroll_bounce_enabled_get()
2757     * @ingroup Scrolling
2758     */
2759    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2760
2761    /**
2762     * Get the amount of inertia a scroller will impose at bounce
2763     * animations.
2764     *
2765     * @return the thumb scroll bounce friction
2766     *
2767     * @ingroup Scrolling
2768     */
2769    EAPI double           elm_scroll_bounce_friction_get(void);
2770
2771    /**
2772     * Set the amount of inertia a scroller will impose at bounce
2773     * animations.
2774     *
2775     * @param friction the thumb scroll bounce friction
2776     *
2777     * @see elm_thumbscroll_bounce_friction_get()
2778     * @ingroup Scrolling
2779     */
2780    EAPI void             elm_scroll_bounce_friction_set(double friction);
2781
2782    /**
2783     * Set the amount of inertia a scroller will impose at bounce
2784     * animations, for all Elementary application windows.
2785     *
2786     * @param friction the thumb scroll bounce friction
2787     *
2788     * @see elm_thumbscroll_bounce_friction_get()
2789     * @ingroup Scrolling
2790     */
2791    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2792
2793    /**
2794     * Get the amount of inertia a <b>paged</b> scroller will impose at
2795     * page fitting animations.
2796     *
2797     * @return the page scroll friction
2798     *
2799     * @ingroup Scrolling
2800     */
2801    EAPI double           elm_scroll_page_scroll_friction_get(void);
2802
2803    /**
2804     * Set the amount of inertia a <b>paged</b> scroller will impose at
2805     * page fitting animations.
2806     *
2807     * @param friction the page scroll friction
2808     *
2809     * @see elm_thumbscroll_page_scroll_friction_get()
2810     * @ingroup Scrolling
2811     */
2812    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2813
2814    /**
2815     * Set the amount of inertia a <b>paged</b> scroller will impose at
2816     * page fitting animations, for all Elementary application windows.
2817     *
2818     * @param friction the page scroll friction
2819     *
2820     * @see elm_thumbscroll_page_scroll_friction_get()
2821     * @ingroup Scrolling
2822     */
2823    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2824
2825    /**
2826     * Get the amount of inertia a scroller will impose at region bring
2827     * animations.
2828     *
2829     * @return the bring in scroll friction
2830     *
2831     * @ingroup Scrolling
2832     */
2833    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2834
2835    /**
2836     * Set the amount of inertia a scroller will impose at region bring
2837     * animations.
2838     *
2839     * @param friction the bring in scroll friction
2840     *
2841     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2842     * @ingroup Scrolling
2843     */
2844    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2845
2846    /**
2847     * Set the amount of inertia a scroller will impose at region bring
2848     * animations, for all Elementary application windows.
2849     *
2850     * @param friction the bring in scroll friction
2851     *
2852     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2853     * @ingroup Scrolling
2854     */
2855    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2856
2857    /**
2858     * Get the amount of inertia scrollers will impose at animations
2859     * triggered by Elementary widgets' zooming API.
2860     *
2861     * @return the zoom friction
2862     *
2863     * @ingroup Scrolling
2864     */
2865    EAPI double           elm_scroll_zoom_friction_get(void);
2866
2867    /**
2868     * Set the amount of inertia scrollers will impose at animations
2869     * triggered by Elementary widgets' zooming API.
2870     *
2871     * @param friction the zoom friction
2872     *
2873     * @see elm_thumbscroll_zoom_friction_get()
2874     * @ingroup Scrolling
2875     */
2876    EAPI void             elm_scroll_zoom_friction_set(double friction);
2877
2878    /**
2879     * Set the amount of inertia scrollers will impose at animations
2880     * triggered by Elementary widgets' zooming API, for all Elementary
2881     * application windows.
2882     *
2883     * @param friction the zoom friction
2884     *
2885     * @see elm_thumbscroll_zoom_friction_get()
2886     * @ingroup Scrolling
2887     */
2888    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2889
2890    /**
2891     * Get whether scrollers should be draggable from any point in their
2892     * views.
2893     *
2894     * @return the thumb scroll state
2895     *
2896     * @note This is the default behavior for touch screens, in general.
2897     * @note All other functions namespaced with "thumbscroll" will only
2898     *       have effect if this mode is enabled.
2899     *
2900     * @ingroup Scrolling
2901     */
2902    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2903
2904    /**
2905     * Set whether scrollers should be draggable from any point in their
2906     * views.
2907     *
2908     * @param enabled the thumb scroll state
2909     *
2910     * @see elm_thumbscroll_enabled_get()
2911     * @ingroup Scrolling
2912     */
2913    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2914
2915    /**
2916     * Set whether scrollers should be draggable from any point in their
2917     * views, for all Elementary application windows.
2918     *
2919     * @param enabled the thumb scroll state
2920     *
2921     * @see elm_thumbscroll_enabled_get()
2922     * @ingroup Scrolling
2923     */
2924    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2925
2926    /**
2927     * Get the number of pixels one should travel while dragging a
2928     * scroller's view to actually trigger scrolling.
2929     *
2930     * @return the thumb scroll threshould
2931     *
2932     * One would use higher values for touch screens, in general, because
2933     * of their inherent imprecision.
2934     * @ingroup Scrolling
2935     */
2936    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2937
2938    /**
2939     * Set the number of pixels one should travel while dragging a
2940     * scroller's view to actually trigger scrolling.
2941     *
2942     * @param threshold the thumb scroll threshould
2943     *
2944     * @see elm_thumbscroll_threshould_get()
2945     * @ingroup Scrolling
2946     */
2947    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2948
2949    /**
2950     * Set the number of pixels one should travel while dragging a
2951     * scroller's view to actually trigger scrolling, for all Elementary
2952     * application windows.
2953     *
2954     * @param threshold the thumb scroll threshould
2955     *
2956     * @see elm_thumbscroll_threshould_get()
2957     * @ingroup Scrolling
2958     */
2959    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2960
2961    /**
2962     * Get the minimum speed of mouse cursor movement which will trigger
2963     * list self scrolling animation after a mouse up event
2964     * (pixels/second).
2965     *
2966     * @return the thumb scroll momentum threshould
2967     *
2968     * @ingroup Scrolling
2969     */
2970    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2971
2972    /**
2973     * Set the minimum speed of mouse cursor movement which will trigger
2974     * list self scrolling animation after a mouse up event
2975     * (pixels/second).
2976     *
2977     * @param threshold the thumb scroll momentum threshould
2978     *
2979     * @see elm_thumbscroll_momentum_threshould_get()
2980     * @ingroup Scrolling
2981     */
2982    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2983
2984    /**
2985     * Set the minimum speed of mouse cursor movement which will trigger
2986     * list self scrolling animation after a mouse up event
2987     * (pixels/second), for all Elementary application windows.
2988     *
2989     * @param threshold the thumb scroll momentum threshould
2990     *
2991     * @see elm_thumbscroll_momentum_threshould_get()
2992     * @ingroup Scrolling
2993     */
2994    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2995
2996    /**
2997     * Get the amount of inertia a scroller will impose at self scrolling
2998     * animations.
2999     *
3000     * @return the thumb scroll friction
3001     *
3002     * @ingroup Scrolling
3003     */
3004    EAPI double           elm_scroll_thumbscroll_friction_get(void);
3005
3006    /**
3007     * Set the amount of inertia a scroller will impose at self scrolling
3008     * animations.
3009     *
3010     * @param friction the thumb scroll friction
3011     *
3012     * @see elm_thumbscroll_friction_get()
3013     * @ingroup Scrolling
3014     */
3015    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
3016
3017    /**
3018     * Set the amount of inertia a scroller will impose at self scrolling
3019     * animations, for all Elementary application windows.
3020     *
3021     * @param friction the thumb scroll friction
3022     *
3023     * @see elm_thumbscroll_friction_get()
3024     * @ingroup Scrolling
3025     */
3026    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
3027
3028    /**
3029     * Get the amount of lag between your actual mouse cursor dragging
3030     * movement and a scroller's view movement itself, while pushing it
3031     * into bounce state manually.
3032     *
3033     * @return the thumb scroll border friction
3034     *
3035     * @ingroup Scrolling
3036     */
3037    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
3038
3039    /**
3040     * Set the amount of lag between your actual mouse cursor dragging
3041     * movement and a scroller's view movement itself, while pushing it
3042     * into bounce state manually.
3043     *
3044     * @param friction the thumb scroll border friction. @c 0.0 for
3045     *        perfect synchrony between two movements, @c 1.0 for maximum
3046     *        lag.
3047     *
3048     * @see elm_thumbscroll_border_friction_get()
3049     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3050     *
3051     * @ingroup Scrolling
3052     */
3053    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
3054
3055    /**
3056     * Set the amount of lag between your actual mouse cursor dragging
3057     * movement and a scroller's view movement itself, while pushing it
3058     * into bounce state manually, for all Elementary application windows.
3059     *
3060     * @param friction the thumb scroll border friction. @c 0.0 for
3061     *        perfect synchrony between two movements, @c 1.0 for maximum
3062     *        lag.
3063     *
3064     * @see elm_thumbscroll_border_friction_get()
3065     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3066     *
3067     * @ingroup Scrolling
3068     */
3069    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
3070
3071    /**
3072     * Get the sensitivity amount which is be multiplied by the length of
3073     * mouse dragging.
3074     *
3075     * @return the thumb scroll sensitivity friction
3076     *
3077     * @ingroup Scrolling
3078     */
3079    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
3080
3081    /**
3082     * Set the sensitivity amount which is be multiplied by the length of
3083     * mouse dragging.
3084     *
3085     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3086     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3087     *        is proper.
3088     *
3089     * @see elm_thumbscroll_sensitivity_friction_get()
3090     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3091     *
3092     * @ingroup Scrolling
3093     */
3094    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3095
3096    /**
3097     * Set the sensitivity amount which is be multiplied by the length of
3098     * mouse dragging, for all Elementary application windows.
3099     *
3100     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3101     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3102     *        is proper.
3103     *
3104     * @see elm_thumbscroll_sensitivity_friction_get()
3105     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3106     *
3107     * @ingroup Scrolling
3108     */
3109    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3110
3111    /**
3112     * @}
3113     */
3114
3115    /**
3116     * @defgroup Scrollhints Scrollhints
3117     *
3118     * Objects when inside a scroller can scroll, but this may not always be
3119     * desirable in certain situations. This allows an object to hint to itself
3120     * and parents to "not scroll" in one of 2 ways. If any child object of a
3121     * scroller has pushed a scroll freeze or hold then it affects all parent
3122     * scrollers until all children have released them.
3123     *
3124     * 1. To hold on scrolling. This means just flicking and dragging may no
3125     * longer scroll, but pressing/dragging near an edge of the scroller will
3126     * still scroll. This is automatically used by the entry object when
3127     * selecting text.
3128     *
3129     * 2. To totally freeze scrolling. This means it stops. until
3130     * popped/released.
3131     *
3132     * @{
3133     */
3134
3135    /**
3136     * Push the scroll hold by 1
3137     *
3138     * This increments the scroll hold count by one. If it is more than 0 it will
3139     * take effect on the parents of the indicated object.
3140     *
3141     * @param obj The object
3142     * @ingroup Scrollhints
3143     */
3144    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3145
3146    /**
3147     * Pop the scroll hold by 1
3148     *
3149     * This decrements the scroll hold count by one. If it is more than 0 it will
3150     * take effect on the parents of the indicated object.
3151     *
3152     * @param obj The object
3153     * @ingroup Scrollhints
3154     */
3155    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3156
3157    /**
3158     * Push the scroll freeze by 1
3159     *
3160     * This increments the scroll freeze count by one. If it is more
3161     * than 0 it will take effect on the parents of the indicated
3162     * object.
3163     *
3164     * @param obj The object
3165     * @ingroup Scrollhints
3166     */
3167    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3168
3169    /**
3170     * Pop the scroll freeze by 1
3171     *
3172     * This decrements the scroll freeze count by one. If it is more
3173     * than 0 it will take effect on the parents of the indicated
3174     * object.
3175     *
3176     * @param obj The object
3177     * @ingroup Scrollhints
3178     */
3179    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3180
3181    /**
3182     * Lock the scrolling of the given widget (and thus all parents)
3183     *
3184     * This locks the given object from scrolling in the X axis (and implicitly
3185     * also locks all parent scrollers too from doing the same).
3186     *
3187     * @param obj The object
3188     * @param lock The lock state (1 == locked, 0 == unlocked)
3189     * @ingroup Scrollhints
3190     */
3191    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3192
3193    /**
3194     * Lock the scrolling of the given widget (and thus all parents)
3195     *
3196     * This locks the given object from scrolling in the Y axis (and implicitly
3197     * also locks all parent scrollers too from doing the same).
3198     *
3199     * @param obj The object
3200     * @param lock The lock state (1 == locked, 0 == unlocked)
3201     * @ingroup Scrollhints
3202     */
3203    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3204
3205    /**
3206     * Get the scrolling lock of the given widget
3207     *
3208     * This gets the lock for X axis scrolling.
3209     *
3210     * @param obj The object
3211     * @ingroup Scrollhints
3212     */
3213    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3214
3215    /**
3216     * Get the scrolling lock of the given widget
3217     *
3218     * This gets the lock for X axis scrolling.
3219     *
3220     * @param obj The object
3221     * @ingroup Scrollhints
3222     */
3223    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3224
3225    /**
3226     * @}
3227     */
3228
3229    /**
3230     * Send a signal to the widget edje object.
3231     *
3232     * This function sends a signal to the edje object of the obj. An
3233     * edje program can respond to a signal by specifying matching
3234     * 'signal' and 'source' fields.
3235     *
3236     * @param obj The object
3237     * @param emission The signal's name.
3238     * @param source The signal's source.
3239     * @ingroup General
3240     */
3241    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3242
3243    /**
3244     * Add a callback for a signal emitted by widget edje object.
3245     *
3246     * This function connects a callback function to a signal emitted by the
3247     * edje object of the obj.
3248     * Globs can occur in either the emission or source name.
3249     *
3250     * @param obj The object
3251     * @param emission The signal's name.
3252     * @param source The signal's source.
3253     * @param func The callback function to be executed when the signal is
3254     * emitted.
3255     * @param data A pointer to data to pass in to the callback function.
3256     * @ingroup General
3257     */
3258    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);
3259
3260    /**
3261     * Remove a signal-triggered callback from a widget edje object.
3262     *
3263     * This function removes a callback, previoulsy attached to a
3264     * signal emitted by the edje object of the obj.  The parameters
3265     * emission, source and func must match exactly those passed to a
3266     * previous call to elm_object_signal_callback_add(). The data
3267     * pointer that was passed to this call will be returned.
3268     *
3269     * @param obj The object
3270     * @param emission The signal's name.
3271     * @param source The signal's source.
3272     * @param func The callback function to be executed when the signal is
3273     * emitted.
3274     * @return The data pointer
3275     * @ingroup General
3276     */
3277    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);
3278
3279    /**
3280     * Add a callback for input events (key up, key down, mouse wheel)
3281     * on a given Elementary widget
3282     *
3283     * @param obj The widget to add an event callback on
3284     * @param func The callback function to be executed when the event
3285     * happens
3286     * @param data Data to pass in to @p func
3287     *
3288     * Every widget in an Elementary interface set to receive focus,
3289     * with elm_object_focus_allow_set(), will propagate @b all of its
3290     * key up, key down and mouse wheel input events up to its parent
3291     * object, and so on. All of the focusable ones in this chain which
3292     * had an event callback set, with this call, will be able to treat
3293     * those events. There are two ways of making the propagation of
3294     * these event upwards in the tree of widgets to @b cease:
3295     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3296     *   the event was @b not processed, so the propagation will go on.
3297     * - The @c event_info pointer passed to @p func will contain the
3298     *   event's structure and, if you OR its @c event_flags inner
3299     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3300     *   one has already handled it, thus killing the event's
3301     *   propagation, too.
3302     *
3303     * @note Your event callback will be issued on those events taking
3304     * place only if no other child widget of @obj has consumed the
3305     * event already.
3306     *
3307     * @note Not to be confused with @c
3308     * evas_object_event_callback_add(), which will add event callbacks
3309     * per type on general Evas objects (no event propagation
3310     * infrastructure taken in account).
3311     *
3312     * @note Not to be confused with @c
3313     * elm_object_signal_callback_add(), which will add callbacks to @b
3314     * signals coming from a widget's theme, not input events.
3315     *
3316     * @note Not to be confused with @c
3317     * edje_object_signal_callback_add(), which does the same as
3318     * elm_object_signal_callback_add(), but directly on an Edje
3319     * object.
3320     *
3321     * @note Not to be confused with @c
3322     * evas_object_smart_callback_add(), which adds callbacks to smart
3323     * objects' <b>smart events</b>, and not input events.
3324     *
3325     * @see elm_object_event_callback_del()
3326     *
3327     * @ingroup General
3328     */
3329    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3330
3331    /**
3332     * Remove an event callback from a widget.
3333     *
3334     * This function removes a callback, previoulsy attached to event emission
3335     * by the @p obj.
3336     * The parameters func and data must match exactly those passed to
3337     * a previous call to elm_object_event_callback_add(). The data pointer that
3338     * was passed to this call will be returned.
3339     *
3340     * @param obj The object
3341     * @param func The callback function to be executed when the event is
3342     * emitted.
3343     * @param data Data to pass in to the callback function.
3344     * @return The data pointer
3345     * @ingroup General
3346     */
3347    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3348
3349    /**
3350     * Adjust size of an element for finger usage.
3351     *
3352     * @param times_w How many fingers should fit horizontally
3353     * @param w Pointer to the width size to adjust
3354     * @param times_h How many fingers should fit vertically
3355     * @param h Pointer to the height size to adjust
3356     *
3357     * This takes width and height sizes (in pixels) as input and a
3358     * size multiple (which is how many fingers you want to place
3359     * within the area, being "finger" the size set by
3360     * elm_finger_size_set()), and adjusts the size to be large enough
3361     * to accommodate the resulting size -- if it doesn't already
3362     * accommodate it. On return the @p w and @p h sizes pointed to by
3363     * these parameters will be modified, on those conditions.
3364     *
3365     * @note This is kind of a low level Elementary call, most useful
3366     * on size evaluation times for widgets. An external user wouldn't
3367     * be calling, most of the time.
3368     *
3369     * @ingroup Fingers
3370     */
3371    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3372
3373    /**
3374     * Get the duration for occuring long press event.
3375     *
3376     * @return Timeout for long press event
3377     * @ingroup Longpress
3378     */
3379    EAPI double           elm_longpress_timeout_get(void);
3380
3381    /**
3382     * Set the duration for occuring long press event.
3383     *
3384     * @param lonpress_timeout Timeout for long press event
3385     * @ingroup Longpress
3386     */
3387    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3388
3389    /**
3390     * @defgroup Debug Debug
3391     * don't use it unless you are sure
3392     *
3393     * @{
3394     */
3395
3396    /**
3397     * Print Tree object hierarchy in stdout
3398     *
3399     * @param obj The root object
3400     * @ingroup Debug
3401     */
3402    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3403
3404    /**
3405     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3406     *
3407     * @param obj The root object
3408     * @param file The path of output file
3409     * @ingroup Debug
3410     */
3411    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3412
3413    /**
3414     * @}
3415     */
3416
3417    /**
3418     * @defgroup Theme Theme
3419     *
3420     * Elementary uses Edje to theme its widgets, naturally. But for the most
3421     * part this is hidden behind a simpler interface that lets the user set
3422     * extensions and choose the style of widgets in a much easier way.
3423     *
3424     * Instead of thinking in terms of paths to Edje files and their groups
3425     * each time you want to change the appearance of a widget, Elementary
3426     * works so you can add any theme file with extensions or replace the
3427     * main theme at one point in the application, and then just set the style
3428     * of widgets with elm_object_style_set() and related functions. Elementary
3429     * will then look in its list of themes for a matching group and apply it,
3430     * and when the theme changes midway through the application, all widgets
3431     * will be updated accordingly.
3432     *
3433     * There are three concepts you need to know to understand how Elementary
3434     * theming works: default theme, extensions and overlays.
3435     *
3436     * Default theme, obviously enough, is the one that provides the default
3437     * look of all widgets. End users can change the theme used by Elementary
3438     * by setting the @c ELM_THEME environment variable before running an
3439     * application, or globally for all programs using the @c elementary_config
3440     * utility. Applications can change the default theme using elm_theme_set(),
3441     * but this can go against the user wishes, so it's not an adviced practice.
3442     *
3443     * Ideally, applications should find everything they need in the already
3444     * provided theme, but there may be occasions when that's not enough and
3445     * custom styles are required to correctly express the idea. For this
3446     * cases, Elementary has extensions.
3447     *
3448     * Extensions allow the application developer to write styles of its own
3449     * to apply to some widgets. This requires knowledge of how each widget
3450     * is themed, as extensions will always replace the entire group used by
3451     * the widget, so important signals and parts need to be there for the
3452     * object to behave properly (see documentation of Edje for details).
3453     * Once the theme for the extension is done, the application needs to add
3454     * it to the list of themes Elementary will look into, using
3455     * elm_theme_extension_add(), and set the style of the desired widgets as
3456     * he would normally with elm_object_style_set().
3457     *
3458     * Overlays, on the other hand, can replace the look of all widgets by
3459     * overriding the default style. Like extensions, it's up to the application
3460     * developer to write the theme for the widgets it wants, the difference
3461     * being that when looking for the theme, Elementary will check first the
3462     * list of overlays, then the set theme and lastly the list of extensions,
3463     * so with overlays it's possible to replace the default view and every
3464     * widget will be affected. This is very much alike to setting the whole
3465     * theme for the application and will probably clash with the end user
3466     * options, not to mention the risk of ending up with not matching styles
3467     * across the program. Unless there's a very special reason to use them,
3468     * overlays should be avoided for the resons exposed before.
3469     *
3470     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3471     * keeps one default internally and every function that receives one of
3472     * these can be called with NULL to refer to this default (except for
3473     * elm_theme_free()). It's possible to create a new instance of a
3474     * ::Elm_Theme to set other theme for a specific widget (and all of its
3475     * children), but this is as discouraged, if not even more so, than using
3476     * overlays. Don't use this unless you really know what you are doing.
3477     *
3478     * But to be less negative about things, you can look at the following
3479     * examples:
3480     * @li @ref theme_example_01 "Using extensions"
3481     * @li @ref theme_example_02 "Using overlays"
3482     *
3483     * @{
3484     */
3485    /**
3486     * @typedef Elm_Theme
3487     *
3488     * Opaque handler for the list of themes Elementary looks for when
3489     * rendering widgets.
3490     *
3491     * Stay out of this unless you really know what you are doing. For most
3492     * cases, sticking to the default is all a developer needs.
3493     */
3494    typedef struct _Elm_Theme Elm_Theme;
3495
3496    /**
3497     * Create a new specific theme
3498     *
3499     * This creates an empty specific theme that only uses the default theme. A
3500     * specific theme has its own private set of extensions and overlays too
3501     * (which are empty by default). Specific themes do not fall back to themes
3502     * of parent objects. They are not intended for this use. Use styles, overlays
3503     * and extensions when needed, but avoid specific themes unless there is no
3504     * other way (example: you want to have a preview of a new theme you are
3505     * selecting in a "theme selector" window. The preview is inside a scroller
3506     * and should display what the theme you selected will look like, but not
3507     * actually apply it yet. The child of the scroller will have a specific
3508     * theme set to show this preview before the user decides to apply it to all
3509     * applications).
3510     */
3511    EAPI Elm_Theme       *elm_theme_new(void);
3512    /**
3513     * Free a specific theme
3514     *
3515     * @param th The theme to free
3516     *
3517     * This frees a theme created with elm_theme_new().
3518     */
3519    EAPI void             elm_theme_free(Elm_Theme *th);
3520    /**
3521     * Copy the theme fom the source to the destination theme
3522     *
3523     * @param th The source theme to copy from
3524     * @param thdst The destination theme to copy data to
3525     *
3526     * This makes a one-time static copy of all the theme config, extensions
3527     * and overlays from @p th to @p thdst. If @p th references a theme, then
3528     * @p thdst is also set to reference it, with all the theme settings,
3529     * overlays and extensions that @p th had.
3530     */
3531    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3532    /**
3533     * Tell the source theme to reference the ref theme
3534     *
3535     * @param th The theme that will do the referencing
3536     * @param thref The theme that is the reference source
3537     *
3538     * This clears @p th to be empty and then sets it to refer to @p thref
3539     * so @p th acts as an override to @p thref, but where its overrides
3540     * don't apply, it will fall through to @p thref for configuration.
3541     */
3542    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3543    /**
3544     * Return the theme referred to
3545     *
3546     * @param th The theme to get the reference from
3547     * @return The referenced theme handle
3548     *
3549     * This gets the theme set as the reference theme by elm_theme_ref_set().
3550     * If no theme is set as a reference, NULL is returned.
3551     */
3552    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3553    /**
3554     * Return the default theme
3555     *
3556     * @return The default theme handle
3557     *
3558     * This returns the internal default theme setup handle that all widgets
3559     * use implicitly unless a specific theme is set. This is also often use
3560     * as a shorthand of NULL.
3561     */
3562    EAPI Elm_Theme       *elm_theme_default_get(void);
3563    /**
3564     * Prepends a theme overlay to the list of overlays
3565     *
3566     * @param th The theme to add to, or if NULL, the default theme
3567     * @param item The Edje file path to be used
3568     *
3569     * Use this if your application needs to provide some custom overlay theme
3570     * (An Edje file that replaces some default styles of widgets) where adding
3571     * new styles, or changing system theme configuration is not possible. Do
3572     * NOT use this instead of a proper system theme configuration. Use proper
3573     * configuration files, profiles, environment variables etc. to set a theme
3574     * so that the theme can be altered by simple confiugration by a user. Using
3575     * this call to achieve that effect is abusing the API and will create lots
3576     * of trouble.
3577     *
3578     * @see elm_theme_extension_add()
3579     */
3580    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3581    /**
3582     * Delete a theme overlay from the list of overlays
3583     *
3584     * @param th The theme to delete from, or if NULL, the default theme
3585     * @param item The name of the theme overlay
3586     *
3587     * @see elm_theme_overlay_add()
3588     */
3589    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3590    /**
3591     * Appends a theme extension to the list of extensions.
3592     *
3593     * @param th The theme to add to, or if NULL, the default theme
3594     * @param item The Edje file path to be used
3595     *
3596     * This is intended when an application needs more styles of widgets or new
3597     * widget themes that the default does not provide (or may not provide). The
3598     * application has "extended" usage by coming up with new custom style names
3599     * for widgets for specific uses, but as these are not "standard", they are
3600     * not guaranteed to be provided by a default theme. This means the
3601     * application is required to provide these extra elements itself in specific
3602     * Edje files. This call adds one of those Edje files to the theme search
3603     * path to be search after the default theme. The use of this call is
3604     * encouraged when default styles do not meet the needs of the application.
3605     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3606     *
3607     * @see elm_object_style_set()
3608     */
3609    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3610    /**
3611     * Deletes a theme extension from the list of extensions.
3612     *
3613     * @param th The theme to delete from, or if NULL, the default theme
3614     * @param item The name of the theme extension
3615     *
3616     * @see elm_theme_extension_add()
3617     */
3618    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3619    /**
3620     * Set the theme search order for the given theme
3621     *
3622     * @param th The theme to set the search order, or if NULL, the default theme
3623     * @param theme Theme search string
3624     *
3625     * This sets the search string for the theme in path-notation from first
3626     * theme to search, to last, delimited by the : character. Example:
3627     *
3628     * "shiny:/path/to/file.edj:default"
3629     *
3630     * See the ELM_THEME environment variable for more information.
3631     *
3632     * @see elm_theme_get()
3633     * @see elm_theme_list_get()
3634     */
3635    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3636    /**
3637     * Return the theme search order
3638     *
3639     * @param th The theme to get the search order, or if NULL, the default theme
3640     * @return The internal search order path
3641     *
3642     * This function returns a colon separated string of theme elements as
3643     * returned by elm_theme_list_get().
3644     *
3645     * @see elm_theme_set()
3646     * @see elm_theme_list_get()
3647     */
3648    EAPI const char      *elm_theme_get(Elm_Theme *th);
3649    /**
3650     * Return a list of theme elements to be used in a theme.
3651     *
3652     * @param th Theme to get the list of theme elements from.
3653     * @return The internal list of theme elements
3654     *
3655     * This returns the internal list of theme elements (will only be valid as
3656     * long as the theme is not modified by elm_theme_set() or theme is not
3657     * freed by elm_theme_free(). This is a list of strings which must not be
3658     * altered as they are also internal. If @p th is NULL, then the default
3659     * theme element list is returned.
3660     *
3661     * A theme element can consist of a full or relative path to a .edj file,
3662     * or a name, without extension, for a theme to be searched in the known
3663     * theme paths for Elemementary.
3664     *
3665     * @see elm_theme_set()
3666     * @see elm_theme_get()
3667     */
3668    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3669    /**
3670     * Return the full patrh for a theme element
3671     *
3672     * @param f The theme element name
3673     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3674     * @return The full path to the file found.
3675     *
3676     * This returns a string you should free with free() on success, NULL on
3677     * failure. This will search for the given theme element, and if it is a
3678     * full or relative path element or a simple searchable name. The returned
3679     * path is the full path to the file, if searched, and the file exists, or it
3680     * is simply the full path given in the element or a resolved path if
3681     * relative to home. The @p in_search_path boolean pointed to is set to
3682     * EINA_TRUE if the file was a searchable file andis in the search path,
3683     * and EINA_FALSE otherwise.
3684     */
3685    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3686    /**
3687     * Flush the current theme.
3688     *
3689     * @param th Theme to flush
3690     *
3691     * This flushes caches that let elementary know where to find theme elements
3692     * in the given theme. If @p th is NULL, then the default theme is flushed.
3693     * Call this function if source theme data has changed in such a way as to
3694     * make any caches Elementary kept invalid.
3695     */
3696    EAPI void             elm_theme_flush(Elm_Theme *th);
3697    /**
3698     * This flushes all themes (default and specific ones).
3699     *
3700     * This will flush all themes in the current application context, by calling
3701     * elm_theme_flush() on each of them.
3702     */
3703    EAPI void             elm_theme_full_flush(void);
3704    /**
3705     * Set the theme for all elementary using applications on the current display
3706     *
3707     * @param theme The name of the theme to use. Format same as the ELM_THEME
3708     * environment variable.
3709     */
3710    EAPI void             elm_theme_all_set(const char *theme);
3711    /**
3712     * Return a list of theme elements in the theme search path
3713     *
3714     * @return A list of strings that are the theme element names.
3715     *
3716     * This lists all available theme files in the standard Elementary search path
3717     * for theme elements, and returns them in alphabetical order as theme
3718     * element names in a list of strings. Free this with
3719     * elm_theme_name_available_list_free() when you are done with the list.
3720     */
3721    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3722    /**
3723     * Free the list returned by elm_theme_name_available_list_new()
3724     *
3725     * This frees the list of themes returned by
3726     * elm_theme_name_available_list_new(). Once freed the list should no longer
3727     * be used. a new list mys be created.
3728     */
3729    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3730    /**
3731     * Set a specific theme to be used for this object and its children
3732     *
3733     * @param obj The object to set the theme on
3734     * @param th The theme to set
3735     *
3736     * This sets a specific theme that will be used for the given object and any
3737     * child objects it has. If @p th is NULL then the theme to be used is
3738     * cleared and the object will inherit its theme from its parent (which
3739     * ultimately will use the default theme if no specific themes are set).
3740     *
3741     * Use special themes with great care as this will annoy users and make
3742     * configuration difficult. Avoid any custom themes at all if it can be
3743     * helped.
3744     */
3745    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3746    /**
3747     * Get the specific theme to be used
3748     *
3749     * @param obj The object to get the specific theme from
3750     * @return The specifc theme set.
3751     *
3752     * This will return a specific theme set, or NULL if no specific theme is
3753     * set on that object. It will not return inherited themes from parents, only
3754     * the specific theme set for that specific object. See elm_object_theme_set()
3755     * for more information.
3756     */
3757    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3758
3759    /**
3760     * Get a data item from a theme
3761     *
3762     * @param th The theme, or NULL for default theme
3763     * @param key The data key to search with
3764     * @return The data value, or NULL on failure
3765     *
3766     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3767     * It works the same way as edje_file_data_get() except that the return is stringshared.
3768     */
3769    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3770    /**
3771     * @}
3772     */
3773
3774    /* win */
3775    /** @defgroup Win Win
3776     *
3777     * @image html img/widget/win/preview-00.png
3778     * @image latex img/widget/win/preview-00.eps
3779     *
3780     * The window class of Elementary.  Contains functions to manipulate
3781     * windows. The Evas engine used to render the window contents is specified
3782     * in the system or user elementary config files (whichever is found last),
3783     * and can be overridden with the ELM_ENGINE environment variable for
3784     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3785     * compilation setup and modules actually installed at runtime) are (listed
3786     * in order of best supported and most likely to be complete and work to
3787     * lowest quality).
3788     *
3789     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3790     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3791     * rendering in X11)
3792     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3793     * exits)
3794     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3795     * rendering)
3796     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3797     * buffer)
3798     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3799     * rendering using SDL as the buffer)
3800     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3801     * GDI with software)
3802     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3803     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3804     * grayscale using dedicated 8bit software engine in X11)
3805     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3806     * X11 using 16bit software engine)
3807     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3808     * (Windows CE rendering via GDI with 16bit software renderer)
3809     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3810     * buffer with 16bit software renderer)
3811     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3812     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3813     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3814     *
3815     * All engines use a simple string to select the engine to render, EXCEPT
3816     * the "shot" engine. This actually encodes the output of the virtual
3817     * screenshot and how long to delay in the engine string. The engine string
3818     * is encoded in the following way:
3819     *
3820     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3821     *
3822     * Where options are separated by a ":" char if more than one option is
3823     * given, with delay, if provided being the first option and file the last
3824     * (order is important). The delay specifies how long to wait after the
3825     * window is shown before doing the virtual "in memory" rendering and then
3826     * save the output to the file specified by the file option (and then exit).
3827     * If no delay is given, the default is 0.5 seconds. If no file is given the
3828     * default output file is "out.png". Repeat option is for continous
3829     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3830     * fixed to "out001.png" Some examples of using the shot engine:
3831     *
3832     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3833     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3834     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3835     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3836     *   ELM_ENGINE="shot:" elementary_test
3837     *
3838     * Signals that you can add callbacks for are:
3839     *
3840     * @li "delete,request": the user requested to close the window. See
3841     * elm_win_autodel_set().
3842     * @li "focus,in": window got focus
3843     * @li "focus,out": window lost focus
3844     * @li "moved": window that holds the canvas was moved
3845     *
3846     * Examples:
3847     * @li @ref win_example_01
3848     *
3849     * @{
3850     */
3851    /**
3852     * Defines the types of window that can be created
3853     *
3854     * These are hints set on the window so that a running Window Manager knows
3855     * how the window should be handled and/or what kind of decorations it
3856     * should have.
3857     *
3858     * Currently, only the X11 backed engines use them.
3859     */
3860    typedef enum _Elm_Win_Type
3861      {
3862         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3863                          window. Almost every window will be created with this
3864                          type. */
3865         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3866         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3867                            window holding desktop icons. */
3868         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3869                         be kept on top of any other window by the Window
3870                         Manager. */
3871         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3872                            similar. */
3873         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3874         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3875                            pallete. */
3876         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3877         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3878                                  entry in a menubar is clicked. Typically used
3879                                  with elm_win_override_set(). This hint exists
3880                                  for completion only, as the EFL way of
3881                                  implementing a menu would not normally use a
3882                                  separate window for its contents. */
3883         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3884                               triggered by right-clicking an object. */
3885         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3886                            explanatory text that typically appear after the
3887                            mouse cursor hovers over an object for a while.
3888                            Typically used with elm_win_override_set() and also
3889                            not very commonly used in the EFL. */
3890         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3891                                 battery life or a new E-Mail received. */
3892         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3893                          usually used in the EFL. */
3894         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3895                        object being dragged across different windows, or even
3896                        applications. Typically used with
3897                        elm_win_override_set(). */
3898         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3899                                  buffer. No actual window is created for this
3900                                  type, instead the window and all of its
3901                                  contents will be rendered to an image buffer.
3902                                  This allows to have children window inside a
3903                                  parent one just like any other object would
3904                                  be, and do other things like applying @c
3905                                  Evas_Map effects to it. This is the only type
3906                                  of window that requires the @c parent
3907                                  parameter of elm_win_add() to be a valid @c
3908                                  Evas_Object. */
3909      } Elm_Win_Type;
3910
3911    /**
3912     * The differents layouts that can be requested for the virtual keyboard.
3913     *
3914     * When the application window is being managed by Illume, it may request
3915     * any of the following layouts for the virtual keyboard.
3916     */
3917    typedef enum _Elm_Win_Keyboard_Mode
3918      {
3919         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3920         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3921         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3922         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3923         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3924         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3925         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3926         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3927         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3928         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3929         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3930         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3931         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3932         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3933         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3934         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3935      } Elm_Win_Keyboard_Mode;
3936
3937    /**
3938     * Available commands that can be sent to the Illume manager.
3939     *
3940     * When running under an Illume session, a window may send commands to the
3941     * Illume manager to perform different actions.
3942     */
3943    typedef enum _Elm_Illume_Command
3944      {
3945         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3946                                          window */
3947         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3948                                             in the list */
3949         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3950                                          screen */
3951         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3952      } Elm_Illume_Command;
3953
3954    /**
3955     * Adds a window object. If this is the first window created, pass NULL as
3956     * @p parent.
3957     *
3958     * @param parent Parent object to add the window to, or NULL
3959     * @param name The name of the window
3960     * @param type The window type, one of #Elm_Win_Type.
3961     *
3962     * The @p parent paramter can be @c NULL for every window @p type except
3963     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3964     * which the image object will be created.
3965     *
3966     * @return The created object, or NULL on failure
3967     */
3968    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3969    /**
3970     * Adds a window object with standard setup
3971     *
3972     * @param name The name of the window
3973     * @param title The title for the window
3974     *
3975     * This creates a window like elm_win_add() but also puts in a standard
3976     * background with elm_bg_add(), as well as setting the window title to
3977     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3978     * as the parent widget.
3979     * 
3980     * @return The created object, or NULL on failure
3981     *
3982     * @see elm_win_add()
3983     */
3984    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3985    /**
3986     * Add @p subobj as a resize object of window @p obj.
3987     *
3988     *
3989     * Setting an object as a resize object of the window means that the
3990     * @p subobj child's size and position will be controlled by the window
3991     * directly. That is, the object will be resized to match the window size
3992     * and should never be moved or resized manually by the developer.
3993     *
3994     * In addition, resize objects of the window control what the minimum size
3995     * of it will be, as well as whether it can or not be resized by the user.
3996     *
3997     * For the end user to be able to resize a window by dragging the handles
3998     * or borders provided by the Window Manager, or using any other similar
3999     * mechanism, all of the resize objects in the window should have their
4000     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4001     *
4002     * @param obj The window object
4003     * @param subobj The resize object to add
4004     */
4005    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4006    /**
4007     * Delete @p subobj as a resize object of window @p obj.
4008     *
4009     * This function removes the object @p subobj from the resize objects of
4010     * the window @p obj. It will not delete the object itself, which will be
4011     * left unmanaged and should be deleted by the developer, manually handled
4012     * or set as child of some other container.
4013     *
4014     * @param obj The window object
4015     * @param subobj The resize object to add
4016     */
4017    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4018    /**
4019     * Set the title of the window
4020     *
4021     * @param obj The window object
4022     * @param title The title to set
4023     */
4024    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4025    /**
4026     * Get the title of the window
4027     *
4028     * The returned string is an internal one and should not be freed or
4029     * modified. It will also be rendered invalid if a new title is set or if
4030     * the window is destroyed.
4031     *
4032     * @param obj The window object
4033     * @return The title
4034     */
4035    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4036    /**
4037     * Set the window's autodel state.
4038     *
4039     * When closing the window in any way outside of the program control, like
4040     * pressing the X button in the titlebar or using a command from the
4041     * Window Manager, a "delete,request" signal is emitted to indicate that
4042     * this event occurred and the developer can take any action, which may
4043     * include, or not, destroying the window object.
4044     *
4045     * When the @p autodel parameter is set, the window will be automatically
4046     * destroyed when this event occurs, after the signal is emitted.
4047     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4048     * and is up to the program to do so when it's required.
4049     *
4050     * @param obj The window object
4051     * @param autodel If true, the window will automatically delete itself when
4052     * closed
4053     */
4054    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4055    /**
4056     * Get the window's autodel state.
4057     *
4058     * @param obj The window object
4059     * @return If the window will automatically delete itself when closed
4060     *
4061     * @see elm_win_autodel_set()
4062     */
4063    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4064    /**
4065     * Activate a window object.
4066     *
4067     * This function sends a request to the Window Manager to activate the
4068     * window pointed by @p obj. If honored by the WM, the window will receive
4069     * the keyboard focus.
4070     *
4071     * @note This is just a request that a Window Manager may ignore, so calling
4072     * this function does not ensure in any way that the window will be the
4073     * active one after it.
4074     *
4075     * @param obj The window object
4076     */
4077    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4078    /**
4079     * Lower a window object.
4080     *
4081     * Places the window pointed by @p obj at the bottom of the stack, so that
4082     * no other window is covered by it.
4083     *
4084     * If elm_win_override_set() is not set, the Window Manager may ignore this
4085     * request.
4086     *
4087     * @param obj The window object
4088     */
4089    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4090    /**
4091     * Raise a window object.
4092     *
4093     * Places the window pointed by @p obj at the top of the stack, so that it's
4094     * not covered by any other window.
4095     *
4096     * If elm_win_override_set() is not set, the Window Manager may ignore this
4097     * request.
4098     *
4099     * @param obj The window object
4100     */
4101    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4102    /**
4103     * Set the borderless state of a window.
4104     *
4105     * This function requests the Window Manager to not draw any decoration
4106     * around the window.
4107     *
4108     * @param obj The window object
4109     * @param borderless If true, the window is borderless
4110     */
4111    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4112    /**
4113     * Get the borderless state of a window.
4114     *
4115     * @param obj The window object
4116     * @return If true, the window is borderless
4117     */
4118    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4119    /**
4120     * Set the shaped state of a window.
4121     *
4122     * Shaped windows, when supported, will render the parts of the window that
4123     * has no content, transparent.
4124     *
4125     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4126     * background object or cover the entire window in any other way, or the
4127     * parts of the canvas that have no data will show framebuffer artifacts.
4128     *
4129     * @param obj The window object
4130     * @param shaped If true, the window is shaped
4131     *
4132     * @see elm_win_alpha_set()
4133     */
4134    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4135    /**
4136     * Get the shaped state of a window.
4137     *
4138     * @param obj The window object
4139     * @return If true, the window is shaped
4140     *
4141     * @see elm_win_shaped_set()
4142     */
4143    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4144    /**
4145     * Set the alpha channel state of a window.
4146     *
4147     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4148     * possibly making parts of the window completely or partially transparent.
4149     * This is also subject to the underlying system supporting it, like for
4150     * example, running under a compositing manager. If no compositing is
4151     * available, enabling this option will instead fallback to using shaped
4152     * windows, with elm_win_shaped_set().
4153     *
4154     * @param obj The window object
4155     * @param alpha If true, the window has an alpha channel
4156     *
4157     * @see elm_win_alpha_set()
4158     */
4159    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4160    /**
4161     * Get the transparency state of a window.
4162     *
4163     * @param obj The window object
4164     * @return If true, the window is transparent
4165     *
4166     * @see elm_win_transparent_set()
4167     */
4168    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4169    /**
4170     * Set the transparency state of a window.
4171     *
4172     * Use elm_win_alpha_set() instead.
4173     *
4174     * @param obj The window object
4175     * @param transparent If true, the window is transparent
4176     *
4177     * @see elm_win_alpha_set()
4178     */
4179    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4180    /**
4181     * Get the alpha channel state of a window.
4182     *
4183     * @param obj The window object
4184     * @return If true, the window has an alpha channel
4185     */
4186    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4187    /**
4188     * Set the override state of a window.
4189     *
4190     * A window with @p override set to EINA_TRUE will not be managed by the
4191     * Window Manager. This means that no decorations of any kind will be shown
4192     * for it, moving and resizing must be handled by the application, as well
4193     * as the window visibility.
4194     *
4195     * This should not be used for normal windows, and even for not so normal
4196     * ones, it should only be used when there's a good reason and with a lot
4197     * of care. Mishandling override windows may result situations that
4198     * disrupt the normal workflow of the end user.
4199     *
4200     * @param obj The window object
4201     * @param override If true, the window is overridden
4202     */
4203    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4204    /**
4205     * Get the override state of a window.
4206     *
4207     * @param obj The window object
4208     * @return If true, the window is overridden
4209     *
4210     * @see elm_win_override_set()
4211     */
4212    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4213    /**
4214     * Set the fullscreen state of a window.
4215     *
4216     * @param obj The window object
4217     * @param fullscreen If true, the window is fullscreen
4218     */
4219    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4220    /**
4221     * Get the fullscreen state of a window.
4222     *
4223     * @param obj The window object
4224     * @return If true, the window is fullscreen
4225     */
4226    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4227    /**
4228     * Set the maximized state of a window.
4229     *
4230     * @param obj The window object
4231     * @param maximized If true, the window is maximized
4232     */
4233    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4234    /**
4235     * Get the maximized state of a window.
4236     *
4237     * @param obj The window object
4238     * @return If true, the window is maximized
4239     */
4240    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4241    /**
4242     * Set the iconified state of a window.
4243     *
4244     * @param obj The window object
4245     * @param iconified If true, the window is iconified
4246     */
4247    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4248    /**
4249     * Get the iconified state of a window.
4250     *
4251     * @param obj The window object
4252     * @return If true, the window is iconified
4253     */
4254    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4255    /**
4256     * Set the layer of the window.
4257     *
4258     * What this means exactly will depend on the underlying engine used.
4259     *
4260     * In the case of X11 backed engines, the value in @p layer has the
4261     * following meanings:
4262     * @li < 3: The window will be placed below all others.
4263     * @li > 5: The window will be placed above all others.
4264     * @li other: The window will be placed in the default layer.
4265     *
4266     * @param obj The window object
4267     * @param layer The layer of the window
4268     */
4269    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4270    /**
4271     * Get the layer of the window.
4272     *
4273     * @param obj The window object
4274     * @return The layer of the window
4275     *
4276     * @see elm_win_layer_set()
4277     */
4278    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4279    /**
4280     * Set the rotation of the window.
4281     *
4282     * Most engines only work with multiples of 90.
4283     *
4284     * This function is used to set the orientation of the window @p obj to
4285     * match that of the screen. The window itself will be resized to adjust
4286     * to the new geometry of its contents. If you want to keep the window size,
4287     * see elm_win_rotation_with_resize_set().
4288     *
4289     * @param obj The window object
4290     * @param rotation The rotation of the window, in degrees (0-360),
4291     * counter-clockwise.
4292     */
4293    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4294    /**
4295     * Rotates the window and resizes it.
4296     *
4297     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4298     * that they fit inside the current window geometry.
4299     *
4300     * @param obj The window object
4301     * @param layer The rotation of the window in degrees (0-360),
4302     * counter-clockwise.
4303     */
4304    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4305    /**
4306     * Get the rotation of the window.
4307     *
4308     * @param obj The window object
4309     * @return The rotation of the window in degrees (0-360)
4310     *
4311     * @see elm_win_rotation_set()
4312     * @see elm_win_rotation_with_resize_set()
4313     */
4314    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4315    /**
4316     * Set the sticky state of the window.
4317     *
4318     * Hints the Window Manager that the window in @p obj should be left fixed
4319     * at its position even when the virtual desktop it's on moves or changes.
4320     *
4321     * @param obj The window object
4322     * @param sticky If true, the window's sticky state is enabled
4323     */
4324    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4325    /**
4326     * Get the sticky state of the window.
4327     *
4328     * @param obj The window object
4329     * @return If true, the window's sticky state is enabled
4330     *
4331     * @see elm_win_sticky_set()
4332     */
4333    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4334    /**
4335     * Set if this window is an illume conformant window
4336     *
4337     * @param obj The window object
4338     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4339     */
4340    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4341    /**
4342     * Get if this window is an illume conformant window
4343     *
4344     * @param obj The window object
4345     * @return A boolean if this window is illume conformant or not
4346     */
4347    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4348    /**
4349     * Set a window to be an illume quickpanel window
4350     *
4351     * By default window objects are not quickpanel windows.
4352     *
4353     * @param obj The window object
4354     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4355     */
4356    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4357    /**
4358     * Get if this window is a quickpanel or not
4359     *
4360     * @param obj The window object
4361     * @return A boolean if this window is a quickpanel or not
4362     */
4363    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4364    /**
4365     * Set the major priority of a quickpanel window
4366     *
4367     * @param obj The window object
4368     * @param priority The major priority for this quickpanel
4369     */
4370    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4371    /**
4372     * Get the major priority of a quickpanel window
4373     *
4374     * @param obj The window object
4375     * @return The major priority of this quickpanel
4376     */
4377    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4378    /**
4379     * Set the minor priority of a quickpanel window
4380     *
4381     * @param obj The window object
4382     * @param priority The minor priority for this quickpanel
4383     */
4384    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4385    /**
4386     * Get the minor priority of a quickpanel window
4387     *
4388     * @param obj The window object
4389     * @return The minor priority of this quickpanel
4390     */
4391    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4392    /**
4393     * Set which zone this quickpanel should appear in
4394     *
4395     * @param obj The window object
4396     * @param zone The requested zone for this quickpanel
4397     */
4398    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4399    /**
4400     * Get which zone this quickpanel should appear in
4401     *
4402     * @param obj The window object
4403     * @return The requested zone for this quickpanel
4404     */
4405    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4406    /**
4407     * Set the window to be skipped by keyboard focus
4408     *
4409     * This sets the window to be skipped by normal keyboard input. This means
4410     * a window manager will be asked to not focus this window as well as omit
4411     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4412     *
4413     * Call this and enable it on a window BEFORE you show it for the first time,
4414     * otherwise it may have no effect.
4415     *
4416     * Use this for windows that have only output information or might only be
4417     * interacted with by the mouse or fingers, and never for typing input.
4418     * Be careful that this may have side-effects like making the window
4419     * non-accessible in some cases unless the window is specially handled. Use
4420     * this with care.
4421     *
4422     * @param obj The window object
4423     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4424     */
4425    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4426    /**
4427     * Send a command to the windowing environment
4428     *
4429     * This is intended to work in touchscreen or small screen device
4430     * environments where there is a more simplistic window management policy in
4431     * place. This uses the window object indicated to select which part of the
4432     * environment to control (the part that this window lives in), and provides
4433     * a command and an optional parameter structure (use NULL for this if not
4434     * needed).
4435     *
4436     * @param obj The window object that lives in the environment to control
4437     * @param command The command to send
4438     * @param params Optional parameters for the command
4439     */
4440    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4441    /**
4442     * Get the inlined image object handle
4443     *
4444     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4445     * then the window is in fact an evas image object inlined in the parent
4446     * canvas. You can get this object (be careful to not manipulate it as it
4447     * is under control of elementary), and use it to do things like get pixel
4448     * data, save the image to a file, etc.
4449     *
4450     * @param obj The window object to get the inlined image from
4451     * @return The inlined image object, or NULL if none exists
4452     */
4453    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4454    /**
4455     * Set the enabled status for the focus highlight in a window
4456     *
4457     * This function will enable or disable the focus highlight only for the
4458     * given window, regardless of the global setting for it
4459     *
4460     * @param obj The window where to enable the highlight
4461     * @param enabled The enabled value for the highlight
4462     */
4463    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4464    /**
4465     * Get the enabled value of the focus highlight for this window
4466     *
4467     * @param obj The window in which to check if the focus highlight is enabled
4468     *
4469     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4470     */
4471    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4472    /**
4473     * Set the style for the focus highlight on this window
4474     *
4475     * Sets the style to use for theming the highlight of focused objects on
4476     * the given window. If @p style is NULL, the default will be used.
4477     *
4478     * @param obj The window where to set the style
4479     * @param style The style to set
4480     */
4481    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4482    /**
4483     * Get the style set for the focus highlight object
4484     *
4485     * Gets the style set for this windows highilght object, or NULL if none
4486     * is set.
4487     *
4488     * @param obj The window to retrieve the highlights style from
4489     *
4490     * @return The style set or NULL if none was. Default is used in that case.
4491     */
4492    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4493    /*...
4494     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4495     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4496     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4497     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4498     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4499     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4500     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4501     *
4502     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4503     * (blank mouse, private mouse obj, defaultmouse)
4504     *
4505     */
4506    /**
4507     * Sets the keyboard mode of the window.
4508     *
4509     * @param obj The window object
4510     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4511     */
4512    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4513    /**
4514     * Gets the keyboard mode of the window.
4515     *
4516     * @param obj The window object
4517     * @return The mode, one of #Elm_Win_Keyboard_Mode
4518     */
4519    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4520    /**
4521     * Sets whether the window is a keyboard.
4522     *
4523     * @param obj The window object
4524     * @param is_keyboard If true, the window is a virtual keyboard
4525     */
4526    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4527    /**
4528     * Gets whether the window is a keyboard.
4529     *
4530     * @param obj The window object
4531     * @return If the window is a virtual keyboard
4532     */
4533    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4534
4535    /**
4536     * Get the screen position of a window.
4537     *
4538     * @param obj The window object
4539     * @param x The int to store the x coordinate to
4540     * @param y The int to store the y coordinate to
4541     */
4542    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4543    /**
4544     * @}
4545     */
4546
4547    /**
4548     * @defgroup Inwin Inwin
4549     *
4550     * @image html img/widget/inwin/preview-00.png
4551     * @image latex img/widget/inwin/preview-00.eps
4552     * @image html img/widget/inwin/preview-01.png
4553     * @image latex img/widget/inwin/preview-01.eps
4554     * @image html img/widget/inwin/preview-02.png
4555     * @image latex img/widget/inwin/preview-02.eps
4556     *
4557     * An inwin is a window inside a window that is useful for a quick popup.
4558     * It does not hover.
4559     *
4560     * It works by creating an object that will occupy the entire window, so it
4561     * must be created using an @ref Win "elm_win" as parent only. The inwin
4562     * object can be hidden or restacked below every other object if it's
4563     * needed to show what's behind it without destroying it. If this is done,
4564     * the elm_win_inwin_activate() function can be used to bring it back to
4565     * full visibility again.
4566     *
4567     * There are three styles available in the default theme. These are:
4568     * @li default: The inwin is sized to take over most of the window it's
4569     * placed in.
4570     * @li minimal: The size of the inwin will be the minimum necessary to show
4571     * its contents.
4572     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4573     * possible, but it's sized vertically the most it needs to fit its\
4574     * contents.
4575     *
4576     * Some examples of Inwin can be found in the following:
4577     * @li @ref inwin_example_01
4578     *
4579     * @{
4580     */
4581    /**
4582     * Adds an inwin to the current window
4583     *
4584     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4585     * Never call this function with anything other than the top-most window
4586     * as its parameter, unless you are fond of undefined behavior.
4587     *
4588     * After creating the object, the widget will set itself as resize object
4589     * for the window with elm_win_resize_object_add(), so when shown it will
4590     * appear to cover almost the entire window (how much of it depends on its
4591     * content and the style used). It must not be added into other container
4592     * objects and it needs not be moved or resized manually.
4593     *
4594     * @param parent The parent object
4595     * @return The new object or NULL if it cannot be created
4596     */
4597    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4598    /**
4599     * Activates an inwin object, ensuring its visibility
4600     *
4601     * This function will make sure that the inwin @p obj is completely visible
4602     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4603     * to the front. It also sets the keyboard focus to it, which will be passed
4604     * onto its content.
4605     *
4606     * The object's theme will also receive the signal "elm,action,show" with
4607     * source "elm".
4608     *
4609     * @param obj The inwin to activate
4610     */
4611    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4612    /**
4613     * Set the content of an inwin object.
4614     *
4615     * Once the content object is set, a previously set one will be deleted.
4616     * If you want to keep that old content object, use the
4617     * elm_win_inwin_content_unset() function.
4618     *
4619     * @param obj The inwin object
4620     * @param content The object to set as content
4621     */
4622    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4623    /**
4624     * Get the content of an inwin object.
4625     *
4626     * Return the content object which is set for this widget.
4627     *
4628     * The returned object is valid as long as the inwin is still alive and no
4629     * other content is set on it. Deleting the object will notify the inwin
4630     * about it and this one will be left empty.
4631     *
4632     * If you need to remove an inwin's content to be reused somewhere else,
4633     * see elm_win_inwin_content_unset().
4634     *
4635     * @param obj The inwin object
4636     * @return The content that is being used
4637     */
4638    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4639    /**
4640     * Unset the content of an inwin object.
4641     *
4642     * Unparent and return the content object which was set for this widget.
4643     *
4644     * @param obj The inwin object
4645     * @return The content that was being used
4646     */
4647    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4648    /**
4649     * @}
4650     */
4651    /* X specific calls - won't work on non-x engines (return 0) */
4652
4653    /**
4654     * Get the Ecore_X_Window of an Evas_Object
4655     *
4656     * @param obj The object
4657     *
4658     * @return The Ecore_X_Window of @p obj
4659     *
4660     * @ingroup Win
4661     */
4662    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4663
4664    /* smart callbacks called:
4665     * "delete,request" - the user requested to delete the window
4666     * "focus,in" - window got focus
4667     * "focus,out" - window lost focus
4668     * "moved" - window that holds the canvas was moved
4669     */
4670
4671    /**
4672     * @defgroup Bg Bg
4673     *
4674     * @image html img/widget/bg/preview-00.png
4675     * @image latex img/widget/bg/preview-00.eps
4676     *
4677     * @brief Background object, used for setting a solid color, image or Edje
4678     * group as background to a window or any container object.
4679     *
4680     * The bg object is used for setting a solid background to a window or
4681     * packing into any container object. It works just like an image, but has
4682     * some properties useful to a background, like setting it to tiled,
4683     * centered, scaled or stretched.
4684     * 
4685     * Default contents parts of the bg widget that you can use for are:
4686     * @li "overlay" - overlay of the bg
4687     *
4688     * Here is some sample code using it:
4689     * @li @ref bg_01_example_page
4690     * @li @ref bg_02_example_page
4691     * @li @ref bg_03_example_page
4692     */
4693
4694    /* bg */
4695    typedef enum _Elm_Bg_Option
4696      {
4697         ELM_BG_OPTION_CENTER,  /**< center the background */
4698         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4699         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4700         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4701      } Elm_Bg_Option;
4702
4703    /**
4704     * Add a new background to the parent
4705     *
4706     * @param parent The parent object
4707     * @return The new object or NULL if it cannot be created
4708     *
4709     * @ingroup Bg
4710     */
4711    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4712
4713    /**
4714     * Set the file (image or edje) used for the background
4715     *
4716     * @param obj The bg object
4717     * @param file The file path
4718     * @param group Optional key (group in Edje) within the file
4719     *
4720     * This sets the image file used in the background object. The image (or edje)
4721     * will be stretched (retaining aspect if its an image file) to completely fill
4722     * the bg object. This may mean some parts are not visible.
4723     *
4724     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4725     * even if @p file is NULL.
4726     *
4727     * @ingroup Bg
4728     */
4729    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4730
4731    /**
4732     * Get the file (image or edje) used for the background
4733     *
4734     * @param obj The bg object
4735     * @param file The file path
4736     * @param group Optional key (group in Edje) within the file
4737     *
4738     * @ingroup Bg
4739     */
4740    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4741
4742    /**
4743     * Set the option used for the background image
4744     *
4745     * @param obj The bg object
4746     * @param option The desired background option (TILE, SCALE)
4747     *
4748     * This sets the option used for manipulating the display of the background
4749     * image. The image can be tiled or scaled.
4750     *
4751     * @ingroup Bg
4752     */
4753    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4754
4755    /**
4756     * Get the option used for the background image
4757     *
4758     * @param obj The bg object
4759     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4760     *
4761     * @ingroup Bg
4762     */
4763    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4764    /**
4765     * Set the option used for the background color
4766     *
4767     * @param obj The bg object
4768     * @param r
4769     * @param g
4770     * @param b
4771     *
4772     * This sets the color used for the background rectangle. Its range goes
4773     * from 0 to 255.
4774     *
4775     * @ingroup Bg
4776     */
4777    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4778    /**
4779     * Get the option used for the background color
4780     *
4781     * @param obj The bg object
4782     * @param r
4783     * @param g
4784     * @param b
4785     *
4786     * @ingroup Bg
4787     */
4788    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4789
4790    /**
4791     * Set the overlay object used for the background object.
4792     *
4793     * @param obj The bg object
4794     * @param overlay The overlay object
4795     *
4796     * This provides a way for elm_bg to have an 'overlay' that will be on top
4797     * of the bg. Once the over object is set, a previously set one will be
4798     * deleted, even if you set the new one to NULL. If you want to keep that
4799     * old content object, use the elm_bg_overlay_unset() function.
4800     *
4801     * @deprecated use elm_object_part_content_set() instead
4802     *
4803     * @ingroup Bg
4804     */
4805
4806    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4807
4808    /**
4809     * Get the overlay object used for the background object.
4810     *
4811     * @param obj The bg object
4812     * @return The content that is being used
4813     *
4814     * Return the content object which is set for this widget
4815     *
4816     * @deprecated use elm_object_part_content_get() instead
4817     *
4818     * @ingroup Bg
4819     */
4820    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4821
4822    /**
4823     * Get the overlay object used for the background object.
4824     *
4825     * @param obj The bg object
4826     * @return The content that was being used
4827     *
4828     * Unparent and return the overlay object which was set for this widget
4829     *
4830     * @deprecated use elm_object_part_content_unset() instead
4831     *
4832     * @ingroup Bg
4833     */
4834    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4835
4836    /**
4837     * Set the size of the pixmap representation of the image.
4838     *
4839     * This option just makes sense if an image is going to be set in the bg.
4840     *
4841     * @param obj The bg object
4842     * @param w The new width of the image pixmap representation.
4843     * @param h The new height of the image pixmap representation.
4844     *
4845     * This function sets a new size for pixmap representation of the given bg
4846     * image. It allows the image to be loaded already in the specified size,
4847     * reducing the memory usage and load time when loading a big image with load
4848     * size set to a smaller size.
4849     *
4850     * NOTE: this is just a hint, the real size of the pixmap may differ
4851     * depending on the type of image being loaded, being bigger than requested.
4852     *
4853     * @ingroup Bg
4854     */
4855    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4856    /* smart callbacks called:
4857     */
4858
4859    /**
4860     * @defgroup Icon Icon
4861     *
4862     * @image html img/widget/icon/preview-00.png
4863     * @image latex img/widget/icon/preview-00.eps
4864     *
4865     * An object that provides standard icon images (delete, edit, arrows, etc.)
4866     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4867     *
4868     * The icon image requested can be in the elementary theme, or in the
4869     * freedesktop.org paths. It's possible to set the order of preference from
4870     * where the image will be used.
4871     *
4872     * This API is very similar to @ref Image, but with ready to use images.
4873     *
4874     * Default images provided by the theme are described below.
4875     *
4876     * The first list contains icons that were first intended to be used in
4877     * toolbars, but can be used in many other places too:
4878     * @li home
4879     * @li close
4880     * @li apps
4881     * @li arrow_up
4882     * @li arrow_down
4883     * @li arrow_left
4884     * @li arrow_right
4885     * @li chat
4886     * @li clock
4887     * @li delete
4888     * @li edit
4889     * @li refresh
4890     * @li folder
4891     * @li file
4892     *
4893     * Now some icons that were designed to be used in menus (but again, you can
4894     * use them anywhere else):
4895     * @li menu/home
4896     * @li menu/close
4897     * @li menu/apps
4898     * @li menu/arrow_up
4899     * @li menu/arrow_down
4900     * @li menu/arrow_left
4901     * @li menu/arrow_right
4902     * @li menu/chat
4903     * @li menu/clock
4904     * @li menu/delete
4905     * @li menu/edit
4906     * @li menu/refresh
4907     * @li menu/folder
4908     * @li menu/file
4909     *
4910     * And here we have some media player specific icons:
4911     * @li media_player/forward
4912     * @li media_player/info
4913     * @li media_player/next
4914     * @li media_player/pause
4915     * @li media_player/play
4916     * @li media_player/prev
4917     * @li media_player/rewind
4918     * @li media_player/stop
4919     *
4920     * Signals that you can add callbacks for are:
4921     *
4922     * "clicked" - This is called when a user has clicked the icon
4923     *
4924     * An example of usage for this API follows:
4925     * @li @ref tutorial_icon
4926     */
4927
4928    /**
4929     * @addtogroup Icon
4930     * @{
4931     */
4932
4933    typedef enum _Elm_Icon_Type
4934      {
4935         ELM_ICON_NONE,
4936         ELM_ICON_FILE,
4937         ELM_ICON_STANDARD
4938      } Elm_Icon_Type;
4939    /**
4940     * @enum _Elm_Icon_Lookup_Order
4941     * @typedef Elm_Icon_Lookup_Order
4942     *
4943     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4944     * theme, FDO paths, or both?
4945     *
4946     * @ingroup Icon
4947     */
4948    typedef enum _Elm_Icon_Lookup_Order
4949      {
4950         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4951         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4952         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4953         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4954      } Elm_Icon_Lookup_Order;
4955
4956    /**
4957     * Add a new icon object to the parent.
4958     *
4959     * @param parent The parent object
4960     * @return The new object or NULL if it cannot be created
4961     *
4962     * @see elm_icon_file_set()
4963     *
4964     * @ingroup Icon
4965     */
4966    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4967    /**
4968     * Set the file that will be used as icon.
4969     *
4970     * @param obj The icon object
4971     * @param file The path to file that will be used as icon image
4972     * @param group The group that the icon belongs to an edje file
4973     *
4974     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4975     *
4976     * @note The icon image set by this function can be changed by
4977     * elm_icon_standard_set().
4978     *
4979     * @see elm_icon_file_get()
4980     *
4981     * @ingroup Icon
4982     */
4983    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4984    /**
4985     * Set a location in memory to be used as an icon
4986     *
4987     * @param obj The icon object
4988     * @param img The binary data that will be used as an image
4989     * @param size The size of binary data @p img
4990     * @param format Optional format of @p img to pass to the image loader
4991     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4992     *
4993     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4994     *
4995     * @note The icon image set by this function can be changed by
4996     * elm_icon_standard_set().
4997     *
4998     * @ingroup Icon
4999     */
5000    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);
5001    /**
5002     * Get the file that will be used as icon.
5003     *
5004     * @param obj The icon object
5005     * @param file The path to file that will be used as the icon image
5006     * @param group The group that the icon belongs to, in edje file
5007     *
5008     * @see elm_icon_file_set()
5009     *
5010     * @ingroup Icon
5011     */
5012    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5013    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5014    /**
5015     * Set the icon by icon standards names.
5016     *
5017     * @param obj The icon object
5018     * @param name The icon name
5019     *
5020     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5021     *
5022     * For example, freedesktop.org defines standard icon names such as "home",
5023     * "network", etc. There can be different icon sets to match those icon
5024     * keys. The @p name given as parameter is one of these "keys", and will be
5025     * used to look in the freedesktop.org paths and elementary theme. One can
5026     * change the lookup order with elm_icon_order_lookup_set().
5027     *
5028     * If name is not found in any of the expected locations and it is the
5029     * absolute path of an image file, this image will be used.
5030     *
5031     * @note The icon image set by this function can be changed by
5032     * elm_icon_file_set().
5033     *
5034     * @see elm_icon_standard_get()
5035     * @see elm_icon_file_set()
5036     *
5037     * @ingroup Icon
5038     */
5039    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5040    /**
5041     * Get the icon name set by icon standard names.
5042     *
5043     * @param obj The icon object
5044     * @return The icon name
5045     *
5046     * If the icon image was set using elm_icon_file_set() instead of
5047     * elm_icon_standard_set(), then this function will return @c NULL.
5048     *
5049     * @see elm_icon_standard_set()
5050     *
5051     * @ingroup Icon
5052     */
5053    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5054    /**
5055     * Set the smooth scaling for an icon object.
5056     *
5057     * @param obj The icon object
5058     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5059     * otherwise. Default is @c EINA_TRUE.
5060     *
5061     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5062     * scaling provides a better resulting image, but is slower.
5063     *
5064     * The smooth scaling should be disabled when making animations that change
5065     * the icon size, since they will be faster. Animations that don't require
5066     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5067     * is already scaled, since the scaled icon image will be cached).
5068     *
5069     * @see elm_icon_smooth_get()
5070     *
5071     * @ingroup Icon
5072     */
5073    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5074    /**
5075     * Get whether smooth scaling is enabled for an icon object.
5076     *
5077     * @param obj The icon object
5078     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5079     *
5080     * @see elm_icon_smooth_set()
5081     *
5082     * @ingroup Icon
5083     */
5084    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5085    /**
5086     * Disable scaling of this object.
5087     *
5088     * @param obj The icon object.
5089     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5090     * otherwise. Default is @c EINA_FALSE.
5091     *
5092     * This function disables scaling of the icon object through the function
5093     * elm_object_scale_set(). However, this does not affect the object
5094     * size/resize in any way. For that effect, take a look at
5095     * elm_icon_scale_set().
5096     *
5097     * @see elm_icon_no_scale_get()
5098     * @see elm_icon_scale_set()
5099     * @see elm_object_scale_set()
5100     *
5101     * @ingroup Icon
5102     */
5103    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5104    /**
5105     * Get whether scaling is disabled on the object.
5106     *
5107     * @param obj The icon object
5108     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5109     *
5110     * @see elm_icon_no_scale_set()
5111     *
5112     * @ingroup Icon
5113     */
5114    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5115    /**
5116     * Set if the object is (up/down) resizable.
5117     *
5118     * @param obj The icon object
5119     * @param scale_up A bool to set if the object is resizable up. Default is
5120     * @c EINA_TRUE.
5121     * @param scale_down A bool to set if the object is resizable down. Default
5122     * is @c EINA_TRUE.
5123     *
5124     * This function limits the icon object resize ability. If @p scale_up is set to
5125     * @c EINA_FALSE, the object can't have its height or width resized to a value
5126     * higher than the original icon size. Same is valid for @p scale_down.
5127     *
5128     * @see elm_icon_scale_get()
5129     *
5130     * @ingroup Icon
5131     */
5132    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5133    /**
5134     * Get if the object is (up/down) resizable.
5135     *
5136     * @param obj The icon object
5137     * @param scale_up A bool to set if the object is resizable up
5138     * @param scale_down A bool to set if the object is resizable down
5139     *
5140     * @see elm_icon_scale_set()
5141     *
5142     * @ingroup Icon
5143     */
5144    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5145    /**
5146     * Get the object's image size
5147     *
5148     * @param obj The icon object
5149     * @param w A pointer to store the width in
5150     * @param h A pointer to store the height in
5151     *
5152     * @ingroup Icon
5153     */
5154    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5155    /**
5156     * Set if the icon fill the entire object area.
5157     *
5158     * @param obj The icon object
5159     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5160     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5161     *
5162     * When the icon object is resized to a different aspect ratio from the
5163     * original icon image, the icon image will still keep its aspect. This flag
5164     * tells how the image should fill the object's area. They are: keep the
5165     * entire icon inside the limits of height and width of the object (@p
5166     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5167     * of the object, and the icon will fill the entire object (@p fill_outside
5168     * is @c EINA_TRUE).
5169     *
5170     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5171     * retain property to false. Thus, the icon image will always keep its
5172     * original aspect ratio.
5173     *
5174     * @see elm_icon_fill_outside_get()
5175     * @see elm_image_fill_outside_set()
5176     *
5177     * @ingroup Icon
5178     */
5179    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5180    /**
5181     * Get if the object is filled outside.
5182     *
5183     * @param obj The icon object
5184     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5185     *
5186     * @see elm_icon_fill_outside_set()
5187     *
5188     * @ingroup Icon
5189     */
5190    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5191    /**
5192     * Set the prescale size for the icon.
5193     *
5194     * @param obj The icon object
5195     * @param size The prescale size. This value is used for both width and
5196     * height.
5197     *
5198     * This function sets a new size for pixmap representation of the given
5199     * icon. It allows the icon to be loaded already in the specified size,
5200     * reducing the memory usage and load time when loading a big icon with load
5201     * size set to a smaller size.
5202     *
5203     * It's equivalent to the elm_bg_load_size_set() function for bg.
5204     *
5205     * @note this is just a hint, the real size of the pixmap may differ
5206     * depending on the type of icon being loaded, being bigger than requested.
5207     *
5208     * @see elm_icon_prescale_get()
5209     * @see elm_bg_load_size_set()
5210     *
5211     * @ingroup Icon
5212     */
5213    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5214    /**
5215     * Get the prescale size for the icon.
5216     *
5217     * @param obj The icon object
5218     * @return The prescale size
5219     *
5220     * @see elm_icon_prescale_set()
5221     *
5222     * @ingroup Icon
5223     */
5224    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5225    /**
5226     * Gets the image object of the icon. DO NOT MODIFY THIS.
5227     *
5228     * @param obj The icon object
5229     * @return The internal icon object
5230     *
5231     * @ingroup Icon
5232     */
5233    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5234    /**
5235     * Sets the icon lookup order used by elm_icon_standard_set().
5236     *
5237     * @param obj The icon object
5238     * @param order The icon lookup order (can be one of
5239     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5240     * or ELM_ICON_LOOKUP_THEME)
5241     *
5242     * @see elm_icon_order_lookup_get()
5243     * @see Elm_Icon_Lookup_Order
5244     *
5245     * @ingroup Icon
5246     */
5247    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5248    /**
5249     * Gets the icon lookup order.
5250     *
5251     * @param obj The icon object
5252     * @return The icon lookup order
5253     *
5254     * @see elm_icon_order_lookup_set()
5255     * @see Elm_Icon_Lookup_Order
5256     *
5257     * @ingroup Icon
5258     */
5259    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5260    /**
5261     * Enable or disable preloading of the icon
5262     *
5263     * @param obj The icon object
5264     * @param disable If EINA_TRUE, preloading will be disabled
5265     * @ingroup Icon
5266     */
5267    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5268    /**
5269     * Get if the icon supports animation or not.
5270     *
5271     * @param obj The icon object
5272     * @return @c EINA_TRUE if the icon supports animation,
5273     *         @c EINA_FALSE otherwise.
5274     *
5275     * Return if this elm icon's image can be animated. Currently Evas only
5276     * supports gif animation. If the return value is EINA_FALSE, other
5277     * elm_icon_animated_XXX APIs won't work.
5278     * @ingroup Icon
5279     */
5280    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5281    /**
5282     * Set animation mode of the icon.
5283     *
5284     * @param obj The icon object
5285     * @param anim @c EINA_TRUE if the object do animation job,
5286     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5287     *
5288     * Since the default animation mode is set to EINA_FALSE, 
5289     * the icon is shown without animation.
5290     * This might be desirable when the application developer wants to show
5291     * a snapshot of the animated icon.
5292     * Set it to EINA_TRUE when the icon needs to be animated.
5293     * @ingroup Icon
5294     */
5295    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5296    /**
5297     * Get animation mode of the icon.
5298     *
5299     * @param obj The icon object
5300     * @return The animation mode of the icon object
5301     * @see elm_icon_animated_set
5302     * @ingroup Icon
5303     */
5304    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5305    /**
5306     * Set animation play mode of the icon.
5307     *
5308     * @param obj The icon object
5309     * @param play @c EINA_TRUE the object play animation images,
5310     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5311     *
5312     * To play elm icon's animation, set play to EINA_TURE.
5313     * For example, you make gif player using this set/get API and click event.
5314     *
5315     * 1. Click event occurs
5316     * 2. Check play flag using elm_icon_animaged_play_get
5317     * 3. If elm icon was playing, set play to EINA_FALSE.
5318     *    Then animation will be stopped and vice versa
5319     * @ingroup Icon
5320     */
5321    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5322    /**
5323     * Get animation play mode of the icon.
5324     *
5325     * @param obj The icon object
5326     * @return The play mode of the icon object
5327     *
5328     * @see elm_icon_animated_play_get
5329     * @ingroup Icon
5330     */
5331    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5332
5333    /**
5334     * @}
5335     */
5336
5337    /**
5338     * @defgroup Image Image
5339     *
5340     * @image html img/widget/image/preview-00.png
5341     * @image latex img/widget/image/preview-00.eps
5342
5343     *
5344     * An object that allows one to load an image file to it. It can be used
5345     * anywhere like any other elementary widget.
5346     *
5347     * This widget provides most of the functionality provided from @ref Bg or @ref
5348     * Icon, but with a slightly different API (use the one that fits better your
5349     * needs).
5350     *
5351     * The features not provided by those two other image widgets are:
5352     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5353     * @li change the object orientation with elm_image_orient_set();
5354     * @li and turning the image editable with elm_image_editable_set().
5355     *
5356     * Signals that you can add callbacks for are:
5357     *
5358     * @li @c "clicked" - This is called when a user has clicked the image
5359     *
5360     * An example of usage for this API follows:
5361     * @li @ref tutorial_image
5362     */
5363
5364    /**
5365     * @addtogroup Image
5366     * @{
5367     */
5368
5369    /**
5370     * @enum _Elm_Image_Orient
5371     * @typedef Elm_Image_Orient
5372     *
5373     * Possible orientation options for elm_image_orient_set().
5374     *
5375     * @image html elm_image_orient_set.png
5376     * @image latex elm_image_orient_set.eps width=\textwidth
5377     *
5378     * @ingroup Image
5379     */
5380    typedef enum _Elm_Image_Orient
5381      {
5382         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5383         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5384         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5385         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5386         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5387         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5388         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5389         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5390      } Elm_Image_Orient;
5391
5392    /**
5393     * Add a new image to the parent.
5394     *
5395     * @param parent The parent object
5396     * @return The new object or NULL if it cannot be created
5397     *
5398     * @see elm_image_file_set()
5399     *
5400     * @ingroup Image
5401     */
5402    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5403    /**
5404     * Set the file that will be used as image.
5405     *
5406     * @param obj The image object
5407     * @param file The path to file that will be used as image
5408     * @param group The group that the image belongs in edje file (if it's an
5409     * edje image)
5410     *
5411     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5412     *
5413     * @see elm_image_file_get()
5414     *
5415     * @ingroup Image
5416     */
5417    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5418    /**
5419     * Get the file that will be used as image.
5420     *
5421     * @param obj The image object
5422     * @param file The path to file
5423     * @param group The group that the image belongs in edje file
5424     *
5425     * @see elm_image_file_set()
5426     *
5427     * @ingroup Image
5428     */
5429    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5430    /**
5431     * Set the smooth effect for an image.
5432     *
5433     * @param obj The image object
5434     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5435     * otherwise. Default is @c EINA_TRUE.
5436     *
5437     * Set the scaling algorithm to be used when scaling the image. Smooth
5438     * scaling provides a better resulting image, but is slower.
5439     *
5440     * The smooth scaling should be disabled when making animations that change
5441     * the image size, since it will be faster. Animations that don't require
5442     * resizing of the image can keep the smooth scaling enabled (even if the
5443     * image is already scaled, since the scaled image will be cached).
5444     *
5445     * @see elm_image_smooth_get()
5446     *
5447     * @ingroup Image
5448     */
5449    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5450    /**
5451     * Get the smooth effect for an image.
5452     *
5453     * @param obj The image object
5454     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5455     *
5456     * @see elm_image_smooth_get()
5457     *
5458     * @ingroup Image
5459     */
5460    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5461
5462    /**
5463     * Gets the current size of the image.
5464     *
5465     * @param obj The image object.
5466     * @param w Pointer to store width, or NULL.
5467     * @param h Pointer to store height, or NULL.
5468     *
5469     * This is the real size of the image, not the size of the object.
5470     *
5471     * On error, neither w or h will be written.
5472     *
5473     * @ingroup Image
5474     */
5475    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5476    /**
5477     * Disable scaling of this object.
5478     *
5479     * @param obj The image object.
5480     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5481     * otherwise. Default is @c EINA_FALSE.
5482     *
5483     * This function disables scaling of the elm_image widget through the
5484     * function elm_object_scale_set(). However, this does not affect the widget
5485     * size/resize in any way. For that effect, take a look at
5486     * elm_image_scale_set().
5487     *
5488     * @see elm_image_no_scale_get()
5489     * @see elm_image_scale_set()
5490     * @see elm_object_scale_set()
5491     *
5492     * @ingroup Image
5493     */
5494    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5495    /**
5496     * Get whether scaling is disabled on the object.
5497     *
5498     * @param obj The image object
5499     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5500     *
5501     * @see elm_image_no_scale_set()
5502     *
5503     * @ingroup Image
5504     */
5505    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5506    /**
5507     * Set if the object is (up/down) resizable.
5508     *
5509     * @param obj The image object
5510     * @param scale_up A bool to set if the object is resizable up. Default is
5511     * @c EINA_TRUE.
5512     * @param scale_down A bool to set if the object is resizable down. Default
5513     * is @c EINA_TRUE.
5514     *
5515     * This function limits the image resize ability. If @p scale_up is set to
5516     * @c EINA_FALSE, the object can't have its height or width resized to a value
5517     * higher than the original image size. Same is valid for @p scale_down.
5518     *
5519     * @see elm_image_scale_get()
5520     *
5521     * @ingroup Image
5522     */
5523    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5524    /**
5525     * Get if the object is (up/down) resizable.
5526     *
5527     * @param obj The image object
5528     * @param scale_up A bool to set if the object is resizable up
5529     * @param scale_down A bool to set if the object is resizable down
5530     *
5531     * @see elm_image_scale_set()
5532     *
5533     * @ingroup Image
5534     */
5535    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5536    /**
5537     * Set if the image fills the entire object area, when keeping the aspect ratio.
5538     *
5539     * @param obj The image object
5540     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5541     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5542     *
5543     * When the image should keep its aspect ratio even if resized to another
5544     * aspect ratio, there are two possibilities to resize it: keep the entire
5545     * image inside the limits of height and width of the object (@p fill_outside
5546     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5547     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5548     *
5549     * @note This option will have no effect if
5550     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5551     *
5552     * @see elm_image_fill_outside_get()
5553     * @see elm_image_aspect_ratio_retained_set()
5554     *
5555     * @ingroup Image
5556     */
5557    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5558    /**
5559     * Get if the object is filled outside
5560     *
5561     * @param obj The image object
5562     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5563     *
5564     * @see elm_image_fill_outside_set()
5565     *
5566     * @ingroup Image
5567     */
5568    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5569    /**
5570     * Set the prescale size for the image
5571     *
5572     * @param obj The image object
5573     * @param size The prescale size. This value is used for both width and
5574     * height.
5575     *
5576     * This function sets a new size for pixmap representation of the given
5577     * image. It allows the image to be loaded already in the specified size,
5578     * reducing the memory usage and load time when loading a big image with load
5579     * size set to a smaller size.
5580     *
5581     * It's equivalent to the elm_bg_load_size_set() function for bg.
5582     *
5583     * @note this is just a hint, the real size of the pixmap may differ
5584     * depending on the type of image being loaded, being bigger than requested.
5585     *
5586     * @see elm_image_prescale_get()
5587     * @see elm_bg_load_size_set()
5588     *
5589     * @ingroup Image
5590     */
5591    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5592    /**
5593     * Get the prescale size for the image
5594     *
5595     * @param obj The image object
5596     * @return The prescale size
5597     *
5598     * @see elm_image_prescale_set()
5599     *
5600     * @ingroup Image
5601     */
5602    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5603    /**
5604     * Set the image orientation.
5605     *
5606     * @param obj The image object
5607     * @param orient The image orientation @ref Elm_Image_Orient
5608     *  Default is #ELM_IMAGE_ORIENT_NONE.
5609     *
5610     * This function allows to rotate or flip the given image.
5611     *
5612     * @see elm_image_orient_get()
5613     * @see @ref Elm_Image_Orient
5614     *
5615     * @ingroup Image
5616     */
5617    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5618    /**
5619     * Get the image orientation.
5620     *
5621     * @param obj The image object
5622     * @return The image orientation @ref Elm_Image_Orient
5623     *
5624     * @see elm_image_orient_set()
5625     * @see @ref Elm_Image_Orient
5626     *
5627     * @ingroup Image
5628     */
5629    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5630    /**
5631     * Make the image 'editable'.
5632     *
5633     * @param obj Image object.
5634     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5635     *
5636     * This means the image is a valid drag target for drag and drop, and can be
5637     * cut or pasted too.
5638     *
5639     * @ingroup Image
5640     */
5641    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5642    /**
5643     * Check if the image 'editable'.
5644     *
5645     * @param obj Image object.
5646     * @return Editability.
5647     *
5648     * A return value of EINA_TRUE means the image is a valid drag target
5649     * for drag and drop, and can be cut or pasted too.
5650     *
5651     * @ingroup Image
5652     */
5653    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5654    /**
5655     * Get the basic Evas_Image object from this object (widget).
5656     *
5657     * @param obj The image object to get the inlined image from
5658     * @return The inlined image object, or NULL if none exists
5659     *
5660     * This function allows one to get the underlying @c Evas_Object of type
5661     * Image from this elementary widget. It can be useful to do things like get
5662     * the pixel data, save the image to a file, etc.
5663     *
5664     * @note Be careful to not manipulate it, as it is under control of
5665     * elementary.
5666     *
5667     * @ingroup Image
5668     */
5669    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5670    /**
5671     * Set whether the original aspect ratio of the image should be kept on resize.
5672     *
5673     * @param obj The image object.
5674     * @param retained @c EINA_TRUE if the image should retain the aspect,
5675     * @c EINA_FALSE otherwise.
5676     *
5677     * The original aspect ratio (width / height) of the image is usually
5678     * distorted to match the object's size. Enabling this option will retain
5679     * this original aspect, and the way that the image is fit into the object's
5680     * area depends on the option set by elm_image_fill_outside_set().
5681     *
5682     * @see elm_image_aspect_ratio_retained_get()
5683     * @see elm_image_fill_outside_set()
5684     *
5685     * @ingroup Image
5686     */
5687    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5688    /**
5689     * Get if the object retains the original aspect ratio.
5690     *
5691     * @param obj The image object.
5692     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5693     * otherwise.
5694     *
5695     * @ingroup Image
5696     */
5697    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5698
5699    /**
5700     * @}
5701     */
5702
5703    /* box */
5704    /**
5705     * @defgroup Box Box
5706     *
5707     * @image html img/widget/box/preview-00.png
5708     * @image latex img/widget/box/preview-00.eps width=\textwidth
5709     *
5710     * @image html img/box.png
5711     * @image latex img/box.eps width=\textwidth
5712     *
5713     * A box arranges objects in a linear fashion, governed by a layout function
5714     * that defines the details of this arrangement.
5715     *
5716     * By default, the box will use an internal function to set the layout to
5717     * a single row, either vertical or horizontal. This layout is affected
5718     * by a number of parameters, such as the homogeneous flag set by
5719     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5720     * elm_box_align_set() and the hints set to each object in the box.
5721     *
5722     * For this default layout, it's possible to change the orientation with
5723     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5724     * placing its elements ordered from top to bottom. When horizontal is set,
5725     * the order will go from left to right. If the box is set to be
5726     * homogeneous, every object in it will be assigned the same space, that
5727     * of the largest object. Padding can be used to set some spacing between
5728     * the cell given to each object. The alignment of the box, set with
5729     * elm_box_align_set(), determines how the bounding box of all the elements
5730     * will be placed within the space given to the box widget itself.
5731     *
5732     * The size hints of each object also affect how they are placed and sized
5733     * within the box. evas_object_size_hint_min_set() will give the minimum
5734     * size the object can have, and the box will use it as the basis for all
5735     * latter calculations. Elementary widgets set their own minimum size as
5736     * needed, so there's rarely any need to use it manually.
5737     *
5738     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5739     * used to tell whether the object will be allocated the minimum size it
5740     * needs or if the space given to it should be expanded. It's important
5741     * to realize that expanding the size given to the object is not the same
5742     * thing as resizing the object. It could very well end being a small
5743     * widget floating in a much larger empty space. If not set, the weight
5744     * for objects will normally be 0.0 for both axis, meaning the widget will
5745     * not be expanded. To take as much space possible, set the weight to
5746     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5747     *
5748     * Besides how much space each object is allocated, it's possible to control
5749     * how the widget will be placed within that space using
5750     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5751     * for both axis, meaning the object will be centered, but any value from
5752     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5753     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5754     * is -1.0, means the object will be resized to fill the entire space it
5755     * was allocated.
5756     *
5757     * In addition, customized functions to define the layout can be set, which
5758     * allow the application developer to organize the objects within the box
5759     * in any number of ways.
5760     *
5761     * The special elm_box_layout_transition() function can be used
5762     * to switch from one layout to another, animating the motion of the
5763     * children of the box.
5764     *
5765     * @note Objects should not be added to box objects using _add() calls.
5766     *
5767     * Some examples on how to use boxes follow:
5768     * @li @ref box_example_01
5769     * @li @ref box_example_02
5770     *
5771     * @{
5772     */
5773    /**
5774     * @typedef Elm_Box_Transition
5775     *
5776     * Opaque handler containing the parameters to perform an animated
5777     * transition of the layout the box uses.
5778     *
5779     * @see elm_box_transition_new()
5780     * @see elm_box_layout_set()
5781     * @see elm_box_layout_transition()
5782     */
5783    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5784
5785    /**
5786     * Add a new box to the parent
5787     *
5788     * By default, the box will be in vertical mode and non-homogeneous.
5789     *
5790     * @param parent The parent object
5791     * @return The new object or NULL if it cannot be created
5792     */
5793    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5794    /**
5795     * Set the horizontal orientation
5796     *
5797     * By default, box object arranges their contents vertically from top to
5798     * bottom.
5799     * By calling this function with @p horizontal as EINA_TRUE, the box will
5800     * become horizontal, arranging contents from left to right.
5801     *
5802     * @note This flag is ignored if a custom layout function is set.
5803     *
5804     * @param obj The box object
5805     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5806     * EINA_FALSE = vertical)
5807     */
5808    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5809    /**
5810     * Get the horizontal orientation
5811     *
5812     * @param obj The box object
5813     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5814     */
5815    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5816    /**
5817     * Set the box to arrange its children homogeneously
5818     *
5819     * If enabled, homogeneous layout makes all items the same size, according
5820     * to the size of the largest of its children.
5821     *
5822     * @note This flag is ignored if a custom layout function is set.
5823     *
5824     * @param obj The box object
5825     * @param homogeneous The homogeneous flag
5826     */
5827    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5828    /**
5829     * Get whether the box is using homogeneous mode or not
5830     *
5831     * @param obj The box object
5832     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5833     */
5834    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5835    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5836    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5837    /**
5838     * Add an object to the beginning of the pack list
5839     *
5840     * Pack @p subobj into the box @p obj, placing it first in the list of
5841     * children objects. The actual position the object will get on screen
5842     * depends on the layout used. If no custom layout is set, it will be at
5843     * the top or left, depending if the box is vertical or horizontal,
5844     * respectively.
5845     *
5846     * @param obj The box object
5847     * @param subobj The object to add to the box
5848     *
5849     * @see elm_box_pack_end()
5850     * @see elm_box_pack_before()
5851     * @see elm_box_pack_after()
5852     * @see elm_box_unpack()
5853     * @see elm_box_unpack_all()
5854     * @see elm_box_clear()
5855     */
5856    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5857    /**
5858     * Add an object at the end of the pack list
5859     *
5860     * Pack @p subobj into the box @p obj, placing it last in the list of
5861     * children objects. The actual position the object will get on screen
5862     * depends on the layout used. If no custom layout is set, it will be at
5863     * the bottom or right, depending if the box is vertical or horizontal,
5864     * respectively.
5865     *
5866     * @param obj The box object
5867     * @param subobj The object to add to the box
5868     *
5869     * @see elm_box_pack_start()
5870     * @see elm_box_pack_before()
5871     * @see elm_box_pack_after()
5872     * @see elm_box_unpack()
5873     * @see elm_box_unpack_all()
5874     * @see elm_box_clear()
5875     */
5876    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5877    /**
5878     * Adds an object to the box before the indicated object
5879     *
5880     * This will add the @p subobj to the box indicated before the object
5881     * indicated with @p before. If @p before is not already in the box, results
5882     * are undefined. Before means either to the left of the indicated object or
5883     * above it depending on orientation.
5884     *
5885     * @param obj The box object
5886     * @param subobj The object to add to the box
5887     * @param before The object before which to add it
5888     *
5889     * @see elm_box_pack_start()
5890     * @see elm_box_pack_end()
5891     * @see elm_box_pack_after()
5892     * @see elm_box_unpack()
5893     * @see elm_box_unpack_all()
5894     * @see elm_box_clear()
5895     */
5896    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5897    /**
5898     * Adds an object to the box after the indicated object
5899     *
5900     * This will add the @p subobj to the box indicated after the object
5901     * indicated with @p after. If @p after is not already in the box, results
5902     * are undefined. After means either to the right of the indicated object or
5903     * below it depending on orientation.
5904     *
5905     * @param obj The box object
5906     * @param subobj The object to add to the box
5907     * @param after The object after which to add it
5908     *
5909     * @see elm_box_pack_start()
5910     * @see elm_box_pack_end()
5911     * @see elm_box_pack_before()
5912     * @see elm_box_unpack()
5913     * @see elm_box_unpack_all()
5914     * @see elm_box_clear()
5915     */
5916    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5917    /**
5918     * Clear the box of all children
5919     *
5920     * Remove all the elements contained by the box, deleting the respective
5921     * objects.
5922     *
5923     * @param obj The box object
5924     *
5925     * @see elm_box_unpack()
5926     * @see elm_box_unpack_all()
5927     */
5928    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5929    /**
5930     * Unpack a box item
5931     *
5932     * Remove the object given by @p subobj from the box @p obj without
5933     * deleting it.
5934     *
5935     * @param obj The box object
5936     *
5937     * @see elm_box_unpack_all()
5938     * @see elm_box_clear()
5939     */
5940    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5941    /**
5942     * Remove all items from the box, without deleting them
5943     *
5944     * Clear the box from all children, but don't delete the respective objects.
5945     * If no other references of the box children exist, the objects will never
5946     * be deleted, and thus the application will leak the memory. Make sure
5947     * when using this function that you hold a reference to all the objects
5948     * in the box @p obj.
5949     *
5950     * @param obj The box object
5951     *
5952     * @see elm_box_clear()
5953     * @see elm_box_unpack()
5954     */
5955    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5956    /**
5957     * Retrieve a list of the objects packed into the box
5958     *
5959     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5960     * The order of the list corresponds to the packing order the box uses.
5961     *
5962     * You must free this list with eina_list_free() once you are done with it.
5963     *
5964     * @param obj The box object
5965     */
5966    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5967    /**
5968     * Set the space (padding) between the box's elements.
5969     *
5970     * Extra space in pixels that will be added between a box child and its
5971     * neighbors after its containing cell has been calculated. This padding
5972     * is set for all elements in the box, besides any possible padding that
5973     * individual elements may have through their size hints.
5974     *
5975     * @param obj The box object
5976     * @param horizontal The horizontal space between elements
5977     * @param vertical The vertical space between elements
5978     */
5979    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5980    /**
5981     * Get the space (padding) between the box's elements.
5982     *
5983     * @param obj The box object
5984     * @param horizontal The horizontal space between elements
5985     * @param vertical The vertical space between elements
5986     *
5987     * @see elm_box_padding_set()
5988     */
5989    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5990    /**
5991     * Set the alignment of the whole bouding box of contents.
5992     *
5993     * Sets how the bounding box containing all the elements of the box, after
5994     * their sizes and position has been calculated, will be aligned within
5995     * the space given for the whole box widget.
5996     *
5997     * @param obj The box object
5998     * @param horizontal The horizontal alignment of elements
5999     * @param vertical The vertical alignment of elements
6000     */
6001    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6002    /**
6003     * Get the alignment of the whole bouding box of contents.
6004     *
6005     * @param obj The box object
6006     * @param horizontal The horizontal alignment of elements
6007     * @param vertical The vertical alignment of elements
6008     *
6009     * @see elm_box_align_set()
6010     */
6011    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6012
6013    /**
6014     * Force the box to recalculate its children packing.
6015     *
6016     * If any children was added or removed, box will not calculate the
6017     * values immediately rather leaving it to the next main loop
6018     * iteration. While this is great as it would save lots of
6019     * recalculation, whenever you need to get the position of a just
6020     * added item you must force recalculate before doing so.
6021     *
6022     * @param obj The box object.
6023     */
6024    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6025
6026    /**
6027     * Set the layout defining function to be used by the box
6028     *
6029     * Whenever anything changes that requires the box in @p obj to recalculate
6030     * the size and position of its elements, the function @p cb will be called
6031     * to determine what the layout of the children will be.
6032     *
6033     * Once a custom function is set, everything about the children layout
6034     * is defined by it. The flags set by elm_box_horizontal_set() and
6035     * elm_box_homogeneous_set() no longer have any meaning, and the values
6036     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6037     * layout function to decide if they are used and how. These last two
6038     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6039     * passed to @p cb. The @c Evas_Object the function receives is not the
6040     * Elementary widget, but the internal Evas Box it uses, so none of the
6041     * functions described here can be used on it.
6042     *
6043     * Any of the layout functions in @c Evas can be used here, as well as the
6044     * special elm_box_layout_transition().
6045     *
6046     * The final @p data argument received by @p cb is the same @p data passed
6047     * here, and the @p free_data function will be called to free it
6048     * whenever the box is destroyed or another layout function is set.
6049     *
6050     * Setting @p cb to NULL will revert back to the default layout function.
6051     *
6052     * @param obj The box object
6053     * @param cb The callback function used for layout
6054     * @param data Data that will be passed to layout function
6055     * @param free_data Function called to free @p data
6056     *
6057     * @see elm_box_layout_transition()
6058     */
6059    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);
6060    /**
6061     * Special layout function that animates the transition from one layout to another
6062     *
6063     * Normally, when switching the layout function for a box, this will be
6064     * reflected immediately on screen on the next render, but it's also
6065     * possible to do this through an animated transition.
6066     *
6067     * This is done by creating an ::Elm_Box_Transition and setting the box
6068     * layout to this function.
6069     *
6070     * For example:
6071     * @code
6072     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6073     *                            evas_object_box_layout_vertical, // start
6074     *                            NULL, // data for initial layout
6075     *                            NULL, // free function for initial data
6076     *                            evas_object_box_layout_horizontal, // end
6077     *                            NULL, // data for final layout
6078     *                            NULL, // free function for final data
6079     *                            anim_end, // will be called when animation ends
6080     *                            NULL); // data for anim_end function\
6081     * elm_box_layout_set(box, elm_box_layout_transition, t,
6082     *                    elm_box_transition_free);
6083     * @endcode
6084     *
6085     * @note This function can only be used with elm_box_layout_set(). Calling
6086     * it directly will not have the expected results.
6087     *
6088     * @see elm_box_transition_new
6089     * @see elm_box_transition_free
6090     * @see elm_box_layout_set
6091     */
6092    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6093    /**
6094     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6095     *
6096     * If you want to animate the change from one layout to another, you need
6097     * to set the layout function of the box to elm_box_layout_transition(),
6098     * passing as user data to it an instance of ::Elm_Box_Transition with the
6099     * necessary information to perform this animation. The free function to
6100     * set for the layout is elm_box_transition_free().
6101     *
6102     * The parameters to create an ::Elm_Box_Transition sum up to how long
6103     * will it be, in seconds, a layout function to describe the initial point,
6104     * another for the final position of the children and one function to be
6105     * called when the whole animation ends. This last function is useful to
6106     * set the definitive layout for the box, usually the same as the end
6107     * layout for the animation, but could be used to start another transition.
6108     *
6109     * @param start_layout The layout function that will be used to start the animation
6110     * @param start_layout_data The data to be passed the @p start_layout function
6111     * @param start_layout_free_data Function to free @p start_layout_data
6112     * @param end_layout The layout function that will be used to end the animation
6113     * @param end_layout_free_data The data to be passed the @p end_layout function
6114     * @param end_layout_free_data Function to free @p end_layout_data
6115     * @param transition_end_cb Callback function called when animation ends
6116     * @param transition_end_data Data to be passed to @p transition_end_cb
6117     * @return An instance of ::Elm_Box_Transition
6118     *
6119     * @see elm_box_transition_new
6120     * @see elm_box_layout_transition
6121     */
6122    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);
6123    /**
6124     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6125     *
6126     * This function is mostly useful as the @c free_data parameter in
6127     * elm_box_layout_set() when elm_box_layout_transition().
6128     *
6129     * @param data The Elm_Box_Transition instance to be freed.
6130     *
6131     * @see elm_box_transition_new
6132     * @see elm_box_layout_transition
6133     */
6134    EAPI void                elm_box_transition_free(void *data);
6135    /**
6136     * @}
6137     */
6138
6139    /* button */
6140    /**
6141     * @defgroup Button Button
6142     *
6143     * @image html img/widget/button/preview-00.png
6144     * @image latex img/widget/button/preview-00.eps
6145     * @image html img/widget/button/preview-01.png
6146     * @image latex img/widget/button/preview-01.eps
6147     * @image html img/widget/button/preview-02.png
6148     * @image latex img/widget/button/preview-02.eps
6149     *
6150     * This is a push-button. Press it and run some function. It can contain
6151     * a simple label and icon object and it also has an autorepeat feature.
6152     *
6153     * This widgets emits the following signals:
6154     * @li "clicked": the user clicked the button (press/release).
6155     * @li "repeated": the user pressed the button without releasing it.
6156     * @li "pressed": button was pressed.
6157     * @li "unpressed": button was released after being pressed.
6158     * In all three cases, the @c event parameter of the callback will be
6159     * @c NULL.
6160     *
6161     * Also, defined in the default theme, the button has the following styles
6162     * available:
6163     * @li default: a normal button.
6164     * @li anchor: Like default, but the button fades away when the mouse is not
6165     * over it, leaving only the text or icon.
6166     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6167     * continuous look across its options.
6168     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6169     *
6170     * Default contents parts of the button widget that you can use for are:
6171     * @li "icon" - A icon of the button
6172     *
6173     * Default text parts of the button widget that you can use for are:
6174     * @li "default" - Label of the button
6175     *
6176     * Follow through a complete example @ref button_example_01 "here".
6177     * @{
6178     */
6179    /**
6180     * Add a new button to the parent's canvas
6181     *
6182     * @param parent The parent object
6183     * @return The new object or NULL if it cannot be created
6184     */
6185    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6186    /**
6187     * Set the label used in the button
6188     *
6189     * The passed @p label can be NULL to clean any existing text in it and
6190     * leave the button as an icon only object.
6191     *
6192     * @param obj The button object
6193     * @param label The text will be written on the button
6194     * @deprecated use elm_object_text_set() instead.
6195     */
6196    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6197    /**
6198     * Get the label set for the button
6199     *
6200     * The string returned is an internal pointer and should not be freed or
6201     * altered. It will also become invalid when the button is destroyed.
6202     * The string returned, if not NULL, is a stringshare, so if you need to
6203     * keep it around even after the button is destroyed, you can use
6204     * eina_stringshare_ref().
6205     *
6206     * @param obj The button object
6207     * @return The text set to the label, or NULL if nothing is set
6208     * @deprecated use elm_object_text_set() instead.
6209     */
6210    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6211    /**
6212     * Set the icon used for the button
6213     *
6214     * Setting a new icon will delete any other that was previously set, making
6215     * any reference to them invalid. If you need to maintain the previous
6216     * object alive, unset it first with elm_button_icon_unset().
6217     *
6218     * @param obj The button object
6219     * @param icon The icon object for the button
6220     * @deprecated use elm_object_part_content_set() instead.
6221     */
6222    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6223    /**
6224     * Get the icon used for the button
6225     *
6226     * Return the icon object which is set for this widget. If the button is
6227     * destroyed or another icon is set, the returned object will be deleted
6228     * and any reference to it will be invalid.
6229     *
6230     * @param obj The button object
6231     * @return The icon object that is being used
6232     *
6233     * @deprecated use elm_object_part_content_get() instead
6234     */
6235    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6236    /**
6237     * Remove the icon set without deleting it and return the object
6238     *
6239     * This function drops the reference the button holds of the icon object
6240     * and returns this last object. It is used in case you want to remove any
6241     * icon, or set another one, without deleting the actual object. The button
6242     * will be left without an icon set.
6243     *
6244     * @param obj The button object
6245     * @return The icon object that was being used
6246     * @deprecated use elm_object_part_content_unset() instead.
6247     */
6248    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6249    /**
6250     * Turn on/off the autorepeat event generated when the button is kept pressed
6251     *
6252     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6253     * signal when they are clicked.
6254     *
6255     * When on, keeping a button pressed will continuously emit a @c repeated
6256     * signal until the button is released. The time it takes until it starts
6257     * emitting the signal is given by
6258     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6259     * new emission by elm_button_autorepeat_gap_timeout_set().
6260     *
6261     * @param obj The button object
6262     * @param on  A bool to turn on/off the event
6263     */
6264    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6265    /**
6266     * Get whether the autorepeat feature is enabled
6267     *
6268     * @param obj The button object
6269     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6270     *
6271     * @see elm_button_autorepeat_set()
6272     */
6273    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6274    /**
6275     * Set the initial timeout before the autorepeat event is generated
6276     *
6277     * Sets the timeout, in seconds, since the button is pressed until the
6278     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6279     * won't be any delay and the even will be fired the moment the button is
6280     * pressed.
6281     *
6282     * @param obj The button object
6283     * @param t   Timeout in seconds
6284     *
6285     * @see elm_button_autorepeat_set()
6286     * @see elm_button_autorepeat_gap_timeout_set()
6287     */
6288    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6289    /**
6290     * Get the initial timeout before the autorepeat event is generated
6291     *
6292     * @param obj The button object
6293     * @return Timeout in seconds
6294     *
6295     * @see elm_button_autorepeat_initial_timeout_set()
6296     */
6297    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6298    /**
6299     * Set the interval between each generated autorepeat event
6300     *
6301     * After the first @c repeated event is fired, all subsequent ones will
6302     * follow after a delay of @p t seconds for each.
6303     *
6304     * @param obj The button object
6305     * @param t   Interval in seconds
6306     *
6307     * @see elm_button_autorepeat_initial_timeout_set()
6308     */
6309    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6310    /**
6311     * Get the interval between each generated autorepeat event
6312     *
6313     * @param obj The button object
6314     * @return Interval in seconds
6315     */
6316    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6317    /**
6318     * @}
6319     */
6320
6321    /**
6322     * @defgroup File_Selector_Button File Selector Button
6323     *
6324     * @image html img/widget/fileselector_button/preview-00.png
6325     * @image latex img/widget/fileselector_button/preview-00.eps
6326     * @image html img/widget/fileselector_button/preview-01.png
6327     * @image latex img/widget/fileselector_button/preview-01.eps
6328     * @image html img/widget/fileselector_button/preview-02.png
6329     * @image latex img/widget/fileselector_button/preview-02.eps
6330     *
6331     * This is a button that, when clicked, creates an Elementary
6332     * window (or inner window) <b> with a @ref Fileselector "file
6333     * selector widget" within</b>. When a file is chosen, the (inner)
6334     * window is closed and the button emits a signal having the
6335     * selected file as it's @c event_info.
6336     *
6337     * This widget encapsulates operations on its internal file
6338     * selector on its own API. There is less control over its file
6339     * selector than that one would have instatiating one directly.
6340     *
6341     * The following styles are available for this button:
6342     * @li @c "default"
6343     * @li @c "anchor"
6344     * @li @c "hoversel_vertical"
6345     * @li @c "hoversel_vertical_entry"
6346     *
6347     * Smart callbacks one can register to:
6348     * - @c "file,chosen" - the user has selected a path, whose string
6349     *   pointer comes as the @c event_info data (a stringshared
6350     *   string)
6351     *
6352     * Here is an example on its usage:
6353     * @li @ref fileselector_button_example
6354     *
6355     * @see @ref File_Selector_Entry for a similar widget.
6356     * @{
6357     */
6358
6359    /**
6360     * Add a new file selector button widget to the given parent
6361     * Elementary (container) object
6362     *
6363     * @param parent The parent object
6364     * @return a new file selector button widget handle or @c NULL, on
6365     * errors
6366     */
6367    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6368
6369    /**
6370     * Set the label for a given file selector button widget
6371     *
6372     * @param obj The file selector button widget
6373     * @param label The text label to be displayed on @p obj
6374     *
6375     * @deprecated use elm_object_text_set() instead.
6376     */
6377    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6378
6379    /**
6380     * Get the label set for a given file selector button widget
6381     *
6382     * @param obj The file selector button widget
6383     * @return The button label
6384     *
6385     * @deprecated use elm_object_text_set() instead.
6386     */
6387    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6388
6389    /**
6390     * Set the icon on a given file selector button widget
6391     *
6392     * @param obj The file selector button widget
6393     * @param icon The icon object for the button
6394     *
6395     * Once the icon object is set, a previously set one will be
6396     * deleted. If you want to keep the latter, use the
6397     * elm_fileselector_button_icon_unset() function.
6398     *
6399     * @see elm_fileselector_button_icon_get()
6400     */
6401    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6402
6403    /**
6404     * Get the icon set for a given file selector button widget
6405     *
6406     * @param obj The file selector button widget
6407     * @return The icon object currently set on @p obj or @c NULL, if
6408     * none is
6409     *
6410     * @see elm_fileselector_button_icon_set()
6411     */
6412    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6413
6414    /**
6415     * Unset the icon used in a given file selector button widget
6416     *
6417     * @param obj The file selector button widget
6418     * @return The icon object that was being used on @p obj or @c
6419     * NULL, on errors
6420     *
6421     * Unparent and return the icon object which was set for this
6422     * widget.
6423     *
6424     * @see elm_fileselector_button_icon_set()
6425     */
6426    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6427
6428    /**
6429     * Set the title for a given file selector button widget's window
6430     *
6431     * @param obj The file selector button widget
6432     * @param title The title string
6433     *
6434     * This will change the window's title, when the file selector pops
6435     * out after a click on the button. Those windows have the default
6436     * (unlocalized) value of @c "Select a file" as titles.
6437     *
6438     * @note It will only take any effect if the file selector
6439     * button widget is @b not under "inwin mode".
6440     *
6441     * @see elm_fileselector_button_window_title_get()
6442     */
6443    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6444
6445    /**
6446     * Get the title set for a given file selector button widget's
6447     * window
6448     *
6449     * @param obj The file selector button widget
6450     * @return Title of the file selector button's window
6451     *
6452     * @see elm_fileselector_button_window_title_get() for more details
6453     */
6454    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6455
6456    /**
6457     * Set the size of a given file selector button widget's window,
6458     * holding the file selector itself.
6459     *
6460     * @param obj The file selector button widget
6461     * @param width The window's width
6462     * @param height The window's height
6463     *
6464     * @note it will only take any effect if the file selector button
6465     * widget is @b not under "inwin mode". The default size for the
6466     * window (when applicable) is 400x400 pixels.
6467     *
6468     * @see elm_fileselector_button_window_size_get()
6469     */
6470    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6471
6472    /**
6473     * Get the size of a given file selector button widget's window,
6474     * holding the file selector itself.
6475     *
6476     * @param obj The file selector button widget
6477     * @param width Pointer into which to store the width value
6478     * @param height Pointer into which to store the height value
6479     *
6480     * @note Use @c NULL pointers on the size values you're not
6481     * interested in: they'll be ignored by the function.
6482     *
6483     * @see elm_fileselector_button_window_size_set(), for more details
6484     */
6485    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6486
6487    /**
6488     * Set the initial file system path for a given file selector
6489     * button widget
6490     *
6491     * @param obj The file selector button widget
6492     * @param path The path string
6493     *
6494     * It must be a <b>directory</b> path, which will have the contents
6495     * displayed initially in the file selector's view, when invoked
6496     * from @p obj. The default initial path is the @c "HOME"
6497     * environment variable's value.
6498     *
6499     * @see elm_fileselector_button_path_get()
6500     */
6501    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6502
6503    /**
6504     * Get the initial file system path set for a given file selector
6505     * button widget
6506     *
6507     * @param obj The file selector button widget
6508     * @return path The path string
6509     *
6510     * @see elm_fileselector_button_path_set() for more details
6511     */
6512    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6513
6514    /**
6515     * Enable/disable a tree view in the given file selector button
6516     * widget's internal file selector
6517     *
6518     * @param obj The file selector button widget
6519     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6520     * disable
6521     *
6522     * This has the same effect as elm_fileselector_expandable_set(),
6523     * but now applied to a file selector button's internal file
6524     * selector.
6525     *
6526     * @note There's no way to put a file selector button's internal
6527     * file selector in "grid mode", as one may do with "pure" file
6528     * selectors.
6529     *
6530     * @see elm_fileselector_expandable_get()
6531     */
6532    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6533
6534    /**
6535     * Get whether tree view is enabled for the given file selector
6536     * button widget's internal file selector
6537     *
6538     * @param obj The file selector button widget
6539     * @return @c EINA_TRUE if @p obj widget's internal file selector
6540     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6541     *
6542     * @see elm_fileselector_expandable_set() for more details
6543     */
6544    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6545
6546    /**
6547     * Set whether a given file selector button widget's internal file
6548     * selector is to display folders only or the directory contents,
6549     * as well.
6550     *
6551     * @param obj The file selector button widget
6552     * @param only @c EINA_TRUE to make @p obj widget's internal file
6553     * selector only display directories, @c EINA_FALSE to make files
6554     * to be displayed in it too
6555     *
6556     * This has the same effect as elm_fileselector_folder_only_set(),
6557     * but now applied to a file selector button's internal file
6558     * selector.
6559     *
6560     * @see elm_fileselector_folder_only_get()
6561     */
6562    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6563
6564    /**
6565     * Get whether a given file selector button widget's internal file
6566     * selector is displaying folders only or the directory contents,
6567     * as well.
6568     *
6569     * @param obj The file selector button widget
6570     * @return @c EINA_TRUE if @p obj widget's internal file
6571     * selector is only displaying directories, @c EINA_FALSE if files
6572     * are being displayed in it too (and on errors)
6573     *
6574     * @see elm_fileselector_button_folder_only_set() for more details
6575     */
6576    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6577
6578    /**
6579     * Enable/disable the file name entry box where the user can type
6580     * in a name for a file, in a given file selector button widget's
6581     * internal file selector.
6582     *
6583     * @param obj The file selector button widget
6584     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6585     * file selector a "saving dialog", @c EINA_FALSE otherwise
6586     *
6587     * This has the same effect as elm_fileselector_is_save_set(),
6588     * but now applied to a file selector button's internal file
6589     * selector.
6590     *
6591     * @see elm_fileselector_is_save_get()
6592     */
6593    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6594
6595    /**
6596     * Get whether the given file selector button widget's internal
6597     * file selector is in "saving dialog" mode
6598     *
6599     * @param obj The file selector button widget
6600     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6601     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6602     * errors)
6603     *
6604     * @see elm_fileselector_button_is_save_set() for more details
6605     */
6606    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6607
6608    /**
6609     * Set whether a given file selector button widget's internal file
6610     * selector will raise an Elementary "inner window", instead of a
6611     * dedicated Elementary window. By default, it won't.
6612     *
6613     * @param obj The file selector button widget
6614     * @param value @c EINA_TRUE to make it use an inner window, @c
6615     * EINA_TRUE to make it use a dedicated window
6616     *
6617     * @see elm_win_inwin_add() for more information on inner windows
6618     * @see elm_fileselector_button_inwin_mode_get()
6619     */
6620    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6621
6622    /**
6623     * Get whether a given file selector button widget's internal file
6624     * selector will raise an Elementary "inner window", instead of a
6625     * dedicated Elementary window.
6626     *
6627     * @param obj The file selector button widget
6628     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6629     * if it will use a dedicated window
6630     *
6631     * @see elm_fileselector_button_inwin_mode_set() for more details
6632     */
6633    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6634
6635    /**
6636     * @}
6637     */
6638
6639     /**
6640     * @defgroup File_Selector_Entry File Selector Entry
6641     *
6642     * @image html img/widget/fileselector_entry/preview-00.png
6643     * @image latex img/widget/fileselector_entry/preview-00.eps
6644     *
6645     * This is an entry made to be filled with or display a <b>file
6646     * system path string</b>. Besides the entry itself, the widget has
6647     * a @ref File_Selector_Button "file selector button" on its side,
6648     * which will raise an internal @ref Fileselector "file selector widget",
6649     * when clicked, for path selection aided by file system
6650     * navigation.
6651     *
6652     * This file selector may appear in an Elementary window or in an
6653     * inner window. When a file is chosen from it, the (inner) window
6654     * is closed and the selected file's path string is exposed both as
6655     * an smart event and as the new text on the entry.
6656     *
6657     * This widget encapsulates operations on its internal file
6658     * selector on its own API. There is less control over its file
6659     * selector than that one would have instatiating one directly.
6660     *
6661     * Smart callbacks one can register to:
6662     * - @c "changed" - The text within the entry was changed
6663     * - @c "activated" - The entry has had editing finished and
6664     *   changes are to be "committed"
6665     * - @c "press" - The entry has been clicked
6666     * - @c "longpressed" - The entry has been clicked (and held) for a
6667     *   couple seconds
6668     * - @c "clicked" - The entry has been clicked
6669     * - @c "clicked,double" - The entry has been double clicked
6670     * - @c "focused" - The entry has received focus
6671     * - @c "unfocused" - The entry has lost focus
6672     * - @c "selection,paste" - A paste action has occurred on the
6673     *   entry
6674     * - @c "selection,copy" - A copy action has occurred on the entry
6675     * - @c "selection,cut" - A cut action has occurred on the entry
6676     * - @c "unpressed" - The file selector entry's button was released
6677     *   after being pressed.
6678     * - @c "file,chosen" - The user has selected a path via the file
6679     *   selector entry's internal file selector, whose string pointer
6680     *   comes as the @c event_info data (a stringshared string)
6681     *
6682     * Here is an example on its usage:
6683     * @li @ref fileselector_entry_example
6684     *
6685     * @see @ref File_Selector_Button for a similar widget.
6686     * @{
6687     */
6688
6689    /**
6690     * Add a new file selector entry widget to the given parent
6691     * Elementary (container) object
6692     *
6693     * @param parent The parent object
6694     * @return a new file selector entry widget handle or @c NULL, on
6695     * errors
6696     */
6697    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6698
6699    /**
6700     * Set the label for a given file selector entry widget's button
6701     *
6702     * @param obj The file selector entry widget
6703     * @param label The text label to be displayed on @p obj widget's
6704     * button
6705     *
6706     * @deprecated use elm_object_text_set() instead.
6707     */
6708    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6709
6710    /**
6711     * Get the label set for a given file selector entry widget's button
6712     *
6713     * @param obj The file selector entry widget
6714     * @return The widget button's label
6715     *
6716     * @deprecated use elm_object_text_set() instead.
6717     */
6718    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6719
6720    /**
6721     * Set the icon on a given file selector entry widget's button
6722     *
6723     * @param obj The file selector entry widget
6724     * @param icon The icon object for the entry's button
6725     *
6726     * Once the icon object is set, a previously set one will be
6727     * deleted. If you want to keep the latter, use the
6728     * elm_fileselector_entry_button_icon_unset() function.
6729     *
6730     * @see elm_fileselector_entry_button_icon_get()
6731     */
6732    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6733
6734    /**
6735     * Get the icon set for a given file selector entry widget's button
6736     *
6737     * @param obj The file selector entry widget
6738     * @return The icon object currently set on @p obj widget's button
6739     * or @c NULL, if none is
6740     *
6741     * @see elm_fileselector_entry_button_icon_set()
6742     */
6743    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6744
6745    /**
6746     * Unset the icon used in a given file selector entry widget's
6747     * button
6748     *
6749     * @param obj The file selector entry widget
6750     * @return The icon object that was being used on @p obj widget's
6751     * button or @c NULL, on errors
6752     *
6753     * Unparent and return the icon object which was set for this
6754     * widget's button.
6755     *
6756     * @see elm_fileselector_entry_button_icon_set()
6757     */
6758    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6759
6760    /**
6761     * Set the title for a given file selector entry widget's window
6762     *
6763     * @param obj The file selector entry widget
6764     * @param title The title string
6765     *
6766     * This will change the window's title, when the file selector pops
6767     * out after a click on the entry's button. Those windows have the
6768     * default (unlocalized) value of @c "Select a file" as titles.
6769     *
6770     * @note It will only take any effect if the file selector
6771     * entry widget is @b not under "inwin mode".
6772     *
6773     * @see elm_fileselector_entry_window_title_get()
6774     */
6775    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6776
6777    /**
6778     * Get the title set for a given file selector entry widget's
6779     * window
6780     *
6781     * @param obj The file selector entry widget
6782     * @return Title of the file selector entry's window
6783     *
6784     * @see elm_fileselector_entry_window_title_get() for more details
6785     */
6786    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6787
6788    /**
6789     * Set the size of a given file selector entry widget's window,
6790     * holding the file selector itself.
6791     *
6792     * @param obj The file selector entry widget
6793     * @param width The window's width
6794     * @param height The window's height
6795     *
6796     * @note it will only take any effect if the file selector entry
6797     * widget is @b not under "inwin mode". The default size for the
6798     * window (when applicable) is 400x400 pixels.
6799     *
6800     * @see elm_fileselector_entry_window_size_get()
6801     */
6802    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6803
6804    /**
6805     * Get the size of a given file selector entry widget's window,
6806     * holding the file selector itself.
6807     *
6808     * @param obj The file selector entry widget
6809     * @param width Pointer into which to store the width value
6810     * @param height Pointer into which to store the height value
6811     *
6812     * @note Use @c NULL pointers on the size values you're not
6813     * interested in: they'll be ignored by the function.
6814     *
6815     * @see elm_fileselector_entry_window_size_set(), for more details
6816     */
6817    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6818
6819    /**
6820     * Set the initial file system path and the entry's path string for
6821     * a given file selector entry widget
6822     *
6823     * @param obj The file selector entry widget
6824     * @param path The path string
6825     *
6826     * It must be a <b>directory</b> path, which will have the contents
6827     * displayed initially in the file selector's view, when invoked
6828     * from @p obj. The default initial path is the @c "HOME"
6829     * environment variable's value.
6830     *
6831     * @see elm_fileselector_entry_path_get()
6832     */
6833    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6834
6835    /**
6836     * Get the entry's path string for a given file selector entry
6837     * widget
6838     *
6839     * @param obj The file selector entry widget
6840     * @return path The path string
6841     *
6842     * @see elm_fileselector_entry_path_set() for more details
6843     */
6844    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6845
6846    /**
6847     * Enable/disable a tree view in the given file selector entry
6848     * widget's internal file selector
6849     *
6850     * @param obj The file selector entry widget
6851     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6852     * disable
6853     *
6854     * This has the same effect as elm_fileselector_expandable_set(),
6855     * but now applied to a file selector entry's internal file
6856     * selector.
6857     *
6858     * @note There's no way to put a file selector entry's internal
6859     * file selector in "grid mode", as one may do with "pure" file
6860     * selectors.
6861     *
6862     * @see elm_fileselector_expandable_get()
6863     */
6864    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6865
6866    /**
6867     * Get whether tree view is enabled for the given file selector
6868     * entry widget's internal file selector
6869     *
6870     * @param obj The file selector entry widget
6871     * @return @c EINA_TRUE if @p obj widget's internal file selector
6872     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6873     *
6874     * @see elm_fileselector_expandable_set() for more details
6875     */
6876    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6877
6878    /**
6879     * Set whether a given file selector entry widget's internal file
6880     * selector is to display folders only or the directory contents,
6881     * as well.
6882     *
6883     * @param obj The file selector entry widget
6884     * @param only @c EINA_TRUE to make @p obj widget's internal file
6885     * selector only display directories, @c EINA_FALSE to make files
6886     * to be displayed in it too
6887     *
6888     * This has the same effect as elm_fileselector_folder_only_set(),
6889     * but now applied to a file selector entry's internal file
6890     * selector.
6891     *
6892     * @see elm_fileselector_folder_only_get()
6893     */
6894    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6895
6896    /**
6897     * Get whether a given file selector entry widget's internal file
6898     * selector is displaying folders only or the directory contents,
6899     * as well.
6900     *
6901     * @param obj The file selector entry widget
6902     * @return @c EINA_TRUE if @p obj widget's internal file
6903     * selector is only displaying directories, @c EINA_FALSE if files
6904     * are being displayed in it too (and on errors)
6905     *
6906     * @see elm_fileselector_entry_folder_only_set() for more details
6907     */
6908    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6909
6910    /**
6911     * Enable/disable the file name entry box where the user can type
6912     * in a name for a file, in a given file selector entry widget's
6913     * internal file selector.
6914     *
6915     * @param obj The file selector entry widget
6916     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6917     * file selector a "saving dialog", @c EINA_FALSE otherwise
6918     *
6919     * This has the same effect as elm_fileselector_is_save_set(),
6920     * but now applied to a file selector entry's internal file
6921     * selector.
6922     *
6923     * @see elm_fileselector_is_save_get()
6924     */
6925    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6926
6927    /**
6928     * Get whether the given file selector entry widget's internal
6929     * file selector is in "saving dialog" mode
6930     *
6931     * @param obj The file selector entry widget
6932     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6933     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6934     * errors)
6935     *
6936     * @see elm_fileselector_entry_is_save_set() for more details
6937     */
6938    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6939
6940    /**
6941     * Set whether a given file selector entry widget's internal file
6942     * selector will raise an Elementary "inner window", instead of a
6943     * dedicated Elementary window. By default, it won't.
6944     *
6945     * @param obj The file selector entry widget
6946     * @param value @c EINA_TRUE to make it use an inner window, @c
6947     * EINA_TRUE to make it use a dedicated window
6948     *
6949     * @see elm_win_inwin_add() for more information on inner windows
6950     * @see elm_fileselector_entry_inwin_mode_get()
6951     */
6952    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6953
6954    /**
6955     * Get whether a given file selector entry widget's internal file
6956     * selector will raise an Elementary "inner window", instead of a
6957     * dedicated Elementary window.
6958     *
6959     * @param obj The file selector entry widget
6960     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6961     * if it will use a dedicated window
6962     *
6963     * @see elm_fileselector_entry_inwin_mode_set() for more details
6964     */
6965    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6966
6967    /**
6968     * Set the initial file system path for a given file selector entry
6969     * widget
6970     *
6971     * @param obj The file selector entry widget
6972     * @param path The path string
6973     *
6974     * It must be a <b>directory</b> path, which will have the contents
6975     * displayed initially in the file selector's view, when invoked
6976     * from @p obj. The default initial path is the @c "HOME"
6977     * environment variable's value.
6978     *
6979     * @see elm_fileselector_entry_path_get()
6980     */
6981    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6982
6983    /**
6984     * Get the parent directory's path to the latest file selection on
6985     * a given filer selector entry widget
6986     *
6987     * @param obj The file selector object
6988     * @return The (full) path of the directory of the last selection
6989     * on @p obj widget, a @b stringshared string
6990     *
6991     * @see elm_fileselector_entry_path_set()
6992     */
6993    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6994
6995    /**
6996     * @}
6997     */
6998
6999    /**
7000     * @defgroup Scroller Scroller
7001     *
7002     * A scroller holds a single object and "scrolls it around". This means that
7003     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7004     * region around, allowing to move through a much larger object that is
7005     * contained in the scroller. The scroller will always have a small minimum
7006     * size by default as it won't be limited by the contents of the scroller.
7007     *
7008     * Signals that you can add callbacks for are:
7009     * @li "edge,left" - the left edge of the content has been reached
7010     * @li "edge,right" - the right edge of the content has been reached
7011     * @li "edge,top" - the top edge of the content has been reached
7012     * @li "edge,bottom" - the bottom edge of the content has been reached
7013     * @li "scroll" - the content has been scrolled (moved)
7014     * @li "scroll,anim,start" - scrolling animation has started
7015     * @li "scroll,anim,stop" - scrolling animation has stopped
7016     * @li "scroll,drag,start" - dragging the contents around has started
7017     * @li "scroll,drag,stop" - dragging the contents around has stopped
7018     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7019     * user intervetion.
7020     *
7021     * @note When Elemementary is in embedded mode the scrollbars will not be
7022     * dragable, they appear merely as indicators of how much has been scrolled.
7023     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7024     * fingerscroll) won't work.
7025     *
7026     * Default contents parts of the scroller widget that you can use for are:
7027     * @li "default" - A content of the scroller
7028     *
7029     * In @ref tutorial_scroller you'll find an example of how to use most of
7030     * this API.
7031     * @{
7032     */
7033    /**
7034     * @brief Type that controls when scrollbars should appear.
7035     *
7036     * @see elm_scroller_policy_set()
7037     */
7038    typedef enum _Elm_Scroller_Policy
7039      {
7040         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7041         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7042         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7043         ELM_SCROLLER_POLICY_LAST
7044      } Elm_Scroller_Policy;
7045    /**
7046     * @brief Add a new scroller to the parent
7047     *
7048     * @param parent The parent object
7049     * @return The new object or NULL if it cannot be created
7050     */
7051    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7052    /**
7053     * @brief Set the content of the scroller widget (the object to be scrolled around).
7054     *
7055     * @param obj The scroller object
7056     * @param content The new content object
7057     *
7058     * Once the content object is set, a previously set one will be deleted.
7059     * If you want to keep that old content object, use the
7060     * elm_scroller_content_unset() function.
7061     * @deprecated use elm_object_content_set() instead
7062     */
7063    EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7064    /**
7065     * @brief Get the content of the scroller widget
7066     *
7067     * @param obj The slider object
7068     * @return The content that is being used
7069     *
7070     * Return the content object which is set for this widget
7071     *
7072     * @see elm_scroller_content_set()
7073     * @deprecated use elm_object_content_get() instead.
7074     */
7075    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7076    /**
7077     * @brief Unset the content of the scroller widget
7078     *
7079     * @param obj The slider object
7080     * @return The content that was being used
7081     *
7082     * Unparent and return the content object which was set for this widget
7083     *
7084     * @see elm_scroller_content_set()
7085     * @deprecated use elm_object_content_unset() instead.
7086     */
7087    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7088    /**
7089     * @brief Set custom theme elements for the scroller
7090     *
7091     * @param obj The scroller object
7092     * @param widget The widget name to use (default is "scroller")
7093     * @param base The base name to use (default is "base")
7094     */
7095    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7096    /**
7097     * @brief Make the scroller minimum size limited to the minimum size of the content
7098     *
7099     * @param obj The scroller object
7100     * @param w Enable limiting minimum size horizontally
7101     * @param h Enable limiting minimum size vertically
7102     *
7103     * By default the scroller will be as small as its design allows,
7104     * irrespective of its content. This will make the scroller minimum size the
7105     * right size horizontally and/or vertically to perfectly fit its content in
7106     * that direction.
7107     */
7108    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7109    /**
7110     * @brief Show a specific virtual region within the scroller content object
7111     *
7112     * @param obj The scroller object
7113     * @param x X coordinate of the region
7114     * @param y Y coordinate of the region
7115     * @param w Width of the region
7116     * @param h Height of the region
7117     *
7118     * This will ensure all (or part if it does not fit) of the designated
7119     * region in the virtual content object (0, 0 starting at the top-left of the
7120     * virtual content object) is shown within the scroller.
7121     */
7122    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);
7123    /**
7124     * @brief Set the scrollbar visibility policy
7125     *
7126     * @param obj The scroller object
7127     * @param policy_h Horizontal scrollbar policy
7128     * @param policy_v Vertical scrollbar policy
7129     *
7130     * This sets the scrollbar visibility policy for the given scroller.
7131     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7132     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7133     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7134     * respectively for the horizontal and vertical scrollbars.
7135     */
7136    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7137    /**
7138     * @brief Gets scrollbar visibility policy
7139     *
7140     * @param obj The scroller object
7141     * @param policy_h Horizontal scrollbar policy
7142     * @param policy_v Vertical scrollbar policy
7143     *
7144     * @see elm_scroller_policy_set()
7145     */
7146    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7147    /**
7148     * @brief Get the currently visible content region
7149     *
7150     * @param obj The scroller object
7151     * @param x X coordinate of the region
7152     * @param y Y coordinate of the region
7153     * @param w Width of the region
7154     * @param h Height of the region
7155     *
7156     * This gets the current region in the content object that is visible through
7157     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7158     * w, @p h values pointed to.
7159     *
7160     * @note All coordinates are relative to the content.
7161     *
7162     * @see elm_scroller_region_show()
7163     */
7164    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);
7165    /**
7166     * @brief Get the size of the content object
7167     *
7168     * @param obj The scroller object
7169     * @param w Width of the content object.
7170     * @param h Height of the content object.
7171     *
7172     * This gets the size of the content object of the scroller.
7173     */
7174    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7175    /**
7176     * @brief Set bouncing behavior
7177     *
7178     * @param obj The scroller object
7179     * @param h_bounce Allow bounce horizontally
7180     * @param v_bounce Allow bounce vertically
7181     *
7182     * When scrolling, the scroller may "bounce" when reaching an edge of the
7183     * content object. This is a visual way to indicate the end has been reached.
7184     * This is enabled by default for both axis. This API will set if it is enabled
7185     * for the given axis with the boolean parameters for each axis.
7186     */
7187    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7188    /**
7189     * @brief Get the bounce behaviour
7190     *
7191     * @param obj The Scroller object
7192     * @param h_bounce Will the scroller bounce horizontally or not
7193     * @param v_bounce Will the scroller bounce vertically or not
7194     *
7195     * @see elm_scroller_bounce_set()
7196     */
7197    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7198    /**
7199     * @brief Set scroll page size relative to viewport size.
7200     *
7201     * @param obj The scroller object
7202     * @param h_pagerel The horizontal page relative size
7203     * @param v_pagerel The vertical page relative size
7204     *
7205     * The scroller is capable of limiting scrolling by the user to "pages". That
7206     * is to jump by and only show a "whole page" at a time as if the continuous
7207     * area of the scroller content is split into page sized pieces. This sets
7208     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7209     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7210     * axis. This is mutually exclusive with page size
7211     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7212     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7213     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7214     * the other axis.
7215     */
7216    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7217    /**
7218     * @brief Set scroll page size.
7219     *
7220     * @param obj The scroller object
7221     * @param h_pagesize The horizontal page size
7222     * @param v_pagesize The vertical page size
7223     *
7224     * This sets the page size to an absolute fixed value, with 0 turning it off
7225     * for that axis.
7226     *
7227     * @see elm_scroller_page_relative_set()
7228     */
7229    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7230    /**
7231     * @brief Get scroll current page number.
7232     *
7233     * @param obj The scroller object
7234     * @param h_pagenumber The horizontal page number
7235     * @param v_pagenumber The vertical page number
7236     *
7237     * The page number starts from 0. 0 is the first page.
7238     * Current page means the page which meets the top-left of the viewport.
7239     * If there are two or more pages in the viewport, it returns the number of the page
7240     * which meets the top-left of the viewport.
7241     *
7242     * @see elm_scroller_last_page_get()
7243     * @see elm_scroller_page_show()
7244     * @see elm_scroller_page_brint_in()
7245     */
7246    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7247    /**
7248     * @brief Get scroll last page number.
7249     *
7250     * @param obj The scroller object
7251     * @param h_pagenumber The horizontal page number
7252     * @param v_pagenumber The vertical page number
7253     *
7254     * The page number starts from 0. 0 is the first page.
7255     * This returns the last page number among the pages.
7256     *
7257     * @see elm_scroller_current_page_get()
7258     * @see elm_scroller_page_show()
7259     * @see elm_scroller_page_brint_in()
7260     */
7261    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7262    /**
7263     * Show a specific virtual region within the scroller content object by page number.
7264     *
7265     * @param obj The scroller object
7266     * @param h_pagenumber The horizontal page number
7267     * @param v_pagenumber The vertical page number
7268     *
7269     * 0, 0 of the indicated page is located at the top-left of the viewport.
7270     * This will jump to the page directly without animation.
7271     *
7272     * Example of usage:
7273     *
7274     * @code
7275     * sc = elm_scroller_add(win);
7276     * elm_scroller_content_set(sc, content);
7277     * elm_scroller_page_relative_set(sc, 1, 0);
7278     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7279     * elm_scroller_page_show(sc, h_page + 1, v_page);
7280     * @endcode
7281     *
7282     * @see elm_scroller_page_bring_in()
7283     */
7284    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7285    /**
7286     * Show a specific virtual region within the scroller content object by page number.
7287     *
7288     * @param obj The scroller object
7289     * @param h_pagenumber The horizontal page number
7290     * @param v_pagenumber The vertical page number
7291     *
7292     * 0, 0 of the indicated page is located at the top-left of the viewport.
7293     * This will slide to the page with animation.
7294     *
7295     * Example of usage:
7296     *
7297     * @code
7298     * sc = elm_scroller_add(win);
7299     * elm_scroller_content_set(sc, content);
7300     * elm_scroller_page_relative_set(sc, 1, 0);
7301     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7302     * elm_scroller_page_bring_in(sc, h_page, v_page);
7303     * @endcode
7304     *
7305     * @see elm_scroller_page_show()
7306     */
7307    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7308    /**
7309     * @brief Show a specific virtual region within the scroller content object.
7310     *
7311     * @param obj The scroller object
7312     * @param x X coordinate of the region
7313     * @param y Y coordinate of the region
7314     * @param w Width of the region
7315     * @param h Height of the region
7316     *
7317     * This will ensure all (or part if it does not fit) of the designated
7318     * region in the virtual content object (0, 0 starting at the top-left of the
7319     * virtual content object) is shown within the scroller. Unlike
7320     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7321     * to this location (if configuration in general calls for transitions). It
7322     * may not jump immediately to the new location and make take a while and
7323     * show other content along the way.
7324     *
7325     * @see elm_scroller_region_show()
7326     */
7327    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);
7328    /**
7329     * @brief Set event propagation on a scroller
7330     *
7331     * @param obj The scroller object
7332     * @param propagation If propagation is enabled or not
7333     *
7334     * This enables or disabled event propagation from the scroller content to
7335     * the scroller and its parent. By default event propagation is disabled.
7336     */
7337    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7338    /**
7339     * @brief Get event propagation for a scroller
7340     *
7341     * @param obj The scroller object
7342     * @return The propagation state
7343     *
7344     * This gets the event propagation for a scroller.
7345     *
7346     * @see elm_scroller_propagate_events_set()
7347     */
7348    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7349    /**
7350     * @brief Set scrolling gravity on a scroller
7351     *
7352     * @param obj The scroller object
7353     * @param x The scrolling horizontal gravity
7354     * @param y The scrolling vertical gravity
7355     *
7356     * The gravity, defines how the scroller will adjust its view
7357     * when the size of the scroller contents increase.
7358     *
7359     * The scroller will adjust the view to glue itself as follows.
7360     *
7361     *  x=0.0, for showing the left most region of the content.
7362     *  x=1.0, for showing the right most region of the content.
7363     *  y=0.0, for showing the bottom most region of the content.
7364     *  y=1.0, for showing the top most region of the content.
7365     *
7366     * Default values for x and y are 0.0
7367     */
7368    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7369    /**
7370     * @brief Get scrolling gravity values for a scroller
7371     *
7372     * @param obj The scroller object
7373     * @param x The scrolling horizontal gravity
7374     * @param y The scrolling vertical gravity
7375     *
7376     * This gets gravity values for a scroller.
7377     *
7378     * @see elm_scroller_gravity_set()
7379     *
7380     */
7381    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7382    /**
7383     * @}
7384     */
7385
7386    /**
7387     * @defgroup Label Label
7388     *
7389     * @image html img/widget/label/preview-00.png
7390     * @image latex img/widget/label/preview-00.eps
7391     *
7392     * @brief Widget to display text, with simple html-like markup.
7393     *
7394     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7395     * text doesn't fit the geometry of the label it will be ellipsized or be
7396     * cut. Elementary provides several themes for this widget:
7397     * @li default - No animation
7398     * @li marker - Centers the text in the label and make it bold by default
7399     * @li slide_long - The entire text appears from the right of the screen and
7400     * slides until it disappears in the left of the screen(reappering on the
7401     * right again).
7402     * @li slide_short - The text appears in the left of the label and slides to
7403     * the right to show the overflow. When all of the text has been shown the
7404     * position is reset.
7405     * @li slide_bounce - The text appears in the left of the label and slides to
7406     * the right to show the overflow. When all of the text has been shown the
7407     * animation reverses, moving the text to the left.
7408     *
7409     * Custom themes can of course invent new markup tags and style them any way
7410     * they like.
7411     *
7412     * The following signals may be emitted by the label widget:
7413     * @li "language,changed": The program's language changed.
7414     *
7415     * See @ref tutorial_label for a demonstration of how to use a label widget.
7416     * @{
7417     */
7418    /**
7419     * @brief Add a new label to the parent
7420     *
7421     * @param parent The parent object
7422     * @return The new object or NULL if it cannot be created
7423     */
7424    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7425    /**
7426     * @brief Set the label on the label object
7427     *
7428     * @param obj The label object
7429     * @param label The label will be used on the label object
7430     * @deprecated See elm_object_text_set()
7431     */
7432    EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
7433    /**
7434     * @brief Get the label used on the label object
7435     *
7436     * @param obj The label object
7437     * @return The string inside the label
7438     * @deprecated See elm_object_text_get()
7439     */
7440    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7441    /**
7442     * @brief Set the wrapping behavior of the label
7443     *
7444     * @param obj The label object
7445     * @param wrap To wrap text or not
7446     *
7447     * By default no wrapping is done. Possible values for @p wrap are:
7448     * @li ELM_WRAP_NONE - No wrapping
7449     * @li ELM_WRAP_CHAR - wrap between characters
7450     * @li ELM_WRAP_WORD - wrap between words
7451     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7452     */
7453    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7454    /**
7455     * @brief Get the wrapping behavior of the label
7456     *
7457     * @param obj The label object
7458     * @return Wrap type
7459     *
7460     * @see elm_label_line_wrap_set()
7461     */
7462    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7463    /**
7464     * @brief Set wrap width of the label
7465     *
7466     * @param obj The label object
7467     * @param w The wrap width in pixels at a minimum where words need to wrap
7468     *
7469     * This function sets the maximum width size hint of the label.
7470     *
7471     * @warning This is only relevant if the label is inside a container.
7472     */
7473    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7474    /**
7475     * @brief Get wrap width of the label
7476     *
7477     * @param obj The label object
7478     * @return The wrap width in pixels at a minimum where words need to wrap
7479     *
7480     * @see elm_label_wrap_width_set()
7481     */
7482    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7483    /**
7484     * @brief Set wrap height of the label
7485     *
7486     * @param obj The label object
7487     * @param h The wrap height in pixels at a minimum where words need to wrap
7488     *
7489     * This function sets the maximum height size hint of the label.
7490     *
7491     * @warning This is only relevant if the label is inside a container.
7492     */
7493    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7494    /**
7495     * @brief get wrap width of the label
7496     *
7497     * @param obj The label object
7498     * @return The wrap height in pixels at a minimum where words need to wrap
7499     */
7500    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7501    /**
7502     * @brief Set the font size on the label object.
7503     *
7504     * @param obj The label object
7505     * @param size font size
7506     *
7507     * @warning NEVER use this. It is for hyper-special cases only. use styles
7508     * instead. e.g. "big", "medium", "small" - or better name them by use:
7509     * "title", "footnote", "quote" etc.
7510     */
7511    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7512    /**
7513     * @brief Set the text color on the label object
7514     *
7515     * @param obj The label object
7516     * @param r Red property background color of The label object
7517     * @param g Green property background color of The label object
7518     * @param b Blue property background color of The label object
7519     * @param a Alpha property background color of The label object
7520     *
7521     * @warning NEVER use this. It is for hyper-special cases only. use styles
7522     * instead. e.g. "big", "medium", "small" - or better name them by use:
7523     * "title", "footnote", "quote" etc.
7524     */
7525    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);
7526    /**
7527     * @brief Set the text align on the label object
7528     *
7529     * @param obj The label object
7530     * @param align align mode ("left", "center", "right")
7531     *
7532     * @warning NEVER use this. It is for hyper-special cases only. use styles
7533     * instead. e.g. "big", "medium", "small" - or better name them by use:
7534     * "title", "footnote", "quote" etc.
7535     */
7536    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7537    /**
7538     * @brief Set background color of the label
7539     *
7540     * @param obj The label object
7541     * @param r Red property background color of The label object
7542     * @param g Green property background color of The label object
7543     * @param b Blue property background color of The label object
7544     * @param a Alpha property background alpha of The label object
7545     *
7546     * @warning NEVER use this. It is for hyper-special cases only. use styles
7547     * instead. e.g. "big", "medium", "small" - or better name them by use:
7548     * "title", "footnote", "quote" etc.
7549     */
7550    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);
7551    /**
7552     * @brief Set the ellipsis behavior of the label
7553     *
7554     * @param obj The label object
7555     * @param ellipsis To ellipsis text or not
7556     *
7557     * If set to true and the text doesn't fit in the label an ellipsis("...")
7558     * will be shown at the end of the widget.
7559     *
7560     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7561     * choosen wrap method was ELM_WRAP_WORD.
7562     */
7563    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7564    /**
7565     * @brief Set the text slide of the label
7566     *
7567     * @param obj The label object
7568     * @param slide To start slide or stop
7569     *
7570     * If set to true, the text of the label will slide/scroll through the length of
7571     * label.
7572     *
7573     * @warning This only works with the themes "slide_short", "slide_long" and
7574     * "slide_bounce".
7575     */
7576    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7577    /**
7578     * @brief Get the text slide mode of the label
7579     *
7580     * @param obj The label object
7581     * @return slide slide mode value
7582     *
7583     * @see elm_label_slide_set()
7584     */
7585    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7586    /**
7587     * @brief Set the slide duration(speed) of the label
7588     *
7589     * @param obj The label object
7590     * @return The duration in seconds in moving text from slide begin position
7591     * to slide end position
7592     */
7593    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7594    /**
7595     * @brief Get the slide duration(speed) of the label
7596     *
7597     * @param obj The label object
7598     * @return The duration time in moving text from slide begin position to slide end position
7599     *
7600     * @see elm_label_slide_duration_set()
7601     */
7602    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7603    /**
7604     * @}
7605     */
7606
7607    /**
7608     * @defgroup Toggle Toggle
7609     *
7610     * @image html img/widget/toggle/preview-00.png
7611     * @image latex img/widget/toggle/preview-00.eps
7612     *
7613     * @brief A toggle is a slider which can be used to toggle between
7614     * two values.  It has two states: on and off.
7615     *
7616     * This widget is deprecated. Please use elm_check_add() instead using the
7617     * toggle style like:
7618     * 
7619     * @code
7620     * obj = elm_check_add(parent);
7621     * elm_object_style_set(obj, "toggle");
7622     * elm_object_part_text_set(obj, "on", "ON");
7623     * elm_object_part_text_set(obj, "off", "OFF");
7624     * @endcode
7625     * 
7626     * Signals that you can add callbacks for are:
7627     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7628     *                 until the toggle is released by the cursor (assuming it
7629     *                 has been triggered by the cursor in the first place).
7630     *
7631     * Default contents parts of the toggle widget that you can use for are:
7632     * @li "icon" - A icon of the toggle
7633     *
7634     * Default text parts of the toggle widget that you can use for are:
7635     * @li "elm.text" - Label of the toggle
7636     * 
7637     * @ref tutorial_toggle show how to use a toggle.
7638     * @{
7639     */
7640    /**
7641     * @brief Add a toggle to @p parent.
7642     *
7643     * @param parent The parent object
7644     *
7645     * @return The toggle object
7646     */
7647    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7648    /**
7649     * @brief Sets the label to be displayed with the toggle.
7650     *
7651     * @param obj The toggle object
7652     * @param label The label to be displayed
7653     *
7654     * @deprecated use elm_object_text_set() instead.
7655     */
7656    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7657    /**
7658     * @brief Gets the label of the toggle
7659     *
7660     * @param obj  toggle object
7661     * @return The label of the toggle
7662     *
7663     * @deprecated use elm_object_text_get() instead.
7664     */
7665    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7666    /**
7667     * @brief Set the icon used for the toggle
7668     *
7669     * @param obj The toggle object
7670     * @param icon The icon object for the button
7671     *
7672     * Once the icon object is set, a previously set one will be deleted
7673     * If you want to keep that old content object, use the
7674     * elm_toggle_icon_unset() function.
7675     *
7676     * @deprecated use elm_object_part_content_set() instead.
7677     */
7678    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7679    /**
7680     * @brief Get the icon used for the toggle
7681     *
7682     * @param obj The toggle object
7683     * @return The icon object that is being used
7684     *
7685     * Return the icon object which is set for this widget.
7686     *
7687     * @see elm_toggle_icon_set()
7688     *
7689     * @deprecated use elm_object_part_content_get() instead.
7690     */
7691    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7692    /**
7693     * @brief Unset the icon used for the toggle
7694     *
7695     * @param obj The toggle object
7696     * @return The icon object that was being used
7697     *
7698     * Unparent and return the icon object which was set for this widget.
7699     *
7700     * @see elm_toggle_icon_set()
7701     *
7702     * @deprecated use elm_object_part_content_unset() instead.
7703     */
7704    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7705    /**
7706     * @brief Sets the labels to be associated with the on and off states of the toggle.
7707     *
7708     * @param obj The toggle object
7709     * @param onlabel The label displayed when the toggle is in the "on" state
7710     * @param offlabel The label displayed when the toggle is in the "off" state
7711     *
7712     * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7713     * instead.
7714     */
7715    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7716    /**
7717     * @brief Gets the labels associated with the on and off states of the
7718     * toggle.
7719     *
7720     * @param obj The toggle object
7721     * @param onlabel A char** to place the onlabel of @p obj into
7722     * @param offlabel A char** to place the offlabel of @p obj into
7723     *
7724     * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7725     * instead.
7726     */
7727    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7728    /**
7729     * @brief Sets the state of the toggle to @p state.
7730     *
7731     * @param obj The toggle object
7732     * @param state The state of @p obj
7733     *
7734     * @deprecated use elm_check_state_set() instead.
7735     */
7736    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7737    /**
7738     * @brief Gets the state of the toggle to @p state.
7739     *
7740     * @param obj The toggle object
7741     * @return The state of @p obj
7742     *
7743     * @deprecated use elm_check_state_get() instead.
7744     */
7745    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7746    /**
7747     * @brief Sets the state pointer of the toggle to @p statep.
7748     *
7749     * @param obj The toggle object
7750     * @param statep The state pointer of @p obj
7751     *
7752     * @deprecated use elm_check_state_pointer_set() instead.
7753     */
7754    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7755    /**
7756     * @}
7757     */
7758
7759    /**
7760     * @defgroup Frame Frame
7761     *
7762     * @image html img/widget/frame/preview-00.png
7763     * @image latex img/widget/frame/preview-00.eps
7764     *
7765     * @brief Frame is a widget that holds some content and has a title.
7766     *
7767     * The default look is a frame with a title, but Frame supports multple
7768     * styles:
7769     * @li default
7770     * @li pad_small
7771     * @li pad_medium
7772     * @li pad_large
7773     * @li pad_huge
7774     * @li outdent_top
7775     * @li outdent_bottom
7776     *
7777     * Of all this styles only default shows the title. Frame emits no signals.
7778     *
7779     * Default contents parts of the frame widget that you can use for are:
7780     * @li "default" - A content of the frame
7781     *
7782     * Default text parts of the frame widget that you can use for are:
7783     * @li "elm.text" - Label of the frame
7784     *
7785     * For a detailed example see the @ref tutorial_frame.
7786     *
7787     * @{
7788     */
7789    /**
7790     * @brief Add a new frame to the parent
7791     *
7792     * @param parent The parent object
7793     * @return The new object or NULL if it cannot be created
7794     */
7795    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7796    /**
7797     * @brief Set the frame label
7798     *
7799     * @param obj The frame object
7800     * @param label The label of this frame object
7801     *
7802     * @deprecated use elm_object_text_set() instead.
7803     */
7804    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7805    /**
7806     * @brief Get the frame label
7807     *
7808     * @param obj The frame object
7809     *
7810     * @return The label of this frame objet or NULL if unable to get frame
7811     *
7812     * @deprecated use elm_object_text_get() instead.
7813     */
7814    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7815    /**
7816     * @brief Set the content of the frame widget
7817     *
7818     * Once the content object is set, a previously set one will be deleted.
7819     * If you want to keep that old content object, use the
7820     * elm_frame_content_unset() function.
7821     *
7822     * @param obj The frame object
7823     * @param content The content will be filled in this frame object
7824     *
7825     * @deprecated use elm_object_content_set() instead.
7826     */
7827    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7828    /**
7829     * @brief Get the content of the frame widget
7830     *
7831     * Return the content object which is set for this widget
7832     *
7833     * @param obj The frame object
7834     * @return The content that is being used
7835     *
7836     * @deprecated use elm_object_content_get() instead.
7837     */
7838    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7839    /**
7840     * @brief Unset the content of the frame widget
7841     *
7842     * Unparent and return the content object which was set for this widget
7843     *
7844     * @param obj The frame object
7845     * @return The content that was being used
7846     *
7847     * @deprecated use elm_object_content_unset() instead.
7848     */
7849    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7850    /**
7851     * @}
7852     */
7853
7854    /**
7855     * @defgroup Table Table
7856     *
7857     * A container widget to arrange other widgets in a table where items can
7858     * also span multiple columns or rows - even overlap (and then be raised or
7859     * lowered accordingly to adjust stacking if they do overlap).
7860     *
7861     * For a Table widget the row/column count is not fixed.
7862     * The table widget adjusts itself when subobjects are added to it dynamically.
7863     *
7864     * The followin are examples of how to use a table:
7865     * @li @ref tutorial_table_01
7866     * @li @ref tutorial_table_02
7867     *
7868     * @{
7869     */
7870    /**
7871     * @brief Add a new table to the parent
7872     *
7873     * @param parent The parent object
7874     * @return The new object or NULL if it cannot be created
7875     */
7876    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7877    /**
7878     * @brief Set the homogeneous layout in the table
7879     *
7880     * @param obj The layout object
7881     * @param homogeneous A boolean to set if the layout is homogeneous in the
7882     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7883     */
7884    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7885    /**
7886     * @brief Get the current table homogeneous mode.
7887     *
7888     * @param obj The table object
7889     * @return A boolean to indicating if the layout is homogeneous in the table
7890     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7891     */
7892    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7893    /**
7894     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7895     */
7896    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7897    /**
7898     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7899     */
7900    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7901    /**
7902     * @brief Set padding between cells.
7903     *
7904     * @param obj The layout object.
7905     * @param horizontal set the horizontal padding.
7906     * @param vertical set the vertical padding.
7907     *
7908     * Default value is 0.
7909     */
7910    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7911    /**
7912     * @brief Get padding between cells.
7913     *
7914     * @param obj The layout object.
7915     * @param horizontal set the horizontal padding.
7916     * @param vertical set the vertical padding.
7917     */
7918    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7919    /**
7920     * @brief Add a subobject on the table with the coordinates passed
7921     *
7922     * @param obj The table object
7923     * @param subobj The subobject to be added to the table
7924     * @param x Row number
7925     * @param y Column number
7926     * @param w rowspan
7927     * @param h colspan
7928     *
7929     * @note All positioning inside the table is relative to rows and columns, so
7930     * a value of 0 for x and y, means the top left cell of the table, and a
7931     * value of 1 for w and h means @p subobj only takes that 1 cell.
7932     */
7933    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7934    /**
7935     * @brief Remove child from table.
7936     *
7937     * @param obj The table object
7938     * @param subobj The subobject
7939     */
7940    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7941    /**
7942     * @brief Faster way to remove all child objects from a table object.
7943     *
7944     * @param obj The table object
7945     * @param clear If true, will delete children, else just remove from table.
7946     */
7947    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7948    /**
7949     * @brief Set the packing location of an existing child of the table
7950     *
7951     * @param subobj The subobject to be modified in the table
7952     * @param x Row number
7953     * @param y Column number
7954     * @param w rowspan
7955     * @param h colspan
7956     *
7957     * Modifies the position of an object already in the table.
7958     *
7959     * @note All positioning inside the table is relative to rows and columns, so
7960     * a value of 0 for x and y, means the top left cell of the table, and a
7961     * value of 1 for w and h means @p subobj only takes that 1 cell.
7962     */
7963    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7964    /**
7965     * @brief Get the packing location of an existing child of the table
7966     *
7967     * @param subobj The subobject to be modified in the table
7968     * @param x Row number
7969     * @param y Column number
7970     * @param w rowspan
7971     * @param h colspan
7972     *
7973     * @see elm_table_pack_set()
7974     */
7975    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7976    /**
7977     * @}
7978     */
7979
7980    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7981    typedef struct Elm_Gen_Item Elm_Gen_Item;
7982    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7983    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7984    typedef char        *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7985    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. */
7986    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. */
7987    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7988    struct _Elm_Gen_Item_Class
7989      {
7990         const char             *item_style;
7991         struct _Elm_Gen_Item_Class_Func
7992           {
7993              Elm_Gen_Item_Label_Get_Cb label_get;
7994              Elm_Gen_Item_Content_Get_Cb  content_get;
7995              Elm_Gen_Item_State_Get_Cb state_get;
7996              Elm_Gen_Item_Del_Cb       del;
7997           } func;
7998      };
7999    EAPI void elm_gen_clear(Evas_Object *obj);
8000    EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8001    EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8002    EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8003    EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8004    EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8005    EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8006    EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8007    EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8008    EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8009    EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8010    EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8011    EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8012    EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8013    EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8014    EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8015    EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8016    EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8017    EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8018    EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8019    EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8020
8021    /**
8022     * @defgroup Gengrid Gengrid (Generic grid)
8023     *
8024     * This widget aims to position objects in a grid layout while
8025     * actually creating and rendering only the visible ones, using the
8026     * same idea as the @ref Genlist "genlist": the user defines a @b
8027     * class for each item, specifying functions that will be called at
8028     * object creation, deletion, etc. When those items are selected by
8029     * the user, a callback function is issued. Users may interact with
8030     * a gengrid via the mouse (by clicking on items to select them and
8031     * clicking on the grid's viewport and swiping to pan the whole
8032     * view) or via the keyboard, navigating through item with the
8033     * arrow keys.
8034     *
8035     * @section Gengrid_Layouts Gengrid layouts
8036     *
8037     * Gengrid may layout its items in one of two possible layouts:
8038     * - horizontal or
8039     * - vertical.
8040     *
8041     * When in "horizontal mode", items will be placed in @b columns,
8042     * from top to bottom and, when the space for a column is filled,
8043     * another one is started on the right, thus expanding the grid
8044     * horizontally, making for horizontal scrolling. When in "vertical
8045     * mode" , though, items will be placed in @b rows, from left to
8046     * right and, when the space for a row is filled, another one is
8047     * started below, thus expanding the grid vertically (and making
8048     * for vertical scrolling).
8049     *
8050     * @section Gengrid_Items Gengrid items
8051     *
8052     * An item in a gengrid can have 0 or more text labels (they can be
8053     * regular text or textblock Evas objects - that's up to the style
8054     * to determine), 0 or more icons (which are simply objects
8055     * swallowed into the gengrid item's theming Edje object) and 0 or
8056     * more <b>boolean states</b>, which have the behavior left to the
8057     * user to define. The Edje part names for each of these properties
8058     * will be looked up, in the theme file for the gengrid, under the
8059     * Edje (string) data items named @c "labels", @c "icons" and @c
8060     * "states", respectively. For each of those properties, if more
8061     * than one part is provided, they must have names listed separated
8062     * by spaces in the data fields. For the default gengrid item
8063     * theme, we have @b one label part (@c "elm.text"), @b two icon
8064     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8065     * no state parts.
8066     *
8067     * A gengrid item may be at one of several styles. Elementary
8068     * provides one by default - "default", but this can be extended by
8069     * system or application custom themes/overlays/extensions (see
8070     * @ref Theme "themes" for more details).
8071     *
8072     * @section Gengrid_Item_Class Gengrid item classes
8073     *
8074     * In order to have the ability to add and delete items on the fly,
8075     * gengrid implements a class (callback) system where the
8076     * application provides a structure with information about that
8077     * type of item (gengrid may contain multiple different items with
8078     * different classes, states and styles). Gengrid will call the
8079     * functions in this struct (methods) when an item is "realized"
8080     * (i.e., created dynamically, while the user is scrolling the
8081     * grid). All objects will simply be deleted when no longer needed
8082     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8083     * contains the following members:
8084     * - @c item_style - This is a constant string and simply defines
8085     * the name of the item style. It @b must be specified and the
8086     * default should be @c "default".
8087     * - @c func.label_get - This function is called when an item
8088     * object is actually created. The @c data parameter will point to
8089     * the same data passed to elm_gengrid_item_append() and related
8090     * item creation functions. The @c obj parameter is the gengrid
8091     * object itself, while the @c part one is the name string of one
8092     * of the existing text parts in the Edje group implementing the
8093     * item's theme. This function @b must return a strdup'()ed string,
8094     * as the caller will free() it when done. See
8095     * #Elm_Gengrid_Item_Label_Get_Cb.
8096     * - @c func.content_get - This function is called when an item object
8097     * is actually created. The @c data parameter will point to the
8098     * same data passed to elm_gengrid_item_append() and related item
8099     * creation functions. The @c obj parameter is the gengrid object
8100     * itself, while the @c part one is the name string of one of the
8101     * existing (content) swallow parts in the Edje group implementing the
8102     * item's theme. It must return @c NULL, when no content is desired,
8103     * or a valid object handle, otherwise. The object will be deleted
8104     * by the gengrid on its deletion or when the item is "unrealized".
8105     * See #Elm_Gengrid_Item_Content_Get_Cb.
8106     * - @c func.state_get - This function is called when an item
8107     * object is actually created. The @c data parameter will point to
8108     * the same data passed to elm_gengrid_item_append() and related
8109     * item creation functions. The @c obj parameter is the gengrid
8110     * object itself, while the @c part one is the name string of one
8111     * of the state parts in the Edje group implementing the item's
8112     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8113     * true/on. Gengrids will emit a signal to its theming Edje object
8114     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8115     * "source" arguments, respectively, when the state is true (the
8116     * default is false), where @c XXX is the name of the (state) part.
8117     * See #Elm_Gengrid_Item_State_Get_Cb.
8118     * - @c func.del - This is called when elm_gengrid_item_del() is
8119     * called on an item or elm_gengrid_clear() is called on the
8120     * gengrid. This is intended for use when gengrid items are
8121     * deleted, so any data attached to the item (e.g. its data
8122     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8123     *
8124     * @section Gengrid_Usage_Hints Usage hints
8125     *
8126     * If the user wants to have multiple items selected at the same
8127     * time, elm_gengrid_multi_select_set() will permit it. If the
8128     * gengrid is single-selection only (the default), then
8129     * elm_gengrid_select_item_get() will return the selected item or
8130     * @c NULL, if none is selected. If the gengrid is under
8131     * multi-selection, then elm_gengrid_selected_items_get() will
8132     * return a list (that is only valid as long as no items are
8133     * modified (added, deleted, selected or unselected) of child items
8134     * on a gengrid.
8135     *
8136     * If an item changes (internal (boolean) state, label or content 
8137     * changes), then use elm_gengrid_item_update() to have gengrid
8138     * update the item with the new state. A gengrid will re-"realize"
8139     * the item, thus calling the functions in the
8140     * #Elm_Gengrid_Item_Class set for that item.
8141     *
8142     * To programmatically (un)select an item, use
8143     * elm_gengrid_item_selected_set(). To get its selected state use
8144     * elm_gengrid_item_selected_get(). To make an item disabled
8145     * (unable to be selected and appear differently) use
8146     * elm_gengrid_item_disabled_set() to set this and
8147     * elm_gengrid_item_disabled_get() to get the disabled state.
8148     *
8149     * Grid cells will only have their selection smart callbacks called
8150     * when firstly getting selected. Any further clicks will do
8151     * nothing, unless you enable the "always select mode", with
8152     * elm_gengrid_always_select_mode_set(), thus making every click to
8153     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8154     * turn off the ability to select items entirely in the widget and
8155     * they will neither appear selected nor call the selection smart
8156     * callbacks.
8157     *
8158     * Remember that you can create new styles and add your own theme
8159     * augmentation per application with elm_theme_extension_add(). If
8160     * you absolutely must have a specific style that overrides any
8161     * theme the user or system sets up you can use
8162     * elm_theme_overlay_add() to add such a file.
8163     *
8164     * @section Gengrid_Smart_Events Gengrid smart events
8165     *
8166     * Smart events that you can add callbacks for are:
8167     * - @c "activated" - The user has double-clicked or pressed
8168     *   (enter|return|spacebar) on an item. The @c event_info parameter
8169     *   is the gengrid item that was activated.
8170     * - @c "clicked,double" - The user has double-clicked an item.
8171     *   The @c event_info parameter is the gengrid item that was double-clicked.
8172     * - @c "longpressed" - This is called when the item is pressed for a certain
8173     *   amount of time. By default it's 1 second.
8174     * - @c "selected" - The user has made an item selected. The
8175     *   @c event_info parameter is the gengrid item that was selected.
8176     * - @c "unselected" - The user has made an item unselected. The
8177     *   @c event_info parameter is the gengrid item that was unselected.
8178     * - @c "realized" - This is called when the item in the gengrid
8179     *   has its implementing Evas object instantiated, de facto. @c
8180     *   event_info is the gengrid item that was created. The object
8181     *   may be deleted at any time, so it is highly advised to the
8182     *   caller @b not to use the object pointer returned from
8183     *   elm_gengrid_item_object_get(), because it may point to freed
8184     *   objects.
8185     * - @c "unrealized" - This is called when the implementing Evas
8186     *   object for this item is deleted. @c event_info is the gengrid
8187     *   item that was deleted.
8188     * - @c "changed" - Called when an item is added, removed, resized
8189     *   or moved and when the gengrid is resized or gets "horizontal"
8190     *   property changes.
8191     * - @c "scroll,anim,start" - This is called when scrolling animation has
8192     *   started.
8193     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8194     *   stopped.
8195     * - @c "drag,start,up" - Called when the item in the gengrid has
8196     *   been dragged (not scrolled) up.
8197     * - @c "drag,start,down" - Called when the item in the gengrid has
8198     *   been dragged (not scrolled) down.
8199     * - @c "drag,start,left" - Called when the item in the gengrid has
8200     *   been dragged (not scrolled) left.
8201     * - @c "drag,start,right" - Called when the item in the gengrid has
8202     *   been dragged (not scrolled) right.
8203     * - @c "drag,stop" - Called when the item in the gengrid has
8204     *   stopped being dragged.
8205     * - @c "drag" - Called when the item in the gengrid is being
8206     *   dragged.
8207     * - @c "scroll" - called when the content has been scrolled
8208     *   (moved).
8209     * - @c "scroll,drag,start" - called when dragging the content has
8210     *   started.
8211     * - @c "scroll,drag,stop" - called when dragging the content has
8212     *   stopped.
8213     * - @c "edge,top" - This is called when the gengrid is scrolled until
8214     *   the top edge.
8215     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8216     *   until the bottom edge.
8217     * - @c "edge,left" - This is called when the gengrid is scrolled
8218     *   until the left edge.
8219     * - @c "edge,right" - This is called when the gengrid is scrolled
8220     *   until the right edge.
8221     *
8222     * List of gengrid examples:
8223     * @li @ref gengrid_example
8224     */
8225
8226    /**
8227     * @addtogroup Gengrid
8228     * @{
8229     */
8230
8231    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8232    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8233    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8234    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8235    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8236    /**
8237     * Label fetching class function for Elm_Gen_Item_Class.
8238     * @param data The data passed in the item creation function
8239     * @param obj The base widget object
8240     * @param part The part name of the swallow
8241     * @return The allocated (NOT stringshared) string to set as the label
8242     */
8243    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8244    /**
8245     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8246     * @param data The data passed in the item creation function
8247     * @param obj The base widget object
8248     * @param part The part name of the swallow
8249     * @return The content object to swallow
8250     */
8251    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8252    /**
8253     * State fetching class function for Elm_Gen_Item_Class.
8254     * @param data The data passed in the item creation function
8255     * @param obj The base widget object
8256     * @param part The part name of the swallow
8257     * @return The hell if I know
8258     */
8259    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8260    /**
8261     * Deletion class function for Elm_Gen_Item_Class.
8262     * @param data The data passed in the item creation function
8263     * @param obj The base widget object
8264     */
8265    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8266
8267    /**
8268     * @struct _Elm_Gengrid_Item_Class
8269     *
8270     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8271     * field details.
8272     */
8273    struct _Elm_Gengrid_Item_Class
8274      {
8275         const char             *item_style;
8276         struct _Elm_Gengrid_Item_Class_Func
8277           {
8278              Elm_Gengrid_Item_Label_Get_Cb label_get;
8279              Elm_Gengrid_Item_Content_Get_Cb content_get;
8280              Elm_Gengrid_Item_State_Get_Cb state_get;
8281              Elm_Gengrid_Item_Del_Cb       del;
8282           } func;
8283      }; /**< #Elm_Gengrid_Item_Class member definitions */
8284    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8285    /**
8286     * Add a new gengrid widget to the given parent Elementary
8287     * (container) object
8288     *
8289     * @param parent The parent object
8290     * @return a new gengrid widget handle or @c NULL, on errors
8291     *
8292     * This function inserts a new gengrid widget on the canvas.
8293     *
8294     * @see elm_gengrid_item_size_set()
8295     * @see elm_gengrid_group_item_size_set()
8296     * @see elm_gengrid_horizontal_set()
8297     * @see elm_gengrid_item_append()
8298     * @see elm_gengrid_item_del()
8299     * @see elm_gengrid_clear()
8300     *
8301     * @ingroup Gengrid
8302     */
8303    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8304
8305    /**
8306     * Set the size for the items of a given gengrid widget
8307     *
8308     * @param obj The gengrid object.
8309     * @param w The items' width.
8310     * @param h The items' height;
8311     *
8312     * A gengrid, after creation, has still no information on the size
8313     * to give to each of its cells. So, you most probably will end up
8314     * with squares one @ref Fingers "finger" wide, the default
8315     * size. Use this function to force a custom size for you items,
8316     * making them as big as you wish.
8317     *
8318     * @see elm_gengrid_item_size_get()
8319     *
8320     * @ingroup Gengrid
8321     */
8322    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8323
8324    /**
8325     * Get the size set for the items of a given gengrid widget
8326     *
8327     * @param obj The gengrid object.
8328     * @param w Pointer to a variable where to store the items' width.
8329     * @param h Pointer to a variable where to store the items' height.
8330     *
8331     * @note Use @c NULL pointers on the size values you're not
8332     * interested in: they'll be ignored by the function.
8333     *
8334     * @see elm_gengrid_item_size_get() for more details
8335     *
8336     * @ingroup Gengrid
8337     */
8338    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8339
8340    /**
8341     * Set the size for the group items of a given gengrid widget
8342     *
8343     * @param obj The gengrid object.
8344     * @param w The group items' width.
8345     * @param h The group items' height;
8346     *
8347     * A gengrid, after creation, has still no information on the size
8348     * to give to each of its cells. So, you most probably will end up
8349     * with squares one @ref Fingers "finger" wide, the default
8350     * size. Use this function to force a custom size for you group items,
8351     * making them as big as you wish.
8352     *
8353     * @see elm_gengrid_group_item_size_get()
8354     *
8355     * @ingroup Gengrid
8356     */
8357    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8358
8359    /**
8360     * Get the size set for the group items of a given gengrid widget
8361     *
8362     * @param obj The gengrid object.
8363     * @param w Pointer to a variable where to store the group items' width.
8364     * @param h Pointer to a variable where to store the group items' height.
8365     *
8366     * @note Use @c NULL pointers on the size values you're not
8367     * interested in: they'll be ignored by the function.
8368     *
8369     * @see elm_gengrid_group_item_size_get() for more details
8370     *
8371     * @ingroup Gengrid
8372     */
8373    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8374
8375    /**
8376     * Set the items grid's alignment within a given gengrid widget
8377     *
8378     * @param obj The gengrid object.
8379     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8380     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8381     *
8382     * This sets the alignment of the whole grid of items of a gengrid
8383     * within its given viewport. By default, those values are both
8384     * 0.5, meaning that the gengrid will have its items grid placed
8385     * exactly in the middle of its viewport.
8386     *
8387     * @note If given alignment values are out of the cited ranges,
8388     * they'll be changed to the nearest boundary values on the valid
8389     * ranges.
8390     *
8391     * @see elm_gengrid_align_get()
8392     *
8393     * @ingroup Gengrid
8394     */
8395    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8396
8397    /**
8398     * Get the items grid's alignment values within a given gengrid
8399     * widget
8400     *
8401     * @param obj The gengrid object.
8402     * @param align_x Pointer to a variable where to store the
8403     * horizontal alignment.
8404     * @param align_y Pointer to a variable where to store the vertical
8405     * alignment.
8406     *
8407     * @note Use @c NULL pointers on the alignment values you're not
8408     * interested in: they'll be ignored by the function.
8409     *
8410     * @see elm_gengrid_align_set() for more details
8411     *
8412     * @ingroup Gengrid
8413     */
8414    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8415
8416    /**
8417     * Set whether a given gengrid widget is or not able have items
8418     * @b reordered
8419     *
8420     * @param obj The gengrid object
8421     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8422     * @c EINA_FALSE to turn it off
8423     *
8424     * If a gengrid is set to allow reordering, a click held for more
8425     * than 0.5 over a given item will highlight it specially,
8426     * signalling the gengrid has entered the reordering state. From
8427     * that time on, the user will be able to, while still holding the
8428     * mouse button down, move the item freely in the gengrid's
8429     * viewport, replacing to said item to the locations it goes to.
8430     * The replacements will be animated and, whenever the user
8431     * releases the mouse button, the item being replaced gets a new
8432     * definitive place in the grid.
8433     *
8434     * @see elm_gengrid_reorder_mode_get()
8435     *
8436     * @ingroup Gengrid
8437     */
8438    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8439
8440    /**
8441     * Get whether a given gengrid widget is or not able have items
8442     * @b reordered
8443     *
8444     * @param obj The gengrid object
8445     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8446     * off
8447     *
8448     * @see elm_gengrid_reorder_mode_set() for more details
8449     *
8450     * @ingroup Gengrid
8451     */
8452    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8453
8454    /**
8455     * Append a new item in a given gengrid widget.
8456     *
8457     * @param obj The gengrid object.
8458     * @param gic The item class for the item.
8459     * @param data The item data.
8460     * @param func Convenience function called when the item is
8461     * selected.
8462     * @param func_data Data to be passed to @p func.
8463     * @return A handle to the item added or @c NULL, on errors.
8464     *
8465     * This adds an item to the beginning of the gengrid.
8466     *
8467     * @see elm_gengrid_item_prepend()
8468     * @see elm_gengrid_item_insert_before()
8469     * @see elm_gengrid_item_insert_after()
8470     * @see elm_gengrid_item_del()
8471     *
8472     * @ingroup Gengrid
8473     */
8474    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);
8475
8476    /**
8477     * Prepend a new item in a given gengrid widget.
8478     *
8479     * @param obj The gengrid object.
8480     * @param gic The item class for the item.
8481     * @param data The item data.
8482     * @param func Convenience function called when the item is
8483     * selected.
8484     * @param func_data Data to be passed to @p func.
8485     * @return A handle to the item added or @c NULL, on errors.
8486     *
8487     * This adds an item to the end of the gengrid.
8488     *
8489     * @see elm_gengrid_item_append()
8490     * @see elm_gengrid_item_insert_before()
8491     * @see elm_gengrid_item_insert_after()
8492     * @see elm_gengrid_item_del()
8493     *
8494     * @ingroup Gengrid
8495     */
8496    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);
8497
8498    /**
8499     * Insert an item before another in a gengrid widget
8500     *
8501     * @param obj The gengrid object.
8502     * @param gic The item class for the item.
8503     * @param data The item data.
8504     * @param relative The item to place this new one before.
8505     * @param func Convenience function called when the item is
8506     * selected.
8507     * @param func_data Data to be passed to @p func.
8508     * @return A handle to the item added or @c NULL, on errors.
8509     *
8510     * This inserts an item before another in the gengrid.
8511     *
8512     * @see elm_gengrid_item_append()
8513     * @see elm_gengrid_item_prepend()
8514     * @see elm_gengrid_item_insert_after()
8515     * @see elm_gengrid_item_del()
8516     *
8517     * @ingroup Gengrid
8518     */
8519    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);
8520
8521    /**
8522     * Insert an item after another in a gengrid widget
8523     *
8524     * @param obj The gengrid object.
8525     * @param gic The item class for the item.
8526     * @param data The item data.
8527     * @param relative The item to place this new one after.
8528     * @param func Convenience function called when the item is
8529     * selected.
8530     * @param func_data Data to be passed to @p func.
8531     * @return A handle to the item added or @c NULL, on errors.
8532     *
8533     * This inserts an item after another in the gengrid.
8534     *
8535     * @see elm_gengrid_item_append()
8536     * @see elm_gengrid_item_prepend()
8537     * @see elm_gengrid_item_insert_after()
8538     * @see elm_gengrid_item_del()
8539     *
8540     * @ingroup Gengrid
8541     */
8542    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);
8543
8544    /**
8545     * Insert an item in a gengrid widget using a user-defined sort function.
8546     *
8547     * @param obj The gengrid object.
8548     * @param gic The item class for the item.
8549     * @param data The item data.
8550     * @param comp User defined comparison function that defines the sort order based on
8551     * Elm_Gen_Item and its data param.
8552     * @param func Convenience function called when the item is selected.
8553     * @param func_data Data to be passed to @p func.
8554     * @return A handle to the item added or @c NULL, on errors.
8555     *
8556     * This inserts an item in the gengrid based on user defined comparison function.
8557     *
8558     * @see elm_gengrid_item_append()
8559     * @see elm_gengrid_item_prepend()
8560     * @see elm_gengrid_item_insert_after()
8561     * @see elm_gengrid_item_del()
8562     * @see elm_gengrid_item_direct_sorted_insert()
8563     *
8564     * @ingroup Gengrid
8565     */
8566    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);
8567
8568    /**
8569     * Insert an item in a gengrid widget using a user-defined sort function.
8570     *
8571     * @param obj The gengrid object.
8572     * @param gic The item class for the item.
8573     * @param data The item data.
8574     * @param comp User defined comparison function that defines the sort order based on
8575     * Elm_Gen_Item.
8576     * @param func Convenience function called when the item is selected.
8577     * @param func_data Data to be passed to @p func.
8578     * @return A handle to the item added or @c NULL, on errors.
8579     *
8580     * This inserts an item in the gengrid based on user defined comparison function.
8581     *
8582     * @see elm_gengrid_item_append()
8583     * @see elm_gengrid_item_prepend()
8584     * @see elm_gengrid_item_insert_after()
8585     * @see elm_gengrid_item_del()
8586     * @see elm_gengrid_item_sorted_insert()
8587     *
8588     * @ingroup Gengrid
8589     */
8590    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);
8591
8592    /**
8593     * Set whether items on a given gengrid widget are to get their
8594     * selection callbacks issued for @b every subsequent selection
8595     * click on them or just for the first click.
8596     *
8597     * @param obj The gengrid object
8598     * @param always_select @c EINA_TRUE to make items "always
8599     * selected", @c EINA_FALSE, otherwise
8600     *
8601     * By default, grid items will only call their selection callback
8602     * function when firstly getting selected, any subsequent further
8603     * clicks will do nothing. With this call, you make those
8604     * subsequent clicks also to issue the selection callbacks.
8605     *
8606     * @note <b>Double clicks</b> will @b always be reported on items.
8607     *
8608     * @see elm_gengrid_always_select_mode_get()
8609     *
8610     * @ingroup Gengrid
8611     */
8612    EINA_DEPRECATED EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8613
8614    /**
8615     * Get whether items on a given gengrid widget have their selection
8616     * callbacks issued for @b every subsequent selection click on them
8617     * or just for the first click.
8618     *
8619     * @param obj The gengrid object.
8620     * @return @c EINA_TRUE if the gengrid items are "always selected",
8621     * @c EINA_FALSE, otherwise
8622     *
8623     * @see elm_gengrid_always_select_mode_set() for more details
8624     *
8625     * @ingroup Gengrid
8626     */
8627    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8628
8629    /**
8630     * Set whether items on a given gengrid widget can be selected or not.
8631     *
8632     * @param obj The gengrid object
8633     * @param no_select @c EINA_TRUE to make items selectable,
8634     * @c EINA_FALSE otherwise
8635     *
8636     * This will make items in @p obj selectable or not. In the latter
8637     * case, any user interaction on the gengrid items will neither make
8638     * them appear selected nor them call their selection callback
8639     * functions.
8640     *
8641     * @see elm_gengrid_no_select_mode_get()
8642     *
8643     * @ingroup Gengrid
8644     */
8645    EINA_DEPRECATED EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8646
8647    /**
8648     * Get whether items on a given gengrid widget can be selected or
8649     * not.
8650     *
8651     * @param obj The gengrid object
8652     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8653     * otherwise
8654     *
8655     * @see elm_gengrid_no_select_mode_set() for more details
8656     *
8657     * @ingroup Gengrid
8658     */
8659    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8660
8661    /**
8662     * Enable or disable multi-selection in a given gengrid widget
8663     *
8664     * @param obj The gengrid object.
8665     * @param multi @c EINA_TRUE, to enable multi-selection,
8666     * @c EINA_FALSE to disable it.
8667     *
8668     * Multi-selection is the ability to have @b more than one
8669     * item selected, on a given gengrid, simultaneously. When it is
8670     * enabled, a sequence of clicks on different items will make them
8671     * all selected, progressively. A click on an already selected item
8672     * will unselect it. If interacting via the keyboard,
8673     * multi-selection is enabled while holding the "Shift" key.
8674     *
8675     * @note By default, multi-selection is @b disabled on gengrids
8676     *
8677     * @see elm_gengrid_multi_select_get()
8678     *
8679     * @ingroup Gengrid
8680     */
8681    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8682
8683    /**
8684     * Get whether multi-selection is enabled or disabled for a given
8685     * gengrid widget
8686     *
8687     * @param obj The gengrid object.
8688     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8689     * EINA_FALSE otherwise
8690     *
8691     * @see elm_gengrid_multi_select_set() for more details
8692     *
8693     * @ingroup Gengrid
8694     */
8695    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8696
8697    /**
8698     * Enable or disable bouncing effect for a given gengrid widget
8699     *
8700     * @param obj The gengrid object
8701     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8702     * @c EINA_FALSE to disable it
8703     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8704     * @c EINA_FALSE to disable it
8705     *
8706     * The bouncing effect occurs whenever one reaches the gengrid's
8707     * edge's while panning it -- it will scroll past its limits a
8708     * little bit and return to the edge again, in a animated for,
8709     * automatically.
8710     *
8711     * @note By default, gengrids have bouncing enabled on both axis
8712     *
8713     * @see elm_gengrid_bounce_get()
8714     *
8715     * @ingroup Gengrid
8716     */
8717    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8718
8719    /**
8720     * Get whether bouncing effects are enabled or disabled, for a
8721     * given gengrid widget, on each axis
8722     *
8723     * @param obj The gengrid object
8724     * @param h_bounce Pointer to a variable where to store the
8725     * horizontal bouncing flag.
8726     * @param v_bounce Pointer to a variable where to store the
8727     * vertical bouncing flag.
8728     *
8729     * @see elm_gengrid_bounce_set() for more details
8730     *
8731     * @ingroup Gengrid
8732     */
8733    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8734
8735    /**
8736     * Set a given gengrid widget's scrolling page size, relative to
8737     * its viewport size.
8738     *
8739     * @param obj The gengrid object
8740     * @param h_pagerel The horizontal page (relative) size
8741     * @param v_pagerel The vertical page (relative) size
8742     *
8743     * The gengrid's scroller is capable of binding scrolling by the
8744     * user to "pages". It means that, while scrolling and, specially
8745     * after releasing the mouse button, the grid will @b snap to the
8746     * nearest displaying page's area. When page sizes are set, the
8747     * grid's continuous content area is split into (equal) page sized
8748     * pieces.
8749     *
8750     * This function sets the size of a page <b>relatively to the
8751     * viewport dimensions</b> of the gengrid, for each axis. A value
8752     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8753     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8754     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8755     * 1.0. Values beyond those will make it behave behave
8756     * inconsistently. If you only want one axis to snap to pages, use
8757     * the value @c 0.0 for the other one.
8758     *
8759     * There is a function setting page size values in @b absolute
8760     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8761     * is mutually exclusive to this one.
8762     *
8763     * @see elm_gengrid_page_relative_get()
8764     *
8765     * @ingroup Gengrid
8766     */
8767    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8768
8769    /**
8770     * Get a given gengrid widget's scrolling page size, relative to
8771     * its viewport size.
8772     *
8773     * @param obj The gengrid object
8774     * @param h_pagerel Pointer to a variable where to store the
8775     * horizontal page (relative) size
8776     * @param v_pagerel Pointer to a variable where to store the
8777     * vertical page (relative) size
8778     *
8779     * @see elm_gengrid_page_relative_set() for more details
8780     *
8781     * @ingroup Gengrid
8782     */
8783    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8784
8785    /**
8786     * Set a given gengrid widget's scrolling page size
8787     *
8788     * @param obj The gengrid object
8789     * @param h_pagerel The horizontal page size, in pixels
8790     * @param v_pagerel The vertical page size, in pixels
8791     *
8792     * The gengrid's scroller is capable of binding scrolling by the
8793     * user to "pages". It means that, while scrolling and, specially
8794     * after releasing the mouse button, the grid will @b snap to the
8795     * nearest displaying page's area. When page sizes are set, the
8796     * grid's continuous content area is split into (equal) page sized
8797     * pieces.
8798     *
8799     * This function sets the size of a page of the gengrid, in pixels,
8800     * for each axis. Sane usable values are, between @c 0 and the
8801     * dimensions of @p obj, for each axis. Values beyond those will
8802     * make it behave behave inconsistently. If you only want one axis
8803     * to snap to pages, use the value @c 0 for the other one.
8804     *
8805     * There is a function setting page size values in @b relative
8806     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8807     * use is mutually exclusive to this one.
8808     *
8809     * @ingroup Gengrid
8810     */
8811    EINA_DEPRECATED EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8812
8813    /**
8814     * @brief Get gengrid current page number.
8815     *
8816     * @param obj The gengrid object
8817     * @param h_pagenumber The horizontal page number
8818     * @param v_pagenumber The vertical page number
8819     *
8820     * The page number starts from 0. 0 is the first page.
8821     * Current page means the page which meet the top-left of the viewport.
8822     * If there are two or more pages in the viewport, it returns the number of page
8823     * which meet the top-left of the viewport.
8824     *
8825     * @see elm_gengrid_last_page_get()
8826     * @see elm_gengrid_page_show()
8827     * @see elm_gengrid_page_brint_in()
8828     */
8829    EINA_DEPRECATED EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8830
8831    /**
8832     * @brief Get scroll last page number.
8833     *
8834     * @param obj The gengrid object
8835     * @param h_pagenumber The horizontal page number
8836     * @param v_pagenumber The vertical page number
8837     *
8838     * The page number starts from 0. 0 is the first page.
8839     * This returns the last page number among the pages.
8840     *
8841     * @see elm_gengrid_current_page_get()
8842     * @see elm_gengrid_page_show()
8843     * @see elm_gengrid_page_brint_in()
8844     */
8845    EINA_DEPRECATED EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8846
8847    /**
8848     * Show a specific virtual region within the gengrid content object by page number.
8849     *
8850     * @param obj The gengrid object
8851     * @param h_pagenumber The horizontal page number
8852     * @param v_pagenumber The vertical page number
8853     *
8854     * 0, 0 of the indicated page is located at the top-left of the viewport.
8855     * This will jump to the page directly without animation.
8856     *
8857     * Example of usage:
8858     *
8859     * @code
8860     * sc = elm_gengrid_add(win);
8861     * elm_gengrid_content_set(sc, content);
8862     * elm_gengrid_page_relative_set(sc, 1, 0);
8863     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8864     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8865     * @endcode
8866     *
8867     * @see elm_gengrid_page_bring_in()
8868     */
8869    EINA_DEPRECATED EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8870
8871    /**
8872     * Show a specific virtual region within the gengrid content object by page number.
8873     *
8874     * @param obj The gengrid object
8875     * @param h_pagenumber The horizontal page number
8876     * @param v_pagenumber The vertical page number
8877     *
8878     * 0, 0 of the indicated page is located at the top-left of the viewport.
8879     * This will slide to the page with animation.
8880     *
8881     * Example of usage:
8882     *
8883     * @code
8884     * sc = elm_gengrid_add(win);
8885     * elm_gengrid_content_set(sc, content);
8886     * elm_gengrid_page_relative_set(sc, 1, 0);
8887     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8888     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8889     * @endcode
8890     *
8891     * @see elm_gengrid_page_show()
8892     */
8893     EINA_DEPRECATED EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8894
8895    /**
8896     * Set the direction in which a given gengrid widget will expand while
8897     * placing its items.
8898     *
8899     * @param obj The gengrid object.
8900     * @param setting @c EINA_TRUE to make the gengrid expand
8901     * horizontally, @c EINA_FALSE to expand vertically.
8902     *
8903     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8904     * in @b columns, from top to bottom and, when the space for a
8905     * column is filled, another one is started on the right, thus
8906     * expanding the grid horizontally. When in "vertical mode"
8907     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8908     * to right and, when the space for a row is filled, another one is
8909     * started below, thus expanding the grid vertically.
8910     *
8911     * @see elm_gengrid_horizontal_get()
8912     *
8913     * @ingroup Gengrid
8914     */
8915    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8916
8917    /**
8918     * Get for what direction a given gengrid widget will expand while
8919     * placing its items.
8920     *
8921     * @param obj The gengrid object.
8922     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8923     * @c EINA_FALSE if it's set to expand vertically.
8924     *
8925     * @see elm_gengrid_horizontal_set() for more detais
8926     *
8927     * @ingroup Gengrid
8928     */
8929    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8930
8931    /**
8932     * Get the first item in a given gengrid widget
8933     *
8934     * @param obj The gengrid object
8935     * @return The first item's handle or @c NULL, if there are no
8936     * items in @p obj (and on errors)
8937     *
8938     * This returns the first item in the @p obj's internal list of
8939     * items.
8940     *
8941     * @see elm_gengrid_last_item_get()
8942     *
8943     * @ingroup Gengrid
8944     */
8945    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8946
8947    /**
8948     * Get the last item in a given gengrid widget
8949     *
8950     * @param obj The gengrid object
8951     * @return The last item's handle or @c NULL, if there are no
8952     * items in @p obj (and on errors)
8953     *
8954     * This returns the last item in the @p obj's internal list of
8955     * items.
8956     *
8957     * @see elm_gengrid_first_item_get()
8958     *
8959     * @ingroup Gengrid
8960     */
8961    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8962
8963    /**
8964     * Get the @b next item in a gengrid widget's internal list of items,
8965     * given a handle to one of those items.
8966     *
8967     * @param item The gengrid item to fetch next from
8968     * @return The item after @p item, or @c NULL if there's none (and
8969     * on errors)
8970     *
8971     * This returns the item placed after the @p item, on the container
8972     * gengrid.
8973     *
8974     * @see elm_gengrid_item_prev_get()
8975     *
8976     * @ingroup Gengrid
8977     */
8978    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8979
8980    /**
8981     * Get the @b previous item in a gengrid widget's internal list of items,
8982     * given a handle to one of those items.
8983     *
8984     * @param item The gengrid item to fetch previous from
8985     * @return The item before @p item, or @c NULL if there's none (and
8986     * on errors)
8987     *
8988     * This returns the item placed before the @p item, on the container
8989     * gengrid.
8990     *
8991     * @see elm_gengrid_item_next_get()
8992     *
8993     * @ingroup Gengrid
8994     */
8995    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8996
8997    /**
8998     * Get the gengrid object's handle which contains a given gengrid
8999     * item
9000     *
9001     * @param item The item to fetch the container from
9002     * @return The gengrid (parent) object
9003     *
9004     * This returns the gengrid object itself that an item belongs to.
9005     *
9006     * @ingroup Gengrid
9007     */
9008    EINA_DEPRECATED EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9009
9010    /**
9011     * Remove a gengrid item from its parent, deleting it.
9012     *
9013     * @param item The item to be removed.
9014     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9015     *
9016     * @see elm_gengrid_clear(), to remove all items in a gengrid at
9017     * once.
9018     *
9019     * @ingroup Gengrid
9020     */
9021    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9022
9023    /**
9024     * Update the contents of a given gengrid item
9025     *
9026     * @param item The gengrid item
9027     *
9028     * This updates an item by calling all the item class functions
9029     * again to get the contents, labels and states. Use this when the
9030     * original item data has changed and you want the changes to be
9031     * reflected.
9032     *
9033     * @ingroup Gengrid
9034     */
9035    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9036
9037    /**
9038     * Get the Gengrid Item class for the given Gengrid Item.
9039     *
9040     * @param item The gengrid item
9041     *
9042     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9043     * the function pointers and item_style.
9044     *
9045     * @ingroup Gengrid
9046     */
9047    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9048
9049    /**
9050     * Get the Gengrid Item class for the given Gengrid Item.
9051     *
9052     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9053     * the function pointers and item_style.
9054     *
9055     * @param item The gengrid item
9056     * @param gic The gengrid item class describing the function pointers and the item style.
9057     *
9058     * @ingroup Gengrid
9059     */
9060    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9061
9062    /**
9063     * Return the data associated to a given gengrid item
9064     *
9065     * @param item The gengrid item.
9066     * @return the data associated with this item.
9067     *
9068     * This returns the @c data value passed on the
9069     * elm_gengrid_item_append() and related item addition calls.
9070     *
9071     * @see elm_gengrid_item_append()
9072     * @see elm_gengrid_item_data_set()
9073     *
9074     * @ingroup Gengrid
9075     */
9076    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9077
9078    /**
9079     * Set the data associated with a given gengrid item
9080     *
9081     * @param item The gengrid item
9082     * @param data The data pointer to set on it
9083     *
9084     * This @b overrides the @c data value passed on the
9085     * elm_gengrid_item_append() and related item addition calls. This
9086     * function @b won't call elm_gengrid_item_update() automatically,
9087     * so you'd issue it afterwards if you want to have the item
9088     * updated to reflect the new data.
9089     *
9090     * @see elm_gengrid_item_data_get()
9091     * @see elm_gengrid_item_update()
9092     *
9093     * @ingroup Gengrid
9094     */
9095    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9096
9097    /**
9098     * Get a given gengrid item's position, relative to the whole
9099     * gengrid's grid area.
9100     *
9101     * @param item The Gengrid item.
9102     * @param x Pointer to variable to store the item's <b>row number</b>.
9103     * @param y Pointer to variable to store the item's <b>column number</b>.
9104     *
9105     * This returns the "logical" position of the item within the
9106     * gengrid. For example, @c (0, 1) would stand for first row,
9107     * second column.
9108     *
9109     * @ingroup Gengrid
9110     */
9111    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9112
9113    /**
9114     * Set whether a given gengrid item is selected or not
9115     *
9116     * @param item The gengrid item
9117     * @param selected Use @c EINA_TRUE, to make it selected, @c
9118     * EINA_FALSE to make it unselected
9119     *
9120     * This sets the selected state of an item. If multi-selection is
9121     * not enabled on the containing gengrid and @p selected is @c
9122     * EINA_TRUE, any other previously selected items will get
9123     * unselected in favor of this new one.
9124     *
9125     * @see elm_gengrid_item_selected_get()
9126     *
9127     * @ingroup Gengrid
9128     */
9129    EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9130
9131    /**
9132     * Get whether a given gengrid item is selected or not
9133     *
9134     * @param item The gengrid item
9135     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9136     *
9137     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9138     *
9139     * @see elm_gengrid_item_selected_set() for more details
9140     *
9141     * @ingroup Gengrid
9142     */
9143    EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9144
9145    /**
9146     * Get the real Evas object created to implement the view of a
9147     * given gengrid item
9148     *
9149     * @param item The gengrid item.
9150     * @return the Evas object implementing this item's view.
9151     *
9152     * This returns the actual Evas object used to implement the
9153     * specified gengrid item's view. This may be @c NULL, as it may
9154     * not have been created or may have been deleted, at any time, by
9155     * the gengrid. <b>Do not modify this object</b> (move, resize,
9156     * show, hide, etc.), as the gengrid is controlling it. This
9157     * function is for querying, emitting custom signals or hooking
9158     * lower level callbacks for events on that object. Do not delete
9159     * this object under any circumstances.
9160     *
9161     * @see elm_gengrid_item_data_get()
9162     *
9163     * @ingroup Gengrid
9164     */
9165    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9166
9167    /**
9168     * Show the portion of a gengrid's internal grid containing a given
9169     * item, @b immediately.
9170     *
9171     * @param item The item to display
9172     *
9173     * This causes gengrid to @b redraw its viewport's contents to the
9174     * region contining the given @p item item, if it is not fully
9175     * visible.
9176     *
9177     * @see elm_gengrid_item_bring_in()
9178     *
9179     * @ingroup Gengrid
9180     */
9181    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9182
9183    /**
9184     * Animatedly bring in, to the visible area of a gengrid, a given
9185     * item on it.
9186     *
9187     * @param item The gengrid item to display
9188     *
9189     * This causes gengrid to jump to the given @p item and show
9190     * it (by scrolling), if it is not fully visible. This will use
9191     * animation to do so and take a period of time to complete.
9192     *
9193     * @see elm_gengrid_item_show()
9194     *
9195     * @ingroup Gengrid
9196     */
9197    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9198
9199    /**
9200     * Set whether a given gengrid item is disabled or not.
9201     *
9202     * @param item The gengrid item
9203     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9204     * to enable it back.
9205     *
9206     * A disabled item cannot be selected or unselected. It will also
9207     * change its appearance, to signal the user it's disabled.
9208     *
9209     * @see elm_gengrid_item_disabled_get()
9210     *
9211     * @ingroup Gengrid
9212     */
9213    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9214
9215    /**
9216     * Get whether a given gengrid item is disabled or not.
9217     *
9218     * @param item The gengrid item
9219     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9220     * (and on errors).
9221     *
9222     * @see elm_gengrid_item_disabled_set() for more details
9223     *
9224     * @ingroup Gengrid
9225     */
9226    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9227
9228    /**
9229     * Set the text to be shown in a given gengrid item's tooltips.
9230     *
9231     * @param item The gengrid item
9232     * @param text The text to set in the content
9233     *
9234     * This call will setup the text to be used as tooltip to that item
9235     * (analogous to elm_object_tooltip_text_set(), but being item
9236     * tooltips with higher precedence than object tooltips). It can
9237     * have only one tooltip at a time, so any previous tooltip data
9238     * will get removed.
9239     *
9240     * @ingroup Gengrid
9241     */
9242    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9243
9244    /**
9245     * Set the content to be shown in a given gengrid item's tooltip
9246     *
9247     * @param item The gengrid item.
9248     * @param func The function returning the tooltip contents.
9249     * @param data What to provide to @a func as callback data/context.
9250     * @param del_cb Called when data is not needed anymore, either when
9251     *        another callback replaces @p func, the tooltip is unset with
9252     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9253     *        dies. This callback receives as its first parameter the
9254     *        given @p data, being @c event_info the item handle.
9255     *
9256     * This call will setup the tooltip's contents to @p item
9257     * (analogous to elm_object_tooltip_content_cb_set(), but being
9258     * item tooltips with higher precedence than object tooltips). It
9259     * can have only one tooltip at a time, so any previous tooltip
9260     * content will get removed. @p func (with @p data) will be called
9261     * every time Elementary needs to show the tooltip and it should
9262     * return a valid Evas object, which will be fully managed by the
9263     * tooltip system, getting deleted when the tooltip is gone.
9264     *
9265     * @ingroup Gengrid
9266     */
9267    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);
9268
9269    /**
9270     * Unset a tooltip from a given gengrid item
9271     *
9272     * @param item gengrid item to remove a previously set tooltip from.
9273     *
9274     * This call removes any tooltip set on @p item. The callback
9275     * provided as @c del_cb to
9276     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9277     * notify it is not used anymore (and have resources cleaned, if
9278     * need be).
9279     *
9280     * @see elm_gengrid_item_tooltip_content_cb_set()
9281     *
9282     * @ingroup Gengrid
9283     */
9284    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9285
9286    /**
9287     * Set a different @b style for a given gengrid item's tooltip.
9288     *
9289     * @param item gengrid item with tooltip set
9290     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9291     * "default", @c "transparent", etc)
9292     *
9293     * Tooltips can have <b>alternate styles</b> to be displayed on,
9294     * which are defined by the theme set on Elementary. This function
9295     * works analogously as elm_object_tooltip_style_set(), but here
9296     * applied only to gengrid item objects. The default style for
9297     * tooltips is @c "default".
9298     *
9299     * @note before you set a style you should define a tooltip with
9300     *       elm_gengrid_item_tooltip_content_cb_set() or
9301     *       elm_gengrid_item_tooltip_text_set()
9302     *
9303     * @see elm_gengrid_item_tooltip_style_get()
9304     *
9305     * @ingroup Gengrid
9306     */
9307    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9308
9309    /**
9310     * Get the style set a given gengrid item's tooltip.
9311     *
9312     * @param item gengrid item with tooltip already set on.
9313     * @return style the theme style in use, which defaults to
9314     *         "default". If the object does not have a tooltip set,
9315     *         then @c NULL is returned.
9316     *
9317     * @see elm_gengrid_item_tooltip_style_set() for more details
9318     *
9319     * @ingroup Gengrid
9320     */
9321    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9322    /**
9323     * @brief Disable size restrictions on an object's tooltip
9324     * @param item The tooltip's anchor object
9325     * @param disable If EINA_TRUE, size restrictions are disabled
9326     * @return EINA_FALSE on failure, EINA_TRUE on success
9327     *
9328     * This function allows a tooltip to expand beyond its parant window's canvas.
9329     * It will instead be limited only by the size of the display.
9330     */
9331    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9332    /**
9333     * @brief Retrieve size restriction state of an object's tooltip
9334     * @param item The tooltip's anchor object
9335     * @return If EINA_TRUE, size restrictions are disabled
9336     *
9337     * This function returns whether a tooltip is allowed to expand beyond
9338     * its parant window's canvas.
9339     * It will instead be limited only by the size of the display.
9340     */
9341    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9342    /**
9343     * Set the type of mouse pointer/cursor decoration to be shown,
9344     * when the mouse pointer is over the given gengrid widget item
9345     *
9346     * @param item gengrid item to customize cursor on
9347     * @param cursor the cursor type's name
9348     *
9349     * This function works analogously as elm_object_cursor_set(), but
9350     * here the cursor's changing area is restricted to the item's
9351     * area, and not the whole widget's. Note that that item cursors
9352     * have precedence over widget cursors, so that a mouse over @p
9353     * item will always show cursor @p type.
9354     *
9355     * If this function is called twice for an object, a previously set
9356     * cursor will be unset on the second call.
9357     *
9358     * @see elm_object_cursor_set()
9359     * @see elm_gengrid_item_cursor_get()
9360     * @see elm_gengrid_item_cursor_unset()
9361     *
9362     * @ingroup Gengrid
9363     */
9364    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9365
9366    /**
9367     * Get the type of mouse pointer/cursor decoration set to be shown,
9368     * when the mouse pointer is over the given gengrid widget item
9369     *
9370     * @param item gengrid item with custom cursor set
9371     * @return the cursor type's name or @c NULL, if no custom cursors
9372     * were set to @p item (and on errors)
9373     *
9374     * @see elm_object_cursor_get()
9375     * @see elm_gengrid_item_cursor_set() for more details
9376     * @see elm_gengrid_item_cursor_unset()
9377     *
9378     * @ingroup Gengrid
9379     */
9380    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9381
9382    /**
9383     * Unset any custom mouse pointer/cursor decoration set to be
9384     * shown, when the mouse pointer is over the given gengrid widget
9385     * item, thus making it show the @b default cursor again.
9386     *
9387     * @param item a gengrid item
9388     *
9389     * Use this call to undo any custom settings on this item's cursor
9390     * decoration, bringing it back to defaults (no custom style set).
9391     *
9392     * @see elm_object_cursor_unset()
9393     * @see elm_gengrid_item_cursor_set() for more details
9394     *
9395     * @ingroup Gengrid
9396     */
9397    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9398
9399    /**
9400     * Set a different @b style for a given custom cursor set for a
9401     * gengrid item.
9402     *
9403     * @param item gengrid item with custom cursor set
9404     * @param style the <b>theme style</b> to use (e.g. @c "default",
9405     * @c "transparent", etc)
9406     *
9407     * This function only makes sense when one is using custom mouse
9408     * cursor decorations <b>defined in a theme file</b> , which can
9409     * have, given a cursor name/type, <b>alternate styles</b> on
9410     * it. It works analogously as elm_object_cursor_style_set(), but
9411     * here applied only to gengrid item objects.
9412     *
9413     * @warning Before you set a cursor style you should have defined a
9414     *       custom cursor previously on the item, with
9415     *       elm_gengrid_item_cursor_set()
9416     *
9417     * @see elm_gengrid_item_cursor_engine_only_set()
9418     * @see elm_gengrid_item_cursor_style_get()
9419     *
9420     * @ingroup Gengrid
9421     */
9422    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9423
9424    /**
9425     * Get the current @b style set for a given gengrid item's custom
9426     * cursor
9427     *
9428     * @param item gengrid item with custom cursor set.
9429     * @return style the cursor style in use. If the object does not
9430     *         have a cursor set, then @c NULL is returned.
9431     *
9432     * @see elm_gengrid_item_cursor_style_set() for more details
9433     *
9434     * @ingroup Gengrid
9435     */
9436    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9437
9438    /**
9439     * Set if the (custom) cursor for a given gengrid item should be
9440     * searched in its theme, also, or should only rely on the
9441     * rendering engine.
9442     *
9443     * @param item item with custom (custom) cursor already set on
9444     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9445     * only on those provided by the rendering engine, @c EINA_FALSE to
9446     * have them searched on the widget's theme, as well.
9447     *
9448     * @note This call is of use only if you've set a custom cursor
9449     * for gengrid items, with elm_gengrid_item_cursor_set().
9450     *
9451     * @note By default, cursors will only be looked for between those
9452     * provided by the rendering engine.
9453     *
9454     * @ingroup Gengrid
9455     */
9456    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9457
9458    /**
9459     * Get if the (custom) cursor for a given gengrid item is being
9460     * searched in its theme, also, or is only relying on the rendering
9461     * engine.
9462     *
9463     * @param item a gengrid item
9464     * @return @c EINA_TRUE, if cursors are being looked for only on
9465     * those provided by the rendering engine, @c EINA_FALSE if they
9466     * are being searched on the widget's theme, as well.
9467     *
9468     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9469     *
9470     * @ingroup Gengrid
9471     */
9472    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9473
9474    /**
9475     * Remove all items from a given gengrid widget
9476     *
9477     * @param obj The gengrid object.
9478     *
9479     * This removes (and deletes) all items in @p obj, leaving it
9480     * empty.
9481     *
9482     * @see elm_gengrid_item_del(), to remove just one item.
9483     *
9484     * @ingroup Gengrid
9485     */
9486    EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9487
9488    /**
9489     * Get the selected item in a given gengrid widget
9490     *
9491     * @param obj The gengrid object.
9492     * @return The selected item's handleor @c NULL, if none is
9493     * selected at the moment (and on errors)
9494     *
9495     * This returns the selected item in @p obj. If multi selection is
9496     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9497     * the first item in the list is selected, which might not be very
9498     * useful. For that case, see elm_gengrid_selected_items_get().
9499     *
9500     * @ingroup Gengrid
9501     */
9502    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9503
9504    /**
9505     * Get <b>a list</b> of selected items in a given gengrid
9506     *
9507     * @param obj The gengrid object.
9508     * @return The list of selected items or @c NULL, if none is
9509     * selected at the moment (and on errors)
9510     *
9511     * This returns a list of the selected items, in the order that
9512     * they appear in the grid. This list is only valid as long as no
9513     * more items are selected or unselected (or unselected implictly
9514     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9515     * data, naturally.
9516     *
9517     * @see elm_gengrid_selected_item_get()
9518     *
9519     * @ingroup Gengrid
9520     */
9521    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9522
9523    /**
9524     * @}
9525     */
9526
9527    /**
9528     * @defgroup Clock Clock
9529     *
9530     * @image html img/widget/clock/preview-00.png
9531     * @image latex img/widget/clock/preview-00.eps
9532     *
9533     * This is a @b digital clock widget. In its default theme, it has a
9534     * vintage "flipping numbers clock" appearance, which will animate
9535     * sheets of individual algarisms individually as time goes by.
9536     *
9537     * A newly created clock will fetch system's time (already
9538     * considering local time adjustments) to start with, and will tick
9539     * accondingly. It may or may not show seconds.
9540     *
9541     * Clocks have an @b edition mode. When in it, the sheets will
9542     * display extra arrow indications on the top and bottom and the
9543     * user may click on them to raise or lower the time values. After
9544     * it's told to exit edition mode, it will keep ticking with that
9545     * new time set (it keeps the difference from local time).
9546     *
9547     * Also, when under edition mode, user clicks on the cited arrows
9548     * which are @b held for some time will make the clock to flip the
9549     * sheet, thus editing the time, continuosly and automatically for
9550     * the user. The interval between sheet flips will keep growing in
9551     * time, so that it helps the user to reach a time which is distant
9552     * from the one set.
9553     *
9554     * The time display is, by default, in military mode (24h), but an
9555     * am/pm indicator may be optionally shown, too, when it will
9556     * switch to 12h.
9557     *
9558     * Smart callbacks one can register to:
9559     * - "changed" - the clock's user changed the time
9560     *
9561     * Here is an example on its usage:
9562     * @li @ref clock_example
9563     */
9564
9565    /**
9566     * @addtogroup Clock
9567     * @{
9568     */
9569
9570    /**
9571     * Identifiers for which clock digits should be editable, when a
9572     * clock widget is in edition mode. Values may be ORed together to
9573     * make a mask, naturally.
9574     *
9575     * @see elm_clock_edit_set()
9576     * @see elm_clock_digit_edit_set()
9577     */
9578    typedef enum _Elm_Clock_Digedit
9579      {
9580         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9581         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9582         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9583         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9584         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9585         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9586         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9587         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9588      } Elm_Clock_Digedit;
9589
9590    /**
9591     * Add a new clock widget to the given parent Elementary
9592     * (container) object
9593     *
9594     * @param parent The parent object
9595     * @return a new clock widget handle or @c NULL, on errors
9596     *
9597     * This function inserts a new clock widget on the canvas.
9598     *
9599     * @ingroup Clock
9600     */
9601    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9602
9603    /**
9604     * Set a clock widget's time, programmatically
9605     *
9606     * @param obj The clock widget object
9607     * @param hrs The hours to set
9608     * @param min The minutes to set
9609     * @param sec The secondes to set
9610     *
9611     * This function updates the time that is showed by the clock
9612     * widget.
9613     *
9614     *  Values @b must be set within the following ranges:
9615     * - 0 - 23, for hours
9616     * - 0 - 59, for minutes
9617     * - 0 - 59, for seconds,
9618     *
9619     * even if the clock is not in "military" mode.
9620     *
9621     * @warning The behavior for values set out of those ranges is @b
9622     * undefined.
9623     *
9624     * @ingroup Clock
9625     */
9626    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9627
9628    /**
9629     * Get a clock widget's time values
9630     *
9631     * @param obj The clock object
9632     * @param[out] hrs Pointer to the variable to get the hours value
9633     * @param[out] min Pointer to the variable to get the minutes value
9634     * @param[out] sec Pointer to the variable to get the seconds value
9635     *
9636     * This function gets the time set for @p obj, returning
9637     * it on the variables passed as the arguments to function
9638     *
9639     * @note Use @c NULL pointers on the time values you're not
9640     * interested in: they'll be ignored by the function.
9641     *
9642     * @ingroup Clock
9643     */
9644    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9645
9646    /**
9647     * Set whether a given clock widget is under <b>edition mode</b> or
9648     * under (default) displaying-only mode.
9649     *
9650     * @param obj The clock object
9651     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9652     * put it back to "displaying only" mode
9653     *
9654     * This function makes a clock's time to be editable or not <b>by
9655     * user interaction</b>. When in edition mode, clocks @b stop
9656     * ticking, until one brings them back to canonical mode. The
9657     * elm_clock_digit_edit_set() function will influence which digits
9658     * of the clock will be editable. By default, all of them will be
9659     * (#ELM_CLOCK_NONE).
9660     *
9661     * @note am/pm sheets, if being shown, will @b always be editable
9662     * under edition mode.
9663     *
9664     * @see elm_clock_edit_get()
9665     *
9666     * @ingroup Clock
9667     */
9668    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9669
9670    /**
9671     * Retrieve whether a given clock widget is under <b>edition
9672     * mode</b> or under (default) displaying-only mode.
9673     *
9674     * @param obj The clock object
9675     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9676     * otherwise
9677     *
9678     * This function retrieves whether the clock's time can be edited
9679     * or not by user interaction.
9680     *
9681     * @see elm_clock_edit_set() for more details
9682     *
9683     * @ingroup Clock
9684     */
9685    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9686
9687    /**
9688     * Set what digits of the given clock widget should be editable
9689     * when in edition mode.
9690     *
9691     * @param obj The clock object
9692     * @param digedit Bit mask indicating the digits to be editable
9693     * (values in #Elm_Clock_Digedit).
9694     *
9695     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9696     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9697     * EINA_FALSE).
9698     *
9699     * @see elm_clock_digit_edit_get()
9700     *
9701     * @ingroup Clock
9702     */
9703    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9704
9705    /**
9706     * Retrieve what digits of the given clock widget should be
9707     * editable when in edition mode.
9708     *
9709     * @param obj The clock object
9710     * @return Bit mask indicating the digits to be editable
9711     * (values in #Elm_Clock_Digedit).
9712     *
9713     * @see elm_clock_digit_edit_set() for more details
9714     *
9715     * @ingroup Clock
9716     */
9717    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9718
9719    /**
9720     * Set if the given clock widget must show hours in military or
9721     * am/pm mode
9722     *
9723     * @param obj The clock object
9724     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9725     * to military mode
9726     *
9727     * This function sets if the clock must show hours in military or
9728     * am/pm mode. In some countries like Brazil the military mode
9729     * (00-24h-format) is used, in opposition to the USA, where the
9730     * am/pm mode is more commonly used.
9731     *
9732     * @see elm_clock_show_am_pm_get()
9733     *
9734     * @ingroup Clock
9735     */
9736    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9737
9738    /**
9739     * Get if the given clock widget shows hours in military or am/pm
9740     * mode
9741     *
9742     * @param obj The clock object
9743     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9744     * military
9745     *
9746     * This function gets if the clock shows hours in military or am/pm
9747     * mode.
9748     *
9749     * @see elm_clock_show_am_pm_set() for more details
9750     *
9751     * @ingroup Clock
9752     */
9753    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9754
9755    /**
9756     * Set if the given clock widget must show time with seconds or not
9757     *
9758     * @param obj The clock object
9759     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9760     *
9761     * This function sets if the given clock must show or not elapsed
9762     * seconds. By default, they are @b not shown.
9763     *
9764     * @see elm_clock_show_seconds_get()
9765     *
9766     * @ingroup Clock
9767     */
9768    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9769
9770    /**
9771     * Get whether the given clock widget is showing time with seconds
9772     * or not
9773     *
9774     * @param obj The clock object
9775     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9776     *
9777     * This function gets whether @p obj is showing or not the elapsed
9778     * seconds.
9779     *
9780     * @see elm_clock_show_seconds_set()
9781     *
9782     * @ingroup Clock
9783     */
9784    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9785
9786    /**
9787     * Set the interval on time updates for an user mouse button hold
9788     * on clock widgets' time edition.
9789     *
9790     * @param obj The clock object
9791     * @param interval The (first) interval value in seconds
9792     *
9793     * This interval value is @b decreased while the user holds the
9794     * mouse pointer either incrementing or decrementing a given the
9795     * clock digit's value.
9796     *
9797     * This helps the user to get to a given time distant from the
9798     * current one easier/faster, as it will start to flip quicker and
9799     * quicker on mouse button holds.
9800     *
9801     * The calculation for the next flip interval value, starting from
9802     * the one set with this call, is the previous interval divided by
9803     * 1.05, so it decreases a little bit.
9804     *
9805     * The default starting interval value for automatic flips is
9806     * @b 0.85 seconds.
9807     *
9808     * @see elm_clock_interval_get()
9809     *
9810     * @ingroup Clock
9811     */
9812    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9813
9814    /**
9815     * Get the interval on time updates for an user mouse button hold
9816     * on clock widgets' time edition.
9817     *
9818     * @param obj The clock object
9819     * @return The (first) interval value, in seconds, set on it
9820     *
9821     * @see elm_clock_interval_set() for more details
9822     *
9823     * @ingroup Clock
9824     */
9825    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9826
9827    /**
9828     * @}
9829     */
9830
9831    /**
9832     * @defgroup Layout Layout
9833     *
9834     * @image html img/widget/layout/preview-00.png
9835     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9836     *
9837     * @image html img/layout-predefined.png
9838     * @image latex img/layout-predefined.eps width=\textwidth
9839     *
9840     * This is a container widget that takes a standard Edje design file and
9841     * wraps it very thinly in a widget.
9842     *
9843     * An Edje design (theme) file has a very wide range of possibilities to
9844     * describe the behavior of elements added to the Layout. Check out the Edje
9845     * documentation and the EDC reference to get more information about what can
9846     * be done with Edje.
9847     *
9848     * Just like @ref List, @ref Box, and other container widgets, any
9849     * object added to the Layout will become its child, meaning that it will be
9850     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9851     *
9852     * The Layout widget can contain as many Contents, Boxes or Tables as
9853     * described in its theme file. For instance, objects can be added to
9854     * different Tables by specifying the respective Table part names. The same
9855     * is valid for Content and Box.
9856     *
9857     * The objects added as child of the Layout will behave as described in the
9858     * part description where they were added. There are 3 possible types of
9859     * parts where a child can be added:
9860     *
9861     * @section secContent Content (SWALLOW part)
9862     *
9863     * Only one object can be added to the @c SWALLOW part (but you still can
9864     * have many @c SWALLOW parts and one object on each of them). Use the @c
9865     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9866     * objects as content of the @c SWALLOW. After being set to this part, the 
9867     * object size, position, visibility, clipping and other description 
9868     * properties will be totally controled by the description of the given part 
9869     * (inside the Edje theme file).
9870     *
9871     * One can use @c evas_object_size_hint_* functions on the child to have some
9872     * kind of control over its behavior, but the resulting behavior will still
9873     * depend heavily on the @c SWALLOW part description.
9874     *
9875     * The Edje theme also can change the part description, based on signals or
9876     * scripts running inside the theme. This change can also be animated. All of
9877     * this will affect the child object set as content accordingly. The object
9878     * size will be changed if the part size is changed, it will animate move if
9879     * the part is moving, and so on.
9880     *
9881     * The following picture demonstrates a Layout widget with a child object
9882     * added to its @c SWALLOW:
9883     *
9884     * @image html layout_swallow.png
9885     * @image latex layout_swallow.eps width=\textwidth
9886     *
9887     * @section secBox Box (BOX part)
9888     *
9889     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9890     * allows one to add objects to the box and have them distributed along its
9891     * area, accordingly to the specified @a layout property (now by @a layout we
9892     * mean the chosen layouting design of the Box, not the Layout widget
9893     * itself).
9894     *
9895     * A similar effect for having a box with its position, size and other things
9896     * controled by the Layout theme would be to create an Elementary @ref Box
9897     * widget and add it as a Content in the @c SWALLOW part.
9898     *
9899     * The main difference of using the Layout Box is that its behavior, the box
9900     * properties like layouting format, padding, align, etc. will be all
9901     * controled by the theme. This means, for example, that a signal could be
9902     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9903     * handled the signal by changing the box padding, or align, or both. Using
9904     * the Elementary @ref Box widget is not necessarily harder or easier, it
9905     * just depends on the circunstances and requirements.
9906     *
9907     * The Layout Box can be used through the @c elm_layout_box_* set of
9908     * functions.
9909     *
9910     * The following picture demonstrates a Layout widget with many child objects
9911     * added to its @c BOX part:
9912     *
9913     * @image html layout_box.png
9914     * @image latex layout_box.eps width=\textwidth
9915     *
9916     * @section secTable Table (TABLE part)
9917     *
9918     * Just like the @ref secBox, the Layout Table is very similar to the
9919     * Elementary @ref Table widget. It allows one to add objects to the Table
9920     * specifying the row and column where the object should be added, and any
9921     * column or row span if necessary.
9922     *
9923     * Again, we could have this design by adding a @ref Table widget to the @c
9924     * SWALLOW part using elm_object_part_content_set(). The same difference happens
9925     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9926     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9927     *
9928     * The Layout Table can be used through the @c elm_layout_table_* set of
9929     * functions.
9930     *
9931     * The following picture demonstrates a Layout widget with many child objects
9932     * added to its @c TABLE part:
9933     *
9934     * @image html layout_table.png
9935     * @image latex layout_table.eps width=\textwidth
9936     *
9937     * @section secPredef Predefined Layouts
9938     *
9939     * Another interesting thing about the Layout widget is that it offers some
9940     * predefined themes that come with the default Elementary theme. These
9941     * themes can be set by the call elm_layout_theme_set(), and provide some
9942     * basic functionality depending on the theme used.
9943     *
9944     * Most of them already send some signals, some already provide a toolbar or
9945     * back and next buttons.
9946     *
9947     * These are available predefined theme layouts. All of them have class = @c
9948     * layout, group = @c application, and style = one of the following options:
9949     *
9950     * @li @c toolbar-content - application with toolbar and main content area
9951     * @li @c toolbar-content-back - application with toolbar and main content
9952     * area with a back button and title area
9953     * @li @c toolbar-content-back-next - application with toolbar and main
9954     * content area with a back and next buttons and title area
9955     * @li @c content-back - application with a main content area with a back
9956     * button and title area
9957     * @li @c content-back-next - application with a main content area with a
9958     * back and next buttons and title area
9959     * @li @c toolbar-vbox - application with toolbar and main content area as a
9960     * vertical box
9961     * @li @c toolbar-table - application with toolbar and main content area as a
9962     * table
9963     *
9964     * @section secExamples Examples
9965     *
9966     * Some examples of the Layout widget can be found here:
9967     * @li @ref layout_example_01
9968     * @li @ref layout_example_02
9969     * @li @ref layout_example_03
9970     * @li @ref layout_example_edc
9971     *
9972     */
9973
9974    /**
9975     * Add a new layout to the parent
9976     *
9977     * @param parent The parent object
9978     * @return The new object or NULL if it cannot be created
9979     *
9980     * @see elm_layout_file_set()
9981     * @see elm_layout_theme_set()
9982     *
9983     * @ingroup Layout
9984     */
9985    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9986    /**
9987     * Set the file that will be used as layout
9988     *
9989     * @param obj The layout object
9990     * @param file The path to file (edj) that will be used as layout
9991     * @param group The group that the layout belongs in edje file
9992     *
9993     * @return (1 = success, 0 = error)
9994     *
9995     * @ingroup Layout
9996     */
9997    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9998    /**
9999     * Set the edje group from the elementary theme that will be used as layout
10000     *
10001     * @param obj The layout object
10002     * @param clas the clas of the group
10003     * @param group the group
10004     * @param style the style to used
10005     *
10006     * @return (1 = success, 0 = error)
10007     *
10008     * @ingroup Layout
10009     */
10010    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10011    /**
10012     * Set the layout content.
10013     *
10014     * @param obj The layout object
10015     * @param swallow The swallow part name in the edje file
10016     * @param content The child that will be added in this layout object
10017     *
10018     * Once the content object is set, a previously set one will be deleted.
10019     * If you want to keep that old content object, use the
10020     * elm_object_part_content_unset() function.
10021     *
10022     * @note In an Edje theme, the part used as a content container is called @c
10023     * SWALLOW. This is why the parameter name is called @p swallow, but it is
10024     * expected to be a part name just like the second parameter of
10025     * elm_layout_box_append().
10026     *
10027     * @see elm_layout_box_append()
10028     * @see elm_object_part_content_get()
10029     * @see elm_object_part_content_unset()
10030     * @see @ref secBox
10031     * @deprecated use elm_object_part_content_set() instead
10032     *
10033     * @ingroup Layout
10034     */
10035    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10036    /**
10037     * Get the child object in the given content part.
10038     *
10039     * @param obj The layout object
10040     * @param swallow The SWALLOW part to get its content
10041     *
10042     * @return The swallowed object or NULL if none or an error occurred
10043     *
10044     * @deprecated use elm_object_part_content_get() instead
10045     *
10046     * @ingroup Layout
10047     */
10048    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10049    /**
10050     * Unset the layout content.
10051     *
10052     * @param obj The layout object
10053     * @param swallow The swallow part name in the edje file
10054     * @return The content that was being used
10055     *
10056     * Unparent and return the content object which was set for this part.
10057     *
10058     * @deprecated use elm_object_part_content_unset() instead
10059     *
10060     * @ingroup Layout
10061     */
10062    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10063    /**
10064     * Set the text of the given part
10065     *
10066     * @param obj The layout object
10067     * @param part The TEXT part where to set the text
10068     * @param text The text to set
10069     *
10070     * @ingroup Layout
10071     * @deprecated use elm_object_part_text_set() instead.
10072     */
10073    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10074    /**
10075     * Get the text set in the given part
10076     *
10077     * @param obj The layout object
10078     * @param part The TEXT part to retrieve the text off
10079     *
10080     * @return The text set in @p part
10081     *
10082     * @ingroup Layout
10083     * @deprecated use elm_object_part_text_get() instead.
10084     */
10085    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10086    /**
10087     * Append child to layout box part.
10088     *
10089     * @param obj the layout object
10090     * @param part the box part to which the object will be appended.
10091     * @param child the child object to append to box.
10092     *
10093     * Once the object is appended, it will become child of the layout. Its
10094     * lifetime will be bound to the layout, whenever the layout dies the child
10095     * will be deleted automatically. One should use elm_layout_box_remove() to
10096     * make this layout forget about the object.
10097     *
10098     * @see elm_layout_box_prepend()
10099     * @see elm_layout_box_insert_before()
10100     * @see elm_layout_box_insert_at()
10101     * @see elm_layout_box_remove()
10102     *
10103     * @ingroup Layout
10104     */
10105    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10106    /**
10107     * Prepend child to layout box part.
10108     *
10109     * @param obj the layout object
10110     * @param part the box part to prepend.
10111     * @param child the child object to prepend to box.
10112     *
10113     * Once the object is prepended, it will become child of the layout. Its
10114     * lifetime will be bound to the layout, whenever the layout dies the child
10115     * will be deleted automatically. One should use elm_layout_box_remove() to
10116     * make this layout forget about the object.
10117     *
10118     * @see elm_layout_box_append()
10119     * @see elm_layout_box_insert_before()
10120     * @see elm_layout_box_insert_at()
10121     * @see elm_layout_box_remove()
10122     *
10123     * @ingroup Layout
10124     */
10125    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10126    /**
10127     * Insert child to layout box part before a reference object.
10128     *
10129     * @param obj the layout object
10130     * @param part the box part to insert.
10131     * @param child the child object to insert into box.
10132     * @param reference another reference object to insert before in box.
10133     *
10134     * Once the object is inserted, it will become child of the layout. Its
10135     * lifetime will be bound to the layout, whenever the layout dies the child
10136     * will be deleted automatically. One should use elm_layout_box_remove() to
10137     * make this layout forget about the object.
10138     *
10139     * @see elm_layout_box_append()
10140     * @see elm_layout_box_prepend()
10141     * @see elm_layout_box_insert_before()
10142     * @see elm_layout_box_remove()
10143     *
10144     * @ingroup Layout
10145     */
10146    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10147    /**
10148     * Insert child to layout box part at a given position.
10149     *
10150     * @param obj the layout object
10151     * @param part the box part to insert.
10152     * @param child the child object to insert into box.
10153     * @param pos the numeric position >=0 to insert the child.
10154     *
10155     * Once the object is inserted, it will become child of the layout. Its
10156     * lifetime will be bound to the layout, whenever the layout dies the child
10157     * will be deleted automatically. One should use elm_layout_box_remove() to
10158     * make this layout forget about the object.
10159     *
10160     * @see elm_layout_box_append()
10161     * @see elm_layout_box_prepend()
10162     * @see elm_layout_box_insert_before()
10163     * @see elm_layout_box_remove()
10164     *
10165     * @ingroup Layout
10166     */
10167    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10168    /**
10169     * Remove a child of the given part box.
10170     *
10171     * @param obj The layout object
10172     * @param part The box part name to remove child.
10173     * @param child The object to remove from box.
10174     * @return The object that was being used, or NULL if not found.
10175     *
10176     * The object will be removed from the box part and its lifetime will
10177     * not be handled by the layout anymore. This is equivalent to
10178     * elm_object_part_content_unset() for box.
10179     *
10180     * @see elm_layout_box_append()
10181     * @see elm_layout_box_remove_all()
10182     *
10183     * @ingroup Layout
10184     */
10185    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10186    /**
10187     * Remove all child of the given part box.
10188     *
10189     * @param obj The layout object
10190     * @param part The box part name to remove child.
10191     * @param clear If EINA_TRUE, then all objects will be deleted as
10192     *        well, otherwise they will just be removed and will be
10193     *        dangling on the canvas.
10194     *
10195     * The objects will be removed from the box part and their lifetime will
10196     * not be handled by the layout anymore. This is equivalent to
10197     * elm_layout_box_remove() for all box children.
10198     *
10199     * @see elm_layout_box_append()
10200     * @see elm_layout_box_remove()
10201     *
10202     * @ingroup Layout
10203     */
10204    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10205    /**
10206     * Insert child to layout table part.
10207     *
10208     * @param obj the layout object
10209     * @param part the box part to pack child.
10210     * @param child_obj the child object to pack into table.
10211     * @param col the column to which the child should be added. (>= 0)
10212     * @param row the row to which the child should be added. (>= 0)
10213     * @param colspan how many columns should be used to store this object. (>=
10214     *        1)
10215     * @param rowspan how many rows should be used to store this object. (>= 1)
10216     *
10217     * Once the object is inserted, it will become child of the table. Its
10218     * lifetime will be bound to the layout, and whenever the layout dies the
10219     * child will be deleted automatically. One should use
10220     * elm_layout_table_remove() to make this layout forget about the object.
10221     *
10222     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10223     * more space than a single cell. For instance, the following code:
10224     * @code
10225     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10226     * @endcode
10227     *
10228     * Would result in an object being added like the following picture:
10229     *
10230     * @image html layout_colspan.png
10231     * @image latex layout_colspan.eps width=\textwidth
10232     *
10233     * @see elm_layout_table_unpack()
10234     * @see elm_layout_table_clear()
10235     *
10236     * @ingroup Layout
10237     */
10238    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);
10239    /**
10240     * Unpack (remove) a child of the given part table.
10241     *
10242     * @param obj The layout object
10243     * @param part The table part name to remove child.
10244     * @param child_obj The object to remove from table.
10245     * @return The object that was being used, or NULL if not found.
10246     *
10247     * The object will be unpacked from the table part and its lifetime
10248     * will not be handled by the layout anymore. This is equivalent to
10249     * elm_object_part_content_unset() for table.
10250     *
10251     * @see elm_layout_table_pack()
10252     * @see elm_layout_table_clear()
10253     *
10254     * @ingroup Layout
10255     */
10256    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10257    /**
10258     * Remove all child of the given part table.
10259     *
10260     * @param obj The layout object
10261     * @param part The table part name to remove child.
10262     * @param clear If EINA_TRUE, then all objects will be deleted as
10263     *        well, otherwise they will just be removed and will be
10264     *        dangling on the canvas.
10265     *
10266     * The objects will be removed from the table part and their lifetime will
10267     * not be handled by the layout anymore. This is equivalent to
10268     * elm_layout_table_unpack() for all table children.
10269     *
10270     * @see elm_layout_table_pack()
10271     * @see elm_layout_table_unpack()
10272     *
10273     * @ingroup Layout
10274     */
10275    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10276    /**
10277     * Get the edje layout
10278     *
10279     * @param obj The layout object
10280     *
10281     * @return A Evas_Object with the edje layout settings loaded
10282     * with function elm_layout_file_set
10283     *
10284     * This returns the edje object. It is not expected to be used to then
10285     * swallow objects via edje_object_part_swallow() for example. Use
10286     * elm_object_part_content_set() instead so child object handling and sizing is
10287     * done properly.
10288     *
10289     * @note This function should only be used if you really need to call some
10290     * low level Edje function on this edje object. All the common stuff (setting
10291     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10292     * with proper elementary functions.
10293     *
10294     * @see elm_object_signal_callback_add()
10295     * @see elm_object_signal_emit()
10296     * @see elm_object_part_text_set()
10297     * @see elm_object_part_content_set()
10298     * @see elm_layout_box_append()
10299     * @see elm_layout_table_pack()
10300     * @see elm_layout_data_get()
10301     *
10302     * @ingroup Layout
10303     */
10304    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10305    /**
10306     * Get the edje data from the given layout
10307     *
10308     * @param obj The layout object
10309     * @param key The data key
10310     *
10311     * @return The edje data string
10312     *
10313     * This function fetches data specified inside the edje theme of this layout.
10314     * This function return NULL if data is not found.
10315     *
10316     * In EDC this comes from a data block within the group block that @p
10317     * obj was loaded from. E.g.
10318     *
10319     * @code
10320     * collections {
10321     *   group {
10322     *     name: "a_group";
10323     *     data {
10324     *       item: "key1" "value1";
10325     *       item: "key2" "value2";
10326     *     }
10327     *   }
10328     * }
10329     * @endcode
10330     *
10331     * @ingroup Layout
10332     */
10333    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10334    /**
10335     * Eval sizing
10336     *
10337     * @param obj The layout object
10338     *
10339     * Manually forces a sizing re-evaluation. This is useful when the minimum
10340     * size required by the edje theme of this layout has changed. The change on
10341     * the minimum size required by the edje theme is not immediately reported to
10342     * the elementary layout, so one needs to call this function in order to tell
10343     * the widget (layout) that it needs to reevaluate its own size.
10344     *
10345     * The minimum size of the theme is calculated based on minimum size of
10346     * parts, the size of elements inside containers like box and table, etc. All
10347     * of this can change due to state changes, and that's when this function
10348     * should be called.
10349     *
10350     * Also note that a standard signal of "size,eval" "elm" emitted from the
10351     * edje object will cause this to happen too.
10352     *
10353     * @ingroup Layout
10354     */
10355    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10356
10357    /**
10358     * Sets a specific cursor for an edje part.
10359     *
10360     * @param obj The layout object.
10361     * @param part_name a part from loaded edje group.
10362     * @param cursor cursor name to use, see Elementary_Cursor.h
10363     *
10364     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10365     *         part not exists or it has "mouse_events: 0".
10366     *
10367     * @ingroup Layout
10368     */
10369    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10370
10371    /**
10372     * Get the cursor to be shown when mouse is over an edje part
10373     *
10374     * @param obj The layout object.
10375     * @param part_name a part from loaded edje group.
10376     * @return the cursor name.
10377     *
10378     * @ingroup Layout
10379     */
10380    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10381
10382    /**
10383     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10384     *
10385     * @param obj The layout object.
10386     * @param part_name a part from loaded edje group, that had a cursor set
10387     *        with elm_layout_part_cursor_set().
10388     *
10389     * @ingroup Layout
10390     */
10391    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10392
10393    /**
10394     * Sets a specific cursor style for an edje part.
10395     *
10396     * @param obj The layout object.
10397     * @param part_name a part from loaded edje group.
10398     * @param style the theme style to use (default, transparent, ...)
10399     *
10400     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10401     *         part not exists or it did not had a cursor set.
10402     *
10403     * @ingroup Layout
10404     */
10405    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10406
10407    /**
10408     * Gets a specific cursor style for an edje part.
10409     *
10410     * @param obj The layout object.
10411     * @param part_name a part from loaded edje group.
10412     *
10413     * @return the theme style in use, defaults to "default". If the
10414     *         object does not have a cursor set, then NULL is returned.
10415     *
10416     * @ingroup Layout
10417     */
10418    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10419
10420    /**
10421     * Sets if the cursor set should be searched on the theme or should use
10422     * the provided by the engine, only.
10423     *
10424     * @note before you set if should look on theme you should define a
10425     * cursor with elm_layout_part_cursor_set(). By default it will only
10426     * look for cursors provided by the engine.
10427     *
10428     * @param obj The layout object.
10429     * @param part_name a part from loaded edje group.
10430     * @param engine_only if cursors should be just provided by the engine
10431     *        or should also search on widget's theme as well
10432     *
10433     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10434     *         part not exists or it did not had a cursor set.
10435     *
10436     * @ingroup Layout
10437     */
10438    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);
10439
10440    /**
10441     * Gets a specific cursor engine_only for an edje part.
10442     *
10443     * @param obj The layout object.
10444     * @param part_name a part from loaded edje group.
10445     *
10446     * @return whenever the cursor is just provided by engine or also from theme.
10447     *
10448     * @ingroup Layout
10449     */
10450    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10451
10452 /**
10453  * @def elm_layout_icon_set
10454  * Convienience macro to set the icon object in a layout that follows the
10455  * Elementary naming convention for its parts.
10456  *
10457  * @ingroup Layout
10458  */
10459 #define elm_layout_icon_set(_ly, _obj) \
10460   do { \
10461     const char *sig; \
10462     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10463     if ((_obj)) sig = "elm,state,icon,visible"; \
10464     else sig = "elm,state,icon,hidden"; \
10465     elm_object_signal_emit((_ly), sig, "elm"); \
10466   } while (0)
10467
10468 /**
10469  * @def elm_layout_icon_get
10470  * Convienience macro to get the icon object from a layout that follows the
10471  * Elementary naming convention for its parts.
10472  *
10473  * @ingroup Layout
10474  */
10475 #define elm_layout_icon_get(_ly) \
10476   elm_object_part_content_get((_ly), "elm.swallow.icon")
10477
10478 /**
10479  * @def elm_layout_end_set
10480  * Convienience macro to set the end object in a layout that follows the
10481  * Elementary naming convention for its parts.
10482  *
10483  * @ingroup Layout
10484  */
10485 #define elm_layout_end_set(_ly, _obj) \
10486   do { \
10487     const char *sig; \
10488     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10489     if ((_obj)) sig = "elm,state,end,visible"; \
10490     else sig = "elm,state,end,hidden"; \
10491     elm_object_signal_emit((_ly), sig, "elm"); \
10492   } while (0)
10493
10494 /**
10495  * @def elm_layout_end_get
10496  * Convienience macro to get the end object in a layout that follows the
10497  * Elementary naming convention for its parts.
10498  *
10499  * @ingroup Layout
10500  */
10501 #define elm_layout_end_get(_ly) \
10502   elm_object_part_content_get((_ly), "elm.swallow.end")
10503
10504 /**
10505  * @def elm_layout_label_set
10506  * Convienience macro to set the label in a layout that follows the
10507  * Elementary naming convention for its parts.
10508  *
10509  * @ingroup Layout
10510  * @deprecated use elm_object_text_set() instead.
10511  */
10512 #define elm_layout_label_set(_ly, _txt) \
10513   elm_layout_text_set((_ly), "elm.text", (_txt))
10514
10515 /**
10516  * @def elm_layout_label_get
10517  * Convenience macro to get the label in a layout that follows the
10518  * Elementary naming convention for its parts.
10519  *
10520  * @ingroup Layout
10521  * @deprecated use elm_object_text_set() instead.
10522  */
10523 #define elm_layout_label_get(_ly) \
10524   elm_layout_text_get((_ly), "elm.text")
10525
10526    /* smart callbacks called:
10527     * "theme,changed" - when elm theme is changed.
10528     */
10529
10530    /**
10531     * @defgroup Notify Notify
10532     *
10533     * @image html img/widget/notify/preview-00.png
10534     * @image latex img/widget/notify/preview-00.eps
10535     *
10536     * Display a container in a particular region of the parent(top, bottom,
10537     * etc).  A timeout can be set to automatically hide the notify. This is so
10538     * that, after an evas_object_show() on a notify object, if a timeout was set
10539     * on it, it will @b automatically get hidden after that time.
10540     *
10541     * Signals that you can add callbacks for are:
10542     * @li "timeout" - when timeout happens on notify and it's hidden
10543     * @li "block,clicked" - when a click outside of the notify happens
10544     *
10545     * Default contents parts of the notify widget that you can use for are:
10546     * @li "default" - A content of the notify
10547     *
10548     * @ref tutorial_notify show usage of the API.
10549     *
10550     * @{
10551     */
10552    /**
10553     * @brief Possible orient values for notify.
10554     *
10555     * This values should be used in conjunction to elm_notify_orient_set() to
10556     * set the position in which the notify should appear(relative to its parent)
10557     * and in conjunction with elm_notify_orient_get() to know where the notify
10558     * is appearing.
10559     */
10560    typedef enum _Elm_Notify_Orient
10561      {
10562         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10563         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10564         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10565         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10566         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10567         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10568         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10569         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10570         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10571         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10572      } Elm_Notify_Orient;
10573    /**
10574     * @brief Add a new notify to the parent
10575     *
10576     * @param parent The parent object
10577     * @return The new object or NULL if it cannot be created
10578     */
10579    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10580    /**
10581     * @brief Set the content of the notify widget
10582     *
10583     * @param obj The notify object
10584     * @param content The content will be filled in this notify object
10585     *
10586     * Once the content object is set, a previously set one will be deleted. If
10587     * you want to keep that old content object, use the
10588     * elm_notify_content_unset() function.
10589     *
10590     * @deprecated use elm_object_content_set() instead
10591     *
10592     */
10593    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10594    /**
10595     * @brief Unset the content of the notify widget
10596     *
10597     * @param obj The notify object
10598     * @return The content that was being used
10599     *
10600     * Unparent and return the content object which was set for this widget
10601     *
10602     * @see elm_notify_content_set()
10603     * @deprecated use elm_object_content_unset() instead
10604     *
10605     */
10606    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10607    /**
10608     * @brief Return the content of the notify widget
10609     *
10610     * @param obj The notify object
10611     * @return The content that is being used
10612     *
10613     * @see elm_notify_content_set()
10614     * @deprecated use elm_object_content_get() instead
10615     *
10616     */
10617    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10618    /**
10619     * @brief Set the notify parent
10620     *
10621     * @param obj The notify object
10622     * @param content The new parent
10623     *
10624     * Once the parent object is set, a previously set one will be disconnected
10625     * and replaced.
10626     */
10627    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10628    /**
10629     * @brief Get the notify parent
10630     *
10631     * @param obj The notify object
10632     * @return The parent
10633     *
10634     * @see elm_notify_parent_set()
10635     */
10636    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10637    /**
10638     * @brief Set the orientation
10639     *
10640     * @param obj The notify object
10641     * @param orient The new orientation
10642     *
10643     * Sets the position in which the notify will appear in its parent.
10644     *
10645     * @see @ref Elm_Notify_Orient for possible values.
10646     */
10647    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10648    /**
10649     * @brief Return the orientation
10650     * @param obj The notify object
10651     * @return The orientation of the notification
10652     *
10653     * @see elm_notify_orient_set()
10654     * @see Elm_Notify_Orient
10655     */
10656    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10657    /**
10658     * @brief Set the time interval after which the notify window is going to be
10659     * hidden.
10660     *
10661     * @param obj The notify object
10662     * @param time The timeout in seconds
10663     *
10664     * This function sets a timeout and starts the timer controlling when the
10665     * notify is hidden. Since calling evas_object_show() on a notify restarts
10666     * the timer controlling when the notify is hidden, setting this before the
10667     * notify is shown will in effect mean starting the timer when the notify is
10668     * shown.
10669     *
10670     * @note Set a value <= 0.0 to disable a running timer.
10671     *
10672     * @note If the value > 0.0 and the notify is previously visible, the
10673     * timer will be started with this value, canceling any running timer.
10674     */
10675    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10676    /**
10677     * @brief Return the timeout value (in seconds)
10678     * @param obj the notify object
10679     *
10680     * @see elm_notify_timeout_set()
10681     */
10682    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10683    /**
10684     * @brief Sets whether events should be passed to by a click outside
10685     * its area.
10686     *
10687     * @param obj The notify object
10688     * @param repeats EINA_TRUE Events are repeats, else no
10689     *
10690     * When true if the user clicks outside the window the events will be caught
10691     * by the others widgets, else the events are blocked.
10692     *
10693     * @note The default value is EINA_TRUE.
10694     */
10695    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10696    /**
10697     * @brief Return true if events are repeat below the notify object
10698     * @param obj the notify object
10699     *
10700     * @see elm_notify_repeat_events_set()
10701     */
10702    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10703    /**
10704     * @}
10705     */
10706
10707    /**
10708     * @defgroup Hover Hover
10709     *
10710     * @image html img/widget/hover/preview-00.png
10711     * @image latex img/widget/hover/preview-00.eps
10712     *
10713     * A Hover object will hover over its @p parent object at the @p target
10714     * location. Anything in the background will be given a darker coloring to
10715     * indicate that the hover object is on top (at the default theme). When the
10716     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10717     * clicked that @b doesn't cause the hover to be dismissed.
10718     *
10719     * A Hover object has two parents. One parent that owns it during creation
10720     * and the other parent being the one over which the hover object spans.
10721     *
10722     *
10723     * @note The hover object will take up the entire space of @p target
10724     * object.
10725     *
10726     * Elementary has the following styles for the hover widget:
10727     * @li default
10728     * @li popout
10729     * @li menu
10730     * @li hoversel_vertical
10731     *
10732     * The following are the available position for content:
10733     * @li left
10734     * @li top-left
10735     * @li top
10736     * @li top-right
10737     * @li right
10738     * @li bottom-right
10739     * @li bottom
10740     * @li bottom-left
10741     * @li middle
10742     * @li smart
10743     *
10744     * Signals that you can add callbacks for are:
10745     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10746     * @li "smart,changed" - a content object placed under the "smart"
10747     *                   policy was replaced to a new slot direction.
10748     *
10749     * See @ref tutorial_hover for more information.
10750     *
10751     * @{
10752     */
10753    typedef enum _Elm_Hover_Axis
10754      {
10755         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10756         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10757         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10758         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10759      } Elm_Hover_Axis;
10760    /**
10761     * @brief Adds a hover object to @p parent
10762     *
10763     * @param parent The parent object
10764     * @return The hover object or NULL if one could not be created
10765     */
10766    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10767    /**
10768     * @brief Sets the target object for the hover.
10769     *
10770     * @param obj The hover object
10771     * @param target The object to center the hover onto. The hover
10772     *
10773     * This function will cause the hover to be centered on the target object.
10774     */
10775    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10776    /**
10777     * @brief Gets the target object for the hover.
10778     *
10779     * @param obj The hover object
10780     * @param parent The object to locate the hover over.
10781     *
10782     * @see elm_hover_target_set()
10783     */
10784    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10785    /**
10786     * @brief Sets the parent object for the hover.
10787     *
10788     * @param obj The hover object
10789     * @param parent The object to locate the hover over.
10790     *
10791     * This function will cause the hover to take up the entire space that the
10792     * parent object fills.
10793     */
10794    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10795    /**
10796     * @brief Gets the parent object for the hover.
10797     *
10798     * @param obj The hover object
10799     * @return The parent object to locate the hover over.
10800     *
10801     * @see elm_hover_parent_set()
10802     */
10803    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10804    /**
10805     * @brief Sets the content of the hover object and the direction in which it
10806     * will pop out.
10807     *
10808     * @param obj The hover object
10809     * @param swallow The direction that the object will be displayed
10810     * at. Accepted values are "left", "top-left", "top", "top-right",
10811     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10812     * "smart".
10813     * @param content The content to place at @p swallow
10814     *
10815     * Once the content object is set for a given direction, a previously
10816     * set one (on the same direction) will be deleted. If you want to
10817     * keep that old content object, use the elm_hover_content_unset()
10818     * function.
10819     *
10820     * All directions may have contents at the same time, except for
10821     * "smart". This is a special placement hint and its use case
10822     * independs of the calculations coming from
10823     * elm_hover_best_content_location_get(). Its use is for cases when
10824     * one desires only one hover content, but with a dinamic special
10825     * placement within the hover area. The content's geometry, whenever
10826     * it changes, will be used to decide on a best location not
10827     * extrapolating the hover's parent object view to show it in (still
10828     * being the hover's target determinant of its medium part -- move and
10829     * resize it to simulate finger sizes, for example). If one of the
10830     * directions other than "smart" are used, a previously content set
10831     * using it will be deleted, and vice-versa.
10832     */
10833    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10834    /**
10835     * @brief Get the content of the hover object, in a given direction.
10836     *
10837     * Return the content object which was set for this widget in the
10838     * @p swallow direction.
10839     *
10840     * @param obj The hover object
10841     * @param swallow The direction that the object was display at.
10842     * @return The content that was being used
10843     *
10844     * @see elm_hover_content_set()
10845     */
10846    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10847    /**
10848     * @brief Unset the content of the hover object, in a given direction.
10849     *
10850     * Unparent and return the content object set at @p swallow direction.
10851     *
10852     * @param obj The hover object
10853     * @param swallow The direction that the object was display at.
10854     * @return The content that was being used.
10855     *
10856     * @see elm_hover_content_set()
10857     */
10858    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10859    /**
10860     * @brief Returns the best swallow location for content in the hover.
10861     *
10862     * @param obj The hover object
10863     * @param pref_axis The preferred orientation axis for the hover object to use
10864     * @return The edje location to place content into the hover or @c
10865     *         NULL, on errors.
10866     *
10867     * Best is defined here as the location at which there is the most available
10868     * space.
10869     *
10870     * @p pref_axis may be one of
10871     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10872     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10873     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10874     * - @c ELM_HOVER_AXIS_BOTH -- both
10875     *
10876     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10877     * nescessarily be along the horizontal axis("left" or "right"). If
10878     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10879     * be along the vertical axis("top" or "bottom"). Chossing
10880     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10881     * returned position may be in either axis.
10882     *
10883     * @see elm_hover_content_set()
10884     */
10885    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10886    /**
10887     * @}
10888     */
10889
10890    /* entry */
10891    /**
10892     * @defgroup Entry Entry
10893     *
10894     * @image html img/widget/entry/preview-00.png
10895     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10896     * @image html img/widget/entry/preview-01.png
10897     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10898     * @image html img/widget/entry/preview-02.png
10899     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10900     * @image html img/widget/entry/preview-03.png
10901     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10902     *
10903     * An entry is a convenience widget which shows a box that the user can
10904     * enter text into. Entries by default don't scroll, so they grow to
10905     * accomodate the entire text, resizing the parent window as needed. This
10906     * can be changed with the elm_entry_scrollable_set() function.
10907     *
10908     * They can also be single line or multi line (the default) and when set
10909     * to multi line mode they support text wrapping in any of the modes
10910     * indicated by #Elm_Wrap_Type.
10911     *
10912     * Other features include password mode, filtering of inserted text with
10913     * elm_entry_text_filter_append() and related functions, inline "items" and
10914     * formatted markup text.
10915     *
10916     * @section entry-markup Formatted text
10917     *
10918     * The markup tags supported by the Entry are defined by the theme, but
10919     * even when writing new themes or extensions it's a good idea to stick to
10920     * a sane default, to maintain coherency and avoid application breakages.
10921     * Currently defined by the default theme are the following tags:
10922     * @li \<br\>: Inserts a line break.
10923     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10924     * breaks.
10925     * @li \<tab\>: Inserts a tab.
10926     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10927     * enclosed text.
10928     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10929     * @li \<link\>...\</link\>: Underlines the enclosed text.
10930     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10931     *
10932     * @section entry-special Special markups
10933     *
10934     * Besides those used to format text, entries support two special markup
10935     * tags used to insert clickable portions of text or items inlined within
10936     * the text.
10937     *
10938     * @subsection entry-anchors Anchors
10939     *
10940     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10941     * \</a\> tags and an event will be generated when this text is clicked,
10942     * like this:
10943     *
10944     * @code
10945     * This text is outside <a href=anc-01>but this one is an anchor</a>
10946     * @endcode
10947     *
10948     * The @c href attribute in the opening tag gives the name that will be
10949     * used to identify the anchor and it can be any valid utf8 string.
10950     *
10951     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10952     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10953     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10954     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10955     * an anchor.
10956     *
10957     * @subsection entry-items Items
10958     *
10959     * Inlined in the text, any other @c Evas_Object can be inserted by using
10960     * \<item\> tags this way:
10961     *
10962     * @code
10963     * <item size=16x16 vsize=full href=emoticon/haha></item>
10964     * @endcode
10965     *
10966     * Just like with anchors, the @c href identifies each item, but these need,
10967     * in addition, to indicate their size, which is done using any one of
10968     * @c size, @c absize or @c relsize attributes. These attributes take their
10969     * value in the WxH format, where W is the width and H the height of the
10970     * item.
10971     *
10972     * @li absize: Absolute pixel size for the item. Whatever value is set will
10973     * be the item's size regardless of any scale value the object may have
10974     * been set to. The final line height will be adjusted to fit larger items.
10975     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10976     * for the object.
10977     * @li relsize: Size is adjusted for the item to fit within the current
10978     * line height.
10979     *
10980     * Besides their size, items are specificed a @c vsize value that affects
10981     * how their final size and position are calculated. The possible values
10982     * are:
10983     * @li ascent: Item will be placed within the line's baseline and its
10984     * ascent. That is, the height between the line where all characters are
10985     * positioned and the highest point in the line. For @c size and @c absize
10986     * items, the descent value will be added to the total line height to make
10987     * them fit. @c relsize items will be adjusted to fit within this space.
10988     * @li full: Items will be placed between the descent and ascent, or the
10989     * lowest point in the line and its highest.
10990     *
10991     * The next image shows different configurations of items and how they
10992     * are the previously mentioned options affect their sizes. In all cases,
10993     * the green line indicates the ascent, blue for the baseline and red for
10994     * the descent.
10995     *
10996     * @image html entry_item.png
10997     * @image latex entry_item.eps width=\textwidth
10998     *
10999     * And another one to show how size differs from absize. In the first one,
11000     * the scale value is set to 1.0, while the second one is using one of 2.0.
11001     *
11002     * @image html entry_item_scale.png
11003     * @image latex entry_item_scale.eps width=\textwidth
11004     *
11005     * After the size for an item is calculated, the entry will request an
11006     * object to place in its space. For this, the functions set with
11007     * elm_entry_item_provider_append() and related functions will be called
11008     * in order until one of them returns a @c non-NULL value. If no providers
11009     * are available, or all of them return @c NULL, then the entry falls back
11010     * to one of the internal defaults, provided the name matches with one of
11011     * them.
11012     *
11013     * All of the following are currently supported:
11014     *
11015     * - emoticon/angry
11016     * - emoticon/angry-shout
11017     * - emoticon/crazy-laugh
11018     * - emoticon/evil-laugh
11019     * - emoticon/evil
11020     * - emoticon/goggle-smile
11021     * - emoticon/grumpy
11022     * - emoticon/grumpy-smile
11023     * - emoticon/guilty
11024     * - emoticon/guilty-smile
11025     * - emoticon/haha
11026     * - emoticon/half-smile
11027     * - emoticon/happy-panting
11028     * - emoticon/happy
11029     * - emoticon/indifferent
11030     * - emoticon/kiss
11031     * - emoticon/knowing-grin
11032     * - emoticon/laugh
11033     * - emoticon/little-bit-sorry
11034     * - emoticon/love-lots
11035     * - emoticon/love
11036     * - emoticon/minimal-smile
11037     * - emoticon/not-happy
11038     * - emoticon/not-impressed
11039     * - emoticon/omg
11040     * - emoticon/opensmile
11041     * - emoticon/smile
11042     * - emoticon/sorry
11043     * - emoticon/squint-laugh
11044     * - emoticon/surprised
11045     * - emoticon/suspicious
11046     * - emoticon/tongue-dangling
11047     * - emoticon/tongue-poke
11048     * - emoticon/uh
11049     * - emoticon/unhappy
11050     * - emoticon/very-sorry
11051     * - emoticon/what
11052     * - emoticon/wink
11053     * - emoticon/worried
11054     * - emoticon/wtf
11055     *
11056     * Alternatively, an item may reference an image by its path, using
11057     * the URI form @c file:///path/to/an/image.png and the entry will then
11058     * use that image for the item.
11059     *
11060     * @section entry-files Loading and saving files
11061     *
11062     * Entries have convinience functions to load text from a file and save
11063     * changes back to it after a short delay. The automatic saving is enabled
11064     * by default, but can be disabled with elm_entry_autosave_set() and files
11065     * can be loaded directly as plain text or have any markup in them
11066     * recognized. See elm_entry_file_set() for more details.
11067     *
11068     * @section entry-signals Emitted signals
11069     *
11070     * This widget emits the following signals:
11071     *
11072     * @li "changed": The text within the entry was changed.
11073     * @li "changed,user": The text within the entry was changed because of user interaction.
11074     * @li "activated": The enter key was pressed on a single line entry.
11075     * @li "press": A mouse button has been pressed on the entry.
11076     * @li "longpressed": A mouse button has been pressed and held for a couple
11077     * seconds.
11078     * @li "clicked": The entry has been clicked (mouse press and release).
11079     * @li "clicked,double": The entry has been double clicked.
11080     * @li "clicked,triple": The entry has been triple clicked.
11081     * @li "focused": The entry has received focus.
11082     * @li "unfocused": The entry has lost focus.
11083     * @li "selection,paste": A paste of the clipboard contents was requested.
11084     * @li "selection,copy": A copy of the selected text into the clipboard was
11085     * requested.
11086     * @li "selection,cut": A cut of the selected text into the clipboard was
11087     * requested.
11088     * @li "selection,start": A selection has begun and no previous selection
11089     * existed.
11090     * @li "selection,changed": The current selection has changed.
11091     * @li "selection,cleared": The current selection has been cleared.
11092     * @li "cursor,changed": The cursor has changed position.
11093     * @li "anchor,clicked": An anchor has been clicked. The event_info
11094     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11095     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11096     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11097     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11098     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11099     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11100     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11101     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11102     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11103     * @li "preedit,changed": The preedit string has changed.
11104     * @li "language,changed": Program language changed.
11105     *
11106     * @section entry-examples
11107     *
11108     * An overview of the Entry API can be seen in @ref entry_example_01
11109     *
11110     * @{
11111     */
11112    /**
11113     * @typedef Elm_Entry_Anchor_Info
11114     *
11115     * The info sent in the callback for the "anchor,clicked" signals emitted
11116     * by entries.
11117     */
11118    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11119    /**
11120     * @struct _Elm_Entry_Anchor_Info
11121     *
11122     * The info sent in the callback for the "anchor,clicked" signals emitted
11123     * by entries.
11124     */
11125    struct _Elm_Entry_Anchor_Info
11126      {
11127         const char *name; /**< The name of the anchor, as stated in its href */
11128         int         button; /**< The mouse button used to click on it */
11129         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11130                     y, /**< Anchor geometry, relative to canvas */
11131                     w, /**< Anchor geometry, relative to canvas */
11132                     h; /**< Anchor geometry, relative to canvas */
11133      };
11134    /**
11135     * @typedef Elm_Entry_Filter_Cb
11136     * This callback type is used by entry filters to modify text.
11137     * @param data The data specified as the last param when adding the filter
11138     * @param entry The entry object
11139     * @param text A pointer to the location of the text being filtered. This data can be modified,
11140     * but any additional allocations must be managed by the user.
11141     * @see elm_entry_text_filter_append
11142     * @see elm_entry_text_filter_prepend
11143     */
11144    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11145
11146    /**
11147     * @typedef Elm_Entry_Change_Info
11148     * This corresponds to Edje_Entry_Change_Info. Includes information about
11149     * a change in the entry.
11150     */
11151    typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11152
11153
11154    /**
11155     * This adds an entry to @p parent object.
11156     *
11157     * By default, entries are:
11158     * @li not scrolled
11159     * @li multi-line
11160     * @li word wrapped
11161     * @li autosave is enabled
11162     *
11163     * @param parent The parent object
11164     * @return The new object or NULL if it cannot be created
11165     */
11166    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11167    /**
11168     * Sets the entry to single line mode.
11169     *
11170     * In single line mode, entries don't ever wrap when the text reaches the
11171     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11172     * key will generate an @c "activate" event instead of adding a new line.
11173     *
11174     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11175     * and pressing enter will break the text into a different line
11176     * without generating any events.
11177     *
11178     * @param obj The entry object
11179     * @param single_line If true, the text in the entry
11180     * will be on a single line.
11181     */
11182    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11183    /**
11184     * Gets whether the entry is set to be single line.
11185     *
11186     * @param obj The entry object
11187     * @return single_line If true, the text in the entry is set to display
11188     * on a single line.
11189     *
11190     * @see elm_entry_single_line_set()
11191     */
11192    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11193    /**
11194     * Sets the entry to password mode.
11195     *
11196     * In password mode, entries are implicitly single line and the display of
11197     * any text in them is replaced with asterisks (*).
11198     *
11199     * @param obj The entry object
11200     * @param password If true, password mode is enabled.
11201     */
11202    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11203    /**
11204     * Gets whether the entry is set to password mode.
11205     *
11206     * @param obj The entry object
11207     * @return If true, the entry is set to display all characters
11208     * as asterisks (*).
11209     *
11210     * @see elm_entry_password_set()
11211     */
11212    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11213    /**
11214     * This sets the text displayed within the entry to @p entry.
11215     *
11216     * @param obj The entry object
11217     * @param entry The text to be displayed
11218     *
11219     * @deprecated Use elm_object_text_set() instead.
11220     * @note Using this function bypasses text filters
11221     */
11222    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11223    /**
11224     * This returns the text currently shown in object @p entry.
11225     * See also elm_entry_entry_set().
11226     *
11227     * @param obj The entry object
11228     * @return The currently displayed text or NULL on failure
11229     *
11230     * @deprecated Use elm_object_text_get() instead.
11231     */
11232    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11233    /**
11234     * Appends @p entry to the text of the entry.
11235     *
11236     * Adds the text in @p entry to the end of any text already present in the
11237     * widget.
11238     *
11239     * The appended text is subject to any filters set for the widget.
11240     *
11241     * @param obj The entry object
11242     * @param entry The text to be displayed
11243     *
11244     * @see elm_entry_text_filter_append()
11245     */
11246    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11247    /**
11248     * Gets whether the entry is empty.
11249     *
11250     * Empty means no text at all. If there are any markup tags, like an item
11251     * tag for which no provider finds anything, and no text is displayed, this
11252     * function still returns EINA_FALSE.
11253     *
11254     * @param obj The entry object
11255     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11256     */
11257    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11258    /**
11259     * Gets any selected text within the entry.
11260     *
11261     * If there's any selected text in the entry, this function returns it as
11262     * a string in markup format. NULL is returned if no selection exists or
11263     * if an error occurred.
11264     *
11265     * The returned value points to an internal string and should not be freed
11266     * or modified in any way. If the @p entry object is deleted or its
11267     * contents are changed, the returned pointer should be considered invalid.
11268     *
11269     * @param obj The entry object
11270     * @return The selected text within the entry or NULL on failure
11271     */
11272    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11273    /**
11274     * Returns the actual textblock object of the entry.
11275     *
11276     * This function exposes the internal textblock object that actually
11277     * contains and draws the text. This should be used for low-level
11278     * manipulations that are otherwise not possible.
11279     *
11280     * Changing the textblock directly from here will not notify edje/elm to
11281     * recalculate the textblock size automatically, so any modifications
11282     * done to the textblock returned by this function should be followed by
11283     * a call to elm_entry_calc_force().
11284     *
11285     * The return value is marked as const as an additional warning.
11286     * One should not use the returned object with any of the generic evas
11287     * functions (geometry_get/resize/move and etc), but only with the textblock
11288     * functions; The former will either not work at all, or break the correct
11289     * functionality.
11290     *
11291     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11292     * the internal textblock object. Do NOT cache the returned object, and try
11293     * not to mix calls on this object with regular elm_entry calls (which may
11294     * change the internal textblock object). This applies to all cursors
11295     * returned from textblock calls, and all the other derivative values.
11296     *
11297     * @param obj The entry object
11298     * @return The textblock object.
11299     */
11300    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11301    /**
11302     * Forces calculation of the entry size and text layouting.
11303     *
11304     * This should be used after modifying the textblock object directly. See
11305     * elm_entry_textblock_get() for more information.
11306     *
11307     * @param obj The entry object
11308     *
11309     * @see elm_entry_textblock_get()
11310     */
11311    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11312    /**
11313     * Inserts the given text into the entry at the current cursor position.
11314     *
11315     * This inserts text at the cursor position as if it was typed
11316     * by the user (note that this also allows markup which a user
11317     * can't just "type" as it would be converted to escaped text, so this
11318     * call can be used to insert things like emoticon items or bold push/pop
11319     * tags, other font and color change tags etc.)
11320     *
11321     * If any selection exists, it will be replaced by the inserted text.
11322     *
11323     * The inserted text is subject to any filters set for the widget.
11324     *
11325     * @param obj The entry object
11326     * @param entry The text to insert
11327     *
11328     * @see elm_entry_text_filter_append()
11329     */
11330    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11331    /**
11332     * Set the line wrap type to use on multi-line entries.
11333     *
11334     * Sets the wrap type used by the entry to any of the specified in
11335     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11336     * line (without inserting a line break or paragraph separator) when it
11337     * reaches the far edge of the widget.
11338     *
11339     * Note that this only makes sense for multi-line entries. A widget set
11340     * to be single line will never wrap.
11341     *
11342     * @param obj The entry object
11343     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11344     */
11345    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11346    /**
11347     * Gets the wrap mode the entry was set to use.
11348     *
11349     * @param obj The entry object
11350     * @return Wrap type
11351     *
11352     * @see also elm_entry_line_wrap_set()
11353     */
11354    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11355    /**
11356     * Sets if the entry is to be editable or not.
11357     *
11358     * By default, entries are editable and when focused, any text input by the
11359     * user will be inserted at the current cursor position. But calling this
11360     * function with @p editable as EINA_FALSE will prevent the user from
11361     * inputting text into the entry.
11362     *
11363     * The only way to change the text of a non-editable entry is to use
11364     * elm_object_text_set(), elm_entry_entry_insert() and other related
11365     * functions.
11366     *
11367     * @param obj The entry object
11368     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11369     * if not, the entry is read-only and no user input is allowed.
11370     */
11371    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11372    /**
11373     * Gets whether the entry is editable or not.
11374     *
11375     * @param obj The entry object
11376     * @return If true, the entry is editable by the user.
11377     * If false, it is not editable by the user
11378     *
11379     * @see elm_entry_editable_set()
11380     */
11381    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11382    /**
11383     * This drops any existing text selection within the entry.
11384     *
11385     * @param obj The entry object
11386     */
11387    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11388    /**
11389     * This selects all text within the entry.
11390     *
11391     * @param obj The entry object
11392     */
11393    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11394    /**
11395     * This moves the cursor one place to the right within the entry.
11396     *
11397     * @param obj The entry object
11398     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11399     */
11400    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11401    /**
11402     * This moves the cursor one place to the left within the entry.
11403     *
11404     * @param obj The entry object
11405     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11406     */
11407    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11408    /**
11409     * This moves the cursor one line up within the entry.
11410     *
11411     * @param obj The entry object
11412     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11413     */
11414    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11415    /**
11416     * This moves the cursor one line down within the entry.
11417     *
11418     * @param obj The entry object
11419     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11420     */
11421    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11422    /**
11423     * This moves the cursor to the beginning of the entry.
11424     *
11425     * @param obj The entry object
11426     */
11427    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11428    /**
11429     * This moves the cursor to the end of the entry.
11430     *
11431     * @param obj The entry object
11432     */
11433    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11434    /**
11435     * This moves the cursor to the beginning of the current line.
11436     *
11437     * @param obj The entry object
11438     */
11439    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11440    /**
11441     * This moves the cursor to the end of the current line.
11442     *
11443     * @param obj The entry object
11444     */
11445    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11446    /**
11447     * This begins a selection within the entry as though
11448     * the user were holding down the mouse button to make a selection.
11449     *
11450     * @param obj The entry object
11451     */
11452    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11453    /**
11454     * This ends a selection within the entry as though
11455     * the user had just released the mouse button while making a selection.
11456     *
11457     * @param obj The entry object
11458     */
11459    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11460    /**
11461     * Gets whether a format node exists at the current cursor position.
11462     *
11463     * A format node is anything that defines how the text is rendered. It can
11464     * be a visible format node, such as a line break or a paragraph separator,
11465     * or an invisible one, such as bold begin or end tag.
11466     * This function returns whether any format node exists at the current
11467     * cursor position.
11468     *
11469     * @param obj The entry object
11470     * @return EINA_TRUE if the current cursor position contains a format node,
11471     * EINA_FALSE otherwise.
11472     *
11473     * @see elm_entry_cursor_is_visible_format_get()
11474     */
11475    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11476    /**
11477     * Gets if the current cursor position holds a visible format node.
11478     *
11479     * @param obj The entry object
11480     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11481     * if it's an invisible one or no format exists.
11482     *
11483     * @see elm_entry_cursor_is_format_get()
11484     */
11485    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11486    /**
11487     * Gets the character pointed by the cursor at its current position.
11488     *
11489     * This function returns a string with the utf8 character stored at the
11490     * current cursor position.
11491     * Only the text is returned, any format that may exist will not be part
11492     * of the return value.
11493     *
11494     * @param obj The entry object
11495     * @return The text pointed by the cursors.
11496     */
11497    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11498    /**
11499     * This function returns the geometry of the cursor.
11500     *
11501     * It's useful if you want to draw something on the cursor (or where it is),
11502     * or for example in the case of scrolled entry where you want to show the
11503     * cursor.
11504     *
11505     * @param obj The entry object
11506     * @param x returned geometry
11507     * @param y returned geometry
11508     * @param w returned geometry
11509     * @param h returned geometry
11510     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11511     */
11512    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);
11513    /**
11514     * Sets the cursor position in the entry to the given value
11515     *
11516     * The value in @p pos is the index of the character position within the
11517     * contents of the string as returned by elm_entry_cursor_pos_get().
11518     *
11519     * @param obj The entry object
11520     * @param pos The position of the cursor
11521     */
11522    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11523    /**
11524     * Retrieves the current position of the cursor in the entry
11525     *
11526     * @param obj The entry object
11527     * @return The cursor position
11528     */
11529    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11530    /**
11531     * This executes a "cut" action on the selected text in the entry.
11532     *
11533     * @param obj The entry object
11534     */
11535    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11536    /**
11537     * This executes a "copy" action on the selected text in the entry.
11538     *
11539     * @param obj The entry object
11540     */
11541    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11542    /**
11543     * This executes a "paste" action in the entry.
11544     *
11545     * @param obj The entry object
11546     */
11547    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11548    /**
11549     * This clears and frees the items in a entry's contextual (longpress)
11550     * menu.
11551     *
11552     * @param obj The entry object
11553     *
11554     * @see elm_entry_context_menu_item_add()
11555     */
11556    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11557    /**
11558     * This adds an item to the entry's contextual menu.
11559     *
11560     * A longpress on an entry will make the contextual menu show up, if this
11561     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11562     * By default, this menu provides a few options like enabling selection mode,
11563     * which is useful on embedded devices that need to be explicit about it,
11564     * and when a selection exists it also shows the copy and cut actions.
11565     *
11566     * With this function, developers can add other options to this menu to
11567     * perform any action they deem necessary.
11568     *
11569     * @param obj The entry object
11570     * @param label The item's text label
11571     * @param icon_file The item's icon file
11572     * @param icon_type The item's icon type
11573     * @param func The callback to execute when the item is clicked
11574     * @param data The data to associate with the item for related functions
11575     */
11576    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);
11577    /**
11578     * This disables the entry's contextual (longpress) menu.
11579     *
11580     * @param obj The entry object
11581     * @param disabled If true, the menu is disabled
11582     */
11583    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11584    /**
11585     * This returns whether the entry's contextual (longpress) menu is
11586     * disabled.
11587     *
11588     * @param obj The entry object
11589     * @return If true, the menu is disabled
11590     */
11591    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11592    /**
11593     * This appends a custom item provider to the list for that entry
11594     *
11595     * This appends the given callback. The list is walked from beginning to end
11596     * with each function called given the item href string in the text. If the
11597     * function returns an object handle other than NULL (it should create an
11598     * object to do this), then this object is used to replace that item. If
11599     * not the next provider is called until one provides an item object, or the
11600     * default provider in entry does.
11601     *
11602     * @param obj The entry object
11603     * @param func The function called to provide the item object
11604     * @param data The data passed to @p func
11605     *
11606     * @see @ref entry-items
11607     */
11608    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);
11609    /**
11610     * This prepends a custom item provider to the list for that entry
11611     *
11612     * This prepends the given callback. See elm_entry_item_provider_append() for
11613     * more information
11614     *
11615     * @param obj The entry object
11616     * @param func The function called to provide the item object
11617     * @param data The data passed to @p func
11618     */
11619    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);
11620    /**
11621     * This removes a custom item provider to the list for that entry
11622     *
11623     * This removes the given callback. See elm_entry_item_provider_append() for
11624     * more information
11625     *
11626     * @param obj The entry object
11627     * @param func The function called to provide the item object
11628     * @param data The data passed to @p func
11629     */
11630    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);
11631    /**
11632     * Append a filter function for text inserted in the entry
11633     *
11634     * Append the given callback to the list. This functions will be called
11635     * whenever any text is inserted into the entry, with the text to be inserted
11636     * as a parameter. The callback function is free to alter the text in any way
11637     * it wants, but it must remember to free the given pointer and update it.
11638     * If the new text is to be discarded, the function can free it and set its
11639     * text parameter to NULL. This will also prevent any following filters from
11640     * being called.
11641     *
11642     * @param obj The entry object
11643     * @param func The function to use as text filter
11644     * @param data User data to pass to @p func
11645     */
11646    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11647    /**
11648     * Prepend a filter function for text insdrted in the entry
11649     *
11650     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11651     * for more information
11652     *
11653     * @param obj The entry object
11654     * @param func The function to use as text filter
11655     * @param data User data to pass to @p func
11656     */
11657    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11658    /**
11659     * Remove a filter from the list
11660     *
11661     * Removes the given callback from the filter list. See
11662     * elm_entry_text_filter_append() for more information.
11663     *
11664     * @param obj The entry object
11665     * @param func The filter function to remove
11666     * @param data The user data passed when adding the function
11667     */
11668    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11669    /**
11670     * This converts a markup (HTML-like) string into UTF-8.
11671     *
11672     * The returned string is a malloc'ed buffer and it should be freed when
11673     * not needed anymore.
11674     *
11675     * @param s The string (in markup) to be converted
11676     * @return The converted string (in UTF-8). It should be freed.
11677     */
11678    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11679    /**
11680     * This converts a UTF-8 string into markup (HTML-like).
11681     *
11682     * The returned string is a malloc'ed buffer and it should be freed when
11683     * not needed anymore.
11684     *
11685     * @param s The string (in UTF-8) to be converted
11686     * @return The converted string (in markup). It should be freed.
11687     */
11688    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11689    /**
11690     * This sets the file (and implicitly loads it) for the text to display and
11691     * then edit. All changes are written back to the file after a short delay if
11692     * the entry object is set to autosave (which is the default).
11693     *
11694     * If the entry had any other file set previously, any changes made to it
11695     * will be saved if the autosave feature is enabled, otherwise, the file
11696     * will be silently discarded and any non-saved changes will be lost.
11697     *
11698     * @param obj The entry object
11699     * @param file The path to the file to load and save
11700     * @param format The file format
11701     */
11702    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11703    /**
11704     * Gets the file being edited by the entry.
11705     *
11706     * This function can be used to retrieve any file set on the entry for
11707     * edition, along with the format used to load and save it.
11708     *
11709     * @param obj The entry object
11710     * @param file The path to the file to load and save
11711     * @param format The file format
11712     */
11713    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11714    /**
11715     * This function writes any changes made to the file set with
11716     * elm_entry_file_set()
11717     *
11718     * @param obj The entry object
11719     */
11720    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11721    /**
11722     * This sets the entry object to 'autosave' the loaded text file or not.
11723     *
11724     * @param obj The entry object
11725     * @param autosave Autosave the loaded file or not
11726     *
11727     * @see elm_entry_file_set()
11728     */
11729    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11730    /**
11731     * This gets the entry object's 'autosave' status.
11732     *
11733     * @param obj The entry object
11734     * @return Autosave the loaded file or not
11735     *
11736     * @see elm_entry_file_set()
11737     */
11738    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11739    /**
11740     * Control pasting of text and images for the widget.
11741     *
11742     * Normally the entry allows both text and images to be pasted.  By setting
11743     * textonly to be true, this prevents images from being pasted.
11744     *
11745     * Note this only changes the behaviour of text.
11746     *
11747     * @param obj The entry object
11748     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11749     * text+image+other.
11750     */
11751    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11752    /**
11753     * Getting elm_entry text paste/drop mode.
11754     *
11755     * In textonly mode, only text may be pasted or dropped into the widget.
11756     *
11757     * @param obj The entry object
11758     * @return If the widget only accepts text from pastes.
11759     */
11760    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11761    /**
11762     * Enable or disable scrolling in entry
11763     *
11764     * Normally the entry is not scrollable unless you enable it with this call.
11765     *
11766     * @param obj The entry object
11767     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11768     */
11769    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11770    /**
11771     * Get the scrollable state of the entry
11772     *
11773     * Normally the entry is not scrollable. This gets the scrollable state
11774     * of the entry. See elm_entry_scrollable_set() for more information.
11775     *
11776     * @param obj The entry object
11777     * @return The scrollable state
11778     */
11779    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11780    /**
11781     * This sets a widget to be displayed to the left of a scrolled entry.
11782     *
11783     * @param obj The scrolled entry object
11784     * @param icon The widget to display on the left side of the scrolled
11785     * entry.
11786     *
11787     * @note A previously set widget will be destroyed.
11788     * @note If the object being set does not have minimum size hints set,
11789     * it won't get properly displayed.
11790     *
11791     * @see elm_entry_end_set()
11792     */
11793    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11794    /**
11795     * Gets the leftmost widget of the scrolled entry. This object is
11796     * owned by the scrolled entry and should not be modified.
11797     *
11798     * @param obj The scrolled entry object
11799     * @return the left widget inside the scroller
11800     */
11801    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11802    /**
11803     * Unset the leftmost widget of the scrolled entry, unparenting and
11804     * returning it.
11805     *
11806     * @param obj The scrolled entry object
11807     * @return the previously set icon sub-object of this entry, on
11808     * success.
11809     *
11810     * @see elm_entry_icon_set()
11811     */
11812    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11813    /**
11814     * Sets the visibility of the left-side widget of the scrolled entry,
11815     * set by elm_entry_icon_set().
11816     *
11817     * @param obj The scrolled entry object
11818     * @param setting EINA_TRUE if the object should be displayed,
11819     * EINA_FALSE if not.
11820     */
11821    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11822    /**
11823     * This sets a widget to be displayed to the end of a scrolled entry.
11824     *
11825     * @param obj The scrolled entry object
11826     * @param end The widget to display on the right side of the scrolled
11827     * entry.
11828     *
11829     * @note A previously set widget will be destroyed.
11830     * @note If the object being set does not have minimum size hints set,
11831     * it won't get properly displayed.
11832     *
11833     * @see elm_entry_icon_set
11834     */
11835    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11836    /**
11837     * Gets the endmost widget of the scrolled entry. This object is owned
11838     * by the scrolled entry and should not be modified.
11839     *
11840     * @param obj The scrolled entry object
11841     * @return the right widget inside the scroller
11842     */
11843    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11844    /**
11845     * Unset the endmost widget of the scrolled entry, unparenting and
11846     * returning it.
11847     *
11848     * @param obj The scrolled entry object
11849     * @return the previously set icon sub-object of this entry, on
11850     * success.
11851     *
11852     * @see elm_entry_icon_set()
11853     */
11854    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11855    /**
11856     * Sets the visibility of the end widget of the scrolled entry, set by
11857     * elm_entry_end_set().
11858     *
11859     * @param obj The scrolled entry object
11860     * @param setting EINA_TRUE if the object should be displayed,
11861     * EINA_FALSE if not.
11862     */
11863    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11864    /**
11865     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11866     * them).
11867     *
11868     * Setting an entry to single-line mode with elm_entry_single_line_set()
11869     * will automatically disable the display of scrollbars when the entry
11870     * moves inside its scroller.
11871     *
11872     * @param obj The scrolled entry object
11873     * @param h The horizontal scrollbar policy to apply
11874     * @param v The vertical scrollbar policy to apply
11875     */
11876    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11877    /**
11878     * This enables/disables bouncing within the entry.
11879     *
11880     * This function sets whether the entry will bounce when scrolling reaches
11881     * the end of the contained entry.
11882     *
11883     * @param obj The scrolled entry object
11884     * @param h The horizontal bounce state
11885     * @param v The vertical bounce state
11886     */
11887    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11888    /**
11889     * Get the bounce mode
11890     *
11891     * @param obj The Entry object
11892     * @param h_bounce Allow bounce horizontally
11893     * @param v_bounce Allow bounce vertically
11894     */
11895    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11896
11897    /* pre-made filters for entries */
11898    /**
11899     * @typedef Elm_Entry_Filter_Limit_Size
11900     *
11901     * Data for the elm_entry_filter_limit_size() entry filter.
11902     */
11903    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11904    /**
11905     * @struct _Elm_Entry_Filter_Limit_Size
11906     *
11907     * Data for the elm_entry_filter_limit_size() entry filter.
11908     */
11909    struct _Elm_Entry_Filter_Limit_Size
11910      {
11911         int max_char_count; /**< The maximum number of characters allowed. */
11912         int max_byte_count; /**< The maximum number of bytes allowed*/
11913      };
11914    /**
11915     * Filter inserted text based on user defined character and byte limits
11916     *
11917     * Add this filter to an entry to limit the characters that it will accept
11918     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11919     * The funtion works on the UTF-8 representation of the string, converting
11920     * it from the set markup, thus not accounting for any format in it.
11921     *
11922     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11923     * it as data when setting the filter. In it, it's possible to set limits
11924     * by character count or bytes (any of them is disabled if 0), and both can
11925     * be set at the same time. In that case, it first checks for characters,
11926     * then bytes.
11927     *
11928     * The function will cut the inserted text in order to allow only the first
11929     * number of characters that are still allowed. The cut is made in
11930     * characters, even when limiting by bytes, in order to always contain
11931     * valid ones and avoid half unicode characters making it in.
11932     *
11933     * This filter, like any others, does not apply when setting the entry text
11934     * directly with elm_object_text_set() (or the deprecated
11935     * elm_entry_entry_set()).
11936     */
11937    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11938    /**
11939     * @typedef Elm_Entry_Filter_Accept_Set
11940     *
11941     * Data for the elm_entry_filter_accept_set() entry filter.
11942     */
11943    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11944    /**
11945     * @struct _Elm_Entry_Filter_Accept_Set
11946     *
11947     * Data for the elm_entry_filter_accept_set() entry filter.
11948     */
11949    struct _Elm_Entry_Filter_Accept_Set
11950      {
11951         const char *accepted; /**< Set of characters accepted in the entry. */
11952         const char *rejected; /**< Set of characters rejected from the entry. */
11953      };
11954    /**
11955     * Filter inserted text based on accepted or rejected sets of characters
11956     *
11957     * Add this filter to an entry to restrict the set of accepted characters
11958     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11959     * This structure contains both accepted and rejected sets, but they are
11960     * mutually exclusive.
11961     *
11962     * The @c accepted set takes preference, so if it is set, the filter will
11963     * only work based on the accepted characters, ignoring anything in the
11964     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11965     *
11966     * In both cases, the function filters by matching utf8 characters to the
11967     * raw markup text, so it can be used to remove formatting tags.
11968     *
11969     * This filter, like any others, does not apply when setting the entry text
11970     * directly with elm_object_text_set() (or the deprecated
11971     * elm_entry_entry_set()).
11972     */
11973    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11974    /**
11975     * Set the input panel layout of the entry
11976     *
11977     * @param obj The entry object
11978     * @param layout layout type
11979     */
11980    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11981    /**
11982     * Get the input panel layout of the entry
11983     *
11984     * @param obj The entry object
11985     * @return layout type
11986     *
11987     * @see elm_entry_input_panel_layout_set
11988     */
11989    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11990    /**
11991     * Set the autocapitalization type on the immodule.
11992     *
11993     * @param obj The entry object
11994     * @param autocapital_type The type of autocapitalization
11995     */
11996    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11997    /**
11998     * Retrieve the autocapitalization type on the immodule.
11999     *
12000     * @param obj The entry object
12001     * @return autocapitalization type
12002     */
12003    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12004    /**
12005     * Sets the attribute to show the input panel automatically.
12006     *
12007     * @param obj The entry object
12008     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12009     */
12010    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12011    /**
12012     * Retrieve the attribute to show the input panel automatically.
12013     *
12014     * @param obj The entry object
12015     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12016     */
12017    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12018
12019    /**
12020     * @}
12021     */
12022
12023    /* composite widgets - these basically put together basic widgets above
12024     * in convenient packages that do more than basic stuff */
12025
12026    /* anchorview */
12027    /**
12028     * @defgroup Anchorview Anchorview
12029     *
12030     * @image html img/widget/anchorview/preview-00.png
12031     * @image latex img/widget/anchorview/preview-00.eps
12032     *
12033     * Anchorview is for displaying text that contains markup with anchors
12034     * like <c>\<a href=1234\>something\</\></c> in it.
12035     *
12036     * Besides being styled differently, the anchorview widget provides the
12037     * necessary functionality so that clicking on these anchors brings up a
12038     * popup with user defined content such as "call", "add to contacts" or
12039     * "open web page". This popup is provided using the @ref Hover widget.
12040     *
12041     * This widget is very similar to @ref Anchorblock, so refer to that
12042     * widget for an example. The only difference Anchorview has is that the
12043     * widget is already provided with scrolling functionality, so if the
12044     * text set to it is too large to fit in the given space, it will scroll,
12045     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12046     * text can be displayed.
12047     *
12048     * This widget emits the following signals:
12049     * @li "anchor,clicked": will be called when an anchor is clicked. The
12050     * @p event_info parameter on the callback will be a pointer of type
12051     * ::Elm_Entry_Anchorview_Info.
12052     *
12053     * See @ref Anchorblock for an example on how to use both of them.
12054     *
12055     * @see Anchorblock
12056     * @see Entry
12057     * @see Hover
12058     *
12059     * @{
12060     */
12061    /**
12062     * @typedef Elm_Entry_Anchorview_Info
12063     *
12064     * The info sent in the callback for "anchor,clicked" signals emitted by
12065     * the Anchorview widget.
12066     */
12067    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12068    /**
12069     * @struct _Elm_Entry_Anchorview_Info
12070     *
12071     * The info sent in the callback for "anchor,clicked" signals emitted by
12072     * the Anchorview widget.
12073     */
12074    struct _Elm_Entry_Anchorview_Info
12075      {
12076         const char     *name; /**< Name of the anchor, as indicated in its href
12077                                    attribute */
12078         int             button; /**< The mouse button used to click on it */
12079         Evas_Object    *hover; /**< The hover object to use for the popup */
12080         struct {
12081              Evas_Coord    x, y, w, h;
12082         } anchor, /**< Geometry selection of text used as anchor */
12083           hover_parent; /**< Geometry of the object used as parent by the
12084                              hover */
12085         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12086                                              for content on the left side of
12087                                              the hover. Before calling the
12088                                              callback, the widget will make the
12089                                              necessary calculations to check
12090                                              which sides are fit to be set with
12091                                              content, based on the position the
12092                                              hover is activated and its distance
12093                                              to the edges of its parent object
12094                                              */
12095         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12096                                               the right side of the hover.
12097                                               See @ref hover_left */
12098         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12099                                             of the hover. See @ref hover_left */
12100         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12101                                                below the hover. See @ref
12102                                                hover_left */
12103      };
12104    /**
12105     * Add a new Anchorview object
12106     *
12107     * @param parent The parent object
12108     * @return The new object or NULL if it cannot be created
12109     */
12110    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12111    /**
12112     * Set the text to show in the anchorview
12113     *
12114     * Sets the text of the anchorview to @p text. This text can include markup
12115     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12116     * text that will be specially styled and react to click events, ended with
12117     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12118     * "anchor,clicked" signal that you can attach a callback to with
12119     * evas_object_smart_callback_add(). The name of the anchor given in the
12120     * event info struct will be the one set in the href attribute, in this
12121     * case, anchorname.
12122     *
12123     * Other markup can be used to style the text in different ways, but it's
12124     * up to the style defined in the theme which tags do what.
12125     * @deprecated use elm_object_text_set() instead.
12126     */
12127    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12128    /**
12129     * Get the markup text set for the anchorview
12130     *
12131     * Retrieves the text set on the anchorview, with markup tags included.
12132     *
12133     * @param obj The anchorview object
12134     * @return The markup text set or @c NULL if nothing was set or an error
12135     * occurred
12136     * @deprecated use elm_object_text_set() instead.
12137     */
12138    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12139    /**
12140     * Set the parent of the hover popup
12141     *
12142     * Sets the parent object to use by the hover created by the anchorview
12143     * when an anchor is clicked. See @ref Hover for more details on this.
12144     * If no parent is set, the same anchorview object will be used.
12145     *
12146     * @param obj The anchorview object
12147     * @param parent The object to use as parent for the hover
12148     */
12149    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12150    /**
12151     * Get the parent of the hover popup
12152     *
12153     * Get the object used as parent for the hover created by the anchorview
12154     * widget. See @ref Hover for more details on this.
12155     *
12156     * @param obj The anchorview object
12157     * @return The object used as parent for the hover, NULL if none is set.
12158     */
12159    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12160    /**
12161     * Set the style that the hover should use
12162     *
12163     * When creating the popup hover, anchorview will request that it's
12164     * themed according to @p style.
12165     *
12166     * @param obj The anchorview object
12167     * @param style The style to use for the underlying hover
12168     *
12169     * @see elm_object_style_set()
12170     */
12171    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12172    /**
12173     * Get the style that the hover should use
12174     *
12175     * Get the style the hover created by anchorview will use.
12176     *
12177     * @param obj The anchorview object
12178     * @return The style to use by the hover. NULL means the default is used.
12179     *
12180     * @see elm_object_style_set()
12181     */
12182    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12183    /**
12184     * Ends the hover popup in the anchorview
12185     *
12186     * When an anchor is clicked, the anchorview widget will create a hover
12187     * object to use as a popup with user provided content. This function
12188     * terminates this popup, returning the anchorview to its normal state.
12189     *
12190     * @param obj The anchorview object
12191     */
12192    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12193    /**
12194     * Set bouncing behaviour when the scrolled content reaches an edge
12195     *
12196     * Tell the internal scroller object whether it should bounce or not
12197     * when it reaches the respective edges for each axis.
12198     *
12199     * @param obj The anchorview object
12200     * @param h_bounce Whether to bounce or not in the horizontal axis
12201     * @param v_bounce Whether to bounce or not in the vertical axis
12202     *
12203     * @see elm_scroller_bounce_set()
12204     */
12205    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12206    /**
12207     * Get the set bouncing behaviour of the internal scroller
12208     *
12209     * Get whether the internal scroller should bounce when the edge of each
12210     * axis is reached scrolling.
12211     *
12212     * @param obj The anchorview object
12213     * @param h_bounce Pointer where to store the bounce state of the horizontal
12214     *                 axis
12215     * @param v_bounce Pointer where to store the bounce state of the vertical
12216     *                 axis
12217     *
12218     * @see elm_scroller_bounce_get()
12219     */
12220    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12221    /**
12222     * Appends a custom item provider to the given anchorview
12223     *
12224     * Appends the given function to the list of items providers. This list is
12225     * called, one function at a time, with the given @p data pointer, the
12226     * anchorview object and, in the @p item parameter, the item name as
12227     * referenced in its href string. Following functions in the list will be
12228     * called in order until one of them returns something different to NULL,
12229     * which should be an Evas_Object which will be used in place of the item
12230     * element.
12231     *
12232     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12233     * href=item/name\>\</item\>
12234     *
12235     * @param obj The anchorview object
12236     * @param func The function to add to the list of providers
12237     * @param data User data that will be passed to the callback function
12238     *
12239     * @see elm_entry_item_provider_append()
12240     */
12241    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);
12242    /**
12243     * Prepend a custom item provider to the given anchorview
12244     *
12245     * Like elm_anchorview_item_provider_append(), but it adds the function
12246     * @p func to the beginning of the list, instead of the end.
12247     *
12248     * @param obj The anchorview object
12249     * @param func The function to add to the list of providers
12250     * @param data User data that will be passed to the callback function
12251     */
12252    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);
12253    /**
12254     * Remove a custom item provider from the list of the given anchorview
12255     *
12256     * Removes the function and data pairing that matches @p func and @p data.
12257     * That is, unless the same function and same user data are given, the
12258     * function will not be removed from the list. This allows us to add the
12259     * same callback several times, with different @p data pointers and be
12260     * able to remove them later without conflicts.
12261     *
12262     * @param obj The anchorview object
12263     * @param func The function to remove from the list
12264     * @param data The data matching the function to remove from the list
12265     */
12266    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);
12267    /**
12268     * @}
12269     */
12270
12271    /* anchorblock */
12272    /**
12273     * @defgroup Anchorblock Anchorblock
12274     *
12275     * @image html img/widget/anchorblock/preview-00.png
12276     * @image latex img/widget/anchorblock/preview-00.eps
12277     *
12278     * Anchorblock is for displaying text that contains markup with anchors
12279     * like <c>\<a href=1234\>something\</\></c> in it.
12280     *
12281     * Besides being styled differently, the anchorblock widget provides the
12282     * necessary functionality so that clicking on these anchors brings up a
12283     * popup with user defined content such as "call", "add to contacts" or
12284     * "open web page". This popup is provided using the @ref Hover widget.
12285     *
12286     * This widget emits the following signals:
12287     * @li "anchor,clicked": will be called when an anchor is clicked. The
12288     * @p event_info parameter on the callback will be a pointer of type
12289     * ::Elm_Entry_Anchorblock_Info.
12290     *
12291     * @see Anchorview
12292     * @see Entry
12293     * @see Hover
12294     *
12295     * Since examples are usually better than plain words, we might as well
12296     * try @ref tutorial_anchorblock_example "one".
12297     */
12298    /**
12299     * @addtogroup Anchorblock
12300     * @{
12301     */
12302    /**
12303     * @typedef Elm_Entry_Anchorblock_Info
12304     *
12305     * The info sent in the callback for "anchor,clicked" signals emitted by
12306     * the Anchorblock widget.
12307     */
12308    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12309    /**
12310     * @struct _Elm_Entry_Anchorblock_Info
12311     *
12312     * The info sent in the callback for "anchor,clicked" signals emitted by
12313     * the Anchorblock widget.
12314     */
12315    struct _Elm_Entry_Anchorblock_Info
12316      {
12317         const char     *name; /**< Name of the anchor, as indicated in its href
12318                                    attribute */
12319         int             button; /**< The mouse button used to click on it */
12320         Evas_Object    *hover; /**< The hover object to use for the popup */
12321         struct {
12322              Evas_Coord    x, y, w, h;
12323         } anchor, /**< Geometry selection of text used as anchor */
12324           hover_parent; /**< Geometry of the object used as parent by the
12325                              hover */
12326         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12327                                              for content on the left side of
12328                                              the hover. Before calling the
12329                                              callback, the widget will make the
12330                                              necessary calculations to check
12331                                              which sides are fit to be set with
12332                                              content, based on the position the
12333                                              hover is activated and its distance
12334                                              to the edges of its parent object
12335                                              */
12336         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12337                                               the right side of the hover.
12338                                               See @ref hover_left */
12339         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12340                                             of the hover. See @ref hover_left */
12341         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12342                                                below the hover. See @ref
12343                                                hover_left */
12344      };
12345    /**
12346     * Add a new Anchorblock object
12347     *
12348     * @param parent The parent object
12349     * @return The new object or NULL if it cannot be created
12350     */
12351    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12352    /**
12353     * Set the text to show in the anchorblock
12354     *
12355     * Sets the text of the anchorblock to @p text. This text can include markup
12356     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12357     * of text that will be specially styled and react to click events, ended
12358     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12359     * "anchor,clicked" signal that you can attach a callback to with
12360     * evas_object_smart_callback_add(). The name of the anchor given in the
12361     * event info struct will be the one set in the href attribute, in this
12362     * case, anchorname.
12363     *
12364     * Other markup can be used to style the text in different ways, but it's
12365     * up to the style defined in the theme which tags do what.
12366     * @deprecated use elm_object_text_set() instead.
12367     */
12368    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12369    /**
12370     * Get the markup text set for the anchorblock
12371     *
12372     * Retrieves the text set on the anchorblock, with markup tags included.
12373     *
12374     * @param obj The anchorblock object
12375     * @return The markup text set or @c NULL if nothing was set or an error
12376     * occurred
12377     * @deprecated use elm_object_text_set() instead.
12378     */
12379    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12380    /**
12381     * Set the parent of the hover popup
12382     *
12383     * Sets the parent object to use by the hover created by the anchorblock
12384     * when an anchor is clicked. See @ref Hover for more details on this.
12385     *
12386     * @param obj The anchorblock object
12387     * @param parent The object to use as parent for the hover
12388     */
12389    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12390    /**
12391     * Get the parent of the hover popup
12392     *
12393     * Get the object used as parent for the hover created by the anchorblock
12394     * widget. See @ref Hover for more details on this.
12395     * If no parent is set, the same anchorblock object will be used.
12396     *
12397     * @param obj The anchorblock object
12398     * @return The object used as parent for the hover, NULL if none is set.
12399     */
12400    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12401    /**
12402     * Set the style that the hover should use
12403     *
12404     * When creating the popup hover, anchorblock will request that it's
12405     * themed according to @p style.
12406     *
12407     * @param obj The anchorblock object
12408     * @param style The style to use for the underlying hover
12409     *
12410     * @see elm_object_style_set()
12411     */
12412    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12413    /**
12414     * Get the style that the hover should use
12415     *
12416     * Get the style, the hover created by anchorblock will use.
12417     *
12418     * @param obj The anchorblock object
12419     * @return The style to use by the hover. NULL means the default is used.
12420     *
12421     * @see elm_object_style_set()
12422     */
12423    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12424    /**
12425     * Ends the hover popup in the anchorblock
12426     *
12427     * When an anchor is clicked, the anchorblock widget will create a hover
12428     * object to use as a popup with user provided content. This function
12429     * terminates this popup, returning the anchorblock to its normal state.
12430     *
12431     * @param obj The anchorblock object
12432     */
12433    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12434    /**
12435     * Appends a custom item provider to the given anchorblock
12436     *
12437     * Appends the given function to the list of items providers. This list is
12438     * called, one function at a time, with the given @p data pointer, the
12439     * anchorblock object and, in the @p item parameter, the item name as
12440     * referenced in its href string. Following functions in the list will be
12441     * called in order until one of them returns something different to NULL,
12442     * which should be an Evas_Object which will be used in place of the item
12443     * element.
12444     *
12445     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12446     * href=item/name\>\</item\>
12447     *
12448     * @param obj The anchorblock object
12449     * @param func The function to add to the list of providers
12450     * @param data User data that will be passed to the callback function
12451     *
12452     * @see elm_entry_item_provider_append()
12453     */
12454    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);
12455    /**
12456     * Prepend a custom item provider to the given anchorblock
12457     *
12458     * Like elm_anchorblock_item_provider_append(), but it adds the function
12459     * @p func to the beginning of the list, instead of the end.
12460     *
12461     * @param obj The anchorblock object
12462     * @param func The function to add to the list of providers
12463     * @param data User data that will be passed to the callback function
12464     */
12465    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);
12466    /**
12467     * Remove a custom item provider from the list of the given anchorblock
12468     *
12469     * Removes the function and data pairing that matches @p func and @p data.
12470     * That is, unless the same function and same user data are given, the
12471     * function will not be removed from the list. This allows us to add the
12472     * same callback several times, with different @p data pointers and be
12473     * able to remove them later without conflicts.
12474     *
12475     * @param obj The anchorblock object
12476     * @param func The function to remove from the list
12477     * @param data The data matching the function to remove from the list
12478     */
12479    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);
12480    /**
12481     * @}
12482     */
12483
12484    /**
12485     * @defgroup Bubble Bubble
12486     *
12487     * @image html img/widget/bubble/preview-00.png
12488     * @image latex img/widget/bubble/preview-00.eps
12489     * @image html img/widget/bubble/preview-01.png
12490     * @image latex img/widget/bubble/preview-01.eps
12491     * @image html img/widget/bubble/preview-02.png
12492     * @image latex img/widget/bubble/preview-02.eps
12493     *
12494     * @brief The Bubble is a widget to show text similar to how speech is
12495     * represented in comics.
12496     *
12497     * The bubble widget contains 5 important visual elements:
12498     * @li The frame is a rectangle with rounded edjes and an "arrow".
12499     * @li The @p icon is an image to which the frame's arrow points to.
12500     * @li The @p label is a text which appears to the right of the icon if the
12501     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12502     * otherwise.
12503     * @li The @p info is a text which appears to the right of the label. Info's
12504     * font is of a ligther color than label.
12505     * @li The @p content is an evas object that is shown inside the frame.
12506     *
12507     * The position of the arrow, icon, label and info depends on which corner is
12508     * selected. The four available corners are:
12509     * @li "top_left" - Default
12510     * @li "top_right"
12511     * @li "bottom_left"
12512     * @li "bottom_right"
12513     *
12514     * Signals that you can add callbacks for are:
12515     * @li "clicked" - This is called when a user has clicked the bubble.
12516     *
12517     * Default contents parts of the bubble that you can use for are:
12518     * @li "default" - A content of the bubble
12519     * @li "icon" - An icon of the bubble
12520     *
12521     * Default text parts of the button widget that you can use for are:
12522     * @li NULL - Label of the bubble
12523     * 
12524          * For an example of using a buble see @ref bubble_01_example_page "this".
12525     *
12526     * @{
12527     */
12528
12529    /**
12530     * Add a new bubble to the parent
12531     *
12532     * @param parent The parent object
12533     * @return The new object or NULL if it cannot be created
12534     *
12535     * This function adds a text bubble to the given parent evas object.
12536     */
12537    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12538    /**
12539     * Set the label of the bubble
12540     *
12541     * @param obj The bubble object
12542     * @param label The string to set in the label
12543     *
12544     * This function sets the title of the bubble. Where this appears depends on
12545     * the selected corner.
12546     * @deprecated use elm_object_text_set() instead.
12547     */
12548    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12549    /**
12550     * Get the label of the bubble
12551     *
12552     * @param obj The bubble object
12553     * @return The string of set in the label
12554     *
12555     * This function gets the title of the bubble.
12556     * @deprecated use elm_object_text_get() instead.
12557     */
12558    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12559    /**
12560     * Set the info of the bubble
12561     *
12562     * @param obj The bubble object
12563     * @param info The given info about the bubble
12564     *
12565     * This function sets the info of the bubble. Where this appears depends on
12566     * the selected corner.
12567     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12568     */
12569    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12570    /**
12571     * Get the info of the bubble
12572     *
12573     * @param obj The bubble object
12574     *
12575     * @return The "info" string of the bubble
12576     *
12577     * This function gets the info text.
12578     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12579     */
12580    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12581    /**
12582     * Set the content to be shown in the bubble
12583     *
12584     * Once the content object is set, a previously set one will be deleted.
12585     * If you want to keep the old content object, use the
12586     * elm_bubble_content_unset() function.
12587     *
12588     * @param obj The bubble object
12589     * @param content The given content of the bubble
12590     *
12591     * This function sets the content shown on the middle of the bubble.
12592     * 
12593     * @deprecated use elm_object_content_set() instead
12594     *
12595     */
12596    EINA_DEPRECATED EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12597    /**
12598     * Get the content shown in the bubble
12599     *
12600     * Return the content object which is set for this widget.
12601     *
12602     * @param obj The bubble object
12603     * @return The content that is being used
12604     *
12605     * @deprecated use elm_object_content_get() instead
12606     *
12607     */
12608    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12609    /**
12610     * Unset the content shown in the bubble
12611     *
12612     * Unparent and return the content object which was set for this widget.
12613     *
12614     * @param obj The bubble object
12615     * @return The content that was being used
12616     *
12617     * @deprecated use elm_object_content_unset() instead
12618     *
12619     */
12620    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12621    /**
12622     * Set the icon of the bubble
12623     *
12624     * Once the icon object is set, a previously set one will be deleted.
12625     * If you want to keep the old content object, use the
12626     * elm_icon_content_unset() function.
12627     *
12628     * @param obj The bubble object
12629     * @param icon The given icon for the bubble
12630     *
12631     * @deprecated use elm_object_part_content_set() instead
12632     *
12633     */
12634    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12635    /**
12636     * Get the icon of the bubble
12637     *
12638     * @param obj The bubble object
12639     * @return The icon for the bubble
12640     *
12641     * This function gets the icon shown on the top left of bubble.
12642     *
12643     * @deprecated use elm_object_part_content_get() instead
12644     *
12645     */
12646    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12647    /**
12648     * Unset the icon of the bubble
12649     *
12650     * Unparent and return the icon object which was set for this widget.
12651     *
12652     * @param obj The bubble object
12653     * @return The icon that was being used
12654     *
12655     * @deprecated use elm_object_part_content_unset() instead
12656     *
12657     */
12658    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12659    /**
12660     * Set the corner of the bubble
12661     *
12662     * @param obj The bubble object.
12663     * @param corner The given corner for the bubble.
12664     *
12665     * This function sets the corner of the bubble. The corner will be used to
12666     * determine where the arrow in the frame points to and where label, icon and
12667     * info are shown.
12668     *
12669     * Possible values for corner are:
12670     * @li "top_left" - Default
12671     * @li "top_right"
12672     * @li "bottom_left"
12673     * @li "bottom_right"
12674     */
12675    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12676    /**
12677     * Get the corner of the bubble
12678     *
12679     * @param obj The bubble object.
12680     * @return The given corner for the bubble.
12681     *
12682     * This function gets the selected corner of the bubble.
12683     */
12684    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12685    /**
12686     * @}
12687     */
12688
12689    /**
12690     * @defgroup Photo Photo
12691     *
12692     * For displaying the photo of a person (contact). Simple, yet
12693     * with a very specific purpose.
12694     *
12695     * Signals that you can add callbacks for are:
12696     *
12697     * "clicked" - This is called when a user has clicked the photo
12698     * "drag,start" - Someone started dragging the image out of the object
12699     * "drag,end" - Dragged item was dropped (somewhere)
12700     *
12701     * @{
12702     */
12703
12704    /**
12705     * Add a new photo to the parent
12706     *
12707     * @param parent The parent object
12708     * @return The new object or NULL if it cannot be created
12709     *
12710     * @ingroup Photo
12711     */
12712    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12713
12714    /**
12715     * Set the file that will be used as photo
12716     *
12717     * @param obj The photo object
12718     * @param file The path to file that will be used as photo
12719     *
12720     * @return (1 = success, 0 = error)
12721     *
12722     * @ingroup Photo
12723     */
12724    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12725
12726     /**
12727     * Set the file that will be used as thumbnail in the photo.
12728     *
12729     * @param obj The photo object.
12730     * @param file The path to file that will be used as thumb.
12731     * @param group The key used in case of an EET file.
12732     *
12733     * @ingroup Photo
12734     */
12735    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12736
12737    /**
12738     * Set the size that will be used on the photo
12739     *
12740     * @param obj The photo object
12741     * @param size The size that the photo will be
12742     *
12743     * @ingroup Photo
12744     */
12745    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12746
12747    /**
12748     * Set if the photo should be completely visible or not.
12749     *
12750     * @param obj The photo object
12751     * @param fill if true the photo will be completely visible
12752     *
12753     * @ingroup Photo
12754     */
12755    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12756
12757    /**
12758     * Set editability of the photo.
12759     *
12760     * An editable photo can be dragged to or from, and can be cut or
12761     * pasted too.  Note that pasting an image or dropping an item on
12762     * the image will delete the existing content.
12763     *
12764     * @param obj The photo object.
12765     * @param set To set of clear editablity.
12766     */
12767    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12768
12769    /**
12770     * @}
12771     */
12772
12773    /* gesture layer */
12774    /**
12775     * @defgroup Elm_Gesture_Layer Gesture Layer
12776     * Gesture Layer Usage:
12777     *
12778     * Use Gesture Layer to detect gestures.
12779     * The advantage is that you don't have to implement
12780     * gesture detection, just set callbacks of gesture state.
12781     * By using gesture layer we make standard interface.
12782     *
12783     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12784     * with a parent object parameter.
12785     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12786     * call. Usually with same object as target (2nd parameter).
12787     *
12788     * Now you need to tell gesture layer what gestures you follow.
12789     * This is done with @ref elm_gesture_layer_cb_set call.
12790     * By setting the callback you actually saying to gesture layer:
12791     * I would like to know when the gesture @ref Elm_Gesture_Types
12792     * switches to state @ref Elm_Gesture_State.
12793     *
12794     * Next, you need to implement the actual action that follows the input
12795     * in your callback.
12796     *
12797     * Note that if you like to stop being reported about a gesture, just set
12798     * all callbacks referring this gesture to NULL.
12799     * (again with @ref elm_gesture_layer_cb_set)
12800     *
12801     * The information reported by gesture layer to your callback is depending
12802     * on @ref Elm_Gesture_Types:
12803     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12804     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12805     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12806     *
12807     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12808     * @ref ELM_GESTURE_MOMENTUM.
12809     *
12810     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12811     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12812     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12813     * Note that we consider a flick as a line-gesture that should be completed
12814     * in flick-time-limit as defined in @ref Config.
12815     *
12816     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12817     *
12818     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12819     *
12820     *
12821     * Gesture Layer Tweaks:
12822     *
12823     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12824     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12825     *
12826     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12827     * so gesture starts when user touches (a *DOWN event) touch-surface
12828     * and ends when no fingers touches surface (a *UP event).
12829     */
12830
12831    /**
12832     * @enum _Elm_Gesture_Types
12833     * Enum of supported gesture types.
12834     * @ingroup Elm_Gesture_Layer
12835     */
12836    enum _Elm_Gesture_Types
12837      {
12838         ELM_GESTURE_FIRST = 0,
12839
12840         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12841         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12842         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12843         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12844
12845         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12846
12847         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12848         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12849
12850         ELM_GESTURE_ZOOM, /**< Zoom */
12851         ELM_GESTURE_ROTATE, /**< Rotate */
12852
12853         ELM_GESTURE_LAST
12854      };
12855
12856    /**
12857     * @typedef Elm_Gesture_Types
12858     * gesture types enum
12859     * @ingroup Elm_Gesture_Layer
12860     */
12861    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12862
12863    /**
12864     * @enum _Elm_Gesture_State
12865     * Enum of gesture states.
12866     * @ingroup Elm_Gesture_Layer
12867     */
12868    enum _Elm_Gesture_State
12869      {
12870         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12871         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12872         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12873         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12874         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12875      };
12876
12877    /**
12878     * @typedef Elm_Gesture_State
12879     * gesture states enum
12880     * @ingroup Elm_Gesture_Layer
12881     */
12882    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12883
12884    /**
12885     * @struct _Elm_Gesture_Taps_Info
12886     * Struct holds taps info for user
12887     * @ingroup Elm_Gesture_Layer
12888     */
12889    struct _Elm_Gesture_Taps_Info
12890      {
12891         Evas_Coord x, y;         /**< Holds center point between fingers */
12892         unsigned int n;          /**< Number of fingers tapped           */
12893         unsigned int timestamp;  /**< event timestamp       */
12894      };
12895
12896    /**
12897     * @typedef Elm_Gesture_Taps_Info
12898     * holds taps info for user
12899     * @ingroup Elm_Gesture_Layer
12900     */
12901    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12902
12903    /**
12904     * @struct _Elm_Gesture_Momentum_Info
12905     * Struct holds momentum info for user
12906     * x1 and y1 are not necessarily in sync
12907     * x1 holds x value of x direction starting point
12908     * and same holds for y1.
12909     * This is noticeable when doing V-shape movement
12910     * @ingroup Elm_Gesture_Layer
12911     */
12912    struct _Elm_Gesture_Momentum_Info
12913      {  /* Report line ends, timestamps, and momentum computed        */
12914         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12915         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12916         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12917         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12918
12919         unsigned int tx; /**< Timestamp of start of final x-swipe */
12920         unsigned int ty; /**< Timestamp of start of final y-swipe */
12921
12922         Evas_Coord mx; /**< Momentum on X */
12923         Evas_Coord my; /**< Momentum on Y */
12924
12925         unsigned int n;  /**< Number of fingers */
12926      };
12927
12928    /**
12929     * @typedef Elm_Gesture_Momentum_Info
12930     * holds momentum info for user
12931     * @ingroup Elm_Gesture_Layer
12932     */
12933     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12934
12935    /**
12936     * @struct _Elm_Gesture_Line_Info
12937     * Struct holds line info for user
12938     * @ingroup Elm_Gesture_Layer
12939     */
12940    struct _Elm_Gesture_Line_Info
12941      {  /* Report line ends, timestamps, and momentum computed      */
12942         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12943         double angle;              /**< Angle (direction) of lines  */
12944      };
12945
12946    /**
12947     * @typedef Elm_Gesture_Line_Info
12948     * Holds line info for user
12949     * @ingroup Elm_Gesture_Layer
12950     */
12951     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12952
12953    /**
12954     * @struct _Elm_Gesture_Zoom_Info
12955     * Struct holds zoom info for user
12956     * @ingroup Elm_Gesture_Layer
12957     */
12958    struct _Elm_Gesture_Zoom_Info
12959      {
12960         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12961         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12962         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12963         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12964      };
12965
12966    /**
12967     * @typedef Elm_Gesture_Zoom_Info
12968     * Holds zoom info for user
12969     * @ingroup Elm_Gesture_Layer
12970     */
12971    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12972
12973    /**
12974     * @struct _Elm_Gesture_Rotate_Info
12975     * Struct holds rotation info for user
12976     * @ingroup Elm_Gesture_Layer
12977     */
12978    struct _Elm_Gesture_Rotate_Info
12979      {
12980         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12981         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12982         double base_angle; /**< Holds start-angle */
12983         double angle;      /**< Rotation value: 0.0 means no rotation         */
12984         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12985      };
12986
12987    /**
12988     * @typedef Elm_Gesture_Rotate_Info
12989     * Holds rotation info for user
12990     * @ingroup Elm_Gesture_Layer
12991     */
12992    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12993
12994    /**
12995     * @typedef Elm_Gesture_Event_Cb
12996     * User callback used to stream gesture info from gesture layer
12997     * @param data user data
12998     * @param event_info gesture report info
12999     * Returns a flag field to be applied on the causing event.
13000     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13001     * upon the event, in an irreversible way.
13002     *
13003     * @ingroup Elm_Gesture_Layer
13004     */
13005    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13006
13007    /**
13008     * Use function to set callbacks to be notified about
13009     * change of state of gesture.
13010     * When a user registers a callback with this function
13011     * this means this gesture has to be tested.
13012     *
13013     * When ALL callbacks for a gesture are set to NULL
13014     * it means user isn't interested in gesture-state
13015     * and it will not be tested.
13016     *
13017     * @param obj Pointer to gesture-layer.
13018     * @param idx The gesture you would like to track its state.
13019     * @param cb callback function pointer.
13020     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13021     * @param data user info to be sent to callback (usually, Smart Data)
13022     *
13023     * @ingroup Elm_Gesture_Layer
13024     */
13025    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);
13026
13027    /**
13028     * Call this function to get repeat-events settings.
13029     *
13030     * @param obj Pointer to gesture-layer.
13031     *
13032     * @return repeat events settings.
13033     * @see elm_gesture_layer_hold_events_set()
13034     * @ingroup Elm_Gesture_Layer
13035     */
13036    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13037
13038    /**
13039     * This function called in order to make gesture-layer repeat events.
13040     * Set this of you like to get the raw events only if gestures were not detected.
13041     * Clear this if you like gesture layer to fwd events as testing gestures.
13042     *
13043     * @param obj Pointer to gesture-layer.
13044     * @param r Repeat: TRUE/FALSE
13045     *
13046     * @ingroup Elm_Gesture_Layer
13047     */
13048    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13049
13050    /**
13051     * This function sets step-value for zoom action.
13052     * Set step to any positive value.
13053     * Cancel step setting by setting to 0.0
13054     *
13055     * @param obj Pointer to gesture-layer.
13056     * @param s new zoom step value.
13057     *
13058     * @ingroup Elm_Gesture_Layer
13059     */
13060    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13061
13062    /**
13063     * This function sets step-value for rotate action.
13064     * Set step to any positive value.
13065     * Cancel step setting by setting to 0.0
13066     *
13067     * @param obj Pointer to gesture-layer.
13068     * @param s new roatate step value.
13069     *
13070     * @ingroup Elm_Gesture_Layer
13071     */
13072    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13073
13074    /**
13075     * This function called to attach gesture-layer to an Evas_Object.
13076     * @param obj Pointer to gesture-layer.
13077     * @param t Pointer to underlying object (AKA Target)
13078     *
13079     * @return TRUE, FALSE on success, failure.
13080     *
13081     * @ingroup Elm_Gesture_Layer
13082     */
13083    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13084
13085    /**
13086     * Call this function to construct a new gesture-layer object.
13087     * This does not activate the gesture layer. You have to
13088     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13089     *
13090     * @param parent the parent object.
13091     *
13092     * @return Pointer to new gesture-layer object.
13093     *
13094     * @ingroup Elm_Gesture_Layer
13095     */
13096    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13097
13098    /**
13099     * @defgroup Thumb Thumb
13100     *
13101     * @image html img/widget/thumb/preview-00.png
13102     * @image latex img/widget/thumb/preview-00.eps
13103     *
13104     * A thumb object is used for displaying the thumbnail of an image or video.
13105     * You must have compiled Elementary with Ethumb_Client support and the DBus
13106     * service must be present and auto-activated in order to have thumbnails to
13107     * be generated.
13108     *
13109     * Once the thumbnail object becomes visible, it will check if there is a
13110     * previously generated thumbnail image for the file set on it. If not, it
13111     * will start generating this thumbnail.
13112     *
13113     * Different config settings will cause different thumbnails to be generated
13114     * even on the same file.
13115     *
13116     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13117     * Ethumb documentation to change this path, and to see other configuration
13118     * options.
13119     *
13120     * Signals that you can add callbacks for are:
13121     *
13122     * - "clicked" - This is called when a user has clicked the thumb without dragging
13123     *             around.
13124     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13125     * - "press" - This is called when a user has pressed down the thumb.
13126     * - "generate,start" - The thumbnail generation started.
13127     * - "generate,stop" - The generation process stopped.
13128     * - "generate,error" - The generation failed.
13129     * - "load,error" - The thumbnail image loading failed.
13130     *
13131     * available styles:
13132     * - default
13133     * - noframe
13134     *
13135     * An example of use of thumbnail:
13136     *
13137     * - @ref thumb_example_01
13138     */
13139
13140    /**
13141     * @addtogroup Thumb
13142     * @{
13143     */
13144
13145    /**
13146     * @enum _Elm_Thumb_Animation_Setting
13147     * @typedef Elm_Thumb_Animation_Setting
13148     *
13149     * Used to set if a video thumbnail is animating or not.
13150     *
13151     * @ingroup Thumb
13152     */
13153    typedef enum _Elm_Thumb_Animation_Setting
13154      {
13155         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13156         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13157         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13158         ELM_THUMB_ANIMATION_LAST
13159      } Elm_Thumb_Animation_Setting;
13160
13161    /**
13162     * Add a new thumb object to the parent.
13163     *
13164     * @param parent The parent object.
13165     * @return The new object or NULL if it cannot be created.
13166     *
13167     * @see elm_thumb_file_set()
13168     * @see elm_thumb_ethumb_client_get()
13169     *
13170     * @ingroup Thumb
13171     */
13172    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13173    /**
13174     * Reload thumbnail if it was generated before.
13175     *
13176     * @param obj The thumb object to reload
13177     *
13178     * This is useful if the ethumb client configuration changed, like its
13179     * size, aspect or any other property one set in the handle returned
13180     * by elm_thumb_ethumb_client_get().
13181     *
13182     * If the options didn't change, the thumbnail won't be generated again, but
13183     * the old one will still be used.
13184     *
13185     * @see elm_thumb_file_set()
13186     *
13187     * @ingroup Thumb
13188     */
13189    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13190    /**
13191     * Set the file that will be used as thumbnail.
13192     *
13193     * @param obj The thumb object.
13194     * @param file The path to file that will be used as thumb.
13195     * @param key The key used in case of an EET file.
13196     *
13197     * The file can be an image or a video (in that case, acceptable extensions are:
13198     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13199     * function elm_thumb_animate().
13200     *
13201     * @see elm_thumb_file_get()
13202     * @see elm_thumb_reload()
13203     * @see elm_thumb_animate()
13204     *
13205     * @ingroup Thumb
13206     */
13207    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13208    /**
13209     * Get the image or video path and key used to generate the thumbnail.
13210     *
13211     * @param obj The thumb object.
13212     * @param file Pointer to filename.
13213     * @param key Pointer to key.
13214     *
13215     * @see elm_thumb_file_set()
13216     * @see elm_thumb_path_get()
13217     *
13218     * @ingroup Thumb
13219     */
13220    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13221    /**
13222     * Get the path and key to the image or video generated by ethumb.
13223     *
13224     * One just need to make sure that the thumbnail was generated before getting
13225     * its path; otherwise, the path will be NULL. One way to do that is by asking
13226     * for the path when/after the "generate,stop" smart callback is called.
13227     *
13228     * @param obj The thumb object.
13229     * @param file Pointer to thumb path.
13230     * @param key Pointer to thumb key.
13231     *
13232     * @see elm_thumb_file_get()
13233     *
13234     * @ingroup Thumb
13235     */
13236    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13237    /**
13238     * Set the animation state for the thumb object. If its content is an animated
13239     * video, you may start/stop the animation or tell it to play continuously and
13240     * looping.
13241     *
13242     * @param obj The thumb object.
13243     * @param setting The animation setting.
13244     *
13245     * @see elm_thumb_file_set()
13246     *
13247     * @ingroup Thumb
13248     */
13249    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13250    /**
13251     * Get the animation state for the thumb object.
13252     *
13253     * @param obj The thumb object.
13254     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13255     * on errors.
13256     *
13257     * @see elm_thumb_animate_set()
13258     *
13259     * @ingroup Thumb
13260     */
13261    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13262    /**
13263     * Get the ethumb_client handle so custom configuration can be made.
13264     *
13265     * @return Ethumb_Client instance or NULL.
13266     *
13267     * This must be called before the objects are created to be sure no object is
13268     * visible and no generation started.
13269     *
13270     * Example of usage:
13271     *
13272     * @code
13273     * #include <Elementary.h>
13274     * #ifndef ELM_LIB_QUICKLAUNCH
13275     * EAPI_MAIN int
13276     * elm_main(int argc, char **argv)
13277     * {
13278     *    Ethumb_Client *client;
13279     *
13280     *    elm_need_ethumb();
13281     *
13282     *    // ... your code
13283     *
13284     *    client = elm_thumb_ethumb_client_get();
13285     *    if (!client)
13286     *      {
13287     *         ERR("could not get ethumb_client");
13288     *         return 1;
13289     *      }
13290     *    ethumb_client_size_set(client, 100, 100);
13291     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13292     *    // ... your code
13293     *
13294     *    // Create elm_thumb objects here
13295     *
13296     *    elm_run();
13297     *    elm_shutdown();
13298     *    return 0;
13299     * }
13300     * #endif
13301     * ELM_MAIN()
13302     * @endcode
13303     *
13304     * @note There's only one client handle for Ethumb, so once a configuration
13305     * change is done to it, any other request for thumbnails (for any thumbnail
13306     * object) will use that configuration. Thus, this configuration is global.
13307     *
13308     * @ingroup Thumb
13309     */
13310    EAPI void                        *elm_thumb_ethumb_client_get(void);
13311    /**
13312     * Get the ethumb_client connection state.
13313     *
13314     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13315     * otherwise.
13316     */
13317    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13318    /**
13319     * Make the thumbnail 'editable'.
13320     *
13321     * @param obj Thumb object.
13322     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13323     *
13324     * This means the thumbnail is a valid drag target for drag and drop, and can be
13325     * cut or pasted too.
13326     *
13327     * @see elm_thumb_editable_get()
13328     *
13329     * @ingroup Thumb
13330     */
13331    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13332    /**
13333     * Make the thumbnail 'editable'.
13334     *
13335     * @param obj Thumb object.
13336     * @return Editability.
13337     *
13338     * This means the thumbnail is a valid drag target for drag and drop, and can be
13339     * cut or pasted too.
13340     *
13341     * @see elm_thumb_editable_set()
13342     *
13343     * @ingroup Thumb
13344     */
13345    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13346
13347    /**
13348     * @}
13349     */
13350
13351    /**
13352     * @defgroup Web Web
13353     *
13354     * @image html img/widget/web/preview-00.png
13355     * @image latex img/widget/web/preview-00.eps
13356     *
13357     * A web object is used for displaying web pages (HTML/CSS/JS)
13358     * using WebKit-EFL. You must have compiled Elementary with
13359     * ewebkit support.
13360     *
13361     * Signals that you can add callbacks for are:
13362     * @li "download,request": A file download has been requested. Event info is
13363     * a pointer to a Elm_Web_Download
13364     * @li "editorclient,contents,changed": Editor client's contents changed
13365     * @li "editorclient,selection,changed": Editor client's selection changed
13366     * @li "frame,created": A new frame was created. Event info is an
13367     * Evas_Object which can be handled with WebKit's ewk_frame API
13368     * @li "icon,received": An icon was received by the main frame
13369     * @li "inputmethod,changed": Input method changed. Event info is an
13370     * Eina_Bool indicating whether it's enabled or not
13371     * @li "js,windowobject,clear": JS window object has been cleared
13372     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13373     * is a char *link[2], where the first string contains the URL the link
13374     * points to, and the second one the title of the link
13375     * @li "link,hover,out": Mouse cursor left the link
13376     * @li "load,document,finished": Loading of a document finished. Event info
13377     * is the frame that finished loading
13378     * @li "load,error": Load failed. Event info is a pointer to
13379     * Elm_Web_Frame_Load_Error
13380     * @li "load,finished": Load finished. Event info is NULL on success, on
13381     * error it's a pointer to Elm_Web_Frame_Load_Error
13382     * @li "load,newwindow,show": A new window was created and is ready to be
13383     * shown
13384     * @li "load,progress": Overall load progress. Event info is a pointer to
13385     * a double containing a value between 0.0 and 1.0
13386     * @li "load,provisional": Started provisional load
13387     * @li "load,started": Loading of a document started
13388     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13389     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13390     * the menubar is visible, or EINA_FALSE in case it's not
13391     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13392     * an Eina_Bool indicating the visibility
13393     * @li "popup,created": A dropdown widget was activated, requesting its
13394     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13395     * @li "popup,willdelete": The web object is ready to destroy the popup
13396     * object created. Event info is a pointer to Elm_Web_Menu
13397     * @li "ready": Page is fully loaded
13398     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13399     * info is a pointer to Eina_Bool where the visibility state should be set
13400     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13401     * is an Eina_Bool with the visibility state set
13402     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13403     * a string with the new text
13404     * @li "statusbar,visible,get": Queries visibility of the status bar.
13405     * Event info is a pointer to Eina_Bool where the visibility state should be
13406     * set.
13407     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13408     * an Eina_Bool with the visibility value
13409     * @li "title,changed": Title of the main frame changed. Event info is a
13410     * string with the new title
13411     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13412     * is a pointer to Eina_Bool where the visibility state should be set
13413     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13414     * info is an Eina_Bool with the visibility state
13415     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13416     * a string with the text to show
13417     * @li "uri,changed": URI of the main frame changed. Event info is a string
13418     * with the new URI
13419     * @li "view,resized": The web object internal's view changed sized
13420     * @li "windows,close,request": A JavaScript request to close the current
13421     * window was requested
13422     * @li "zoom,animated,end": Animated zoom finished
13423     *
13424     * available styles:
13425     * - default
13426     *
13427     * An example of use of web:
13428     *
13429     * - @ref web_example_01 TBD
13430     */
13431
13432    /**
13433     * @addtogroup Web
13434     * @{
13435     */
13436
13437    /**
13438     * Structure used to report load errors.
13439     *
13440     * Load errors are reported as signal by elm_web. All the strings are
13441     * temporary references and should @b not be used after the signal
13442     * callback returns. If it's required, make copies with strdup() or
13443     * eina_stringshare_add() (they are not even guaranteed to be
13444     * stringshared, so must use eina_stringshare_add() and not
13445     * eina_stringshare_ref()).
13446     */
13447    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13448    /**
13449     * Structure used to report load errors.
13450     *
13451     * Load errors are reported as signal by elm_web. All the strings are
13452     * temporary references and should @b not be used after the signal
13453     * callback returns. If it's required, make copies with strdup() or
13454     * eina_stringshare_add() (they are not even guaranteed to be
13455     * stringshared, so must use eina_stringshare_add() and not
13456     * eina_stringshare_ref()).
13457     */
13458    struct _Elm_Web_Frame_Load_Error
13459      {
13460         int code; /**< Numeric error code */
13461         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13462         const char *domain; /**< Error domain name */
13463         const char *description; /**< Error description (already localized) */
13464         const char *failing_url; /**< The URL that failed to load */
13465         Evas_Object *frame; /**< Frame object that produced the error */
13466      };
13467
13468    /**
13469     * The possibles types that the items in a menu can be
13470     */
13471    typedef enum _Elm_Web_Menu_Item_Type
13472      {
13473         ELM_WEB_MENU_SEPARATOR,
13474         ELM_WEB_MENU_GROUP,
13475         ELM_WEB_MENU_OPTION
13476      } Elm_Web_Menu_Item_Type;
13477
13478    /**
13479     * Structure describing the items in a menu
13480     */
13481    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13482    /**
13483     * Structure describing the items in a menu
13484     */
13485    struct _Elm_Web_Menu_Item
13486      {
13487         const char *text; /**< The text for the item */
13488         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13489      };
13490
13491    /**
13492     * Structure describing the menu of a popup
13493     *
13494     * This structure will be passed as the @c event_info for the "popup,create"
13495     * signal, which is emitted when a dropdown menu is opened. Users wanting
13496     * to handle these popups by themselves should listen to this signal and
13497     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13498     * property as @c EINA_FALSE means that the user will not handle the popup
13499     * and the default implementation will be used.
13500     *
13501     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13502     * will be emitted to notify the user that it can destroy any objects and
13503     * free all data related to it.
13504     *
13505     * @see elm_web_popup_selected_set()
13506     * @see elm_web_popup_destroy()
13507     */
13508    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13509    /**
13510     * Structure describing the menu of a popup
13511     *
13512     * This structure will be passed as the @c event_info for the "popup,create"
13513     * signal, which is emitted when a dropdown menu is opened. Users wanting
13514     * to handle these popups by themselves should listen to this signal and
13515     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13516     * property as @c EINA_FALSE means that the user will not handle the popup
13517     * and the default implementation will be used.
13518     *
13519     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13520     * will be emitted to notify the user that it can destroy any objects and
13521     * free all data related to it.
13522     *
13523     * @see elm_web_popup_selected_set()
13524     * @see elm_web_popup_destroy()
13525     */
13526    struct _Elm_Web_Menu
13527      {
13528         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13529         int x; /**< The X position of the popup, relative to the elm_web object */
13530         int y; /**< The Y position of the popup, relative to the elm_web object */
13531         int width; /**< Width of the popup menu */
13532         int height; /**< Height of the popup menu */
13533
13534         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. */
13535      };
13536
13537    typedef struct _Elm_Web_Download Elm_Web_Download;
13538    struct _Elm_Web_Download
13539      {
13540         const char *url;
13541      };
13542
13543    /**
13544     * Types of zoom available.
13545     */
13546    typedef enum _Elm_Web_Zoom_Mode
13547      {
13548         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13549         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13550         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13551         ELM_WEB_ZOOM_MODE_LAST
13552      } Elm_Web_Zoom_Mode;
13553    /**
13554     * Opaque handler containing the features (such as statusbar, menubar, etc)
13555     * that are to be set on a newly requested window.
13556     */
13557    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13558    /**
13559     * Callback type for the create_window hook.
13560     *
13561     * The function parameters are:
13562     * @li @p data User data pointer set when setting the hook function
13563     * @li @p obj The elm_web object requesting the new window
13564     * @li @p js Set to @c EINA_TRUE if the request was originated from
13565     * JavaScript. @c EINA_FALSE otherwise.
13566     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13567     * the features requested for the new window.
13568     *
13569     * The returned value of the function should be the @c elm_web widget where
13570     * the request will be loaded. That is, if a new window or tab is created,
13571     * the elm_web widget in it should be returned, and @b NOT the window
13572     * object.
13573     * Returning @c NULL should cancel the request.
13574     *
13575     * @see elm_web_window_create_hook_set()
13576     */
13577    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13578    /**
13579     * Callback type for the JS alert hook.
13580     *
13581     * The function parameters are:
13582     * @li @p data User data pointer set when setting the hook function
13583     * @li @p obj The elm_web object requesting the new window
13584     * @li @p message The message to show in the alert dialog
13585     *
13586     * The function should return the object representing the alert dialog.
13587     * Elm_Web will run a second main loop to handle the dialog and normal
13588     * flow of the application will be restored when the object is deleted, so
13589     * the user should handle the popup properly in order to delete the object
13590     * when the action is finished.
13591     * If the function returns @c NULL the popup will be ignored.
13592     *
13593     * @see elm_web_dialog_alert_hook_set()
13594     */
13595    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13596    /**
13597     * Callback type for the JS confirm hook.
13598     *
13599     * The function parameters are:
13600     * @li @p data User data pointer set when setting the hook function
13601     * @li @p obj The elm_web object requesting the new window
13602     * @li @p message The message to show in the confirm dialog
13603     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13604     * the user selected @c Ok, @c EINA_FALSE otherwise.
13605     *
13606     * The function should return the object representing the confirm dialog.
13607     * Elm_Web will run a second main loop to handle the dialog and normal
13608     * flow of the application will be restored when the object is deleted, so
13609     * the user should handle the popup properly in order to delete the object
13610     * when the action is finished.
13611     * If the function returns @c NULL the popup will be ignored.
13612     *
13613     * @see elm_web_dialog_confirm_hook_set()
13614     */
13615    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13616    /**
13617     * Callback type for the JS prompt hook.
13618     *
13619     * The function parameters are:
13620     * @li @p data User data pointer set when setting the hook function
13621     * @li @p obj The elm_web object requesting the new window
13622     * @li @p message The message to show in the prompt dialog
13623     * @li @p def_value The default value to present the user in the entry
13624     * @li @p value Pointer where to store the value given by the user. Must
13625     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13626     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13627     * the user selected @c Ok, @c EINA_FALSE otherwise.
13628     *
13629     * The function should return the object representing the prompt dialog.
13630     * Elm_Web will run a second main loop to handle the dialog and normal
13631     * flow of the application will be restored when the object is deleted, so
13632     * the user should handle the popup properly in order to delete the object
13633     * when the action is finished.
13634     * If the function returns @c NULL the popup will be ignored.
13635     *
13636     * @see elm_web_dialog_prompt_hook_set()
13637     */
13638    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13639    /**
13640     * Callback type for the JS file selector hook.
13641     *
13642     * The function parameters are:
13643     * @li @p data User data pointer set when setting the hook function
13644     * @li @p obj The elm_web object requesting the new window
13645     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13646     * @li @p accept_types Mime types accepted
13647     * @li @p selected Pointer where to store the list of malloc'ed strings
13648     * containing the path to each file selected. Must be @c NULL if the file
13649     * dialog is cancelled
13650     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13651     * the user selected @c Ok, @c EINA_FALSE otherwise.
13652     *
13653     * The function should return the object representing the file selector
13654     * dialog.
13655     * Elm_Web will run a second main loop to handle the dialog and normal
13656     * flow of the application will be restored when the object is deleted, so
13657     * the user should handle the popup properly in order to delete the object
13658     * when the action is finished.
13659     * If the function returns @c NULL the popup will be ignored.
13660     *
13661     * @see elm_web_dialog_file selector_hook_set()
13662     */
13663    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);
13664    /**
13665     * Callback type for the JS console message hook.
13666     *
13667     * When a console message is added from JavaScript, any set function to the
13668     * console message hook will be called for the user to handle. There is no
13669     * default implementation of this hook.
13670     *
13671     * The function parameters are:
13672     * @li @p data User data pointer set when setting the hook function
13673     * @li @p obj The elm_web object that originated the message
13674     * @li @p message The message sent
13675     * @li @p line_number The line number
13676     * @li @p source_id Source id
13677     *
13678     * @see elm_web_console_message_hook_set()
13679     */
13680    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13681    /**
13682     * Add a new web object to the parent.
13683     *
13684     * @param parent The parent object.
13685     * @return The new object or NULL if it cannot be created.
13686     *
13687     * @see elm_web_uri_set()
13688     * @see elm_web_webkit_view_get()
13689     */
13690    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13691
13692    /**
13693     * Get internal ewk_view object from web object.
13694     *
13695     * Elementary may not provide some low level features of EWebKit,
13696     * instead of cluttering the API with proxy methods we opted to
13697     * return the internal reference. Be careful using it as it may
13698     * interfere with elm_web behavior.
13699     *
13700     * @param obj The web object.
13701     * @return The internal ewk_view object or NULL if it does not
13702     *         exist. (Failure to create or Elementary compiled without
13703     *         ewebkit)
13704     *
13705     * @see elm_web_add()
13706     */
13707    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13708
13709    /**
13710     * Sets the function to call when a new window is requested
13711     *
13712     * This hook will be called when a request to create a new window is
13713     * issued from the web page loaded.
13714     * There is no default implementation for this feature, so leaving this
13715     * unset or passing @c NULL in @p func will prevent new windows from
13716     * opening.
13717     *
13718     * @param obj The web object where to set the hook function
13719     * @param func The hook function to be called when a window is requested
13720     * @param data User data
13721     */
13722    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13723    /**
13724     * Sets the function to call when an alert dialog
13725     *
13726     * This hook will be called when a JavaScript alert dialog is requested.
13727     * If no function is set or @c NULL is passed in @p func, the default
13728     * implementation will take place.
13729     *
13730     * @param obj The web object where to set the hook function
13731     * @param func The callback function to be used
13732     * @param data User data
13733     *
13734     * @see elm_web_inwin_mode_set()
13735     */
13736    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13737    /**
13738     * Sets the function to call when an confirm dialog
13739     *
13740     * This hook will be called when a JavaScript confirm dialog is requested.
13741     * If no function is set or @c NULL is passed in @p func, the default
13742     * implementation will take place.
13743     *
13744     * @param obj The web object where to set the hook function
13745     * @param func The callback function to be used
13746     * @param data User data
13747     *
13748     * @see elm_web_inwin_mode_set()
13749     */
13750    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13751    /**
13752     * Sets the function to call when an prompt dialog
13753     *
13754     * This hook will be called when a JavaScript prompt dialog is requested.
13755     * If no function is set or @c NULL is passed in @p func, the default
13756     * implementation will take place.
13757     *
13758     * @param obj The web object where to set the hook function
13759     * @param func The callback function to be used
13760     * @param data User data
13761     *
13762     * @see elm_web_inwin_mode_set()
13763     */
13764    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13765    /**
13766     * Sets the function to call when an file selector dialog
13767     *
13768     * This hook will be called when a JavaScript file selector dialog is
13769     * requested.
13770     * If no function is set or @c NULL is passed in @p func, the default
13771     * implementation will take place.
13772     *
13773     * @param obj The web object where to set the hook function
13774     * @param func The callback function to be used
13775     * @param data User data
13776     *
13777     * @see elm_web_inwin_mode_set()
13778     */
13779    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13780    /**
13781     * Sets the function to call when a console message is emitted from JS
13782     *
13783     * This hook will be called when a console message is emitted from
13784     * JavaScript. There is no default implementation for this feature.
13785     *
13786     * @param obj The web object where to set the hook function
13787     * @param func The callback function to be used
13788     * @param data User data
13789     */
13790    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13791    /**
13792     * Gets the status of the tab propagation
13793     *
13794     * @param obj The web object to query
13795     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13796     *
13797     * @see elm_web_tab_propagate_set()
13798     */
13799    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13800    /**
13801     * Sets whether to use tab propagation
13802     *
13803     * If tab propagation is enabled, whenever the user presses the Tab key,
13804     * Elementary will handle it and switch focus to the next widget.
13805     * The default value is disabled, where WebKit will handle the Tab key to
13806     * cycle focus though its internal objects, jumping to the next widget
13807     * only when that cycle ends.
13808     *
13809     * @param obj The web object
13810     * @param propagate Whether to propagate Tab keys to Elementary or not
13811     */
13812    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13813    /**
13814     * Sets the URI for the web object
13815     *
13816     * It must be a full URI, with resource included, in the form
13817     * http://www.enlightenment.org or file:///tmp/something.html
13818     *
13819     * @param obj The web object
13820     * @param uri The URI to set
13821     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13822     */
13823    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13824    /**
13825     * Gets the current URI for the object
13826     *
13827     * The returned string must not be freed and is guaranteed to be
13828     * stringshared.
13829     *
13830     * @param obj The web object
13831     * @return A stringshared internal string with the current URI, or NULL on
13832     * failure
13833     */
13834    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13835    /**
13836     * Gets the current title
13837     *
13838     * The returned string must not be freed and is guaranteed to be
13839     * stringshared.
13840     *
13841     * @param obj The web object
13842     * @return A stringshared internal string with the current title, or NULL on
13843     * failure
13844     */
13845    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13846    /**
13847     * Sets the background color to be used by the web object
13848     *
13849     * This is the color that will be used by default when the loaded page
13850     * does not set it's own. Color values are pre-multiplied.
13851     *
13852     * @param obj The web object
13853     * @param r Red component
13854     * @param g Green component
13855     * @param b Blue component
13856     * @param a Alpha component
13857     */
13858    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13859    /**
13860     * Gets the background color to be used by the web object
13861     *
13862     * This is the color that will be used by default when the loaded page
13863     * does not set it's own. Color values are pre-multiplied.
13864     *
13865     * @param obj The web object
13866     * @param r Red component
13867     * @param g Green component
13868     * @param b Blue component
13869     * @param a Alpha component
13870     */
13871    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13872    /**
13873     * Gets a copy of the currently selected text
13874     *
13875     * The string returned must be freed by the user when it's done with it.
13876     *
13877     * @param obj The web object
13878     * @return A newly allocated string, or NULL if nothing is selected or an
13879     * error occurred
13880     */
13881    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13882    /**
13883     * Tells the web object which index in the currently open popup was selected
13884     *
13885     * When the user handles the popup creation from the "popup,created" signal,
13886     * it needs to tell the web object which item was selected by calling this
13887     * function with the index corresponding to the item.
13888     *
13889     * @param obj The web object
13890     * @param index The index selected
13891     *
13892     * @see elm_web_popup_destroy()
13893     */
13894    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13895    /**
13896     * Dismisses an open dropdown popup
13897     *
13898     * When the popup from a dropdown widget is to be dismissed, either after
13899     * selecting an option or to cancel it, this function must be called, which
13900     * will later emit an "popup,willdelete" signal to notify the user that
13901     * any memory and objects related to this popup can be freed.
13902     *
13903     * @param obj The web object
13904     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13905     * if there was no menu to destroy
13906     */
13907    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13908    /**
13909     * Searches the given string in a document.
13910     *
13911     * @param obj The web object where to search the text
13912     * @param string String to search
13913     * @param case_sensitive If search should be case sensitive or not
13914     * @param forward If search is from cursor and on or backwards
13915     * @param wrap If search should wrap at the end
13916     *
13917     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13918     * or failure
13919     */
13920    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13921    /**
13922     * Marks matches of the given string in a document.
13923     *
13924     * @param obj The web object where to search text
13925     * @param string String to match
13926     * @param case_sensitive If match should be case sensitive or not
13927     * @param highlight If matches should be highlighted
13928     * @param limit Maximum amount of matches, or zero to unlimited
13929     *
13930     * @return number of matched @a string
13931     */
13932    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13933    /**
13934     * Clears all marked matches in the document
13935     *
13936     * @param obj The web object
13937     *
13938     * @return EINA_TRUE on success, EINA_FALSE otherwise
13939     */
13940    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13941    /**
13942     * Sets whether to highlight the matched marks
13943     *
13944     * If enabled, marks set with elm_web_text_matches_mark() will be
13945     * highlighted.
13946     *
13947     * @param obj The web object
13948     * @param highlight Whether to highlight the marks or not
13949     *
13950     * @return EINA_TRUE on success, EINA_FALSE otherwise
13951     */
13952    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13953    /**
13954     * Gets whether highlighting marks is enabled
13955     *
13956     * @param The web object
13957     *
13958     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13959     * otherwise
13960     */
13961    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13962    /**
13963     * Gets the overall loading progress of the page
13964     *
13965     * Returns the estimated loading progress of the page, with a value between
13966     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13967     * included in the page.
13968     *
13969     * @param The web object
13970     *
13971     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13972     * failure
13973     */
13974    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13975    /**
13976     * Stops loading the current page
13977     *
13978     * Cancels the loading of the current page in the web object. This will
13979     * cause a "load,error" signal to be emitted, with the is_cancellation
13980     * flag set to EINA_TRUE.
13981     *
13982     * @param obj The web object
13983     *
13984     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13985     */
13986    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13987    /**
13988     * Requests a reload of the current document in the object
13989     *
13990     * @param obj The web object
13991     *
13992     * @return EINA_TRUE on success, EINA_FALSE otherwise
13993     */
13994    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13995    /**
13996     * Requests a reload of the current document, avoiding any existing caches
13997     *
13998     * @param obj The web object
13999     *
14000     * @return EINA_TRUE on success, EINA_FALSE otherwise
14001     */
14002    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
14003    /**
14004     * Goes back one step in the browsing history
14005     *
14006     * This is equivalent to calling elm_web_object_navigate(obj, -1);
14007     *
14008     * @param obj The web object
14009     *
14010     * @return EINA_TRUE on success, EINA_FALSE otherwise
14011     *
14012     * @see elm_web_history_enable_set()
14013     * @see elm_web_back_possible()
14014     * @see elm_web_forward()
14015     * @see elm_web_navigate()
14016     */
14017    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
14018    /**
14019     * Goes forward one step in the browsing history
14020     *
14021     * This is equivalent to calling elm_web_object_navigate(obj, 1);
14022     *
14023     * @param obj The web object
14024     *
14025     * @return EINA_TRUE on success, EINA_FALSE otherwise
14026     *
14027     * @see elm_web_history_enable_set()
14028     * @see elm_web_forward_possible()
14029     * @see elm_web_back()
14030     * @see elm_web_navigate()
14031     */
14032    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14033    /**
14034     * Jumps the given number of steps in the browsing history
14035     *
14036     * The @p steps value can be a negative integer to back in history, or a
14037     * positive to move forward.
14038     *
14039     * @param obj The web object
14040     * @param steps The number of steps to jump
14041     *
14042     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14043     * history exists to jump the given number of steps
14044     *
14045     * @see elm_web_history_enable_set()
14046     * @see elm_web_navigate_possible()
14047     * @see elm_web_back()
14048     * @see elm_web_forward()
14049     */
14050    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14051    /**
14052     * Queries whether it's possible to go back in history
14053     *
14054     * @param obj The web object
14055     *
14056     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14057     * otherwise
14058     */
14059    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14060    /**
14061     * Queries whether it's possible to go forward in history
14062     *
14063     * @param obj The web object
14064     *
14065     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14066     * otherwise
14067     */
14068    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14069    /**
14070     * Queries whether it's possible to jump the given number of steps
14071     *
14072     * The @p steps value can be a negative integer to back in history, or a
14073     * positive to move forward.
14074     *
14075     * @param obj The web object
14076     * @param steps The number of steps to check for
14077     *
14078     * @return EINA_TRUE if enough history exists to perform the given jump,
14079     * EINA_FALSE otherwise
14080     */
14081    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14082    /**
14083     * Gets whether browsing history is enabled for the given object
14084     *
14085     * @param obj The web object
14086     *
14087     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14088     */
14089    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14090    /**
14091     * Enables or disables the browsing history
14092     *
14093     * @param obj The web object
14094     * @param enable Whether to enable or disable the browsing history
14095     */
14096    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14097    /**
14098     * Sets the zoom level of the web object
14099     *
14100     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14101     * values meaning zoom in and lower meaning zoom out. This function will
14102     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14103     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14104     *
14105     * @param obj The web object
14106     * @param zoom The zoom level to set
14107     */
14108    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14109    /**
14110     * Gets the current zoom level set on the web object
14111     *
14112     * Note that this is the zoom level set on the web object and not that
14113     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14114     * the two zoom levels should match, but for the other two modes the
14115     * Webkit zoom is calculated internally to match the chosen mode without
14116     * changing the zoom level set for the web object.
14117     *
14118     * @param obj The web object
14119     *
14120     * @return The zoom level set on the object
14121     */
14122    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14123    /**
14124     * Sets the zoom mode to use
14125     *
14126     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14127     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14128     *
14129     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14130     * with the elm_web_zoom_set() function.
14131     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14132     * make sure the entirety of the web object's contents are shown.
14133     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14134     * fit the contents in the web object's size, without leaving any space
14135     * unused.
14136     *
14137     * @param obj The web object
14138     * @param mode The mode to set
14139     */
14140    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14141    /**
14142     * Gets the currently set zoom mode
14143     *
14144     * @param obj The web object
14145     *
14146     * @return The current zoom mode set for the object, or
14147     * ::ELM_WEB_ZOOM_MODE_LAST on error
14148     */
14149    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14150    /**
14151     * Shows the given region in the web object
14152     *
14153     * @param obj The web object
14154     * @param x The x coordinate of the region to show
14155     * @param y The y coordinate of the region to show
14156     * @param w The width of the region to show
14157     * @param h The height of the region to show
14158     */
14159    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14160    /**
14161     * Brings in the region to the visible area
14162     *
14163     * Like elm_web_region_show(), but it animates the scrolling of the object
14164     * to show the area
14165     *
14166     * @param obj The web object
14167     * @param x The x coordinate of the region to show
14168     * @param y The y coordinate of the region to show
14169     * @param w The width of the region to show
14170     * @param h The height of the region to show
14171     */
14172    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14173    /**
14174     * Sets the default dialogs to use an Inwin instead of a normal window
14175     *
14176     * If set, then the default implementation for the JavaScript dialogs and
14177     * file selector will be opened in an Inwin. Otherwise they will use a
14178     * normal separated window.
14179     *
14180     * @param obj The web object
14181     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14182     */
14183    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14184    /**
14185     * Gets whether Inwin mode is set for the current object
14186     *
14187     * @param obj The web object
14188     *
14189     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14190     */
14191    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14192
14193    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14194    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14195    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);
14196    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14197
14198    /**
14199     * @}
14200     */
14201
14202    /**
14203     * @defgroup Hoversel Hoversel
14204     *
14205     * @image html img/widget/hoversel/preview-00.png
14206     * @image latex img/widget/hoversel/preview-00.eps
14207     *
14208     * A hoversel is a button that pops up a list of items (automatically
14209     * choosing the direction to display) that have a label and, optionally, an
14210     * icon to select from. It is a convenience widget to avoid the need to do
14211     * all the piecing together yourself. It is intended for a small number of
14212     * items in the hoversel menu (no more than 8), though is capable of many
14213     * more.
14214     *
14215     * Signals that you can add callbacks for are:
14216     * "clicked" - the user clicked the hoversel button and popped up the sel
14217     * "selected" - an item in the hoversel list is selected. event_info is the item
14218     * "dismissed" - the hover is dismissed
14219     *
14220     * See @ref tutorial_hoversel for an example.
14221     * @{
14222     */
14223    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14224    /**
14225     * @brief Add a new Hoversel object
14226     *
14227     * @param parent The parent object
14228     * @return The new object or NULL if it cannot be created
14229     */
14230    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14231    /**
14232     * @brief This sets the hoversel to expand horizontally.
14233     *
14234     * @param obj The hoversel object
14235     * @param horizontal If true, the hover will expand horizontally to the
14236     * right.
14237     *
14238     * @note The initial button will display horizontally regardless of this
14239     * setting.
14240     */
14241    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14242    /**
14243     * @brief This returns whether the hoversel is set to expand horizontally.
14244     *
14245     * @param obj The hoversel object
14246     * @return If true, the hover will expand horizontally to the right.
14247     *
14248     * @see elm_hoversel_horizontal_set()
14249     */
14250    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14251    /**
14252     * @brief Set the Hover parent
14253     *
14254     * @param obj The hoversel object
14255     * @param parent The parent to use
14256     *
14257     * Sets the hover parent object, the area that will be darkened when the
14258     * hoversel is clicked. Should probably be the window that the hoversel is
14259     * in. See @ref Hover objects for more information.
14260     */
14261    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14262    /**
14263     * @brief Get the Hover parent
14264     *
14265     * @param obj The hoversel object
14266     * @return The used parent
14267     *
14268     * Gets the hover parent object.
14269     *
14270     * @see elm_hoversel_hover_parent_set()
14271     */
14272    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14273    /**
14274     * @brief Set the hoversel button label
14275     *
14276     * @param obj The hoversel object
14277     * @param label The label text.
14278     *
14279     * This sets the label of the button that is always visible (before it is
14280     * clicked and expanded).
14281     *
14282     * @deprecated elm_object_text_set()
14283     */
14284    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14285    /**
14286     * @brief Get the hoversel button label
14287     *
14288     * @param obj The hoversel object
14289     * @return The label text.
14290     *
14291     * @deprecated elm_object_text_get()
14292     */
14293    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14294    /**
14295     * @brief Set the icon of the hoversel button
14296     *
14297     * @param obj The hoversel object
14298     * @param icon The icon object
14299     *
14300     * Sets the icon of the button that is always visible (before it is clicked
14301     * and expanded).  Once the icon object is set, a previously set one will be
14302     * deleted, if you want to keep that old content object, use the
14303     * elm_hoversel_icon_unset() function.
14304     *
14305     * @see elm_object_content_set() for the button widget
14306     */
14307    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14308    /**
14309     * @brief Get the icon of the hoversel button
14310     *
14311     * @param obj The hoversel object
14312     * @return The icon object
14313     *
14314     * Get the icon of the button that is always visible (before it is clicked
14315     * and expanded). Also see elm_object_content_get() for the button widget.
14316     *
14317     * @see elm_hoversel_icon_set()
14318     */
14319    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14320    /**
14321     * @brief Get and unparent the icon of the hoversel button
14322     *
14323     * @param obj The hoversel object
14324     * @return The icon object that was being used
14325     *
14326     * Unparent and return the icon of the button that is always visible
14327     * (before it is clicked and expanded).
14328     *
14329     * @see elm_hoversel_icon_set()
14330     * @see elm_object_content_unset() for the button widget
14331     */
14332    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14333    /**
14334     * @brief This triggers the hoversel popup from code, the same as if the user
14335     * had clicked the button.
14336     *
14337     * @param obj The hoversel object
14338     */
14339    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14340    /**
14341     * @brief This dismisses the hoversel popup as if the user had clicked
14342     * outside the hover.
14343     *
14344     * @param obj The hoversel object
14345     */
14346    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14347    /**
14348     * @brief Returns whether the hoversel is expanded.
14349     *
14350     * @param obj The hoversel object
14351     * @return  This will return EINA_TRUE if the hoversel is expanded or
14352     * EINA_FALSE if it is not expanded.
14353     */
14354    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14355    /**
14356     * @brief This will remove all the children items from the hoversel.
14357     *
14358     * @param obj The hoversel object
14359     *
14360     * @warning Should @b not be called while the hoversel is active; use
14361     * elm_hoversel_expanded_get() to check first.
14362     *
14363     * @see elm_hoversel_item_del_cb_set()
14364     * @see elm_hoversel_item_del()
14365     */
14366    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14367    /**
14368     * @brief Get the list of items within the given hoversel.
14369     *
14370     * @param obj The hoversel object
14371     * @return Returns a list of Elm_Hoversel_Item*
14372     *
14373     * @see elm_hoversel_item_add()
14374     */
14375    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14376    /**
14377     * @brief Add an item to the hoversel button
14378     *
14379     * @param obj The hoversel object
14380     * @param label The text label to use for the item (NULL if not desired)
14381     * @param icon_file An image file path on disk to use for the icon or standard
14382     * icon name (NULL if not desired)
14383     * @param icon_type The icon type if relevant
14384     * @param func Convenience function to call when this item is selected
14385     * @param data Data to pass to item-related functions
14386     * @return A handle to the item added.
14387     *
14388     * This adds an item to the hoversel to show when it is clicked. Note: if you
14389     * need to use an icon from an edje file then use
14390     * elm_hoversel_item_icon_set() right after the this function, and set
14391     * icon_file to NULL here.
14392     *
14393     * For more information on what @p icon_file and @p icon_type are see the
14394     * @ref Icon "icon documentation".
14395     */
14396    EAPI Elm_Hoversel_Item *elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14397    /**
14398     * @brief Delete an item from the hoversel
14399     *
14400     * @param item The item to delete
14401     *
14402     * This deletes the item from the hoversel (should not be called while the
14403     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14404     *
14405     * @see elm_hoversel_item_add()
14406     * @see elm_hoversel_item_del_cb_set()
14407     */
14408    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14409    /**
14410     * @brief Set the function to be called when an item from the hoversel is
14411     * freed.
14412     *
14413     * @param item The item to set the callback on
14414     * @param func The function called
14415     *
14416     * That function will receive these parameters:
14417     * @li void *item_data
14418     * @li Evas_Object *the_item_object
14419     * @li Elm_Hoversel_Item *the_object_struct
14420     *
14421     * @see elm_hoversel_item_add()
14422     */
14423    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14424    /**
14425     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14426     * that will be passed to associated function callbacks.
14427     *
14428     * @param item The item to get the data from
14429     * @return The data pointer set with elm_hoversel_item_add()
14430     *
14431     * @see elm_hoversel_item_add()
14432     */
14433    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14434    /**
14435     * @brief This returns the label text of the given hoversel item.
14436     *
14437     * @param item The item to get the label
14438     * @return The label text of the hoversel item
14439     *
14440     * @see elm_hoversel_item_add()
14441     */
14442    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14443    /**
14444     * @brief This sets the icon for the given hoversel item.
14445     *
14446     * @param item The item to set the icon
14447     * @param icon_file An image file path on disk to use for the icon or standard
14448     * icon name
14449     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14450     * to NULL if the icon is not an edje file
14451     * @param icon_type The icon type
14452     *
14453     * The icon can be loaded from the standard set, from an image file, or from
14454     * an edje file.
14455     *
14456     * @see elm_hoversel_item_add()
14457     */
14458    EAPI void               elm_hoversel_item_icon_set(Elm_Hoversel_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
14459    /**
14460     * @brief Get the icon object of the hoversel item
14461     *
14462     * @param item The item to get the icon from
14463     * @param icon_file The image file path on disk used for the icon or standard
14464     * icon name
14465     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14466     * if the icon is not an edje file
14467     * @param icon_type The icon type
14468     *
14469     * @see elm_hoversel_item_icon_set()
14470     * @see elm_hoversel_item_add()
14471     */
14472    EAPI void               elm_hoversel_item_icon_get(const Elm_Hoversel_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
14473    /**
14474     * @}
14475     */
14476
14477    /**
14478     * @defgroup Toolbar Toolbar
14479     * @ingroup Elementary
14480     *
14481     * @image html img/widget/toolbar/preview-00.png
14482     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14483     *
14484     * @image html img/toolbar.png
14485     * @image latex img/toolbar.eps width=\textwidth
14486     *
14487     * A toolbar is a widget that displays a list of items inside
14488     * a box. It can be scrollable, show a menu with items that don't fit
14489     * to toolbar size or even crop them.
14490     *
14491     * Only one item can be selected at a time.
14492     *
14493     * Items can have multiple states, or show menus when selected by the user.
14494     *
14495     * Smart callbacks one can listen to:
14496     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14497     * - "language,changed" - when the program language changes
14498     *
14499     * Available styles for it:
14500     * - @c "default"
14501     * - @c "transparent" - no background or shadow, just show the content
14502     *
14503     * List of examples:
14504     * @li @ref toolbar_example_01
14505     * @li @ref toolbar_example_02
14506     * @li @ref toolbar_example_03
14507     */
14508
14509    /**
14510     * @addtogroup Toolbar
14511     * @{
14512     */
14513
14514    /**
14515     * @enum _Elm_Toolbar_Shrink_Mode
14516     * @typedef Elm_Toolbar_Shrink_Mode
14517     *
14518     * Set toolbar's items display behavior, it can be scrollabel,
14519     * show a menu with exceeding items, or simply hide them.
14520     *
14521     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14522     * from elm config.
14523     *
14524     * Values <b> don't </b> work as bitmask, only one can be choosen.
14525     *
14526     * @see elm_toolbar_mode_shrink_set()
14527     * @see elm_toolbar_mode_shrink_get()
14528     *
14529     * @ingroup Toolbar
14530     */
14531    typedef enum _Elm_Toolbar_Shrink_Mode
14532      {
14533         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14534         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14535         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14536         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14537         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14538      } Elm_Toolbar_Shrink_Mode;
14539
14540    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
14541
14542    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(). */
14543
14544    /**
14545     * Add a new toolbar widget to the given parent Elementary
14546     * (container) object.
14547     *
14548     * @param parent The parent object.
14549     * @return a new toolbar widget handle or @c NULL, on errors.
14550     *
14551     * This function inserts a new toolbar widget on the canvas.
14552     *
14553     * @ingroup Toolbar
14554     */
14555    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14556
14557    /**
14558     * Set the icon size, in pixels, to be used by toolbar items.
14559     *
14560     * @param obj The toolbar object
14561     * @param icon_size The icon size in pixels
14562     *
14563     * @note Default value is @c 32. It reads value from elm config.
14564     *
14565     * @see elm_toolbar_icon_size_get()
14566     *
14567     * @ingroup Toolbar
14568     */
14569    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14570
14571    /**
14572     * Get the icon size, in pixels, to be used by toolbar items.
14573     *
14574     * @param obj The toolbar object.
14575     * @return The icon size in pixels.
14576     *
14577     * @see elm_toolbar_icon_size_set() for details.
14578     *
14579     * @ingroup Toolbar
14580     */
14581    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14582
14583    /**
14584     * Sets icon lookup order, for toolbar items' icons.
14585     *
14586     * @param obj The toolbar object.
14587     * @param order The icon lookup order.
14588     *
14589     * Icons added before calling this function will not be affected.
14590     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14591     *
14592     * @see elm_toolbar_icon_order_lookup_get()
14593     *
14594     * @ingroup Toolbar
14595     */
14596    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14597
14598    /**
14599     * Gets the icon lookup order.
14600     *
14601     * @param obj The toolbar object.
14602     * @return The icon lookup order.
14603     *
14604     * @see elm_toolbar_icon_order_lookup_set() for details.
14605     *
14606     * @ingroup Toolbar
14607     */
14608    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14609
14610    /**
14611     * Set whether the toolbar should always have an item selected.
14612     *
14613     * @param obj The toolbar object.
14614     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14615     * disable it.
14616     *
14617     * This will cause the toolbar to always have an item selected, and clicking
14618     * the selected item will not cause a selected event to be emitted. Enabling this mode
14619     * will immediately select the first toolbar item.
14620     *
14621     * Always-selected is disabled by default.
14622     *
14623     * @see elm_toolbar_always_select_mode_get().
14624     *
14625     * @ingroup Toolbar
14626     */
14627    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14628
14629    /**
14630     * Get whether the toolbar should always have an item selected.
14631     *
14632     * @param obj The toolbar object.
14633     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14634     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14635     *
14636     * @see elm_toolbar_always_select_mode_set() for details.
14637     *
14638     * @ingroup Toolbar
14639     */
14640    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14641
14642    /**
14643     * Set whether the toolbar items' should be selected by the user or not.
14644     *
14645     * @param obj The toolbar object.
14646     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14647     * enable it.
14648     *
14649     * This will turn off the ability to select items entirely and they will
14650     * neither appear selected nor emit selected signals. The clicked
14651     * callback function will still be called.
14652     *
14653     * Selection is enabled by default.
14654     *
14655     * @see elm_toolbar_no_select_mode_get().
14656     *
14657     * @ingroup Toolbar
14658     */
14659    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14660
14661    /**
14662     * Set whether the toolbar items' should be selected by the user or not.
14663     *
14664     * @param obj The toolbar object.
14665     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14666     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14667     *
14668     * @see elm_toolbar_no_select_mode_set() for details.
14669     *
14670     * @ingroup Toolbar
14671     */
14672    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14673
14674    /**
14675     * Append item to the toolbar.
14676     *
14677     * @param obj The toolbar object.
14678     * @param icon A string with icon name or the absolute path of an image file.
14679     * @param label The label of the item.
14680     * @param func The function to call when the item is clicked.
14681     * @param data The data to associate with the item for related callbacks.
14682     * @return The created item or @c NULL upon failure.
14683     *
14684     * A new item will be created and appended to the toolbar, i.e., will
14685     * be set as @b last item.
14686     *
14687     * Items created with this method can be deleted with
14688     * elm_toolbar_item_del().
14689     *
14690     * Associated @p data can be properly freed when item is deleted if a
14691     * callback function is set with elm_toolbar_item_del_cb_set().
14692     *
14693     * If a function is passed as argument, it will be called everytime this item
14694     * is selected, i.e., the user clicks over an unselected item.
14695     * If such function isn't needed, just passing
14696     * @c NULL as @p func is enough. The same should be done for @p data.
14697     *
14698     * Toolbar will load icon image from fdo or current theme.
14699     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14700     * If an absolute path is provided it will load it direct from a file.
14701     *
14702     * @see elm_toolbar_item_icon_set()
14703     * @see elm_toolbar_item_del()
14704     * @see elm_toolbar_item_del_cb_set()
14705     *
14706     * @ingroup Toolbar
14707     */
14708    EAPI Elm_Toolbar_Item       *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14709
14710    /**
14711     * Prepend item to the toolbar.
14712     *
14713     * @param obj The toolbar object.
14714     * @param icon A string with icon name or the absolute path of an image file.
14715     * @param label The label of the item.
14716     * @param func The function to call when the item is clicked.
14717     * @param data The data to associate with the item for related callbacks.
14718     * @return The created item or @c NULL upon failure.
14719     *
14720     * A new item will be created and prepended to the toolbar, i.e., will
14721     * be set as @b first item.
14722     *
14723     * Items created with this method can be deleted with
14724     * elm_toolbar_item_del().
14725     *
14726     * Associated @p data can be properly freed when item is deleted if a
14727     * callback function is set with elm_toolbar_item_del_cb_set().
14728     *
14729     * If a function is passed as argument, it will be called everytime this item
14730     * is selected, i.e., the user clicks over an unselected item.
14731     * If such function isn't needed, just passing
14732     * @c NULL as @p func is enough. The same should be done for @p data.
14733     *
14734     * Toolbar will load icon image from fdo or current theme.
14735     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14736     * If an absolute path is provided it will load it direct from a file.
14737     *
14738     * @see elm_toolbar_item_icon_set()
14739     * @see elm_toolbar_item_del()
14740     * @see elm_toolbar_item_del_cb_set()
14741     *
14742     * @ingroup Toolbar
14743     */
14744    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14745
14746    /**
14747     * Insert a new item into the toolbar object before item @p before.
14748     *
14749     * @param obj The toolbar object.
14750     * @param before The toolbar item to insert before.
14751     * @param icon A string with icon name or the absolute path of an image file.
14752     * @param label The label of the item.
14753     * @param func The function to call when the item is clicked.
14754     * @param data The data to associate with the item for related callbacks.
14755     * @return The created item or @c NULL upon failure.
14756     *
14757     * A new item will be created and added to the toolbar. Its position in
14758     * this toolbar will be just before item @p before.
14759     *
14760     * Items created with this method can be deleted with
14761     * elm_toolbar_item_del().
14762     *
14763     * Associated @p data can be properly freed when item is deleted if a
14764     * callback function is set with elm_toolbar_item_del_cb_set().
14765     *
14766     * If a function is passed as argument, it will be called everytime this item
14767     * is selected, i.e., the user clicks over an unselected item.
14768     * If such function isn't needed, just passing
14769     * @c NULL as @p func is enough. The same should be done for @p data.
14770     *
14771     * Toolbar will load icon image from fdo or current theme.
14772     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14773     * If an absolute path is provided it will load it direct from a file.
14774     *
14775     * @see elm_toolbar_item_icon_set()
14776     * @see elm_toolbar_item_del()
14777     * @see elm_toolbar_item_del_cb_set()
14778     *
14779     * @ingroup Toolbar
14780     */
14781    EAPI Elm_Toolbar_Item       *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Toolbar_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14782
14783    /**
14784     * Insert a new item into the toolbar object after item @p after.
14785     *
14786     * @param obj The toolbar object.
14787     * @param after The toolbar item to insert after.
14788     * @param icon A string with icon name or the absolute path of an image file.
14789     * @param label The label of the item.
14790     * @param func The function to call when the item is clicked.
14791     * @param data The data to associate with the item for related callbacks.
14792     * @return The created item or @c NULL upon failure.
14793     *
14794     * A new item will be created and added to the toolbar. Its position in
14795     * this toolbar will be just after item @p after.
14796     *
14797     * Items created with this method can be deleted with
14798     * elm_toolbar_item_del().
14799     *
14800     * Associated @p data can be properly freed when item is deleted if a
14801     * callback function is set with elm_toolbar_item_del_cb_set().
14802     *
14803     * If a function is passed as argument, it will be called everytime this item
14804     * is selected, i.e., the user clicks over an unselected item.
14805     * If such function isn't needed, just passing
14806     * @c NULL as @p func is enough. The same should be done for @p data.
14807     *
14808     * Toolbar will load icon image from fdo or current theme.
14809     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14810     * If an absolute path is provided it will load it direct from a file.
14811     *
14812     * @see elm_toolbar_item_icon_set()
14813     * @see elm_toolbar_item_del()
14814     * @see elm_toolbar_item_del_cb_set()
14815     *
14816     * @ingroup Toolbar
14817     */
14818    EAPI Elm_Toolbar_Item       *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Toolbar_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14819
14820    /**
14821     * Get the first item in the given toolbar widget's list of
14822     * items.
14823     *
14824     * @param obj The toolbar object
14825     * @return The first item or @c NULL, if it has no items (and on
14826     * errors)
14827     *
14828     * @see elm_toolbar_item_append()
14829     * @see elm_toolbar_last_item_get()
14830     *
14831     * @ingroup Toolbar
14832     */
14833    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14834
14835    /**
14836     * Get the last item in the given toolbar widget's list of
14837     * items.
14838     *
14839     * @param obj The toolbar object
14840     * @return The last item or @c NULL, if it has no items (and on
14841     * errors)
14842     *
14843     * @see elm_toolbar_item_prepend()
14844     * @see elm_toolbar_first_item_get()
14845     *
14846     * @ingroup Toolbar
14847     */
14848    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14849
14850    /**
14851     * Get the item after @p item in toolbar.
14852     *
14853     * @param item The toolbar item.
14854     * @return The item after @p item, or @c NULL if none or on failure.
14855     *
14856     * @note If it is the last item, @c NULL will be returned.
14857     *
14858     * @see elm_toolbar_item_append()
14859     *
14860     * @ingroup Toolbar
14861     */
14862    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14863
14864    /**
14865     * Get the item before @p item in toolbar.
14866     *
14867     * @param item The toolbar item.
14868     * @return The item before @p item, or @c NULL if none or on failure.
14869     *
14870     * @note If it is the first item, @c NULL will be returned.
14871     *
14872     * @see elm_toolbar_item_prepend()
14873     *
14874     * @ingroup Toolbar
14875     */
14876    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14877
14878    /**
14879     * Get the toolbar object from an item.
14880     *
14881     * @param item The item.
14882     * @return The toolbar object.
14883     *
14884     * This returns the toolbar object itself that an item belongs to.
14885     *
14886     * @ingroup Toolbar
14887     */
14888    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14889
14890    /**
14891     * Set the priority of a toolbar item.
14892     *
14893     * @param item The toolbar item.
14894     * @param priority The item priority. The default is zero.
14895     *
14896     * This is used only when the toolbar shrink mode is set to
14897     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14898     * When space is less than required, items with low priority
14899     * will be removed from the toolbar and added to a dynamically-created menu,
14900     * while items with higher priority will remain on the toolbar,
14901     * with the same order they were added.
14902     *
14903     * @see elm_toolbar_item_priority_get()
14904     *
14905     * @ingroup Toolbar
14906     */
14907    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14908
14909    /**
14910     * Get the priority of a toolbar item.
14911     *
14912     * @param item The toolbar item.
14913     * @return The @p item priority, or @c 0 on failure.
14914     *
14915     * @see elm_toolbar_item_priority_set() for details.
14916     *
14917     * @ingroup Toolbar
14918     */
14919    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14920
14921    /**
14922     * Get the label of item.
14923     *
14924     * @param item The item of toolbar.
14925     * @return The label of item.
14926     *
14927     * The return value is a pointer to the label associated to @p item when
14928     * it was created, with function elm_toolbar_item_append() or similar,
14929     * or later,
14930     * with function elm_toolbar_item_label_set. If no label
14931     * was passed as argument, it will return @c NULL.
14932     *
14933     * @see elm_toolbar_item_label_set() for more details.
14934     * @see elm_toolbar_item_append()
14935     *
14936     * @ingroup Toolbar
14937     */
14938    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14939
14940    /**
14941     * Set the label of item.
14942     *
14943     * @param item The item of toolbar.
14944     * @param text The label of item.
14945     *
14946     * The label to be displayed by the item.
14947     * Label will be placed at icons bottom (if set).
14948     *
14949     * If a label was passed as argument on item creation, with function
14950     * elm_toolbar_item_append() or similar, it will be already
14951     * displayed by the item.
14952     *
14953     * @see elm_toolbar_item_label_get()
14954     * @see elm_toolbar_item_append()
14955     *
14956     * @ingroup Toolbar
14957     */
14958    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14959
14960    /**
14961     * Return the data associated with a given toolbar widget item.
14962     *
14963     * @param item The toolbar widget item handle.
14964     * @return The data associated with @p item.
14965     *
14966     * @see elm_toolbar_item_data_set()
14967     *
14968     * @ingroup Toolbar
14969     */
14970    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14971
14972    /**
14973     * Set the data associated with a given toolbar widget item.
14974     *
14975     * @param item The toolbar widget item handle.
14976     * @param data The new data pointer to set to @p item.
14977     *
14978     * This sets new item data on @p item.
14979     *
14980     * @warning The old data pointer won't be touched by this function, so
14981     * the user had better to free that old data himself/herself.
14982     *
14983     * @ingroup Toolbar
14984     */
14985    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14986
14987    /**
14988     * Returns a pointer to a toolbar item by its label.
14989     *
14990     * @param obj The toolbar object.
14991     * @param label The label of the item to find.
14992     *
14993     * @return The pointer to the toolbar item matching @p label or @c NULL
14994     * on failure.
14995     *
14996     * @ingroup Toolbar
14997     */
14998    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14999
15000    /*
15001     * Get whether the @p item is selected or not.
15002     *
15003     * @param item The toolbar item.
15004     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15005     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15006     *
15007     * @see elm_toolbar_selected_item_set() for details.
15008     * @see elm_toolbar_item_selected_get()
15009     *
15010     * @ingroup Toolbar
15011     */
15012    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15013
15014    /**
15015     * Set the selected state of an item.
15016     *
15017     * @param item The toolbar item
15018     * @param selected The selected state
15019     *
15020     * This sets the selected state of the given item @p it.
15021     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15022     *
15023     * If a new item is selected the previosly selected will be unselected.
15024     * Previoulsy selected item can be get with function
15025     * elm_toolbar_selected_item_get().
15026     *
15027     * Selected items will be highlighted.
15028     *
15029     * @see elm_toolbar_item_selected_get()
15030     * @see elm_toolbar_selected_item_get()
15031     *
15032     * @ingroup Toolbar
15033     */
15034    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15035
15036    /**
15037     * Get the selected item.
15038     *
15039     * @param obj The toolbar object.
15040     * @return The selected toolbar item.
15041     *
15042     * The selected item can be unselected with function
15043     * elm_toolbar_item_selected_set().
15044     *
15045     * The selected item always will be highlighted on toolbar.
15046     *
15047     * @see elm_toolbar_selected_items_get()
15048     *
15049     * @ingroup Toolbar
15050     */
15051    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15052
15053    /**
15054     * Set the icon associated with @p item.
15055     *
15056     * @param obj The parent of this item.
15057     * @param item The toolbar item.
15058     * @param icon A string with icon name or the absolute path of an image file.
15059     *
15060     * Toolbar will load icon image from fdo or current theme.
15061     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15062     * If an absolute path is provided it will load it direct from a file.
15063     *
15064     * @see elm_toolbar_icon_order_lookup_set()
15065     * @see elm_toolbar_icon_order_lookup_get()
15066     *
15067     * @ingroup Toolbar
15068     */
15069    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15070
15071    /**
15072     * Get the string used to set the icon of @p item.
15073     *
15074     * @param item The toolbar item.
15075     * @return The string associated with the icon object.
15076     *
15077     * @see elm_toolbar_item_icon_set() for details.
15078     *
15079     * @ingroup Toolbar
15080     */
15081    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15082
15083    /**
15084     * Get the object of @p item.
15085     *
15086     * @param item The toolbar item.
15087     * @return The object
15088     *
15089     * @ingroup Toolbar
15090     */
15091    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15092
15093    /**
15094     * Get the icon object of @p item.
15095     *
15096     * @param item The toolbar item.
15097     * @return The icon object
15098     *
15099     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15100     *
15101     * @ingroup Toolbar
15102     */
15103    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15104
15105    /**
15106     * Set the icon associated with @p item to an image in a binary buffer.
15107     *
15108     * @param item The toolbar item.
15109     * @param img The binary data that will be used as an image
15110     * @param size The size of binary data @p img
15111     * @param format Optional format of @p img to pass to the image loader
15112     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15113     *
15114     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15115     *
15116     * @note The icon image set by this function can be changed by
15117     * elm_toolbar_item_icon_set().
15118     * 
15119     * @ingroup Toolbar
15120     */
15121    EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
15122
15123    /**
15124     * Delete them item from the toolbar.
15125     *
15126     * @param item The item of toolbar to be deleted.
15127     *
15128     * @see elm_toolbar_item_append()
15129     * @see elm_toolbar_item_del_cb_set()
15130     *
15131     * @ingroup Toolbar
15132     */
15133    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15134
15135    /**
15136     * Set the function called when a toolbar item is freed.
15137     *
15138     * @param item The item to set the callback on.
15139     * @param func The function called.
15140     *
15141     * If there is a @p func, then it will be called prior item's memory release.
15142     * That will be called with the following arguments:
15143     * @li item's data;
15144     * @li item's Evas object;
15145     * @li item itself;
15146     *
15147     * This way, a data associated to a toolbar item could be properly freed.
15148     *
15149     * @ingroup Toolbar
15150     */
15151    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15152
15153    /**
15154     * Get a value whether toolbar item is disabled or not.
15155     *
15156     * @param item The item.
15157     * @return The disabled state.
15158     *
15159     * @see elm_toolbar_item_disabled_set() for more details.
15160     *
15161     * @ingroup Toolbar
15162     */
15163    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15164
15165    /**
15166     * Sets the disabled/enabled state of a toolbar item.
15167     *
15168     * @param item The item.
15169     * @param disabled The disabled state.
15170     *
15171     * A disabled item cannot be selected or unselected. It will also
15172     * change its appearance (generally greyed out). This sets the
15173     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15174     * enabled).
15175     *
15176     * @ingroup Toolbar
15177     */
15178    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15179
15180    /**
15181     * Set or unset item as a separator.
15182     *
15183     * @param item The toolbar item.
15184     * @param setting @c EINA_TRUE to set item @p item as separator or
15185     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15186     *
15187     * Items aren't set as separator by default.
15188     *
15189     * If set as separator it will display separator theme, so won't display
15190     * icons or label.
15191     *
15192     * @see elm_toolbar_item_separator_get()
15193     *
15194     * @ingroup Toolbar
15195     */
15196    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15197
15198    /**
15199     * Get a value whether item is a separator or not.
15200     *
15201     * @param item The toolbar item.
15202     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15203     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15204     *
15205     * @see elm_toolbar_item_separator_set() for details.
15206     *
15207     * @ingroup Toolbar
15208     */
15209    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15210
15211    /**
15212     * Set the shrink state of toolbar @p obj.
15213     *
15214     * @param obj The toolbar object.
15215     * @param shrink_mode Toolbar's items display behavior.
15216     *
15217     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15218     * but will enforce a minimun size so all the items will fit, won't scroll
15219     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15220     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15221     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15222     *
15223     * @ingroup Toolbar
15224     */
15225    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15226
15227    /**
15228     * Get the shrink mode of toolbar @p obj.
15229     *
15230     * @param obj The toolbar object.
15231     * @return Toolbar's items display behavior.
15232     *
15233     * @see elm_toolbar_mode_shrink_set() for details.
15234     *
15235     * @ingroup Toolbar
15236     */
15237    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15238
15239    /**
15240     * Enable/disable homogenous mode.
15241     *
15242     * @param obj The toolbar object
15243     * @param homogeneous Assume the items within the toolbar are of the
15244     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15245     *
15246     * This will enable the homogeneous mode where items are of the same size.
15247     * @see elm_toolbar_homogeneous_get()
15248     *
15249     * @ingroup Toolbar
15250     */
15251    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15252
15253    /**
15254     * Get whether the homogenous mode is enabled.
15255     *
15256     * @param obj The toolbar object.
15257     * @return Assume the items within the toolbar are of the same height
15258     * and width (EINA_TRUE = on, EINA_FALSE = off).
15259     *
15260     * @see elm_toolbar_homogeneous_set()
15261     *
15262     * @ingroup Toolbar
15263     */
15264    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15265
15266    /**
15267     * Enable/disable homogenous mode.
15268     *
15269     * @param obj The toolbar object
15270     * @param homogeneous Assume the items within the toolbar are of the
15271     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15272     *
15273     * This will enable the homogeneous mode where items are of the same size.
15274     * @see elm_toolbar_homogeneous_get()
15275     *
15276     * @deprecated use elm_toolbar_homogeneous_set() instead.
15277     *
15278     * @ingroup Toolbar
15279     */
15280    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15281
15282    /**
15283     * Get whether the homogenous mode is enabled.
15284     *
15285     * @param obj The toolbar object.
15286     * @return Assume the items within the toolbar are of the same height
15287     * and width (EINA_TRUE = on, EINA_FALSE = off).
15288     *
15289     * @see elm_toolbar_homogeneous_set()
15290     * @deprecated use elm_toolbar_homogeneous_get() instead.
15291     *
15292     * @ingroup Toolbar
15293     */
15294    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15295
15296    /**
15297     * Set the parent object of the toolbar items' menus.
15298     *
15299     * @param obj The toolbar object.
15300     * @param parent The parent of the menu objects.
15301     *
15302     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15303     *
15304     * For more details about setting the parent for toolbar menus, see
15305     * elm_menu_parent_set().
15306     *
15307     * @see elm_menu_parent_set() for details.
15308     * @see elm_toolbar_item_menu_set() for details.
15309     *
15310     * @ingroup Toolbar
15311     */
15312    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15313
15314    /**
15315     * Get the parent object of the toolbar items' menus.
15316     *
15317     * @param obj The toolbar object.
15318     * @return The parent of the menu objects.
15319     *
15320     * @see elm_toolbar_menu_parent_set() for details.
15321     *
15322     * @ingroup Toolbar
15323     */
15324    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15325
15326    /**
15327     * Set the alignment of the items.
15328     *
15329     * @param obj The toolbar object.
15330     * @param align The new alignment, a float between <tt> 0.0 </tt>
15331     * and <tt> 1.0 </tt>.
15332     *
15333     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15334     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15335     * items.
15336     *
15337     * Centered items by default.
15338     *
15339     * @see elm_toolbar_align_get()
15340     *
15341     * @ingroup Toolbar
15342     */
15343    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15344
15345    /**
15346     * Get the alignment of the items.
15347     *
15348     * @param obj The toolbar object.
15349     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15350     * <tt> 1.0 </tt>.
15351     *
15352     * @see elm_toolbar_align_set() for details.
15353     *
15354     * @ingroup Toolbar
15355     */
15356    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15357
15358    /**
15359     * Set whether the toolbar item opens a menu.
15360     *
15361     * @param item The toolbar item.
15362     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15363     *
15364     * A toolbar item can be set to be a menu, using this function.
15365     *
15366     * Once it is set to be a menu, it can be manipulated through the
15367     * menu-like function elm_toolbar_menu_parent_set() and the other
15368     * elm_menu functions, using the Evas_Object @c menu returned by
15369     * elm_toolbar_item_menu_get().
15370     *
15371     * So, items to be displayed in this item's menu should be added with
15372     * elm_menu_item_add().
15373     *
15374     * The following code exemplifies the most basic usage:
15375     * @code
15376     * tb = elm_toolbar_add(win)
15377     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15378     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15379     * elm_toolbar_menu_parent_set(tb, win);
15380     * menu = elm_toolbar_item_menu_get(item);
15381     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15382     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15383     * NULL);
15384     * @endcode
15385     *
15386     * @see elm_toolbar_item_menu_get()
15387     *
15388     * @ingroup Toolbar
15389     */
15390    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15391
15392    /**
15393     * Get toolbar item's menu.
15394     *
15395     * @param item The toolbar item.
15396     * @return Item's menu object or @c NULL on failure.
15397     *
15398     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15399     * this function will set it.
15400     *
15401     * @see elm_toolbar_item_menu_set() for details.
15402     *
15403     * @ingroup Toolbar
15404     */
15405    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15406
15407    /**
15408     * Add a new state to @p item.
15409     *
15410     * @param item The item.
15411     * @param icon A string with icon name or the absolute path of an image file.
15412     * @param label The label of the new state.
15413     * @param func The function to call when the item is clicked when this
15414     * state is selected.
15415     * @param data The data to associate with the state.
15416     * @return The toolbar item state, or @c NULL upon failure.
15417     *
15418     * Toolbar will load icon image from fdo or current theme.
15419     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15420     * If an absolute path is provided it will load it direct from a file.
15421     *
15422     * States created with this function can be removed with
15423     * elm_toolbar_item_state_del().
15424     *
15425     * @see elm_toolbar_item_state_del()
15426     * @see elm_toolbar_item_state_sel()
15427     * @see elm_toolbar_item_state_get()
15428     *
15429     * @ingroup Toolbar
15430     */
15431    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Toolbar_Item *item, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15432
15433    /**
15434     * Delete a previoulsy added state to @p item.
15435     *
15436     * @param item The toolbar item.
15437     * @param state The state to be deleted.
15438     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15439     *
15440     * @see elm_toolbar_item_state_add()
15441     */
15442    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15443
15444    /**
15445     * Set @p state as the current state of @p it.
15446     *
15447     * @param it The item.
15448     * @param state The state to use.
15449     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15450     *
15451     * If @p state is @c NULL, it won't select any state and the default item's
15452     * icon and label will be used. It's the same behaviour than
15453     * elm_toolbar_item_state_unser().
15454     *
15455     * @see elm_toolbar_item_state_unset()
15456     *
15457     * @ingroup Toolbar
15458     */
15459    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15460
15461    /**
15462     * Unset the state of @p it.
15463     *
15464     * @param it The item.
15465     *
15466     * The default icon and label from this item will be displayed.
15467     *
15468     * @see elm_toolbar_item_state_set() for more details.
15469     *
15470     * @ingroup Toolbar
15471     */
15472    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15473
15474    /**
15475     * Get the current state of @p it.
15476     *
15477     * @param item The item.
15478     * @return The selected state or @c NULL if none is selected or on failure.
15479     *
15480     * @see elm_toolbar_item_state_set() for details.
15481     * @see elm_toolbar_item_state_unset()
15482     * @see elm_toolbar_item_state_add()
15483     *
15484     * @ingroup Toolbar
15485     */
15486    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15487
15488    /**
15489     * Get the state after selected state in toolbar's @p item.
15490     *
15491     * @param it The toolbar item to change state.
15492     * @return The state after current state, or @c NULL on failure.
15493     *
15494     * If last state is selected, this function will return first state.
15495     *
15496     * @see elm_toolbar_item_state_set()
15497     * @see elm_toolbar_item_state_add()
15498     *
15499     * @ingroup Toolbar
15500     */
15501    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15502
15503    /**
15504     * Get the state before selected state in toolbar's @p item.
15505     *
15506     * @param it The toolbar item to change state.
15507     * @return The state before current state, or @c NULL on failure.
15508     *
15509     * If first state is selected, this function will return last state.
15510     *
15511     * @see elm_toolbar_item_state_set()
15512     * @see elm_toolbar_item_state_add()
15513     *
15514     * @ingroup Toolbar
15515     */
15516    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15517
15518    /**
15519     * Set the text to be shown in a given toolbar item's tooltips.
15520     *
15521     * @param item Target item.
15522     * @param text The text to set in the content.
15523     *
15524     * Setup the text as tooltip to object. The item can have only one tooltip,
15525     * so any previous tooltip data - set with this function or
15526     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15527     *
15528     * @see elm_object_tooltip_text_set() for more details.
15529     *
15530     * @ingroup Toolbar
15531     */
15532    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15533
15534    /**
15535     * Set the content to be shown in the tooltip item.
15536     *
15537     * Setup the tooltip to item. The item can have only one tooltip,
15538     * so any previous tooltip data is removed. @p func(with @p data) will
15539     * be called every time that need show the tooltip and it should
15540     * return a valid Evas_Object. This object is then managed fully by
15541     * tooltip system and is deleted when the tooltip is gone.
15542     *
15543     * @param item the toolbar item being attached a tooltip.
15544     * @param func the function used to create the tooltip contents.
15545     * @param data what to provide to @a func as callback data/context.
15546     * @param del_cb called when data is not needed anymore, either when
15547     *        another callback replaces @a func, the tooltip is unset with
15548     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15549     *        dies. This callback receives as the first parameter the
15550     *        given @a data, and @c event_info is the item.
15551     *
15552     * @see elm_object_tooltip_content_cb_set() for more details.
15553     *
15554     * @ingroup Toolbar
15555     */
15556    EAPI void             elm_toolbar_item_tooltip_content_cb_set(Elm_Toolbar_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
15557
15558    /**
15559     * Unset tooltip from item.
15560     *
15561     * @param item toolbar item to remove previously set tooltip.
15562     *
15563     * Remove tooltip from item. The callback provided as del_cb to
15564     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15565     * it is not used anymore.
15566     *
15567     * @see elm_object_tooltip_unset() for more details.
15568     * @see elm_toolbar_item_tooltip_content_cb_set()
15569     *
15570     * @ingroup Toolbar
15571     */
15572    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15573
15574    /**
15575     * Sets a different style for this item tooltip.
15576     *
15577     * @note before you set a style you should define a tooltip with
15578     *       elm_toolbar_item_tooltip_content_cb_set() or
15579     *       elm_toolbar_item_tooltip_text_set()
15580     *
15581     * @param item toolbar item with tooltip already set.
15582     * @param style the theme style to use (default, transparent, ...)
15583     *
15584     * @see elm_object_tooltip_style_set() for more details.
15585     *
15586     * @ingroup Toolbar
15587     */
15588    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15589
15590    /**
15591     * Get the style for this item tooltip.
15592     *
15593     * @param item toolbar item with tooltip already set.
15594     * @return style the theme style in use, defaults to "default". If the
15595     *         object does not have a tooltip set, then NULL is returned.
15596     *
15597     * @see elm_object_tooltip_style_get() for more details.
15598     * @see elm_toolbar_item_tooltip_style_set()
15599     *
15600     * @ingroup Toolbar
15601     */
15602    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15603
15604    /**
15605     * Set the type of mouse pointer/cursor decoration to be shown,
15606     * when the mouse pointer is over the given toolbar widget item
15607     *
15608     * @param item toolbar item to customize cursor on
15609     * @param cursor the cursor type's name
15610     *
15611     * This function works analogously as elm_object_cursor_set(), but
15612     * here the cursor's changing area is restricted to the item's
15613     * area, and not the whole widget's. Note that that item cursors
15614     * have precedence over widget cursors, so that a mouse over an
15615     * item with custom cursor set will always show @b that cursor.
15616     *
15617     * If this function is called twice for an object, a previously set
15618     * cursor will be unset on the second call.
15619     *
15620     * @see elm_object_cursor_set()
15621     * @see elm_toolbar_item_cursor_get()
15622     * @see elm_toolbar_item_cursor_unset()
15623     *
15624     * @ingroup Toolbar
15625     */
15626    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15627
15628    /*
15629     * Get the type of mouse pointer/cursor decoration set to be shown,
15630     * when the mouse pointer is over the given toolbar widget item
15631     *
15632     * @param item toolbar item with custom cursor set
15633     * @return the cursor type's name or @c NULL, if no custom cursors
15634     * were set to @p item (and on errors)
15635     *
15636     * @see elm_object_cursor_get()
15637     * @see elm_toolbar_item_cursor_set()
15638     * @see elm_toolbar_item_cursor_unset()
15639     *
15640     * @ingroup Toolbar
15641     */
15642    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15643
15644    /**
15645     * Unset any custom mouse pointer/cursor decoration set to be
15646     * shown, when the mouse pointer is over the given toolbar widget
15647     * item, thus making it show the @b default cursor again.
15648     *
15649     * @param item a toolbar item
15650     *
15651     * Use this call to undo any custom settings on this item's cursor
15652     * decoration, bringing it back to defaults (no custom style set).
15653     *
15654     * @see elm_object_cursor_unset()
15655     * @see elm_toolbar_item_cursor_set()
15656     *
15657     * @ingroup Toolbar
15658     */
15659    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15660
15661    /**
15662     * Set a different @b style for a given custom cursor set for a
15663     * toolbar item.
15664     *
15665     * @param item toolbar item with custom cursor set
15666     * @param style the <b>theme style</b> to use (e.g. @c "default",
15667     * @c "transparent", etc)
15668     *
15669     * This function only makes sense when one is using custom mouse
15670     * cursor decorations <b>defined in a theme file</b>, which can have,
15671     * given a cursor name/type, <b>alternate styles</b> on it. It
15672     * works analogously as elm_object_cursor_style_set(), but here
15673     * applyed only to toolbar item objects.
15674     *
15675     * @warning Before you set a cursor style you should have definen a
15676     *       custom cursor previously on the item, with
15677     *       elm_toolbar_item_cursor_set()
15678     *
15679     * @see elm_toolbar_item_cursor_engine_only_set()
15680     * @see elm_toolbar_item_cursor_style_get()
15681     *
15682     * @ingroup Toolbar
15683     */
15684    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15685
15686    /**
15687     * Get the current @b style set for a given toolbar item's custom
15688     * cursor
15689     *
15690     * @param item toolbar item with custom cursor set.
15691     * @return style the cursor style in use. If the object does not
15692     *         have a cursor set, then @c NULL is returned.
15693     *
15694     * @see elm_toolbar_item_cursor_style_set() for more details
15695     *
15696     * @ingroup Toolbar
15697     */
15698    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15699
15700    /**
15701     * Set if the (custom)cursor for a given toolbar item should be
15702     * searched in its theme, also, or should only rely on the
15703     * rendering engine.
15704     *
15705     * @param item item with custom (custom) cursor already set on
15706     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15707     * only on those provided by the rendering engine, @c EINA_FALSE to
15708     * have them searched on the widget's theme, as well.
15709     *
15710     * @note This call is of use only if you've set a custom cursor
15711     * for toolbar items, with elm_toolbar_item_cursor_set().
15712     *
15713     * @note By default, cursors will only be looked for between those
15714     * provided by the rendering engine.
15715     *
15716     * @ingroup Toolbar
15717     */
15718    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15719
15720    /**
15721     * Get if the (custom) cursor for a given toolbar item is being
15722     * searched in its theme, also, or is only relying on the rendering
15723     * engine.
15724     *
15725     * @param item a toolbar item
15726     * @return @c EINA_TRUE, if cursors are being looked for only on
15727     * those provided by the rendering engine, @c EINA_FALSE if they
15728     * are being searched on the widget's theme, as well.
15729     *
15730     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15731     *
15732     * @ingroup Toolbar
15733     */
15734    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15735
15736    /**
15737     * Change a toolbar's orientation
15738     * @param obj The toolbar object
15739     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15740     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15741     * @ingroup Toolbar
15742     * @deprecated use elm_toolbar_horizontal_set() instead.
15743     */
15744    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15745
15746    /**
15747     * Change a toolbar's orientation
15748     * @param obj The toolbar object
15749     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15750     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15751     * @ingroup Toolbar
15752     */
15753    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15754
15755    /**
15756     * Get a toolbar's orientation
15757     * @param obj The toolbar object
15758     * @return If @c EINA_TRUE, the toolbar is vertical
15759     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15760     * @ingroup Toolbar
15761     * @deprecated use elm_toolbar_horizontal_get() instead.
15762     */
15763    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15764
15765    /**
15766     * Get a toolbar's orientation
15767     * @param obj The toolbar object
15768     * @return If @c EINA_TRUE, the toolbar is horizontal
15769     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15770     * @ingroup Toolbar
15771     */
15772    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15773    /**
15774     * @}
15775     */
15776
15777    /**
15778     * @defgroup Tooltips Tooltips
15779     *
15780     * The Tooltip is an (internal, for now) smart object used to show a
15781     * content in a frame on mouse hover of objects(or widgets), with
15782     * tips/information about them.
15783     *
15784     * @{
15785     */
15786
15787    EAPI double       elm_tooltip_delay_get(void);
15788    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15789    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15790    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15791    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15792    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15793 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15794    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);
15795    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15796    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15797    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15798    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15799    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15800
15801    /**
15802     * @}
15803     */
15804
15805    /**
15806     * @defgroup Cursors Cursors
15807     *
15808     * The Elementary cursor is an internal smart object used to
15809     * customize the mouse cursor displayed over objects (or
15810     * widgets). In the most common scenario, the cursor decoration
15811     * comes from the graphical @b engine Elementary is running
15812     * on. Those engines may provide different decorations for cursors,
15813     * and Elementary provides functions to choose them (think of X11
15814     * cursors, as an example).
15815     *
15816     * There's also the possibility of, besides using engine provided
15817     * cursors, also use ones coming from Edje theming files. Both
15818     * globally and per widget, Elementary makes it possible for one to
15819     * make the cursors lookup to be held on engines only or on
15820     * Elementary's theme file, too. To set cursor's hot spot,
15821     * two data items should be added to cursor's theme: "hot_x" and
15822     * "hot_y", that are the offset from upper-left corner of the cursor
15823     * (coordinates 0,0).
15824     *
15825     * @{
15826     */
15827
15828    /**
15829     * Set the cursor to be shown when mouse is over the object
15830     *
15831     * Set the cursor that will be displayed when mouse is over the
15832     * object. The object can have only one cursor set to it, so if
15833     * this function is called twice for an object, the previous set
15834     * will be unset.
15835     * If using X cursors, a definition of all the valid cursor names
15836     * is listed on Elementary_Cursors.h. If an invalid name is set
15837     * the default cursor will be used.
15838     *
15839     * @param obj the object being set a cursor.
15840     * @param cursor the cursor name to be used.
15841     *
15842     * @ingroup Cursors
15843     */
15844    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15845
15846    /**
15847     * Get the cursor to be shown when mouse is over the object
15848     *
15849     * @param obj an object with cursor already set.
15850     * @return the cursor name.
15851     *
15852     * @ingroup Cursors
15853     */
15854    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15855
15856    /**
15857     * Unset cursor for object
15858     *
15859     * Unset cursor for object, and set the cursor to default if the mouse
15860     * was over this object.
15861     *
15862     * @param obj Target object
15863     * @see elm_object_cursor_set()
15864     *
15865     * @ingroup Cursors
15866     */
15867    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15868
15869    /**
15870     * Sets a different style for this object cursor.
15871     *
15872     * @note before you set a style you should define a cursor with
15873     *       elm_object_cursor_set()
15874     *
15875     * @param obj an object with cursor already set.
15876     * @param style the theme style to use (default, transparent, ...)
15877     *
15878     * @ingroup Cursors
15879     */
15880    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15881
15882    /**
15883     * Get the style for this object cursor.
15884     *
15885     * @param obj an object with cursor already set.
15886     * @return style the theme style in use, defaults to "default". If the
15887     *         object does not have a cursor set, then NULL is returned.
15888     *
15889     * @ingroup Cursors
15890     */
15891    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15892
15893    /**
15894     * Set if the cursor set should be searched on the theme or should use
15895     * the provided by the engine, only.
15896     *
15897     * @note before you set if should look on theme you should define a cursor
15898     * with elm_object_cursor_set(). By default it will only look for cursors
15899     * provided by the engine.
15900     *
15901     * @param obj an object with cursor already set.
15902     * @param engine_only boolean to define it cursors should be looked only
15903     * between the provided by the engine or searched on widget's theme as well.
15904     *
15905     * @ingroup Cursors
15906     */
15907    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15908
15909    /**
15910     * Get the cursor engine only usage for this object cursor.
15911     *
15912     * @param obj an object with cursor already set.
15913     * @return engine_only boolean to define it cursors should be
15914     * looked only between the provided by the engine or searched on
15915     * widget's theme as well. If the object does not have a cursor
15916     * set, then EINA_FALSE is returned.
15917     *
15918     * @ingroup Cursors
15919     */
15920    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15921
15922    /**
15923     * Get the configured cursor engine only usage
15924     *
15925     * This gets the globally configured exclusive usage of engine cursors.
15926     *
15927     * @return 1 if only engine cursors should be used
15928     * @ingroup Cursors
15929     */
15930    EAPI int          elm_cursor_engine_only_get(void);
15931
15932    /**
15933     * Set the configured cursor engine only usage
15934     *
15935     * This sets the globally configured exclusive usage of engine cursors.
15936     * It won't affect cursors set before changing this value.
15937     *
15938     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15939     * look for them on theme before.
15940     * @return EINA_TRUE if value is valid and setted (0 or 1)
15941     * @ingroup Cursors
15942     */
15943    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15944
15945    /**
15946     * @}
15947     */
15948
15949    /**
15950     * @defgroup Menu Menu
15951     *
15952     * @image html img/widget/menu/preview-00.png
15953     * @image latex img/widget/menu/preview-00.eps
15954     *
15955     * A menu is a list of items displayed above its parent. When the menu is
15956     * showing its parent is darkened. Each item can have a sub-menu. The menu
15957     * object can be used to display a menu on a right click event, in a toolbar,
15958     * anywhere.
15959     *
15960     * Signals that you can add callbacks for are:
15961     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15962     *             event_info is NULL.
15963     *
15964     * @see @ref tutorial_menu
15965     * @{
15966     */
15967    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15968    /**
15969     * @brief Add a new menu to the parent
15970     *
15971     * @param parent The parent object.
15972     * @return The new object or NULL if it cannot be created.
15973     */
15974    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15975    /**
15976     * @brief Set the parent for the given menu widget
15977     *
15978     * @param obj The menu object.
15979     * @param parent The new parent.
15980     */
15981    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15982    /**
15983     * @brief Get the parent for the given menu widget
15984     *
15985     * @param obj The menu object.
15986     * @return The parent.
15987     *
15988     * @see elm_menu_parent_set()
15989     */
15990    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15991    /**
15992     * @brief Move the menu to a new position
15993     *
15994     * @param obj The menu object.
15995     * @param x The new position.
15996     * @param y The new position.
15997     *
15998     * Sets the top-left position of the menu to (@p x,@p y).
15999     *
16000     * @note @p x and @p y coordinates are relative to parent.
16001     */
16002    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16003    /**
16004     * @brief Close a opened menu
16005     *
16006     * @param obj the menu object
16007     * @return void
16008     *
16009     * Hides the menu and all it's sub-menus.
16010     */
16011    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16012    /**
16013     * @brief Returns a list of @p item's items.
16014     *
16015     * @param obj The menu object
16016     * @return An Eina_List* of @p item's items
16017     */
16018    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16019    /**
16020     * @brief Get the Evas_Object of an Elm_Menu_Item
16021     *
16022     * @param item The menu item object.
16023     * @return The edje object containing the swallowed content
16024     *
16025     * @warning Don't manipulate this object!
16026     */
16027    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16028    /**
16029     * @brief Add an item at the end of the given menu widget
16030     *
16031     * @param obj The menu object.
16032     * @param parent The parent menu item (optional)
16033     * @param icon A icon display on the item. The icon will be destryed by the menu.
16034     * @param label The label of the item.
16035     * @param func Function called when the user select the item.
16036     * @param data Data sent by the callback.
16037     * @return Returns the new item.
16038     */
16039    EAPI Elm_Menu_Item     *elm_menu_item_add(Evas_Object *obj, Elm_Menu_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16040    /**
16041     * @brief Add an object swallowed in an item at the end of the given menu
16042     * widget
16043     *
16044     * @param obj The menu object.
16045     * @param parent The parent menu item (optional)
16046     * @param subobj The object to swallow
16047     * @param func Function called when the user select the item.
16048     * @param data Data sent by the callback.
16049     * @return Returns the new item.
16050     *
16051     * Add an evas object as an item to the menu.
16052     */
16053    EAPI Elm_Menu_Item     *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16054    /**
16055     * @brief Set the label of a menu item
16056     *
16057     * @param item The menu item object.
16058     * @param label The label to set for @p item
16059     *
16060     * @warning Don't use this funcion on items created with
16061     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16062     */
16063    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16064    /**
16065     * @brief Get the label of a menu item
16066     *
16067     * @param item The menu item object.
16068     * @return The label of @p item
16069     */
16070    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16071    /**
16072     * @brief Set the icon of a menu item to the standard icon with name @p icon
16073     *
16074     * @param item The menu item object.
16075     * @param icon The icon object to set for the content of @p item
16076     *
16077     * Once this icon is set, any previously set icon will be deleted.
16078     */
16079    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16080    /**
16081     * @brief Get the string representation from the icon of a menu item
16082     *
16083     * @param item The menu item object.
16084     * @return The string representation of @p item's icon or NULL
16085     *
16086     * @see elm_menu_item_object_icon_name_set()
16087     */
16088    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16089    /**
16090     * @brief Set the content object of a menu item
16091     *
16092     * @param item The menu item object
16093     * @param The content object or NULL
16094     * @return EINA_TRUE on success, else EINA_FALSE
16095     *
16096     * Use this function to change the object swallowed by a menu item, deleting
16097     * any previously swallowed object.
16098     */
16099    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16100    /**
16101     * @brief Get the content object of a menu item
16102     *
16103     * @param item The menu item object
16104     * @return The content object or NULL
16105     * @note If @p item was added with elm_menu_item_add_object, this
16106     * function will return the object passed, else it will return the
16107     * icon object.
16108     *
16109     * @see elm_menu_item_object_content_set()
16110     */
16111    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16112    /**
16113     * @brief Set the selected state of @p item.
16114     *
16115     * @param item The menu item object.
16116     * @param selected The selected/unselected state of the item
16117     */
16118    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16119    /**
16120     * @brief Get the selected state of @p item.
16121     *
16122     * @param item The menu item object.
16123     * @return The selected/unselected state of the item
16124     *
16125     * @see elm_menu_item_selected_set()
16126     */
16127    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16128    /**
16129     * @brief Set the disabled state of @p item.
16130     *
16131     * @param item The menu item object.
16132     * @param disabled The enabled/disabled state of the item
16133     */
16134    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16135    /**
16136     * @brief Get the disabled state of @p item.
16137     *
16138     * @param item The menu item object.
16139     * @return The enabled/disabled state of the item
16140     *
16141     * @see elm_menu_item_disabled_set()
16142     */
16143    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16144    /**
16145     * @brief Add a separator item to menu @p obj under @p parent.
16146     *
16147     * @param obj The menu object
16148     * @param parent The item to add the separator under
16149     * @return The created item or NULL on failure
16150     *
16151     * This is item is a @ref Separator.
16152     */
16153    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16154    /**
16155     * @brief Returns whether @p item is a separator.
16156     *
16157     * @param item The item to check
16158     * @return If true, @p item is a separator
16159     *
16160     * @see elm_menu_item_separator_add()
16161     */
16162    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16163    /**
16164     * @brief Deletes an item from the menu.
16165     *
16166     * @param item The item to delete.
16167     *
16168     * @see elm_menu_item_add()
16169     */
16170    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16171    /**
16172     * @brief Set the function called when a menu item is deleted.
16173     *
16174     * @param item The item to set the callback on
16175     * @param func The function called
16176     *
16177     * @see elm_menu_item_add()
16178     * @see elm_menu_item_del()
16179     */
16180    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16181    /**
16182     * @brief Returns the data associated with menu item @p item.
16183     *
16184     * @param item The item
16185     * @return The data associated with @p item or NULL if none was set.
16186     *
16187     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16188     */
16189    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16190    /**
16191     * @brief Sets the data to be associated with menu item @p item.
16192     *
16193     * @param item The item
16194     * @param data The data to be associated with @p item
16195     */
16196    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16197    /**
16198     * @brief Returns a list of @p item's subitems.
16199     *
16200     * @param item The item
16201     * @return An Eina_List* of @p item's subitems
16202     *
16203     * @see elm_menu_add()
16204     */
16205    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16206    /**
16207     * @brief Get the position of a menu item
16208     *
16209     * @param item The menu item
16210     * @return The item's index
16211     *
16212     * This function returns the index position of a menu item in a menu.
16213     * For a sub-menu, this number is relative to the first item in the sub-menu.
16214     *
16215     * @note Index values begin with 0
16216     */
16217    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16218    /**
16219     * @brief @brief Return a menu item's owner menu
16220     *
16221     * @param item The menu item
16222     * @return The menu object owning @p item, or NULL on failure
16223     *
16224     * Use this function to get the menu object owning an item.
16225     */
16226    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16227    /**
16228     * @brief Get the selected item in the menu
16229     *
16230     * @param obj The menu object
16231     * @return The selected item, or NULL if none
16232     *
16233     * @see elm_menu_item_selected_get()
16234     * @see elm_menu_item_selected_set()
16235     */
16236    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16237    /**
16238     * @brief Get the last item in the menu
16239     *
16240     * @param obj The menu object
16241     * @return The last item, or NULL if none
16242     */
16243    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16244    /**
16245     * @brief Get the first item in the menu
16246     *
16247     * @param obj The menu object
16248     * @return The first item, or NULL if none
16249     */
16250    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16251    /**
16252     * @brief Get the next item in the menu.
16253     *
16254     * @param item The menu item object.
16255     * @return The item after it, or NULL if none
16256     */
16257    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16258    /**
16259     * @brief Get the previous item in the menu.
16260     *
16261     * @param item The menu item object.
16262     * @return The item before it, or NULL if none
16263     */
16264    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16265    /**
16266     * @}
16267     */
16268
16269    /**
16270     * @defgroup List List
16271     * @ingroup Elementary
16272     *
16273     * @image html img/widget/list/preview-00.png
16274     * @image latex img/widget/list/preview-00.eps width=\textwidth
16275     *
16276     * @image html img/list.png
16277     * @image latex img/list.eps width=\textwidth
16278     *
16279     * A list widget is a container whose children are displayed vertically or
16280     * horizontally, in order, and can be selected.
16281     * The list can accept only one or multiple items selection. Also has many
16282     * modes of items displaying.
16283     *
16284     * A list is a very simple type of list widget.  For more robust
16285     * lists, @ref Genlist should probably be used.
16286     *
16287     * Smart callbacks one can listen to:
16288     * - @c "activated" - The user has double-clicked or pressed
16289     *   (enter|return|spacebar) on an item. The @c event_info parameter
16290     *   is the item that was activated.
16291     * - @c "clicked,double" - The user has double-clicked an item.
16292     *   The @c event_info parameter is the item that was double-clicked.
16293     * - "selected" - when the user selected an item
16294     * - "unselected" - when the user unselected an item
16295     * - "longpressed" - an item in the list is long-pressed
16296     * - "edge,top" - the list is scrolled until the top edge
16297     * - "edge,bottom" - the list is scrolled until the bottom edge
16298     * - "edge,left" - the list is scrolled until the left edge
16299     * - "edge,right" - the list is scrolled until the right edge
16300     * - "language,changed" - the program's language changed
16301     *
16302     * Available styles for it:
16303     * - @c "default"
16304     *
16305     * List of examples:
16306     * @li @ref list_example_01
16307     * @li @ref list_example_02
16308     * @li @ref list_example_03
16309     */
16310
16311    /**
16312     * @addtogroup List
16313     * @{
16314     */
16315
16316    /**
16317     * @enum _Elm_List_Mode
16318     * @typedef Elm_List_Mode
16319     *
16320     * Set list's resize behavior, transverse axis scroll and
16321     * items cropping. See each mode's description for more details.
16322     *
16323     * @note Default value is #ELM_LIST_SCROLL.
16324     *
16325     * Values <b> don't </b> work as bitmask, only one can be choosen.
16326     *
16327     * @see elm_list_mode_set()
16328     * @see elm_list_mode_get()
16329     *
16330     * @ingroup List
16331     */
16332    typedef enum _Elm_List_Mode
16333      {
16334         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. */
16335         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). */
16336         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. */
16337         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. */
16338         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16339      } Elm_List_Mode;
16340
16341    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().  */
16342
16343    /**
16344     * Add a new list widget to the given parent Elementary
16345     * (container) object.
16346     *
16347     * @param parent The parent object.
16348     * @return a new list widget handle or @c NULL, on errors.
16349     *
16350     * This function inserts a new list widget on the canvas.
16351     *
16352     * @ingroup List
16353     */
16354    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16355
16356    /**
16357     * Starts the list.
16358     *
16359     * @param obj The list object
16360     *
16361     * @note Call before running show() on the list object.
16362     * @warning If not called, it won't display the list properly.
16363     *
16364     * @code
16365     * li = elm_list_add(win);
16366     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16367     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16368     * elm_list_go(li);
16369     * evas_object_show(li);
16370     * @endcode
16371     *
16372     * @ingroup List
16373     */
16374    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16375
16376    /**
16377     * Enable or disable multiple items selection on the list object.
16378     *
16379     * @param obj The list object
16380     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16381     * disable it.
16382     *
16383     * Disabled by default. If disabled, the user can select a single item of
16384     * the list each time. Selected items are highlighted on list.
16385     * If enabled, many items can be selected.
16386     *
16387     * If a selected item is selected again, it will be unselected.
16388     *
16389     * @see elm_list_multi_select_get()
16390     *
16391     * @ingroup List
16392     */
16393    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16394
16395    /**
16396     * Get a value whether multiple items selection is enabled or not.
16397     *
16398     * @see elm_list_multi_select_set() for details.
16399     *
16400     * @param obj The list object.
16401     * @return @c EINA_TRUE means multiple items selection is enabled.
16402     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16403     * @c EINA_FALSE is returned.
16404     *
16405     * @ingroup List
16406     */
16407    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16408
16409    /**
16410     * Set which mode to use for the list object.
16411     *
16412     * @param obj The list object
16413     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16414     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16415     *
16416     * Set list's resize behavior, transverse axis scroll and
16417     * items cropping. See each mode's description for more details.
16418     *
16419     * @note Default value is #ELM_LIST_SCROLL.
16420     *
16421     * Only one can be set, if a previous one was set, it will be changed
16422     * by the new mode set. Bitmask won't work as well.
16423     *
16424     * @see elm_list_mode_get()
16425     *
16426     * @ingroup List
16427     */
16428    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16429
16430    /**
16431     * Get the mode the list is at.
16432     *
16433     * @param obj The list object
16434     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16435     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16436     *
16437     * @note see elm_list_mode_set() for more information.
16438     *
16439     * @ingroup List
16440     */
16441    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16442
16443    /**
16444     * Enable or disable horizontal mode on the list object.
16445     *
16446     * @param obj The list object.
16447     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16448     * disable it, i.e., to enable vertical mode.
16449     *
16450     * @note Vertical mode is set by default.
16451     *
16452     * On horizontal mode items are displayed on list from left to right,
16453     * instead of from top to bottom. Also, the list will scroll horizontally.
16454     * Each item will presents left icon on top and right icon, or end, at
16455     * the bottom.
16456     *
16457     * @see elm_list_horizontal_get()
16458     *
16459     * @ingroup List
16460     */
16461    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16462
16463    /**
16464     * Get a value whether horizontal mode is enabled or not.
16465     *
16466     * @param obj The list object.
16467     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16468     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16469     * @c EINA_FALSE is returned.
16470     *
16471     * @see elm_list_horizontal_set() for details.
16472     *
16473     * @ingroup List
16474     */
16475    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16476
16477    /**
16478     * Enable or disable always select mode on the list object.
16479     *
16480     * @param obj The list object
16481     * @param always_select @c EINA_TRUE to enable always select mode or
16482     * @c EINA_FALSE to disable it.
16483     *
16484     * @note Always select mode is disabled by default.
16485     *
16486     * Default behavior of list items is to only call its callback function
16487     * the first time it's pressed, i.e., when it is selected. If a selected
16488     * item is pressed again, and multi-select is disabled, it won't call
16489     * this function (if multi-select is enabled it will unselect the item).
16490     *
16491     * If always select is enabled, it will call the callback function
16492     * everytime a item is pressed, so it will call when the item is selected,
16493     * and again when a selected item is pressed.
16494     *
16495     * @see elm_list_always_select_mode_get()
16496     * @see elm_list_multi_select_set()
16497     *
16498     * @ingroup List
16499     */
16500    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16501
16502    /**
16503     * Get a value whether always select mode is enabled or not, meaning that
16504     * an item will always call its callback function, even if already selected.
16505     *
16506     * @param obj The list object
16507     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16508     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16509     * @c EINA_FALSE is returned.
16510     *
16511     * @see elm_list_always_select_mode_set() for details.
16512     *
16513     * @ingroup List
16514     */
16515    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16516
16517    /**
16518     * Set bouncing behaviour when the scrolled content reaches an edge.
16519     *
16520     * Tell the internal scroller object whether it should bounce or not
16521     * when it reaches the respective edges for each axis.
16522     *
16523     * @param obj The list object
16524     * @param h_bounce Whether to bounce or not in the horizontal axis.
16525     * @param v_bounce Whether to bounce or not in the vertical axis.
16526     *
16527     * @see elm_scroller_bounce_set()
16528     *
16529     * @ingroup List
16530     */
16531    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16532
16533    /**
16534     * Get the bouncing behaviour of the internal scroller.
16535     *
16536     * Get whether the internal scroller should bounce when the edge of each
16537     * axis is reached scrolling.
16538     *
16539     * @param obj The list object.
16540     * @param h_bounce Pointer where to store the bounce state of the horizontal
16541     * axis.
16542     * @param v_bounce Pointer where to store the bounce state of the vertical
16543     * axis.
16544     *
16545     * @see elm_scroller_bounce_get()
16546     * @see elm_list_bounce_set()
16547     *
16548     * @ingroup List
16549     */
16550    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16551
16552    /**
16553     * Set the scrollbar policy.
16554     *
16555     * @param obj The list object
16556     * @param policy_h Horizontal scrollbar policy.
16557     * @param policy_v Vertical scrollbar policy.
16558     *
16559     * This sets the scrollbar visibility policy for the given scroller.
16560     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16561     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16562     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16563     * This applies respectively for the horizontal and vertical scrollbars.
16564     *
16565     * The both are disabled by default, i.e., are set to
16566     * #ELM_SCROLLER_POLICY_OFF.
16567     *
16568     * @ingroup List
16569     */
16570    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16571
16572    /**
16573     * Get the scrollbar policy.
16574     *
16575     * @see elm_list_scroller_policy_get() for details.
16576     *
16577     * @param obj The list object.
16578     * @param policy_h Pointer where to store horizontal scrollbar policy.
16579     * @param policy_v Pointer where to store vertical scrollbar policy.
16580     *
16581     * @ingroup List
16582     */
16583    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);
16584
16585    /**
16586     * Append a new item to the list object.
16587     *
16588     * @param obj The list object.
16589     * @param label The label of the list item.
16590     * @param icon The icon object to use for the left side of the item. An
16591     * icon can be any Evas object, but usually it is an icon created
16592     * with elm_icon_add().
16593     * @param end The icon object to use for the right side of the item. An
16594     * icon can be any Evas object.
16595     * @param func The function to call when the item is clicked.
16596     * @param data The data to associate with the item for related callbacks.
16597     *
16598     * @return The created item or @c NULL upon failure.
16599     *
16600     * A new item will be created and appended to the list, i.e., will
16601     * be set as @b last item.
16602     *
16603     * Items created with this method can be deleted with
16604     * elm_list_item_del().
16605     *
16606     * Associated @p data can be properly freed when item is deleted if a
16607     * callback function is set with elm_list_item_del_cb_set().
16608     *
16609     * If a function is passed as argument, it will be called everytime this item
16610     * is selected, i.e., the user clicks over an unselected item.
16611     * If always select is enabled it will call this function every time
16612     * user clicks over an item (already selected or not).
16613     * If such function isn't needed, just passing
16614     * @c NULL as @p func is enough. The same should be done for @p data.
16615     *
16616     * Simple example (with no function callback or data associated):
16617     * @code
16618     * li = elm_list_add(win);
16619     * ic = elm_icon_add(win);
16620     * elm_icon_file_set(ic, "path/to/image", NULL);
16621     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16622     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16623     * elm_list_go(li);
16624     * evas_object_show(li);
16625     * @endcode
16626     *
16627     * @see elm_list_always_select_mode_set()
16628     * @see elm_list_item_del()
16629     * @see elm_list_item_del_cb_set()
16630     * @see elm_list_clear()
16631     * @see elm_icon_add()
16632     *
16633     * @ingroup List
16634     */
16635    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);
16636
16637    /**
16638     * Prepend a new item to the list object.
16639     *
16640     * @param obj The list object.
16641     * @param label The label of the list item.
16642     * @param icon The icon object to use for the left side of the item. An
16643     * icon can be any Evas object, but usually it is an icon created
16644     * with elm_icon_add().
16645     * @param end The icon object to use for the right side of the item. An
16646     * icon can be any Evas object.
16647     * @param func The function to call when the item is clicked.
16648     * @param data The data to associate with the item for related callbacks.
16649     *
16650     * @return The created item or @c NULL upon failure.
16651     *
16652     * A new item will be created and prepended to the list, i.e., will
16653     * be set as @b first item.
16654     *
16655     * Items created with this method can be deleted with
16656     * elm_list_item_del().
16657     *
16658     * Associated @p data can be properly freed when item is deleted if a
16659     * callback function is set with elm_list_item_del_cb_set().
16660     *
16661     * If a function is passed as argument, it will be called everytime this item
16662     * is selected, i.e., the user clicks over an unselected item.
16663     * If always select is enabled it will call this function every time
16664     * user clicks over an item (already selected or not).
16665     * If such function isn't needed, just passing
16666     * @c NULL as @p func is enough. The same should be done for @p data.
16667     *
16668     * @see elm_list_item_append() for a simple code example.
16669     * @see elm_list_always_select_mode_set()
16670     * @see elm_list_item_del()
16671     * @see elm_list_item_del_cb_set()
16672     * @see elm_list_clear()
16673     * @see elm_icon_add()
16674     *
16675     * @ingroup List
16676     */
16677    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);
16678
16679    /**
16680     * Insert a new item into the list object before item @p before.
16681     *
16682     * @param obj The list object.
16683     * @param before The list item to insert before.
16684     * @param label The label of the list item.
16685     * @param icon The icon object to use for the left side of the item. An
16686     * icon can be any Evas object, but usually it is an icon created
16687     * with elm_icon_add().
16688     * @param end The icon object to use for the right side of the item. An
16689     * icon can be any Evas object.
16690     * @param func The function to call when the item is clicked.
16691     * @param data The data to associate with the item for related callbacks.
16692     *
16693     * @return The created item or @c NULL upon failure.
16694     *
16695     * A new item will be created and added to the list. Its position in
16696     * this list will be just before item @p before.
16697     *
16698     * Items created with this method can be deleted with
16699     * elm_list_item_del().
16700     *
16701     * Associated @p data can be properly freed when item is deleted if a
16702     * callback function is set with elm_list_item_del_cb_set().
16703     *
16704     * If a function is passed as argument, it will be called everytime this item
16705     * is selected, i.e., the user clicks over an unselected item.
16706     * If always select is enabled it will call this function every time
16707     * user clicks over an item (already selected or not).
16708     * If such function isn't needed, just passing
16709     * @c NULL as @p func is enough. The same should be done for @p data.
16710     *
16711     * @see elm_list_item_append() for a simple code example.
16712     * @see elm_list_always_select_mode_set()
16713     * @see elm_list_item_del()
16714     * @see elm_list_item_del_cb_set()
16715     * @see elm_list_clear()
16716     * @see elm_icon_add()
16717     *
16718     * @ingroup List
16719     */
16720    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);
16721
16722    /**
16723     * Insert a new item into the list object after item @p after.
16724     *
16725     * @param obj The list object.
16726     * @param after The list item to insert after.
16727     * @param label The label of the list item.
16728     * @param icon The icon object to use for the left side of the item. An
16729     * icon can be any Evas object, but usually it is an icon created
16730     * with elm_icon_add().
16731     * @param end The icon object to use for the right side of the item. An
16732     * icon can be any Evas object.
16733     * @param func The function to call when the item is clicked.
16734     * @param data The data to associate with the item for related callbacks.
16735     *
16736     * @return The created item or @c NULL upon failure.
16737     *
16738     * A new item will be created and added to the list. Its position in
16739     * this list will be just after item @p after.
16740     *
16741     * Items created with this method can be deleted with
16742     * elm_list_item_del().
16743     *
16744     * Associated @p data can be properly freed when item is deleted if a
16745     * callback function is set with elm_list_item_del_cb_set().
16746     *
16747     * If a function is passed as argument, it will be called everytime this item
16748     * is selected, i.e., the user clicks over an unselected item.
16749     * If always select is enabled it will call this function every time
16750     * user clicks over an item (already selected or not).
16751     * If such function isn't needed, just passing
16752     * @c NULL as @p func is enough. The same should be done for @p data.
16753     *
16754     * @see elm_list_item_append() for a simple code example.
16755     * @see elm_list_always_select_mode_set()
16756     * @see elm_list_item_del()
16757     * @see elm_list_item_del_cb_set()
16758     * @see elm_list_clear()
16759     * @see elm_icon_add()
16760     *
16761     * @ingroup List
16762     */
16763    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);
16764
16765    /**
16766     * Insert a new item into the sorted list object.
16767     *
16768     * @param obj The list object.
16769     * @param label The label of the list item.
16770     * @param icon The icon object to use for the left side of the item. An
16771     * icon can be any Evas object, but usually it is an icon created
16772     * with elm_icon_add().
16773     * @param end The icon object to use for the right side of the item. An
16774     * icon can be any Evas object.
16775     * @param func The function to call when the item is clicked.
16776     * @param data The data to associate with the item for related callbacks.
16777     * @param cmp_func The comparing function to be used to sort list
16778     * items <b>by #Elm_List_Item item handles</b>. This function will
16779     * receive two items and compare them, returning a non-negative integer
16780     * if the second item should be place after the first, or negative value
16781     * if should be placed before.
16782     *
16783     * @return The created item or @c NULL upon failure.
16784     *
16785     * @note This function inserts values into a list object assuming it was
16786     * sorted and the result will be sorted.
16787     *
16788     * A new item will be created and added to the list. Its position in
16789     * this list will be found comparing the new item with previously inserted
16790     * items using function @p cmp_func.
16791     *
16792     * Items created with this method can be deleted with
16793     * elm_list_item_del().
16794     *
16795     * Associated @p data can be properly freed when item is deleted if a
16796     * callback function is set with elm_list_item_del_cb_set().
16797     *
16798     * If a function is passed as argument, it will be called everytime this item
16799     * is selected, i.e., the user clicks over an unselected item.
16800     * If always select is enabled it will call this function every time
16801     * user clicks over an item (already selected or not).
16802     * If such function isn't needed, just passing
16803     * @c NULL as @p func is enough. The same should be done for @p data.
16804     *
16805     * @see elm_list_item_append() for a simple code example.
16806     * @see elm_list_always_select_mode_set()
16807     * @see elm_list_item_del()
16808     * @see elm_list_item_del_cb_set()
16809     * @see elm_list_clear()
16810     * @see elm_icon_add()
16811     *
16812     * @ingroup List
16813     */
16814    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);
16815
16816    /**
16817     * Remove all list's items.
16818     *
16819     * @param obj The list object
16820     *
16821     * @see elm_list_item_del()
16822     * @see elm_list_item_append()
16823     *
16824     * @ingroup List
16825     */
16826    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16827
16828    /**
16829     * Get a list of all the list items.
16830     *
16831     * @param obj The list object
16832     * @return An @c Eina_List of list items, #Elm_List_Item,
16833     * or @c NULL on failure.
16834     *
16835     * @see elm_list_item_append()
16836     * @see elm_list_item_del()
16837     * @see elm_list_clear()
16838     *
16839     * @ingroup List
16840     */
16841    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16842
16843    /**
16844     * Get the selected item.
16845     *
16846     * @param obj The list object.
16847     * @return The selected list item.
16848     *
16849     * The selected item can be unselected with function
16850     * elm_list_item_selected_set().
16851     *
16852     * The selected item always will be highlighted on list.
16853     *
16854     * @see elm_list_selected_items_get()
16855     *
16856     * @ingroup List
16857     */
16858    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16859
16860    /**
16861     * Return a list of the currently selected list items.
16862     *
16863     * @param obj The list object.
16864     * @return An @c Eina_List of list items, #Elm_List_Item,
16865     * or @c NULL on failure.
16866     *
16867     * Multiple items can be selected if multi select is enabled. It can be
16868     * done with elm_list_multi_select_set().
16869     *
16870     * @see elm_list_selected_item_get()
16871     * @see elm_list_multi_select_set()
16872     *
16873     * @ingroup List
16874     */
16875    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16876
16877    /**
16878     * Set the selected state of an item.
16879     *
16880     * @param item The list item
16881     * @param selected The selected state
16882     *
16883     * This sets the selected state of the given item @p it.
16884     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16885     *
16886     * If a new item is selected the previosly selected will be unselected,
16887     * unless multiple selection is enabled with elm_list_multi_select_set().
16888     * Previoulsy selected item can be get with function
16889     * elm_list_selected_item_get().
16890     *
16891     * Selected items will be highlighted.
16892     *
16893     * @see elm_list_item_selected_get()
16894     * @see elm_list_selected_item_get()
16895     * @see elm_list_multi_select_set()
16896     *
16897     * @ingroup List
16898     */
16899    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16900
16901    /*
16902     * Get whether the @p item is selected or not.
16903     *
16904     * @param item The list item.
16905     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16906     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16907     *
16908     * @see elm_list_selected_item_set() for details.
16909     * @see elm_list_item_selected_get()
16910     *
16911     * @ingroup List
16912     */
16913    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16914
16915    /**
16916     * Set or unset item as a separator.
16917     *
16918     * @param it The list item.
16919     * @param setting @c EINA_TRUE to set item @p it as separator or
16920     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16921     *
16922     * Items aren't set as separator by default.
16923     *
16924     * If set as separator it will display separator theme, so won't display
16925     * icons or label.
16926     *
16927     * @see elm_list_item_separator_get()
16928     *
16929     * @ingroup List
16930     */
16931    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16932
16933    /**
16934     * Get a value whether item is a separator or not.
16935     *
16936     * @see elm_list_item_separator_set() for details.
16937     *
16938     * @param it The list item.
16939     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16940     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16941     *
16942     * @ingroup List
16943     */
16944    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16945
16946    /**
16947     * Show @p item in the list view.
16948     *
16949     * @param item The list item to be shown.
16950     *
16951     * It won't animate list until item is visible. If such behavior is wanted,
16952     * use elm_list_bring_in() intead.
16953     *
16954     * @ingroup List
16955     */
16956    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16957
16958    /**
16959     * Bring in the given item to list view.
16960     *
16961     * @param item The item.
16962     *
16963     * This causes list to jump to the given item @p item and show it
16964     * (by scrolling), if it is not fully visible.
16965     *
16966     * This may use animation to do so and take a period of time.
16967     *
16968     * If animation isn't wanted, elm_list_item_show() can be used.
16969     *
16970     * @ingroup List
16971     */
16972    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16973
16974    /**
16975     * Delete them item from the list.
16976     *
16977     * @param item The item of list to be deleted.
16978     *
16979     * If deleting all list items is required, elm_list_clear()
16980     * should be used instead of getting items list and deleting each one.
16981     *
16982     * @see elm_list_clear()
16983     * @see elm_list_item_append()
16984     * @see elm_list_item_del_cb_set()
16985     *
16986     * @ingroup List
16987     */
16988    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16989
16990    /**
16991     * Set the function called when a list item is freed.
16992     *
16993     * @param item The item to set the callback on
16994     * @param func The function called
16995     *
16996     * If there is a @p func, then it will be called prior item's memory release.
16997     * That will be called with the following arguments:
16998     * @li item's data;
16999     * @li item's Evas object;
17000     * @li item itself;
17001     *
17002     * This way, a data associated to a list item could be properly freed.
17003     *
17004     * @ingroup List
17005     */
17006    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17007
17008    /**
17009     * Get the data associated to the item.
17010     *
17011     * @param item The list item
17012     * @return The data associated to @p item
17013     *
17014     * The return value is a pointer to data associated to @p item when it was
17015     * created, with function elm_list_item_append() or similar. If no data
17016     * was passed as argument, it will return @c NULL.
17017     *
17018     * @see elm_list_item_append()
17019     *
17020     * @ingroup List
17021     */
17022    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17023
17024    /**
17025     * Get the left side icon associated to the item.
17026     *
17027     * @param item The list item
17028     * @return The left side icon associated to @p item
17029     *
17030     * The return value is a pointer to the icon associated to @p item when
17031     * it was
17032     * created, with function elm_list_item_append() or similar, or later
17033     * with function elm_list_item_icon_set(). If no icon
17034     * was passed as argument, it will return @c NULL.
17035     *
17036     * @see elm_list_item_append()
17037     * @see elm_list_item_icon_set()
17038     *
17039     * @ingroup List
17040     */
17041    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17042
17043    /**
17044     * Set the left side icon associated to the item.
17045     *
17046     * @param item The list item
17047     * @param icon The left side icon object to associate with @p item
17048     *
17049     * The icon object to use at left side of the item. An
17050     * icon can be any Evas object, but usually it is an icon created
17051     * with elm_icon_add().
17052     *
17053     * Once the icon object is set, a previously set one will be deleted.
17054     * @warning Setting the same icon for two items will cause the icon to
17055     * dissapear from the first item.
17056     *
17057     * If an icon was passed as argument on item creation, with function
17058     * elm_list_item_append() or similar, it will be already
17059     * associated to the item.
17060     *
17061     * @see elm_list_item_append()
17062     * @see elm_list_item_icon_get()
17063     *
17064     * @ingroup List
17065     */
17066    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17067
17068    /**
17069     * Get the right side icon associated to the item.
17070     *
17071     * @param item The list item
17072     * @return The right side icon associated to @p item
17073     *
17074     * The return value is a pointer to the icon associated to @p item when
17075     * it was
17076     * created, with function elm_list_item_append() or similar, or later
17077     * with function elm_list_item_icon_set(). If no icon
17078     * was passed as argument, it will return @c NULL.
17079     *
17080     * @see elm_list_item_append()
17081     * @see elm_list_item_icon_set()
17082     *
17083     * @ingroup List
17084     */
17085    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17086
17087    /**
17088     * Set the right side icon associated to the item.
17089     *
17090     * @param item The list item
17091     * @param end The right side icon object to associate with @p item
17092     *
17093     * The icon object to use at right side of the item. An
17094     * icon can be any Evas object, but usually it is an icon created
17095     * with elm_icon_add().
17096     *
17097     * Once the icon object is set, a previously set one will be deleted.
17098     * @warning Setting the same icon for two items will cause the icon to
17099     * dissapear from the first item.
17100     *
17101     * If an icon was passed as argument on item creation, with function
17102     * elm_list_item_append() or similar, it will be already
17103     * associated to the item.
17104     *
17105     * @see elm_list_item_append()
17106     * @see elm_list_item_end_get()
17107     *
17108     * @ingroup List
17109     */
17110    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17111
17112    /**
17113     * Gets the base object of the item.
17114     *
17115     * @param item The list item
17116     * @return The base object associated with @p item
17117     *
17118     * Base object is the @c Evas_Object that represents that item.
17119     *
17120     * @ingroup List
17121     */
17122    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17123    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17124
17125    /**
17126     * Get the label of item.
17127     *
17128     * @param item The item of list.
17129     * @return The label of item.
17130     *
17131     * The return value is a pointer to the label associated to @p item when
17132     * it was created, with function elm_list_item_append(), or later
17133     * with function elm_list_item_label_set. If no label
17134     * was passed as argument, it will return @c NULL.
17135     *
17136     * @see elm_list_item_label_set() for more details.
17137     * @see elm_list_item_append()
17138     *
17139     * @ingroup List
17140     */
17141    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17142
17143    /**
17144     * Set the label of item.
17145     *
17146     * @param item The item of list.
17147     * @param text The label of item.
17148     *
17149     * The label to be displayed by the item.
17150     * Label will be placed between left and right side icons (if set).
17151     *
17152     * If a label was passed as argument on item creation, with function
17153     * elm_list_item_append() or similar, it will be already
17154     * displayed by the item.
17155     *
17156     * @see elm_list_item_label_get()
17157     * @see elm_list_item_append()
17158     *
17159     * @ingroup List
17160     */
17161    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17162
17163
17164    /**
17165     * Get the item before @p it in list.
17166     *
17167     * @param it The list item.
17168     * @return The item before @p it, or @c NULL if none or on failure.
17169     *
17170     * @note If it is the first item, @c NULL will be returned.
17171     *
17172     * @see elm_list_item_append()
17173     * @see elm_list_items_get()
17174     *
17175     * @ingroup List
17176     */
17177    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17178
17179    /**
17180     * Get the item after @p it in list.
17181     *
17182     * @param it The list item.
17183     * @return The item after @p it, or @c NULL if none or on failure.
17184     *
17185     * @note If it is the last item, @c NULL will be returned.
17186     *
17187     * @see elm_list_item_append()
17188     * @see elm_list_items_get()
17189     *
17190     * @ingroup List
17191     */
17192    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17193
17194    /**
17195     * Sets the disabled/enabled state of a list item.
17196     *
17197     * @param it The item.
17198     * @param disabled The disabled state.
17199     *
17200     * A disabled item cannot be selected or unselected. It will also
17201     * change its appearance (generally greyed out). This sets the
17202     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17203     * enabled).
17204     *
17205     * @ingroup List
17206     */
17207    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17208
17209    /**
17210     * Get a value whether list item is disabled or not.
17211     *
17212     * @param it The item.
17213     * @return The disabled state.
17214     *
17215     * @see elm_list_item_disabled_set() for more details.
17216     *
17217     * @ingroup List
17218     */
17219    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17220
17221    /**
17222     * Set the text to be shown in a given list item's tooltips.
17223     *
17224     * @param item Target item.
17225     * @param text The text to set in the content.
17226     *
17227     * Setup the text as tooltip to object. The item can have only one tooltip,
17228     * so any previous tooltip data - set with this function or
17229     * elm_list_item_tooltip_content_cb_set() - is removed.
17230     *
17231     * @see elm_object_tooltip_text_set() for more details.
17232     *
17233     * @ingroup List
17234     */
17235    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17236
17237
17238    /**
17239     * @brief Disable size restrictions on an object's tooltip
17240     * @param item The tooltip's anchor object
17241     * @param disable If EINA_TRUE, size restrictions are disabled
17242     * @return EINA_FALSE on failure, EINA_TRUE on success
17243     *
17244     * This function allows a tooltip to expand beyond its parant window's canvas.
17245     * It will instead be limited only by the size of the display.
17246     */
17247    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17248    /**
17249     * @brief Retrieve size restriction state of an object's tooltip
17250     * @param obj The tooltip's anchor object
17251     * @return If EINA_TRUE, size restrictions are disabled
17252     *
17253     * This function returns whether a tooltip is allowed to expand beyond
17254     * its parant window's canvas.
17255     * It will instead be limited only by the size of the display.
17256     */
17257    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17258
17259    /**
17260     * Set the content to be shown in the tooltip item.
17261     *
17262     * Setup the tooltip to item. The item can have only one tooltip,
17263     * so any previous tooltip data is removed. @p func(with @p data) will
17264     * be called every time that need show the tooltip and it should
17265     * return a valid Evas_Object. This object is then managed fully by
17266     * tooltip system and is deleted when the tooltip is gone.
17267     *
17268     * @param item the list item being attached a tooltip.
17269     * @param func the function used to create the tooltip contents.
17270     * @param data what to provide to @a func as callback data/context.
17271     * @param del_cb called when data is not needed anymore, either when
17272     *        another callback replaces @a func, the tooltip is unset with
17273     *        elm_list_item_tooltip_unset() or the owner @a item
17274     *        dies. This callback receives as the first parameter the
17275     *        given @a data, and @c event_info is the item.
17276     *
17277     * @see elm_object_tooltip_content_cb_set() for more details.
17278     *
17279     * @ingroup List
17280     */
17281    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);
17282
17283    /**
17284     * Unset tooltip from item.
17285     *
17286     * @param item list item to remove previously set tooltip.
17287     *
17288     * Remove tooltip from item. The callback provided as del_cb to
17289     * elm_list_item_tooltip_content_cb_set() will be called to notify
17290     * it is not used anymore.
17291     *
17292     * @see elm_object_tooltip_unset() for more details.
17293     * @see elm_list_item_tooltip_content_cb_set()
17294     *
17295     * @ingroup List
17296     */
17297    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17298
17299    /**
17300     * Sets a different style for this item tooltip.
17301     *
17302     * @note before you set a style you should define a tooltip with
17303     *       elm_list_item_tooltip_content_cb_set() or
17304     *       elm_list_item_tooltip_text_set()
17305     *
17306     * @param item list item with tooltip already set.
17307     * @param style the theme style to use (default, transparent, ...)
17308     *
17309     * @see elm_object_tooltip_style_set() for more details.
17310     *
17311     * @ingroup List
17312     */
17313    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17314
17315    /**
17316     * Get the style for this item tooltip.
17317     *
17318     * @param item list item with tooltip already set.
17319     * @return style the theme style in use, defaults to "default". If the
17320     *         object does not have a tooltip set, then NULL is returned.
17321     *
17322     * @see elm_object_tooltip_style_get() for more details.
17323     * @see elm_list_item_tooltip_style_set()
17324     *
17325     * @ingroup List
17326     */
17327    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17328
17329    /**
17330     * Set the type of mouse pointer/cursor decoration to be shown,
17331     * when the mouse pointer is over the given list widget item
17332     *
17333     * @param item list item to customize cursor on
17334     * @param cursor the cursor type's name
17335     *
17336     * This function works analogously as elm_object_cursor_set(), but
17337     * here the cursor's changing area is restricted to the item's
17338     * area, and not the whole widget's. Note that that item cursors
17339     * have precedence over widget cursors, so that a mouse over an
17340     * item with custom cursor set will always show @b that cursor.
17341     *
17342     * If this function is called twice for an object, a previously set
17343     * cursor will be unset on the second call.
17344     *
17345     * @see elm_object_cursor_set()
17346     * @see elm_list_item_cursor_get()
17347     * @see elm_list_item_cursor_unset()
17348     *
17349     * @ingroup List
17350     */
17351    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17352
17353    /*
17354     * Get the type of mouse pointer/cursor decoration set to be shown,
17355     * when the mouse pointer is over the given list widget item
17356     *
17357     * @param item list item with custom cursor set
17358     * @return the cursor type's name or @c NULL, if no custom cursors
17359     * were set to @p item (and on errors)
17360     *
17361     * @see elm_object_cursor_get()
17362     * @see elm_list_item_cursor_set()
17363     * @see elm_list_item_cursor_unset()
17364     *
17365     * @ingroup List
17366     */
17367    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17368
17369    /**
17370     * Unset any custom mouse pointer/cursor decoration set to be
17371     * shown, when the mouse pointer is over the given list widget
17372     * item, thus making it show the @b default cursor again.
17373     *
17374     * @param item a list item
17375     *
17376     * Use this call to undo any custom settings on this item's cursor
17377     * decoration, bringing it back to defaults (no custom style set).
17378     *
17379     * @see elm_object_cursor_unset()
17380     * @see elm_list_item_cursor_set()
17381     *
17382     * @ingroup List
17383     */
17384    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17385
17386    /**
17387     * Set a different @b style for a given custom cursor set for a
17388     * list item.
17389     *
17390     * @param item list item with custom cursor set
17391     * @param style the <b>theme style</b> to use (e.g. @c "default",
17392     * @c "transparent", etc)
17393     *
17394     * This function only makes sense when one is using custom mouse
17395     * cursor decorations <b>defined in a theme file</b>, which can have,
17396     * given a cursor name/type, <b>alternate styles</b> on it. It
17397     * works analogously as elm_object_cursor_style_set(), but here
17398     * applyed only to list item objects.
17399     *
17400     * @warning Before you set a cursor style you should have definen a
17401     *       custom cursor previously on the item, with
17402     *       elm_list_item_cursor_set()
17403     *
17404     * @see elm_list_item_cursor_engine_only_set()
17405     * @see elm_list_item_cursor_style_get()
17406     *
17407     * @ingroup List
17408     */
17409    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17410
17411    /**
17412     * Get the current @b style set for a given list item's custom
17413     * cursor
17414     *
17415     * @param item list item with custom cursor set.
17416     * @return style the cursor style in use. If the object does not
17417     *         have a cursor set, then @c NULL is returned.
17418     *
17419     * @see elm_list_item_cursor_style_set() for more details
17420     *
17421     * @ingroup List
17422     */
17423    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17424
17425    /**
17426     * Set if the (custom)cursor for a given list item should be
17427     * searched in its theme, also, or should only rely on the
17428     * rendering engine.
17429     *
17430     * @param item item with custom (custom) cursor already set on
17431     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17432     * only on those provided by the rendering engine, @c EINA_FALSE to
17433     * have them searched on the widget's theme, as well.
17434     *
17435     * @note This call is of use only if you've set a custom cursor
17436     * for list items, with elm_list_item_cursor_set().
17437     *
17438     * @note By default, cursors will only be looked for between those
17439     * provided by the rendering engine.
17440     *
17441     * @ingroup List
17442     */
17443    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17444
17445    /**
17446     * Get if the (custom) cursor for a given list item is being
17447     * searched in its theme, also, or is only relying on the rendering
17448     * engine.
17449     *
17450     * @param item a list item
17451     * @return @c EINA_TRUE, if cursors are being looked for only on
17452     * those provided by the rendering engine, @c EINA_FALSE if they
17453     * are being searched on the widget's theme, as well.
17454     *
17455     * @see elm_list_item_cursor_engine_only_set(), for more details
17456     *
17457     * @ingroup List
17458     */
17459    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17460
17461    /**
17462     * @}
17463     */
17464
17465    /**
17466     * @defgroup Slider Slider
17467     * @ingroup Elementary
17468     *
17469     * @image html img/widget/slider/preview-00.png
17470     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17471     *
17472     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
17473     * something within a range.
17474     *
17475     * A slider can be horizontal or vertical. It can contain an Icon and has a
17476     * primary label as well as a units label (that is formatted with floating
17477     * point values and thus accepts a printf-style format string, like
17478     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
17479     * else (like on the slider itself) that also accepts a format string like
17480     * units. Label, Icon Unit and Indicator strings/objects are optional.
17481     *
17482     * A slider may be inverted which means values invert, with high vales being
17483     * on the left or top and low values on the right or bottom (as opposed to
17484     * normally being low on the left or top and high on the bottom and right).
17485     *
17486     * The slider should have its minimum and maximum values set by the
17487     * application with  elm_slider_min_max_set() and value should also be set by
17488     * the application before use with  elm_slider_value_set(). The span of the
17489     * slider is its length (horizontally or vertically). This will be scaled by
17490     * the object or applications scaling factor. At any point code can query the
17491     * slider for its value with elm_slider_value_get().
17492     *
17493     * Smart callbacks one can listen to:
17494     * - "changed" - Whenever the slider value is changed by the user.
17495     * - "slider,drag,start" - dragging the slider indicator around has started.
17496     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17497     * - "delay,changed" - A short time after the value is changed by the user.
17498     * This will be called only when the user stops dragging for
17499     * a very short period or when they release their
17500     * finger/mouse, so it avoids possibly expensive reactions to
17501     * the value change.
17502     *
17503     * Available styles for it:
17504     * - @c "default"
17505     *
17506     * Default contents parts of the slider widget that you can use for are:
17507     * @li "icon" - A icon of the slider
17508     * @li "end" - A end part content of the slider
17509     * 
17510     * Default text parts of the silder widget that you can use for are:
17511     * @li "default" - Label of the silder
17512     * Here is an example on its usage:
17513     * @li @ref slider_example
17514     */
17515
17516    /**
17517     * @addtogroup Slider
17518     * @{
17519     */
17520
17521    /**
17522     * Add a new slider widget to the given parent Elementary
17523     * (container) object.
17524     *
17525     * @param parent The parent object.
17526     * @return a new slider widget handle or @c NULL, on errors.
17527     *
17528     * This function inserts a new slider widget on the canvas.
17529     *
17530     * @ingroup Slider
17531     */
17532    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17533
17534    /**
17535     * Set the label of a given slider widget
17536     *
17537     * @param obj The progress bar object
17538     * @param label The text label string, in UTF-8
17539     *
17540     * @ingroup Slider
17541     * @deprecated use elm_object_text_set() instead.
17542     */
17543    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17544
17545    /**
17546     * Get the label of a given slider widget
17547     *
17548     * @param obj The progressbar object
17549     * @return The text label string, in UTF-8
17550     *
17551     * @ingroup Slider
17552     * @deprecated use elm_object_text_get() instead.
17553     */
17554    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17555
17556    /**
17557     * Set the icon object of the slider object.
17558     *
17559     * @param obj The slider object.
17560     * @param icon The icon object.
17561     *
17562     * On horizontal mode, icon is placed at left, and on vertical mode,
17563     * placed at top.
17564     *
17565     * @note Once the icon object is set, a previously set one will be deleted.
17566     * If you want to keep that old content object, use the
17567     * elm_slider_icon_unset() function.
17568     *
17569     * @warning If the object being set does not have minimum size hints set,
17570     * it won't get properly displayed.
17571     *
17572     * @ingroup Slider
17573     * @deprecated use elm_object_part_content_set() instead.
17574     */
17575    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17576
17577    /**
17578     * Unset an icon set on a given slider widget.
17579     *
17580     * @param obj The slider object.
17581     * @return The icon object that was being used, if any was set, or
17582     * @c NULL, otherwise (and on errors).
17583     *
17584     * On horizontal mode, icon is placed at left, and on vertical mode,
17585     * placed at top.
17586     *
17587     * This call will unparent and return the icon object which was set
17588     * for this widget, previously, on success.
17589     *
17590     * @see elm_slider_icon_set() for more details
17591     * @see elm_slider_icon_get()
17592     * @deprecated use elm_object_part_content_unset() instead.
17593     *
17594     * @ingroup Slider
17595     */
17596    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17597
17598    /**
17599     * Retrieve the icon object set for a given slider widget.
17600     *
17601     * @param obj The slider object.
17602     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17603     * otherwise (and on errors).
17604     *
17605     * On horizontal mode, icon is placed at left, and on vertical mode,
17606     * placed at top.
17607     *
17608     * @see elm_slider_icon_set() for more details
17609     * @see elm_slider_icon_unset()
17610     *
17611     * @deprecated use elm_object_part_content_get() instead.
17612     *
17613     * @ingroup Slider
17614     */
17615    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17616
17617    /**
17618     * Set the end object of the slider object.
17619     *
17620     * @param obj The slider object.
17621     * @param end The end object.
17622     *
17623     * On horizontal mode, end is placed at left, and on vertical mode,
17624     * placed at bottom.
17625     *
17626     * @note Once the icon object is set, a previously set one will be deleted.
17627     * If you want to keep that old content object, use the
17628     * elm_slider_end_unset() function.
17629     *
17630     * @warning If the object being set does not have minimum size hints set,
17631     * it won't get properly displayed.
17632     *
17633     * @deprecated use elm_object_part_content_set() instead.
17634     *
17635     * @ingroup Slider
17636     */
17637    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17638
17639    /**
17640     * Unset an end object set on a given slider widget.
17641     *
17642     * @param obj The slider object.
17643     * @return The end object that was being used, if any was set, or
17644     * @c NULL, otherwise (and on errors).
17645     *
17646     * On horizontal mode, end is placed at left, and on vertical mode,
17647     * placed at bottom.
17648     *
17649     * This call will unparent and return the icon object which was set
17650     * for this widget, previously, on success.
17651     *
17652     * @see elm_slider_end_set() for more details.
17653     * @see elm_slider_end_get()
17654     *
17655     * @deprecated use elm_object_part_content_unset() instead
17656     * instead.
17657     *
17658     * @ingroup Slider
17659     */
17660    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17661
17662    /**
17663     * Retrieve the end object set for a given slider widget.
17664     *
17665     * @param obj The slider object.
17666     * @return The end object's handle, if @p obj had one set, or @c NULL,
17667     * otherwise (and on errors).
17668     *
17669     * On horizontal mode, icon is placed at right, and on vertical mode,
17670     * placed at bottom.
17671     *
17672     * @see elm_slider_end_set() for more details.
17673     * @see elm_slider_end_unset()
17674     *
17675     *
17676     * @deprecated use elm_object_part_content_get() instead 
17677     * instead.
17678     *
17679     * @ingroup Slider
17680     */
17681    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17682
17683    /**
17684     * Set the (exact) length of the bar region of a given slider widget.
17685     *
17686     * @param obj The slider object.
17687     * @param size The length of the slider's bar region.
17688     *
17689     * This sets the minimum width (when in horizontal mode) or height
17690     * (when in vertical mode) of the actual bar area of the slider
17691     * @p obj. This in turn affects the object's minimum size. Use
17692     * this when you're not setting other size hints expanding on the
17693     * given direction (like weight and alignment hints) and you would
17694     * like it to have a specific size.
17695     *
17696     * @note Icon, end, label, indicator and unit text around @p obj
17697     * will require their
17698     * own space, which will make @p obj to require more the @p size,
17699     * actually.
17700     *
17701     * @see elm_slider_span_size_get()
17702     *
17703     * @ingroup Slider
17704     */
17705    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17706
17707    /**
17708     * Get the length set for the bar region of a given slider widget
17709     *
17710     * @param obj The slider object.
17711     * @return The length of the slider's bar region.
17712     *
17713     * If that size was not set previously, with
17714     * elm_slider_span_size_set(), this call will return @c 0.
17715     *
17716     * @ingroup Slider
17717     */
17718    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17719
17720    /**
17721     * Set the format string for the unit label.
17722     *
17723     * @param obj The slider object.
17724     * @param format The format string for the unit display.
17725     *
17726     * Unit label is displayed all the time, if set, after slider's bar.
17727     * In horizontal mode, at right and in vertical mode, at bottom.
17728     *
17729     * If @c NULL, unit label won't be visible. If not it sets the format
17730     * string for the label text. To the label text is provided a floating point
17731     * value, so the label text can display up to 1 floating point value.
17732     * Note that this is optional.
17733     *
17734     * Use a format string such as "%1.2f meters" for example, and it will
17735     * display values like: "3.14 meters" for a value equal to 3.14159.
17736     *
17737     * Default is unit label disabled.
17738     *
17739     * @see elm_slider_indicator_format_get()
17740     *
17741     * @ingroup Slider
17742     */
17743    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17744
17745    /**
17746     * Get the unit label format of the slider.
17747     *
17748     * @param obj The slider object.
17749     * @return The unit label format string in UTF-8.
17750     *
17751     * Unit label is displayed all the time, if set, after slider's bar.
17752     * In horizontal mode, at right and in vertical mode, at bottom.
17753     *
17754     * @see elm_slider_unit_format_set() for more
17755     * information on how this works.
17756     *
17757     * @ingroup Slider
17758     */
17759    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17760
17761    /**
17762     * Set the format string for the indicator label.
17763     *
17764     * @param obj The slider object.
17765     * @param indicator The format string for the indicator display.
17766     *
17767     * The slider may display its value somewhere else then unit label,
17768     * for example, above the slider knob that is dragged around. This function
17769     * sets the format string used for this.
17770     *
17771     * If @c NULL, indicator label won't be visible. If not it sets the format
17772     * string for the label text. To the label text is provided a floating point
17773     * value, so the label text can display up to 1 floating point value.
17774     * Note that this is optional.
17775     *
17776     * Use a format string such as "%1.2f meters" for example, and it will
17777     * display values like: "3.14 meters" for a value equal to 3.14159.
17778     *
17779     * Default is indicator label disabled.
17780     *
17781     * @see elm_slider_indicator_format_get()
17782     *
17783     * @ingroup Slider
17784     */
17785    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17786
17787    /**
17788     * Get the indicator label format of the slider.
17789     *
17790     * @param obj The slider object.
17791     * @return The indicator label format string in UTF-8.
17792     *
17793     * The slider may display its value somewhere else then unit label,
17794     * for example, above the slider knob that is dragged around. This function
17795     * gets the format string used for this.
17796     *
17797     * @see elm_slider_indicator_format_set() for more
17798     * information on how this works.
17799     *
17800     * @ingroup Slider
17801     */
17802    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17803
17804    /**
17805     * Set the format function pointer for the indicator label
17806     *
17807     * @param obj The slider object.
17808     * @param func The indicator format function.
17809     * @param free_func The freeing function for the format string.
17810     *
17811     * Set the callback function to format the indicator string.
17812     *
17813     * @see elm_slider_indicator_format_set() for more info on how this works.
17814     *
17815     * @ingroup Slider
17816     */
17817   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);
17818
17819   /**
17820    * Set the format function pointer for the units label
17821    *
17822    * @param obj The slider object.
17823    * @param func The units format function.
17824    * @param free_func The freeing function for the format string.
17825    *
17826    * Set the callback function to format the indicator string.
17827    *
17828    * @see elm_slider_units_format_set() for more info on how this works.
17829    *
17830    * @ingroup Slider
17831    */
17832   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);
17833
17834   /**
17835    * Set the orientation of a given slider widget.
17836    *
17837    * @param obj The slider object.
17838    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17839    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17840    *
17841    * Use this function to change how your slider is to be
17842    * disposed: vertically or horizontally.
17843    *
17844    * By default it's displayed horizontally.
17845    *
17846    * @see elm_slider_horizontal_get()
17847    *
17848    * @ingroup Slider
17849    */
17850    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17851
17852    /**
17853     * Retrieve the orientation of a given slider widget
17854     *
17855     * @param obj The slider object.
17856     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17857     * @c EINA_FALSE if it's @b vertical (and on errors).
17858     *
17859     * @see elm_slider_horizontal_set() for more details.
17860     *
17861     * @ingroup Slider
17862     */
17863    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17864
17865    /**
17866     * Set the minimum and maximum values for the slider.
17867     *
17868     * @param obj The slider object.
17869     * @param min The minimum value.
17870     * @param max The maximum value.
17871     *
17872     * Define the allowed range of values to be selected by the user.
17873     *
17874     * If actual value is less than @p min, it will be updated to @p min. If it
17875     * is bigger then @p max, will be updated to @p max. Actual value can be
17876     * get with elm_slider_value_get().
17877     *
17878     * By default, min is equal to 0.0, and max is equal to 1.0.
17879     *
17880     * @warning Maximum must be greater than minimum, otherwise behavior
17881     * is undefined.
17882     *
17883     * @see elm_slider_min_max_get()
17884     *
17885     * @ingroup Slider
17886     */
17887    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17888
17889    /**
17890     * Get the minimum and maximum values of the slider.
17891     *
17892     * @param obj The slider object.
17893     * @param min Pointer where to store the minimum value.
17894     * @param max Pointer where to store the maximum value.
17895     *
17896     * @note If only one value is needed, the other pointer can be passed
17897     * as @c NULL.
17898     *
17899     * @see elm_slider_min_max_set() for details.
17900     *
17901     * @ingroup Slider
17902     */
17903    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17904
17905    /**
17906     * Set the value the slider displays.
17907     *
17908     * @param obj The slider object.
17909     * @param val The value to be displayed.
17910     *
17911     * Value will be presented on the unit label following format specified with
17912     * elm_slider_unit_format_set() and on indicator with
17913     * elm_slider_indicator_format_set().
17914     *
17915     * @warning The value must to be between min and max values. This values
17916     * are set by elm_slider_min_max_set().
17917     *
17918     * @see elm_slider_value_get()
17919     * @see elm_slider_unit_format_set()
17920     * @see elm_slider_indicator_format_set()
17921     * @see elm_slider_min_max_set()
17922     *
17923     * @ingroup Slider
17924     */
17925    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17926
17927    /**
17928     * Get the value displayed by the spinner.
17929     *
17930     * @param obj The spinner object.
17931     * @return The value displayed.
17932     *
17933     * @see elm_spinner_value_set() for details.
17934     *
17935     * @ingroup Slider
17936     */
17937    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17938
17939    /**
17940     * Invert a given slider widget's displaying values order
17941     *
17942     * @param obj The slider object.
17943     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17944     * @c EINA_FALSE to bring it back to default, non-inverted values.
17945     *
17946     * A slider may be @b inverted, in which state it gets its
17947     * values inverted, with high vales being on the left or top and
17948     * low values on the right or bottom, as opposed to normally have
17949     * the low values on the former and high values on the latter,
17950     * respectively, for horizontal and vertical modes.
17951     *
17952     * @see elm_slider_inverted_get()
17953     *
17954     * @ingroup Slider
17955     */
17956    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17957
17958    /**
17959     * Get whether a given slider widget's displaying values are
17960     * inverted or not.
17961     *
17962     * @param obj The slider object.
17963     * @return @c EINA_TRUE, if @p obj has inverted values,
17964     * @c EINA_FALSE otherwise (and on errors).
17965     *
17966     * @see elm_slider_inverted_set() for more details.
17967     *
17968     * @ingroup Slider
17969     */
17970    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17971
17972    /**
17973     * Set whether to enlarge slider indicator (augmented knob) or not.
17974     *
17975     * @param obj The slider object.
17976     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17977     * let the knob always at default size.
17978     *
17979     * By default, indicator will be bigger while dragged by the user.
17980     *
17981     * @warning It won't display values set with
17982     * elm_slider_indicator_format_set() if you disable indicator.
17983     *
17984     * @ingroup Slider
17985     */
17986    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17987
17988    /**
17989     * Get whether a given slider widget's enlarging indicator or not.
17990     *
17991     * @param obj The slider object.
17992     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17993     * @c EINA_FALSE otherwise (and on errors).
17994     *
17995     * @see elm_slider_indicator_show_set() for details.
17996     *
17997     * @ingroup Slider
17998     */
17999    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18000
18001    /**
18002     * @}
18003     */
18004
18005    /**
18006     * @addtogroup Actionslider Actionslider
18007     *
18008     * @image html img/widget/actionslider/preview-00.png
18009     * @image latex img/widget/actionslider/preview-00.eps
18010     *
18011     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18012     * properties. The user drags and releases the indicator, to choose a label.
18013     *
18014     * Labels occupy the following positions.
18015     * a. Left
18016     * b. Right
18017     * c. Center
18018     *
18019     * Positions can be enabled or disabled.
18020     *
18021     * Magnets can be set on the above positions.
18022     *
18023     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18024     *
18025     * @note By default all positions are set as enabled.
18026     *
18027     * Signals that you can add callbacks for are:
18028     *
18029     * "selected" - when user selects an enabled position (the label is passed
18030     *              as event info)".
18031     * @n
18032     * "pos_changed" - when the indicator reaches any of the positions("left",
18033     *                 "right" or "center").
18034     *
18035     * See an example of actionslider usage @ref actionslider_example_page "here"
18036     * @{
18037     */
18038    typedef enum _Elm_Actionslider_Pos
18039      {
18040         ELM_ACTIONSLIDER_NONE = 0,
18041         ELM_ACTIONSLIDER_LEFT = 1 << 0,
18042         ELM_ACTIONSLIDER_CENTER = 1 << 1,
18043         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18044         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18045      } Elm_Actionslider_Pos;
18046
18047    /**
18048     * Add a new actionslider to the parent.
18049     *
18050     * @param parent The parent object
18051     * @return The new actionslider object or NULL if it cannot be created
18052     */
18053    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18054    /**
18055     * Set actionslider labels.
18056     *
18057     * @param obj The actionslider object
18058     * @param left_label The label to be set on the left.
18059     * @param center_label The label to be set on the center.
18060     * @param right_label The label to be set on the right.
18061     * @deprecated use elm_object_text_set() instead.
18062     */
18063    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);
18064    /**
18065     * Get actionslider labels.
18066     *
18067     * @param obj The actionslider object
18068     * @param left_label A char** to place the left_label of @p obj into.
18069     * @param center_label A char** to place the center_label of @p obj into.
18070     * @param right_label A char** to place the right_label of @p obj into.
18071     * @deprecated use elm_object_text_set() instead.
18072     */
18073    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);
18074    /**
18075     * Get actionslider selected label.
18076     *
18077     * @param obj The actionslider object
18078     * @return The selected label
18079     */
18080    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18081    /**
18082     * Set actionslider indicator position.
18083     *
18084     * @param obj The actionslider object.
18085     * @param pos The position of the indicator.
18086     */
18087    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18088    /**
18089     * Get actionslider indicator position.
18090     *
18091     * @param obj The actionslider object.
18092     * @return The position of the indicator.
18093     */
18094    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18095    /**
18096     * Set actionslider magnet position. To make multiple positions magnets @c or
18097     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18098     *
18099     * @param obj The actionslider object.
18100     * @param pos Bit mask indicating the magnet positions.
18101     */
18102    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18103    /**
18104     * Get actionslider magnet position.
18105     *
18106     * @param obj The actionslider object.
18107     * @return The positions with magnet property.
18108     */
18109    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18110    /**
18111     * Set actionslider enabled position. To set multiple positions as enabled @c or
18112     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18113     *
18114     * @note All the positions are enabled by default.
18115     *
18116     * @param obj The actionslider object.
18117     * @param pos Bit mask indicating the enabled positions.
18118     */
18119    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18120    /**
18121     * Get actionslider enabled position.
18122     *
18123     * @param obj The actionslider object.
18124     * @return The enabled positions.
18125     */
18126    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18127    /**
18128     * Set the label used on the indicator.
18129     *
18130     * @param obj The actionslider object
18131     * @param label The label to be set on the indicator.
18132     * @deprecated use elm_object_text_set() instead.
18133     */
18134    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18135    /**
18136     * Get the label used on the indicator object.
18137     *
18138     * @param obj The actionslider object
18139     * @return The indicator label
18140     * @deprecated use elm_object_text_get() instead.
18141     */
18142    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18143    /**
18144     * @}
18145     */
18146
18147    /**
18148     * @defgroup Genlist Genlist
18149     *
18150     * @image html img/widget/genlist/preview-00.png
18151     * @image latex img/widget/genlist/preview-00.eps
18152     * @image html img/genlist.png
18153     * @image latex img/genlist.eps
18154     *
18155     * This widget aims to have more expansive list than the simple list in
18156     * Elementary that could have more flexible items and allow many more entries
18157     * while still being fast and low on memory usage. At the same time it was
18158     * also made to be able to do tree structures. But the price to pay is more
18159     * complexity when it comes to usage. If all you want is a simple list with
18160     * icons and a single label, use the normal @ref List object.
18161     *
18162     * Genlist has a fairly large API, mostly because it's relatively complex,
18163     * trying to be both expansive, powerful and efficient. First we will begin
18164     * an overview on the theory behind genlist.
18165     *
18166     * @section Genlist_Item_Class Genlist item classes - creating items
18167     *
18168     * In order to have the ability to add and delete items on the fly, genlist
18169     * implements a class (callback) system where the application provides a
18170     * structure with information about that type of item (genlist may contain
18171     * multiple different items with different classes, states and styles).
18172     * Genlist will call the functions in this struct (methods) when an item is
18173     * "realized" (i.e., created dynamically, while the user is scrolling the
18174     * grid). All objects will simply be deleted when no longer needed with
18175     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18176     * following members:
18177     * - @c item_style - This is a constant string and simply defines the name
18178     *   of the item style. It @b must be specified and the default should be @c
18179     *   "default".
18180     *
18181     * - @c func - A struct with pointers to functions that will be called when
18182     *   an item is going to be actually created. All of them receive a @c data
18183     *   parameter that will point to the same data passed to
18184     *   elm_genlist_item_append() and related item creation functions, and a @c
18185     *   obj parameter that points to the genlist object itself.
18186     *
18187     * The function pointers inside @c func are @c label_get, @c icon_get, @c
18188     * state_get and @c del. The 3 first functions also receive a @c part
18189     * parameter described below. A brief description of these functions follows:
18190     *
18191     * - @c label_get - The @c part parameter is the name string of one of the
18192     *   existing text parts in the Edje group implementing the item's theme.
18193     *   This function @b must return a strdup'()ed string, as the caller will
18194     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18195     * - @c content_get - The @c part parameter is the name string of one of the
18196     *   existing (content) swallow parts in the Edje group implementing the item's
18197     *   theme. It must return @c NULL, when no content is desired, or a valid
18198     *   object handle, otherwise.  The object will be deleted by the genlist on
18199     *   its deletion or when the item is "unrealized".  See
18200     *   #Elm_Genlist_Item_Content_Get_Cb.
18201     * - @c func.state_get - The @c part parameter is the name string of one of
18202     *   the state parts in the Edje group implementing the item's theme. Return
18203     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18204     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18205     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18206     *   the state is true (the default is false), where @c XXX is the name of
18207     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18208     * - @c func.del - This is intended for use when genlist items are deleted,
18209     *   so any data attached to the item (e.g. its data parameter on creation)
18210     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18211     *
18212     * available item styles:
18213     * - default
18214     * - default_style - The text part is a textblock
18215     *
18216     * @image html img/widget/genlist/preview-04.png
18217     * @image latex img/widget/genlist/preview-04.eps
18218     *
18219     * - double_label
18220     *
18221     * @image html img/widget/genlist/preview-01.png
18222     * @image latex img/widget/genlist/preview-01.eps
18223     *
18224     * - icon_top_text_bottom
18225     *
18226     * @image html img/widget/genlist/preview-02.png
18227     * @image latex img/widget/genlist/preview-02.eps
18228     *
18229     * - group_index
18230     *
18231     * @image html img/widget/genlist/preview-03.png
18232     * @image latex img/widget/genlist/preview-03.eps
18233     *
18234     * @section Genlist_Items Structure of items
18235     *
18236     * An item in a genlist can have 0 or more text labels (they can be regular
18237     * text or textblock Evas objects - that's up to the style to determine), 0
18238     * or more contents (which are simply objects swallowed into the genlist item's
18239     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18240     * behavior left to the user to define. The Edje part names for each of
18241     * these properties will be looked up, in the theme file for the genlist,
18242     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18243     * "states", respectively. For each of those properties, if more than one
18244     * part is provided, they must have names listed separated by spaces in the
18245     * data fields. For the default genlist item theme, we have @b one label
18246     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18247     * "elm.swallow.end") and @b no state parts.
18248     *
18249     * A genlist item may be at one of several styles. Elementary provides one
18250     * by default - "default", but this can be extended by system or application
18251     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18252     * details).
18253     *
18254     * @section Genlist_Manipulation Editing and Navigating
18255     *
18256     * Items can be added by several calls. All of them return a @ref
18257     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18258     * They all take a data parameter that is meant to be used for a handle to
18259     * the applications internal data (eg the struct with the original item
18260     * data). The parent parameter is the parent genlist item this belongs to if
18261     * it is a tree or an indexed group, and NULL if there is no parent. The
18262     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18263     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18264     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18265     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18266     * is set then this item is group index item that is displayed at the top
18267     * until the next group comes. The func parameter is a convenience callback
18268     * that is called when the item is selected and the data parameter will be
18269     * the func_data parameter, obj be the genlist object and event_info will be
18270     * the genlist item.
18271     *
18272     * elm_genlist_item_append() adds an item to the end of the list, or if
18273     * there is a parent, to the end of all the child items of the parent.
18274     * elm_genlist_item_prepend() is the same but adds to the beginning of
18275     * the list or children list. elm_genlist_item_insert_before() inserts at
18276     * item before another item and elm_genlist_item_insert_after() inserts after
18277     * the indicated item.
18278     *
18279     * The application can clear the list with elm_gen_clear() which deletes
18280     * all the items in the list and elm_genlist_item_del() will delete a specific
18281     * item. elm_genlist_item_subitems_clear() will clear all items that are
18282     * children of the indicated parent item.
18283     *
18284     * To help inspect list items you can jump to the item at the top of the list
18285     * with elm_genlist_first_item_get() which will return the item pointer, and
18286     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18287     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18288     * and previous items respectively relative to the indicated item. Using
18289     * these calls you can walk the entire item list/tree. Note that as a tree
18290     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18291     * let you know which item is the parent (and thus know how to skip them if
18292     * wanted).
18293     *
18294     * @section Genlist_Muti_Selection Multi-selection
18295     *
18296     * If the application wants multiple items to be able to be selected,
18297     * elm_genlist_multi_select_set() can enable this. If the list is
18298     * single-selection only (the default), then elm_genlist_selected_item_get()
18299     * will return the selected item, if any, or NULL if none is selected. If the
18300     * list is multi-select then elm_genlist_selected_items_get() will return a
18301     * list (that is only valid as long as no items are modified (added, deleted,
18302     * selected or unselected)).
18303     *
18304     * @section Genlist_Usage_Hints Usage hints
18305     *
18306     * There are also convenience functions. elm_gen_item_genlist_get() will
18307     * return the genlist object the item belongs to. elm_genlist_item_show()
18308     * will make the scroller scroll to show that specific item so its visible.
18309     * elm_genlist_item_data_get() returns the data pointer set by the item
18310     * creation functions.
18311     *
18312     * If an item changes (state of boolean changes, label or contents change),
18313     * then use elm_genlist_item_update() to have genlist update the item with
18314     * the new state. Genlist will re-realize the item thus call the functions
18315     * in the _Elm_Genlist_Item_Class for that item.
18316     *
18317     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18318     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18319     * to expand/contract an item and get its expanded state, use
18320     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18321     * again to make an item disabled (unable to be selected and appear
18322     * differently) use elm_genlist_item_disabled_set() to set this and
18323     * elm_genlist_item_disabled_get() to get the disabled state.
18324     *
18325     * In general to indicate how the genlist should expand items horizontally to
18326     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18327     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18328     * mode means that if items are too wide to fit, the scroller will scroll
18329     * horizontally. Otherwise items are expanded to fill the width of the
18330     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18331     * to the viewport width and limited to that size. This can be combined with
18332     * a different style that uses edjes' ellipsis feature (cutting text off like
18333     * this: "tex...").
18334     *
18335     * Items will only call their selection func and callback when first becoming
18336     * selected. Any further clicks will do nothing, unless you enable always
18337     * select with elm_gen_always_select_mode_set(). This means even if
18338     * selected, every click will make the selected callbacks be called.
18339     * elm_genlist_no_select_mode_set() will turn off the ability to select
18340     * items entirely and they will neither appear selected nor call selected
18341     * callback functions.
18342     *
18343     * Remember that you can create new styles and add your own theme augmentation
18344     * per application with elm_theme_extension_add(). If you absolutely must
18345     * have a specific style that overrides any theme the user or system sets up
18346     * you can use elm_theme_overlay_add() to add such a file.
18347     *
18348     * @section Genlist_Implementation Implementation
18349     *
18350     * Evas tracks every object you create. Every time it processes an event
18351     * (mouse move, down, up etc.) it needs to walk through objects and find out
18352     * what event that affects. Even worse every time it renders display updates,
18353     * in order to just calculate what to re-draw, it needs to walk through many
18354     * many many objects. Thus, the more objects you keep active, the more
18355     * overhead Evas has in just doing its work. It is advisable to keep your
18356     * active objects to the minimum working set you need. Also remember that
18357     * object creation and deletion carries an overhead, so there is a
18358     * middle-ground, which is not easily determined. But don't keep massive lists
18359     * of objects you can't see or use. Genlist does this with list objects. It
18360     * creates and destroys them dynamically as you scroll around. It groups them
18361     * into blocks so it can determine the visibility etc. of a whole block at
18362     * once as opposed to having to walk the whole list. This 2-level list allows
18363     * for very large numbers of items to be in the list (tests have used up to
18364     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18365     * may be different sizes, every item added needs to be calculated as to its
18366     * size and thus this presents a lot of overhead on populating the list, this
18367     * genlist employs a queue. Any item added is queued and spooled off over
18368     * time, actually appearing some time later, so if your list has many members
18369     * you may find it takes a while for them to all appear, with your process
18370     * consuming a lot of CPU while it is busy spooling.
18371     *
18372     * Genlist also implements a tree structure, but it does so with callbacks to
18373     * the application, with the application filling in tree structures when
18374     * requested (allowing for efficient building of a very deep tree that could
18375     * even be used for file-management). See the above smart signal callbacks for
18376     * details.
18377     *
18378     * @section Genlist_Smart_Events Genlist smart events
18379     *
18380     * Signals that you can add callbacks for are:
18381     * - @c "activated" - The user has double-clicked or pressed
18382     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18383     *   item that was activated.
18384     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18385     *   event_info parameter is the item that was double-clicked.
18386     * - @c "selected" - This is called when a user has made an item selected.
18387     *   The event_info parameter is the genlist item that was selected.
18388     * - @c "unselected" - This is called when a user has made an item
18389     *   unselected. The event_info parameter is the genlist item that was
18390     *   unselected.
18391     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18392     *   called and the item is now meant to be expanded. The event_info
18393     *   parameter is the genlist item that was indicated to expand.  It is the
18394     *   job of this callback to then fill in the child items.
18395     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18396     *   called and the item is now meant to be contracted. The event_info
18397     *   parameter is the genlist item that was indicated to contract. It is the
18398     *   job of this callback to then delete the child items.
18399     * - @c "expand,request" - This is called when a user has indicated they want
18400     *   to expand a tree branch item. The callback should decide if the item can
18401     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18402     *   appropriately to set the state. The event_info parameter is the genlist
18403     *   item that was indicated to expand.
18404     * - @c "contract,request" - This is called when a user has indicated they
18405     *   want to contract a tree branch item. The callback should decide if the
18406     *   item can contract (has any children) and then call
18407     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18408     *   event_info parameter is the genlist item that was indicated to contract.
18409     * - @c "realized" - This is called when the item in the list is created as a
18410     *   real evas object. event_info parameter is the genlist item that was
18411     *   created. The object may be deleted at any time, so it is up to the
18412     *   caller to not use the object pointer from elm_genlist_item_object_get()
18413     *   in a way where it may point to freed objects.
18414     * - @c "unrealized" - This is called just before an item is unrealized.
18415     *   After this call content objects provided will be deleted and the item
18416     *   object itself delete or be put into a floating cache.
18417     * - @c "drag,start,up" - This is called when the item in the list has been
18418     *   dragged (not scrolled) up.
18419     * - @c "drag,start,down" - This is called when the item in the list has been
18420     *   dragged (not scrolled) down.
18421     * - @c "drag,start,left" - This is called when the item in the list has been
18422     *   dragged (not scrolled) left.
18423     * - @c "drag,start,right" - This is called when the item in the list has
18424     *   been dragged (not scrolled) right.
18425     * - @c "drag,stop" - This is called when the item in the list has stopped
18426     *   being dragged.
18427     * - @c "drag" - This is called when the item in the list is being dragged.
18428     * - @c "longpressed" - This is called when the item is pressed for a certain
18429     *   amount of time. By default it's 1 second.
18430     * - @c "scroll,anim,start" - This is called when scrolling animation has
18431     *   started.
18432     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18433     *   stopped.
18434     * - @c "scroll,drag,start" - This is called when dragging the content has
18435     *   started.
18436     * - @c "scroll,drag,stop" - This is called when dragging the content has
18437     *   stopped.
18438     * - @c "edge,top" - This is called when the genlist is scrolled until
18439     *   the top edge.
18440     * - @c "edge,bottom" - This is called when the genlist is scrolled
18441     *   until the bottom edge.
18442     * - @c "edge,left" - This is called when the genlist is scrolled
18443     *   until the left edge.
18444     * - @c "edge,right" - This is called when the genlist is scrolled
18445     *   until the right edge.
18446     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18447     *   swiped left.
18448     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18449     *   swiped right.
18450     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18451     *   swiped up.
18452     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18453     *   swiped down.
18454     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18455     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18456     *   multi-touch pinched in.
18457     * - @c "swipe" - This is called when the genlist is swiped.
18458     * - @c "moved" - This is called when a genlist item is moved.
18459     * - @c "language,changed" - This is called when the program's language is
18460     *   changed.
18461     *
18462     * @section Genlist_Examples Examples
18463     *
18464     * Here is a list of examples that use the genlist, trying to show some of
18465     * its capabilities:
18466     * - @ref genlist_example_01
18467     * - @ref genlist_example_02
18468     * - @ref genlist_example_03
18469     * - @ref genlist_example_04
18470     * - @ref genlist_example_05
18471     */
18472
18473    /**
18474     * @addtogroup Genlist
18475     * @{
18476     */
18477
18478    /**
18479     * @enum _Elm_Genlist_Item_Flags
18480     * @typedef Elm_Genlist_Item_Flags
18481     *
18482     * Defines if the item is of any special type (has subitems or it's the
18483     * index of a group), or is just a simple item.
18484     *
18485     * @ingroup Genlist
18486     */
18487    typedef enum _Elm_Genlist_Item_Flags
18488      {
18489         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18490         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18491         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18492      } Elm_Genlist_Item_Flags;
18493    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18494    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18495    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18496    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18497    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18498    /**
18499     * Label fetching class function for Elm_Gen_Item_Class.
18500     * @param data The data passed in the item creation function
18501     * @param obj The base widget object
18502     * @param part The part name of the swallow
18503     * @return The allocated (NOT stringshared) string to set as the label
18504     */
18505    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18506    /**
18507     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18508     * @param data The data passed in the item creation function
18509     * @param obj The base widget object
18510     * @param part The part name of the swallow
18511     * @return The content object to swallow
18512     */
18513    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
18514    /**
18515     * State fetching class function for Elm_Gen_Item_Class.
18516     * @param data The data passed in the item creation function
18517     * @param obj The base widget object
18518     * @param part The part name of the swallow
18519     * @return The hell if I know
18520     */
18521    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18522    /**
18523     * Deletion class function for Elm_Gen_Item_Class.
18524     * @param data The data passed in the item creation function
18525     * @param obj The base widget object
18526     */
18527    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj);
18528
18529    /**
18530     * @struct _Elm_Genlist_Item_Class
18531     *
18532     * Genlist item class definition structs.
18533     *
18534     * This struct contains the style and fetching functions that will define the
18535     * contents of each item.
18536     *
18537     * @see @ref Genlist_Item_Class
18538     */
18539    struct _Elm_Genlist_Item_Class
18540      {
18541         const char                *item_style; /**< style of this class. */
18542         struct Elm_Genlist_Item_Class_Func
18543           {
18544              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
18545              Elm_Genlist_Item_Content_Get_Cb   content_get; /**< Content fetching class function for genlist item classes. */
18546              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
18547              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
18548           } func;
18549      };
18550    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18551    /**
18552     * Add a new genlist widget to the given parent Elementary
18553     * (container) object
18554     *
18555     * @param parent The parent object
18556     * @return a new genlist widget handle or @c NULL, on errors
18557     *
18558     * This function inserts a new genlist widget on the canvas.
18559     *
18560     * @see elm_genlist_item_append()
18561     * @see elm_genlist_item_del()
18562     * @see elm_gen_clear()
18563     *
18564     * @ingroup Genlist
18565     */
18566    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18567    /**
18568     * Remove all items from a given genlist widget.
18569     *
18570     * @param obj The genlist object
18571     *
18572     * This removes (and deletes) all items in @p obj, leaving it empty.
18573     *
18574     * This is deprecated. Please use elm_gen_clear() instead.
18575     * 
18576     * @see elm_genlist_item_del(), to remove just one item.
18577     *
18578     * @ingroup Genlist
18579     */
18580    EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18581    /**
18582     * Enable or disable multi-selection in the genlist
18583     *
18584     * @param obj The genlist object
18585     * @param multi Multi-select enable/disable. Default is disabled.
18586     *
18587     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18588     * the list. This allows more than 1 item to be selected. To retrieve the list
18589     * of selected items, use elm_genlist_selected_items_get().
18590     *
18591     * @see elm_genlist_selected_items_get()
18592     * @see elm_genlist_multi_select_get()
18593     *
18594     * @ingroup Genlist
18595     */
18596    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18597    /**
18598     * Gets if multi-selection in genlist is enabled or disabled.
18599     *
18600     * @param obj The genlist object
18601     * @return Multi-select enabled/disabled
18602     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18603     *
18604     * @see elm_genlist_multi_select_set()
18605     *
18606     * @ingroup Genlist
18607     */
18608    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18609    /**
18610     * This sets the horizontal stretching mode.
18611     *
18612     * @param obj The genlist object
18613     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18614     *
18615     * This sets the mode used for sizing items horizontally. Valid modes
18616     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18617     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18618     * the scroller will scroll horizontally. Otherwise items are expanded
18619     * to fill the width of the viewport of the scroller. If it is
18620     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18621     * limited to that size.
18622     *
18623     * @see elm_genlist_horizontal_get()
18624     *
18625     * @ingroup Genlist
18626     */
18627    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18628    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18629    /**
18630     * Gets the horizontal stretching mode.
18631     *
18632     * @param obj The genlist object
18633     * @return The mode to use
18634     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18635     *
18636     * @see elm_genlist_horizontal_set()
18637     *
18638     * @ingroup Genlist
18639     */
18640    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18641    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18642    /**
18643     * Set the always select mode.
18644     *
18645     * @param obj The genlist object
18646     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18647     * EINA_FALSE = off). Default is @c EINA_FALSE.
18648     *
18649     * Items will only call their selection func and callback when first
18650     * becoming selected. Any further clicks will do nothing, unless you
18651     * enable always select with elm_gen_always_select_mode_set().
18652     * This means that, even if selected, every click will make the selected
18653     * callbacks be called.
18654     * 
18655     * This function is deprecated. please see elm_gen_always_select_mode_set()
18656     *
18657     * @see elm_genlist_always_select_mode_get()
18658     *
18659     * @ingroup Genlist
18660     */
18661    EINA_DEPRECATED EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18662    /**
18663     * Get the always select mode.
18664     *
18665     * @param obj The genlist object
18666     * @return The always select mode
18667     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18668     *
18669     * @see elm_genlist_always_select_mode_set()
18670     *
18671     * @ingroup Genlist
18672     */
18673    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18674    /**
18675     * Enable/disable the no select mode.
18676     *
18677     * @param obj The genlist object
18678     * @param no_select The no select mode
18679     * (EINA_TRUE = on, EINA_FALSE = off)
18680     *
18681     * This will turn off the ability to select items entirely and they
18682     * will neither appear selected nor call selected callback functions.
18683     *
18684     * @see elm_genlist_no_select_mode_get()
18685     *
18686     * @ingroup Genlist
18687     */
18688    EINA_DEPRECATED EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18689    /**
18690     * Gets whether the no select mode is enabled.
18691     *
18692     * @param obj The genlist object
18693     * @return The no select mode
18694     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18695     *
18696     * @see elm_genlist_no_select_mode_set()
18697     *
18698     * @ingroup Genlist
18699     */
18700    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18701    /**
18702     * Enable/disable compress mode.
18703     *
18704     * @param obj The genlist object
18705     * @param compress The compress mode
18706     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18707     *
18708     * This will enable the compress mode where items are "compressed"
18709     * horizontally to fit the genlist scrollable viewport width. This is
18710     * special for genlist.  Do not rely on
18711     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18712     * work as genlist needs to handle it specially.
18713     *
18714     * @see elm_genlist_compress_mode_get()
18715     *
18716     * @ingroup Genlist
18717     */
18718    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18719    /**
18720     * Get whether the compress mode is enabled.
18721     *
18722     * @param obj The genlist object
18723     * @return The compress mode
18724     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18725     *
18726     * @see elm_genlist_compress_mode_set()
18727     *
18728     * @ingroup Genlist
18729     */
18730    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18731    /**
18732     * Enable/disable height-for-width mode.
18733     *
18734     * @param obj The genlist object
18735     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18736     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18737     *
18738     * With height-for-width mode the item width will be fixed (restricted
18739     * to a minimum of) to the list width when calculating its size in
18740     * order to allow the height to be calculated based on it. This allows,
18741     * for instance, text block to wrap lines if the Edje part is
18742     * configured with "text.min: 0 1".
18743     *
18744     * @note This mode will make list resize slower as it will have to
18745     *       recalculate every item height again whenever the list width
18746     *       changes!
18747     *
18748     * @note When height-for-width mode is enabled, it also enables
18749     *       compress mode (see elm_genlist_compress_mode_set()) and
18750     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18751     *
18752     * @ingroup Genlist
18753     */
18754    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18755    /**
18756     * Get whether the height-for-width mode is enabled.
18757     *
18758     * @param obj The genlist object
18759     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18760     * off)
18761     *
18762     * @ingroup Genlist
18763     */
18764    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18765    /**
18766     * Enable/disable horizontal and vertical bouncing effect.
18767     *
18768     * @param obj The genlist object
18769     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18770     * EINA_FALSE = off). Default is @c EINA_FALSE.
18771     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18772     * EINA_FALSE = off). Default is @c EINA_TRUE.
18773     *
18774     * This will enable or disable the scroller bouncing effect for the
18775     * genlist. See elm_scroller_bounce_set() for details.
18776     *
18777     * @see elm_scroller_bounce_set()
18778     * @see elm_genlist_bounce_get()
18779     *
18780     * @ingroup Genlist
18781     */
18782    EINA_DEPRECATED EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18783    /**
18784     * Get whether the horizontal and vertical bouncing effect is enabled.
18785     *
18786     * @param obj The genlist object
18787     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18788     * option is set.
18789     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18790     * option is set.
18791     *
18792     * @see elm_genlist_bounce_set()
18793     *
18794     * @ingroup Genlist
18795     */
18796    EINA_DEPRECATED EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18797    /**
18798     * Enable/disable homogenous mode.
18799     *
18800     * @param obj The genlist object
18801     * @param homogeneous Assume the items within the genlist are of the
18802     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18803     * EINA_FALSE.
18804     *
18805     * This will enable the homogeneous mode where items are of the same
18806     * height and width so that genlist may do the lazy-loading at its
18807     * maximum (which increases the performance for scrolling the list). This
18808     * implies 'compressed' mode.
18809     *
18810     * @see elm_genlist_compress_mode_set()
18811     * @see elm_genlist_homogeneous_get()
18812     *
18813     * @ingroup Genlist
18814     */
18815    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18816    /**
18817     * Get whether the homogenous mode is enabled.
18818     *
18819     * @param obj The genlist object
18820     * @return Assume the items within the genlist are of the same height
18821     * and width (EINA_TRUE = on, EINA_FALSE = off)
18822     *
18823     * @see elm_genlist_homogeneous_set()
18824     *
18825     * @ingroup Genlist
18826     */
18827    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18828    /**
18829     * Set the maximum number of items within an item block
18830     *
18831     * @param obj The genlist object
18832     * @param n   Maximum number of items within an item block. Default is 32.
18833     *
18834     * This will configure the block count to tune to the target with
18835     * particular performance matrix.
18836     *
18837     * A block of objects will be used to reduce the number of operations due to
18838     * many objects in the screen. It can determine the visibility, or if the
18839     * object has changed, it theme needs to be updated, etc. doing this kind of
18840     * calculation to the entire block, instead of per object.
18841     *
18842     * The default value for the block count is enough for most lists, so unless
18843     * you know you will have a lot of objects visible in the screen at the same
18844     * time, don't try to change this.
18845     *
18846     * @see elm_genlist_block_count_get()
18847     * @see @ref Genlist_Implementation
18848     *
18849     * @ingroup Genlist
18850     */
18851    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18852    /**
18853     * Get the maximum number of items within an item block
18854     *
18855     * @param obj The genlist object
18856     * @return Maximum number of items within an item block
18857     *
18858     * @see elm_genlist_block_count_set()
18859     *
18860     * @ingroup Genlist
18861     */
18862    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18863    /**
18864     * Set the timeout in seconds for the longpress event.
18865     *
18866     * @param obj The genlist object
18867     * @param timeout timeout in seconds. Default is 1.
18868     *
18869     * This option will change how long it takes to send an event "longpressed"
18870     * after the mouse down signal is sent to the list. If this event occurs, no
18871     * "clicked" event will be sent.
18872     *
18873     * @see elm_genlist_longpress_timeout_set()
18874     *
18875     * @ingroup Genlist
18876     */
18877    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18878    /**
18879     * Get the timeout in seconds for the longpress event.
18880     *
18881     * @param obj The genlist object
18882     * @return timeout in seconds
18883     *
18884     * @see elm_genlist_longpress_timeout_get()
18885     *
18886     * @ingroup Genlist
18887     */
18888    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18889    /**
18890     * Append a new item in a given genlist widget.
18891     *
18892     * @param obj The genlist object
18893     * @param itc The item class for the item
18894     * @param data The item data
18895     * @param parent The parent item, or NULL if none
18896     * @param flags Item flags
18897     * @param func Convenience function called when the item is selected
18898     * @param func_data Data passed to @p func above.
18899     * @return A handle to the item added or @c NULL if not possible
18900     *
18901     * This adds the given item to the end of the list or the end of
18902     * the children list if the @p parent is given.
18903     *
18904     * @see elm_genlist_item_prepend()
18905     * @see elm_genlist_item_insert_before()
18906     * @see elm_genlist_item_insert_after()
18907     * @see elm_genlist_item_del()
18908     *
18909     * @ingroup Genlist
18910     */
18911    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);
18912    /**
18913     * Prepend a new item in a given genlist widget.
18914     *
18915     * @param obj The genlist object
18916     * @param itc The item class for the item
18917     * @param data The item data
18918     * @param parent The parent item, or NULL if none
18919     * @param flags Item flags
18920     * @param func Convenience function called when the item is selected
18921     * @param func_data Data passed to @p func above.
18922     * @return A handle to the item added or NULL if not possible
18923     *
18924     * This adds an item to the beginning of the list or beginning of the
18925     * children of the parent if given.
18926     *
18927     * @see elm_genlist_item_append()
18928     * @see elm_genlist_item_insert_before()
18929     * @see elm_genlist_item_insert_after()
18930     * @see elm_genlist_item_del()
18931     *
18932     * @ingroup Genlist
18933     */
18934    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);
18935    /**
18936     * Insert an item before another in a genlist widget
18937     *
18938     * @param obj The genlist object
18939     * @param itc The item class for the item
18940     * @param data The item data
18941     * @param before The item to place this new one before.
18942     * @param flags Item flags
18943     * @param func Convenience function called when the item is selected
18944     * @param func_data Data passed to @p func above.
18945     * @return A handle to the item added or @c NULL if not possible
18946     *
18947     * This inserts an item before another in the list. It will be in the
18948     * same tree level or group as the item it is inserted before.
18949     *
18950     * @see elm_genlist_item_append()
18951     * @see elm_genlist_item_prepend()
18952     * @see elm_genlist_item_insert_after()
18953     * @see elm_genlist_item_del()
18954     *
18955     * @ingroup Genlist
18956     */
18957    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);
18958    /**
18959     * Insert an item after another in a genlist widget
18960     *
18961     * @param obj The genlist object
18962     * @param itc The item class for the item
18963     * @param data The item data
18964     * @param after The item to place this new one after.
18965     * @param flags Item flags
18966     * @param func Convenience function called when the item is selected
18967     * @param func_data Data passed to @p func above.
18968     * @return A handle to the item added or @c NULL if not possible
18969     *
18970     * This inserts an item after another in the list. It will be in the
18971     * same tree level or group as the item it is inserted after.
18972     *
18973     * @see elm_genlist_item_append()
18974     * @see elm_genlist_item_prepend()
18975     * @see elm_genlist_item_insert_before()
18976     * @see elm_genlist_item_del()
18977     *
18978     * @ingroup Genlist
18979     */
18980    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);
18981    /**
18982     * Insert a new item into the sorted genlist object
18983     *
18984     * @param obj The genlist object
18985     * @param itc The item class for the item
18986     * @param data The item data
18987     * @param parent The parent item, or NULL if none
18988     * @param flags Item flags
18989     * @param comp The function called for the sort
18990     * @param func Convenience function called when item selected
18991     * @param func_data Data passed to @p func above.
18992     * @return A handle to the item added or NULL if not possible
18993     *
18994     * @ingroup Genlist
18995     */
18996    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);
18997    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);
18998    /* operations to retrieve existing items */
18999    /**
19000     * Get the selectd item in the genlist.
19001     *
19002     * @param obj The genlist object
19003     * @return The selected item, or NULL if none is selected.
19004     *
19005     * This gets the selected item in the list (if multi-selection is enabled, only
19006     * the item that was first selected in the list is returned - which is not very
19007     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19008     * used).
19009     *
19010     * If no item is selected, NULL is returned.
19011     *
19012     * @see elm_genlist_selected_items_get()
19013     *
19014     * @ingroup Genlist
19015     */
19016    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19017    /**
19018     * Get a list of selected items in the genlist.
19019     *
19020     * @param obj The genlist object
19021     * @return The list of selected items, or NULL if none are selected.
19022     *
19023     * It returns a list of the selected items. This list pointer is only valid so
19024     * long as the selection doesn't change (no items are selected or unselected, or
19025     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19026     * pointers. The order of the items in this list is the order which they were
19027     * selected, i.e. the first item in this list is the first item that was
19028     * selected, and so on.
19029     *
19030     * @note If not in multi-select mode, consider using function
19031     * elm_genlist_selected_item_get() instead.
19032     *
19033     * @see elm_genlist_multi_select_set()
19034     * @see elm_genlist_selected_item_get()
19035     *
19036     * @ingroup Genlist
19037     */
19038    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19039    /**
19040     * Get the mode item style of items in the genlist
19041     * @param obj The genlist object
19042     * @return The mode item style string, or NULL if none is specified
19043     * 
19044     * This is a constant string and simply defines the name of the
19045     * style that will be used for mode animations. It can be
19046     * @c NULL if you don't plan to use Genlist mode. See
19047     * elm_genlist_item_mode_set() for more info.
19048     * 
19049     * @ingroup Genlist
19050     */
19051    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19052    /**
19053     * Set the mode item style of items in the genlist
19054     * @param obj The genlist object
19055     * @param style The mode item style string, or NULL if none is desired
19056     * 
19057     * This is a constant string and simply defines the name of the
19058     * style that will be used for mode animations. It can be
19059     * @c NULL if you don't plan to use Genlist mode. See
19060     * elm_genlist_item_mode_set() for more info.
19061     * 
19062     * @ingroup Genlist
19063     */
19064    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19065    /**
19066     * Get a list of realized items in genlist
19067     *
19068     * @param obj The genlist object
19069     * @return The list of realized items, nor NULL if none are realized.
19070     *
19071     * This returns a list of the realized items in the genlist. The list
19072     * contains Elm_Genlist_Item pointers. The list must be freed by the
19073     * caller when done with eina_list_free(). The item pointers in the
19074     * list are only valid so long as those items are not deleted or the
19075     * genlist is not deleted.
19076     *
19077     * @see elm_genlist_realized_items_update()
19078     *
19079     * @ingroup Genlist
19080     */
19081    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19082    /**
19083     * Get the item that is at the x, y canvas coords.
19084     *
19085     * @param obj The gelinst object.
19086     * @param x The input x coordinate
19087     * @param y The input y coordinate
19088     * @param posret The position relative to the item returned here
19089     * @return The item at the coordinates or NULL if none
19090     *
19091     * This returns the item at the given coordinates (which are canvas
19092     * relative, not object-relative). If an item is at that coordinate,
19093     * that item handle is returned, and if @p posret is not NULL, the
19094     * integer pointed to is set to a value of -1, 0 or 1, depending if
19095     * the coordinate is on the upper portion of that item (-1), on the
19096     * middle section (0) or on the lower part (1). If NULL is returned as
19097     * an item (no item found there), then posret may indicate -1 or 1
19098     * based if the coordinate is above or below all items respectively in
19099     * the genlist.
19100     *
19101     * @ingroup Genlist
19102     */
19103    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);
19104    /**
19105     * Get the first item in the genlist
19106     *
19107     * This returns the first item in the list.
19108     *
19109     * @param obj The genlist object
19110     * @return The first item, or NULL if none
19111     *
19112     * @ingroup Genlist
19113     */
19114    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19115    /**
19116     * Get the last item in the genlist
19117     *
19118     * This returns the last item in the list.
19119     *
19120     * @return The last item, or NULL if none
19121     *
19122     * @ingroup Genlist
19123     */
19124    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19125    /**
19126     * Set the scrollbar policy
19127     *
19128     * @param obj The genlist object
19129     * @param policy_h Horizontal scrollbar policy.
19130     * @param policy_v Vertical scrollbar policy.
19131     *
19132     * This sets the scrollbar visibility policy for the given genlist
19133     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19134     * made visible if it is needed, and otherwise kept hidden.
19135     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19136     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19137     * respectively for the horizontal and vertical scrollbars. Default is
19138     * #ELM_SMART_SCROLLER_POLICY_AUTO
19139     *
19140     * @see elm_genlist_scroller_policy_get()
19141     *
19142     * @ingroup Genlist
19143     */
19144    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19145    /**
19146     * Get the scrollbar policy
19147     *
19148     * @param obj The genlist object
19149     * @param policy_h Pointer to store the horizontal scrollbar policy.
19150     * @param policy_v Pointer to store the vertical scrollbar policy.
19151     *
19152     * @see elm_genlist_scroller_policy_set()
19153     *
19154     * @ingroup Genlist
19155     */
19156    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);
19157    /**
19158     * Get the @b next item in a genlist widget's internal list of items,
19159     * given a handle to one of those items.
19160     *
19161     * @param item The genlist item to fetch next from
19162     * @return The item after @p item, or @c NULL if there's none (and
19163     * on errors)
19164     *
19165     * This returns the item placed after the @p item, on the container
19166     * genlist.
19167     *
19168     * @see elm_genlist_item_prev_get()
19169     *
19170     * @ingroup Genlist
19171     */
19172    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19173    /**
19174     * Get the @b previous item in a genlist widget's internal list of items,
19175     * given a handle to one of those items.
19176     *
19177     * @param item The genlist item to fetch previous from
19178     * @return The item before @p item, or @c NULL if there's none (and
19179     * on errors)
19180     *
19181     * This returns the item placed before the @p item, on the container
19182     * genlist.
19183     *
19184     * @see elm_genlist_item_next_get()
19185     *
19186     * @ingroup Genlist
19187     */
19188    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19189    /**
19190     * Get the genlist object's handle which contains a given genlist
19191     * item
19192     *
19193     * @param item The item to fetch the container from
19194     * @return The genlist (parent) object
19195     *
19196     * This returns the genlist object itself that an item belongs to.
19197     *
19198     * This function is deprecated. Please use elm_gen_item_widget_get()
19199     * 
19200     * @ingroup Genlist
19201     */
19202    EINA_DEPRECATED EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19203    /**
19204     * Get the parent item of the given item
19205     *
19206     * @param it The item
19207     * @return The parent of the item or @c NULL if it has no parent.
19208     *
19209     * This returns the item that was specified as parent of the item @p it on
19210     * elm_genlist_item_append() and insertion related functions.
19211     *
19212     * @ingroup Genlist
19213     */
19214    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19215    /**
19216     * Remove all sub-items (children) of the given item
19217     *
19218     * @param it The item
19219     *
19220     * This removes all items that are children (and their descendants) of the
19221     * given item @p it.
19222     *
19223     * @see elm_genlist_clear()
19224     * @see elm_genlist_item_del()
19225     *
19226     * @ingroup Genlist
19227     */
19228    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19229    /**
19230     * Set whether a given genlist item is selected or not
19231     *
19232     * @param it The item
19233     * @param selected Use @c EINA_TRUE, to make it selected, @c
19234     * EINA_FALSE to make it unselected
19235     *
19236     * This sets the selected state of an item. If multi selection is
19237     * not enabled on the containing genlist and @p selected is @c
19238     * EINA_TRUE, any other previously selected items will get
19239     * unselected in favor of this new one.
19240     *
19241     * @see elm_genlist_item_selected_get()
19242     *
19243     * @ingroup Genlist
19244     */
19245    EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19246    /**
19247     * Get whether a given genlist item is selected or not
19248     *
19249     * @param it The item
19250     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19251     *
19252     * @see elm_genlist_item_selected_set() for more details
19253     *
19254     * @ingroup Genlist
19255     */
19256    EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19257    /**
19258     * Sets the expanded state of an item.
19259     *
19260     * @param it The item
19261     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19262     *
19263     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19264     * expanded or not.
19265     *
19266     * The theme will respond to this change visually, and a signal "expanded" or
19267     * "contracted" will be sent from the genlist with a pointer to the item that
19268     * has been expanded/contracted.
19269     *
19270     * Calling this function won't show or hide any child of this item (if it is
19271     * a parent). You must manually delete and create them on the callbacks fo
19272     * the "expanded" or "contracted" signals.
19273     *
19274     * @see elm_genlist_item_expanded_get()
19275     *
19276     * @ingroup Genlist
19277     */
19278    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19279    /**
19280     * Get the expanded state of an item
19281     *
19282     * @param it The item
19283     * @return The expanded state
19284     *
19285     * This gets the expanded state of an item.
19286     *
19287     * @see elm_genlist_item_expanded_set()
19288     *
19289     * @ingroup Genlist
19290     */
19291    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19292    /**
19293     * Get the depth of expanded item
19294     *
19295     * @param it The genlist item object
19296     * @return The depth of expanded item
19297     *
19298     * @ingroup Genlist
19299     */
19300    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19301    /**
19302     * Set whether a given genlist item is disabled or not.
19303     *
19304     * @param it The item
19305     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19306     * to enable it back.
19307     *
19308     * A disabled item cannot be selected or unselected. It will also
19309     * change its appearance, to signal the user it's disabled.
19310     *
19311     * @see elm_genlist_item_disabled_get()
19312     *
19313     * @ingroup Genlist
19314     */
19315    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19316    /**
19317     * Get whether a given genlist item is disabled or not.
19318     *
19319     * @param it The item
19320     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19321     * (and on errors).
19322     *
19323     * @see elm_genlist_item_disabled_set() for more details
19324     *
19325     * @ingroup Genlist
19326     */
19327    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19328    /**
19329     * Sets the display only state of an item.
19330     *
19331     * @param it The item
19332     * @param display_only @c EINA_TRUE if the item is display only, @c
19333     * EINA_FALSE otherwise.
19334     *
19335     * A display only item cannot be selected or unselected. It is for
19336     * display only and not selecting or otherwise clicking, dragging
19337     * etc. by the user, thus finger size rules will not be applied to
19338     * this item.
19339     *
19340     * It's good to set group index items to display only state.
19341     *
19342     * @see elm_genlist_item_display_only_get()
19343     *
19344     * @ingroup Genlist
19345     */
19346    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19347    /**
19348     * Get the display only state of an item
19349     *
19350     * @param it The item
19351     * @return @c EINA_TRUE if the item is display only, @c
19352     * EINA_FALSE otherwise.
19353     *
19354     * @see elm_genlist_item_display_only_set()
19355     *
19356     * @ingroup Genlist
19357     */
19358    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19359    /**
19360     * Show the portion of a genlist's internal list containing a given
19361     * item, immediately.
19362     *
19363     * @param it The item to display
19364     *
19365     * This causes genlist to jump to the given item @p it and show it (by
19366     * immediately scrolling to that position), if it is not fully visible.
19367     *
19368     * @see elm_genlist_item_bring_in()
19369     * @see elm_genlist_item_top_show()
19370     * @see elm_genlist_item_middle_show()
19371     *
19372     * @ingroup Genlist
19373     */
19374    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19375    /**
19376     * Animatedly bring in, to the visible are of a genlist, a given
19377     * item on it.
19378     *
19379     * @param it The item to display
19380     *
19381     * This causes genlist to jump to the given item @p it and show it (by
19382     * animatedly scrolling), if it is not fully visible. This may use animation
19383     * to do so and take a period of time
19384     *
19385     * @see elm_genlist_item_show()
19386     * @see elm_genlist_item_top_bring_in()
19387     * @see elm_genlist_item_middle_bring_in()
19388     *
19389     * @ingroup Genlist
19390     */
19391    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19392    /**
19393     * Show the portion of a genlist's internal list containing a given
19394     * item, immediately.
19395     *
19396     * @param it The item to display
19397     *
19398     * This causes genlist to jump to the given item @p it and show it (by
19399     * immediately scrolling to that position), if it is not fully visible.
19400     *
19401     * The item will be positioned at the top of the genlist viewport.
19402     *
19403     * @see elm_genlist_item_show()
19404     * @see elm_genlist_item_top_bring_in()
19405     *
19406     * @ingroup Genlist
19407     */
19408    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19409    /**
19410     * Animatedly bring in, to the visible are of a genlist, a given
19411     * item on it.
19412     *
19413     * @param it The item
19414     *
19415     * This causes genlist to jump to the given item @p it and show it (by
19416     * animatedly scrolling), if it is not fully visible. This may use animation
19417     * to do so and take a period of time
19418     *
19419     * The item will be positioned at the top of the genlist viewport.
19420     *
19421     * @see elm_genlist_item_bring_in()
19422     * @see elm_genlist_item_top_show()
19423     *
19424     * @ingroup Genlist
19425     */
19426    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19427    /**
19428     * Show the portion of a genlist's internal list containing a given
19429     * item, immediately.
19430     *
19431     * @param it The item to display
19432     *
19433     * This causes genlist to jump to the given item @p it and show it (by
19434     * immediately scrolling to that position), if it is not fully visible.
19435     *
19436     * The item will be positioned at the middle of the genlist viewport.
19437     *
19438     * @see elm_genlist_item_show()
19439     * @see elm_genlist_item_middle_bring_in()
19440     *
19441     * @ingroup Genlist
19442     */
19443    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19444    /**
19445     * Animatedly bring in, to the visible are of a genlist, a given
19446     * item on it.
19447     *
19448     * @param it The item
19449     *
19450     * This causes genlist to jump to the given item @p it and show it (by
19451     * animatedly scrolling), if it is not fully visible. This may use animation
19452     * to do so and take a period of time
19453     *
19454     * The item will be positioned at the middle of the genlist viewport.
19455     *
19456     * @see elm_genlist_item_bring_in()
19457     * @see elm_genlist_item_middle_show()
19458     *
19459     * @ingroup Genlist
19460     */
19461    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19462    /**
19463     * Remove a genlist item from the its parent, deleting it.
19464     *
19465     * @param item The item to be removed.
19466     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19467     *
19468     * @see elm_genlist_clear(), to remove all items in a genlist at
19469     * once.
19470     *
19471     * @ingroup Genlist
19472     */
19473    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19474    /**
19475     * Return the data associated to a given genlist item
19476     *
19477     * @param item The genlist item.
19478     * @return the data associated to this item.
19479     *
19480     * This returns the @c data value passed on the
19481     * elm_genlist_item_append() and related item addition calls.
19482     *
19483     * @see elm_genlist_item_append()
19484     * @see elm_genlist_item_data_set()
19485     *
19486     * @ingroup Genlist
19487     */
19488    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19489    /**
19490     * Set the data associated to a given genlist item
19491     *
19492     * @param item The genlist item
19493     * @param data The new data pointer to set on it
19494     *
19495     * This @b overrides the @c data value passed on the
19496     * elm_genlist_item_append() and related item addition calls. This
19497     * function @b won't call elm_genlist_item_update() automatically,
19498     * so you'd issue it afterwards if you want to hove the item
19499     * updated to reflect the that new data.
19500     *
19501     * @see elm_genlist_item_data_get()
19502     *
19503     * @ingroup Genlist
19504     */
19505    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19506    /**
19507     * Tells genlist to "orphan" icons fetchs by the item class
19508     *
19509     * @param it The item
19510     *
19511     * This instructs genlist to release references to icons in the item,
19512     * meaning that they will no longer be managed by genlist and are
19513     * floating "orphans" that can be re-used elsewhere if the user wants
19514     * to.
19515     *
19516     * @ingroup Genlist
19517     */
19518    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19519    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19520    /**
19521     * Get the real Evas object created to implement the view of a
19522     * given genlist item
19523     *
19524     * @param item The genlist item.
19525     * @return the Evas object implementing this item's view.
19526     *
19527     * This returns the actual Evas object used to implement the
19528     * specified genlist item's view. This may be @c NULL, as it may
19529     * not have been created or may have been deleted, at any time, by
19530     * the genlist. <b>Do not modify this object</b> (move, resize,
19531     * show, hide, etc.), as the genlist is controlling it. This
19532     * function is for querying, emitting custom signals or hooking
19533     * lower level callbacks for events on that object. Do not delete
19534     * this object under any circumstances.
19535     *
19536     * @see elm_genlist_item_data_get()
19537     *
19538     * @ingroup Genlist
19539     */
19540    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19541    /**
19542     * Update the contents of an item
19543     *
19544     * @param it The item
19545     *
19546     * This updates an item by calling all the item class functions again
19547     * to get the icons, labels and states. Use this when the original
19548     * item data has changed and the changes are desired to be reflected.
19549     *
19550     * Use elm_genlist_realized_items_update() to update all already realized
19551     * items.
19552     *
19553     * @see elm_genlist_realized_items_update()
19554     *
19555     * @ingroup Genlist
19556     */
19557    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19558    /**
19559     * Update the item class of an item
19560     *
19561     * @param it The item
19562     * @param itc The item class for the item
19563     *
19564     * This sets another class fo the item, changing the way that it is
19565     * displayed. After changing the item class, elm_genlist_item_update() is
19566     * called on the item @p it.
19567     *
19568     * @ingroup Genlist
19569     */
19570    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19571    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19572    /**
19573     * Set the text to be shown in a given genlist item's tooltips.
19574     *
19575     * @param item The genlist item
19576     * @param text The text to set in the content
19577     *
19578     * This call will setup the text to be used as tooltip to that item
19579     * (analogous to elm_object_tooltip_text_set(), but being item
19580     * tooltips with higher precedence than object tooltips). It can
19581     * have only one tooltip at a time, so any previous tooltip data
19582     * will get removed.
19583     *
19584     * In order to set an icon or something else as a tooltip, look at
19585     * elm_genlist_item_tooltip_content_cb_set().
19586     *
19587     * @ingroup Genlist
19588     */
19589    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19590    /**
19591     * Set the content to be shown in a given genlist item's tooltips
19592     *
19593     * @param item The genlist item.
19594     * @param func The function returning the tooltip contents.
19595     * @param data What to provide to @a func as callback data/context.
19596     * @param del_cb Called when data is not needed anymore, either when
19597     *        another callback replaces @p func, the tooltip is unset with
19598     *        elm_genlist_item_tooltip_unset() or the owner @p item
19599     *        dies. This callback receives as its first parameter the
19600     *        given @p data, being @c event_info the item handle.
19601     *
19602     * This call will setup the tooltip's contents to @p item
19603     * (analogous to elm_object_tooltip_content_cb_set(), but being
19604     * item tooltips with higher precedence than object tooltips). It
19605     * can have only one tooltip at a time, so any previous tooltip
19606     * content will get removed. @p func (with @p data) will be called
19607     * every time Elementary needs to show the tooltip and it should
19608     * return a valid Evas object, which will be fully managed by the
19609     * tooltip system, getting deleted when the tooltip is gone.
19610     *
19611     * In order to set just a text as a tooltip, look at
19612     * elm_genlist_item_tooltip_text_set().
19613     *
19614     * @ingroup Genlist
19615     */
19616    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);
19617    /**
19618     * Unset a tooltip from a given genlist item
19619     *
19620     * @param item genlist item to remove a previously set tooltip from.
19621     *
19622     * This call removes any tooltip set on @p item. The callback
19623     * provided as @c del_cb to
19624     * elm_genlist_item_tooltip_content_cb_set() will be called to
19625     * notify it is not used anymore (and have resources cleaned, if
19626     * need be).
19627     *
19628     * @see elm_genlist_item_tooltip_content_cb_set()
19629     *
19630     * @ingroup Genlist
19631     */
19632    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19633    /**
19634     * Set a different @b style for a given genlist item's tooltip.
19635     *
19636     * @param item genlist item with tooltip set
19637     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19638     * "default", @c "transparent", etc)
19639     *
19640     * Tooltips can have <b>alternate styles</b> to be displayed on,
19641     * which are defined by the theme set on Elementary. This function
19642     * works analogously as elm_object_tooltip_style_set(), but here
19643     * applied only to genlist item objects. The default style for
19644     * tooltips is @c "default".
19645     *
19646     * @note before you set a style you should define a tooltip with
19647     *       elm_genlist_item_tooltip_content_cb_set() or
19648     *       elm_genlist_item_tooltip_text_set()
19649     *
19650     * @see elm_genlist_item_tooltip_style_get()
19651     *
19652     * @ingroup Genlist
19653     */
19654    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19655    /**
19656     * Get the style set a given genlist item's tooltip.
19657     *
19658     * @param item genlist item with tooltip already set on.
19659     * @return style the theme style in use, which defaults to
19660     *         "default". If the object does not have a tooltip set,
19661     *         then @c NULL is returned.
19662     *
19663     * @see elm_genlist_item_tooltip_style_set() for more details
19664     *
19665     * @ingroup Genlist
19666     */
19667    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19668    /**
19669     * @brief Disable size restrictions on an object's tooltip
19670     * @param item The tooltip's anchor object
19671     * @param disable If EINA_TRUE, size restrictions are disabled
19672     * @return EINA_FALSE on failure, EINA_TRUE on success
19673     *
19674     * This function allows a tooltip to expand beyond its parant window's canvas.
19675     * It will instead be limited only by the size of the display.
19676     */
19677    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19678    /**
19679     * @brief Retrieve size restriction state of an object's tooltip
19680     * @param item The tooltip's anchor object
19681     * @return If EINA_TRUE, size restrictions are disabled
19682     *
19683     * This function returns whether a tooltip is allowed to expand beyond
19684     * its parant window's canvas.
19685     * It will instead be limited only by the size of the display.
19686     */
19687    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19688    /**
19689     * Set the type of mouse pointer/cursor decoration to be shown,
19690     * when the mouse pointer is over the given genlist widget item
19691     *
19692     * @param item genlist item to customize cursor on
19693     * @param cursor the cursor type's name
19694     *
19695     * This function works analogously as elm_object_cursor_set(), but
19696     * here the cursor's changing area is restricted to the item's
19697     * area, and not the whole widget's. Note that that item cursors
19698     * have precedence over widget cursors, so that a mouse over @p
19699     * item will always show cursor @p type.
19700     *
19701     * If this function is called twice for an object, a previously set
19702     * cursor will be unset on the second call.
19703     *
19704     * @see elm_object_cursor_set()
19705     * @see elm_genlist_item_cursor_get()
19706     * @see elm_genlist_item_cursor_unset()
19707     *
19708     * @ingroup Genlist
19709     */
19710    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19711    /**
19712     * Get the type of mouse pointer/cursor decoration set to be shown,
19713     * when the mouse pointer is over the given genlist widget item
19714     *
19715     * @param item genlist item with custom cursor set
19716     * @return the cursor type's name or @c NULL, if no custom cursors
19717     * were set to @p item (and on errors)
19718     *
19719     * @see elm_object_cursor_get()
19720     * @see elm_genlist_item_cursor_set() for more details
19721     * @see elm_genlist_item_cursor_unset()
19722     *
19723     * @ingroup Genlist
19724     */
19725    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19726    /**
19727     * Unset any custom mouse pointer/cursor decoration set to be
19728     * shown, when the mouse pointer is over the given genlist widget
19729     * item, thus making it show the @b default cursor again.
19730     *
19731     * @param item a genlist item
19732     *
19733     * Use this call to undo any custom settings on this item's cursor
19734     * decoration, bringing it back to defaults (no custom style set).
19735     *
19736     * @see elm_object_cursor_unset()
19737     * @see elm_genlist_item_cursor_set() for more details
19738     *
19739     * @ingroup Genlist
19740     */
19741    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19742    /**
19743     * Set a different @b style for a given custom cursor set for a
19744     * genlist item.
19745     *
19746     * @param item genlist item with custom cursor set
19747     * @param style the <b>theme style</b> to use (e.g. @c "default",
19748     * @c "transparent", etc)
19749     *
19750     * This function only makes sense when one is using custom mouse
19751     * cursor decorations <b>defined in a theme file</b> , which can
19752     * have, given a cursor name/type, <b>alternate styles</b> on
19753     * it. It works analogously as elm_object_cursor_style_set(), but
19754     * here applied only to genlist item objects.
19755     *
19756     * @warning Before you set a cursor style you should have defined a
19757     *       custom cursor previously on the item, with
19758     *       elm_genlist_item_cursor_set()
19759     *
19760     * @see elm_genlist_item_cursor_engine_only_set()
19761     * @see elm_genlist_item_cursor_style_get()
19762     *
19763     * @ingroup Genlist
19764     */
19765    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19766    /**
19767     * Get the current @b style set for a given genlist item's custom
19768     * cursor
19769     *
19770     * @param item genlist item with custom cursor set.
19771     * @return style the cursor style in use. If the object does not
19772     *         have a cursor set, then @c NULL is returned.
19773     *
19774     * @see elm_genlist_item_cursor_style_set() for more details
19775     *
19776     * @ingroup Genlist
19777     */
19778    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19779    /**
19780     * Set if the (custom) cursor for a given genlist item should be
19781     * searched in its theme, also, or should only rely on the
19782     * rendering engine.
19783     *
19784     * @param item item with custom (custom) cursor already set on
19785     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19786     * only on those provided by the rendering engine, @c EINA_FALSE to
19787     * have them searched on the widget's theme, as well.
19788     *
19789     * @note This call is of use only if you've set a custom cursor
19790     * for genlist items, with elm_genlist_item_cursor_set().
19791     *
19792     * @note By default, cursors will only be looked for between those
19793     * provided by the rendering engine.
19794     *
19795     * @ingroup Genlist
19796     */
19797    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19798    /**
19799     * Get if the (custom) cursor for a given genlist item is being
19800     * searched in its theme, also, or is only relying on the rendering
19801     * engine.
19802     *
19803     * @param item a genlist item
19804     * @return @c EINA_TRUE, if cursors are being looked for only on
19805     * those provided by the rendering engine, @c EINA_FALSE if they
19806     * are being searched on the widget's theme, as well.
19807     *
19808     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19809     *
19810     * @ingroup Genlist
19811     */
19812    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19813    /**
19814     * Update the contents of all realized items.
19815     *
19816     * @param obj The genlist object.
19817     *
19818     * This updates all realized items by calling all the item class functions again
19819     * to get the icons, labels and states. Use this when the original
19820     * item data has changed and the changes are desired to be reflected.
19821     *
19822     * To update just one item, use elm_genlist_item_update().
19823     *
19824     * @see elm_genlist_realized_items_get()
19825     * @see elm_genlist_item_update()
19826     *
19827     * @ingroup Genlist
19828     */
19829    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19830    /**
19831     * Activate a genlist mode on an item
19832     *
19833     * @param item The genlist item
19834     * @param mode Mode name
19835     * @param mode_set Boolean to define set or unset mode.
19836     *
19837     * A genlist mode is a different way of selecting an item. Once a mode is
19838     * activated on an item, any other selected item is immediately unselected.
19839     * This feature provides an easy way of implementing a new kind of animation
19840     * for selecting an item, without having to entirely rewrite the item style
19841     * theme. However, the elm_genlist_selected_* API can't be used to get what
19842     * item is activate for a mode.
19843     *
19844     * The current item style will still be used, but applying a genlist mode to
19845     * an item will select it using a different kind of animation.
19846     *
19847     * The current active item for a mode can be found by
19848     * elm_genlist_mode_item_get().
19849     *
19850     * The characteristics of genlist mode are:
19851     * - Only one mode can be active at any time, and for only one item.
19852     * - Genlist handles deactivating other items when one item is activated.
19853     * - A mode is defined in the genlist theme (edc), and more modes can easily
19854     *   be added.
19855     * - A mode style and the genlist item style are different things. They
19856     *   can be combined to provide a default style to the item, with some kind
19857     *   of animation for that item when the mode is activated.
19858     *
19859     * When a mode is activated on an item, a new view for that item is created.
19860     * The theme of this mode defines the animation that will be used to transit
19861     * the item from the old view to the new view. This second (new) view will be
19862     * active for that item while the mode is active on the item, and will be
19863     * destroyed after the mode is totally deactivated from that item.
19864     *
19865     * @see elm_genlist_mode_get()
19866     * @see elm_genlist_mode_item_get()
19867     *
19868     * @ingroup Genlist
19869     */
19870    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19871    /**
19872     * Get the last (or current) genlist mode used.
19873     *
19874     * @param obj The genlist object
19875     *
19876     * This function just returns the name of the last used genlist mode. It will
19877     * be the current mode if it's still active.
19878     *
19879     * @see elm_genlist_item_mode_set()
19880     * @see elm_genlist_mode_item_get()
19881     *
19882     * @ingroup Genlist
19883     */
19884    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19885    /**
19886     * Get active genlist mode item
19887     *
19888     * @param obj The genlist object
19889     * @return The active item for that current mode. Or @c NULL if no item is
19890     * activated with any mode.
19891     *
19892     * This function returns the item that was activated with a mode, by the
19893     * function elm_genlist_item_mode_set().
19894     *
19895     * @see elm_genlist_item_mode_set()
19896     * @see elm_genlist_mode_get()
19897     *
19898     * @ingroup Genlist
19899     */
19900    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19901
19902    /**
19903     * Set reorder mode
19904     *
19905     * @param obj The genlist object
19906     * @param reorder_mode The reorder mode
19907     * (EINA_TRUE = on, EINA_FALSE = off)
19908     *
19909     * @ingroup Genlist
19910     */
19911    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19912
19913    /**
19914     * Get the reorder mode
19915     *
19916     * @param obj The genlist object
19917     * @return The reorder mode
19918     * (EINA_TRUE = on, EINA_FALSE = off)
19919     *
19920     * @ingroup Genlist
19921     */
19922    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19923
19924    /**
19925     * @}
19926     */
19927
19928    /**
19929     * @defgroup Check Check
19930     *
19931     * @image html img/widget/check/preview-00.png
19932     * @image latex img/widget/check/preview-00.eps
19933     * @image html img/widget/check/preview-01.png
19934     * @image latex img/widget/check/preview-01.eps
19935     * @image html img/widget/check/preview-02.png
19936     * @image latex img/widget/check/preview-02.eps
19937     *
19938     * @brief The check widget allows for toggling a value between true and
19939     * false.
19940     *
19941     * Check objects are a lot like radio objects in layout and functionality
19942     * except they do not work as a group, but independently and only toggle the
19943     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19944     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19945     * returns the current state. For convenience, like the radio objects, you
19946     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19947     * for it to modify.
19948     *
19949     * Signals that you can add callbacks for are:
19950     * "changed" - This is called whenever the user changes the state of one of
19951     *             the check object(event_info is NULL).
19952     *
19953     * Default contents parts of the check widget that you can use for are:
19954     * @li "icon" - A icon of the check
19955     *
19956     * Default text parts of the check widget that you can use for are:
19957     * @li "elm.text" - Label of the check
19958     *
19959     * @ref tutorial_check should give you a firm grasp of how to use this widget
19960     * .
19961     * @{
19962     */
19963    /**
19964     * @brief Add a new Check object
19965     *
19966     * @param parent The parent object
19967     * @return The new object or NULL if it cannot be created
19968     */
19969    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19970    /**
19971     * @brief Set the text label of the check object
19972     *
19973     * @param obj The check object
19974     * @param label The text label string in UTF-8
19975     *
19976     * @deprecated use elm_object_text_set() instead.
19977     */
19978    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19979    /**
19980     * @brief Get the text label of the check object
19981     *
19982     * @param obj The check object
19983     * @return The text label string in UTF-8
19984     *
19985     * @deprecated use elm_object_text_get() instead.
19986     */
19987    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19988    /**
19989     * @brief Set the icon object of the check object
19990     *
19991     * @param obj The check object
19992     * @param icon The icon object
19993     *
19994     * Once the icon object is set, a previously set one will be deleted.
19995     * If you want to keep that old content object, use the
19996     * elm_object_content_unset() function.
19997     *
19998     * @deprecated use elm_object_part_content_set() instead.
19999     *
20000     */
20001    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20002    /**
20003     * @brief Get the icon object of the check object
20004     *
20005     * @param obj The check object
20006     * @return The icon object
20007     *
20008     * @deprecated use elm_object_part_content_get() instead.
20009     *  
20010     */
20011    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20012    /**
20013     * @brief Unset the icon used for the check object
20014     *
20015     * @param obj The check object
20016     * @return The icon object that was being used
20017     *
20018     * Unparent and return the icon object which was set for this widget.
20019     *
20020     * @deprecated use elm_object_part_content_unset() instead.
20021     *
20022     */
20023    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20024    /**
20025     * @brief Set the on/off state of the check object
20026     *
20027     * @param obj The check object
20028     * @param state The state to use (1 == on, 0 == off)
20029     *
20030     * This sets the state of the check. If set
20031     * with elm_check_state_pointer_set() the state of that variable is also
20032     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20033     */
20034    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20035    /**
20036     * @brief Get the state of the check object
20037     *
20038     * @param obj The check object
20039     * @return The boolean state
20040     */
20041    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20042    /**
20043     * @brief Set a convenience pointer to a boolean to change
20044     *
20045     * @param obj The check object
20046     * @param statep Pointer to the boolean to modify
20047     *
20048     * This sets a pointer to a boolean, that, in addition to the check objects
20049     * state will also be modified directly. To stop setting the object pointed
20050     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20051     * then when this is called, the check objects state will also be modified to
20052     * reflect the value of the boolean @p statep points to, just like calling
20053     * elm_check_state_set().
20054     */
20055    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20056    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20057    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);
20058
20059    /**
20060     * @}
20061     */
20062
20063    /**
20064     * @defgroup Radio Radio
20065     *
20066     * @image html img/widget/radio/preview-00.png
20067     * @image latex img/widget/radio/preview-00.eps
20068     *
20069     * @brief Radio is a widget that allows for 1 or more options to be displayed
20070     * and have the user choose only 1 of them.
20071     *
20072     * A radio object contains an indicator, an optional Label and an optional
20073     * icon object. While it's possible to have a group of only one radio they,
20074     * are normally used in groups of 2 or more. To add a radio to a group use
20075     * elm_radio_group_add(). The radio object(s) will select from one of a set
20076     * of integer values, so any value they are configuring needs to be mapped to
20077     * a set of integers. To configure what value that radio object represents,
20078     * use  elm_radio_state_value_set() to set the integer it represents. To set
20079     * the value the whole group(which one is currently selected) is to indicate
20080     * use elm_radio_value_set() on any group member, and to get the groups value
20081     * use elm_radio_value_get(). For convenience the radio objects are also able
20082     * to directly set an integer(int) to the value that is selected. To specify
20083     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20084     * The radio objects will modify this directly. That implies the pointer must
20085     * point to valid memory for as long as the radio objects exist.
20086     *
20087     * Signals that you can add callbacks for are:
20088     * @li changed - This is called whenever the user changes the state of one of
20089     * the radio objects within the group of radio objects that work together.
20090     *
20091     * Default contents parts of the radio widget that you can use for are:
20092     * @li "icon" - A icon of the radio
20093     *
20094     * @ref tutorial_radio show most of this API in action.
20095     * @{
20096     */
20097    /**
20098     * @brief Add a new radio to the parent
20099     *
20100     * @param parent The parent object
20101     * @return The new object or NULL if it cannot be created
20102     */
20103    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20104    /**
20105     * @brief Set the text label of the radio object
20106     *
20107     * @param obj The radio object
20108     * @param label The text label string in UTF-8
20109     *
20110     * @deprecated use elm_object_text_set() instead.
20111     */
20112    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20113    /**
20114     * @brief Get the text label of the radio object
20115     *
20116     * @param obj The radio object
20117     * @return The text label string in UTF-8
20118     *
20119     * @deprecated use elm_object_text_set() instead.
20120     */
20121    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20122    /**
20123     * @brief Set the icon object of the radio object
20124     *
20125     * @param obj The radio object
20126     * @param icon The icon object
20127     *
20128     * Once the icon object is set, a previously set one will be deleted. If you
20129     * want to keep that old content object, use the elm_radio_icon_unset()
20130     * function.
20131     *
20132     * @deprecated use elm_object_part_content_set() instead.
20133     *
20134     */
20135    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20136    /**
20137     * @brief Get the icon object of the radio object
20138     *
20139     * @param obj The radio object
20140     * @return The icon object
20141     *
20142     * @see elm_radio_icon_set()
20143     *
20144     * @deprecated use elm_object_part_content_get() instead.
20145     *
20146     */
20147    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20148    /**
20149     * @brief Unset the icon used for the radio object
20150     *
20151     * @param obj The radio object
20152     * @return The icon object that was being used
20153     *
20154     * Unparent and return the icon object which was set for this widget.
20155     *
20156     * @see elm_radio_icon_set()
20157     * @deprecated use elm_object_part_content_unset() instead.
20158     *
20159     */
20160    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20161    /**
20162     * @brief Add this radio to a group of other radio objects
20163     *
20164     * @param obj The radio object
20165     * @param group Any object whose group the @p obj is to join.
20166     *
20167     * Radio objects work in groups. Each member should have a different integer
20168     * value assigned. In order to have them work as a group, they need to know
20169     * about each other. This adds the given radio object to the group of which
20170     * the group object indicated is a member.
20171     */
20172    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20173    /**
20174     * @brief Set the integer value that this radio object represents
20175     *
20176     * @param obj The radio object
20177     * @param value The value to use if this radio object is selected
20178     *
20179     * This sets the value of the radio.
20180     */
20181    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20182    /**
20183     * @brief Get the integer value that this radio object represents
20184     *
20185     * @param obj The radio object
20186     * @return The value used if this radio object is selected
20187     *
20188     * This gets the value of the radio.
20189     *
20190     * @see elm_radio_value_set()
20191     */
20192    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20193    /**
20194     * @brief Set the value of the radio.
20195     *
20196     * @param obj The radio object
20197     * @param value The value to use for the group
20198     *
20199     * This sets the value of the radio group and will also set the value if
20200     * pointed to, to the value supplied, but will not call any callbacks.
20201     */
20202    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20203    /**
20204     * @brief Get the state of the radio object
20205     *
20206     * @param obj The radio object
20207     * @return The integer state
20208     */
20209    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20210    /**
20211     * @brief Set a convenience pointer to a integer to change
20212     *
20213     * @param obj The radio object
20214     * @param valuep Pointer to the integer to modify
20215     *
20216     * This sets a pointer to a integer, that, in addition to the radio objects
20217     * state will also be modified directly. To stop setting the object pointed
20218     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20219     * when this is called, the radio objects state will also be modified to
20220     * reflect the value of the integer valuep points to, just like calling
20221     * elm_radio_value_set().
20222     */
20223    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20224    /**
20225     * @}
20226     */
20227
20228    /**
20229     * @defgroup Pager Pager
20230     *
20231     * @image html img/widget/pager/preview-00.png
20232     * @image latex img/widget/pager/preview-00.eps
20233     *
20234     * @brief Widget that allows flipping between one or more ā€œpagesā€
20235     * of objects.
20236     *
20237     * The flipping between pages of objects is animated. All content
20238     * in the pager is kept in a stack, being the last content added
20239     * (visible one) on the top of that stack.
20240     *
20241     * Objects can be pushed or popped from the stack or deleted as
20242     * well. Pushes and pops will animate the widget accordingly to its
20243     * style (a pop will also delete the child object once the
20244     * animation is finished). Any object already in the pager can be
20245     * promoted to the top (from its current stacking position) through
20246     * the use of elm_pager_content_promote(). New objects are pushed
20247     * to the top with elm_pager_content_push(). When the top item is
20248     * no longer wanted, simply pop it with elm_pager_content_pop() and
20249     * it will also be deleted. If an object is no longer needed and is
20250     * not the top item, just delete it as normal. You can query which
20251     * objects are the top and bottom with
20252     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20253     *
20254     * Signals that you can add callbacks for are:
20255     * - @c "show,finished" - when a new page is actually shown on the top
20256     * - @c "hide,finished" - when a previous page is hidden
20257     *
20258     * Only after the first of that signals the child object is
20259     * guaranteed to be visible, as in @c evas_object_visible_get().
20260     *
20261     * This widget has the following styles available:
20262     * - @c "default"
20263     * - @c "fade"
20264     * - @c "fade_translucide"
20265     * - @c "fade_invisible"
20266     *
20267     * @note These styles affect only the flipping animations on the
20268     * default theme; the appearance when not animating is unaffected
20269     * by them.
20270     *
20271     * @ref tutorial_pager gives a good overview of the usage of the API.
20272     * @{
20273     */
20274
20275    /**
20276     * Add a new pager to the parent
20277     *
20278     * @param parent The parent object
20279     * @return The new object or NULL if it cannot be created
20280     *
20281     * @ingroup Pager
20282     */
20283    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20284
20285    /**
20286     * @brief Push an object to the top of the pager stack (and show it).
20287     *
20288     * @param obj The pager object
20289     * @param content The object to push
20290     *
20291     * The object pushed becomes a child of the pager, it will be controlled and
20292     * deleted when the pager is deleted.
20293     *
20294     * @note If the content is already in the stack use
20295     * elm_pager_content_promote().
20296     * @warning Using this function on @p content already in the stack results in
20297     * undefined behavior.
20298     */
20299    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20300
20301    /**
20302     * @brief Pop the object that is on top of the stack
20303     *
20304     * @param obj The pager object
20305     *
20306     * This pops the object that is on the top(visible) of the pager, makes it
20307     * disappear, then deletes the object. The object that was underneath it on
20308     * the stack will become visible.
20309     */
20310    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20311
20312    /**
20313     * @brief Moves an object already in the pager stack to the top of the stack.
20314     *
20315     * @param obj The pager object
20316     * @param content The object to promote
20317     *
20318     * This will take the @p content and move it to the top of the stack as
20319     * if it had been pushed there.
20320     *
20321     * @note If the content isn't already in the stack use
20322     * elm_pager_content_push().
20323     * @warning Using this function on @p content not already in the stack
20324     * results in undefined behavior.
20325     */
20326    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20327
20328    /**
20329     * @brief Return the object at the bottom of the pager stack
20330     *
20331     * @param obj The pager object
20332     * @return The bottom object or NULL if none
20333     */
20334    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20335
20336    /**
20337     * @brief  Return the object at the top of the pager stack
20338     *
20339     * @param obj The pager object
20340     * @return The top object or NULL if none
20341     */
20342    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20343
20344    /**
20345     * @}
20346     */
20347
20348    /**
20349     * @defgroup Slideshow Slideshow
20350     *
20351     * @image html img/widget/slideshow/preview-00.png
20352     * @image latex img/widget/slideshow/preview-00.eps
20353     *
20354     * This widget, as the name indicates, is a pre-made image
20355     * slideshow panel, with API functions acting on (child) image
20356     * items presentation. Between those actions, are:
20357     * - advance to next/previous image
20358     * - select the style of image transition animation
20359     * - set the exhibition time for each image
20360     * - start/stop the slideshow
20361     *
20362     * The transition animations are defined in the widget's theme,
20363     * consequently new animations can be added without having to
20364     * update the widget's code.
20365     *
20366     * @section Slideshow_Items Slideshow items
20367     *
20368     * For slideshow items, just like for @ref Genlist "genlist" ones,
20369     * the user defines a @b classes, specifying functions that will be
20370     * called on the item's creation and deletion times.
20371     *
20372     * The #Elm_Slideshow_Item_Class structure contains the following
20373     * members:
20374     *
20375     * - @c func.get - When an item is displayed, this function is
20376     *   called, and it's where one should create the item object, de
20377     *   facto. For example, the object can be a pure Evas image object
20378     *   or an Elementary @ref Photocam "photocam" widget. See
20379     *   #SlideshowItemGetFunc.
20380     * - @c func.del - When an item is no more displayed, this function
20381     *   is called, where the user must delete any data associated to
20382     *   the item. See #SlideshowItemDelFunc.
20383     *
20384     * @section Slideshow_Caching Slideshow caching
20385     *
20386     * The slideshow provides facilities to have items adjacent to the
20387     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20388     * you, so that the system does not have to decode image data
20389     * anymore at the time it has to actually switch images on its
20390     * viewport. The user is able to set the numbers of items to be
20391     * cached @b before and @b after the current item, in the widget's
20392     * item list.
20393     *
20394     * Smart events one can add callbacks for are:
20395     *
20396     * - @c "changed" - when the slideshow switches its view to a new
20397     *   item
20398     *
20399     * List of examples for the slideshow widget:
20400     * @li @ref slideshow_example
20401     */
20402
20403    /**
20404     * @addtogroup Slideshow
20405     * @{
20406     */
20407
20408    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20409    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20410    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20411    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20412    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20413
20414    /**
20415     * @struct _Elm_Slideshow_Item_Class
20416     *
20417     * Slideshow item class definition. See @ref Slideshow_Items for
20418     * field details.
20419     */
20420    struct _Elm_Slideshow_Item_Class
20421      {
20422         struct _Elm_Slideshow_Item_Class_Func
20423           {
20424              SlideshowItemGetFunc get;
20425              SlideshowItemDelFunc del;
20426           } func;
20427      }; /**< #Elm_Slideshow_Item_Class member definitions */
20428
20429    /**
20430     * Add a new slideshow widget to the given parent Elementary
20431     * (container) object
20432     *
20433     * @param parent The parent object
20434     * @return A new slideshow widget handle or @c NULL, on errors
20435     *
20436     * This function inserts a new slideshow widget on the canvas.
20437     *
20438     * @ingroup Slideshow
20439     */
20440    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20441
20442    /**
20443     * Add (append) a new item in a given slideshow widget.
20444     *
20445     * @param obj The slideshow object
20446     * @param itc The item class for the item
20447     * @param data The item's data
20448     * @return A handle to the item added or @c NULL, on errors
20449     *
20450     * Add a new item to @p obj's internal list of items, appending it.
20451     * The item's class must contain the function really fetching the
20452     * image object to show for this item, which could be an Evas image
20453     * object or an Elementary photo, for example. The @p data
20454     * parameter is going to be passed to both class functions of the
20455     * item.
20456     *
20457     * @see #Elm_Slideshow_Item_Class
20458     * @see elm_slideshow_item_sorted_insert()
20459     *
20460     * @ingroup Slideshow
20461     */
20462    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20463
20464    /**
20465     * Insert a new item into the given slideshow widget, using the @p func
20466     * function to sort items (by item handles).
20467     *
20468     * @param obj The slideshow object
20469     * @param itc The item class for the item
20470     * @param data The item's data
20471     * @param func The comparing function to be used to sort slideshow
20472     * items <b>by #Elm_Slideshow_Item item handles</b>
20473     * @return Returns The slideshow item handle, on success, or
20474     * @c NULL, on errors
20475     *
20476     * Add a new item to @p obj's internal list of items, in a position
20477     * determined by the @p func comparing function. The item's class
20478     * must contain the function really fetching the image object to
20479     * show for this item, which could be an Evas image object or an
20480     * Elementary photo, for example. The @p data parameter is going to
20481     * be passed to both class functions of the item.
20482     *
20483     * @see #Elm_Slideshow_Item_Class
20484     * @see elm_slideshow_item_add()
20485     *
20486     * @ingroup Slideshow
20487     */
20488    EAPI Elm_Slideshow_Item *elm_slideshow_item_sorted_insert(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data, Eina_Compare_Cb func) EINA_ARG_NONNULL(1);
20489
20490    /**
20491     * Display a given slideshow widget's item, programmatically.
20492     *
20493     * @param obj The slideshow object
20494     * @param item The item to display on @p obj's viewport
20495     *
20496     * The change between the current item and @p item will use the
20497     * transition @p obj is set to use (@see
20498     * elm_slideshow_transition_set()).
20499     *
20500     * @ingroup Slideshow
20501     */
20502    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20503
20504    /**
20505     * Slide to the @b next item, in a given slideshow widget
20506     *
20507     * @param obj The slideshow object
20508     *
20509     * The sliding animation @p obj is set to use will be the
20510     * transition effect used, after this call is issued.
20511     *
20512     * @note If the end of the slideshow's internal list of items is
20513     * reached, it'll wrap around to the list's beginning, again.
20514     *
20515     * @ingroup Slideshow
20516     */
20517    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20518
20519    /**
20520     * Slide to the @b previous item, in a given slideshow widget
20521     *
20522     * @param obj The slideshow object
20523     *
20524     * The sliding animation @p obj is set to use will be the
20525     * transition effect used, after this call is issued.
20526     *
20527     * @note If the beginning of the slideshow's internal list of items
20528     * is reached, it'll wrap around to the list's end, again.
20529     *
20530     * @ingroup Slideshow
20531     */
20532    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20533
20534    /**
20535     * Returns the list of sliding transition/effect names available, for a
20536     * given slideshow widget.
20537     *
20538     * @param obj The slideshow object
20539     * @return The list of transitions (list of @b stringshared strings
20540     * as data)
20541     *
20542     * The transitions, which come from @p obj's theme, must be an EDC
20543     * data item named @c "transitions" on the theme file, with (prefix)
20544     * names of EDC programs actually implementing them.
20545     *
20546     * The available transitions for slideshows on the default theme are:
20547     * - @c "fade" - the current item fades out, while the new one
20548     *   fades in to the slideshow's viewport.
20549     * - @c "black_fade" - the current item fades to black, and just
20550     *   then, the new item will fade in.
20551     * - @c "horizontal" - the current item slides horizontally, until
20552     *   it gets out of the slideshow's viewport, while the new item
20553     *   comes from the left to take its place.
20554     * - @c "vertical" - the current item slides vertically, until it
20555     *   gets out of the slideshow's viewport, while the new item comes
20556     *   from the bottom to take its place.
20557     * - @c "square" - the new item starts to appear from the middle of
20558     *   the current one, but with a tiny size, growing until its
20559     *   target (full) size and covering the old one.
20560     *
20561     * @warning The stringshared strings get no new references
20562     * exclusive to the user grabbing the list, here, so if you'd like
20563     * to use them out of this call's context, you'd better @c
20564     * eina_stringshare_ref() them.
20565     *
20566     * @see elm_slideshow_transition_set()
20567     *
20568     * @ingroup Slideshow
20569     */
20570    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20571
20572    /**
20573     * Set the current slide transition/effect in use for a given
20574     * slideshow widget
20575     *
20576     * @param obj The slideshow object
20577     * @param transition The new transition's name string
20578     *
20579     * If @p transition is implemented in @p obj's theme (i.e., is
20580     * contained in the list returned by
20581     * elm_slideshow_transitions_get()), this new sliding effect will
20582     * be used on the widget.
20583     *
20584     * @see elm_slideshow_transitions_get() for more details
20585     *
20586     * @ingroup Slideshow
20587     */
20588    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20589
20590    /**
20591     * Get the current slide transition/effect in use for a given
20592     * slideshow widget
20593     *
20594     * @param obj The slideshow object
20595     * @return The current transition's name
20596     *
20597     * @see elm_slideshow_transition_set() for more details
20598     *
20599     * @ingroup Slideshow
20600     */
20601    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20602
20603    /**
20604     * Set the interval between each image transition on a given
20605     * slideshow widget, <b>and start the slideshow, itself</b>
20606     *
20607     * @param obj The slideshow object
20608     * @param timeout The new displaying timeout for images
20609     *
20610     * After this call, the slideshow widget will start cycling its
20611     * view, sequentially and automatically, with the images of the
20612     * items it has. The time between each new image displayed is going
20613     * to be @p timeout, in @b seconds. If a different timeout was set
20614     * previously and an slideshow was in progress, it will continue
20615     * with the new time between transitions, after this call.
20616     *
20617     * @note A value less than or equal to 0 on @p timeout will disable
20618     * the widget's internal timer, thus halting any slideshow which
20619     * could be happening on @p obj.
20620     *
20621     * @see elm_slideshow_timeout_get()
20622     *
20623     * @ingroup Slideshow
20624     */
20625    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20626
20627    /**
20628     * Get the interval set for image transitions on a given slideshow
20629     * widget.
20630     *
20631     * @param obj The slideshow object
20632     * @return Returns the timeout set on it
20633     *
20634     * @see elm_slideshow_timeout_set() for more details
20635     *
20636     * @ingroup Slideshow
20637     */
20638    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20639
20640    /**
20641     * Set if, after a slideshow is started, for a given slideshow
20642     * widget, its items should be displayed cyclically or not.
20643     *
20644     * @param obj The slideshow object
20645     * @param loop Use @c EINA_TRUE to make it cycle through items or
20646     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20647     * list of items
20648     *
20649     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20650     * ignore what is set by this functions, i.e., they'll @b always
20651     * cycle through items. This affects only the "automatic"
20652     * slideshow, as set by elm_slideshow_timeout_set().
20653     *
20654     * @see elm_slideshow_loop_get()
20655     *
20656     * @ingroup Slideshow
20657     */
20658    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20659
20660    /**
20661     * Get if, after a slideshow is started, for a given slideshow
20662     * widget, its items are to be displayed cyclically or not.
20663     *
20664     * @param obj The slideshow object
20665     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20666     * through or @c EINA_FALSE, otherwise
20667     *
20668     * @see elm_slideshow_loop_set() for more details
20669     *
20670     * @ingroup Slideshow
20671     */
20672    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20673
20674    /**
20675     * Remove all items from a given slideshow widget
20676     *
20677     * @param obj The slideshow object
20678     *
20679     * This removes (and deletes) all items in @p obj, leaving it
20680     * empty.
20681     *
20682     * @see elm_slideshow_item_del(), to remove just one item.
20683     *
20684     * @ingroup Slideshow
20685     */
20686    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20687
20688    /**
20689     * Get the internal list of items in a given slideshow widget.
20690     *
20691     * @param obj The slideshow object
20692     * @return The list of items (#Elm_Slideshow_Item as data) or
20693     * @c NULL on errors.
20694     *
20695     * This list is @b not to be modified in any way and must not be
20696     * freed. Use the list members with functions like
20697     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20698     *
20699     * @warning This list is only valid until @p obj object's internal
20700     * items list is changed. It should be fetched again with another
20701     * call to this function when changes happen.
20702     *
20703     * @ingroup Slideshow
20704     */
20705    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20706
20707    /**
20708     * Delete a given item from a slideshow widget.
20709     *
20710     * @param item The slideshow item
20711     *
20712     * @ingroup Slideshow
20713     */
20714    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20715
20716    /**
20717     * Return the data associated with a given slideshow item
20718     *
20719     * @param item The slideshow item
20720     * @return Returns the data associated to this item
20721     *
20722     * @ingroup Slideshow
20723     */
20724    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20725
20726    /**
20727     * Returns the currently displayed item, in a given slideshow widget
20728     *
20729     * @param obj The slideshow object
20730     * @return A handle to the item being displayed in @p obj or
20731     * @c NULL, if none is (and on errors)
20732     *
20733     * @ingroup Slideshow
20734     */
20735    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20736
20737    /**
20738     * Get the real Evas object created to implement the view of a
20739     * given slideshow item
20740     *
20741     * @param item The slideshow item.
20742     * @return the Evas object implementing this item's view.
20743     *
20744     * This returns the actual Evas object used to implement the
20745     * specified slideshow item's view. This may be @c NULL, as it may
20746     * not have been created or may have been deleted, at any time, by
20747     * the slideshow. <b>Do not modify this object</b> (move, resize,
20748     * show, hide, etc.), as the slideshow is controlling it. This
20749     * function is for querying, emitting custom signals or hooking
20750     * lower level callbacks for events on that object. Do not delete
20751     * this object under any circumstances.
20752     *
20753     * @see elm_slideshow_item_data_get()
20754     *
20755     * @ingroup Slideshow
20756     */
20757    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20758
20759    /**
20760     * Get the the item, in a given slideshow widget, placed at
20761     * position @p nth, in its internal items list
20762     *
20763     * @param obj The slideshow object
20764     * @param nth The number of the item to grab a handle to (0 being
20765     * the first)
20766     * @return The item stored in @p obj at position @p nth or @c NULL,
20767     * if there's no item with that index (and on errors)
20768     *
20769     * @ingroup Slideshow
20770     */
20771    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20772
20773    /**
20774     * Set the current slide layout in use for a given slideshow widget
20775     *
20776     * @param obj The slideshow object
20777     * @param layout The new layout's name string
20778     *
20779     * If @p layout is implemented in @p obj's theme (i.e., is contained
20780     * in the list returned by elm_slideshow_layouts_get()), this new
20781     * images layout will be used on the widget.
20782     *
20783     * @see elm_slideshow_layouts_get() for more details
20784     *
20785     * @ingroup Slideshow
20786     */
20787    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20788
20789    /**
20790     * Get the current slide layout in use for a given slideshow widget
20791     *
20792     * @param obj The slideshow object
20793     * @return The current layout's name
20794     *
20795     * @see elm_slideshow_layout_set() for more details
20796     *
20797     * @ingroup Slideshow
20798     */
20799    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20800
20801    /**
20802     * Returns the list of @b layout names available, for a given
20803     * slideshow widget.
20804     *
20805     * @param obj The slideshow object
20806     * @return The list of layouts (list of @b stringshared strings
20807     * as data)
20808     *
20809     * Slideshow layouts will change how the widget is to dispose each
20810     * image item in its viewport, with regard to cropping, scaling,
20811     * etc.
20812     *
20813     * The layouts, which come from @p obj's theme, must be an EDC
20814     * data item name @c "layouts" on the theme file, with (prefix)
20815     * names of EDC programs actually implementing them.
20816     *
20817     * The available layouts for slideshows on the default theme are:
20818     * - @c "fullscreen" - item images with original aspect, scaled to
20819     *   touch top and down slideshow borders or, if the image's heigh
20820     *   is not enough, left and right slideshow borders.
20821     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20822     *   one, but always leaving 10% of the slideshow's dimensions of
20823     *   distance between the item image's borders and the slideshow
20824     *   borders, for each axis.
20825     *
20826     * @warning The stringshared strings get no new references
20827     * exclusive to the user grabbing the list, here, so if you'd like
20828     * to use them out of this call's context, you'd better @c
20829     * eina_stringshare_ref() them.
20830     *
20831     * @see elm_slideshow_layout_set()
20832     *
20833     * @ingroup Slideshow
20834     */
20835    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20836
20837    /**
20838     * Set the number of items to cache, on a given slideshow widget,
20839     * <b>before the current item</b>
20840     *
20841     * @param obj The slideshow object
20842     * @param count Number of items to cache before the current one
20843     *
20844     * The default value for this property is @c 2. See
20845     * @ref Slideshow_Caching "slideshow caching" for more details.
20846     *
20847     * @see elm_slideshow_cache_before_get()
20848     *
20849     * @ingroup Slideshow
20850     */
20851    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20852
20853    /**
20854     * Retrieve the number of items to cache, on a given slideshow widget,
20855     * <b>before the current item</b>
20856     *
20857     * @param obj The slideshow object
20858     * @return The number of items set to be cached before the current one
20859     *
20860     * @see elm_slideshow_cache_before_set() for more details
20861     *
20862     * @ingroup Slideshow
20863     */
20864    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20865
20866    /**
20867     * Set the number of items to cache, on a given slideshow widget,
20868     * <b>after the current item</b>
20869     *
20870     * @param obj The slideshow object
20871     * @param count Number of items to cache after the current one
20872     *
20873     * The default value for this property is @c 2. See
20874     * @ref Slideshow_Caching "slideshow caching" for more details.
20875     *
20876     * @see elm_slideshow_cache_after_get()
20877     *
20878     * @ingroup Slideshow
20879     */
20880    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20881
20882    /**
20883     * Retrieve the number of items to cache, on a given slideshow widget,
20884     * <b>after the current item</b>
20885     *
20886     * @param obj The slideshow object
20887     * @return The number of items set to be cached after the current one
20888     *
20889     * @see elm_slideshow_cache_after_set() for more details
20890     *
20891     * @ingroup Slideshow
20892     */
20893    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20894
20895    /**
20896     * Get the number of items stored in a given slideshow widget
20897     *
20898     * @param obj The slideshow object
20899     * @return The number of items on @p obj, at the moment of this call
20900     *
20901     * @ingroup Slideshow
20902     */
20903    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20904
20905    /**
20906     * @}
20907     */
20908
20909    /**
20910     * @defgroup Fileselector File Selector
20911     *
20912     * @image html img/widget/fileselector/preview-00.png
20913     * @image latex img/widget/fileselector/preview-00.eps
20914     *
20915     * A file selector is a widget that allows a user to navigate
20916     * through a file system, reporting file selections back via its
20917     * API.
20918     *
20919     * It contains shortcut buttons for home directory (@c ~) and to
20920     * jump one directory upwards (..), as well as cancel/ok buttons to
20921     * confirm/cancel a given selection. After either one of those two
20922     * former actions, the file selector will issue its @c "done" smart
20923     * callback.
20924     *
20925     * There's a text entry on it, too, showing the name of the current
20926     * selection. There's the possibility of making it editable, so it
20927     * is useful on file saving dialogs on applications, where one
20928     * gives a file name to save contents to, in a given directory in
20929     * the system. This custom file name will be reported on the @c
20930     * "done" smart callback (explained in sequence).
20931     *
20932     * Finally, it has a view to display file system items into in two
20933     * possible forms:
20934     * - list
20935     * - grid
20936     *
20937     * If Elementary is built with support of the Ethumb thumbnailing
20938     * library, the second form of view will display preview thumbnails
20939     * of files which it supports.
20940     *
20941     * Smart callbacks one can register to:
20942     *
20943     * - @c "selected" - the user has clicked on a file (when not in
20944     *      folders-only mode) or directory (when in folders-only mode)
20945     * - @c "directory,open" - the list has been populated with new
20946     *      content (@c event_info is a pointer to the directory's
20947     *      path, a @b stringshared string)
20948     * - @c "done" - the user has clicked on the "ok" or "cancel"
20949     *      buttons (@c event_info is a pointer to the selection's
20950     *      path, a @b stringshared string)
20951     *
20952     * Here is an example on its usage:
20953     * @li @ref fileselector_example
20954     */
20955
20956    /**
20957     * @addtogroup Fileselector
20958     * @{
20959     */
20960
20961    /**
20962     * Defines how a file selector widget is to layout its contents
20963     * (file system entries).
20964     */
20965    typedef enum _Elm_Fileselector_Mode
20966      {
20967         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20968         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20969         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20970      } Elm_Fileselector_Mode;
20971
20972    /**
20973     * Add a new file selector widget to the given parent Elementary
20974     * (container) object
20975     *
20976     * @param parent The parent object
20977     * @return a new file selector widget handle or @c NULL, on errors
20978     *
20979     * This function inserts a new file selector widget on the canvas.
20980     *
20981     * @ingroup Fileselector
20982     */
20983    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20984
20985    /**
20986     * Enable/disable the file name entry box where the user can type
20987     * in a name for a file, in a given file selector widget
20988     *
20989     * @param obj The file selector object
20990     * @param is_save @c EINA_TRUE to make the file selector a "saving
20991     * dialog", @c EINA_FALSE otherwise
20992     *
20993     * Having the entry editable is useful on file saving dialogs on
20994     * applications, where one gives a file name to save contents to,
20995     * in a given directory in the system. This custom file name will
20996     * be reported on the @c "done" smart callback.
20997     *
20998     * @see elm_fileselector_is_save_get()
20999     *
21000     * @ingroup Fileselector
21001     */
21002    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21003
21004    /**
21005     * Get whether the given file selector is in "saving dialog" mode
21006     *
21007     * @param obj The file selector object
21008     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21009     * mode, @c EINA_FALSE otherwise (and on errors)
21010     *
21011     * @see elm_fileselector_is_save_set() for more details
21012     *
21013     * @ingroup Fileselector
21014     */
21015    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21016
21017    /**
21018     * Enable/disable folder-only view for a given file selector widget
21019     *
21020     * @param obj The file selector object
21021     * @param only @c EINA_TRUE to make @p obj only display
21022     * directories, @c EINA_FALSE to make files to be displayed in it
21023     * too
21024     *
21025     * If enabled, the widget's view will only display folder items,
21026     * naturally.
21027     *
21028     * @see elm_fileselector_folder_only_get()
21029     *
21030     * @ingroup Fileselector
21031     */
21032    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21033
21034    /**
21035     * Get whether folder-only view is set for a given file selector
21036     * widget
21037     *
21038     * @param obj The file selector object
21039     * @return only @c EINA_TRUE if @p obj is only displaying
21040     * directories, @c EINA_FALSE if files are being displayed in it
21041     * too (and on errors)
21042     *
21043     * @see elm_fileselector_folder_only_get()
21044     *
21045     * @ingroup Fileselector
21046     */
21047    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21048
21049    /**
21050     * Enable/disable the "ok" and "cancel" buttons on a given file
21051     * selector widget
21052     *
21053     * @param obj The file selector object
21054     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21055     *
21056     * @note A file selector without those buttons will never emit the
21057     * @c "done" smart event, and is only usable if one is just hooking
21058     * to the other two events.
21059     *
21060     * @see elm_fileselector_buttons_ok_cancel_get()
21061     *
21062     * @ingroup Fileselector
21063     */
21064    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21065
21066    /**
21067     * Get whether the "ok" and "cancel" buttons on a given file
21068     * selector widget are being shown.
21069     *
21070     * @param obj The file selector object
21071     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21072     * otherwise (and on errors)
21073     *
21074     * @see elm_fileselector_buttons_ok_cancel_set() for more details
21075     *
21076     * @ingroup Fileselector
21077     */
21078    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21079
21080    /**
21081     * Enable/disable a tree view in the given file selector widget,
21082     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21083     *
21084     * @param obj The file selector object
21085     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21086     * disable
21087     *
21088     * In a tree view, arrows are created on the sides of directories,
21089     * allowing them to expand in place.
21090     *
21091     * @note If it's in other mode, the changes made by this function
21092     * will only be visible when one switches back to "list" mode.
21093     *
21094     * @see elm_fileselector_expandable_get()
21095     *
21096     * @ingroup Fileselector
21097     */
21098    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21099
21100    /**
21101     * Get whether tree view is enabled for the given file selector
21102     * widget
21103     *
21104     * @param obj The file selector object
21105     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21106     * otherwise (and or errors)
21107     *
21108     * @see elm_fileselector_expandable_set() for more details
21109     *
21110     * @ingroup Fileselector
21111     */
21112    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21113
21114    /**
21115     * Set, programmatically, the @b directory that a given file
21116     * selector widget will display contents from
21117     *
21118     * @param obj The file selector object
21119     * @param path The path to display in @p obj
21120     *
21121     * This will change the @b directory that @p obj is displaying. It
21122     * will also clear the text entry area on the @p obj object, which
21123     * displays select files' names.
21124     *
21125     * @see elm_fileselector_path_get()
21126     *
21127     * @ingroup Fileselector
21128     */
21129    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21130
21131    /**
21132     * Get the parent directory's path that a given file selector
21133     * widget is displaying
21134     *
21135     * @param obj The file selector object
21136     * @return The (full) path of the directory the file selector is
21137     * displaying, a @b stringshared string
21138     *
21139     * @see elm_fileselector_path_set()
21140     *
21141     * @ingroup Fileselector
21142     */
21143    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21144
21145    /**
21146     * Set, programmatically, the currently selected file/directory in
21147     * the given file selector widget
21148     *
21149     * @param obj The file selector object
21150     * @param path The (full) path to a file or directory
21151     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21152     * latter case occurs if the directory or file pointed to do not
21153     * exist.
21154     *
21155     * @see elm_fileselector_selected_get()
21156     *
21157     * @ingroup Fileselector
21158     */
21159    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21160
21161    /**
21162     * Get the currently selected item's (full) path, in the given file
21163     * selector widget
21164     *
21165     * @param obj The file selector object
21166     * @return The absolute path of the selected item, a @b
21167     * stringshared string
21168     *
21169     * @note Custom editions on @p obj object's text entry, if made,
21170     * will appear on the return string of this function, naturally.
21171     *
21172     * @see elm_fileselector_selected_set() for more details
21173     *
21174     * @ingroup Fileselector
21175     */
21176    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21177
21178    /**
21179     * Set the mode in which a given file selector widget will display
21180     * (layout) file system entries in its view
21181     *
21182     * @param obj The file selector object
21183     * @param mode The mode of the fileselector, being it one of
21184     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21185     * first one, naturally, will display the files in a list. The
21186     * latter will make the widget to display its entries in a grid
21187     * form.
21188     *
21189     * @note By using elm_fileselector_expandable_set(), the user may
21190     * trigger a tree view for that list.
21191     *
21192     * @note If Elementary is built with support of the Ethumb
21193     * thumbnailing library, the second form of view will display
21194     * preview thumbnails of files which it supports. You must have
21195     * elm_need_ethumb() called in your Elementary for thumbnailing to
21196     * work, though.
21197     *
21198     * @see elm_fileselector_expandable_set().
21199     * @see elm_fileselector_mode_get().
21200     *
21201     * @ingroup Fileselector
21202     */
21203    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21204
21205    /**
21206     * Get the mode in which a given file selector widget is displaying
21207     * (layouting) file system entries in its view
21208     *
21209     * @param obj The fileselector object
21210     * @return The mode in which the fileselector is at
21211     *
21212     * @see elm_fileselector_mode_set() for more details
21213     *
21214     * @ingroup Fileselector
21215     */
21216    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21217
21218    /**
21219     * @}
21220     */
21221
21222    /**
21223     * @defgroup Progressbar Progress bar
21224     *
21225     * The progress bar is a widget for visually representing the
21226     * progress status of a given job/task.
21227     *
21228     * A progress bar may be horizontal or vertical. It may display an
21229     * icon besides it, as well as primary and @b units labels. The
21230     * former is meant to label the widget as a whole, while the
21231     * latter, which is formatted with floating point values (and thus
21232     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21233     * units"</c>), is meant to label the widget's <b>progress
21234     * value</b>. Label, icon and unit strings/objects are @b optional
21235     * for progress bars.
21236     *
21237     * A progress bar may be @b inverted, in which state it gets its
21238     * values inverted, with high values being on the left or top and
21239     * low values on the right or bottom, as opposed to normally have
21240     * the low values on the former and high values on the latter,
21241     * respectively, for horizontal and vertical modes.
21242     *
21243     * The @b span of the progress, as set by
21244     * elm_progressbar_span_size_set(), is its length (horizontally or
21245     * vertically), unless one puts size hints on the widget to expand
21246     * on desired directions, by any container. That length will be
21247     * scaled by the object or applications scaling factor. At any
21248     * point code can query the progress bar for its value with
21249     * elm_progressbar_value_get().
21250     *
21251     * Available widget styles for progress bars:
21252     * - @c "default"
21253     * - @c "wheel" (simple style, no text, no progression, only
21254     *      "pulse" effect is available)
21255     *
21256     * Default contents parts of the progressbar widget that you can use for are:
21257     * @li "icon" - A icon of the progressbar
21258     * 
21259     * Here is an example on its usage:
21260     * @li @ref progressbar_example
21261     */
21262
21263    /**
21264     * Add a new progress bar widget to the given parent Elementary
21265     * (container) object
21266     *
21267     * @param parent The parent object
21268     * @return a new progress bar widget handle or @c NULL, on errors
21269     *
21270     * This function inserts a new progress bar widget on the canvas.
21271     *
21272     * @ingroup Progressbar
21273     */
21274    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21275
21276    /**
21277     * Set whether a given progress bar widget is at "pulsing mode" or
21278     * not.
21279     *
21280     * @param obj The progress bar object
21281     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21282     * @c EINA_FALSE to put it back to its default one
21283     *
21284     * By default, progress bars will display values from the low to
21285     * high value boundaries. There are, though, contexts in which the
21286     * state of progression of a given task is @b unknown.  For those,
21287     * one can set a progress bar widget to a "pulsing state", to give
21288     * the user an idea that some computation is being held, but
21289     * without exact progress values. In the default theme it will
21290     * animate its bar with the contents filling in constantly and back
21291     * to non-filled, in a loop. To start and stop this pulsing
21292     * animation, one has to explicitly call elm_progressbar_pulse().
21293     *
21294     * @see elm_progressbar_pulse_get()
21295     * @see elm_progressbar_pulse()
21296     *
21297     * @ingroup Progressbar
21298     */
21299    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21300
21301    /**
21302     * Get whether a given progress bar widget is at "pulsing mode" or
21303     * not.
21304     *
21305     * @param obj The progress bar object
21306     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21307     * if it's in the default one (and on errors)
21308     *
21309     * @ingroup Progressbar
21310     */
21311    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21312
21313    /**
21314     * Start/stop a given progress bar "pulsing" animation, if its
21315     * under that mode
21316     *
21317     * @param obj The progress bar object
21318     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21319     * @c EINA_FALSE to @b stop it
21320     *
21321     * @note This call won't do anything if @p obj is not under "pulsing mode".
21322     *
21323     * @see elm_progressbar_pulse_set() for more details.
21324     *
21325     * @ingroup Progressbar
21326     */
21327    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21328
21329    /**
21330     * Set the progress value (in percentage) on a given progress bar
21331     * widget
21332     *
21333     * @param obj The progress bar object
21334     * @param val The progress value (@b must be between @c 0.0 and @c
21335     * 1.0)
21336     *
21337     * Use this call to set progress bar levels.
21338     *
21339     * @note If you passes a value out of the specified range for @p
21340     * val, it will be interpreted as the @b closest of the @b boundary
21341     * values in the range.
21342     *
21343     * @ingroup Progressbar
21344     */
21345    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21346
21347    /**
21348     * Get the progress value (in percentage) on a given progress bar
21349     * widget
21350     *
21351     * @param obj The progress bar object
21352     * @return The value of the progressbar
21353     *
21354     * @see elm_progressbar_value_set() for more details
21355     *
21356     * @ingroup Progressbar
21357     */
21358    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21359
21360    /**
21361     * Set the label of a given progress bar widget
21362     *
21363     * @param obj The progress bar object
21364     * @param label The text label string, in UTF-8
21365     *
21366     * @ingroup Progressbar
21367     * @deprecated use elm_object_text_set() instead.
21368     */
21369    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21370
21371    /**
21372     * Get the label of a given progress bar widget
21373     *
21374     * @param obj The progressbar object
21375     * @return The text label string, in UTF-8
21376     *
21377     * @ingroup Progressbar
21378     * @deprecated use elm_object_text_set() instead.
21379     */
21380    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21381
21382    /**
21383     * Set the icon object of a given progress bar widget
21384     *
21385     * @param obj The progress bar object
21386     * @param icon The icon object
21387     *
21388     * Use this call to decorate @p obj with an icon next to it.
21389     *
21390     * @note Once the icon object is set, a previously set one will be
21391     * deleted. If you want to keep that old content object, use the
21392     * elm_progressbar_icon_unset() function.
21393     *
21394     * @see elm_progressbar_icon_get()
21395     * @deprecated use elm_object_part_content_set() instead.
21396     *
21397     * @ingroup Progressbar
21398     */
21399    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21400
21401    /**
21402     * Retrieve the icon object set for a given progress bar widget
21403     *
21404     * @param obj The progress bar object
21405     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21406     * otherwise (and on errors)
21407     *
21408     * @see elm_progressbar_icon_set() for more details
21409     * @deprecated use elm_object_part_content_get() instead.
21410     *
21411     * @ingroup Progressbar
21412     */
21413    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21414
21415    /**
21416     * Unset an icon set on a given progress bar widget
21417     *
21418     * @param obj The progress bar object
21419     * @return The icon object that was being used, if any was set, or
21420     * @c NULL, otherwise (and on errors)
21421     *
21422     * This call will unparent and return the icon object which was set
21423     * for this widget, previously, on success.
21424     *
21425     * @see elm_progressbar_icon_set() for more details
21426     * @deprecated use elm_object_part_content_unset() instead.
21427     *
21428     * @ingroup Progressbar
21429     */
21430    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21431
21432    /**
21433     * Set the (exact) length of the bar region of a given progress bar
21434     * widget
21435     *
21436     * @param obj The progress bar object
21437     * @param size The length of the progress bar's bar region
21438     *
21439     * This sets the minimum width (when in horizontal mode) or height
21440     * (when in vertical mode) of the actual bar area of the progress
21441     * bar @p obj. This in turn affects the object's minimum size. Use
21442     * this when you're not setting other size hints expanding on the
21443     * given direction (like weight and alignment hints) and you would
21444     * like it to have a specific size.
21445     *
21446     * @note Icon, label and unit text around @p obj will require their
21447     * own space, which will make @p obj to require more the @p size,
21448     * actually.
21449     *
21450     * @see elm_progressbar_span_size_get()
21451     *
21452     * @ingroup Progressbar
21453     */
21454    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21455
21456    /**
21457     * Get the length set for the bar region of a given progress bar
21458     * widget
21459     *
21460     * @param obj The progress bar object
21461     * @return The length of the progress bar's bar region
21462     *
21463     * If that size was not set previously, with
21464     * elm_progressbar_span_size_set(), this call will return @c 0.
21465     *
21466     * @ingroup Progressbar
21467     */
21468    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21469
21470    /**
21471     * Set the format string for a given progress bar widget's units
21472     * label
21473     *
21474     * @param obj The progress bar object
21475     * @param format The format string for @p obj's units label
21476     *
21477     * If @c NULL is passed on @p format, it will make @p obj's units
21478     * area to be hidden completely. If not, it'll set the <b>format
21479     * string</b> for the units label's @b text. The units label is
21480     * provided a floating point value, so the units text is up display
21481     * at most one floating point falue. Note that the units label is
21482     * optional. Use a format string such as "%1.2f meters" for
21483     * example.
21484     *
21485     * @note The default format string for a progress bar is an integer
21486     * percentage, as in @c "%.0f %%".
21487     *
21488     * @see elm_progressbar_unit_format_get()
21489     *
21490     * @ingroup Progressbar
21491     */
21492    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21493
21494    /**
21495     * Retrieve the format string set for a given progress bar widget's
21496     * units label
21497     *
21498     * @param obj The progress bar object
21499     * @return The format set string for @p obj's units label or
21500     * @c NULL, if none was set (and on errors)
21501     *
21502     * @see elm_progressbar_unit_format_set() for more details
21503     *
21504     * @ingroup Progressbar
21505     */
21506    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21507
21508    /**
21509     * Set the orientation of a given progress bar widget
21510     *
21511     * @param obj The progress bar object
21512     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21513     * @b horizontal, @c EINA_FALSE to make it @b vertical
21514     *
21515     * Use this function to change how your progress bar is to be
21516     * disposed: vertically or horizontally.
21517     *
21518     * @see elm_progressbar_horizontal_get()
21519     *
21520     * @ingroup Progressbar
21521     */
21522    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21523
21524    /**
21525     * Retrieve the orientation of a given progress bar widget
21526     *
21527     * @param obj The progress bar object
21528     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21529     * @c EINA_FALSE if it's @b vertical (and on errors)
21530     *
21531     * @see elm_progressbar_horizontal_set() for more details
21532     *
21533     * @ingroup Progressbar
21534     */
21535    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21536
21537    /**
21538     * Invert a given progress bar widget's displaying values order
21539     *
21540     * @param obj The progress bar object
21541     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21542     * @c EINA_FALSE to bring it back to default, non-inverted values.
21543     *
21544     * A progress bar may be @b inverted, in which state it gets its
21545     * values inverted, with high values being on the left or top and
21546     * low values on the right or bottom, as opposed to normally have
21547     * the low values on the former and high values on the latter,
21548     * respectively, for horizontal and vertical modes.
21549     *
21550     * @see elm_progressbar_inverted_get()
21551     *
21552     * @ingroup Progressbar
21553     */
21554    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21555
21556    /**
21557     * Get whether a given progress bar widget's displaying values are
21558     * inverted or not
21559     *
21560     * @param obj The progress bar object
21561     * @return @c EINA_TRUE, if @p obj has inverted values,
21562     * @c EINA_FALSE otherwise (and on errors)
21563     *
21564     * @see elm_progressbar_inverted_set() for more details
21565     *
21566     * @ingroup Progressbar
21567     */
21568    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21569
21570    /**
21571     * @defgroup Separator Separator
21572     *
21573     * @brief Separator is a very thin object used to separate other objects.
21574     *
21575     * A separator can be vertical or horizontal.
21576     *
21577     * @ref tutorial_separator is a good example of how to use a separator.
21578     * @{
21579     */
21580    /**
21581     * @brief Add a separator object to @p parent
21582     *
21583     * @param parent The parent object
21584     *
21585     * @return The separator object, or NULL upon failure
21586     */
21587    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21588    /**
21589     * @brief Set the horizontal mode of a separator object
21590     *
21591     * @param obj The separator object
21592     * @param horizontal If true, the separator is horizontal
21593     */
21594    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21595    /**
21596     * @brief Get the horizontal mode of a separator object
21597     *
21598     * @param obj The separator object
21599     * @return If true, the separator is horizontal
21600     *
21601     * @see elm_separator_horizontal_set()
21602     */
21603    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21604    /**
21605     * @}
21606     */
21607
21608    /**
21609     * @defgroup Spinner Spinner
21610     * @ingroup Elementary
21611     *
21612     * @image html img/widget/spinner/preview-00.png
21613     * @image latex img/widget/spinner/preview-00.eps
21614     *
21615     * A spinner is a widget which allows the user to increase or decrease
21616     * numeric values using arrow buttons, or edit values directly, clicking
21617     * over it and typing the new value.
21618     *
21619     * By default the spinner will not wrap and has a label
21620     * of "%.0f" (just showing the integer value of the double).
21621     *
21622     * A spinner has a label that is formatted with floating
21623     * point values and thus accepts a printf-style format string, like
21624     * ā€œ%1.2f unitsā€.
21625     *
21626     * It also allows specific values to be replaced by pre-defined labels.
21627     *
21628     * Smart callbacks one can register to:
21629     *
21630     * - "changed" - Whenever the spinner value is changed.
21631     * - "delay,changed" - A short time after the value is changed by the user.
21632     *    This will be called only when the user stops dragging for a very short
21633     *    period or when they release their finger/mouse, so it avoids possibly
21634     *    expensive reactions to the value change.
21635     *
21636     * Available styles for it:
21637     * - @c "default";
21638     * - @c "vertical": up/down buttons at the right side and text left aligned.
21639     *
21640     * Here is an example on its usage:
21641     * @ref spinner_example
21642     */
21643
21644    /**
21645     * @addtogroup Spinner
21646     * @{
21647     */
21648
21649    /**
21650     * Add a new spinner widget to the given parent Elementary
21651     * (container) object.
21652     *
21653     * @param parent The parent object.
21654     * @return a new spinner widget handle or @c NULL, on errors.
21655     *
21656     * This function inserts a new spinner widget on the canvas.
21657     *
21658     * @ingroup Spinner
21659     *
21660     */
21661    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21662
21663    /**
21664     * Set the format string of the displayed label.
21665     *
21666     * @param obj The spinner object.
21667     * @param fmt The format string for the label display.
21668     *
21669     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21670     * string for the label text. The label text is provided a floating point
21671     * value, so the label text can display up to 1 floating point value.
21672     * Note that this is optional.
21673     *
21674     * Use a format string such as "%1.2f meters" for example, and it will
21675     * display values like: "3.14 meters" for a value equal to 3.14159.
21676     *
21677     * Default is "%0.f".
21678     *
21679     * @see elm_spinner_label_format_get()
21680     *
21681     * @ingroup Spinner
21682     */
21683    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21684
21685    /**
21686     * Get the label format of the spinner.
21687     *
21688     * @param obj The spinner object.
21689     * @return The text label format string in UTF-8.
21690     *
21691     * @see elm_spinner_label_format_set() for details.
21692     *
21693     * @ingroup Spinner
21694     */
21695    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21696
21697    /**
21698     * Set the minimum and maximum values for the spinner.
21699     *
21700     * @param obj The spinner object.
21701     * @param min The minimum value.
21702     * @param max The maximum value.
21703     *
21704     * Define the allowed range of values to be selected by the user.
21705     *
21706     * If actual value is less than @p min, it will be updated to @p min. If it
21707     * is bigger then @p max, will be updated to @p max. Actual value can be
21708     * get with elm_spinner_value_get().
21709     *
21710     * By default, min is equal to 0, and max is equal to 100.
21711     *
21712     * @warning Maximum must be greater than minimum.
21713     *
21714     * @see elm_spinner_min_max_get()
21715     *
21716     * @ingroup Spinner
21717     */
21718    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21719
21720    /**
21721     * Get the minimum and maximum values of the spinner.
21722     *
21723     * @param obj The spinner object.
21724     * @param min Pointer where to store the minimum value.
21725     * @param max Pointer where to store the maximum value.
21726     *
21727     * @note If only one value is needed, the other pointer can be passed
21728     * as @c NULL.
21729     *
21730     * @see elm_spinner_min_max_set() for details.
21731     *
21732     * @ingroup Spinner
21733     */
21734    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21735
21736    /**
21737     * Set the step used to increment or decrement the spinner value.
21738     *
21739     * @param obj The spinner object.
21740     * @param step The step value.
21741     *
21742     * This value will be incremented or decremented to the displayed value.
21743     * It will be incremented while the user keep right or top arrow pressed,
21744     * and will be decremented while the user keep left or bottom arrow pressed.
21745     *
21746     * The interval to increment / decrement can be set with
21747     * elm_spinner_interval_set().
21748     *
21749     * By default step value is equal to 1.
21750     *
21751     * @see elm_spinner_step_get()
21752     *
21753     * @ingroup Spinner
21754     */
21755    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21756
21757    /**
21758     * Get the step used to increment or decrement the spinner value.
21759     *
21760     * @param obj The spinner object.
21761     * @return The step value.
21762     *
21763     * @see elm_spinner_step_get() for more details.
21764     *
21765     * @ingroup Spinner
21766     */
21767    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21768
21769    /**
21770     * Set the value the spinner displays.
21771     *
21772     * @param obj The spinner object.
21773     * @param val The value to be displayed.
21774     *
21775     * Value will be presented on the label following format specified with
21776     * elm_spinner_format_set().
21777     *
21778     * @warning The value must to be between min and max values. This values
21779     * are set by elm_spinner_min_max_set().
21780     *
21781     * @see elm_spinner_value_get().
21782     * @see elm_spinner_format_set().
21783     * @see elm_spinner_min_max_set().
21784     *
21785     * @ingroup Spinner
21786     */
21787    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21788
21789    /**
21790     * Get the value displayed by the spinner.
21791     *
21792     * @param obj The spinner object.
21793     * @return The value displayed.
21794     *
21795     * @see elm_spinner_value_set() for details.
21796     *
21797     * @ingroup Spinner
21798     */
21799    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21800
21801    /**
21802     * Set whether the spinner should wrap when it reaches its
21803     * minimum or maximum value.
21804     *
21805     * @param obj The spinner object.
21806     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21807     * disable it.
21808     *
21809     * Disabled by default. If disabled, when the user tries to increment the
21810     * value,
21811     * but displayed value plus step value is bigger than maximum value,
21812     * the spinner
21813     * won't allow it. The same happens when the user tries to decrement it,
21814     * but the value less step is less than minimum value.
21815     *
21816     * When wrap is enabled, in such situations it will allow these changes,
21817     * but will get the value that would be less than minimum and subtracts
21818     * from maximum. Or add the value that would be more than maximum to
21819     * the minimum.
21820     *
21821     * E.g.:
21822     * @li min value = 10
21823     * @li max value = 50
21824     * @li step value = 20
21825     * @li displayed value = 20
21826     *
21827     * When the user decrement value (using left or bottom arrow), it will
21828     * displays @c 40, because max - (min - (displayed - step)) is
21829     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21830     *
21831     * @see elm_spinner_wrap_get().
21832     *
21833     * @ingroup Spinner
21834     */
21835    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21836
21837    /**
21838     * Get whether the spinner should wrap when it reaches its
21839     * minimum or maximum value.
21840     *
21841     * @param obj The spinner object
21842     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21843     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21844     *
21845     * @see elm_spinner_wrap_set() for details.
21846     *
21847     * @ingroup Spinner
21848     */
21849    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21850
21851    /**
21852     * Set whether the spinner can be directly edited by the user or not.
21853     *
21854     * @param obj The spinner object.
21855     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21856     * don't allow users to edit it directly.
21857     *
21858     * Spinner objects can have edition @b disabled, in which state they will
21859     * be changed only by arrows.
21860     * Useful for contexts
21861     * where you don't want your users to interact with it writting the value.
21862     * Specially
21863     * when using special values, the user can see real value instead
21864     * of special label on edition.
21865     *
21866     * It's enabled by default.
21867     *
21868     * @see elm_spinner_editable_get()
21869     *
21870     * @ingroup Spinner
21871     */
21872    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21873
21874    /**
21875     * Get whether the spinner can be directly edited by the user or not.
21876     *
21877     * @param obj The spinner object.
21878     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21879     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21880     *
21881     * @see elm_spinner_editable_set() for details.
21882     *
21883     * @ingroup Spinner
21884     */
21885    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21886
21887    /**
21888     * Set a special string to display in the place of the numerical value.
21889     *
21890     * @param obj The spinner object.
21891     * @param value The value to be replaced.
21892     * @param label The label to be used.
21893     *
21894     * It's useful for cases when a user should select an item that is
21895     * better indicated by a label than a value. For example, weekdays or months.
21896     *
21897     * E.g.:
21898     * @code
21899     * sp = elm_spinner_add(win);
21900     * elm_spinner_min_max_set(sp, 1, 3);
21901     * elm_spinner_special_value_add(sp, 1, "January");
21902     * elm_spinner_special_value_add(sp, 2, "February");
21903     * elm_spinner_special_value_add(sp, 3, "March");
21904     * evas_object_show(sp);
21905     * @endcode
21906     *
21907     * @ingroup Spinner
21908     */
21909    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21910
21911    /**
21912     * Set the interval on time updates for an user mouse button hold
21913     * on spinner widgets' arrows.
21914     *
21915     * @param obj The spinner object.
21916     * @param interval The (first) interval value in seconds.
21917     *
21918     * This interval value is @b decreased while the user holds the
21919     * mouse pointer either incrementing or decrementing spinner's value.
21920     *
21921     * This helps the user to get to a given value distant from the
21922     * current one easier/faster, as it will start to change quicker and
21923     * quicker on mouse button holds.
21924     *
21925     * The calculation for the next change interval value, starting from
21926     * the one set with this call, is the previous interval divided by
21927     * @c 1.05, so it decreases a little bit.
21928     *
21929     * The default starting interval value for automatic changes is
21930     * @c 0.85 seconds.
21931     *
21932     * @see elm_spinner_interval_get()
21933     *
21934     * @ingroup Spinner
21935     */
21936    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21937
21938    /**
21939     * Get the interval on time updates for an user mouse button hold
21940     * on spinner widgets' arrows.
21941     *
21942     * @param obj The spinner object.
21943     * @return The (first) interval value, in seconds, set on it.
21944     *
21945     * @see elm_spinner_interval_set() for more details.
21946     *
21947     * @ingroup Spinner
21948     */
21949    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21950
21951    /**
21952     * @}
21953     */
21954
21955    /**
21956     * @defgroup Index Index
21957     *
21958     * @image html img/widget/index/preview-00.png
21959     * @image latex img/widget/index/preview-00.eps
21960     *
21961     * An index widget gives you an index for fast access to whichever
21962     * group of other UI items one might have. It's a list of text
21963     * items (usually letters, for alphabetically ordered access).
21964     *
21965     * Index widgets are by default hidden and just appear when the
21966     * user clicks over it's reserved area in the canvas. In its
21967     * default theme, it's an area one @ref Fingers "finger" wide on
21968     * the right side of the index widget's container.
21969     *
21970     * When items on the index are selected, smart callbacks get
21971     * called, so that its user can make other container objects to
21972     * show a given area or child object depending on the index item
21973     * selected. You'd probably be using an index together with @ref
21974     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21975     * "general grids".
21976     *
21977     * Smart events one  can add callbacks for are:
21978     * - @c "changed" - When the selected index item changes. @c
21979     *      event_info is the selected item's data pointer.
21980     * - @c "delay,changed" - When the selected index item changes, but
21981     *      after a small idling period. @c event_info is the selected
21982     *      item's data pointer.
21983     * - @c "selected" - When the user releases a mouse button and
21984     *      selects an item. @c event_info is the selected item's data
21985     *      pointer.
21986     * - @c "level,up" - when the user moves a finger from the first
21987     *      level to the second level
21988     * - @c "level,down" - when the user moves a finger from the second
21989     *      level to the first level
21990     *
21991     * The @c "delay,changed" event is so that it'll wait a small time
21992     * before actually reporting those events and, moreover, just the
21993     * last event happening on those time frames will actually be
21994     * reported.
21995     *
21996     * Here are some examples on its usage:
21997     * @li @ref index_example_01
21998     * @li @ref index_example_02
21999     */
22000
22001    /**
22002     * @addtogroup Index
22003     * @{
22004     */
22005
22006    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22007
22008    /**
22009     * Add a new index widget to the given parent Elementary
22010     * (container) object
22011     *
22012     * @param parent The parent object
22013     * @return a new index widget handle or @c NULL, on errors
22014     *
22015     * This function inserts a new index widget on the canvas.
22016     *
22017     * @ingroup Index
22018     */
22019    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22020
22021    /**
22022     * Set whether a given index widget is or not visible,
22023     * programatically.
22024     *
22025     * @param obj The index object
22026     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22027     *
22028     * Not to be confused with visible as in @c evas_object_show() --
22029     * visible with regard to the widget's auto hiding feature.
22030     *
22031     * @see elm_index_active_get()
22032     *
22033     * @ingroup Index
22034     */
22035    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22036
22037    /**
22038     * Get whether a given index widget is currently visible or not.
22039     *
22040     * @param obj The index object
22041     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22042     *
22043     * @see elm_index_active_set() for more details
22044     *
22045     * @ingroup Index
22046     */
22047    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22048
22049    /**
22050     * Set the items level for a given index widget.
22051     *
22052     * @param obj The index object.
22053     * @param level @c 0 or @c 1, the currently implemented levels.
22054     *
22055     * @see elm_index_item_level_get()
22056     *
22057     * @ingroup Index
22058     */
22059    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22060
22061    /**
22062     * Get the items level set for a given index widget.
22063     *
22064     * @param obj The index object.
22065     * @return @c 0 or @c 1, which are the levels @p obj might be at.
22066     *
22067     * @see elm_index_item_level_set() for more information
22068     *
22069     * @ingroup Index
22070     */
22071    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22072
22073    /**
22074     * Returns the last selected item's data, for a given index widget.
22075     *
22076     * @param obj The index object.
22077     * @return The item @b data associated to the last selected item on
22078     * @p obj (or @c NULL, on errors).
22079     *
22080     * @warning The returned value is @b not an #Elm_Index_Item item
22081     * handle, but the data associated to it (see the @c item parameter
22082     * in elm_index_item_append(), as an example).
22083     *
22084     * @ingroup Index
22085     */
22086    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22087
22088    /**
22089     * Append a new item on a given index widget.
22090     *
22091     * @param obj The index object.
22092     * @param letter Letter under which the item should be indexed
22093     * @param item The item data to set for the index's item
22094     *
22095     * Despite the most common usage of the @p letter argument is for
22096     * single char strings, one could use arbitrary strings as index
22097     * entries.
22098     *
22099     * @c item will be the pointer returned back on @c "changed", @c
22100     * "delay,changed" and @c "selected" smart events.
22101     *
22102     * @ingroup Index
22103     */
22104    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22105
22106    /**
22107     * Prepend a new item on a given index widget.
22108     *
22109     * @param obj The index object.
22110     * @param letter Letter under which the item should be indexed
22111     * @param item The item data to set for the index's item
22112     *
22113     * Despite the most common usage of the @p letter argument is for
22114     * single char strings, one could use arbitrary strings as index
22115     * entries.
22116     *
22117     * @c item will be the pointer returned back on @c "changed", @c
22118     * "delay,changed" and @c "selected" smart events.
22119     *
22120     * @ingroup Index
22121     */
22122    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22123
22124    /**
22125     * Append a new item, on a given index widget, <b>after the item
22126     * having @p relative as data</b>.
22127     *
22128     * @param obj The index object.
22129     * @param letter Letter under which the item should be indexed
22130     * @param item The item data to set for the index's item
22131     * @param relative The item data of the index item to be the
22132     * predecessor of this new one
22133     *
22134     * Despite the most common usage of the @p letter argument is for
22135     * single char strings, one could use arbitrary strings as index
22136     * entries.
22137     *
22138     * @c item will be the pointer returned back on @c "changed", @c
22139     * "delay,changed" and @c "selected" smart events.
22140     *
22141     * @note If @p relative is @c NULL or if it's not found to be data
22142     * set on any previous item on @p obj, this function will behave as
22143     * elm_index_item_append().
22144     *
22145     * @ingroup Index
22146     */
22147    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22148
22149    /**
22150     * Prepend a new item, on a given index widget, <b>after the item
22151     * having @p relative as data</b>.
22152     *
22153     * @param obj The index object.
22154     * @param letter Letter under which the item should be indexed
22155     * @param item The item data to set for the index's item
22156     * @param relative The item data of the index item to be the
22157     * successor of this new one
22158     *
22159     * Despite the most common usage of the @p letter argument is for
22160     * single char strings, one could use arbitrary strings as index
22161     * entries.
22162     *
22163     * @c item will be the pointer returned back on @c "changed", @c
22164     * "delay,changed" and @c "selected" smart events.
22165     *
22166     * @note If @p relative is @c NULL or if it's not found to be data
22167     * set on any previous item on @p obj, this function will behave as
22168     * elm_index_item_prepend().
22169     *
22170     * @ingroup Index
22171     */
22172    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22173
22174    /**
22175     * Insert a new item into the given index widget, using @p cmp_func
22176     * function to sort items (by item handles).
22177     *
22178     * @param obj The index object.
22179     * @param letter Letter under which the item should be indexed
22180     * @param item The item data to set for the index's item
22181     * @param cmp_func The comparing function to be used to sort index
22182     * items <b>by #Elm_Index_Item item handles</b>
22183     * @param cmp_data_func A @b fallback function to be called for the
22184     * sorting of index items <b>by item data</b>). It will be used
22185     * when @p cmp_func returns @c 0 (equality), which means an index
22186     * item with provided item data already exists. To decide which
22187     * data item should be pointed to by the index item in question, @p
22188     * cmp_data_func will be used. If @p cmp_data_func returns a
22189     * non-negative value, the previous index item data will be
22190     * replaced by the given @p item pointer. If the previous data need
22191     * to be freed, it should be done by the @p cmp_data_func function,
22192     * because all references to it will be lost. If this function is
22193     * not provided (@c NULL is given), index items will be @b
22194     * duplicated, if @p cmp_func returns @c 0.
22195     *
22196     * Despite the most common usage of the @p letter argument is for
22197     * single char strings, one could use arbitrary strings as index
22198     * entries.
22199     *
22200     * @c item will be the pointer returned back on @c "changed", @c
22201     * "delay,changed" and @c "selected" smart events.
22202     *
22203     * @ingroup Index
22204     */
22205    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);
22206
22207    /**
22208     * Remove an item from a given index widget, <b>to be referenced by
22209     * it's data value</b>.
22210     *
22211     * @param obj The index object
22212     * @param item The item's data pointer for the item to be removed
22213     * from @p obj
22214     *
22215     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22216     * that callback function will be called by this one.
22217     *
22218     * @warning The item to be removed from @p obj will be found via
22219     * its item data pointer, and not by an #Elm_Index_Item handle.
22220     *
22221     * @ingroup Index
22222     */
22223    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22224
22225    /**
22226     * Find a given index widget's item, <b>using item data</b>.
22227     *
22228     * @param obj The index object
22229     * @param item The item data pointed to by the desired index item
22230     * @return The index item handle, if found, or @c NULL otherwise
22231     *
22232     * @ingroup Index
22233     */
22234    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22235
22236    /**
22237     * Removes @b all items from a given index widget.
22238     *
22239     * @param obj The index object.
22240     *
22241     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22242     * that callback function will be called for each item in @p obj.
22243     *
22244     * @ingroup Index
22245     */
22246    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22247
22248    /**
22249     * Go to a given items level on a index widget
22250     *
22251     * @param obj The index object
22252     * @param level The index level (one of @c 0 or @c 1)
22253     *
22254     * @ingroup Index
22255     */
22256    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22257
22258    /**
22259     * Return the data associated with a given index widget item
22260     *
22261     * @param it The index widget item handle
22262     * @return The data associated with @p it
22263     *
22264     * @see elm_index_item_data_set()
22265     *
22266     * @ingroup Index
22267     */
22268    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22269
22270    /**
22271     * Set the data associated with a given index widget item
22272     *
22273     * @param it The index widget item handle
22274     * @param data The new data pointer to set to @p it
22275     *
22276     * This sets new item data on @p it.
22277     *
22278     * @warning The old data pointer won't be touched by this function, so
22279     * the user had better to free that old data himself/herself.
22280     *
22281     * @ingroup Index
22282     */
22283    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22284
22285    /**
22286     * Set the function to be called when a given index widget item is freed.
22287     *
22288     * @param it The item to set the callback on
22289     * @param func The function to call on the item's deletion
22290     *
22291     * When called, @p func will have both @c data and @c event_info
22292     * arguments with the @p it item's data value and, naturally, the
22293     * @c obj argument with a handle to the parent index widget.
22294     *
22295     * @ingroup Index
22296     */
22297    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22298
22299    /**
22300     * Get the letter (string) set on a given index widget item.
22301     *
22302     * @param it The index item handle
22303     * @return The letter string set on @p it
22304     *
22305     * @ingroup Index
22306     */
22307    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22308
22309    /**
22310     * @}
22311     */
22312
22313    /**
22314     * @defgroup Photocam Photocam
22315     *
22316     * @image html img/widget/photocam/preview-00.png
22317     * @image latex img/widget/photocam/preview-00.eps
22318     *
22319     * This is a widget specifically for displaying high-resolution digital
22320     * camera photos giving speedy feedback (fast load), low memory footprint
22321     * and zooming and panning as well as fitting logic. It is entirely focused
22322     * on jpeg images, and takes advantage of properties of the jpeg format (via
22323     * evas loader features in the jpeg loader).
22324     *
22325     * Signals that you can add callbacks for are:
22326     * @li "clicked" - This is called when a user has clicked the photo without
22327     *                 dragging around.
22328     * @li "press" - This is called when a user has pressed down on the photo.
22329     * @li "longpressed" - This is called when a user has pressed down on the
22330     *                     photo for a long time without dragging around.
22331     * @li "clicked,double" - This is called when a user has double-clicked the
22332     *                        photo.
22333     * @li "load" - Photo load begins.
22334     * @li "loaded" - This is called when the image file load is complete for the
22335     *                first view (low resolution blurry version).
22336     * @li "load,detail" - Photo detailed data load begins.
22337     * @li "loaded,detail" - This is called when the image file load is complete
22338     *                      for the detailed image data (full resolution needed).
22339     * @li "zoom,start" - Zoom animation started.
22340     * @li "zoom,stop" - Zoom animation stopped.
22341     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22342     * @li "scroll" - the content has been scrolled (moved)
22343     * @li "scroll,anim,start" - scrolling animation has started
22344     * @li "scroll,anim,stop" - scrolling animation has stopped
22345     * @li "scroll,drag,start" - dragging the contents around has started
22346     * @li "scroll,drag,stop" - dragging the contents around has stopped
22347     *
22348     * @ref tutorial_photocam shows the API in action.
22349     * @{
22350     */
22351    /**
22352     * @brief Types of zoom available.
22353     */
22354    typedef enum _Elm_Photocam_Zoom_Mode
22355      {
22356         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22357         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22358         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22359         ELM_PHOTOCAM_ZOOM_MODE_LAST
22360      } Elm_Photocam_Zoom_Mode;
22361    /**
22362     * @brief Add a new Photocam object
22363     *
22364     * @param parent The parent object
22365     * @return The new object or NULL if it cannot be created
22366     */
22367    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22368    /**
22369     * @brief Set the photo file to be shown
22370     *
22371     * @param obj The photocam object
22372     * @param file The photo file
22373     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22374     *
22375     * This sets (and shows) the specified file (with a relative or absolute
22376     * path) and will return a load error (same error that
22377     * evas_object_image_load_error_get() will return). The image will change and
22378     * adjust its size at this point and begin a background load process for this
22379     * photo that at some time in the future will be displayed at the full
22380     * quality needed.
22381     */
22382    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22383    /**
22384     * @brief Returns the path of the current image file
22385     *
22386     * @param obj The photocam object
22387     * @return Returns the path
22388     *
22389     * @see elm_photocam_file_set()
22390     */
22391    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22392    /**
22393     * @brief Set the zoom level of the photo
22394     *
22395     * @param obj The photocam object
22396     * @param zoom The zoom level to set
22397     *
22398     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22399     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22400     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22401     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22402     * 16, 32, etc.).
22403     */
22404    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22405    /**
22406     * @brief Get the zoom level of the photo
22407     *
22408     * @param obj The photocam object
22409     * @return The current zoom level
22410     *
22411     * This returns the current zoom level of the photocam object. Note that if
22412     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22413     * (which is the default), the zoom level may be changed at any time by the
22414     * photocam object itself to account for photo size and photocam viewpoer
22415     * size.
22416     *
22417     * @see elm_photocam_zoom_set()
22418     * @see elm_photocam_zoom_mode_set()
22419     */
22420    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22421    /**
22422     * @brief Set the zoom mode
22423     *
22424     * @param obj The photocam object
22425     * @param mode The desired mode
22426     *
22427     * This sets the zoom mode to manual or one of several automatic levels.
22428     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22429     * elm_photocam_zoom_set() and will stay at that level until changed by code
22430     * or until zoom mode is changed. This is the default mode. The Automatic
22431     * modes will allow the photocam object to automatically adjust zoom mode
22432     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22433     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22434     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22435     * pixels within the frame are left unfilled.
22436     */
22437    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22438    /**
22439     * @brief Get the zoom mode
22440     *
22441     * @param obj The photocam object
22442     * @return The current zoom mode
22443     *
22444     * This gets the current zoom mode of the photocam object.
22445     *
22446     * @see elm_photocam_zoom_mode_set()
22447     */
22448    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22449    /**
22450     * @brief Get the current image pixel width and height
22451     *
22452     * @param obj The photocam object
22453     * @param w A pointer to the width return
22454     * @param h A pointer to the height return
22455     *
22456     * This gets the current photo pixel width and height (for the original).
22457     * The size will be returned in the integers @p w and @p h that are pointed
22458     * to.
22459     */
22460    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22461    /**
22462     * @brief Get the area of the image that is currently shown
22463     *
22464     * @param obj
22465     * @param x A pointer to the X-coordinate of region
22466     * @param y A pointer to the Y-coordinate of region
22467     * @param w A pointer to the width
22468     * @param h A pointer to the height
22469     *
22470     * @see elm_photocam_image_region_show()
22471     * @see elm_photocam_image_region_bring_in()
22472     */
22473    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22474    /**
22475     * @brief Set the viewed portion of the image
22476     *
22477     * @param obj The photocam object
22478     * @param x X-coordinate of region in image original pixels
22479     * @param y Y-coordinate of region in image original pixels
22480     * @param w Width of region in image original pixels
22481     * @param h Height of region in image original pixels
22482     *
22483     * This shows the region of the image without using animation.
22484     */
22485    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22486    /**
22487     * @brief Bring in the viewed portion of the image
22488     *
22489     * @param obj The photocam object
22490     * @param x X-coordinate of region in image original pixels
22491     * @param y Y-coordinate of region in image original pixels
22492     * @param w Width of region in image original pixels
22493     * @param h Height of region in image original pixels
22494     *
22495     * This shows the region of the image using animation.
22496     */
22497    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22498    /**
22499     * @brief Set the paused state for photocam
22500     *
22501     * @param obj The photocam object
22502     * @param paused The pause state to set
22503     *
22504     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22505     * photocam. The default is off. This will stop zooming using animation on
22506     * zoom levels changes and change instantly. This will stop any existing
22507     * animations that are running.
22508     */
22509    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22510    /**
22511     * @brief Get the paused state for photocam
22512     *
22513     * @param obj The photocam object
22514     * @return The current paused state
22515     *
22516     * This gets the current paused state for the photocam object.
22517     *
22518     * @see elm_photocam_paused_set()
22519     */
22520    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22521    /**
22522     * @brief Get the internal low-res image used for photocam
22523     *
22524     * @param obj The photocam object
22525     * @return The internal image object handle, or NULL if none exists
22526     *
22527     * This gets the internal image object inside photocam. Do not modify it. It
22528     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22529     * deleted at any time as well.
22530     */
22531    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22532    /**
22533     * @brief Set the photocam scrolling bouncing.
22534     *
22535     * @param obj The photocam object
22536     * @param h_bounce bouncing for horizontal
22537     * @param v_bounce bouncing for vertical
22538     */
22539    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22540    /**
22541     * @brief Get the photocam scrolling bouncing.
22542     *
22543     * @param obj The photocam object
22544     * @param h_bounce bouncing for horizontal
22545     * @param v_bounce bouncing for vertical
22546     *
22547     * @see elm_photocam_bounce_set()
22548     */
22549    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22550    /**
22551     * @}
22552     */
22553
22554    /**
22555     * @defgroup Map Map
22556     * @ingroup Elementary
22557     *
22558     * @image html img/widget/map/preview-00.png
22559     * @image latex img/widget/map/preview-00.eps
22560     *
22561     * This is a widget specifically for displaying a map. It uses basically
22562     * OpenStreetMap provider http://www.openstreetmap.org/,
22563     * but custom providers can be added.
22564     *
22565     * It supports some basic but yet nice features:
22566     * @li zoom and scroll
22567     * @li markers with content to be displayed when user clicks over it
22568     * @li group of markers
22569     * @li routes
22570     *
22571     * Smart callbacks one can listen to:
22572     *
22573     * - "clicked" - This is called when a user has clicked the map without
22574     *   dragging around.
22575     * - "press" - This is called when a user has pressed down on the map.
22576     * - "longpressed" - This is called when a user has pressed down on the map
22577     *   for a long time without dragging around.
22578     * - "clicked,double" - This is called when a user has double-clicked
22579     *   the map.
22580     * - "load,detail" - Map detailed data load begins.
22581     * - "loaded,detail" - This is called when all currently visible parts of
22582     *   the map are loaded.
22583     * - "zoom,start" - Zoom animation started.
22584     * - "zoom,stop" - Zoom animation stopped.
22585     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22586     * - "scroll" - the content has been scrolled (moved).
22587     * - "scroll,anim,start" - scrolling animation has started.
22588     * - "scroll,anim,stop" - scrolling animation has stopped.
22589     * - "scroll,drag,start" - dragging the contents around has started.
22590     * - "scroll,drag,stop" - dragging the contents around has stopped.
22591     * - "downloaded" - This is called when all currently required map images
22592     *   are downloaded.
22593     * - "route,load" - This is called when route request begins.
22594     * - "route,loaded" - This is called when route request ends.
22595     * - "name,load" - This is called when name request begins.
22596     * - "name,loaded- This is called when name request ends.
22597     *
22598     * Available style for map widget:
22599     * - @c "default"
22600     *
22601     * Available style for markers:
22602     * - @c "radio"
22603     * - @c "radio2"
22604     * - @c "empty"
22605     *
22606     * Available style for marker bubble:
22607     * - @c "default"
22608     *
22609     * List of examples:
22610     * @li @ref map_example_01
22611     * @li @ref map_example_02
22612     * @li @ref map_example_03
22613     */
22614
22615    /**
22616     * @addtogroup Map
22617     * @{
22618     */
22619
22620    /**
22621     * @enum _Elm_Map_Zoom_Mode
22622     * @typedef Elm_Map_Zoom_Mode
22623     *
22624     * Set map's zoom behavior. It can be set to manual or automatic.
22625     *
22626     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22627     *
22628     * Values <b> don't </b> work as bitmask, only one can be choosen.
22629     *
22630     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22631     * than the scroller view.
22632     *
22633     * @see elm_map_zoom_mode_set()
22634     * @see elm_map_zoom_mode_get()
22635     *
22636     * @ingroup Map
22637     */
22638    typedef enum _Elm_Map_Zoom_Mode
22639      {
22640         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22641         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22642         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22643         ELM_MAP_ZOOM_MODE_LAST
22644      } Elm_Map_Zoom_Mode;
22645
22646    /**
22647     * @enum _Elm_Map_Route_Sources
22648     * @typedef Elm_Map_Route_Sources
22649     *
22650     * Set route service to be used. By default used source is
22651     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22652     *
22653     * @see elm_map_route_source_set()
22654     * @see elm_map_route_source_get()
22655     *
22656     * @ingroup Map
22657     */
22658    typedef enum _Elm_Map_Route_Sources
22659      {
22660         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22661         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. */
22662         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22663         ELM_MAP_ROUTE_SOURCE_LAST
22664      } Elm_Map_Route_Sources;
22665
22666    typedef enum _Elm_Map_Name_Sources
22667      {
22668         ELM_MAP_NAME_SOURCE_NOMINATIM,
22669         ELM_MAP_NAME_SOURCE_LAST
22670      } Elm_Map_Name_Sources;
22671
22672    /**
22673     * @enum _Elm_Map_Route_Type
22674     * @typedef Elm_Map_Route_Type
22675     *
22676     * Set type of transport used on route.
22677     *
22678     * @see elm_map_route_add()
22679     *
22680     * @ingroup Map
22681     */
22682    typedef enum _Elm_Map_Route_Type
22683      {
22684         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22685         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22686         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22687         ELM_MAP_ROUTE_TYPE_LAST
22688      } Elm_Map_Route_Type;
22689
22690    /**
22691     * @enum _Elm_Map_Route_Method
22692     * @typedef Elm_Map_Route_Method
22693     *
22694     * Set the routing method, what should be priorized, time or distance.
22695     *
22696     * @see elm_map_route_add()
22697     *
22698     * @ingroup Map
22699     */
22700    typedef enum _Elm_Map_Route_Method
22701      {
22702         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22703         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22704         ELM_MAP_ROUTE_METHOD_LAST
22705      } Elm_Map_Route_Method;
22706
22707    typedef enum _Elm_Map_Name_Method
22708      {
22709         ELM_MAP_NAME_METHOD_SEARCH,
22710         ELM_MAP_NAME_METHOD_REVERSE,
22711         ELM_MAP_NAME_METHOD_LAST
22712      } Elm_Map_Name_Method;
22713
22714    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(). */
22715    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(). */
22716    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(). */
22717    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(). */
22718    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22719    typedef struct _Elm_Map_Track           Elm_Map_Track;
22720
22721    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. */
22722    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22723    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22724    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22725
22726    typedef char        *(*ElmMapModuleSourceFunc) (void);
22727    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22728    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22729    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22730    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22731    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22732    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22733    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22734    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22735
22736    /**
22737     * Add a new map widget to the given parent Elementary (container) object.
22738     *
22739     * @param parent The parent object.
22740     * @return a new map widget handle or @c NULL, on errors.
22741     *
22742     * This function inserts a new map widget on the canvas.
22743     *
22744     * @ingroup Map
22745     */
22746    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22747
22748    /**
22749     * Set the zoom level of the map.
22750     *
22751     * @param obj The map object.
22752     * @param zoom The zoom level to set.
22753     *
22754     * This sets the zoom level.
22755     *
22756     * It will respect limits defined by elm_map_source_zoom_min_set() and
22757     * elm_map_source_zoom_max_set().
22758     *
22759     * By default these values are 0 (world map) and 18 (maximum zoom).
22760     *
22761     * This function should be used when zoom mode is set to
22762     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22763     * with elm_map_zoom_mode_set().
22764     *
22765     * @see elm_map_zoom_mode_set().
22766     * @see elm_map_zoom_get().
22767     *
22768     * @ingroup Map
22769     */
22770    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22771
22772    /**
22773     * Get the zoom level of the map.
22774     *
22775     * @param obj The map object.
22776     * @return The current zoom level.
22777     *
22778     * This returns the current zoom level of the map object.
22779     *
22780     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22781     * (which is the default), the zoom level may be changed at any time by the
22782     * map object itself to account for map size and map viewport size.
22783     *
22784     * @see elm_map_zoom_set() for details.
22785     *
22786     * @ingroup Map
22787     */
22788    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22789
22790    /**
22791     * Set the zoom mode used by the map object.
22792     *
22793     * @param obj The map object.
22794     * @param mode The zoom mode of the map, being it one of
22795     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22796     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22797     *
22798     * This sets the zoom mode to manual or one of the automatic levels.
22799     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22800     * elm_map_zoom_set() and will stay at that level until changed by code
22801     * or until zoom mode is changed. This is the default mode.
22802     *
22803     * The Automatic modes will allow the map object to automatically
22804     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22805     * adjust zoom so the map fits inside the scroll frame with no pixels
22806     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22807     * ensure no pixels within the frame are left unfilled. Do not forget that
22808     * the valid sizes are 2^zoom, consequently the map may be smaller than
22809     * the scroller view.
22810     *
22811     * @see elm_map_zoom_set()
22812     *
22813     * @ingroup Map
22814     */
22815    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22816
22817    /**
22818     * Get the zoom mode used by the map object.
22819     *
22820     * @param obj The map object.
22821     * @return The zoom mode of the map, being it one of
22822     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22823     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22824     *
22825     * This function returns the current zoom mode used by the map object.
22826     *
22827     * @see elm_map_zoom_mode_set() for more details.
22828     *
22829     * @ingroup Map
22830     */
22831    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22832
22833    /**
22834     * Get the current coordinates of the map.
22835     *
22836     * @param obj The map object.
22837     * @param lon Pointer where to store longitude.
22838     * @param lat Pointer where to store latitude.
22839     *
22840     * This gets the current center coordinates of the map object. It can be
22841     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22842     *
22843     * @see elm_map_geo_region_bring_in()
22844     * @see elm_map_geo_region_show()
22845     *
22846     * @ingroup Map
22847     */
22848    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22849
22850    /**
22851     * Animatedly bring in given coordinates to the center of the map.
22852     *
22853     * @param obj The map object.
22854     * @param lon Longitude to center at.
22855     * @param lat Latitude to center at.
22856     *
22857     * This causes map to jump to the given @p lat and @p lon coordinates
22858     * and show it (by scrolling) in the center of the viewport, if it is not
22859     * already centered. This will use animation to do so and take a period
22860     * of time to complete.
22861     *
22862     * @see elm_map_geo_region_show() for a function to avoid animation.
22863     * @see elm_map_geo_region_get()
22864     *
22865     * @ingroup Map
22866     */
22867    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22868
22869    /**
22870     * Show the given coordinates at the center of the map, @b immediately.
22871     *
22872     * @param obj The map object.
22873     * @param lon Longitude to center at.
22874     * @param lat Latitude to center at.
22875     *
22876     * This causes map to @b redraw its viewport's contents to the
22877     * region contining the given @p lat and @p lon, that will be moved to the
22878     * center of the map.
22879     *
22880     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22881     * @see elm_map_geo_region_get()
22882     *
22883     * @ingroup Map
22884     */
22885    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22886
22887    /**
22888     * Pause or unpause the map.
22889     *
22890     * @param obj The map object.
22891     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22892     * to unpause it.
22893     *
22894     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22895     * for map.
22896     *
22897     * The default is off.
22898     *
22899     * This will stop zooming using animation, changing zoom levels will
22900     * change instantly. This will stop any existing animations that are running.
22901     *
22902     * @see elm_map_paused_get()
22903     *
22904     * @ingroup Map
22905     */
22906    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22907
22908    /**
22909     * Get a value whether map is paused or not.
22910     *
22911     * @param obj The map object.
22912     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22913     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22914     *
22915     * This gets the current paused state for the map object.
22916     *
22917     * @see elm_map_paused_set() for details.
22918     *
22919     * @ingroup Map
22920     */
22921    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22922
22923    /**
22924     * Set to show markers during zoom level changes or not.
22925     *
22926     * @param obj The map object.
22927     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22928     * to show them.
22929     *
22930     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22931     * for map.
22932     *
22933     * The default is off.
22934     *
22935     * This will stop zooming using animation, changing zoom levels will
22936     * change instantly. This will stop any existing animations that are running.
22937     *
22938     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22939     * for the markers.
22940     *
22941     * The default  is off.
22942     *
22943     * Enabling it will force the map to stop displaying the markers during
22944     * zoom level changes. Set to on if you have a large number of markers.
22945     *
22946     * @see elm_map_paused_markers_get()
22947     *
22948     * @ingroup Map
22949     */
22950    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22951
22952    /**
22953     * Get a value whether markers will be displayed on zoom level changes or not
22954     *
22955     * @param obj The map object.
22956     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22957     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22958     *
22959     * This gets the current markers paused state for the map object.
22960     *
22961     * @see elm_map_paused_markers_set() for details.
22962     *
22963     * @ingroup Map
22964     */
22965    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22966
22967    /**
22968     * Get the information of downloading status.
22969     *
22970     * @param obj The map object.
22971     * @param try_num Pointer where to store number of tiles being downloaded.
22972     * @param finish_num Pointer where to store number of tiles successfully
22973     * downloaded.
22974     *
22975     * This gets the current downloading status for the map object, the number
22976     * of tiles being downloaded and the number of tiles already downloaded.
22977     *
22978     * @ingroup Map
22979     */
22980    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22981
22982    /**
22983     * Convert a pixel coordinate (x,y) into a geographic coordinate
22984     * (longitude, latitude).
22985     *
22986     * @param obj The map object.
22987     * @param x the coordinate.
22988     * @param y the coordinate.
22989     * @param size the size in pixels of the map.
22990     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22991     * @param lon Pointer where to store the longitude that correspond to x.
22992     * @param lat Pointer where to store the latitude that correspond to y.
22993     *
22994     * @note Origin pixel point is the top left corner of the viewport.
22995     * Map zoom and size are taken on account.
22996     *
22997     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22998     *
22999     * @ingroup Map
23000     */
23001    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);
23002
23003    /**
23004     * Convert a geographic coordinate (longitude, latitude) into a pixel
23005     * coordinate (x, y).
23006     *
23007     * @param obj The map object.
23008     * @param lon the longitude.
23009     * @param lat the latitude.
23010     * @param size the size in pixels of the map. The map is a square
23011     * and generally his size is : pow(2.0, zoom)*256.
23012     * @param x Pointer where to store the horizontal pixel coordinate that
23013     * correspond to the longitude.
23014     * @param y Pointer where to store the vertical pixel coordinate that
23015     * correspond to the latitude.
23016     *
23017     * @note Origin pixel point is the top left corner of the viewport.
23018     * Map zoom and size are taken on account.
23019     *
23020     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23021     *
23022     * @ingroup Map
23023     */
23024    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);
23025
23026    /**
23027     * Convert a geographic coordinate (longitude, latitude) into a name
23028     * (address).
23029     *
23030     * @param obj The map object.
23031     * @param lon the longitude.
23032     * @param lat the latitude.
23033     * @return name A #Elm_Map_Name handle for this coordinate.
23034     *
23035     * To get the string for this address, elm_map_name_address_get()
23036     * should be used.
23037     *
23038     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23039     *
23040     * @ingroup Map
23041     */
23042    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23043
23044    /**
23045     * Convert a name (address) into a geographic coordinate
23046     * (longitude, latitude).
23047     *
23048     * @param obj The map object.
23049     * @param name The address.
23050     * @return name A #Elm_Map_Name handle for this address.
23051     *
23052     * To get the longitude and latitude, elm_map_name_region_get()
23053     * should be used.
23054     *
23055     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23056     *
23057     * @ingroup Map
23058     */
23059    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23060
23061    /**
23062     * Convert a pixel coordinate into a rotated pixel coordinate.
23063     *
23064     * @param obj The map object.
23065     * @param x horizontal coordinate of the point to rotate.
23066     * @param y vertical coordinate of the point to rotate.
23067     * @param cx rotation's center horizontal position.
23068     * @param cy rotation's center vertical position.
23069     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23070     * @param xx Pointer where to store rotated x.
23071     * @param yy Pointer where to store rotated y.
23072     *
23073     * @ingroup Map
23074     */
23075    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);
23076
23077    /**
23078     * Add a new marker to the map object.
23079     *
23080     * @param obj The map object.
23081     * @param lon The longitude of the marker.
23082     * @param lat The latitude of the marker.
23083     * @param clas The class, to use when marker @b isn't grouped to others.
23084     * @param clas_group The class group, to use when marker is grouped to others
23085     * @param data The data passed to the callbacks.
23086     *
23087     * @return The created marker or @c NULL upon failure.
23088     *
23089     * A marker will be created and shown in a specific point of the map, defined
23090     * by @p lon and @p lat.
23091     *
23092     * It will be displayed using style defined by @p class when this marker
23093     * is displayed alone (not grouped). A new class can be created with
23094     * elm_map_marker_class_new().
23095     *
23096     * If the marker is grouped to other markers, it will be displayed with
23097     * style defined by @p class_group. Markers with the same group are grouped
23098     * if they are close. A new group class can be created with
23099     * elm_map_marker_group_class_new().
23100     *
23101     * Markers created with this method can be deleted with
23102     * elm_map_marker_remove().
23103     *
23104     * A marker can have associated content to be displayed by a bubble,
23105     * when a user click over it, as well as an icon. These objects will
23106     * be fetch using class' callback functions.
23107     *
23108     * @see elm_map_marker_class_new()
23109     * @see elm_map_marker_group_class_new()
23110     * @see elm_map_marker_remove()
23111     *
23112     * @ingroup Map
23113     */
23114    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);
23115
23116    /**
23117     * Set the maximum numbers of markers' content to be displayed in a group.
23118     *
23119     * @param obj The map object.
23120     * @param max The maximum numbers of items displayed in a bubble.
23121     *
23122     * A bubble will be displayed when the user clicks over the group,
23123     * and will place the content of markers that belong to this group
23124     * inside it.
23125     *
23126     * A group can have a long list of markers, consequently the creation
23127     * of the content of the bubble can be very slow.
23128     *
23129     * In order to avoid this, a maximum number of items is displayed
23130     * in a bubble.
23131     *
23132     * By default this number is 30.
23133     *
23134     * Marker with the same group class are grouped if they are close.
23135     *
23136     * @see elm_map_marker_add()
23137     *
23138     * @ingroup Map
23139     */
23140    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23141
23142    /**
23143     * Remove a marker from the map.
23144     *
23145     * @param marker The marker to remove.
23146     *
23147     * @see elm_map_marker_add()
23148     *
23149     * @ingroup Map
23150     */
23151    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23152
23153    /**
23154     * Get the current coordinates of the marker.
23155     *
23156     * @param marker marker.
23157     * @param lat Pointer where to store the marker's latitude.
23158     * @param lon Pointer where to store the marker's longitude.
23159     *
23160     * These values are set when adding markers, with function
23161     * elm_map_marker_add().
23162     *
23163     * @see elm_map_marker_add()
23164     *
23165     * @ingroup Map
23166     */
23167    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23168
23169    /**
23170     * Animatedly bring in given marker to the center of the map.
23171     *
23172     * @param marker The marker to center at.
23173     *
23174     * This causes map to jump to the given @p marker's coordinates
23175     * and show it (by scrolling) in the center of the viewport, if it is not
23176     * already centered. This will use animation to do so and take a period
23177     * of time to complete.
23178     *
23179     * @see elm_map_marker_show() for a function to avoid animation.
23180     * @see elm_map_marker_region_get()
23181     *
23182     * @ingroup Map
23183     */
23184    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23185
23186    /**
23187     * Show the given marker at the center of the map, @b immediately.
23188     *
23189     * @param marker The marker to center at.
23190     *
23191     * This causes map to @b redraw its viewport's contents to the
23192     * region contining the given @p marker's coordinates, that will be
23193     * moved to the center of the map.
23194     *
23195     * @see elm_map_marker_bring_in() for a function to move with animation.
23196     * @see elm_map_markers_list_show() if more than one marker need to be
23197     * displayed.
23198     * @see elm_map_marker_region_get()
23199     *
23200     * @ingroup Map
23201     */
23202    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23203
23204    /**
23205     * Move and zoom the map to display a list of markers.
23206     *
23207     * @param markers A list of #Elm_Map_Marker handles.
23208     *
23209     * The map will be centered on the center point of the markers in the list.
23210     * Then the map will be zoomed in order to fit the markers using the maximum
23211     * zoom which allows display of all the markers.
23212     *
23213     * @warning All the markers should belong to the same map object.
23214     *
23215     * @see elm_map_marker_show() to show a single marker.
23216     * @see elm_map_marker_bring_in()
23217     *
23218     * @ingroup Map
23219     */
23220    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23221
23222    /**
23223     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23224     *
23225     * @param marker The marker wich content should be returned.
23226     * @return Return the evas object if it exists, else @c NULL.
23227     *
23228     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23229     * elm_map_marker_class_get_cb_set() should be used.
23230     *
23231     * This content is what will be inside the bubble that will be displayed
23232     * when an user clicks over the marker.
23233     *
23234     * This returns the actual Evas object used to be placed inside
23235     * the bubble. This may be @c NULL, as it may
23236     * not have been created or may have been deleted, at any time, by
23237     * the map. <b>Do not modify this object</b> (move, resize,
23238     * show, hide, etc.), as the map is controlling it. This
23239     * function is for querying, emitting custom signals or hooking
23240     * lower level callbacks for events on that object. Do not delete
23241     * this object under any circumstances.
23242     *
23243     * @ingroup Map
23244     */
23245    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23246
23247    /**
23248     * Update the marker
23249     *
23250     * @param marker The marker to be updated.
23251     *
23252     * If a content is set to this marker, it will call function to delete it,
23253     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23254     * #ElmMapMarkerGetFunc.
23255     *
23256     * These functions are set for the marker class with
23257     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23258     *
23259     * @ingroup Map
23260     */
23261    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23262
23263    /**
23264     * Close all the bubbles opened by the user.
23265     *
23266     * @param obj The map object.
23267     *
23268     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23269     * when the user clicks on a marker.
23270     *
23271     * This functions is set for the marker class with
23272     * elm_map_marker_class_get_cb_set().
23273     *
23274     * @ingroup Map
23275     */
23276    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23277
23278    /**
23279     * Create a new group class.
23280     *
23281     * @param obj The map object.
23282     * @return Returns the new group class.
23283     *
23284     * Each marker must be associated to a group class. Markers in the same
23285     * group are grouped if they are close.
23286     *
23287     * The group class defines the style of the marker when a marker is grouped
23288     * to others markers. When it is alone, another class will be used.
23289     *
23290     * A group class will need to be provided when creating a marker with
23291     * elm_map_marker_add().
23292     *
23293     * Some properties and functions can be set by class, as:
23294     * - style, with elm_map_group_class_style_set()
23295     * - data - to be associated to the group class. It can be set using
23296     *   elm_map_group_class_data_set().
23297     * - min zoom to display markers, set with
23298     *   elm_map_group_class_zoom_displayed_set().
23299     * - max zoom to group markers, set using
23300     *   elm_map_group_class_zoom_grouped_set().
23301     * - visibility - set if markers will be visible or not, set with
23302     *   elm_map_group_class_hide_set().
23303     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23304     *   It can be set using elm_map_group_class_icon_cb_set().
23305     *
23306     * @see elm_map_marker_add()
23307     * @see elm_map_group_class_style_set()
23308     * @see elm_map_group_class_data_set()
23309     * @see elm_map_group_class_zoom_displayed_set()
23310     * @see elm_map_group_class_zoom_grouped_set()
23311     * @see elm_map_group_class_hide_set()
23312     * @see elm_map_group_class_icon_cb_set()
23313     *
23314     * @ingroup Map
23315     */
23316    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23317
23318    /**
23319     * Set the marker's style of a group class.
23320     *
23321     * @param clas The group class.
23322     * @param style The style to be used by markers.
23323     *
23324     * Each marker must be associated to a group class, and will use the style
23325     * defined by such class when grouped to other markers.
23326     *
23327     * The following styles are provided by default theme:
23328     * @li @c radio - blue circle
23329     * @li @c radio2 - green circle
23330     * @li @c empty
23331     *
23332     * @see elm_map_group_class_new() for more details.
23333     * @see elm_map_marker_add()
23334     *
23335     * @ingroup Map
23336     */
23337    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23338
23339    /**
23340     * Set the icon callback function of a group class.
23341     *
23342     * @param clas The group class.
23343     * @param icon_get The callback function that will return the icon.
23344     *
23345     * Each marker must be associated to a group class, and it can display a
23346     * custom icon. The function @p icon_get must return this icon.
23347     *
23348     * @see elm_map_group_class_new() for more details.
23349     * @see elm_map_marker_add()
23350     *
23351     * @ingroup Map
23352     */
23353    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23354
23355    /**
23356     * Set the data associated to the group class.
23357     *
23358     * @param clas The group class.
23359     * @param data The new user data.
23360     *
23361     * This data will be passed for callback functions, like icon get callback,
23362     * that can be set with elm_map_group_class_icon_cb_set().
23363     *
23364     * If a data was previously set, the object will lose the pointer for it,
23365     * so if needs to be freed, you must do it yourself.
23366     *
23367     * @see elm_map_group_class_new() for more details.
23368     * @see elm_map_group_class_icon_cb_set()
23369     * @see elm_map_marker_add()
23370     *
23371     * @ingroup Map
23372     */
23373    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23374
23375    /**
23376     * Set the minimum zoom from where the markers are displayed.
23377     *
23378     * @param clas The group class.
23379     * @param zoom The minimum zoom.
23380     *
23381     * Markers only will be displayed when the map is displayed at @p zoom
23382     * or bigger.
23383     *
23384     * @see elm_map_group_class_new() for more details.
23385     * @see elm_map_marker_add()
23386     *
23387     * @ingroup Map
23388     */
23389    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23390
23391    /**
23392     * Set the zoom from where the markers are no more grouped.
23393     *
23394     * @param clas The group class.
23395     * @param zoom The maximum zoom.
23396     *
23397     * Markers only will be grouped when the map is displayed at
23398     * less than @p zoom.
23399     *
23400     * @see elm_map_group_class_new() for more details.
23401     * @see elm_map_marker_add()
23402     *
23403     * @ingroup Map
23404     */
23405    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23406
23407    /**
23408     * Set if the markers associated to the group class @clas are hidden or not.
23409     *
23410     * @param clas The group class.
23411     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23412     * to show them.
23413     *
23414     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23415     * is to show them.
23416     *
23417     * @ingroup Map
23418     */
23419    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23420
23421    /**
23422     * Create a new marker class.
23423     *
23424     * @param obj The map object.
23425     * @return Returns the new group class.
23426     *
23427     * Each marker must be associated to a class.
23428     *
23429     * The marker class defines the style of the marker when a marker is
23430     * displayed alone, i.e., not grouped to to others markers. When grouped
23431     * it will use group class style.
23432     *
23433     * A marker class will need to be provided when creating a marker with
23434     * elm_map_marker_add().
23435     *
23436     * Some properties and functions can be set by class, as:
23437     * - style, with elm_map_marker_class_style_set()
23438     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23439     *   It can be set using elm_map_marker_class_icon_cb_set().
23440     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23441     *   Set using elm_map_marker_class_get_cb_set().
23442     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23443     *   Set using elm_map_marker_class_del_cb_set().
23444     *
23445     * @see elm_map_marker_add()
23446     * @see elm_map_marker_class_style_set()
23447     * @see elm_map_marker_class_icon_cb_set()
23448     * @see elm_map_marker_class_get_cb_set()
23449     * @see elm_map_marker_class_del_cb_set()
23450     *
23451     * @ingroup Map
23452     */
23453    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23454
23455    /**
23456     * Set the marker's style of a marker class.
23457     *
23458     * @param clas The marker class.
23459     * @param style The style to be used by markers.
23460     *
23461     * Each marker must be associated to a marker class, and will use the style
23462     * defined by such class when alone, i.e., @b not grouped to other markers.
23463     *
23464     * The following styles are provided by default theme:
23465     * @li @c radio
23466     * @li @c radio2
23467     * @li @c empty
23468     *
23469     * @see elm_map_marker_class_new() for more details.
23470     * @see elm_map_marker_add()
23471     *
23472     * @ingroup Map
23473     */
23474    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23475
23476    /**
23477     * Set the icon callback function of a marker class.
23478     *
23479     * @param clas The marker class.
23480     * @param icon_get The callback function that will return the icon.
23481     *
23482     * Each marker must be associated to a marker class, and it can display a
23483     * custom icon. The function @p icon_get must return this icon.
23484     *
23485     * @see elm_map_marker_class_new() for more details.
23486     * @see elm_map_marker_add()
23487     *
23488     * @ingroup Map
23489     */
23490    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23491
23492    /**
23493     * Set the bubble content callback function of a marker class.
23494     *
23495     * @param clas The marker class.
23496     * @param get The callback function that will return the content.
23497     *
23498     * Each marker must be associated to a marker class, and it can display a
23499     * a content on a bubble that opens when the user click over the marker.
23500     * The function @p get must return this content object.
23501     *
23502     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23503     * can be used.
23504     *
23505     * @see elm_map_marker_class_new() for more details.
23506     * @see elm_map_marker_class_del_cb_set()
23507     * @see elm_map_marker_add()
23508     *
23509     * @ingroup Map
23510     */
23511    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23512
23513    /**
23514     * Set the callback function used to delete bubble content of a marker class.
23515     *
23516     * @param clas The marker class.
23517     * @param del The callback function that will delete the content.
23518     *
23519     * Each marker must be associated to a marker class, and it can display a
23520     * a content on a bubble that opens when the user click over the marker.
23521     * The function to return such content can be set with
23522     * elm_map_marker_class_get_cb_set().
23523     *
23524     * If this content must be freed, a callback function need to be
23525     * set for that task with this function.
23526     *
23527     * If this callback is defined it will have to delete (or not) the
23528     * object inside, but if the callback is not defined the object will be
23529     * destroyed with evas_object_del().
23530     *
23531     * @see elm_map_marker_class_new() for more details.
23532     * @see elm_map_marker_class_get_cb_set()
23533     * @see elm_map_marker_add()
23534     *
23535     * @ingroup Map
23536     */
23537    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23538
23539    /**
23540     * Get the list of available sources.
23541     *
23542     * @param obj The map object.
23543     * @return The source names list.
23544     *
23545     * It will provide a list with all available sources, that can be set as
23546     * current source with elm_map_source_name_set(), or get with
23547     * elm_map_source_name_get().
23548     *
23549     * Available sources:
23550     * @li "Mapnik"
23551     * @li "Osmarender"
23552     * @li "CycleMap"
23553     * @li "Maplint"
23554     *
23555     * @see elm_map_source_name_set() for more details.
23556     * @see elm_map_source_name_get()
23557     *
23558     * @ingroup Map
23559     */
23560    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23561
23562    /**
23563     * Set the source of the map.
23564     *
23565     * @param obj The map object.
23566     * @param source The source to be used.
23567     *
23568     * Map widget retrieves images that composes the map from a web service.
23569     * This web service can be set with this method.
23570     *
23571     * A different service can return a different maps with different
23572     * information and it can use different zoom values.
23573     *
23574     * The @p source_name need to match one of the names provided by
23575     * elm_map_source_names_get().
23576     *
23577     * The current source can be get using elm_map_source_name_get().
23578     *
23579     * @see elm_map_source_names_get()
23580     * @see elm_map_source_name_get()
23581     *
23582     *
23583     * @ingroup Map
23584     */
23585    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23586
23587    /**
23588     * Get the name of currently used source.
23589     *
23590     * @param obj The map object.
23591     * @return Returns the name of the source in use.
23592     *
23593     * @see elm_map_source_name_set() for more details.
23594     *
23595     * @ingroup Map
23596     */
23597    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23598
23599    /**
23600     * Set the source of the route service to be used by the map.
23601     *
23602     * @param obj The map object.
23603     * @param source The route service to be used, being it one of
23604     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23605     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23606     *
23607     * Each one has its own algorithm, so the route retrieved may
23608     * differ depending on the source route. Now, only the default is working.
23609     *
23610     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23611     * http://www.yournavigation.org/.
23612     *
23613     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23614     * assumptions. Its routing core is based on Contraction Hierarchies.
23615     *
23616     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23617     *
23618     * @see elm_map_route_source_get().
23619     *
23620     * @ingroup Map
23621     */
23622    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23623
23624    /**
23625     * Get the current route source.
23626     *
23627     * @param obj The map object.
23628     * @return The source of the route service used by the map.
23629     *
23630     * @see elm_map_route_source_set() for details.
23631     *
23632     * @ingroup Map
23633     */
23634    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23635
23636    /**
23637     * Set the minimum zoom of the source.
23638     *
23639     * @param obj The map object.
23640     * @param zoom New minimum zoom value to be used.
23641     *
23642     * By default, it's 0.
23643     *
23644     * @ingroup Map
23645     */
23646    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23647
23648    /**
23649     * Get the minimum zoom of the source.
23650     *
23651     * @param obj The map object.
23652     * @return Returns the minimum zoom of the source.
23653     *
23654     * @see elm_map_source_zoom_min_set() for details.
23655     *
23656     * @ingroup Map
23657     */
23658    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23659
23660    /**
23661     * Set the maximum zoom of the source.
23662     *
23663     * @param obj The map object.
23664     * @param zoom New maximum zoom value to be used.
23665     *
23666     * By default, it's 18.
23667     *
23668     * @ingroup Map
23669     */
23670    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23671
23672    /**
23673     * Get the maximum zoom of the source.
23674     *
23675     * @param obj The map object.
23676     * @return Returns the maximum zoom of the source.
23677     *
23678     * @see elm_map_source_zoom_min_set() for details.
23679     *
23680     * @ingroup Map
23681     */
23682    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23683
23684    /**
23685     * Set the user agent used by the map object to access routing services.
23686     *
23687     * @param obj The map object.
23688     * @param user_agent The user agent to be used by the map.
23689     *
23690     * User agent is a client application implementing a network protocol used
23691     * in communications within a clientā€“server distributed computing system
23692     *
23693     * The @p user_agent identification string will transmitted in a header
23694     * field @c User-Agent.
23695     *
23696     * @see elm_map_user_agent_get()
23697     *
23698     * @ingroup Map
23699     */
23700    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23701
23702    /**
23703     * Get the user agent used by the map object.
23704     *
23705     * @param obj The map object.
23706     * @return The user agent identification string used by the map.
23707     *
23708     * @see elm_map_user_agent_set() for details.
23709     *
23710     * @ingroup Map
23711     */
23712    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23713
23714    /**
23715     * Add a new route to the map object.
23716     *
23717     * @param obj The map object.
23718     * @param type The type of transport to be considered when tracing a route.
23719     * @param method The routing method, what should be priorized.
23720     * @param flon The start longitude.
23721     * @param flat The start latitude.
23722     * @param tlon The destination longitude.
23723     * @param tlat The destination latitude.
23724     *
23725     * @return The created route or @c NULL upon failure.
23726     *
23727     * A route will be traced by point on coordinates (@p flat, @p flon)
23728     * to point on coordinates (@p tlat, @p tlon), using the route service
23729     * set with elm_map_route_source_set().
23730     *
23731     * It will take @p type on consideration to define the route,
23732     * depending if the user will be walking or driving, the route may vary.
23733     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23734     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23735     *
23736     * Another parameter is what the route should priorize, the minor distance
23737     * or the less time to be spend on the route. So @p method should be one
23738     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23739     *
23740     * Routes created with this method can be deleted with
23741     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23742     * and distance can be get with elm_map_route_distance_get().
23743     *
23744     * @see elm_map_route_remove()
23745     * @see elm_map_route_color_set()
23746     * @see elm_map_route_distance_get()
23747     * @see elm_map_route_source_set()
23748     *
23749     * @ingroup Map
23750     */
23751    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);
23752
23753    /**
23754     * Remove a route from the map.
23755     *
23756     * @param route The route to remove.
23757     *
23758     * @see elm_map_route_add()
23759     *
23760     * @ingroup Map
23761     */
23762    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23763
23764    /**
23765     * Set the route color.
23766     *
23767     * @param route The route object.
23768     * @param r Red channel value, from 0 to 255.
23769     * @param g Green channel value, from 0 to 255.
23770     * @param b Blue channel value, from 0 to 255.
23771     * @param a Alpha channel value, from 0 to 255.
23772     *
23773     * It uses an additive color model, so each color channel represents
23774     * how much of each primary colors must to be used. 0 represents
23775     * ausence of this color, so if all of the three are set to 0,
23776     * the color will be black.
23777     *
23778     * These component values should be integers in the range 0 to 255,
23779     * (single 8-bit byte).
23780     *
23781     * This sets the color used for the route. By default, it is set to
23782     * solid red (r = 255, g = 0, b = 0, a = 255).
23783     *
23784     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23785     *
23786     * @see elm_map_route_color_get()
23787     *
23788     * @ingroup Map
23789     */
23790    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23791
23792    /**
23793     * Get the route color.
23794     *
23795     * @param route The route object.
23796     * @param r Pointer where to store the red channel value.
23797     * @param g Pointer where to store the green channel value.
23798     * @param b Pointer where to store the blue channel value.
23799     * @param a Pointer where to store the alpha channel value.
23800     *
23801     * @see elm_map_route_color_set() for details.
23802     *
23803     * @ingroup Map
23804     */
23805    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23806
23807    /**
23808     * Get the route distance in kilometers.
23809     *
23810     * @param route The route object.
23811     * @return The distance of route (unit : km).
23812     *
23813     * @ingroup Map
23814     */
23815    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23816
23817    /**
23818     * Get the information of route nodes.
23819     *
23820     * @param route The route object.
23821     * @return Returns a string with the nodes of route.
23822     *
23823     * @ingroup Map
23824     */
23825    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23826
23827    /**
23828     * Get the information of route waypoint.
23829     *
23830     * @param route the route object.
23831     * @return Returns a string with information about waypoint of route.
23832     *
23833     * @ingroup Map
23834     */
23835    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23836
23837    /**
23838     * Get the address of the name.
23839     *
23840     * @param name The name handle.
23841     * @return Returns the address string of @p name.
23842     *
23843     * This gets the coordinates of the @p name, created with one of the
23844     * conversion functions.
23845     *
23846     * @see elm_map_utils_convert_name_into_coord()
23847     * @see elm_map_utils_convert_coord_into_name()
23848     *
23849     * @ingroup Map
23850     */
23851    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23852
23853    /**
23854     * Get the current coordinates of the name.
23855     *
23856     * @param name The name handle.
23857     * @param lat Pointer where to store the latitude.
23858     * @param lon Pointer where to store The longitude.
23859     *
23860     * This gets the coordinates of the @p name, created with one of the
23861     * conversion functions.
23862     *
23863     * @see elm_map_utils_convert_name_into_coord()
23864     * @see elm_map_utils_convert_coord_into_name()
23865     *
23866     * @ingroup Map
23867     */
23868    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23869
23870    /**
23871     * Remove a name from the map.
23872     *
23873     * @param name The name to remove.
23874     *
23875     * Basically the struct handled by @p name will be freed, so convertions
23876     * between address and coordinates will be lost.
23877     *
23878     * @see elm_map_utils_convert_name_into_coord()
23879     * @see elm_map_utils_convert_coord_into_name()
23880     *
23881     * @ingroup Map
23882     */
23883    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23884
23885    /**
23886     * Rotate the map.
23887     *
23888     * @param obj The map object.
23889     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23890     * @param cx Rotation's center horizontal position.
23891     * @param cy Rotation's center vertical position.
23892     *
23893     * @see elm_map_rotate_get()
23894     *
23895     * @ingroup Map
23896     */
23897    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23898
23899    /**
23900     * Get the rotate degree of the map
23901     *
23902     * @param obj The map object
23903     * @param degree Pointer where to store degrees from 0.0 to 360.0
23904     * to rotate arount Z axis.
23905     * @param cx Pointer where to store rotation's center horizontal position.
23906     * @param cy Pointer where to store rotation's center vertical position.
23907     *
23908     * @see elm_map_rotate_set() to set map rotation.
23909     *
23910     * @ingroup Map
23911     */
23912    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);
23913
23914    /**
23915     * Enable or disable mouse wheel to be used to zoom in / out the map.
23916     *
23917     * @param obj The map object.
23918     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23919     * to enable it.
23920     *
23921     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23922     *
23923     * It's disabled by default.
23924     *
23925     * @see elm_map_wheel_disabled_get()
23926     *
23927     * @ingroup Map
23928     */
23929    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23930
23931    /**
23932     * Get a value whether mouse wheel is enabled or not.
23933     *
23934     * @param obj The map object.
23935     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23936     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23937     *
23938     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23939     *
23940     * @see elm_map_wheel_disabled_set() for details.
23941     *
23942     * @ingroup Map
23943     */
23944    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23945
23946 #ifdef ELM_EMAP
23947    /**
23948     * Add a track on the map
23949     *
23950     * @param obj The map object.
23951     * @param emap The emap route object.
23952     * @return The route object. This is an elm object of type Route.
23953     *
23954     * @see elm_route_add() for details.
23955     *
23956     * @ingroup Map
23957     */
23958    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23959 #endif
23960
23961    /**
23962     * Remove a track from the map
23963     *
23964     * @param obj The map object.
23965     * @param route The track to remove.
23966     *
23967     * @ingroup Map
23968     */
23969    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23970
23971    /**
23972     * @}
23973     */
23974
23975    /* Route */
23976    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23977 #ifdef ELM_EMAP
23978    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23979 #endif
23980    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23981    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23982    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23983    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23984
23985
23986    /**
23987     * @defgroup Panel Panel
23988     *
23989     * @image html img/widget/panel/preview-00.png
23990     * @image latex img/widget/panel/preview-00.eps
23991     *
23992     * @brief A panel is a type of animated container that contains subobjects.
23993     * It can be expanded or contracted by clicking the button on it's edge.
23994     *
23995     * Orientations are as follows:
23996     * @li ELM_PANEL_ORIENT_TOP
23997     * @li ELM_PANEL_ORIENT_LEFT
23998     * @li ELM_PANEL_ORIENT_RIGHT
23999     *
24000     * Default contents parts of the panel widget that you can use for are:
24001     * @li "default" - A content of the panel
24002     *
24003     * @ref tutorial_panel shows one way to use this widget.
24004     * @{
24005     */
24006    typedef enum _Elm_Panel_Orient
24007      {
24008         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24009         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24010         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24011         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24012      } Elm_Panel_Orient;
24013    /**
24014     * @brief Adds a panel object
24015     *
24016     * @param parent The parent object
24017     *
24018     * @return The panel object, or NULL on failure
24019     */
24020    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24021    /**
24022     * @brief Sets the orientation of the panel
24023     *
24024     * @param parent The parent object
24025     * @param orient The panel orientation. Can be one of the following:
24026     * @li ELM_PANEL_ORIENT_TOP
24027     * @li ELM_PANEL_ORIENT_LEFT
24028     * @li ELM_PANEL_ORIENT_RIGHT
24029     *
24030     * Sets from where the panel will (dis)appear.
24031     */
24032    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24033    /**
24034     * @brief Get the orientation of the panel.
24035     *
24036     * @param obj The panel object
24037     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24038     */
24039    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24040    /**
24041     * @brief Set the content of the panel.
24042     *
24043     * @param obj The panel object
24044     * @param content The panel content
24045     *
24046     * Once the content object is set, a previously set one will be deleted.
24047     * If you want to keep that old content object, use the
24048     * elm_panel_content_unset() function.
24049     *
24050     * @deprecated use elm_object_content_set() instead
24051     *
24052     */
24053    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24054    /**
24055     * @brief Get the content of the panel.
24056     *
24057     * @param obj The panel object
24058     * @return The content that is being used
24059     *
24060     * Return the content object which is set for this widget.
24061     *
24062     * @see elm_panel_content_set()
24063     * 
24064     * @deprecated use elm_object_content_get() instead
24065     *
24066     */
24067    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24068    /**
24069     * @brief Unset the content of the panel.
24070     *
24071     * @param obj The panel object
24072     * @return The content that was being used
24073     *
24074     * Unparent and return the content object which was set for this widget.
24075     *
24076     * @see elm_panel_content_set()
24077     *
24078     * @deprecated use elm_object_content_unset() instead
24079     *
24080     */
24081    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24082    /**
24083     * @brief Set the state of the panel.
24084     *
24085     * @param obj The panel object
24086     * @param hidden If true, the panel will run the animation to contract
24087     */
24088    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24089    /**
24090     * @brief Get the state of the panel.
24091     *
24092     * @param obj The panel object
24093     * @param hidden If true, the panel is in the "hide" state
24094     */
24095    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24096    /**
24097     * @brief Toggle the hidden state of the panel from code
24098     *
24099     * @param obj The panel object
24100     */
24101    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24102    /**
24103     * @}
24104     */
24105
24106    /**
24107     * @defgroup Panes Panes
24108     * @ingroup Elementary
24109     *
24110     * @image html img/widget/panes/preview-00.png
24111     * @image latex img/widget/panes/preview-00.eps width=\textwidth
24112     *
24113     * @image html img/panes.png
24114     * @image latex img/panes.eps width=\textwidth
24115     *
24116     * The panes adds a dragable bar between two contents. When dragged
24117     * this bar will resize contents size.
24118     *
24119     * Panes can be displayed vertically or horizontally, and contents
24120     * size proportion can be customized (homogeneous by default).
24121     *
24122     * Smart callbacks one can listen to:
24123     * - "press" - The panes has been pressed (button wasn't released yet).
24124     * - "unpressed" - The panes was released after being pressed.
24125     * - "clicked" - The panes has been clicked>
24126     * - "clicked,double" - The panes has been double clicked
24127     *
24128     * Available styles for it:
24129     * - @c "default"
24130     *
24131     * Default contents parts of the panes widget that you can use for are:
24132     * @li "left" - A leftside content of the panes
24133     * @li "right" - A rightside content of the panes
24134     *
24135     * If panes is displayed vertically, left content will be displayed at
24136     * top.
24137     * 
24138     * Here is an example on its usage:
24139     * @li @ref panes_example
24140     */
24141
24142    /**
24143     * @addtogroup Panes
24144     * @{
24145     */
24146
24147    /**
24148     * Add a new panes widget to the given parent Elementary
24149     * (container) object.
24150     *
24151     * @param parent The parent object.
24152     * @return a new panes widget handle or @c NULL, on errors.
24153     *
24154     * This function inserts a new panes widget on the canvas.
24155     *
24156     * @ingroup Panes
24157     */
24158    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24159
24160    /**
24161     * Set the left content of the panes widget.
24162     *
24163     * @param obj The panes object.
24164     * @param content The new left content object.
24165     *
24166     * Once the content object is set, a previously set one will be deleted.
24167     * If you want to keep that old content object, use the
24168     * elm_panes_content_left_unset() function.
24169     *
24170     * If panes is displayed vertically, left content will be displayed at
24171     * top.
24172     *
24173     * @see elm_panes_content_left_get()
24174     * @see elm_panes_content_right_set() to set content on the other side.
24175     *
24176     * @deprecated use elm_object_part_content_set() instead
24177     *
24178     * @ingroup Panes
24179     */
24180    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24181
24182    /**
24183     * Set the right content of the panes widget.
24184     *
24185     * @param obj The panes object.
24186     * @param content The new right content object.
24187     *
24188     * Once the content object is set, a previously set one will be deleted.
24189     * If you want to keep that old content object, use the
24190     * elm_panes_content_right_unset() function.
24191     *
24192     * If panes is displayed vertically, left content will be displayed at
24193     * bottom.
24194     *
24195     * @see elm_panes_content_right_get()
24196     * @see elm_panes_content_left_set() to set content on the other side.
24197     *
24198     * @deprecated use elm_object_part_content_set() instead
24199     *
24200     * @ingroup Panes
24201     */
24202    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24203
24204    /**
24205     * Get the left content of the panes.
24206     *
24207     * @param obj The panes object.
24208     * @return The left content object that is being used.
24209     *
24210     * Return the left content object which is set for this widget.
24211     *
24212     * @see elm_panes_content_left_set() for details.
24213     *
24214     * @deprecated use elm_object_part_content_get() instead
24215     *
24216     * @ingroup Panes
24217     */
24218    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24219
24220    /**
24221     * Get the right content of the panes.
24222     *
24223     * @param obj The panes object
24224     * @return The right content object that is being used
24225     *
24226     * Return the right content object which is set for this widget.
24227     *
24228     * @see elm_panes_content_right_set() for details.
24229     *
24230     * @deprecated use elm_object_part_content_get() instead
24231     *
24232     * @ingroup Panes
24233     */
24234    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24235
24236    /**
24237     * Unset the left content used for the panes.
24238     *
24239     * @param obj The panes object.
24240     * @return The left content object that was being used.
24241     *
24242     * Unparent and return the left content object which was set for this widget.
24243     *
24244     * @see elm_panes_content_left_set() for details.
24245     * @see elm_panes_content_left_get().
24246     *
24247     * @deprecated use elm_object_part_content_unset() instead
24248     *
24249     * @ingroup Panes
24250     */
24251    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24252
24253    /**
24254     * Unset the right content used for the panes.
24255     *
24256     * @param obj The panes object.
24257     * @return The right content object that was being used.
24258     *
24259     * Unparent and return the right content object which was set for this
24260     * widget.
24261     *
24262     * @see elm_panes_content_right_set() for details.
24263     * @see elm_panes_content_right_get().
24264     *
24265     * @deprecated use elm_object_part_content_unset() instead
24266     *
24267     * @ingroup Panes
24268     */
24269    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24270
24271    /**
24272     * Get the size proportion of panes widget's left side.
24273     *
24274     * @param obj The panes object.
24275     * @return float value between 0.0 and 1.0 representing size proportion
24276     * of left side.
24277     *
24278     * @see elm_panes_content_left_size_set() for more details.
24279     *
24280     * @ingroup Panes
24281     */
24282    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24283
24284    /**
24285     * Set the size proportion of panes widget's left side.
24286     *
24287     * @param obj The panes object.
24288     * @param size Value between 0.0 and 1.0 representing size proportion
24289     * of left side.
24290     *
24291     * By default it's homogeneous, i.e., both sides have the same size.
24292     *
24293     * If something different is required, it can be set with this function.
24294     * For example, if the left content should be displayed over
24295     * 75% of the panes size, @p size should be passed as @c 0.75.
24296     * This way, right content will be resized to 25% of panes size.
24297     *
24298     * If displayed vertically, left content is displayed at top, and
24299     * right content at bottom.
24300     *
24301     * @note This proportion will change when user drags the panes bar.
24302     *
24303     * @see elm_panes_content_left_size_get()
24304     *
24305     * @ingroup Panes
24306     */
24307    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24308
24309   /**
24310    * Set the orientation of a given panes widget.
24311    *
24312    * @param obj The panes object.
24313    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24314    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24315    *
24316    * Use this function to change how your panes is to be
24317    * disposed: vertically or horizontally.
24318    *
24319    * By default it's displayed horizontally.
24320    *
24321    * @see elm_panes_horizontal_get()
24322    *
24323    * @ingroup Panes
24324    */
24325    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24326
24327    /**
24328     * Retrieve the orientation of a given panes widget.
24329     *
24330     * @param obj The panes object.
24331     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24332     * @c EINA_FALSE if it's @b vertical (and on errors).
24333     *
24334     * @see elm_panes_horizontal_set() for more details.
24335     *
24336     * @ingroup Panes
24337     */
24338    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24339    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24340    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24341
24342    /**
24343     * @}
24344     */
24345
24346    /**
24347     * @defgroup Flip Flip
24348     *
24349     * @image html img/widget/flip/preview-00.png
24350     * @image latex img/widget/flip/preview-00.eps
24351     *
24352     * This widget holds 2 content objects(Evas_Object): one on the front and one
24353     * on the back. It allows you to flip from front to back and vice-versa using
24354     * various animations.
24355     *
24356     * If either the front or back contents are not set the flip will treat that
24357     * as transparent. So if you wore to set the front content but not the back,
24358     * and then call elm_flip_go() you would see whatever is below the flip.
24359     *
24360     * For a list of supported animations see elm_flip_go().
24361     *
24362     * Signals that you can add callbacks for are:
24363     * "animate,begin" - when a flip animation was started
24364     * "animate,done" - when a flip animation is finished
24365     *
24366     * @ref tutorial_flip show how to use most of the API.
24367     *
24368     * @{
24369     */
24370    typedef enum _Elm_Flip_Mode
24371      {
24372         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24373         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24374         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24375         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24376         ELM_FLIP_CUBE_LEFT,
24377         ELM_FLIP_CUBE_RIGHT,
24378         ELM_FLIP_CUBE_UP,
24379         ELM_FLIP_CUBE_DOWN,
24380         ELM_FLIP_PAGE_LEFT,
24381         ELM_FLIP_PAGE_RIGHT,
24382         ELM_FLIP_PAGE_UP,
24383         ELM_FLIP_PAGE_DOWN
24384      } Elm_Flip_Mode;
24385    typedef enum _Elm_Flip_Interaction
24386      {
24387         ELM_FLIP_INTERACTION_NONE,
24388         ELM_FLIP_INTERACTION_ROTATE,
24389         ELM_FLIP_INTERACTION_CUBE,
24390         ELM_FLIP_INTERACTION_PAGE
24391      } Elm_Flip_Interaction;
24392    typedef enum _Elm_Flip_Direction
24393      {
24394         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24395         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24396         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24397         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24398      } Elm_Flip_Direction;
24399    /**
24400     * @brief Add a new flip to the parent
24401     *
24402     * @param parent The parent object
24403     * @return The new object or NULL if it cannot be created
24404     */
24405    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24406    /**
24407     * @brief Set the front content of the flip widget.
24408     *
24409     * @param obj The flip object
24410     * @param content The new front content object
24411     *
24412     * Once the content object is set, a previously set one will be deleted.
24413     * If you want to keep that old content object, use the
24414     * elm_flip_content_front_unset() function.
24415     */
24416    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24417    /**
24418     * @brief Set the back content of the flip widget.
24419     *
24420     * @param obj The flip object
24421     * @param content The new back content object
24422     *
24423     * Once the content object is set, a previously set one will be deleted.
24424     * If you want to keep that old content object, use the
24425     * elm_flip_content_back_unset() function.
24426     */
24427    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24428    /**
24429     * @brief Get the front content used for the flip
24430     *
24431     * @param obj The flip object
24432     * @return The front content object that is being used
24433     *
24434     * Return the front content object which is set for this widget.
24435     */
24436    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24437    /**
24438     * @brief Get the back content used for the flip
24439     *
24440     * @param obj The flip object
24441     * @return The back content object that is being used
24442     *
24443     * Return the back content object which is set for this widget.
24444     */
24445    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24446    /**
24447     * @brief Unset the front content used for the flip
24448     *
24449     * @param obj The flip object
24450     * @return The front content object that was being used
24451     *
24452     * Unparent and return the front content object which was set for this widget.
24453     */
24454    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24455    /**
24456     * @brief Unset the back content used for the flip
24457     *
24458     * @param obj The flip object
24459     * @return The back content object that was being used
24460     *
24461     * Unparent and return the back content object which was set for this widget.
24462     */
24463    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24464    /**
24465     * @brief Get flip front visibility state
24466     *
24467     * @param obj The flip objct
24468     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24469     * showing.
24470     */
24471    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24472    /**
24473     * @brief Set flip perspective
24474     *
24475     * @param obj The flip object
24476     * @param foc The coordinate to set the focus on
24477     * @param x The X coordinate
24478     * @param y The Y coordinate
24479     *
24480     * @warning This function currently does nothing.
24481     */
24482    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24483    /**
24484     * @brief Runs the flip animation
24485     *
24486     * @param obj The flip object
24487     * @param mode The mode type
24488     *
24489     * Flips the front and back contents using the @p mode animation. This
24490     * efectively hides the currently visible content and shows the hidden one.
24491     *
24492     * There a number of possible animations to use for the flipping:
24493     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24494     * around a horizontal axis in the middle of its height, the other content
24495     * is shown as the other side of the flip.
24496     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24497     * around a vertical axis in the middle of its width, the other content is
24498     * shown as the other side of the flip.
24499     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24500     * around a diagonal axis in the middle of its width, the other content is
24501     * shown as the other side of the flip.
24502     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24503     * around a diagonal axis in the middle of its height, the other content is
24504     * shown as the other side of the flip.
24505     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24506     * as if the flip was a cube, the other content is show as the right face of
24507     * the cube.
24508     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24509     * right as if the flip was a cube, the other content is show as the left
24510     * face of the cube.
24511     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24512     * flip was a cube, the other content is show as the bottom face of the cube.
24513     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24514     * the flip was a cube, the other content is show as the upper face of the
24515     * cube.
24516     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24517     * if the flip was a book, the other content is shown as the page below that.
24518     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24519     * as if the flip was a book, the other content is shown as the page below
24520     * that.
24521     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24522     * flip was a book, the other content is shown as the page below that.
24523     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24524     * flip was a book, the other content is shown as the page below that.
24525     *
24526     * @image html elm_flip.png
24527     * @image latex elm_flip.eps width=\textwidth
24528     */
24529    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24530    /**
24531     * @brief Set the interactive flip mode
24532     *
24533     * @param obj The flip object
24534     * @param mode The interactive flip mode to use
24535     *
24536     * This sets if the flip should be interactive (allow user to click and
24537     * drag a side of the flip to reveal the back page and cause it to flip).
24538     * By default a flip is not interactive. You may also need to set which
24539     * sides of the flip are "active" for flipping and how much space they use
24540     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24541     * and elm_flip_interacton_direction_hitsize_set()
24542     *
24543     * The four avilable mode of interaction are:
24544     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24545     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24546     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24547     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24548     *
24549     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24550     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24551     * happen, those can only be acheived with elm_flip_go();
24552     */
24553    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24554    /**
24555     * @brief Get the interactive flip mode
24556     *
24557     * @param obj The flip object
24558     * @return The interactive flip mode
24559     *
24560     * Returns the interactive flip mode set by elm_flip_interaction_set()
24561     */
24562    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24563    /**
24564     * @brief Set which directions of the flip respond to interactive flip
24565     *
24566     * @param obj The flip object
24567     * @param dir The direction to change
24568     * @param enabled If that direction is enabled or not
24569     *
24570     * By default all directions are disabled, so you may want to enable the
24571     * desired directions for flipping if you need interactive flipping. You must
24572     * call this function once for each direction that should be enabled.
24573     *
24574     * @see elm_flip_interaction_set()
24575     */
24576    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24577    /**
24578     * @brief Get the enabled state of that flip direction
24579     *
24580     * @param obj The flip object
24581     * @param dir The direction to check
24582     * @return If that direction is enabled or not
24583     *
24584     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24585     *
24586     * @see elm_flip_interaction_set()
24587     */
24588    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24589    /**
24590     * @brief Set the amount of the flip that is sensitive to interactive flip
24591     *
24592     * @param obj The flip object
24593     * @param dir The direction to modify
24594     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24595     *
24596     * Set the amount of the flip that is sensitive to interactive flip, with 0
24597     * representing no area in the flip and 1 representing the entire flip. There
24598     * is however a consideration to be made in that the area will never be
24599     * smaller than the finger size set(as set in your Elementary configuration).
24600     *
24601     * @see elm_flip_interaction_set()
24602     */
24603    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24604    /**
24605     * @brief Get the amount of the flip that is sensitive to interactive flip
24606     *
24607     * @param obj The flip object
24608     * @param dir The direction to check
24609     * @return The size set for that direction
24610     *
24611     * Returns the amount os sensitive area set by
24612     * elm_flip_interacton_direction_hitsize_set().
24613     */
24614    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24615    /**
24616     * @}
24617     */
24618
24619    /* scrolledentry */
24620    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24621    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24622    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24623    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24624    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24625    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24626    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24627    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24628    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24629    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24630    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24631    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24632    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24633    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24634    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24635    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24636    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24637    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24638    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24639    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24640    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24641    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24642    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24643    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24644    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24645    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24646    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24647    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24648    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24649    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24650    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24651    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24652    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24653    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24654    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24655    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);
24656    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24657    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24658    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);
24659    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24660    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);
24661    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24662    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24663    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24664    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24665    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24666    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24667    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24668    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24669    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);
24670    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);
24671    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);
24672    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);
24673    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);
24674    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);
24675    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24676    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24677    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24678    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24679    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24680    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24681    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24682
24683    /**
24684     * @defgroup Conformant Conformant
24685     * @ingroup Elementary
24686     *
24687     * @image html img/widget/conformant/preview-00.png
24688     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24689     *
24690     * @image html img/conformant.png
24691     * @image latex img/conformant.eps width=\textwidth
24692     *
24693     * The aim is to provide a widget that can be used in elementary apps to
24694     * account for space taken up by the indicator, virtual keypad & softkey
24695     * windows when running the illume2 module of E17.
24696     *
24697     * So conformant content will be sized and positioned considering the
24698     * space required for such stuff, and when they popup, as a keyboard
24699     * shows when an entry is selected, conformant content won't change.
24700     *
24701     * Available styles for it:
24702     * - @c "default"
24703     *
24704     * Default contents parts of the conformant widget that you can use for are:
24705     * @li "default" - A content of the conformant
24706     *
24707     * See how to use this widget in this example:
24708     * @ref conformant_example
24709     */
24710
24711    /**
24712     * @addtogroup Conformant
24713     * @{
24714     */
24715
24716    /**
24717     * Add a new conformant widget to the given parent Elementary
24718     * (container) object.
24719     *
24720     * @param parent The parent object.
24721     * @return A new conformant widget handle or @c NULL, on errors.
24722     *
24723     * This function inserts a new conformant widget on the canvas.
24724     *
24725     * @ingroup Conformant
24726     */
24727    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24728
24729    /**
24730     * Set the content of the conformant widget.
24731     *
24732     * @param obj The conformant object.
24733     * @param content The content to be displayed by the conformant.
24734     *
24735     * Content will be sized and positioned considering the space required
24736     * to display a virtual keyboard. So it won't fill all the conformant
24737     * size. This way is possible to be sure that content won't resize
24738     * or be re-positioned after the keyboard is displayed.
24739     *
24740     * Once the content object is set, a previously set one will be deleted.
24741     * If you want to keep that old content object, use the
24742     * elm_object_content_unset() function.
24743     *
24744     * @see elm_object_content_unset()
24745     * @see elm_object_content_get()
24746     *
24747     * @deprecated use elm_object_content_set() instead
24748     *
24749     * @ingroup Conformant
24750     */
24751    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24752
24753    /**
24754     * Get the content of the conformant widget.
24755     *
24756     * @param obj The conformant object.
24757     * @return The content that is being used.
24758     *
24759     * Return the content object which is set for this widget.
24760     * It won't be unparent from conformant. For that, use
24761     * elm_object_content_unset().
24762     *
24763     * @see elm_object_content_set().
24764     * @see elm_object_content_unset()
24765     *
24766     * @deprecated use elm_object_content_get() instead
24767     *
24768     * @ingroup Conformant
24769     */
24770    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24771
24772    /**
24773     * Unset the content of the conformant widget.
24774     *
24775     * @param obj The conformant object.
24776     * @return The content that was being used.
24777     *
24778     * Unparent and return the content object which was set for this widget.
24779     *
24780     * @see elm_object_content_set().
24781     *
24782     * @deprecated use elm_object_content_unset() instead
24783     *
24784     * @ingroup Conformant
24785     */
24786    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24787
24788    /**
24789     * Returns the Evas_Object that represents the content area.
24790     *
24791     * @param obj The conformant object.
24792     * @return The content area of the widget.
24793     *
24794     * @ingroup Conformant
24795     */
24796    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24797
24798    /**
24799     * @}
24800     */
24801
24802    /**
24803     * @defgroup Mapbuf Mapbuf
24804     * @ingroup Elementary
24805     *
24806     * @image html img/widget/mapbuf/preview-00.png
24807     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24808     *
24809     * This holds one content object and uses an Evas Map of transformation
24810     * points to be later used with this content. So the content will be
24811     * moved, resized, etc as a single image. So it will improve performance
24812     * when you have a complex interafce, with a lot of elements, and will
24813     * need to resize or move it frequently (the content object and its
24814     * children).
24815     *
24816     * Default contents parts of the mapbuf widget that you can use for are:
24817     * @li "default" - A content of the mapbuf
24818     *
24819     * To enable map, elm_mapbuf_enabled_set() should be used.
24820     * 
24821     * See how to use this widget in this example:
24822     * @ref mapbuf_example
24823     */
24824
24825    /**
24826     * @addtogroup Mapbuf
24827     * @{
24828     */
24829
24830    /**
24831     * Add a new mapbuf widget to the given parent Elementary
24832     * (container) object.
24833     *
24834     * @param parent The parent object.
24835     * @return A new mapbuf widget handle or @c NULL, on errors.
24836     *
24837     * This function inserts a new mapbuf widget on the canvas.
24838     *
24839     * @ingroup Mapbuf
24840     */
24841    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24842
24843    /**
24844     * Set the content of the mapbuf.
24845     *
24846     * @param obj The mapbuf object.
24847     * @param content The content that will be filled in this mapbuf object.
24848     *
24849     * Once the content object is set, a previously set one will be deleted.
24850     * If you want to keep that old content object, use the
24851     * elm_mapbuf_content_unset() function.
24852     *
24853     * To enable map, elm_mapbuf_enabled_set() should be used.
24854     *
24855     * @deprecated use elm_object_content_set() instead
24856     *
24857     * @ingroup Mapbuf
24858     */
24859    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24860
24861    /**
24862     * Get the content of the mapbuf.
24863     *
24864     * @param obj The mapbuf object.
24865     * @return The content that is being used.
24866     *
24867     * Return the content object which is set for this widget.
24868     *
24869     * @see elm_mapbuf_content_set() for details.
24870     *
24871     * @deprecated use elm_object_content_get() instead
24872     *
24873     * @ingroup Mapbuf
24874     */
24875    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24876
24877    /**
24878     * Unset the content of the mapbuf.
24879     *
24880     * @param obj The mapbuf object.
24881     * @return The content that was being used.
24882     *
24883     * Unparent and return the content object which was set for this widget.
24884     *
24885     * @see elm_mapbuf_content_set() for details.
24886     *
24887     * @deprecated use elm_object_content_unset() instead
24888     *
24889     * @ingroup Mapbuf
24890     */
24891    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24892
24893    /**
24894     * Enable or disable the map.
24895     *
24896     * @param obj The mapbuf object.
24897     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24898     *
24899     * This enables the map that is set or disables it. On enable, the object
24900     * geometry will be saved, and the new geometry will change (position and
24901     * size) to reflect the map geometry set.
24902     *
24903     * Also, when enabled, alpha and smooth states will be used, so if the
24904     * content isn't solid, alpha should be enabled, for example, otherwise
24905     * a black retangle will fill the content.
24906     *
24907     * When disabled, the stored map will be freed and geometry prior to
24908     * enabling the map will be restored.
24909     *
24910     * It's disabled by default.
24911     *
24912     * @see elm_mapbuf_alpha_set()
24913     * @see elm_mapbuf_smooth_set()
24914     *
24915     * @ingroup Mapbuf
24916     */
24917    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24918
24919    /**
24920     * Get a value whether map is enabled or not.
24921     *
24922     * @param obj The mapbuf object.
24923     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24924     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24925     *
24926     * @see elm_mapbuf_enabled_set() for details.
24927     *
24928     * @ingroup Mapbuf
24929     */
24930    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24931
24932    /**
24933     * Enable or disable smooth map rendering.
24934     *
24935     * @param obj The mapbuf object.
24936     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24937     * to disable it.
24938     *
24939     * This sets smoothing for map rendering. If the object is a type that has
24940     * its own smoothing settings, then both the smooth settings for this object
24941     * and the map must be turned off.
24942     *
24943     * By default smooth maps are enabled.
24944     *
24945     * @ingroup Mapbuf
24946     */
24947    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24948
24949    /**
24950     * Get a value whether smooth map rendering is enabled or not.
24951     *
24952     * @param obj The mapbuf object.
24953     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24954     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24955     *
24956     * @see elm_mapbuf_smooth_set() for details.
24957     *
24958     * @ingroup Mapbuf
24959     */
24960    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24961
24962    /**
24963     * Set or unset alpha flag for map rendering.
24964     *
24965     * @param obj The mapbuf object.
24966     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24967     * to disable it.
24968     *
24969     * This sets alpha flag for map rendering. If the object is a type that has
24970     * its own alpha settings, then this will take precedence. Only image objects
24971     * have this currently. It stops alpha blending of the map area, and is
24972     * useful if you know the object and/or all sub-objects is 100% solid.
24973     *
24974     * Alpha is enabled by default.
24975     *
24976     * @ingroup Mapbuf
24977     */
24978    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24979
24980    /**
24981     * Get a value whether alpha blending is enabled or not.
24982     *
24983     * @param obj The mapbuf object.
24984     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24985     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24986     *
24987     * @see elm_mapbuf_alpha_set() for details.
24988     *
24989     * @ingroup Mapbuf
24990     */
24991    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24992
24993    /**
24994     * @}
24995     */
24996
24997    /**
24998     * @defgroup Flipselector Flip Selector
24999     *
25000     * @image html img/widget/flipselector/preview-00.png
25001     * @image latex img/widget/flipselector/preview-00.eps
25002     *
25003     * A flip selector is a widget to show a set of @b text items, one
25004     * at a time, with the same sheet switching style as the @ref Clock
25005     * "clock" widget, when one changes the current displaying sheet
25006     * (thus, the "flip" in the name).
25007     *
25008     * User clicks to flip sheets which are @b held for some time will
25009     * make the flip selector to flip continuosly and automatically for
25010     * the user. The interval between flips will keep growing in time,
25011     * so that it helps the user to reach an item which is distant from
25012     * the current selection.
25013     *
25014     * Smart callbacks one can register to:
25015     * - @c "selected" - when the widget's selected text item is changed
25016     * - @c "overflowed" - when the widget's current selection is changed
25017     *   from the first item in its list to the last
25018     * - @c "underflowed" - when the widget's current selection is changed
25019     *   from the last item in its list to the first
25020     *
25021     * Available styles for it:
25022     * - @c "default"
25023     *
25024          * To set/get the label of the flipselector item, you can use
25025          * elm_object_item_text_set/get APIs.
25026          * Once the text is set, a previously set one will be deleted.
25027          * 
25028     * Here is an example on its usage:
25029     * @li @ref flipselector_example
25030     */
25031
25032    /**
25033     * @addtogroup Flipselector
25034     * @{
25035     */
25036
25037    /**
25038     * Add a new flip selector widget to the given parent Elementary
25039     * (container) widget
25040     *
25041     * @param parent The parent object
25042     * @return a new flip selector widget handle or @c NULL, on errors
25043     *
25044     * This function inserts a new flip selector widget on the canvas.
25045     *
25046     * @ingroup Flipselector
25047     */
25048    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25049
25050    /**
25051     * Programmatically select the next item of a flip selector widget
25052     *
25053     * @param obj The flipselector object
25054     *
25055     * @note The selection will be animated. Also, if it reaches the
25056     * end of its list of member items, it will continue with the first
25057     * one onwards.
25058     *
25059     * @ingroup Flipselector
25060     */
25061    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25062
25063    /**
25064     * Programmatically select the previous item of a flip selector
25065     * widget
25066     *
25067     * @param obj The flipselector object
25068     *
25069     * @note The selection will be animated.  Also, if it reaches the
25070     * beginning of its list of member items, it will continue with the
25071     * last one backwards.
25072     *
25073     * @ingroup Flipselector
25074     */
25075    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25076
25077    /**
25078     * Append a (text) item to a flip selector widget
25079     *
25080     * @param obj The flipselector object
25081     * @param label The (text) label of the new item
25082     * @param func Convenience callback function to take place when
25083     * item is selected
25084     * @param data Data passed to @p func, above
25085     * @return A handle to the item added or @c NULL, on errors
25086     *
25087     * The widget's list of labels to show will be appended with the
25088     * given value. If the user wishes so, a callback function pointer
25089     * can be passed, which will get called when this same item is
25090     * selected.
25091     *
25092     * @note The current selection @b won't be modified by appending an
25093     * element to the list.
25094     *
25095     * @note The maximum length of the text label is going to be
25096     * determined <b>by the widget's theme</b>. Strings larger than
25097     * that value are going to be @b truncated.
25098     *
25099     * @ingroup Flipselector
25100     */
25101    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25102
25103    /**
25104     * Prepend a (text) item to a flip selector widget
25105     *
25106     * @param obj The flipselector object
25107     * @param label The (text) label of the new item
25108     * @param func Convenience callback function to take place when
25109     * item is selected
25110     * @param data Data passed to @p func, above
25111     * @return A handle to the item added or @c NULL, on errors
25112     *
25113     * The widget's list of labels to show will be prepended with the
25114     * given value. If the user wishes so, a callback function pointer
25115     * can be passed, which will get called when this same item is
25116     * selected.
25117     *
25118     * @note The current selection @b won't be modified by prepending
25119     * an element to the list.
25120     *
25121     * @note The maximum length of the text label is going to be
25122     * determined <b>by the widget's theme</b>. Strings larger than
25123     * that value are going to be @b truncated.
25124     *
25125     * @ingroup Flipselector
25126     */
25127    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25128
25129    /**
25130     * Get the internal list of items in a given flip selector widget.
25131     *
25132     * @param obj The flipselector object
25133     * @return The list of items (#Elm_Object_Item as data) or
25134     * @c NULL on errors.
25135     *
25136     * This list is @b not to be modified in any way and must not be
25137     * freed. Use the list members with functions like
25138     * elm_object_item_text_set(),
25139     * elm_object_item_text_get(),
25140     * elm_flipselector_item_del(),
25141     * elm_flipselector_item_selected_get(),
25142     * elm_flipselector_item_selected_set().
25143     *
25144     * @warning This list is only valid until @p obj object's internal
25145     * items list is changed. It should be fetched again with another
25146     * call to this function when changes happen.
25147     *
25148     * @ingroup Flipselector
25149     */
25150    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25151
25152    /**
25153     * Get the first item in the given flip selector widget's list of
25154     * items.
25155     *
25156     * @param obj The flipselector object
25157     * @return The first item or @c NULL, if it has no items (and on
25158     * errors)
25159     *
25160     * @see elm_flipselector_item_append()
25161     * @see elm_flipselector_last_item_get()
25162     *
25163     * @ingroup Flipselector
25164     */
25165    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25166
25167    /**
25168     * Get the last item in the given flip selector widget's list of
25169     * items.
25170     *
25171     * @param obj The flipselector object
25172     * @return The last item or @c NULL, if it has no items (and on
25173     * errors)
25174     *
25175     * @see elm_flipselector_item_prepend()
25176     * @see elm_flipselector_first_item_get()
25177     *
25178     * @ingroup Flipselector
25179     */
25180    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25181
25182    /**
25183     * Get the currently selected item in a flip selector widget.
25184     *
25185     * @param obj The flipselector object
25186     * @return The selected item or @c NULL, if the widget has no items
25187     * (and on erros)
25188     *
25189     * @ingroup Flipselector
25190     */
25191    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25192
25193    /**
25194     * Set whether a given flip selector widget's item should be the
25195     * currently selected one.
25196     *
25197     * @param it The flip selector item
25198     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25199     *
25200     * This sets whether @p item is or not the selected (thus, under
25201     * display) one. If @p item is different than one under display,
25202     * the latter will be unselected. If the @p item is set to be
25203     * unselected, on the other hand, the @b first item in the widget's
25204     * internal members list will be the new selected one.
25205     *
25206     * @see elm_flipselector_item_selected_get()
25207     *
25208     * @ingroup Flipselector
25209     */
25210    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25211
25212    /**
25213     * Get whether a given flip selector widget's item is the currently
25214     * selected one.
25215     *
25216     * @param it The flip selector item
25217     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25218     * (or on errors).
25219     *
25220     * @see elm_flipselector_item_selected_set()
25221     *
25222     * @ingroup Flipselector
25223     */
25224    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25225
25226    /**
25227     * Delete a given item from a flip selector widget.
25228     *
25229     * @param it The item to delete
25230     *
25231     * @ingroup Flipselector
25232     */
25233    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25234
25235    /**
25236     * Get the label of a given flip selector widget's item.
25237     *
25238     * @param it The item to get label from
25239     * @return The text label of @p item or @c NULL, on errors
25240     *
25241     * @see elm_object_item_text_set()
25242     *
25243     * @deprecated see elm_object_item_text_get() instead
25244     * @ingroup Flipselector
25245     */
25246    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25247
25248    /**
25249     * Set the label of a given flip selector widget's item.
25250     *
25251     * @param it The item to set label on
25252     * @param label The text label string, in UTF-8 encoding
25253     *
25254     * @see elm_object_item_text_get()
25255     *
25256          * @deprecated see elm_object_item_text_set() instead
25257     * @ingroup Flipselector
25258     */
25259    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25260
25261    /**
25262     * Gets the item before @p item in a flip selector widget's
25263     * internal list of items.
25264     *
25265     * @param it The item to fetch previous from
25266     * @return The item before the @p item, in its parent's list. If
25267     *         there is no previous item for @p item or there's an
25268     *         error, @c NULL is returned.
25269     *
25270     * @see elm_flipselector_item_next_get()
25271     *
25272     * @ingroup Flipselector
25273     */
25274    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25275
25276    /**
25277     * Gets the item after @p item in a flip selector widget's
25278     * internal list of items.
25279     *
25280     * @param it The item to fetch next from
25281     * @return The item after the @p item, in its parent's list. If
25282     *         there is no next item for @p item or there's an
25283     *         error, @c NULL is returned.
25284     *
25285     * @see elm_flipselector_item_next_get()
25286     *
25287     * @ingroup Flipselector
25288     */
25289    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25290
25291    /**
25292     * Set the interval on time updates for an user mouse button hold
25293     * on a flip selector widget.
25294     *
25295     * @param obj The flip selector object
25296     * @param interval The (first) interval value in seconds
25297     *
25298     * This interval value is @b decreased while the user holds the
25299     * mouse pointer either flipping up or flipping doww a given flip
25300     * selector.
25301     *
25302     * This helps the user to get to a given item distant from the
25303     * current one easier/faster, as it will start to flip quicker and
25304     * quicker on mouse button holds.
25305     *
25306     * The calculation for the next flip interval value, starting from
25307     * the one set with this call, is the previous interval divided by
25308     * 1.05, so it decreases a little bit.
25309     *
25310     * The default starting interval value for automatic flips is
25311     * @b 0.85 seconds.
25312     *
25313     * @see elm_flipselector_interval_get()
25314     *
25315     * @ingroup Flipselector
25316     */
25317    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25318
25319    /**
25320     * Get the interval on time updates for an user mouse button hold
25321     * on a flip selector widget.
25322     *
25323     * @param obj The flip selector object
25324     * @return The (first) interval value, in seconds, set on it
25325     *
25326     * @see elm_flipselector_interval_set() for more details
25327     *
25328     * @ingroup Flipselector
25329     */
25330    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25331    /**
25332     * @}
25333     */
25334
25335    /**
25336     * @addtogroup Calendar
25337     * @{
25338     */
25339
25340    /**
25341     * @enum _Elm_Calendar_Mark_Repeat
25342     * @typedef Elm_Calendar_Mark_Repeat
25343     *
25344     * Event periodicity, used to define if a mark should be repeated
25345     * @b beyond event's day. It's set when a mark is added.
25346     *
25347     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25348     * there will be marks every week after this date. Marks will be displayed
25349     * at 13th, 20th, 27th, 3rd June ...
25350     *
25351     * Values don't work as bitmask, only one can be choosen.
25352     *
25353     * @see elm_calendar_mark_add()
25354     *
25355     * @ingroup Calendar
25356     */
25357    typedef enum _Elm_Calendar_Mark_Repeat
25358      {
25359         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25360         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25361         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25362         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*/
25363         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. */
25364      } Elm_Calendar_Mark_Repeat;
25365
25366    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(). */
25367
25368    /**
25369     * Add a new calendar widget to the given parent Elementary
25370     * (container) object.
25371     *
25372     * @param parent The parent object.
25373     * @return a new calendar widget handle or @c NULL, on errors.
25374     *
25375     * This function inserts a new calendar widget on the canvas.
25376     *
25377     * @ref calendar_example_01
25378     *
25379     * @ingroup Calendar
25380     */
25381    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25382
25383    /**
25384     * Get weekdays names displayed by the calendar.
25385     *
25386     * @param obj The calendar object.
25387     * @return Array of seven strings to be used as weekday names.
25388     *
25389     * By default, weekdays abbreviations get from system are displayed:
25390     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25391     * The first string is related to Sunday, the second to Monday...
25392     *
25393     * @see elm_calendar_weekdays_name_set()
25394     *
25395     * @ref calendar_example_05
25396     *
25397     * @ingroup Calendar
25398     */
25399    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25400
25401    /**
25402     * Set weekdays names to be displayed by the calendar.
25403     *
25404     * @param obj The calendar object.
25405     * @param weekdays Array of seven strings to be used as weekday names.
25406     * @warning It must have 7 elements, or it will access invalid memory.
25407     * @warning The strings must be NULL terminated ('@\0').
25408     *
25409     * By default, weekdays abbreviations get from system are displayed:
25410     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25411     *
25412     * The first string should be related to Sunday, the second to Monday...
25413     *
25414     * The usage should be like this:
25415     * @code
25416     *   const char *weekdays[] =
25417     *   {
25418     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25419     *      "Thursday", "Friday", "Saturday"
25420     *   };
25421     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25422     * @endcode
25423     *
25424     * @see elm_calendar_weekdays_name_get()
25425     *
25426     * @ref calendar_example_02
25427     *
25428     * @ingroup Calendar
25429     */
25430    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25431
25432    /**
25433     * Set the minimum and maximum values for the year
25434     *
25435     * @param obj The calendar object
25436     * @param min The minimum year, greater than 1901;
25437     * @param max The maximum year;
25438     *
25439     * Maximum must be greater than minimum, except if you don't wan't to set
25440     * maximum year.
25441     * Default values are 1902 and -1.
25442     *
25443     * If the maximum year is a negative value, it will be limited depending
25444     * on the platform architecture (year 2037 for 32 bits);
25445     *
25446     * @see elm_calendar_min_max_year_get()
25447     *
25448     * @ref calendar_example_03
25449     *
25450     * @ingroup Calendar
25451     */
25452    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25453
25454    /**
25455     * Get the minimum and maximum values for the year
25456     *
25457     * @param obj The calendar object.
25458     * @param min The minimum year.
25459     * @param max The maximum year.
25460     *
25461     * Default values are 1902 and -1.
25462     *
25463     * @see elm_calendar_min_max_year_get() for more details.
25464     *
25465     * @ref calendar_example_05
25466     *
25467     * @ingroup Calendar
25468     */
25469    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25470
25471    /**
25472     * Enable or disable day selection
25473     *
25474     * @param obj The calendar object.
25475     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25476     * disable it.
25477     *
25478     * Enabled by default. If disabled, the user still can select months,
25479     * but not days. Selected days are highlighted on calendar.
25480     * It should be used if you won't need such selection for the widget usage.
25481     *
25482     * When a day is selected, or month is changed, smart callbacks for
25483     * signal "changed" will be called.
25484     *
25485     * @see elm_calendar_day_selection_enable_get()
25486     *
25487     * @ref calendar_example_04
25488     *
25489     * @ingroup Calendar
25490     */
25491    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25492
25493    /**
25494     * Get a value whether day selection is enabled or not.
25495     *
25496     * @see elm_calendar_day_selection_enable_set() for details.
25497     *
25498     * @param obj The calendar object.
25499     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25500     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25501     *
25502     * @ref calendar_example_05
25503     *
25504     * @ingroup Calendar
25505     */
25506    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25507
25508
25509    /**
25510     * Set selected date to be highlighted on calendar.
25511     *
25512     * @param obj The calendar object.
25513     * @param selected_time A @b tm struct to represent the selected date.
25514     *
25515     * Set the selected date, changing the displayed month if needed.
25516     * Selected date changes when the user goes to next/previous month or
25517     * select a day pressing over it on calendar.
25518     *
25519     * @see elm_calendar_selected_time_get()
25520     *
25521     * @ref calendar_example_04
25522     *
25523     * @ingroup Calendar
25524     */
25525    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25526
25527    /**
25528     * Get selected date.
25529     *
25530     * @param obj The calendar object
25531     * @param selected_time A @b tm struct to point to selected date
25532     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25533     * be considered.
25534     *
25535     * Get date selected by the user or set by function
25536     * elm_calendar_selected_time_set().
25537     * Selected date changes when the user goes to next/previous month or
25538     * select a day pressing over it on calendar.
25539     *
25540     * @see elm_calendar_selected_time_get()
25541     *
25542     * @ref calendar_example_05
25543     *
25544     * @ingroup Calendar
25545     */
25546    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25547
25548    /**
25549     * Set a function to format the string that will be used to display
25550     * month and year;
25551     *
25552     * @param obj The calendar object
25553     * @param format_function Function to set the month-year string given
25554     * the selected date
25555     *
25556     * By default it uses strftime with "%B %Y" format string.
25557     * It should allocate the memory that will be used by the string,
25558     * that will be freed by the widget after usage.
25559     * A pointer to the string and a pointer to the time struct will be provided.
25560     *
25561     * Example:
25562     * @code
25563     * static char *
25564     * _format_month_year(struct tm *selected_time)
25565     * {
25566     *    char buf[32];
25567     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25568     *    return strdup(buf);
25569     * }
25570     *
25571     * elm_calendar_format_function_set(calendar, _format_month_year);
25572     * @endcode
25573     *
25574     * @ref calendar_example_02
25575     *
25576     * @ingroup Calendar
25577     */
25578    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25579
25580    /**
25581     * Add a new mark to the calendar
25582     *
25583     * @param obj The calendar object
25584     * @param mark_type A string used to define the type of mark. It will be
25585     * emitted to the theme, that should display a related modification on these
25586     * days representation.
25587     * @param mark_time A time struct to represent the date of inclusion of the
25588     * mark. For marks that repeats it will just be displayed after the inclusion
25589     * date in the calendar.
25590     * @param repeat Repeat the event following this periodicity. Can be a unique
25591     * mark (that don't repeat), daily, weekly, monthly or annually.
25592     * @return The created mark or @p NULL upon failure.
25593     *
25594     * Add a mark that will be drawn in the calendar respecting the insertion
25595     * time and periodicity. It will emit the type as signal to the widget theme.
25596     * Default theme supports "holiday" and "checked", but it can be extended.
25597     *
25598     * It won't immediately update the calendar, drawing the marks.
25599     * For this, call elm_calendar_marks_draw(). However, when user selects
25600     * next or previous month calendar forces marks drawn.
25601     *
25602     * Marks created with this method can be deleted with
25603     * elm_calendar_mark_del().
25604     *
25605     * Example
25606     * @code
25607     * struct tm selected_time;
25608     * time_t current_time;
25609     *
25610     * current_time = time(NULL) + 5 * 84600;
25611     * localtime_r(&current_time, &selected_time);
25612     * elm_calendar_mark_add(cal, "holiday", selected_time,
25613     *     ELM_CALENDAR_ANNUALLY);
25614     *
25615     * current_time = time(NULL) + 1 * 84600;
25616     * localtime_r(&current_time, &selected_time);
25617     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25618     *
25619     * elm_calendar_marks_draw(cal);
25620     * @endcode
25621     *
25622     * @see elm_calendar_marks_draw()
25623     * @see elm_calendar_mark_del()
25624     *
25625     * @ref calendar_example_06
25626     *
25627     * @ingroup Calendar
25628     */
25629    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);
25630
25631    /**
25632     * Delete mark from the calendar.
25633     *
25634     * @param mark The mark to be deleted.
25635     *
25636     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25637     * should be used instead of getting marks list and deleting each one.
25638     *
25639     * @see elm_calendar_mark_add()
25640     *
25641     * @ref calendar_example_06
25642     *
25643     * @ingroup Calendar
25644     */
25645    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25646
25647    /**
25648     * Remove all calendar's marks
25649     *
25650     * @param obj The calendar object.
25651     *
25652     * @see elm_calendar_mark_add()
25653     * @see elm_calendar_mark_del()
25654     *
25655     * @ingroup Calendar
25656     */
25657    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25658
25659
25660    /**
25661     * Get a list of all the calendar marks.
25662     *
25663     * @param obj The calendar object.
25664     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25665     *
25666     * @see elm_calendar_mark_add()
25667     * @see elm_calendar_mark_del()
25668     * @see elm_calendar_marks_clear()
25669     *
25670     * @ingroup Calendar
25671     */
25672    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25673
25674    /**
25675     * Draw calendar marks.
25676     *
25677     * @param obj The calendar object.
25678     *
25679     * Should be used after adding, removing or clearing marks.
25680     * It will go through the entire marks list updating the calendar.
25681     * If lots of marks will be added, add all the marks and then call
25682     * this function.
25683     *
25684     * When the month is changed, i.e. user selects next or previous month,
25685     * marks will be drawed.
25686     *
25687     * @see elm_calendar_mark_add()
25688     * @see elm_calendar_mark_del()
25689     * @see elm_calendar_marks_clear()
25690     *
25691     * @ref calendar_example_06
25692     *
25693     * @ingroup Calendar
25694     */
25695    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25696
25697    /**
25698     * Set a day text color to the same that represents Saturdays.
25699     *
25700     * @param obj The calendar object.
25701     * @param pos The text position. Position is the cell counter, from left
25702     * to right, up to down. It starts on 0 and ends on 41.
25703     *
25704     * @deprecated use elm_calendar_mark_add() instead like:
25705     *
25706     * @code
25707     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25708     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25709     * @endcode
25710     *
25711     * @see elm_calendar_mark_add()
25712     *
25713     * @ingroup Calendar
25714     */
25715    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25716
25717    /**
25718     * Set a day text color to the same that represents Sundays.
25719     *
25720     * @param obj The calendar object.
25721     * @param pos The text position. Position is the cell counter, from left
25722     * to right, up to down. It starts on 0 and ends on 41.
25723
25724     * @deprecated use elm_calendar_mark_add() instead like:
25725     *
25726     * @code
25727     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25728     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25729     * @endcode
25730     *
25731     * @see elm_calendar_mark_add()
25732     *
25733     * @ingroup Calendar
25734     */
25735    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25736
25737    /**
25738     * Set a day text color to the same that represents Weekdays.
25739     *
25740     * @param obj The calendar object
25741     * @param pos The text position. Position is the cell counter, from left
25742     * to right, up to down. It starts on 0 and ends on 41.
25743     *
25744     * @deprecated use elm_calendar_mark_add() instead like:
25745     *
25746     * @code
25747     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25748     *
25749     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25750     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25751     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25752     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25753     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25754     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25755     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25756     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25757     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25758     * @endcode
25759     *
25760     * @see elm_calendar_mark_add()
25761     *
25762     * @ingroup Calendar
25763     */
25764    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25765
25766    /**
25767     * Set the interval on time updates for an user mouse button hold
25768     * on calendar widgets' month selection.
25769     *
25770     * @param obj The calendar object
25771     * @param interval The (first) interval value in seconds
25772     *
25773     * This interval value is @b decreased while the user holds the
25774     * mouse pointer either selecting next or previous month.
25775     *
25776     * This helps the user to get to a given month distant from the
25777     * current one easier/faster, as it will start to change quicker and
25778     * quicker on mouse button holds.
25779     *
25780     * The calculation for the next change interval value, starting from
25781     * the one set with this call, is the previous interval divided by
25782     * 1.05, so it decreases a little bit.
25783     *
25784     * The default starting interval value for automatic changes is
25785     * @b 0.85 seconds.
25786     *
25787     * @see elm_calendar_interval_get()
25788     *
25789     * @ingroup Calendar
25790     */
25791    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25792
25793    /**
25794     * Get the interval on time updates for an user mouse button hold
25795     * on calendar widgets' month selection.
25796     *
25797     * @param obj The calendar object
25798     * @return The (first) interval value, in seconds, set on it
25799     *
25800     * @see elm_calendar_interval_set() for more details
25801     *
25802     * @ingroup Calendar
25803     */
25804    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25805
25806    /**
25807     * @}
25808     */
25809
25810    /**
25811     * @defgroup Diskselector Diskselector
25812     * @ingroup Elementary
25813     *
25814     * @image html img/widget/diskselector/preview-00.png
25815     * @image latex img/widget/diskselector/preview-00.eps
25816     *
25817     * A diskselector is a kind of list widget. It scrolls horizontally,
25818     * and can contain label and icon objects. Three items are displayed
25819     * with the selected one in the middle.
25820     *
25821     * It can act like a circular list with round mode and labels can be
25822     * reduced for a defined length for side items.
25823     *
25824     * Smart callbacks one can listen to:
25825     * - "selected" - when item is selected, i.e. scroller stops.
25826     *
25827     * Available styles for it:
25828     * - @c "default"
25829     *
25830     * List of examples:
25831     * @li @ref diskselector_example_01
25832     * @li @ref diskselector_example_02
25833     */
25834
25835    /**
25836     * @addtogroup Diskselector
25837     * @{
25838     */
25839
25840    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(). */
25841
25842    /**
25843     * Add a new diskselector widget to the given parent Elementary
25844     * (container) object.
25845     *
25846     * @param parent The parent object.
25847     * @return a new diskselector widget handle or @c NULL, on errors.
25848     *
25849     * This function inserts a new diskselector widget on the canvas.
25850     *
25851     * @ingroup Diskselector
25852     */
25853    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25854
25855    /**
25856     * Enable or disable round mode.
25857     *
25858     * @param obj The diskselector object.
25859     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25860     * disable it.
25861     *
25862     * Disabled by default. If round mode is enabled the items list will
25863     * work like a circle list, so when the user reaches the last item,
25864     * the first one will popup.
25865     *
25866     * @see elm_diskselector_round_get()
25867     *
25868     * @ingroup Diskselector
25869     */
25870    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25871
25872    /**
25873     * Get a value whether round mode is enabled or not.
25874     *
25875     * @see elm_diskselector_round_set() for details.
25876     *
25877     * @param obj The diskselector object.
25878     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25879     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25880     *
25881     * @ingroup Diskselector
25882     */
25883    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25884
25885    /**
25886     * Get the side labels max length.
25887     *
25888     * @deprecated use elm_diskselector_side_label_length_get() instead:
25889     *
25890     * @param obj The diskselector object.
25891     * @return The max length defined for side labels, or 0 if not a valid
25892     * diskselector.
25893     *
25894     * @ingroup Diskselector
25895     */
25896    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25897
25898    /**
25899     * Set the side labels max length.
25900     *
25901     * @deprecated use elm_diskselector_side_label_length_set() instead:
25902     *
25903     * @param obj The diskselector object.
25904     * @param len The max length defined for side labels.
25905     *
25906     * @ingroup Diskselector
25907     */
25908    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25909
25910    /**
25911     * Get the side labels max length.
25912     *
25913     * @see elm_diskselector_side_label_length_set() for details.
25914     *
25915     * @param obj The diskselector object.
25916     * @return The max length defined for side labels, or 0 if not a valid
25917     * diskselector.
25918     *
25919     * @ingroup Diskselector
25920     */
25921    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25922
25923    /**
25924     * Set the side labels max length.
25925     *
25926     * @param obj The diskselector object.
25927     * @param len The max length defined for side labels.
25928     *
25929     * Length is the number of characters of items' label that will be
25930     * visible when it's set on side positions. It will just crop
25931     * the string after defined size. E.g.:
25932     *
25933     * An item with label "January" would be displayed on side position as
25934     * "Jan" if max length is set to 3, or "Janu", if this property
25935     * is set to 4.
25936     *
25937     * When it's selected, the entire label will be displayed, except for
25938     * width restrictions. In this case label will be cropped and "..."
25939     * will be concatenated.
25940     *
25941     * Default side label max length is 3.
25942     *
25943     * This property will be applyed over all items, included before or
25944     * later this function call.
25945     *
25946     * @ingroup Diskselector
25947     */
25948    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25949
25950    /**
25951     * Set the number of items to be displayed.
25952     *
25953     * @param obj The diskselector object.
25954     * @param num The number of items the diskselector will display.
25955     *
25956     * Default value is 3, and also it's the minimun. If @p num is less
25957     * than 3, it will be set to 3.
25958     *
25959     * Also, it can be set on theme, using data item @c display_item_num
25960     * on group "elm/diskselector/item/X", where X is style set.
25961     * E.g.:
25962     *
25963     * group { name: "elm/diskselector/item/X";
25964     * data {
25965     *     item: "display_item_num" "5";
25966     *     }
25967     *
25968     * @ingroup Diskselector
25969     */
25970    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25971
25972    /**
25973     * Get the number of items in the diskselector object.
25974     *
25975     * @param obj The diskselector object.
25976     *
25977     * @ingroup Diskselector
25978     */
25979    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25980
25981    /**
25982     * Set bouncing behaviour when the scrolled content reaches an edge.
25983     *
25984     * Tell the internal scroller object whether it should bounce or not
25985     * when it reaches the respective edges for each axis.
25986     *
25987     * @param obj The diskselector object.
25988     * @param h_bounce Whether to bounce or not in the horizontal axis.
25989     * @param v_bounce Whether to bounce or not in the vertical axis.
25990     *
25991     * @see elm_scroller_bounce_set()
25992     *
25993     * @ingroup Diskselector
25994     */
25995    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25996
25997    /**
25998     * Get the bouncing behaviour of the internal scroller.
25999     *
26000     * Get whether the internal scroller should bounce when the edge of each
26001     * axis is reached scrolling.
26002     *
26003     * @param obj The diskselector object.
26004     * @param h_bounce Pointer where to store the bounce state of the horizontal
26005     * axis.
26006     * @param v_bounce Pointer where to store the bounce state of the vertical
26007     * axis.
26008     *
26009     * @see elm_scroller_bounce_get()
26010     * @see elm_diskselector_bounce_set()
26011     *
26012     * @ingroup Diskselector
26013     */
26014    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26015
26016    /**
26017     * Get the scrollbar policy.
26018     *
26019     * @see elm_diskselector_scroller_policy_get() for details.
26020     *
26021     * @param obj The diskselector object.
26022     * @param policy_h Pointer where to store horizontal scrollbar policy.
26023     * @param policy_v Pointer where to store vertical scrollbar policy.
26024     *
26025     * @ingroup Diskselector
26026     */
26027    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);
26028
26029    /**
26030     * Set the scrollbar policy.
26031     *
26032     * @param obj The diskselector object.
26033     * @param policy_h Horizontal scrollbar policy.
26034     * @param policy_v Vertical scrollbar policy.
26035     *
26036     * This sets the scrollbar visibility policy for the given scroller.
26037     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26038     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26039     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26040     * This applies respectively for the horizontal and vertical scrollbars.
26041     *
26042     * The both are disabled by default, i.e., are set to
26043     * #ELM_SCROLLER_POLICY_OFF.
26044     *
26045     * @ingroup Diskselector
26046     */
26047    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26048
26049    /**
26050     * Remove all diskselector's items.
26051     *
26052     * @param obj The diskselector object.
26053     *
26054     * @see elm_diskselector_item_del()
26055     * @see elm_diskselector_item_append()
26056     *
26057     * @ingroup Diskselector
26058     */
26059    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26060
26061    /**
26062     * Get a list of all the diskselector items.
26063     *
26064     * @param obj The diskselector object.
26065     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26066     * or @c NULL on failure.
26067     *
26068     * @see elm_diskselector_item_append()
26069     * @see elm_diskselector_item_del()
26070     * @see elm_diskselector_clear()
26071     *
26072     * @ingroup Diskselector
26073     */
26074    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26075
26076    /**
26077     * Appends a new item to the diskselector object.
26078     *
26079     * @param obj The diskselector object.
26080     * @param label The label of the diskselector item.
26081     * @param icon The icon object to use at left side of the item. An
26082     * icon can be any Evas object, but usually it is an icon created
26083     * with elm_icon_add().
26084     * @param func The function to call when the item is selected.
26085     * @param data The data to associate with the item for related callbacks.
26086     *
26087     * @return The created item or @c NULL upon failure.
26088     *
26089     * A new item will be created and appended to the diskselector, i.e., will
26090     * be set as last item. Also, if there is no selected item, it will
26091     * be selected. This will always happens for the first appended item.
26092     *
26093     * If no icon is set, label will be centered on item position, otherwise
26094     * the icon will be placed at left of the label, that will be shifted
26095     * to the right.
26096     *
26097     * Items created with this method can be deleted with
26098     * elm_diskselector_item_del().
26099     *
26100     * Associated @p data can be properly freed when item is deleted if a
26101     * callback function is set with elm_diskselector_item_del_cb_set().
26102     *
26103     * If a function is passed as argument, it will be called everytime this item
26104     * is selected, i.e., the user stops the diskselector with this
26105     * item on center position. If such function isn't needed, just passing
26106     * @c NULL as @p func is enough. The same should be done for @p data.
26107     *
26108     * Simple example (with no function callback or data associated):
26109     * @code
26110     * disk = elm_diskselector_add(win);
26111     * ic = elm_icon_add(win);
26112     * elm_icon_file_set(ic, "path/to/image", NULL);
26113     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26114     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26115     * @endcode
26116     *
26117     * @see elm_diskselector_item_del()
26118     * @see elm_diskselector_item_del_cb_set()
26119     * @see elm_diskselector_clear()
26120     * @see elm_icon_add()
26121     *
26122     * @ingroup Diskselector
26123     */
26124    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);
26125
26126
26127    /**
26128     * Delete them item from the diskselector.
26129     *
26130     * @param it The item of diskselector to be deleted.
26131     *
26132     * If deleting all diskselector items is required, elm_diskselector_clear()
26133     * should be used instead of getting items list and deleting each one.
26134     *
26135     * @see elm_diskselector_clear()
26136     * @see elm_diskselector_item_append()
26137     * @see elm_diskselector_item_del_cb_set()
26138     *
26139     * @ingroup Diskselector
26140     */
26141    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26142
26143    /**
26144     * Set the function called when a diskselector item is freed.
26145     *
26146     * @param it The item to set the callback on
26147     * @param func The function called
26148     *
26149     * If there is a @p func, then it will be called prior item's memory release.
26150     * That will be called with the following arguments:
26151     * @li item's data;
26152     * @li item's Evas object;
26153     * @li item itself;
26154     *
26155     * This way, a data associated to a diskselector item could be properly
26156     * freed.
26157     *
26158     * @ingroup Diskselector
26159     */
26160    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26161
26162    /**
26163     * Get the data associated to the item.
26164     *
26165     * @param it The diskselector item
26166     * @return The data associated to @p it
26167     *
26168     * The return value is a pointer to data associated to @p item when it was
26169     * created, with function elm_diskselector_item_append(). If no data
26170     * was passed as argument, it will return @c NULL.
26171     *
26172     * @see elm_diskselector_item_append()
26173     *
26174     * @ingroup Diskselector
26175     */
26176    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26177
26178    /**
26179     * Set the icon associated to the item.
26180     *
26181     * @param it The diskselector item
26182     * @param icon The icon object to associate with @p it
26183     *
26184     * The icon object to use at left side of the item. An
26185     * icon can be any Evas object, but usually it is an icon created
26186     * with elm_icon_add().
26187     *
26188     * Once the icon object is set, a previously set one will be deleted.
26189     * @warning Setting the same icon for two items will cause the icon to
26190     * dissapear from the first item.
26191     *
26192     * If an icon was passed as argument on item creation, with function
26193     * elm_diskselector_item_append(), it will be already
26194     * associated to the item.
26195     *
26196     * @see elm_diskselector_item_append()
26197     * @see elm_diskselector_item_icon_get()
26198     *
26199     * @ingroup Diskselector
26200     */
26201    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26202
26203    /**
26204     * Get the icon associated to the item.
26205     *
26206     * @param it The diskselector item
26207     * @return The icon associated to @p it
26208     *
26209     * The return value is a pointer to the icon associated to @p item when it was
26210     * created, with function elm_diskselector_item_append(), or later
26211     * with function elm_diskselector_item_icon_set. If no icon
26212     * was passed as argument, it will return @c NULL.
26213     *
26214     * @see elm_diskselector_item_append()
26215     * @see elm_diskselector_item_icon_set()
26216     *
26217     * @ingroup Diskselector
26218     */
26219    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26220
26221    /**
26222     * Set the label of item.
26223     *
26224     * @param it The item of diskselector.
26225     * @param label The label of item.
26226     *
26227     * The label to be displayed by the item.
26228     *
26229     * If no icon is set, label will be centered on item position, otherwise
26230     * the icon will be placed at left of the label, that will be shifted
26231     * to the right.
26232     *
26233     * An item with label "January" would be displayed on side position as
26234     * "Jan" if max length is set to 3 with function
26235     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26236     * is set to 4.
26237     *
26238     * When this @p item is selected, the entire label will be displayed,
26239     * except for width restrictions.
26240     * In this case label will be cropped and "..." will be concatenated,
26241     * but only for display purposes. It will keep the entire string, so
26242     * if diskselector is resized the remaining characters will be displayed.
26243     *
26244     * If a label was passed as argument on item creation, with function
26245     * elm_diskselector_item_append(), it will be already
26246     * displayed by the item.
26247     *
26248     * @see elm_diskselector_side_label_lenght_set()
26249     * @see elm_diskselector_item_label_get()
26250     * @see elm_diskselector_item_append()
26251     *
26252     * @ingroup Diskselector
26253     */
26254    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26255
26256    /**
26257     * Get the label of item.
26258     *
26259     * @param it The item of diskselector.
26260     * @return The label of item.
26261     *
26262     * The return value is a pointer to the label associated to @p item when it was
26263     * created, with function elm_diskselector_item_append(), or later
26264     * with function elm_diskselector_item_label_set. If no label
26265     * was passed as argument, it will return @c NULL.
26266     *
26267     * @see elm_diskselector_item_label_set() for more details.
26268     * @see elm_diskselector_item_append()
26269     *
26270     * @ingroup Diskselector
26271     */
26272    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26273
26274    /**
26275     * Get the selected item.
26276     *
26277     * @param obj The diskselector object.
26278     * @return The selected diskselector item.
26279     *
26280     * The selected item can be unselected with function
26281     * elm_diskselector_item_selected_set(), and the first item of
26282     * diskselector will be selected.
26283     *
26284     * The selected item always will be centered on diskselector, with
26285     * full label displayed, i.e., max lenght set to side labels won't
26286     * apply on the selected item. More details on
26287     * elm_diskselector_side_label_length_set().
26288     *
26289     * @ingroup Diskselector
26290     */
26291    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26292
26293    /**
26294     * Set the selected state of an item.
26295     *
26296     * @param it The diskselector item
26297     * @param selected The selected state
26298     *
26299     * This sets the selected state of the given item @p it.
26300     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26301     *
26302     * If a new item is selected the previosly selected will be unselected.
26303     * Previoulsy selected item can be get with function
26304     * elm_diskselector_selected_item_get().
26305     *
26306     * If the item @p it is unselected, the first item of diskselector will
26307     * be selected.
26308     *
26309     * Selected items will be visible on center position of diskselector.
26310     * So if it was on another position before selected, or was invisible,
26311     * diskselector will animate items until the selected item reaches center
26312     * position.
26313     *
26314     * @see elm_diskselector_item_selected_get()
26315     * @see elm_diskselector_selected_item_get()
26316     *
26317     * @ingroup Diskselector
26318     */
26319    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26320
26321    /*
26322     * Get whether the @p item is selected or not.
26323     *
26324     * @param it The diskselector item.
26325     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26326     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26327     *
26328     * @see elm_diskselector_selected_item_set() for details.
26329     * @see elm_diskselector_item_selected_get()
26330     *
26331     * @ingroup Diskselector
26332     */
26333    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26334
26335    /**
26336     * Get the first item of the diskselector.
26337     *
26338     * @param obj The diskselector object.
26339     * @return The first item, or @c NULL if none.
26340     *
26341     * The list of items follows append order. So it will return the first
26342     * item appended to the widget that wasn't deleted.
26343     *
26344     * @see elm_diskselector_item_append()
26345     * @see elm_diskselector_items_get()
26346     *
26347     * @ingroup Diskselector
26348     */
26349    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26350
26351    /**
26352     * Get the last item of the diskselector.
26353     *
26354     * @param obj The diskselector object.
26355     * @return The last item, or @c NULL if none.
26356     *
26357     * The list of items follows append order. So it will return last first
26358     * item appended to the widget that wasn't deleted.
26359     *
26360     * @see elm_diskselector_item_append()
26361     * @see elm_diskselector_items_get()
26362     *
26363     * @ingroup Diskselector
26364     */
26365    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26366
26367    /**
26368     * Get the item before @p item in diskselector.
26369     *
26370     * @param it The diskselector item.
26371     * @return The item before @p item, or @c NULL if none or on failure.
26372     *
26373     * The list of items follows append order. So it will return item appended
26374     * just before @p item and that wasn't deleted.
26375     *
26376     * If it is the first item, @c NULL will be returned.
26377     * First item can be get by elm_diskselector_first_item_get().
26378     *
26379     * @see elm_diskselector_item_append()
26380     * @see elm_diskselector_items_get()
26381     *
26382     * @ingroup Diskselector
26383     */
26384    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26385
26386    /**
26387     * Get the item after @p item in diskselector.
26388     *
26389     * @param it The diskselector item.
26390     * @return The item after @p item, or @c NULL if none or on failure.
26391     *
26392     * The list of items follows append order. So it will return item appended
26393     * just after @p item and that wasn't deleted.
26394     *
26395     * If it is the last item, @c NULL will be returned.
26396     * Last item can be get by elm_diskselector_last_item_get().
26397     *
26398     * @see elm_diskselector_item_append()
26399     * @see elm_diskselector_items_get()
26400     *
26401     * @ingroup Diskselector
26402     */
26403    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26404
26405    /**
26406     * Set the text to be shown in the diskselector item.
26407     *
26408     * @param item Target item
26409     * @param text The text to set in the content
26410     *
26411     * Setup the text as tooltip to object. The item can have only one tooltip,
26412     * so any previous tooltip data is removed.
26413     *
26414     * @see elm_object_tooltip_text_set() for more details.
26415     *
26416     * @ingroup Diskselector
26417     */
26418    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26419
26420    /**
26421     * Set the content to be shown in the tooltip item.
26422     *
26423     * Setup the tooltip to item. The item can have only one tooltip,
26424     * so any previous tooltip data is removed. @p func(with @p data) will
26425     * be called every time that need show the tooltip and it should
26426     * return a valid Evas_Object. This object is then managed fully by
26427     * tooltip system and is deleted when the tooltip is gone.
26428     *
26429     * @param item the diskselector item being attached a tooltip.
26430     * @param func the function used to create the tooltip contents.
26431     * @param data what to provide to @a func as callback data/context.
26432     * @param del_cb called when data is not needed anymore, either when
26433     *        another callback replaces @p func, the tooltip is unset with
26434     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26435     *        dies. This callback receives as the first parameter the
26436     *        given @a data, and @c event_info is the item.
26437     *
26438     * @see elm_object_tooltip_content_cb_set() for more details.
26439     *
26440     * @ingroup Diskselector
26441     */
26442    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);
26443
26444    /**
26445     * Unset tooltip from item.
26446     *
26447     * @param item diskselector item to remove previously set tooltip.
26448     *
26449     * Remove tooltip from item. The callback provided as del_cb to
26450     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26451     * it is not used anymore.
26452     *
26453     * @see elm_object_tooltip_unset() for more details.
26454     * @see elm_diskselector_item_tooltip_content_cb_set()
26455     *
26456     * @ingroup Diskselector
26457     */
26458    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26459
26460
26461    /**
26462     * Sets a different style for this item tooltip.
26463     *
26464     * @note before you set a style you should define a tooltip with
26465     *       elm_diskselector_item_tooltip_content_cb_set() or
26466     *       elm_diskselector_item_tooltip_text_set()
26467     *
26468     * @param item diskselector item with tooltip already set.
26469     * @param style the theme style to use (default, transparent, ...)
26470     *
26471     * @see elm_object_tooltip_style_set() for more details.
26472     *
26473     * @ingroup Diskselector
26474     */
26475    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26476
26477    /**
26478     * Get the style for this item tooltip.
26479     *
26480     * @param item diskselector item with tooltip already set.
26481     * @return style the theme style in use, defaults to "default". If the
26482     *         object does not have a tooltip set, then NULL is returned.
26483     *
26484     * @see elm_object_tooltip_style_get() for more details.
26485     * @see elm_diskselector_item_tooltip_style_set()
26486     *
26487     * @ingroup Diskselector
26488     */
26489    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26490
26491    /**
26492     * Set the cursor to be shown when mouse is over the diskselector item
26493     *
26494     * @param item Target item
26495     * @param cursor the cursor name to be used.
26496     *
26497     * @see elm_object_cursor_set() for more details.
26498     *
26499     * @ingroup Diskselector
26500     */
26501    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26502
26503    /**
26504     * Get the cursor to be shown when mouse is over the diskselector item
26505     *
26506     * @param item diskselector item with cursor already set.
26507     * @return the cursor name.
26508     *
26509     * @see elm_object_cursor_get() for more details.
26510     * @see elm_diskselector_cursor_set()
26511     *
26512     * @ingroup Diskselector
26513     */
26514    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26515
26516
26517    /**
26518     * Unset the cursor to be shown when mouse is over the diskselector item
26519     *
26520     * @param item Target item
26521     *
26522     * @see elm_object_cursor_unset() for more details.
26523     * @see elm_diskselector_cursor_set()
26524     *
26525     * @ingroup Diskselector
26526     */
26527    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26528
26529    /**
26530     * Sets a different style for this item cursor.
26531     *
26532     * @note before you set a style you should define a cursor with
26533     *       elm_diskselector_item_cursor_set()
26534     *
26535     * @param item diskselector item with cursor already set.
26536     * @param style the theme style to use (default, transparent, ...)
26537     *
26538     * @see elm_object_cursor_style_set() for more details.
26539     *
26540     * @ingroup Diskselector
26541     */
26542    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26543
26544
26545    /**
26546     * Get the style for this item cursor.
26547     *
26548     * @param item diskselector item with cursor already set.
26549     * @return style the theme style in use, defaults to "default". If the
26550     *         object does not have a cursor set, then @c NULL is returned.
26551     *
26552     * @see elm_object_cursor_style_get() for more details.
26553     * @see elm_diskselector_item_cursor_style_set()
26554     *
26555     * @ingroup Diskselector
26556     */
26557    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26558
26559
26560    /**
26561     * Set if the cursor set should be searched on the theme or should use
26562     * the provided by the engine, only.
26563     *
26564     * @note before you set if should look on theme you should define a cursor
26565     * with elm_diskselector_item_cursor_set().
26566     * By default it will only look for cursors provided by the engine.
26567     *
26568     * @param item widget item with cursor already set.
26569     * @param engine_only boolean to define if cursors set with
26570     * elm_diskselector_item_cursor_set() should be searched only
26571     * between cursors provided by the engine or searched on widget's
26572     * theme as well.
26573     *
26574     * @see elm_object_cursor_engine_only_set() for more details.
26575     *
26576     * @ingroup Diskselector
26577     */
26578    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26579
26580    /**
26581     * Get the cursor engine only usage for this item cursor.
26582     *
26583     * @param item widget item with cursor already set.
26584     * @return engine_only boolean to define it cursors should be looked only
26585     * between the provided by the engine or searched on widget's theme as well.
26586     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26587     *
26588     * @see elm_object_cursor_engine_only_get() for more details.
26589     * @see elm_diskselector_item_cursor_engine_only_set()
26590     *
26591     * @ingroup Diskselector
26592     */
26593    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26594
26595    /**
26596     * @}
26597     */
26598
26599    /**
26600     * @defgroup Colorselector Colorselector
26601     *
26602     * @{
26603     *
26604     * @image html img/widget/colorselector/preview-00.png
26605     * @image latex img/widget/colorselector/preview-00.eps
26606     *
26607     * @brief Widget for user to select a color.
26608     *
26609     * Signals that you can add callbacks for are:
26610     * "changed" - When the color value changes(event_info is NULL).
26611     *
26612     * See @ref tutorial_colorselector.
26613     */
26614    /**
26615     * @brief Add a new colorselector to the parent
26616     *
26617     * @param parent The parent object
26618     * @return The new object or NULL if it cannot be created
26619     *
26620     * @ingroup Colorselector
26621     */
26622    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26623    /**
26624     * Set a color for the colorselector
26625     *
26626     * @param obj   Colorselector object
26627     * @param r     r-value of color
26628     * @param g     g-value of color
26629     * @param b     b-value of color
26630     * @param a     a-value of color
26631     *
26632     * @ingroup Colorselector
26633     */
26634    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26635    /**
26636     * Get a color from the colorselector
26637     *
26638     * @param obj   Colorselector object
26639     * @param r     integer pointer for r-value of color
26640     * @param g     integer pointer for g-value of color
26641     * @param b     integer pointer for b-value of color
26642     * @param a     integer pointer for a-value of color
26643     *
26644     * @ingroup Colorselector
26645     */
26646    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26647    /**
26648     * @}
26649     */
26650
26651    /**
26652     * @defgroup Ctxpopup Ctxpopup
26653     *
26654     * @image html img/widget/ctxpopup/preview-00.png
26655     * @image latex img/widget/ctxpopup/preview-00.eps
26656     *
26657     * @brief Context popup widet.
26658     *
26659     * A ctxpopup is a widget that, when shown, pops up a list of items.
26660     * It automatically chooses an area inside its parent object's view
26661     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26662     * optimally fit into it. In the default theme, it will also point an
26663     * arrow to it's top left position at the time one shows it. Ctxpopup
26664     * items have a label and/or an icon. It is intended for a small
26665     * number of items (hence the use of list, not genlist).
26666     *
26667     * @note Ctxpopup is a especialization of @ref Hover.
26668     *
26669     * Signals that you can add callbacks for are:
26670     * "dismissed" - the ctxpopup was dismissed
26671     *
26672     * Default contents parts of the ctxpopup widget that you can use for are:
26673     * @li "default" - A content of the ctxpopup
26674     *
26675     * Default contents parts of the naviframe items that you can use for are:
26676     * @li "icon" - A icon in the title area
26677     * 
26678     * Default text parts of the naviframe items that you can use for are:
26679     * @li "default" - Title label in the title area
26680     *
26681     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26682     * @{
26683     */
26684    typedef enum _Elm_Ctxpopup_Direction
26685      {
26686         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26687                                           area */
26688         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26689                                            the clicked area */
26690         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26691                                           the clicked area */
26692         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26693                                         area */
26694         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26695      } Elm_Ctxpopup_Direction;
26696
26697    /**
26698     * @brief Add a new Ctxpopup object to the parent.
26699     *
26700     * @param parent Parent object
26701     * @return New object or @c NULL, if it cannot be created
26702     */
26703    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26704    /**
26705     * @brief Set the Ctxpopup's parent
26706     *
26707     * @param obj The ctxpopup object
26708     * @param area The parent to use
26709     *
26710     * Set the parent object.
26711     *
26712     * @note elm_ctxpopup_add() will automatically call this function
26713     * with its @c parent argument.
26714     *
26715     * @see elm_ctxpopup_add()
26716     * @see elm_hover_parent_set()
26717     */
26718    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26719    /**
26720     * @brief Get the Ctxpopup's parent
26721     *
26722     * @param obj The ctxpopup object
26723     *
26724     * @see elm_ctxpopup_hover_parent_set() for more information
26725     */
26726    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26727    /**
26728     * @brief Clear all items in the given ctxpopup object.
26729     *
26730     * @param obj Ctxpopup object
26731     */
26732    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26733    /**
26734     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26735     *
26736     * @param obj Ctxpopup object
26737     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26738     */
26739    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26740    /**
26741     * @brief Get the value of current ctxpopup object's orientation.
26742     *
26743     * @param obj Ctxpopup object
26744     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26745     *
26746     * @see elm_ctxpopup_horizontal_set()
26747     */
26748    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26749    /**
26750     * @brief Add a new item to a ctxpopup object.
26751     *
26752     * @param obj Ctxpopup object
26753     * @param icon Icon to be set on new item
26754     * @param label The Label of the new item
26755     * @param func Convenience function called when item selected
26756     * @param data Data passed to @p func
26757     * @return A handle to the item added or @c NULL, on errors
26758     *
26759     * @warning Ctxpopup can't hold both an item list and a content at the same
26760     * time. When an item is added, any previous content will be removed.
26761     *
26762     * @see elm_ctxpopup_content_set()
26763     */
26764    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);
26765    /**
26766     * @brief Delete the given item in a ctxpopup object.
26767     *
26768     * @param it Ctxpopup item to be deleted
26769     *
26770     * @see elm_ctxpopup_item_append()
26771     */
26772    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26773    /**
26774     * @brief Set the ctxpopup item's state as disabled or enabled.
26775     *
26776     * @param it Ctxpopup item to be enabled/disabled
26777     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26778     *
26779     * When disabled the item is greyed out to indicate it's state.
26780     * @deprecated use elm_object_item_disabled_set() instead
26781     */
26782    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26783    /**
26784     * @brief Get the ctxpopup item's disabled/enabled state.
26785     *
26786     * @param it Ctxpopup item to be enabled/disabled
26787     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26788     *
26789     * @see elm_ctxpopup_item_disabled_set()
26790     * @deprecated use elm_object_item_disabled_get() instead
26791     */
26792    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26793    /**
26794     * @brief Get the icon object for the given ctxpopup item.
26795     *
26796     * @param it Ctxpopup item
26797     * @return icon object or @c NULL, if the item does not have icon or an error
26798     * occurred
26799     *
26800     * @see elm_ctxpopup_item_append()
26801     * @see elm_ctxpopup_item_icon_set()
26802     *
26803     * @deprecated use elm_object_item_part_content_get() instead
26804     */
26805    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26806    /**
26807     * @brief Sets the side icon associated with the ctxpopup item
26808     *
26809     * @param it Ctxpopup item
26810     * @param icon Icon object to be set
26811     *
26812     * Once the icon object is set, a previously set one will be deleted.
26813     * @warning Setting the same icon for two items will cause the icon to
26814     * dissapear from the first item.
26815     *
26816     * @see elm_ctxpopup_item_append()
26817     *  
26818     * @deprecated use elm_object_item_part_content_set() instead
26819     *
26820     */
26821    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26822    /**
26823     * @brief Get the label for the given ctxpopup item.
26824     *
26825     * @param it Ctxpopup item
26826     * @return label string or @c NULL, if the item does not have label or an
26827     * error occured
26828     *
26829     * @see elm_ctxpopup_item_append()
26830     * @see elm_ctxpopup_item_label_set()
26831     *
26832     * @deprecated use elm_object_item_text_get() instead
26833     */
26834    EINA_DEPRECATED EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26835    /**
26836     * @brief (Re)set the label on the given ctxpopup item.
26837     *
26838     * @param it Ctxpopup item
26839     * @param label String to set as label
26840     *
26841     * @deprecated use elm_object_item_text_set() instead
26842     */
26843    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26844    /**
26845     * @brief Set an elm widget as the content of the ctxpopup.
26846     *
26847     * @param obj Ctxpopup object
26848     * @param content Content to be swallowed
26849     *
26850     * If the content object is already set, a previous one will bedeleted. If
26851     * you want to keep that old content object, use the
26852     * elm_ctxpopup_content_unset() function.
26853     *
26854     * @warning Ctxpopup can't hold both a item list and a content at the same
26855     * time. When a content is set, any previous items will be removed.
26856     * 
26857     * @deprecated use elm_object_content_set() instead
26858     *
26859     */
26860    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26861    /**
26862     * @brief Unset the ctxpopup content
26863     *
26864     * @param obj Ctxpopup object
26865     * @return The content that was being used
26866     *
26867     * Unparent and return the content object which was set for this widget.
26868     *
26869     * @deprecated use elm_object_content_unset()
26870     *
26871     * @see elm_ctxpopup_content_set()
26872     *
26873     * @deprecated use elm_object_content_unset() instead
26874     *
26875     */
26876    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26877    /**
26878     * @brief Set the direction priority of a ctxpopup.
26879     *
26880     * @param obj Ctxpopup object
26881     * @param first 1st priority of direction
26882     * @param second 2nd priority of direction
26883     * @param third 3th priority of direction
26884     * @param fourth 4th priority of direction
26885     *
26886     * This functions gives a chance to user to set the priority of ctxpopup
26887     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26888     * requested direction.
26889     *
26890     * @see Elm_Ctxpopup_Direction
26891     */
26892    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);
26893    /**
26894     * @brief Get the direction priority of a ctxpopup.
26895     *
26896     * @param obj Ctxpopup object
26897     * @param first 1st priority of direction to be returned
26898     * @param second 2nd priority of direction to be returned
26899     * @param third 3th priority of direction to be returned
26900     * @param fourth 4th priority of direction to be returned
26901     *
26902     * @see elm_ctxpopup_direction_priority_set() for more information.
26903     */
26904    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);
26905
26906    /**
26907     * @brief Get the current direction of a ctxpopup.
26908     *
26909     * @param obj Ctxpopup object
26910     * @return current direction of a ctxpopup
26911     *
26912     * @warning Once the ctxpopup showed up, the direction would be determined
26913     */
26914    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26915
26916    /**
26917     * @}
26918     */
26919
26920    /* transit */
26921    /**
26922     *
26923     * @defgroup Transit Transit
26924     * @ingroup Elementary
26925     *
26926     * Transit is designed to apply various animated transition effects to @c
26927     * Evas_Object, such like translation, rotation, etc. For using these
26928     * effects, create an @ref Elm_Transit and add the desired transition effects.
26929     *
26930     * Once the effects are added into transit, they will be automatically
26931     * managed (their callback will be called until the duration is ended, and
26932     * they will be deleted on completion).
26933     *
26934     * Example:
26935     * @code
26936     * Elm_Transit *trans = elm_transit_add();
26937     * elm_transit_object_add(trans, obj);
26938     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26939     * elm_transit_duration_set(transit, 1);
26940     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26941     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26942     * elm_transit_repeat_times_set(transit, 3);
26943     * @endcode
26944     *
26945     * Some transition effects are used to change the properties of objects. They
26946     * are:
26947     * @li @ref elm_transit_effect_translation_add
26948     * @li @ref elm_transit_effect_color_add
26949     * @li @ref elm_transit_effect_rotation_add
26950     * @li @ref elm_transit_effect_wipe_add
26951     * @li @ref elm_transit_effect_zoom_add
26952     * @li @ref elm_transit_effect_resizing_add
26953     *
26954     * Other transition effects are used to make one object disappear and another
26955     * object appear on its old place. These effects are:
26956     *
26957     * @li @ref elm_transit_effect_flip_add
26958     * @li @ref elm_transit_effect_resizable_flip_add
26959     * @li @ref elm_transit_effect_fade_add
26960     * @li @ref elm_transit_effect_blend_add
26961     *
26962     * It's also possible to make a transition chain with @ref
26963     * elm_transit_chain_transit_add.
26964     *
26965     * @warning We strongly recommend to use elm_transit just when edje can not do
26966     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26967     * animations can be manipulated inside the theme.
26968     *
26969     * List of examples:
26970     * @li @ref transit_example_01_explained
26971     * @li @ref transit_example_02_explained
26972     * @li @ref transit_example_03_c
26973     * @li @ref transit_example_04_c
26974     *
26975     * @{
26976     */
26977
26978    /**
26979     * @enum Elm_Transit_Tween_Mode
26980     *
26981     * The type of acceleration used in the transition.
26982     */
26983    typedef enum
26984      {
26985         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26986         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26987                                              over time, then decrease again
26988                                              and stop slowly */
26989         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26990                                              speed over time */
26991         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26992                                             over time */
26993      } Elm_Transit_Tween_Mode;
26994
26995    /**
26996     * @enum Elm_Transit_Effect_Flip_Axis
26997     *
26998     * The axis where flip effect should be applied.
26999     */
27000    typedef enum
27001      {
27002         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27003         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27004      } Elm_Transit_Effect_Flip_Axis;
27005    /**
27006     * @enum Elm_Transit_Effect_Wipe_Dir
27007     *
27008     * The direction where the wipe effect should occur.
27009     */
27010    typedef enum
27011      {
27012         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27013         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27014         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27015         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27016      } Elm_Transit_Effect_Wipe_Dir;
27017    /** @enum Elm_Transit_Effect_Wipe_Type
27018     *
27019     * Whether the wipe effect should show or hide the object.
27020     */
27021    typedef enum
27022      {
27023         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27024                                              animation */
27025         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27026                                             animation */
27027      } Elm_Transit_Effect_Wipe_Type;
27028
27029    /**
27030     * @typedef Elm_Transit
27031     *
27032     * The Transit created with elm_transit_add(). This type has the information
27033     * about the objects which the transition will be applied, and the
27034     * transition effects that will be used. It also contains info about
27035     * duration, number of repetitions, auto-reverse, etc.
27036     */
27037    typedef struct _Elm_Transit Elm_Transit;
27038    typedef void Elm_Transit_Effect;
27039    /**
27040     * @typedef Elm_Transit_Effect_Transition_Cb
27041     *
27042     * Transition callback called for this effect on each transition iteration.
27043     */
27044    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27045    /**
27046     * Elm_Transit_Effect_End_Cb
27047     *
27048     * Transition callback called for this effect when the transition is over.
27049     */
27050    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27051
27052    /**
27053     * Elm_Transit_Del_Cb
27054     *
27055     * A callback called when the transit is deleted.
27056     */
27057    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27058
27059    /**
27060     * Add new transit.
27061     *
27062     * @note Is not necessary to delete the transit object, it will be deleted at
27063     * the end of its operation.
27064     * @note The transit will start playing when the program enter in the main loop, is not
27065     * necessary to give a start to the transit.
27066     *
27067     * @return The transit object.
27068     *
27069     * @ingroup Transit
27070     */
27071    EAPI Elm_Transit                *elm_transit_add(void);
27072
27073    /**
27074     * Stops the animation and delete the @p transit object.
27075     *
27076     * Call this function if you wants to stop the animation before the duration
27077     * time. Make sure the @p transit object is still alive with
27078     * elm_transit_del_cb_set() function.
27079     * All added effects will be deleted, calling its repective data_free_cb
27080     * functions. The function setted by elm_transit_del_cb_set() will be called.
27081     *
27082     * @see elm_transit_del_cb_set()
27083     *
27084     * @param transit The transit object to be deleted.
27085     *
27086     * @ingroup Transit
27087     * @warning Just call this function if you are sure the transit is alive.
27088     */
27089    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27090
27091    /**
27092     * Add a new effect to the transit.
27093     *
27094     * @note The cb function and the data are the key to the effect. If you try to
27095     * add an already added effect, nothing is done.
27096     * @note After the first addition of an effect in @p transit, if its
27097     * effect list become empty again, the @p transit will be killed by
27098     * elm_transit_del(transit) function.
27099     *
27100     * Exemple:
27101     * @code
27102     * Elm_Transit *transit = elm_transit_add();
27103     * elm_transit_effect_add(transit,
27104     *                        elm_transit_effect_blend_op,
27105     *                        elm_transit_effect_blend_context_new(),
27106     *                        elm_transit_effect_blend_context_free);
27107     * @endcode
27108     *
27109     * @param transit The transit object.
27110     * @param transition_cb The operation function. It is called when the
27111     * animation begins, it is the function that actually performs the animation.
27112     * It is called with the @p data, @p transit and the time progression of the
27113     * animation (a double value between 0.0 and 1.0).
27114     * @param effect The context data of the effect.
27115     * @param end_cb The function to free the context data, it will be called
27116     * at the end of the effect, it must finalize the animation and free the
27117     * @p data.
27118     *
27119     * @ingroup Transit
27120     * @warning The transit free the context data at the and of the transition with
27121     * the data_free_cb function, do not use the context data in another transit.
27122     */
27123    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);
27124
27125    /**
27126     * Delete an added effect.
27127     *
27128     * This function will remove the effect from the @p transit, calling the
27129     * data_free_cb to free the @p data.
27130     *
27131     * @see elm_transit_effect_add()
27132     *
27133     * @note If the effect is not found, nothing is done.
27134     * @note If the effect list become empty, this function will call
27135     * elm_transit_del(transit), that is, it will kill the @p transit.
27136     *
27137     * @param transit The transit object.
27138     * @param transition_cb The operation function.
27139     * @param effect The context data of the effect.
27140     *
27141     * @ingroup Transit
27142     */
27143    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);
27144
27145    /**
27146     * Add new object to apply the effects.
27147     *
27148     * @note After the first addition of an object in @p transit, if its
27149     * object list become empty again, the @p transit will be killed by
27150     * elm_transit_del(transit) function.
27151     * @note If the @p obj belongs to another transit, the @p obj will be
27152     * removed from it and it will only belong to the @p transit. If the old
27153     * transit stays without objects, it will die.
27154     * @note When you add an object into the @p transit, its state from
27155     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27156     * transit ends, if you change this state whith evas_object_pass_events_set()
27157     * after add the object, this state will change again when @p transit stops to
27158     * run.
27159     *
27160     * @param transit The transit object.
27161     * @param obj Object to be animated.
27162     *
27163     * @ingroup Transit
27164     * @warning It is not allowed to add a new object after transit begins to go.
27165     */
27166    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27167
27168    /**
27169     * Removes an added object from the transit.
27170     *
27171     * @note If the @p obj is not in the @p transit, nothing is done.
27172     * @note If the list become empty, this function will call
27173     * elm_transit_del(transit), that is, it will kill the @p transit.
27174     *
27175     * @param transit The transit object.
27176     * @param obj Object to be removed from @p transit.
27177     *
27178     * @ingroup Transit
27179     * @warning It is not allowed to remove objects after transit begins to go.
27180     */
27181    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27182
27183    /**
27184     * Get the objects of the transit.
27185     *
27186     * @param transit The transit object.
27187     * @return a Eina_List with the objects from the transit.
27188     *
27189     * @ingroup Transit
27190     */
27191    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27192
27193    /**
27194     * Enable/disable keeping up the objects states.
27195     * If it is not kept, the objects states will be reset when transition ends.
27196     *
27197     * @note @p transit can not be NULL.
27198     * @note One state includes geometry, color, map data.
27199     *
27200     * @param transit The transit object.
27201     * @param state_keep Keeping or Non Keeping.
27202     *
27203     * @ingroup Transit
27204     */
27205    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27206
27207    /**
27208     * Get a value whether the objects states will be reset or not.
27209     *
27210     * @note @p transit can not be NULL
27211     *
27212     * @see elm_transit_objects_final_state_keep_set()
27213     *
27214     * @param transit The transit object.
27215     * @return EINA_TRUE means the states of the objects will be reset.
27216     * If @p transit is NULL, EINA_FALSE is returned
27217     *
27218     * @ingroup Transit
27219     */
27220    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27221
27222    /**
27223     * Set the event enabled when transit is operating.
27224     *
27225     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27226     * events from mouse and keyboard during the animation.
27227     * @note When you add an object with elm_transit_object_add(), its state from
27228     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27229     * transit ends, if you change this state with evas_object_pass_events_set()
27230     * after adding the object, this state will change again when @p transit stops
27231     * to run.
27232     *
27233     * @param transit The transit object.
27234     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27235     * ignored otherwise.
27236     *
27237     * @ingroup Transit
27238     */
27239    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27240
27241    /**
27242     * Get the value of event enabled status.
27243     *
27244     * @see elm_transit_event_enabled_set()
27245     *
27246     * @param transit The Transit object
27247     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27248     * EINA_FALSE is returned
27249     *
27250     * @ingroup Transit
27251     */
27252    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27253
27254    /**
27255     * Set the user-callback function when the transit is deleted.
27256     *
27257     * @note Using this function twice will overwrite the first function setted.
27258     * @note the @p transit object will be deleted after call @p cb function.
27259     *
27260     * @param transit The transit object.
27261     * @param cb Callback function pointer. This function will be called before
27262     * the deletion of the transit.
27263     * @param data Callback funtion user data. It is the @p op parameter.
27264     *
27265     * @ingroup Transit
27266     */
27267    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27268
27269    /**
27270     * Set reverse effect automatically.
27271     *
27272     * If auto reverse is setted, after running the effects with the progress
27273     * parameter from 0 to 1, it will call the effecs again with the progress
27274     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27275     * where the duration was setted with the function elm_transit_add and
27276     * the repeat with the function elm_transit_repeat_times_set().
27277     *
27278     * @param transit The transit object.
27279     * @param reverse EINA_TRUE means the auto_reverse is on.
27280     *
27281     * @ingroup Transit
27282     */
27283    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27284
27285    /**
27286     * Get if the auto reverse is on.
27287     *
27288     * @see elm_transit_auto_reverse_set()
27289     *
27290     * @param transit The transit object.
27291     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27292     * EINA_FALSE is returned
27293     *
27294     * @ingroup Transit
27295     */
27296    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27297
27298    /**
27299     * Set the transit repeat count. Effect will be repeated by repeat count.
27300     *
27301     * This function sets the number of repetition the transit will run after
27302     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27303     * If the @p repeat is a negative number, it will repeat infinite times.
27304     *
27305     * @note If this function is called during the transit execution, the transit
27306     * will run @p repeat times, ignoring the times it already performed.
27307     *
27308     * @param transit The transit object
27309     * @param repeat Repeat count
27310     *
27311     * @ingroup Transit
27312     */
27313    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27314
27315    /**
27316     * Get the transit repeat count.
27317     *
27318     * @see elm_transit_repeat_times_set()
27319     *
27320     * @param transit The Transit object.
27321     * @return The repeat count. If @p transit is NULL
27322     * 0 is returned
27323     *
27324     * @ingroup Transit
27325     */
27326    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27327
27328    /**
27329     * Set the transit animation acceleration type.
27330     *
27331     * This function sets the tween mode of the transit that can be:
27332     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27333     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27334     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27335     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27336     *
27337     * @param transit The transit object.
27338     * @param tween_mode The tween type.
27339     *
27340     * @ingroup Transit
27341     */
27342    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27343
27344    /**
27345     * Get the transit animation acceleration type.
27346     *
27347     * @note @p transit can not be NULL
27348     *
27349     * @param transit The transit object.
27350     * @return The tween type. If @p transit is NULL
27351     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27352     *
27353     * @ingroup Transit
27354     */
27355    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27356
27357    /**
27358     * Set the transit animation time
27359     *
27360     * @note @p transit can not be NULL
27361     *
27362     * @param transit The transit object.
27363     * @param duration The animation time.
27364     *
27365     * @ingroup Transit
27366     */
27367    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27368
27369    /**
27370     * Get the transit animation time
27371     *
27372     * @note @p transit can not be NULL
27373     *
27374     * @param transit The transit object.
27375     *
27376     * @return The transit animation time.
27377     *
27378     * @ingroup Transit
27379     */
27380    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27381
27382    /**
27383     * Starts the transition.
27384     * Once this API is called, the transit begins to measure the time.
27385     *
27386     * @note @p transit can not be NULL
27387     *
27388     * @param transit The transit object.
27389     *
27390     * @ingroup Transit
27391     */
27392    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27393
27394    /**
27395     * Pause/Resume the transition.
27396     *
27397     * If you call elm_transit_go again, the transit will be started from the
27398     * beginning, and will be unpaused.
27399     *
27400     * @note @p transit can not be NULL
27401     *
27402     * @param transit The transit object.
27403     * @param paused Whether the transition should be paused or not.
27404     *
27405     * @ingroup Transit
27406     */
27407    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27408
27409    /**
27410     * Get the value of paused status.
27411     *
27412     * @see elm_transit_paused_set()
27413     *
27414     * @note @p transit can not be NULL
27415     *
27416     * @param transit The transit object.
27417     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27418     * EINA_FALSE is returned
27419     *
27420     * @ingroup Transit
27421     */
27422    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27423
27424    /**
27425     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27426     *
27427     * The value returned is a fraction (current time / total time). It
27428     * represents the progression position relative to the total.
27429     *
27430     * @note @p transit can not be NULL
27431     *
27432     * @param transit The transit object.
27433     *
27434     * @return The time progression value. If @p transit is NULL
27435     * 0 is returned
27436     *
27437     * @ingroup Transit
27438     */
27439    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27440
27441    /**
27442     * Makes the chain relationship between two transits.
27443     *
27444     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27445     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27446     *
27447     * @param transit The transit object.
27448     * @param chain_transit The chain transit object. This transit will be operated
27449     *        after transit is done.
27450     *
27451     * This function adds @p chain_transit transition to a chain after the @p
27452     * transit, and will be started as soon as @p transit ends. See @ref
27453     * transit_example_02_explained for a full example.
27454     *
27455     * @ingroup Transit
27456     */
27457    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27458
27459    /**
27460     * Cut off the chain relationship between two transits.
27461     *
27462     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27463     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27464     *
27465     * @param transit The transit object.
27466     * @param chain_transit The chain transit object.
27467     *
27468     * This function remove the @p chain_transit transition from the @p transit.
27469     *
27470     * @ingroup Transit
27471     */
27472    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27473
27474    /**
27475     * Get the current chain transit list.
27476     *
27477     * @note @p transit can not be NULL.
27478     *
27479     * @param transit The transit object.
27480     * @return chain transit list.
27481     *
27482     * @ingroup Transit
27483     */
27484    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27485
27486    /**
27487     * Add the Resizing Effect to Elm_Transit.
27488     *
27489     * @note This API is one of the facades. It creates resizing effect context
27490     * and add it's required APIs to elm_transit_effect_add.
27491     *
27492     * @see elm_transit_effect_add()
27493     *
27494     * @param transit Transit object.
27495     * @param from_w Object width size when effect begins.
27496     * @param from_h Object height size when effect begins.
27497     * @param to_w Object width size when effect ends.
27498     * @param to_h Object height size when effect ends.
27499     * @return Resizing effect context data.
27500     *
27501     * @ingroup Transit
27502     */
27503    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);
27504
27505    /**
27506     * Add the Translation Effect to Elm_Transit.
27507     *
27508     * @note This API is one of the facades. It creates translation effect context
27509     * and add it's required APIs to elm_transit_effect_add.
27510     *
27511     * @see elm_transit_effect_add()
27512     *
27513     * @param transit Transit object.
27514     * @param from_dx X Position variation when effect begins.
27515     * @param from_dy Y Position variation when effect begins.
27516     * @param to_dx X Position variation when effect ends.
27517     * @param to_dy Y Position variation when effect ends.
27518     * @return Translation effect context data.
27519     *
27520     * @ingroup Transit
27521     * @warning It is highly recommended just create a transit with this effect when
27522     * the window that the objects of the transit belongs has already been created.
27523     * This is because this effect needs the geometry information about the objects,
27524     * and if the window was not created yet, it can get a wrong information.
27525     */
27526    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);
27527
27528    /**
27529     * Add the Zoom Effect to Elm_Transit.
27530     *
27531     * @note This API is one of the facades. It creates zoom effect context
27532     * and add it's required APIs to elm_transit_effect_add.
27533     *
27534     * @see elm_transit_effect_add()
27535     *
27536     * @param transit Transit object.
27537     * @param from_rate Scale rate when effect begins (1 is current rate).
27538     * @param to_rate Scale rate when effect ends.
27539     * @return Zoom effect context data.
27540     *
27541     * @ingroup Transit
27542     * @warning It is highly recommended just create a transit with this effect when
27543     * the window that the objects of the transit belongs has already been created.
27544     * This is because this effect needs the geometry information about the objects,
27545     * and if the window was not created yet, it can get a wrong information.
27546     */
27547    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27548
27549    /**
27550     * Add the Flip Effect to Elm_Transit.
27551     *
27552     * @note This API is one of the facades. It creates flip effect context
27553     * and add it's required APIs to elm_transit_effect_add.
27554     * @note This effect is applied to each pair of objects in the order they are listed
27555     * in the transit list of objects. The first object in the pair will be the
27556     * "front" object and the second will be the "back" object.
27557     *
27558     * @see elm_transit_effect_add()
27559     *
27560     * @param transit Transit object.
27561     * @param axis Flipping Axis(X or Y).
27562     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27563     * @return Flip effect context data.
27564     *
27565     * @ingroup Transit
27566     * @warning It is highly recommended just create a transit with this effect when
27567     * the window that the objects of the transit belongs has already been created.
27568     * This is because this effect needs the geometry information about the objects,
27569     * and if the window was not created yet, it can get a wrong information.
27570     */
27571    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27572
27573    /**
27574     * Add the Resizable Flip Effect to Elm_Transit.
27575     *
27576     * @note This API is one of the facades. It creates resizable flip effect context
27577     * and add it's required APIs to elm_transit_effect_add.
27578     * @note This effect is applied to each pair of objects in the order they are listed
27579     * in the transit list of objects. The first object in the pair will be the
27580     * "front" object and the second will be the "back" object.
27581     *
27582     * @see elm_transit_effect_add()
27583     *
27584     * @param transit Transit object.
27585     * @param axis Flipping Axis(X or Y).
27586     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27587     * @return Resizable flip effect context data.
27588     *
27589     * @ingroup Transit
27590     * @warning It is highly recommended just create a transit with this effect when
27591     * the window that the objects of the transit belongs has already been created.
27592     * This is because this effect needs the geometry information about the objects,
27593     * and if the window was not created yet, it can get a wrong information.
27594     */
27595    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27596
27597    /**
27598     * Add the Wipe Effect to Elm_Transit.
27599     *
27600     * @note This API is one of the facades. It creates wipe effect context
27601     * and add it's required APIs to elm_transit_effect_add.
27602     *
27603     * @see elm_transit_effect_add()
27604     *
27605     * @param transit Transit object.
27606     * @param type Wipe type. Hide or show.
27607     * @param dir Wipe Direction.
27608     * @return Wipe effect context data.
27609     *
27610     * @ingroup Transit
27611     * @warning It is highly recommended just create a transit with this effect when
27612     * the window that the objects of the transit belongs has already been created.
27613     * This is because this effect needs the geometry information about the objects,
27614     * and if the window was not created yet, it can get a wrong information.
27615     */
27616    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27617
27618    /**
27619     * Add the Color Effect to Elm_Transit.
27620     *
27621     * @note This API is one of the facades. It creates color effect context
27622     * and add it's required APIs to elm_transit_effect_add.
27623     *
27624     * @see elm_transit_effect_add()
27625     *
27626     * @param transit        Transit object.
27627     * @param  from_r        RGB R when effect begins.
27628     * @param  from_g        RGB G when effect begins.
27629     * @param  from_b        RGB B when effect begins.
27630     * @param  from_a        RGB A when effect begins.
27631     * @param  to_r          RGB R when effect ends.
27632     * @param  to_g          RGB G when effect ends.
27633     * @param  to_b          RGB B when effect ends.
27634     * @param  to_a          RGB A when effect ends.
27635     * @return               Color effect context data.
27636     *
27637     * @ingroup Transit
27638     */
27639    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);
27640
27641    /**
27642     * Add the Fade Effect to Elm_Transit.
27643     *
27644     * @note This API is one of the facades. It creates fade effect context
27645     * and add it's required APIs to elm_transit_effect_add.
27646     * @note This effect is applied to each pair of objects in the order they are listed
27647     * in the transit list of objects. The first object in the pair will be the
27648     * "before" object and the second will be the "after" object.
27649     *
27650     * @see elm_transit_effect_add()
27651     *
27652     * @param transit Transit object.
27653     * @return Fade effect context data.
27654     *
27655     * @ingroup Transit
27656     * @warning It is highly recommended just create a transit with this effect when
27657     * the window that the objects of the transit belongs has already been created.
27658     * This is because this effect needs the color information about the objects,
27659     * and if the window was not created yet, it can get a wrong information.
27660     */
27661    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27662
27663    /**
27664     * Add the Blend Effect to Elm_Transit.
27665     *
27666     * @note This API is one of the facades. It creates blend effect context
27667     * and add it's required APIs to elm_transit_effect_add.
27668     * @note This effect is applied to each pair of objects in the order they are listed
27669     * in the transit list of objects. The first object in the pair will be the
27670     * "before" object and the second will be the "after" object.
27671     *
27672     * @see elm_transit_effect_add()
27673     *
27674     * @param transit Transit object.
27675     * @return Blend effect context data.
27676     *
27677     * @ingroup Transit
27678     * @warning It is highly recommended just create a transit with this effect when
27679     * the window that the objects of the transit belongs has already been created.
27680     * This is because this effect needs the color information about the objects,
27681     * and if the window was not created yet, it can get a wrong information.
27682     */
27683    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27684
27685    /**
27686     * Add the Rotation Effect to Elm_Transit.
27687     *
27688     * @note This API is one of the facades. It creates rotation effect context
27689     * and add it's required APIs to elm_transit_effect_add.
27690     *
27691     * @see elm_transit_effect_add()
27692     *
27693     * @param transit Transit object.
27694     * @param from_degree Degree when effect begins.
27695     * @param to_degree Degree when effect is ends.
27696     * @return Rotation effect context data.
27697     *
27698     * @ingroup Transit
27699     * @warning It is highly recommended just create a transit with this effect when
27700     * the window that the objects of the transit belongs has already been created.
27701     * This is because this effect needs the geometry information about the objects,
27702     * and if the window was not created yet, it can get a wrong information.
27703     */
27704    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27705
27706    /**
27707     * Add the ImageAnimation Effect to Elm_Transit.
27708     *
27709     * @note This API is one of the facades. It creates image animation effect context
27710     * and add it's required APIs to elm_transit_effect_add.
27711     * The @p images parameter is a list images paths. This list and
27712     * its contents will be deleted at the end of the effect by
27713     * elm_transit_effect_image_animation_context_free() function.
27714     *
27715     * Example:
27716     * @code
27717     * char buf[PATH_MAX];
27718     * Eina_List *images = NULL;
27719     * Elm_Transit *transi = elm_transit_add();
27720     *
27721     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27722     * images = eina_list_append(images, eina_stringshare_add(buf));
27723     *
27724     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27725     * images = eina_list_append(images, eina_stringshare_add(buf));
27726     * elm_transit_effect_image_animation_add(transi, images);
27727     *
27728     * @endcode
27729     *
27730     * @see elm_transit_effect_add()
27731     *
27732     * @param transit Transit object.
27733     * @param images Eina_List of images file paths. This list and
27734     * its contents will be deleted at the end of the effect by
27735     * elm_transit_effect_image_animation_context_free() function.
27736     * @return Image Animation effect context data.
27737     *
27738     * @ingroup Transit
27739     */
27740    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27741    /**
27742     * @}
27743     */
27744
27745    typedef struct _Elm_Store                      Elm_Store;
27746    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27747    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27748    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27749    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27750    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27751    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27752    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27753    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27754    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27755    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27756
27757    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27758    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27759    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27760    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27761
27762    typedef enum
27763      {
27764         ELM_STORE_ITEM_MAPPING_NONE = 0,
27765         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27766         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27767         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27768         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27769         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27770         // can add more here as needed by common apps
27771         ELM_STORE_ITEM_MAPPING_LAST
27772      } Elm_Store_Item_Mapping_Type;
27773
27774    struct _Elm_Store_Item_Mapping_Icon
27775      {
27776         // FIXME: allow edje file icons
27777         int                   w, h;
27778         Elm_Icon_Lookup_Order lookup_order;
27779         Eina_Bool             standard_name : 1;
27780         Eina_Bool             no_scale : 1;
27781         Eina_Bool             smooth : 1;
27782         Eina_Bool             scale_up : 1;
27783         Eina_Bool             scale_down : 1;
27784      };
27785
27786    struct _Elm_Store_Item_Mapping_Empty
27787      {
27788         Eina_Bool             dummy;
27789      };
27790
27791    struct _Elm_Store_Item_Mapping_Photo
27792      {
27793         int                   size;
27794      };
27795
27796    struct _Elm_Store_Item_Mapping_Custom
27797      {
27798         Elm_Store_Item_Mapping_Cb func;
27799      };
27800
27801    struct _Elm_Store_Item_Mapping
27802      {
27803         Elm_Store_Item_Mapping_Type     type;
27804         const char                     *part;
27805         int                             offset;
27806         union
27807           {
27808              Elm_Store_Item_Mapping_Empty  empty;
27809              Elm_Store_Item_Mapping_Icon   icon;
27810              Elm_Store_Item_Mapping_Photo  photo;
27811              Elm_Store_Item_Mapping_Custom custom;
27812              // add more types here
27813           } details;
27814      };
27815
27816    struct _Elm_Store_Item_Info
27817      {
27818         Elm_Genlist_Item_Class       *item_class;
27819         const Elm_Store_Item_Mapping *mapping;
27820         void                         *data;
27821         char                         *sort_id;
27822      };
27823
27824    struct _Elm_Store_Item_Info_Filesystem
27825      {
27826         Elm_Store_Item_Info  base;
27827         char                *path;
27828      };
27829
27830 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27831 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27832
27833    EAPI void                    elm_store_free(Elm_Store *st);
27834
27835    EAPI Elm_Store              *elm_store_filesystem_new(void);
27836    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27837    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27838    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27839
27840    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27841
27842    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27843    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27844    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27845    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27846    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27847    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27848
27849    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27850    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27851    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27852    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27853    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27854    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27855    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27856
27857    /**
27858     * @defgroup SegmentControl SegmentControl
27859     * @ingroup Elementary
27860     *
27861     * @image html img/widget/segment_control/preview-00.png
27862     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27863     *
27864     * @image html img/segment_control.png
27865     * @image latex img/segment_control.eps width=\textwidth
27866     *
27867     * Segment control widget is a horizontal control made of multiple segment
27868     * items, each segment item functioning similar to discrete two state button.
27869     * A segment control groups the items together and provides compact
27870     * single button with multiple equal size segments.
27871     *
27872     * Segment item size is determined by base widget
27873     * size and the number of items added.
27874     * Only one segment item can be at selected state. A segment item can display
27875     * combination of Text and any Evas_Object like Images or other widget.
27876     *
27877     * Smart callbacks one can listen to:
27878     * - "changed" - When the user clicks on a segment item which is not
27879     *   previously selected and get selected. The event_info parameter is the
27880     *   segment item pointer.
27881     *
27882     * Available styles for it:
27883     * - @c "default"
27884     *
27885     * Here is an example on its usage:
27886     * @li @ref segment_control_example
27887     */
27888
27889    /**
27890     * @addtogroup SegmentControl
27891     * @{
27892     */
27893
27894    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27895
27896    /**
27897     * Add a new segment control widget to the given parent Elementary
27898     * (container) object.
27899     *
27900     * @param parent The parent object.
27901     * @return a new segment control widget handle or @c NULL, on errors.
27902     *
27903     * This function inserts a new segment control widget on the canvas.
27904     *
27905     * @ingroup SegmentControl
27906     */
27907    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27908
27909    /**
27910     * Append a new item to the segment control object.
27911     *
27912     * @param obj The segment control object.
27913     * @param icon The icon object to use for the left side of the item. An
27914     * icon can be any Evas object, but usually it is an icon created
27915     * with elm_icon_add().
27916     * @param label The label of the item.
27917     *        Note that, NULL is different from empty string "".
27918     * @return The created item or @c NULL upon failure.
27919     *
27920     * A new item will be created and appended to the segment control, i.e., will
27921     * be set as @b last item.
27922     *
27923     * If it should be inserted at another position,
27924     * elm_segment_control_item_insert_at() should be used instead.
27925     *
27926     * Items created with this function can be deleted with function
27927     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27928     *
27929     * @note @p label set to @c NULL is different from empty string "".
27930     * If an item
27931     * only has icon, it will be displayed bigger and centered. If it has
27932     * icon and label, even that an empty string, icon will be smaller and
27933     * positioned at left.
27934     *
27935     * Simple example:
27936     * @code
27937     * sc = elm_segment_control_add(win);
27938     * ic = elm_icon_add(win);
27939     * elm_icon_file_set(ic, "path/to/image", NULL);
27940     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27941     * elm_segment_control_item_add(sc, ic, "label");
27942     * evas_object_show(sc);
27943     * @endcode
27944     *
27945     * @see elm_segment_control_item_insert_at()
27946     * @see elm_segment_control_item_del()
27947     *
27948     * @ingroup SegmentControl
27949     */
27950    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27951
27952    /**
27953     * Insert a new item to the segment control object at specified position.
27954     *
27955     * @param obj The segment control object.
27956     * @param icon The icon object to use for the left side of the item. An
27957     * icon can be any Evas object, but usually it is an icon created
27958     * with elm_icon_add().
27959     * @param label The label of the item.
27960     * @param index Item position. Value should be between 0 and items count.
27961     * @return The created item or @c NULL upon failure.
27962
27963     * Index values must be between @c 0, when item will be prepended to
27964     * segment control, and items count, that can be get with
27965     * elm_segment_control_item_count_get(), case when item will be appended
27966     * to segment control, just like elm_segment_control_item_add().
27967     *
27968     * Items created with this function can be deleted with function
27969     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27970     *
27971     * @note @p label set to @c NULL is different from empty string "".
27972     * If an item
27973     * only has icon, it will be displayed bigger and centered. If it has
27974     * icon and label, even that an empty string, icon will be smaller and
27975     * positioned at left.
27976     *
27977     * @see elm_segment_control_item_add()
27978     * @see elm_segment_control_item_count_get()
27979     * @see elm_segment_control_item_del()
27980     *
27981     * @ingroup SegmentControl
27982     */
27983    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);
27984
27985    /**
27986     * Remove a segment control item from its parent, deleting it.
27987     *
27988     * @param it The item to be removed.
27989     *
27990     * Items can be added with elm_segment_control_item_add() or
27991     * elm_segment_control_item_insert_at().
27992     *
27993     * @ingroup SegmentControl
27994     */
27995    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27996
27997    /**
27998     * Remove a segment control item at given index from its parent,
27999     * deleting it.
28000     *
28001     * @param obj The segment control object.
28002     * @param index The position of the segment control item to be deleted.
28003     *
28004     * Items can be added with elm_segment_control_item_add() or
28005     * elm_segment_control_item_insert_at().
28006     *
28007     * @ingroup SegmentControl
28008     */
28009    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28010
28011    /**
28012     * Get the Segment items count from segment control.
28013     *
28014     * @param obj The segment control object.
28015     * @return Segment items count.
28016     *
28017     * It will just return the number of items added to segment control @p obj.
28018     *
28019     * @ingroup SegmentControl
28020     */
28021    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28022
28023    /**
28024     * Get the item placed at specified index.
28025     *
28026     * @param obj The segment control object.
28027     * @param index The index of the segment item.
28028     * @return The segment control item or @c NULL on failure.
28029     *
28030     * Index is the position of an item in segment control widget. Its
28031     * range is from @c 0 to <tt> count - 1 </tt>.
28032     * Count is the number of items, that can be get with
28033     * elm_segment_control_item_count_get().
28034     *
28035     * @ingroup SegmentControl
28036     */
28037    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28038
28039    /**
28040     * Get the label of item.
28041     *
28042     * @param obj The segment control object.
28043     * @param index The index of the segment item.
28044     * @return The label of the item at @p index.
28045     *
28046     * The return value is a pointer to the label associated to the item when
28047     * it was created, with function elm_segment_control_item_add(), or later
28048     * with function elm_segment_control_item_label_set. If no label
28049     * was passed as argument, it will return @c NULL.
28050     *
28051     * @see elm_segment_control_item_label_set() for more details.
28052     * @see elm_segment_control_item_add()
28053     *
28054     * @ingroup SegmentControl
28055     */
28056    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28057
28058    /**
28059     * Set the label of item.
28060     *
28061     * @param it The item of segment control.
28062     * @param text The label of item.
28063     *
28064     * The label to be displayed by the item.
28065     * Label will be at right of the icon (if set).
28066     *
28067     * If a label was passed as argument on item creation, with function
28068     * elm_control_segment_item_add(), it will be already
28069     * displayed by the item.
28070     *
28071     * @see elm_segment_control_item_label_get()
28072     * @see elm_segment_control_item_add()
28073     *
28074     * @ingroup SegmentControl
28075     */
28076    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28077
28078    /**
28079     * Get the icon associated to the item.
28080     *
28081     * @param obj The segment control object.
28082     * @param index The index of the segment item.
28083     * @return The left side icon associated to the item at @p index.
28084     *
28085     * The return value is a pointer to the icon associated to the item when
28086     * it was created, with function elm_segment_control_item_add(), or later
28087     * with function elm_segment_control_item_icon_set(). If no icon
28088     * was passed as argument, it will return @c NULL.
28089     *
28090     * @see elm_segment_control_item_add()
28091     * @see elm_segment_control_item_icon_set()
28092     *
28093     * @ingroup SegmentControl
28094     */
28095    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28096
28097    /**
28098     * Set the icon associated to the item.
28099     *
28100     * @param it The segment control item.
28101     * @param icon The icon object to associate with @p it.
28102     *
28103     * The icon object to use at left side of the item. An
28104     * icon can be any Evas object, but usually it is an icon created
28105     * with elm_icon_add().
28106     *
28107     * Once the icon object is set, a previously set one will be deleted.
28108     * @warning Setting the same icon for two items will cause the icon to
28109     * dissapear from the first item.
28110     *
28111     * If an icon was passed as argument on item creation, with function
28112     * elm_segment_control_item_add(), it will be already
28113     * associated to the item.
28114     *
28115     * @see elm_segment_control_item_add()
28116     * @see elm_segment_control_item_icon_get()
28117     *
28118     * @ingroup SegmentControl
28119     */
28120    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28121
28122    /**
28123     * Get the index of an item.
28124     *
28125     * @param it The segment control item.
28126     * @return The position of item in segment control widget.
28127     *
28128     * Index is the position of an item in segment control widget. Its
28129     * range is from @c 0 to <tt> count - 1 </tt>.
28130     * Count is the number of items, that can be get with
28131     * elm_segment_control_item_count_get().
28132     *
28133     * @ingroup SegmentControl
28134     */
28135    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28136
28137    /**
28138     * Get the base object of the item.
28139     *
28140     * @param it The segment control item.
28141     * @return The base object associated with @p it.
28142     *
28143     * Base object is the @c Evas_Object that represents that item.
28144     *
28145     * @ingroup SegmentControl
28146     */
28147    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28148
28149    /**
28150     * Get the selected item.
28151     *
28152     * @param obj The segment control object.
28153     * @return The selected item or @c NULL if none of segment items is
28154     * selected.
28155     *
28156     * The selected item can be unselected with function
28157     * elm_segment_control_item_selected_set().
28158     *
28159     * The selected item always will be highlighted on segment control.
28160     *
28161     * @ingroup SegmentControl
28162     */
28163    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28164
28165    /**
28166     * Set the selected state of an item.
28167     *
28168     * @param it The segment control item
28169     * @param select The selected state
28170     *
28171     * This sets the selected state of the given item @p it.
28172     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28173     *
28174     * If a new item is selected the previosly selected will be unselected.
28175     * Previoulsy selected item can be get with function
28176     * elm_segment_control_item_selected_get().
28177     *
28178     * The selected item always will be highlighted on segment control.
28179     *
28180     * @see elm_segment_control_item_selected_get()
28181     *
28182     * @ingroup SegmentControl
28183     */
28184    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28185
28186    /**
28187     * @}
28188     */
28189
28190    /**
28191     * @defgroup Grid Grid
28192     *
28193     * The grid is a grid layout widget that lays out a series of children as a
28194     * fixed "grid" of widgets using a given percentage of the grid width and
28195     * height each using the child object.
28196     *
28197     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28198     * widgets size itself. The default is 100 x 100, so that means the
28199     * position and sizes of children will effectively be percentages (0 to 100)
28200     * of the width or height of the grid widget
28201     *
28202     * @{
28203     */
28204
28205    /**
28206     * Add a new grid to the parent
28207     *
28208     * @param parent The parent object
28209     * @return The new object or NULL if it cannot be created
28210     *
28211     * @ingroup Grid
28212     */
28213    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28214
28215    /**
28216     * Set the virtual size of the grid
28217     *
28218     * @param obj The grid object
28219     * @param w The virtual width of the grid
28220     * @param h The virtual height of the grid
28221     *
28222     * @ingroup Grid
28223     */
28224    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28225
28226    /**
28227     * Get the virtual size of the grid
28228     *
28229     * @param obj The grid object
28230     * @param w Pointer to integer to store the virtual width of the grid
28231     * @param h Pointer to integer to store the virtual height of the grid
28232     *
28233     * @ingroup Grid
28234     */
28235    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28236
28237    /**
28238     * Pack child at given position and size
28239     *
28240     * @param obj The grid object
28241     * @param subobj The child to pack
28242     * @param x The virtual x coord at which to pack it
28243     * @param y The virtual y coord at which to pack it
28244     * @param w The virtual width at which to pack it
28245     * @param h The virtual height at which to pack it
28246     *
28247     * @ingroup Grid
28248     */
28249    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28250
28251    /**
28252     * Unpack a child from a grid object
28253     *
28254     * @param obj The grid object
28255     * @param subobj The child to unpack
28256     *
28257     * @ingroup Grid
28258     */
28259    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28260
28261    /**
28262     * Faster way to remove all child objects from a grid object.
28263     *
28264     * @param obj The grid object
28265     * @param clear If true, it will delete just removed children
28266     *
28267     * @ingroup Grid
28268     */
28269    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28270
28271    /**
28272     * Set packing of an existing child at to position and size
28273     *
28274     * @param subobj The child to set packing of
28275     * @param x The virtual x coord at which to pack it
28276     * @param y The virtual y coord at which to pack it
28277     * @param w The virtual width at which to pack it
28278     * @param h The virtual height at which to pack it
28279     *
28280     * @ingroup Grid
28281     */
28282    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28283
28284    /**
28285     * get packing of a child
28286     *
28287     * @param subobj The child to query
28288     * @param x Pointer to integer to store the virtual x coord
28289     * @param y Pointer to integer to store the virtual y coord
28290     * @param w Pointer to integer to store the virtual width
28291     * @param h Pointer to integer to store the virtual height
28292     *
28293     * @ingroup Grid
28294     */
28295    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28296
28297    /**
28298     * @}
28299     */
28300
28301    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28302    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28303    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28304    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28305    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28306    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28307
28308    /**
28309     * @defgroup Video Video
28310     *
28311     * @addtogroup Video
28312     * @{
28313     *
28314     * Elementary comes with two object that help design application that need
28315     * to display video. The main one, Elm_Video, display a video by using Emotion.
28316     * It does embedded the video inside an Edje object, so you can do some
28317     * animation depending on the video state change. It does also implement a
28318     * ressource management policy to remove this burden from the application writer.
28319     *
28320     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28321     * It take care of updating its content according to Emotion event and provide a
28322     * way to theme itself. It also does automatically raise the priority of the
28323     * linked Elm_Video so it will use the video decoder if available. It also does
28324     * activate the remember function on the linked Elm_Video object.
28325     *
28326     * Signals that you can add callback for are :
28327     *
28328     * "forward,clicked" - the user clicked the forward button.
28329     * "info,clicked" - the user clicked the info button.
28330     * "next,clicked" - the user clicked the next button.
28331     * "pause,clicked" - the user clicked the pause button.
28332     * "play,clicked" - the user clicked the play button.
28333     * "prev,clicked" - the user clicked the prev button.
28334     * "rewind,clicked" - the user clicked the rewind button.
28335     * "stop,clicked" - the user clicked the stop button.
28336     * 
28337     * Default contents parts of the player widget that you can use for are:
28338     * @li "video" - A video of the player
28339     * 
28340     */
28341
28342    /**
28343     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28344     *
28345     * @param parent The parent object
28346     * @return a new player widget handle or @c NULL, on errors.
28347     *
28348     * This function inserts a new player widget on the canvas.
28349     *
28350     * @see elm_object_part_content_set()
28351     *
28352     * @ingroup Video
28353     */
28354    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28355
28356    /**
28357     * @brief Link a Elm_Payer with an Elm_Video object.
28358     *
28359     * @param player the Elm_Player object.
28360     * @param video The Elm_Video object.
28361     *
28362     * This mean that action on the player widget will affect the
28363     * video object and the state of the video will be reflected in
28364     * the player itself.
28365     *
28366     * @see elm_player_add()
28367     * @see elm_video_add()
28368     * @deprecated use elm_object_part_content_set() instead
28369     *
28370     * @ingroup Video
28371     */
28372    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28373
28374    /**
28375     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28376     *
28377     * @param parent The parent object
28378     * @return a new video widget handle or @c NULL, on errors.
28379     *
28380     * This function inserts a new video widget on the canvas.
28381     *
28382     * @seeelm_video_file_set()
28383     * @see elm_video_uri_set()
28384     *
28385     * @ingroup Video
28386     */
28387    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28388
28389    /**
28390     * @brief Define the file that will be the video source.
28391     *
28392     * @param video The video object to define the file for.
28393     * @param filename The file to target.
28394     *
28395     * This function will explicitly define a filename as a source
28396     * for the video of the Elm_Video object.
28397     *
28398     * @see elm_video_uri_set()
28399     * @see elm_video_add()
28400     * @see elm_player_add()
28401     *
28402     * @ingroup Video
28403     */
28404    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28405
28406    /**
28407     * @brief Define the uri that will be the video source.
28408     *
28409     * @param video The video object to define the file for.
28410     * @param uri The uri to target.
28411     *
28412     * This function will define an uri as a source for the video of the
28413     * Elm_Video object. URI could be remote source of video, like http:// or local source
28414     * like for example WebCam who are most of the time v4l2:// (but that depend and
28415     * you should use Emotion API to request and list the available Webcam on your system).
28416     *
28417     * @see elm_video_file_set()
28418     * @see elm_video_add()
28419     * @see elm_player_add()
28420     *
28421     * @ingroup Video
28422     */
28423    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28424
28425    /**
28426     * @brief Get the underlying Emotion object.
28427     *
28428     * @param video The video object to proceed the request on.
28429     * @return the underlying Emotion object.
28430     *
28431     * @ingroup Video
28432     */
28433    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28434
28435    /**
28436     * @brief Start to play the video
28437     *
28438     * @param video The video object to proceed the request on.
28439     *
28440     * Start to play the video and cancel all suspend state.
28441     *
28442     * @ingroup Video
28443     */
28444    EAPI void elm_video_play(Evas_Object *video);
28445
28446    /**
28447     * @brief Pause the video
28448     *
28449     * @param video The video object to proceed the request on.
28450     *
28451     * Pause the video and start a timer to trigger suspend mode.
28452     *
28453     * @ingroup Video
28454     */
28455    EAPI void elm_video_pause(Evas_Object *video);
28456
28457    /**
28458     * @brief Stop the video
28459     *
28460     * @param video The video object to proceed the request on.
28461     *
28462     * Stop the video and put the emotion in deep sleep mode.
28463     *
28464     * @ingroup Video
28465     */
28466    EAPI void elm_video_stop(Evas_Object *video);
28467
28468    /**
28469     * @brief Is the video actually playing.
28470     *
28471     * @param video The video object to proceed the request on.
28472     * @return EINA_TRUE if the video is actually playing.
28473     *
28474     * You should consider watching event on the object instead of polling
28475     * the object state.
28476     *
28477     * @ingroup Video
28478     */
28479    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28480
28481    /**
28482     * @brief Is it possible to seek inside the video.
28483     *
28484     * @param video The video object to proceed the request on.
28485     * @return EINA_TRUE if is possible to seek inside the video.
28486     *
28487     * @ingroup Video
28488     */
28489    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28490
28491    /**
28492     * @brief Is the audio muted.
28493     *
28494     * @param video The video object to proceed the request on.
28495     * @return EINA_TRUE if the audio is muted.
28496     *
28497     * @ingroup Video
28498     */
28499    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28500
28501    /**
28502     * @brief Change the mute state of the Elm_Video object.
28503     *
28504     * @param video The video object to proceed the request on.
28505     * @param mute The new mute state.
28506     *
28507     * @ingroup Video
28508     */
28509    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28510
28511    /**
28512     * @brief Get the audio level of the current video.
28513     *
28514     * @param video The video object to proceed the request on.
28515     * @return the current audio level.
28516     *
28517     * @ingroup Video
28518     */
28519    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28520
28521    /**
28522     * @brief Set the audio level of anElm_Video object.
28523     *
28524     * @param video The video object to proceed the request on.
28525     * @param volume The new audio volume.
28526     *
28527     * @ingroup Video
28528     */
28529    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28530
28531    EAPI double elm_video_play_position_get(const Evas_Object *video);
28532    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28533    EAPI double elm_video_play_length_get(const Evas_Object *video);
28534    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28535    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28536    EAPI const char *elm_video_title_get(const Evas_Object *video);
28537    /**
28538     * @}
28539     */
28540
28541    /**
28542     * @defgroup Naviframe Naviframe
28543     * @ingroup Elementary
28544     *
28545     * @brief Naviframe is a kind of view manager for the applications.
28546     *
28547     * Naviframe provides functions to switch different pages with stack
28548     * mechanism. It means if one page(item) needs to be changed to the new one,
28549     * then naviframe would push the new page to it's internal stack. Of course,
28550     * it can be back to the previous page by popping the top page. Naviframe
28551     * provides some transition effect while the pages are switching (same as
28552     * pager).
28553     *
28554     * Since each item could keep the different styles, users could keep the
28555     * same look & feel for the pages or different styles for the items in it's
28556     * application.
28557     *
28558     * Signals that you can add callback for are:
28559     * @li "transition,finished" - When the transition is finished in changing
28560     *     the item
28561     * @li "title,clicked" - User clicked title area
28562     *
28563     * Default contents parts of the naviframe items that you can use for are:
28564     * @li "default" - A main content of the page
28565     * @li "icon" - A icon in the title area
28566     * @li "prev_btn" - A button to go to the previous page
28567     * @li "next_btn" - A button to go to the next page
28568     *
28569     * Default text parts of the naviframe items that you can use for are:
28570     * @li "default" - Title label in the title area
28571     * @li "subtitle" - Sub-title label in the title area
28572     *
28573     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28574     */
28575
28576    /**
28577     * @addtogroup Naviframe
28578     * @{
28579     */
28580
28581    /**
28582     * @brief Add a new Naviframe object to the parent.
28583     *
28584     * @param parent Parent object
28585     * @return New object or @c NULL, if it cannot be created
28586     *
28587     * @ingroup Naviframe
28588     */
28589    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28590    /**
28591     * @brief Push a new item to the top of the naviframe stack (and show it).
28592     *
28593     * @param obj The naviframe object
28594     * @param title_label The label in the title area. The name of the title
28595     *        label part is "elm.text.title"
28596     * @param prev_btn The button to go to the previous item. If it is NULL,
28597     *        then naviframe will create a back button automatically. The name of
28598     *        the prev_btn part is "elm.swallow.prev_btn"
28599     * @param next_btn The button to go to the next item. Or It could be just an
28600     *        extra function button. The name of the next_btn part is
28601     *        "elm.swallow.next_btn"
28602     * @param content The main content object. The name of content part is
28603     *        "elm.swallow.content"
28604     * @param item_style The current item style name. @c NULL would be default.
28605     * @return The created item or @c NULL upon failure.
28606     *
28607     * The item pushed becomes one page of the naviframe, this item will be
28608     * deleted when it is popped.
28609     *
28610     * @see also elm_naviframe_item_style_set()
28611     * @see also elm_naviframe_item_insert_before()
28612     * @see also elm_naviframe_item_insert_after()
28613     *
28614     * The following styles are available for this item:
28615     * @li @c "default"
28616     *
28617     * @ingroup Naviframe
28618     */
28619    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);
28620     /**
28621     * @brief Insert a new item into the naviframe before item @p before.
28622     *
28623     * @param before The naviframe item to insert before.
28624     * @param title_label The label in the title area. The name of the title
28625     *        label part is "elm.text.title"
28626     * @param prev_btn The button to go to the previous item. If it is NULL,
28627     *        then naviframe will create a back button automatically. The name of
28628     *        the prev_btn part is "elm.swallow.prev_btn"
28629     * @param next_btn The button to go to the next item. Or It could be just an
28630     *        extra function button. The name of the next_btn part is
28631     *        "elm.swallow.next_btn"
28632     * @param content The main content object. The name of content part is
28633     *        "elm.swallow.content"
28634     * @param item_style The current item style name. @c NULL would be default.
28635     * @return The created item or @c NULL upon failure.
28636     *
28637     * The item is inserted into the naviframe straight away without any
28638     * transition operations. This item will be deleted when it is popped.
28639     *
28640     * @see also elm_naviframe_item_style_set()
28641     * @see also elm_naviframe_item_push()
28642     * @see also elm_naviframe_item_insert_after()
28643     *
28644     * The following styles are available for this item:
28645     * @li @c "default"
28646     *
28647     * @ingroup Naviframe
28648     */
28649    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);
28650    /**
28651     * @brief Insert a new item into the naviframe after item @p after.
28652     *
28653     * @param after The naviframe item to insert after.
28654     * @param title_label The label in the title area. The name of the title
28655     *        label part is "elm.text.title"
28656     * @param prev_btn The button to go to the previous item. If it is NULL,
28657     *        then naviframe will create a back button automatically. The name of
28658     *        the prev_btn part is "elm.swallow.prev_btn"
28659     * @param next_btn The button to go to the next item. Or It could be just an
28660     *        extra function button. The name of the next_btn part is
28661     *        "elm.swallow.next_btn"
28662     * @param content The main content object. The name of content part is
28663     *        "elm.swallow.content"
28664     * @param item_style The current item style name. @c NULL would be default.
28665     * @return The created item or @c NULL upon failure.
28666     *
28667     * The item is inserted into the naviframe straight away without any
28668     * transition operations. This item will be deleted when it is popped.
28669     *
28670     * @see also elm_naviframe_item_style_set()
28671     * @see also elm_naviframe_item_push()
28672     * @see also elm_naviframe_item_insert_before()
28673     *
28674     * The following styles are available for this item:
28675     * @li @c "default"
28676     *
28677     * @ingroup Naviframe
28678     */
28679    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);
28680    /**
28681     * @brief Pop an item that is on top of the stack
28682     *
28683     * @param obj The naviframe object
28684     * @return @c NULL or the content object(if the
28685     *         elm_naviframe_content_preserve_on_pop_get is true).
28686     *
28687     * This pops an item that is on the top(visible) of the naviframe, makes it
28688     * disappear, then deletes the item. The item that was underneath it on the
28689     * stack will become visible.
28690     *
28691     * @see also elm_naviframe_content_preserve_on_pop_get()
28692     *
28693     * @ingroup Naviframe
28694     */
28695    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28696    /**
28697     * @brief Pop the items between the top and the above one on the given item.
28698     *
28699     * @param it The naviframe item
28700     *
28701     * @ingroup Naviframe
28702     */
28703    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28704    /**
28705    * Promote an item already in the naviframe stack to the top of the stack
28706    *
28707    * @param it The naviframe item
28708    *
28709    * This will take the indicated item and promote it to the top of the stack
28710    * as if it had been pushed there. The item must already be inside the
28711    * naviframe stack to work.
28712    *
28713    */
28714    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28715    /**
28716     * @brief Delete the given item instantly.
28717     *
28718     * @param it The naviframe item
28719     *
28720     * This just deletes the given item from the naviframe item list instantly.
28721     * So this would not emit any signals for view transitions but just change
28722     * the current view if the given item is a top one.
28723     *
28724     * @ingroup Naviframe
28725     */
28726    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28727    /**
28728     * @brief preserve the content objects when items are popped.
28729     *
28730     * @param obj The naviframe object
28731     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28732     *
28733     * @see also elm_naviframe_content_preserve_on_pop_get()
28734     *
28735     * @ingroup Naviframe
28736     */
28737    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28738    /**
28739     * @brief Get a value whether preserve mode is enabled or not.
28740     *
28741     * @param obj The naviframe object
28742     * @return If @c EINA_TRUE, preserve mode is enabled
28743     *
28744     * @see also elm_naviframe_content_preserve_on_pop_set()
28745     *
28746     * @ingroup Naviframe
28747     */
28748    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28749    /**
28750     * @brief Get a top item on the naviframe stack
28751     *
28752     * @param obj The naviframe object
28753     * @return The top item on the naviframe stack or @c NULL, if the stack is
28754     *         empty
28755     *
28756     * @ingroup Naviframe
28757     */
28758    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28759    /**
28760     * @brief Get a bottom item on the naviframe stack
28761     *
28762     * @param obj The naviframe object
28763     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28764     *         empty
28765     *
28766     * @ingroup Naviframe
28767     */
28768    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28769    /**
28770     * @brief Set an item style
28771     *
28772     * @param obj The naviframe item
28773     * @param item_style The current item style name. @c NULL would be default
28774     *
28775     * The following styles are available for this item:
28776     * @li @c "default"
28777     *
28778     * @see also elm_naviframe_item_style_get()
28779     *
28780     * @ingroup Naviframe
28781     */
28782    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28783    /**
28784     * @brief Get an item style
28785     *
28786     * @param obj The naviframe item
28787     * @return The current item style name
28788     *
28789     * @see also elm_naviframe_item_style_set()
28790     *
28791     * @ingroup Naviframe
28792     */
28793    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28794    /**
28795     * @brief Show/Hide the title area
28796     *
28797     * @param it The naviframe item
28798     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28799     *        otherwise
28800     *
28801     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28802     *
28803     * @see also elm_naviframe_item_title_visible_get()
28804     *
28805     * @ingroup Naviframe
28806     */
28807    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28808    /**
28809     * @brief Get a value whether title area is visible or not.
28810     *
28811     * @param it The naviframe item
28812     * @return If @c EINA_TRUE, title area is visible
28813     *
28814     * @see also elm_naviframe_item_title_visible_set()
28815     *
28816     * @ingroup Naviframe
28817     */
28818    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28819
28820    /**
28821     * @brief Set creating prev button automatically or not
28822     *
28823     * @param obj The naviframe object
28824     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28825     *        be created internally when you pass the @c NULL to the prev_btn
28826     *        parameter in elm_naviframe_item_push
28827     *
28828     * @see also elm_naviframe_item_push()
28829     */
28830    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28831    /**
28832     * @brief Get a value whether prev button(back button) will be auto pushed or
28833     *        not.
28834     *
28835     * @param obj The naviframe object
28836     * @return If @c EINA_TRUE, prev button will be auto pushed.
28837     *
28838     * @see also elm_naviframe_item_push()
28839     *           elm_naviframe_prev_btn_auto_pushed_set()
28840     */
28841    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28842    /**
28843     * @brief Get a list of all the naviframe items.
28844     *
28845     * @param obj The naviframe object
28846     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28847     * or @c NULL on failure.
28848     */
28849    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28850
28851    /**
28852     * @}
28853     */
28854
28855 #ifdef __cplusplus
28856 }
28857 #endif
28858
28859 #endif