improve docs on label
[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     * Determine whether a window has focus
4456     * @param obj The window to query
4457     * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4458     */
4459    EAPI Eina_Bool    elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4460    /**
4461     * Get screen geometry details for the screen that a window is on
4462     * @param obj The window to query
4463     * @param x where to return the horizontal offset value. May be NULL.
4464     * @param y  where to return the vertical offset value. May be NULL.
4465     * @param w  where to return the width value. May be NULL.
4466     * @param h  where to return the height value. May be NULL.
4467     */
4468    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4469    /**
4470     * Set the enabled status for the focus highlight in a window
4471     *
4472     * This function will enable or disable the focus highlight only for the
4473     * given window, regardless of the global setting for it
4474     *
4475     * @param obj The window where to enable the highlight
4476     * @param enabled The enabled value for the highlight
4477     */
4478    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4479    /**
4480     * Get the enabled value of the focus highlight for this window
4481     *
4482     * @param obj The window in which to check if the focus highlight is enabled
4483     *
4484     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4485     */
4486    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4487    /**
4488     * Set the style for the focus highlight on this window
4489     *
4490     * Sets the style to use for theming the highlight of focused objects on
4491     * the given window. If @p style is NULL, the default will be used.
4492     *
4493     * @param obj The window where to set the style
4494     * @param style The style to set
4495     */
4496    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4497    /**
4498     * Get the style set for the focus highlight object
4499     *
4500     * Gets the style set for this windows highilght object, or NULL if none
4501     * is set.
4502     *
4503     * @param obj The window to retrieve the highlights style from
4504     *
4505     * @return The style set or NULL if none was. Default is used in that case.
4506     */
4507    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4508    /*...
4509     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4510     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4511     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4512     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4513     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4514     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4515     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4516     *
4517     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4518     * (blank mouse, private mouse obj, defaultmouse)
4519     *
4520     */
4521    /**
4522     * Sets the keyboard mode of the window.
4523     *
4524     * @param obj The window object
4525     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4526     */
4527    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4528    /**
4529     * Gets the keyboard mode of the window.
4530     *
4531     * @param obj The window object
4532     * @return The mode, one of #Elm_Win_Keyboard_Mode
4533     */
4534    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4535    /**
4536     * Sets whether the window is a keyboard.
4537     *
4538     * @param obj The window object
4539     * @param is_keyboard If true, the window is a virtual keyboard
4540     */
4541    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4542    /**
4543     * Gets whether the window is a keyboard.
4544     *
4545     * @param obj The window object
4546     * @return If the window is a virtual keyboard
4547     */
4548    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4549
4550    /**
4551     * Get the screen position of a window.
4552     *
4553     * @param obj The window object
4554     * @param x The int to store the x coordinate to
4555     * @param y The int to store the y coordinate to
4556     */
4557    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4558    /**
4559     * @}
4560     */
4561
4562    /**
4563     * @defgroup Inwin Inwin
4564     *
4565     * @image html img/widget/inwin/preview-00.png
4566     * @image latex img/widget/inwin/preview-00.eps
4567     * @image html img/widget/inwin/preview-01.png
4568     * @image latex img/widget/inwin/preview-01.eps
4569     * @image html img/widget/inwin/preview-02.png
4570     * @image latex img/widget/inwin/preview-02.eps
4571     *
4572     * An inwin is a window inside a window that is useful for a quick popup.
4573     * It does not hover.
4574     *
4575     * It works by creating an object that will occupy the entire window, so it
4576     * must be created using an @ref Win "elm_win" as parent only. The inwin
4577     * object can be hidden or restacked below every other object if it's
4578     * needed to show what's behind it without destroying it. If this is done,
4579     * the elm_win_inwin_activate() function can be used to bring it back to
4580     * full visibility again.
4581     *
4582     * There are three styles available in the default theme. These are:
4583     * @li default: The inwin is sized to take over most of the window it's
4584     * placed in.
4585     * @li minimal: The size of the inwin will be the minimum necessary to show
4586     * its contents.
4587     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4588     * possible, but it's sized vertically the most it needs to fit its\
4589     * contents.
4590     *
4591     * Some examples of Inwin can be found in the following:
4592     * @li @ref inwin_example_01
4593     *
4594     * @{
4595     */
4596    /**
4597     * Adds an inwin to the current window
4598     *
4599     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4600     * Never call this function with anything other than the top-most window
4601     * as its parameter, unless you are fond of undefined behavior.
4602     *
4603     * After creating the object, the widget will set itself as resize object
4604     * for the window with elm_win_resize_object_add(), so when shown it will
4605     * appear to cover almost the entire window (how much of it depends on its
4606     * content and the style used). It must not be added into other container
4607     * objects and it needs not be moved or resized manually.
4608     *
4609     * @param parent The parent object
4610     * @return The new object or NULL if it cannot be created
4611     */
4612    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4613    /**
4614     * Activates an inwin object, ensuring its visibility
4615     *
4616     * This function will make sure that the inwin @p obj is completely visible
4617     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4618     * to the front. It also sets the keyboard focus to it, which will be passed
4619     * onto its content.
4620     *
4621     * The object's theme will also receive the signal "elm,action,show" with
4622     * source "elm".
4623     *
4624     * @param obj The inwin to activate
4625     */
4626    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4627    /**
4628     * Set the content of an inwin object.
4629     *
4630     * Once the content object is set, a previously set one will be deleted.
4631     * If you want to keep that old content object, use the
4632     * elm_win_inwin_content_unset() function.
4633     *
4634     * @param obj The inwin object
4635     * @param content The object to set as content
4636     */
4637    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4638    /**
4639     * Get the content of an inwin object.
4640     *
4641     * Return the content object which is set for this widget.
4642     *
4643     * The returned object is valid as long as the inwin is still alive and no
4644     * other content is set on it. Deleting the object will notify the inwin
4645     * about it and this one will be left empty.
4646     *
4647     * If you need to remove an inwin's content to be reused somewhere else,
4648     * see elm_win_inwin_content_unset().
4649     *
4650     * @param obj The inwin object
4651     * @return The content that is being used
4652     */
4653    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4654    /**
4655     * Unset the content of an inwin object.
4656     *
4657     * Unparent and return the content object which was set for this widget.
4658     *
4659     * @param obj The inwin object
4660     * @return The content that was being used
4661     */
4662    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4663    /**
4664     * @}
4665     */
4666    /* X specific calls - won't work on non-x engines (return 0) */
4667
4668    /**
4669     * Get the Ecore_X_Window of an Evas_Object
4670     *
4671     * @param obj The object
4672     *
4673     * @return The Ecore_X_Window of @p obj
4674     *
4675     * @ingroup Win
4676     */
4677    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4678
4679    /* smart callbacks called:
4680     * "delete,request" - the user requested to delete the window
4681     * "focus,in" - window got focus
4682     * "focus,out" - window lost focus
4683     * "moved" - window that holds the canvas was moved
4684     */
4685
4686    /**
4687     * @defgroup Bg Bg
4688     *
4689     * @image html img/widget/bg/preview-00.png
4690     * @image latex img/widget/bg/preview-00.eps
4691     *
4692     * @brief Background object, used for setting a solid color, image or Edje
4693     * group as background to a window or any container object.
4694     *
4695     * The bg object is used for setting a solid background to a window or
4696     * packing into any container object. It works just like an image, but has
4697     * some properties useful to a background, like setting it to tiled,
4698     * centered, scaled or stretched.
4699     * 
4700     * Default contents parts of the bg widget that you can use for are:
4701     * @li "overlay" - overlay of the bg
4702     *
4703     * Here is some sample code using it:
4704     * @li @ref bg_01_example_page
4705     * @li @ref bg_02_example_page
4706     * @li @ref bg_03_example_page
4707     */
4708
4709    /* bg */
4710    typedef enum _Elm_Bg_Option
4711      {
4712         ELM_BG_OPTION_CENTER,  /**< center the background */
4713         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4714         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4715         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4716      } Elm_Bg_Option;
4717
4718    /**
4719     * Add a new background to the parent
4720     *
4721     * @param parent The parent object
4722     * @return The new object or NULL if it cannot be created
4723     *
4724     * @ingroup Bg
4725     */
4726    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4727
4728    /**
4729     * Set the file (image or edje) used for the background
4730     *
4731     * @param obj The bg object
4732     * @param file The file path
4733     * @param group Optional key (group in Edje) within the file
4734     *
4735     * This sets the image file used in the background object. The image (or edje)
4736     * will be stretched (retaining aspect if its an image file) to completely fill
4737     * the bg object. This may mean some parts are not visible.
4738     *
4739     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4740     * even if @p file is NULL.
4741     *
4742     * @ingroup Bg
4743     */
4744    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4745
4746    /**
4747     * Get the file (image or edje) used for the background
4748     *
4749     * @param obj The bg object
4750     * @param file The file path
4751     * @param group Optional key (group in Edje) within the file
4752     *
4753     * @ingroup Bg
4754     */
4755    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4756
4757    /**
4758     * Set the option used for the background image
4759     *
4760     * @param obj The bg object
4761     * @param option The desired background option (TILE, SCALE)
4762     *
4763     * This sets the option used for manipulating the display of the background
4764     * image. The image can be tiled or scaled.
4765     *
4766     * @ingroup Bg
4767     */
4768    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4769
4770    /**
4771     * Get the option used for the background image
4772     *
4773     * @param obj The bg object
4774     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4775     *
4776     * @ingroup Bg
4777     */
4778    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4779    /**
4780     * Set the option used for the background color
4781     *
4782     * @param obj The bg object
4783     * @param r
4784     * @param g
4785     * @param b
4786     *
4787     * This sets the color used for the background rectangle. Its range goes
4788     * from 0 to 255.
4789     *
4790     * @ingroup Bg
4791     */
4792    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4793    /**
4794     * Get the option used for the background color
4795     *
4796     * @param obj The bg object
4797     * @param r
4798     * @param g
4799     * @param b
4800     *
4801     * @ingroup Bg
4802     */
4803    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4804
4805    /**
4806     * Set the overlay object used for the background object.
4807     *
4808     * @param obj The bg object
4809     * @param overlay The overlay object
4810     *
4811     * This provides a way for elm_bg to have an 'overlay' that will be on top
4812     * of the bg. Once the over object is set, a previously set one will be
4813     * deleted, even if you set the new one to NULL. If you want to keep that
4814     * old content object, use the elm_bg_overlay_unset() function.
4815     *
4816     * @deprecated use elm_object_part_content_set() instead
4817     *
4818     * @ingroup Bg
4819     */
4820
4821    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4822
4823    /**
4824     * Get the overlay object used for the background object.
4825     *
4826     * @param obj The bg object
4827     * @return The content that is being used
4828     *
4829     * Return the content object which is set for this widget
4830     *
4831     * @deprecated use elm_object_part_content_get() instead
4832     *
4833     * @ingroup Bg
4834     */
4835    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4836
4837    /**
4838     * Get the overlay object used for the background object.
4839     *
4840     * @param obj The bg object
4841     * @return The content that was being used
4842     *
4843     * Unparent and return the overlay object which was set for this widget
4844     *
4845     * @deprecated use elm_object_part_content_unset() instead
4846     *
4847     * @ingroup Bg
4848     */
4849    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4850
4851    /**
4852     * Set the size of the pixmap representation of the image.
4853     *
4854     * This option just makes sense if an image is going to be set in the bg.
4855     *
4856     * @param obj The bg object
4857     * @param w The new width of the image pixmap representation.
4858     * @param h The new height of the image pixmap representation.
4859     *
4860     * This function sets a new size for pixmap representation of the given bg
4861     * image. It allows the image to be loaded already in the specified size,
4862     * reducing the memory usage and load time when loading a big image with load
4863     * size set to a smaller size.
4864     *
4865     * NOTE: this is just a hint, the real size of the pixmap may differ
4866     * depending on the type of image being loaded, being bigger than requested.
4867     *
4868     * @ingroup Bg
4869     */
4870    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4871    /* smart callbacks called:
4872     */
4873
4874    /**
4875     * @defgroup Icon Icon
4876     *
4877     * @image html img/widget/icon/preview-00.png
4878     * @image latex img/widget/icon/preview-00.eps
4879     *
4880     * An object that provides standard icon images (delete, edit, arrows, etc.)
4881     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4882     *
4883     * The icon image requested can be in the elementary theme, or in the
4884     * freedesktop.org paths. It's possible to set the order of preference from
4885     * where the image will be used.
4886     *
4887     * This API is very similar to @ref Image, but with ready to use images.
4888     *
4889     * Default images provided by the theme are described below.
4890     *
4891     * The first list contains icons that were first intended to be used in
4892     * toolbars, but can be used in many other places too:
4893     * @li home
4894     * @li close
4895     * @li apps
4896     * @li arrow_up
4897     * @li arrow_down
4898     * @li arrow_left
4899     * @li arrow_right
4900     * @li chat
4901     * @li clock
4902     * @li delete
4903     * @li edit
4904     * @li refresh
4905     * @li folder
4906     * @li file
4907     *
4908     * Now some icons that were designed to be used in menus (but again, you can
4909     * use them anywhere else):
4910     * @li menu/home
4911     * @li menu/close
4912     * @li menu/apps
4913     * @li menu/arrow_up
4914     * @li menu/arrow_down
4915     * @li menu/arrow_left
4916     * @li menu/arrow_right
4917     * @li menu/chat
4918     * @li menu/clock
4919     * @li menu/delete
4920     * @li menu/edit
4921     * @li menu/refresh
4922     * @li menu/folder
4923     * @li menu/file
4924     *
4925     * And here we have some media player specific icons:
4926     * @li media_player/forward
4927     * @li media_player/info
4928     * @li media_player/next
4929     * @li media_player/pause
4930     * @li media_player/play
4931     * @li media_player/prev
4932     * @li media_player/rewind
4933     * @li media_player/stop
4934     *
4935     * Signals that you can add callbacks for are:
4936     *
4937     * "clicked" - This is called when a user has clicked the icon
4938     *
4939     * An example of usage for this API follows:
4940     * @li @ref tutorial_icon
4941     */
4942
4943    /**
4944     * @addtogroup Icon
4945     * @{
4946     */
4947
4948    typedef enum _Elm_Icon_Type
4949      {
4950         ELM_ICON_NONE,
4951         ELM_ICON_FILE,
4952         ELM_ICON_STANDARD
4953      } Elm_Icon_Type;
4954    /**
4955     * @enum _Elm_Icon_Lookup_Order
4956     * @typedef Elm_Icon_Lookup_Order
4957     *
4958     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4959     * theme, FDO paths, or both?
4960     *
4961     * @ingroup Icon
4962     */
4963    typedef enum _Elm_Icon_Lookup_Order
4964      {
4965         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4966         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4967         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4968         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4969      } Elm_Icon_Lookup_Order;
4970
4971    /**
4972     * Add a new icon object to the parent.
4973     *
4974     * @param parent The parent object
4975     * @return The new object or NULL if it cannot be created
4976     *
4977     * @see elm_icon_file_set()
4978     *
4979     * @ingroup Icon
4980     */
4981    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4982    /**
4983     * Set the file that will be used as icon.
4984     *
4985     * @param obj The icon object
4986     * @param file The path to file that will be used as icon image
4987     * @param group The group that the icon belongs to an edje file
4988     *
4989     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4990     *
4991     * @note The icon image set by this function can be changed by
4992     * elm_icon_standard_set().
4993     *
4994     * @see elm_icon_file_get()
4995     *
4996     * @ingroup Icon
4997     */
4998    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4999    /**
5000     * Set a location in memory to be used as an icon
5001     *
5002     * @param obj The icon object
5003     * @param img The binary data that will be used as an image
5004     * @param size The size of binary data @p img
5005     * @param format Optional format of @p img to pass to the image loader
5006     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5007     *
5008     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5009     *
5010     * @note The icon image set by this function can be changed by
5011     * elm_icon_standard_set().
5012     *
5013     * @ingroup Icon
5014     */
5015    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);
5016    /**
5017     * Get the file that will be used as icon.
5018     *
5019     * @param obj The icon object
5020     * @param file The path to file that will be used as the icon image
5021     * @param group The group that the icon belongs to, in edje file
5022     *
5023     * @see elm_icon_file_set()
5024     *
5025     * @ingroup Icon
5026     */
5027    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5028    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5029    /**
5030     * Set the icon by icon standards names.
5031     *
5032     * @param obj The icon object
5033     * @param name The icon name
5034     *
5035     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5036     *
5037     * For example, freedesktop.org defines standard icon names such as "home",
5038     * "network", etc. There can be different icon sets to match those icon
5039     * keys. The @p name given as parameter is one of these "keys", and will be
5040     * used to look in the freedesktop.org paths and elementary theme. One can
5041     * change the lookup order with elm_icon_order_lookup_set().
5042     *
5043     * If name is not found in any of the expected locations and it is the
5044     * absolute path of an image file, this image will be used.
5045     *
5046     * @note The icon image set by this function can be changed by
5047     * elm_icon_file_set().
5048     *
5049     * @see elm_icon_standard_get()
5050     * @see elm_icon_file_set()
5051     *
5052     * @ingroup Icon
5053     */
5054    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5055    /**
5056     * Get the icon name set by icon standard names.
5057     *
5058     * @param obj The icon object
5059     * @return The icon name
5060     *
5061     * If the icon image was set using elm_icon_file_set() instead of
5062     * elm_icon_standard_set(), then this function will return @c NULL.
5063     *
5064     * @see elm_icon_standard_set()
5065     *
5066     * @ingroup Icon
5067     */
5068    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5069    /**
5070     * Set the smooth scaling for an icon object.
5071     *
5072     * @param obj The icon object
5073     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5074     * otherwise. Default is @c EINA_TRUE.
5075     *
5076     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5077     * scaling provides a better resulting image, but is slower.
5078     *
5079     * The smooth scaling should be disabled when making animations that change
5080     * the icon size, since they will be faster. Animations that don't require
5081     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5082     * is already scaled, since the scaled icon image will be cached).
5083     *
5084     * @see elm_icon_smooth_get()
5085     *
5086     * @ingroup Icon
5087     */
5088    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5089    /**
5090     * Get whether smooth scaling is enabled for an icon object.
5091     *
5092     * @param obj The icon object
5093     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5094     *
5095     * @see elm_icon_smooth_set()
5096     *
5097     * @ingroup Icon
5098     */
5099    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5100    /**
5101     * Disable scaling of this object.
5102     *
5103     * @param obj The icon object.
5104     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5105     * otherwise. Default is @c EINA_FALSE.
5106     *
5107     * This function disables scaling of the icon object through the function
5108     * elm_object_scale_set(). However, this does not affect the object
5109     * size/resize in any way. For that effect, take a look at
5110     * elm_icon_scale_set().
5111     *
5112     * @see elm_icon_no_scale_get()
5113     * @see elm_icon_scale_set()
5114     * @see elm_object_scale_set()
5115     *
5116     * @ingroup Icon
5117     */
5118    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5119    /**
5120     * Get whether scaling is disabled on the object.
5121     *
5122     * @param obj The icon object
5123     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5124     *
5125     * @see elm_icon_no_scale_set()
5126     *
5127     * @ingroup Icon
5128     */
5129    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5130    /**
5131     * Set if the object is (up/down) resizable.
5132     *
5133     * @param obj The icon object
5134     * @param scale_up A bool to set if the object is resizable up. Default is
5135     * @c EINA_TRUE.
5136     * @param scale_down A bool to set if the object is resizable down. Default
5137     * is @c EINA_TRUE.
5138     *
5139     * This function limits the icon object resize ability. If @p scale_up is set to
5140     * @c EINA_FALSE, the object can't have its height or width resized to a value
5141     * higher than the original icon size. Same is valid for @p scale_down.
5142     *
5143     * @see elm_icon_scale_get()
5144     *
5145     * @ingroup Icon
5146     */
5147    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5148    /**
5149     * Get if the object is (up/down) resizable.
5150     *
5151     * @param obj The icon object
5152     * @param scale_up A bool to set if the object is resizable up
5153     * @param scale_down A bool to set if the object is resizable down
5154     *
5155     * @see elm_icon_scale_set()
5156     *
5157     * @ingroup Icon
5158     */
5159    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5160    /**
5161     * Get the object's image size
5162     *
5163     * @param obj The icon object
5164     * @param w A pointer to store the width in
5165     * @param h A pointer to store the height in
5166     *
5167     * @ingroup Icon
5168     */
5169    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5170    /**
5171     * Set if the icon fill the entire object area.
5172     *
5173     * @param obj The icon object
5174     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5175     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5176     *
5177     * When the icon object is resized to a different aspect ratio from the
5178     * original icon image, the icon image will still keep its aspect. This flag
5179     * tells how the image should fill the object's area. They are: keep the
5180     * entire icon inside the limits of height and width of the object (@p
5181     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5182     * of the object, and the icon will fill the entire object (@p fill_outside
5183     * is @c EINA_TRUE).
5184     *
5185     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5186     * retain property to false. Thus, the icon image will always keep its
5187     * original aspect ratio.
5188     *
5189     * @see elm_icon_fill_outside_get()
5190     * @see elm_image_fill_outside_set()
5191     *
5192     * @ingroup Icon
5193     */
5194    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5195    /**
5196     * Get if the object is filled outside.
5197     *
5198     * @param obj The icon object
5199     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5200     *
5201     * @see elm_icon_fill_outside_set()
5202     *
5203     * @ingroup Icon
5204     */
5205    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5206    /**
5207     * Set the prescale size for the icon.
5208     *
5209     * @param obj The icon object
5210     * @param size The prescale size. This value is used for both width and
5211     * height.
5212     *
5213     * This function sets a new size for pixmap representation of the given
5214     * icon. It allows the icon to be loaded already in the specified size,
5215     * reducing the memory usage and load time when loading a big icon with load
5216     * size set to a smaller size.
5217     *
5218     * It's equivalent to the elm_bg_load_size_set() function for bg.
5219     *
5220     * @note this is just a hint, the real size of the pixmap may differ
5221     * depending on the type of icon being loaded, being bigger than requested.
5222     *
5223     * @see elm_icon_prescale_get()
5224     * @see elm_bg_load_size_set()
5225     *
5226     * @ingroup Icon
5227     */
5228    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5229    /**
5230     * Get the prescale size for the icon.
5231     *
5232     * @param obj The icon object
5233     * @return The prescale size
5234     *
5235     * @see elm_icon_prescale_set()
5236     *
5237     * @ingroup Icon
5238     */
5239    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5240    /**
5241     * Gets the image object of the icon. DO NOT MODIFY THIS.
5242     *
5243     * @param obj The icon object
5244     * @return The internal icon object
5245     *
5246     * @ingroup Icon
5247     */
5248    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5249    /**
5250     * Sets the icon lookup order used by elm_icon_standard_set().
5251     *
5252     * @param obj The icon object
5253     * @param order The icon lookup order (can be one of
5254     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5255     * or ELM_ICON_LOOKUP_THEME)
5256     *
5257     * @see elm_icon_order_lookup_get()
5258     * @see Elm_Icon_Lookup_Order
5259     *
5260     * @ingroup Icon
5261     */
5262    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5263    /**
5264     * Gets the icon lookup order.
5265     *
5266     * @param obj The icon object
5267     * @return The icon lookup order
5268     *
5269     * @see elm_icon_order_lookup_set()
5270     * @see Elm_Icon_Lookup_Order
5271     *
5272     * @ingroup Icon
5273     */
5274    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5275    /**
5276     * Enable or disable preloading of the icon
5277     *
5278     * @param obj The icon object
5279     * @param disable If EINA_TRUE, preloading will be disabled
5280     * @ingroup Icon
5281     */
5282    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5283    /**
5284     * Get if the icon supports animation or not.
5285     *
5286     * @param obj The icon object
5287     * @return @c EINA_TRUE if the icon supports animation,
5288     *         @c EINA_FALSE otherwise.
5289     *
5290     * Return if this elm icon's image can be animated. Currently Evas only
5291     * supports gif animation. If the return value is EINA_FALSE, other
5292     * elm_icon_animated_XXX APIs won't work.
5293     * @ingroup Icon
5294     */
5295    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5296    /**
5297     * Set animation mode of the icon.
5298     *
5299     * @param obj The icon object
5300     * @param anim @c EINA_TRUE if the object do animation job,
5301     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5302     *
5303     * Since the default animation mode is set to EINA_FALSE, 
5304     * the icon is shown without animation.
5305     * This might be desirable when the application developer wants to show
5306     * a snapshot of the animated icon.
5307     * Set it to EINA_TRUE when the icon needs to be animated.
5308     * @ingroup Icon
5309     */
5310    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5311    /**
5312     * Get animation mode of the icon.
5313     *
5314     * @param obj The icon object
5315     * @return The animation mode of the icon object
5316     * @see elm_icon_animated_set
5317     * @ingroup Icon
5318     */
5319    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5320    /**
5321     * Set animation play mode of the icon.
5322     *
5323     * @param obj The icon object
5324     * @param play @c EINA_TRUE the object play animation images,
5325     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5326     *
5327     * To play elm icon's animation, set play to EINA_TURE.
5328     * For example, you make gif player using this set/get API and click event.
5329     *
5330     * 1. Click event occurs
5331     * 2. Check play flag using elm_icon_animaged_play_get
5332     * 3. If elm icon was playing, set play to EINA_FALSE.
5333     *    Then animation will be stopped and vice versa
5334     * @ingroup Icon
5335     */
5336    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5337    /**
5338     * Get animation play mode of the icon.
5339     *
5340     * @param obj The icon object
5341     * @return The play mode of the icon object
5342     *
5343     * @see elm_icon_animated_play_get
5344     * @ingroup Icon
5345     */
5346    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5347
5348    /**
5349     * @}
5350     */
5351
5352    /**
5353     * @defgroup Image Image
5354     *
5355     * @image html img/widget/image/preview-00.png
5356     * @image latex img/widget/image/preview-00.eps
5357
5358     *
5359     * An object that allows one to load an image file to it. It can be used
5360     * anywhere like any other elementary widget.
5361     *
5362     * This widget provides most of the functionality provided from @ref Bg or @ref
5363     * Icon, but with a slightly different API (use the one that fits better your
5364     * needs).
5365     *
5366     * The features not provided by those two other image widgets are:
5367     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5368     * @li change the object orientation with elm_image_orient_set();
5369     * @li and turning the image editable with elm_image_editable_set().
5370     *
5371     * Signals that you can add callbacks for are:
5372     *
5373     * @li @c "clicked" - This is called when a user has clicked the image
5374     *
5375     * An example of usage for this API follows:
5376     * @li @ref tutorial_image
5377     */
5378
5379    /**
5380     * @addtogroup Image
5381     * @{
5382     */
5383
5384    /**
5385     * @enum _Elm_Image_Orient
5386     * @typedef Elm_Image_Orient
5387     *
5388     * Possible orientation options for elm_image_orient_set().
5389     *
5390     * @image html elm_image_orient_set.png
5391     * @image latex elm_image_orient_set.eps width=\textwidth
5392     *
5393     * @ingroup Image
5394     */
5395    typedef enum _Elm_Image_Orient
5396      {
5397         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5398         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5399         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5400         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5401         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5402         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5403         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5404         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5405      } Elm_Image_Orient;
5406
5407    /**
5408     * Add a new image to the parent.
5409     *
5410     * @param parent The parent object
5411     * @return The new object or NULL if it cannot be created
5412     *
5413     * @see elm_image_file_set()
5414     *
5415     * @ingroup Image
5416     */
5417    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5418    /**
5419     * Set the file that will be used as image.
5420     *
5421     * @param obj The image object
5422     * @param file The path to file that will be used as image
5423     * @param group The group that the image belongs in edje file (if it's an
5424     * edje image)
5425     *
5426     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5427     *
5428     * @see elm_image_file_get()
5429     *
5430     * @ingroup Image
5431     */
5432    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5433    /**
5434     * Get the file that will be used as image.
5435     *
5436     * @param obj The image object
5437     * @param file The path to file
5438     * @param group The group that the image belongs in edje file
5439     *
5440     * @see elm_image_file_set()
5441     *
5442     * @ingroup Image
5443     */
5444    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5445    /**
5446     * Set the smooth effect for an image.
5447     *
5448     * @param obj The image object
5449     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5450     * otherwise. Default is @c EINA_TRUE.
5451     *
5452     * Set the scaling algorithm to be used when scaling the image. Smooth
5453     * scaling provides a better resulting image, but is slower.
5454     *
5455     * The smooth scaling should be disabled when making animations that change
5456     * the image size, since it will be faster. Animations that don't require
5457     * resizing of the image can keep the smooth scaling enabled (even if the
5458     * image is already scaled, since the scaled image will be cached).
5459     *
5460     * @see elm_image_smooth_get()
5461     *
5462     * @ingroup Image
5463     */
5464    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5465    /**
5466     * Get the smooth effect for an image.
5467     *
5468     * @param obj The image object
5469     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5470     *
5471     * @see elm_image_smooth_get()
5472     *
5473     * @ingroup Image
5474     */
5475    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5476
5477    /**
5478     * Gets the current size of the image.
5479     *
5480     * @param obj The image object.
5481     * @param w Pointer to store width, or NULL.
5482     * @param h Pointer to store height, or NULL.
5483     *
5484     * This is the real size of the image, not the size of the object.
5485     *
5486     * On error, neither w or h will be written.
5487     *
5488     * @ingroup Image
5489     */
5490    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5491    /**
5492     * Disable scaling of this object.
5493     *
5494     * @param obj The image object.
5495     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5496     * otherwise. Default is @c EINA_FALSE.
5497     *
5498     * This function disables scaling of the elm_image widget through the
5499     * function elm_object_scale_set(). However, this does not affect the widget
5500     * size/resize in any way. For that effect, take a look at
5501     * elm_image_scale_set().
5502     *
5503     * @see elm_image_no_scale_get()
5504     * @see elm_image_scale_set()
5505     * @see elm_object_scale_set()
5506     *
5507     * @ingroup Image
5508     */
5509    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5510    /**
5511     * Get whether scaling is disabled on the object.
5512     *
5513     * @param obj The image object
5514     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5515     *
5516     * @see elm_image_no_scale_set()
5517     *
5518     * @ingroup Image
5519     */
5520    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5521    /**
5522     * Set if the object is (up/down) resizable.
5523     *
5524     * @param obj The image object
5525     * @param scale_up A bool to set if the object is resizable up. Default is
5526     * @c EINA_TRUE.
5527     * @param scale_down A bool to set if the object is resizable down. Default
5528     * is @c EINA_TRUE.
5529     *
5530     * This function limits the image resize ability. If @p scale_up is set to
5531     * @c EINA_FALSE, the object can't have its height or width resized to a value
5532     * higher than the original image size. Same is valid for @p scale_down.
5533     *
5534     * @see elm_image_scale_get()
5535     *
5536     * @ingroup Image
5537     */
5538    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5539    /**
5540     * Get if the object is (up/down) resizable.
5541     *
5542     * @param obj The image object
5543     * @param scale_up A bool to set if the object is resizable up
5544     * @param scale_down A bool to set if the object is resizable down
5545     *
5546     * @see elm_image_scale_set()
5547     *
5548     * @ingroup Image
5549     */
5550    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5551    /**
5552     * Set if the image fills the entire object area, when keeping the aspect ratio.
5553     *
5554     * @param obj The image object
5555     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5556     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5557     *
5558     * When the image should keep its aspect ratio even if resized to another
5559     * aspect ratio, there are two possibilities to resize it: keep the entire
5560     * image inside the limits of height and width of the object (@p fill_outside
5561     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5562     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5563     *
5564     * @note This option will have no effect if
5565     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5566     *
5567     * @see elm_image_fill_outside_get()
5568     * @see elm_image_aspect_ratio_retained_set()
5569     *
5570     * @ingroup Image
5571     */
5572    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5573    /**
5574     * Get if the object is filled outside
5575     *
5576     * @param obj The image object
5577     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5578     *
5579     * @see elm_image_fill_outside_set()
5580     *
5581     * @ingroup Image
5582     */
5583    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5584    /**
5585     * Set the prescale size for the image
5586     *
5587     * @param obj The image object
5588     * @param size The prescale size. This value is used for both width and
5589     * height.
5590     *
5591     * This function sets a new size for pixmap representation of the given
5592     * image. It allows the image to be loaded already in the specified size,
5593     * reducing the memory usage and load time when loading a big image with load
5594     * size set to a smaller size.
5595     *
5596     * It's equivalent to the elm_bg_load_size_set() function for bg.
5597     *
5598     * @note this is just a hint, the real size of the pixmap may differ
5599     * depending on the type of image being loaded, being bigger than requested.
5600     *
5601     * @see elm_image_prescale_get()
5602     * @see elm_bg_load_size_set()
5603     *
5604     * @ingroup Image
5605     */
5606    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5607    /**
5608     * Get the prescale size for the image
5609     *
5610     * @param obj The image object
5611     * @return The prescale size
5612     *
5613     * @see elm_image_prescale_set()
5614     *
5615     * @ingroup Image
5616     */
5617    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5618    /**
5619     * Set the image orientation.
5620     *
5621     * @param obj The image object
5622     * @param orient The image orientation @ref Elm_Image_Orient
5623     *  Default is #ELM_IMAGE_ORIENT_NONE.
5624     *
5625     * This function allows to rotate or flip the given image.
5626     *
5627     * @see elm_image_orient_get()
5628     * @see @ref Elm_Image_Orient
5629     *
5630     * @ingroup Image
5631     */
5632    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5633    /**
5634     * Get the image orientation.
5635     *
5636     * @param obj The image object
5637     * @return The image orientation @ref Elm_Image_Orient
5638     *
5639     * @see elm_image_orient_set()
5640     * @see @ref Elm_Image_Orient
5641     *
5642     * @ingroup Image
5643     */
5644    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5645    /**
5646     * Make the image 'editable'.
5647     *
5648     * @param obj Image object.
5649     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5650     *
5651     * This means the image is a valid drag target for drag and drop, and can be
5652     * cut or pasted too.
5653     *
5654     * @ingroup Image
5655     */
5656    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5657    /**
5658     * Check if the image 'editable'.
5659     *
5660     * @param obj Image object.
5661     * @return Editability.
5662     *
5663     * A return value of EINA_TRUE means the image is a valid drag target
5664     * for drag and drop, and can be cut or pasted too.
5665     *
5666     * @ingroup Image
5667     */
5668    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5669    /**
5670     * Get the basic Evas_Image object from this object (widget).
5671     *
5672     * @param obj The image object to get the inlined image from
5673     * @return The inlined image object, or NULL if none exists
5674     *
5675     * This function allows one to get the underlying @c Evas_Object of type
5676     * Image from this elementary widget. It can be useful to do things like get
5677     * the pixel data, save the image to a file, etc.
5678     *
5679     * @note Be careful to not manipulate it, as it is under control of
5680     * elementary.
5681     *
5682     * @ingroup Image
5683     */
5684    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5685    /**
5686     * Set whether the original aspect ratio of the image should be kept on resize.
5687     *
5688     * @param obj The image object.
5689     * @param retained @c EINA_TRUE if the image should retain the aspect,
5690     * @c EINA_FALSE otherwise.
5691     *
5692     * The original aspect ratio (width / height) of the image is usually
5693     * distorted to match the object's size. Enabling this option will retain
5694     * this original aspect, and the way that the image is fit into the object's
5695     * area depends on the option set by elm_image_fill_outside_set().
5696     *
5697     * @see elm_image_aspect_ratio_retained_get()
5698     * @see elm_image_fill_outside_set()
5699     *
5700     * @ingroup Image
5701     */
5702    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5703    /**
5704     * Get if the object retains the original aspect ratio.
5705     *
5706     * @param obj The image object.
5707     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5708     * otherwise.
5709     *
5710     * @ingroup Image
5711     */
5712    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5713
5714    /**
5715     * @}
5716     */
5717
5718    /* box */
5719    /**
5720     * @defgroup Box Box
5721     *
5722     * @image html img/widget/box/preview-00.png
5723     * @image latex img/widget/box/preview-00.eps width=\textwidth
5724     *
5725     * @image html img/box.png
5726     * @image latex img/box.eps width=\textwidth
5727     *
5728     * A box arranges objects in a linear fashion, governed by a layout function
5729     * that defines the details of this arrangement.
5730     *
5731     * By default, the box will use an internal function to set the layout to
5732     * a single row, either vertical or horizontal. This layout is affected
5733     * by a number of parameters, such as the homogeneous flag set by
5734     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5735     * elm_box_align_set() and the hints set to each object in the box.
5736     *
5737     * For this default layout, it's possible to change the orientation with
5738     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5739     * placing its elements ordered from top to bottom. When horizontal is set,
5740     * the order will go from left to right. If the box is set to be
5741     * homogeneous, every object in it will be assigned the same space, that
5742     * of the largest object. Padding can be used to set some spacing between
5743     * the cell given to each object. The alignment of the box, set with
5744     * elm_box_align_set(), determines how the bounding box of all the elements
5745     * will be placed within the space given to the box widget itself.
5746     *
5747     * The size hints of each object also affect how they are placed and sized
5748     * within the box. evas_object_size_hint_min_set() will give the minimum
5749     * size the object can have, and the box will use it as the basis for all
5750     * latter calculations. Elementary widgets set their own minimum size as
5751     * needed, so there's rarely any need to use it manually.
5752     *
5753     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5754     * used to tell whether the object will be allocated the minimum size it
5755     * needs or if the space given to it should be expanded. It's important
5756     * to realize that expanding the size given to the object is not the same
5757     * thing as resizing the object. It could very well end being a small
5758     * widget floating in a much larger empty space. If not set, the weight
5759     * for objects will normally be 0.0 for both axis, meaning the widget will
5760     * not be expanded. To take as much space possible, set the weight to
5761     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5762     *
5763     * Besides how much space each object is allocated, it's possible to control
5764     * how the widget will be placed within that space using
5765     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5766     * for both axis, meaning the object will be centered, but any value from
5767     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5768     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5769     * is -1.0, means the object will be resized to fill the entire space it
5770     * was allocated.
5771     *
5772     * In addition, customized functions to define the layout can be set, which
5773     * allow the application developer to organize the objects within the box
5774     * in any number of ways.
5775     *
5776     * The special elm_box_layout_transition() function can be used
5777     * to switch from one layout to another, animating the motion of the
5778     * children of the box.
5779     *
5780     * @note Objects should not be added to box objects using _add() calls.
5781     *
5782     * Some examples on how to use boxes follow:
5783     * @li @ref box_example_01
5784     * @li @ref box_example_02
5785     *
5786     * @{
5787     */
5788    /**
5789     * @typedef Elm_Box_Transition
5790     *
5791     * Opaque handler containing the parameters to perform an animated
5792     * transition of the layout the box uses.
5793     *
5794     * @see elm_box_transition_new()
5795     * @see elm_box_layout_set()
5796     * @see elm_box_layout_transition()
5797     */
5798    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5799
5800    /**
5801     * Add a new box to the parent
5802     *
5803     * By default, the box will be in vertical mode and non-homogeneous.
5804     *
5805     * @param parent The parent object
5806     * @return The new object or NULL if it cannot be created
5807     */
5808    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5809    /**
5810     * Set the horizontal orientation
5811     *
5812     * By default, box object arranges their contents vertically from top to
5813     * bottom.
5814     * By calling this function with @p horizontal as EINA_TRUE, the box will
5815     * become horizontal, arranging contents from left to right.
5816     *
5817     * @note This flag is ignored if a custom layout function is set.
5818     *
5819     * @param obj The box object
5820     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5821     * EINA_FALSE = vertical)
5822     */
5823    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5824    /**
5825     * Get the horizontal orientation
5826     *
5827     * @param obj The box object
5828     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5829     */
5830    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5831    /**
5832     * Set the box to arrange its children homogeneously
5833     *
5834     * If enabled, homogeneous layout makes all items the same size, according
5835     * to the size of the largest of its children.
5836     *
5837     * @note This flag is ignored if a custom layout function is set.
5838     *
5839     * @param obj The box object
5840     * @param homogeneous The homogeneous flag
5841     */
5842    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5843    /**
5844     * Get whether the box is using homogeneous mode or not
5845     *
5846     * @param obj The box object
5847     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5848     */
5849    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5850    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5851    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5852    /**
5853     * Add an object to the beginning of the pack list
5854     *
5855     * Pack @p subobj into the box @p obj, placing it first in the list of
5856     * children objects. The actual position the object will get on screen
5857     * depends on the layout used. If no custom layout is set, it will be at
5858     * the top or left, depending if the box is vertical or horizontal,
5859     * respectively.
5860     *
5861     * @param obj The box object
5862     * @param subobj The object to add to the box
5863     *
5864     * @see elm_box_pack_end()
5865     * @see elm_box_pack_before()
5866     * @see elm_box_pack_after()
5867     * @see elm_box_unpack()
5868     * @see elm_box_unpack_all()
5869     * @see elm_box_clear()
5870     */
5871    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5872    /**
5873     * Add an object at the end of the pack list
5874     *
5875     * Pack @p subobj into the box @p obj, placing it last in the list of
5876     * children objects. The actual position the object will get on screen
5877     * depends on the layout used. If no custom layout is set, it will be at
5878     * the bottom or right, depending if the box is vertical or horizontal,
5879     * respectively.
5880     *
5881     * @param obj The box object
5882     * @param subobj The object to add to the box
5883     *
5884     * @see elm_box_pack_start()
5885     * @see elm_box_pack_before()
5886     * @see elm_box_pack_after()
5887     * @see elm_box_unpack()
5888     * @see elm_box_unpack_all()
5889     * @see elm_box_clear()
5890     */
5891    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5892    /**
5893     * Adds an object to the box before the indicated object
5894     *
5895     * This will add the @p subobj to the box indicated before the object
5896     * indicated with @p before. If @p before is not already in the box, results
5897     * are undefined. Before means either to the left of the indicated object or
5898     * above it depending on orientation.
5899     *
5900     * @param obj The box object
5901     * @param subobj The object to add to the box
5902     * @param before The object before which to add it
5903     *
5904     * @see elm_box_pack_start()
5905     * @see elm_box_pack_end()
5906     * @see elm_box_pack_after()
5907     * @see elm_box_unpack()
5908     * @see elm_box_unpack_all()
5909     * @see elm_box_clear()
5910     */
5911    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5912    /**
5913     * Adds an object to the box after the indicated object
5914     *
5915     * This will add the @p subobj to the box indicated after the object
5916     * indicated with @p after. If @p after is not already in the box, results
5917     * are undefined. After means either to the right of the indicated object or
5918     * below it depending on orientation.
5919     *
5920     * @param obj The box object
5921     * @param subobj The object to add to the box
5922     * @param after The object after which to add it
5923     *
5924     * @see elm_box_pack_start()
5925     * @see elm_box_pack_end()
5926     * @see elm_box_pack_before()
5927     * @see elm_box_unpack()
5928     * @see elm_box_unpack_all()
5929     * @see elm_box_clear()
5930     */
5931    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5932    /**
5933     * Clear the box of all children
5934     *
5935     * Remove all the elements contained by the box, deleting the respective
5936     * objects.
5937     *
5938     * @param obj The box object
5939     *
5940     * @see elm_box_unpack()
5941     * @see elm_box_unpack_all()
5942     */
5943    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5944    /**
5945     * Unpack a box item
5946     *
5947     * Remove the object given by @p subobj from the box @p obj without
5948     * deleting it.
5949     *
5950     * @param obj The box object
5951     *
5952     * @see elm_box_unpack_all()
5953     * @see elm_box_clear()
5954     */
5955    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5956    /**
5957     * Remove all items from the box, without deleting them
5958     *
5959     * Clear the box from all children, but don't delete the respective objects.
5960     * If no other references of the box children exist, the objects will never
5961     * be deleted, and thus the application will leak the memory. Make sure
5962     * when using this function that you hold a reference to all the objects
5963     * in the box @p obj.
5964     *
5965     * @param obj The box object
5966     *
5967     * @see elm_box_clear()
5968     * @see elm_box_unpack()
5969     */
5970    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5971    /**
5972     * Retrieve a list of the objects packed into the box
5973     *
5974     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5975     * The order of the list corresponds to the packing order the box uses.
5976     *
5977     * You must free this list with eina_list_free() once you are done with it.
5978     *
5979     * @param obj The box object
5980     */
5981    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5982    /**
5983     * Set the space (padding) between the box's elements.
5984     *
5985     * Extra space in pixels that will be added between a box child and its
5986     * neighbors after its containing cell has been calculated. This padding
5987     * is set for all elements in the box, besides any possible padding that
5988     * individual elements may have through their size hints.
5989     *
5990     * @param obj The box object
5991     * @param horizontal The horizontal space between elements
5992     * @param vertical The vertical space between elements
5993     */
5994    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5995    /**
5996     * Get the space (padding) between the box's elements.
5997     *
5998     * @param obj The box object
5999     * @param horizontal The horizontal space between elements
6000     * @param vertical The vertical space between elements
6001     *
6002     * @see elm_box_padding_set()
6003     */
6004    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6005    /**
6006     * Set the alignment of the whole bouding box of contents.
6007     *
6008     * Sets how the bounding box containing all the elements of the box, after
6009     * their sizes and position has been calculated, will be aligned within
6010     * the space given for the whole box widget.
6011     *
6012     * @param obj The box object
6013     * @param horizontal The horizontal alignment of elements
6014     * @param vertical The vertical alignment of elements
6015     */
6016    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6017    /**
6018     * Get the alignment of the whole bouding box of contents.
6019     *
6020     * @param obj The box object
6021     * @param horizontal The horizontal alignment of elements
6022     * @param vertical The vertical alignment of elements
6023     *
6024     * @see elm_box_align_set()
6025     */
6026    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6027
6028    /**
6029     * Force the box to recalculate its children packing.
6030     *
6031     * If any children was added or removed, box will not calculate the
6032     * values immediately rather leaving it to the next main loop
6033     * iteration. While this is great as it would save lots of
6034     * recalculation, whenever you need to get the position of a just
6035     * added item you must force recalculate before doing so.
6036     *
6037     * @param obj The box object.
6038     */
6039    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6040
6041    /**
6042     * Set the layout defining function to be used by the box
6043     *
6044     * Whenever anything changes that requires the box in @p obj to recalculate
6045     * the size and position of its elements, the function @p cb will be called
6046     * to determine what the layout of the children will be.
6047     *
6048     * Once a custom function is set, everything about the children layout
6049     * is defined by it. The flags set by elm_box_horizontal_set() and
6050     * elm_box_homogeneous_set() no longer have any meaning, and the values
6051     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6052     * layout function to decide if they are used and how. These last two
6053     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6054     * passed to @p cb. The @c Evas_Object the function receives is not the
6055     * Elementary widget, but the internal Evas Box it uses, so none of the
6056     * functions described here can be used on it.
6057     *
6058     * Any of the layout functions in @c Evas can be used here, as well as the
6059     * special elm_box_layout_transition().
6060     *
6061     * The final @p data argument received by @p cb is the same @p data passed
6062     * here, and the @p free_data function will be called to free it
6063     * whenever the box is destroyed or another layout function is set.
6064     *
6065     * Setting @p cb to NULL will revert back to the default layout function.
6066     *
6067     * @param obj The box object
6068     * @param cb The callback function used for layout
6069     * @param data Data that will be passed to layout function
6070     * @param free_data Function called to free @p data
6071     *
6072     * @see elm_box_layout_transition()
6073     */
6074    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);
6075    /**
6076     * Special layout function that animates the transition from one layout to another
6077     *
6078     * Normally, when switching the layout function for a box, this will be
6079     * reflected immediately on screen on the next render, but it's also
6080     * possible to do this through an animated transition.
6081     *
6082     * This is done by creating an ::Elm_Box_Transition and setting the box
6083     * layout to this function.
6084     *
6085     * For example:
6086     * @code
6087     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6088     *                            evas_object_box_layout_vertical, // start
6089     *                            NULL, // data for initial layout
6090     *                            NULL, // free function for initial data
6091     *                            evas_object_box_layout_horizontal, // end
6092     *                            NULL, // data for final layout
6093     *                            NULL, // free function for final data
6094     *                            anim_end, // will be called when animation ends
6095     *                            NULL); // data for anim_end function\
6096     * elm_box_layout_set(box, elm_box_layout_transition, t,
6097     *                    elm_box_transition_free);
6098     * @endcode
6099     *
6100     * @note This function can only be used with elm_box_layout_set(). Calling
6101     * it directly will not have the expected results.
6102     *
6103     * @see elm_box_transition_new
6104     * @see elm_box_transition_free
6105     * @see elm_box_layout_set
6106     */
6107    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6108    /**
6109     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6110     *
6111     * If you want to animate the change from one layout to another, you need
6112     * to set the layout function of the box to elm_box_layout_transition(),
6113     * passing as user data to it an instance of ::Elm_Box_Transition with the
6114     * necessary information to perform this animation. The free function to
6115     * set for the layout is elm_box_transition_free().
6116     *
6117     * The parameters to create an ::Elm_Box_Transition sum up to how long
6118     * will it be, in seconds, a layout function to describe the initial point,
6119     * another for the final position of the children and one function to be
6120     * called when the whole animation ends. This last function is useful to
6121     * set the definitive layout for the box, usually the same as the end
6122     * layout for the animation, but could be used to start another transition.
6123     *
6124     * @param start_layout The layout function that will be used to start the animation
6125     * @param start_layout_data The data to be passed the @p start_layout function
6126     * @param start_layout_free_data Function to free @p start_layout_data
6127     * @param end_layout The layout function that will be used to end the animation
6128     * @param end_layout_free_data The data to be passed the @p end_layout function
6129     * @param end_layout_free_data Function to free @p end_layout_data
6130     * @param transition_end_cb Callback function called when animation ends
6131     * @param transition_end_data Data to be passed to @p transition_end_cb
6132     * @return An instance of ::Elm_Box_Transition
6133     *
6134     * @see elm_box_transition_new
6135     * @see elm_box_layout_transition
6136     */
6137    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);
6138    /**
6139     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6140     *
6141     * This function is mostly useful as the @c free_data parameter in
6142     * elm_box_layout_set() when elm_box_layout_transition().
6143     *
6144     * @param data The Elm_Box_Transition instance to be freed.
6145     *
6146     * @see elm_box_transition_new
6147     * @see elm_box_layout_transition
6148     */
6149    EAPI void                elm_box_transition_free(void *data);
6150    /**
6151     * @}
6152     */
6153
6154    /* button */
6155    /**
6156     * @defgroup Button Button
6157     *
6158     * @image html img/widget/button/preview-00.png
6159     * @image latex img/widget/button/preview-00.eps
6160     * @image html img/widget/button/preview-01.png
6161     * @image latex img/widget/button/preview-01.eps
6162     * @image html img/widget/button/preview-02.png
6163     * @image latex img/widget/button/preview-02.eps
6164     *
6165     * This is a push-button. Press it and run some function. It can contain
6166     * a simple label and icon object and it also has an autorepeat feature.
6167     *
6168     * This widgets emits the following signals:
6169     * @li "clicked": the user clicked the button (press/release).
6170     * @li "repeated": the user pressed the button without releasing it.
6171     * @li "pressed": button was pressed.
6172     * @li "unpressed": button was released after being pressed.
6173     * In all three cases, the @c event parameter of the callback will be
6174     * @c NULL.
6175     *
6176     * Also, defined in the default theme, the button has the following styles
6177     * available:
6178     * @li default: a normal button.
6179     * @li anchor: Like default, but the button fades away when the mouse is not
6180     * over it, leaving only the text or icon.
6181     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6182     * continuous look across its options.
6183     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6184     *
6185     * Default contents parts of the button widget that you can use for are:
6186     * @li "icon" - A icon of the button
6187     *
6188     * Default text parts of the button widget that you can use for are:
6189     * @li "default" - Label of the button
6190     *
6191     * Follow through a complete example @ref button_example_01 "here".
6192     * @{
6193     */
6194    /**
6195     * Add a new button to the parent's canvas
6196     *
6197     * @param parent The parent object
6198     * @return The new object or NULL if it cannot be created
6199     */
6200    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6201    /**
6202     * Set the label used in the button
6203     *
6204     * The passed @p label can be NULL to clean any existing text in it and
6205     * leave the button as an icon only object.
6206     *
6207     * @param obj The button object
6208     * @param label The text will be written on the button
6209     * @deprecated use elm_object_text_set() instead.
6210     */
6211    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6212    /**
6213     * Get the label set for the button
6214     *
6215     * The string returned is an internal pointer and should not be freed or
6216     * altered. It will also become invalid when the button is destroyed.
6217     * The string returned, if not NULL, is a stringshare, so if you need to
6218     * keep it around even after the button is destroyed, you can use
6219     * eina_stringshare_ref().
6220     *
6221     * @param obj The button object
6222     * @return The text set to the label, or NULL if nothing is set
6223     * @deprecated use elm_object_text_set() instead.
6224     */
6225    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6226    /**
6227     * Set the icon used for the button
6228     *
6229     * Setting a new icon will delete any other that was previously set, making
6230     * any reference to them invalid. If you need to maintain the previous
6231     * object alive, unset it first with elm_button_icon_unset().
6232     *
6233     * @param obj The button object
6234     * @param icon The icon object for the button
6235     * @deprecated use elm_object_part_content_set() instead.
6236     */
6237    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6238    /**
6239     * Get the icon used for the button
6240     *
6241     * Return the icon object which is set for this widget. If the button is
6242     * destroyed or another icon is set, the returned object will be deleted
6243     * and any reference to it will be invalid.
6244     *
6245     * @param obj The button object
6246     * @return The icon object that is being used
6247     *
6248     * @deprecated use elm_object_part_content_get() instead
6249     */
6250    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6251    /**
6252     * Remove the icon set without deleting it and return the object
6253     *
6254     * This function drops the reference the button holds of the icon object
6255     * and returns this last object. It is used in case you want to remove any
6256     * icon, or set another one, without deleting the actual object. The button
6257     * will be left without an icon set.
6258     *
6259     * @param obj The button object
6260     * @return The icon object that was being used
6261     * @deprecated use elm_object_part_content_unset() instead.
6262     */
6263    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6264    /**
6265     * Turn on/off the autorepeat event generated when the button is kept pressed
6266     *
6267     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6268     * signal when they are clicked.
6269     *
6270     * When on, keeping a button pressed will continuously emit a @c repeated
6271     * signal until the button is released. The time it takes until it starts
6272     * emitting the signal is given by
6273     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6274     * new emission by elm_button_autorepeat_gap_timeout_set().
6275     *
6276     * @param obj The button object
6277     * @param on  A bool to turn on/off the event
6278     */
6279    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6280    /**
6281     * Get whether the autorepeat feature is enabled
6282     *
6283     * @param obj The button object
6284     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6285     *
6286     * @see elm_button_autorepeat_set()
6287     */
6288    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6289    /**
6290     * Set the initial timeout before the autorepeat event is generated
6291     *
6292     * Sets the timeout, in seconds, since the button is pressed until the
6293     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6294     * won't be any delay and the even will be fired the moment the button is
6295     * pressed.
6296     *
6297     * @param obj The button object
6298     * @param t   Timeout in seconds
6299     *
6300     * @see elm_button_autorepeat_set()
6301     * @see elm_button_autorepeat_gap_timeout_set()
6302     */
6303    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6304    /**
6305     * Get the initial timeout before the autorepeat event is generated
6306     *
6307     * @param obj The button object
6308     * @return Timeout in seconds
6309     *
6310     * @see elm_button_autorepeat_initial_timeout_set()
6311     */
6312    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6313    /**
6314     * Set the interval between each generated autorepeat event
6315     *
6316     * After the first @c repeated event is fired, all subsequent ones will
6317     * follow after a delay of @p t seconds for each.
6318     *
6319     * @param obj The button object
6320     * @param t   Interval in seconds
6321     *
6322     * @see elm_button_autorepeat_initial_timeout_set()
6323     */
6324    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6325    /**
6326     * Get the interval between each generated autorepeat event
6327     *
6328     * @param obj The button object
6329     * @return Interval in seconds
6330     */
6331    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6332    /**
6333     * @}
6334     */
6335
6336    /**
6337     * @defgroup File_Selector_Button File Selector Button
6338     *
6339     * @image html img/widget/fileselector_button/preview-00.png
6340     * @image latex img/widget/fileselector_button/preview-00.eps
6341     * @image html img/widget/fileselector_button/preview-01.png
6342     * @image latex img/widget/fileselector_button/preview-01.eps
6343     * @image html img/widget/fileselector_button/preview-02.png
6344     * @image latex img/widget/fileselector_button/preview-02.eps
6345     *
6346     * This is a button that, when clicked, creates an Elementary
6347     * window (or inner window) <b> with a @ref Fileselector "file
6348     * selector widget" within</b>. When a file is chosen, the (inner)
6349     * window is closed and the button emits a signal having the
6350     * selected file as it's @c event_info.
6351     *
6352     * This widget encapsulates operations on its internal file
6353     * selector on its own API. There is less control over its file
6354     * selector than that one would have instatiating one directly.
6355     *
6356     * The following styles are available for this button:
6357     * @li @c "default"
6358     * @li @c "anchor"
6359     * @li @c "hoversel_vertical"
6360     * @li @c "hoversel_vertical_entry"
6361     *
6362     * Smart callbacks one can register to:
6363     * - @c "file,chosen" - the user has selected a path, whose string
6364     *   pointer comes as the @c event_info data (a stringshared
6365     *   string)
6366     *
6367     * Here is an example on its usage:
6368     * @li @ref fileselector_button_example
6369     *
6370     * @see @ref File_Selector_Entry for a similar widget.
6371     * @{
6372     */
6373
6374    /**
6375     * Add a new file selector button widget to the given parent
6376     * Elementary (container) object
6377     *
6378     * @param parent The parent object
6379     * @return a new file selector button widget handle or @c NULL, on
6380     * errors
6381     */
6382    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6383
6384    /**
6385     * Set the label for a given file selector button widget
6386     *
6387     * @param obj The file selector button widget
6388     * @param label The text label to be displayed on @p obj
6389     *
6390     * @deprecated use elm_object_text_set() instead.
6391     */
6392    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6393
6394    /**
6395     * Get the label set for a given file selector button widget
6396     *
6397     * @param obj The file selector button widget
6398     * @return The button label
6399     *
6400     * @deprecated use elm_object_text_set() instead.
6401     */
6402    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6403
6404    /**
6405     * Set the icon on a given file selector button widget
6406     *
6407     * @param obj The file selector button widget
6408     * @param icon The icon object for the button
6409     *
6410     * Once the icon object is set, a previously set one will be
6411     * deleted. If you want to keep the latter, use the
6412     * elm_fileselector_button_icon_unset() function.
6413     *
6414     * @see elm_fileselector_button_icon_get()
6415     */
6416    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6417
6418    /**
6419     * Get the icon set for a given file selector button widget
6420     *
6421     * @param obj The file selector button widget
6422     * @return The icon object currently set on @p obj or @c NULL, if
6423     * none is
6424     *
6425     * @see elm_fileselector_button_icon_set()
6426     */
6427    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6428
6429    /**
6430     * Unset the icon used in a given file selector button widget
6431     *
6432     * @param obj The file selector button widget
6433     * @return The icon object that was being used on @p obj or @c
6434     * NULL, on errors
6435     *
6436     * Unparent and return the icon object which was set for this
6437     * widget.
6438     *
6439     * @see elm_fileselector_button_icon_set()
6440     */
6441    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6442
6443    /**
6444     * Set the title for a given file selector button widget's window
6445     *
6446     * @param obj The file selector button widget
6447     * @param title The title string
6448     *
6449     * This will change the window's title, when the file selector pops
6450     * out after a click on the button. Those windows have the default
6451     * (unlocalized) value of @c "Select a file" as titles.
6452     *
6453     * @note It will only take any effect if the file selector
6454     * button widget is @b not under "inwin mode".
6455     *
6456     * @see elm_fileselector_button_window_title_get()
6457     */
6458    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6459
6460    /**
6461     * Get the title set for a given file selector button widget's
6462     * window
6463     *
6464     * @param obj The file selector button widget
6465     * @return Title of the file selector button's window
6466     *
6467     * @see elm_fileselector_button_window_title_get() for more details
6468     */
6469    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6470
6471    /**
6472     * Set the size of a given file selector button widget's window,
6473     * holding the file selector itself.
6474     *
6475     * @param obj The file selector button widget
6476     * @param width The window's width
6477     * @param height The window's height
6478     *
6479     * @note it will only take any effect if the file selector button
6480     * widget is @b not under "inwin mode". The default size for the
6481     * window (when applicable) is 400x400 pixels.
6482     *
6483     * @see elm_fileselector_button_window_size_get()
6484     */
6485    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6486
6487    /**
6488     * Get the size of a given file selector button widget's window,
6489     * holding the file selector itself.
6490     *
6491     * @param obj The file selector button widget
6492     * @param width Pointer into which to store the width value
6493     * @param height Pointer into which to store the height value
6494     *
6495     * @note Use @c NULL pointers on the size values you're not
6496     * interested in: they'll be ignored by the function.
6497     *
6498     * @see elm_fileselector_button_window_size_set(), for more details
6499     */
6500    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6501
6502    /**
6503     * Set the initial file system path for a given file selector
6504     * button widget
6505     *
6506     * @param obj The file selector button widget
6507     * @param path The path string
6508     *
6509     * It must be a <b>directory</b> path, which will have the contents
6510     * displayed initially in the file selector's view, when invoked
6511     * from @p obj. The default initial path is the @c "HOME"
6512     * environment variable's value.
6513     *
6514     * @see elm_fileselector_button_path_get()
6515     */
6516    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6517
6518    /**
6519     * Get the initial file system path set for a given file selector
6520     * button widget
6521     *
6522     * @param obj The file selector button widget
6523     * @return path The path string
6524     *
6525     * @see elm_fileselector_button_path_set() for more details
6526     */
6527    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6528
6529    /**
6530     * Enable/disable a tree view in the given file selector button
6531     * widget's internal file selector
6532     *
6533     * @param obj The file selector button widget
6534     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6535     * disable
6536     *
6537     * This has the same effect as elm_fileselector_expandable_set(),
6538     * but now applied to a file selector button's internal file
6539     * selector.
6540     *
6541     * @note There's no way to put a file selector button's internal
6542     * file selector in "grid mode", as one may do with "pure" file
6543     * selectors.
6544     *
6545     * @see elm_fileselector_expandable_get()
6546     */
6547    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6548
6549    /**
6550     * Get whether tree view is enabled for the given file selector
6551     * button widget's internal file selector
6552     *
6553     * @param obj The file selector button widget
6554     * @return @c EINA_TRUE if @p obj widget's internal file selector
6555     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6556     *
6557     * @see elm_fileselector_expandable_set() for more details
6558     */
6559    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6560
6561    /**
6562     * Set whether a given file selector button widget's internal file
6563     * selector is to display folders only or the directory contents,
6564     * as well.
6565     *
6566     * @param obj The file selector button widget
6567     * @param only @c EINA_TRUE to make @p obj widget's internal file
6568     * selector only display directories, @c EINA_FALSE to make files
6569     * to be displayed in it too
6570     *
6571     * This has the same effect as elm_fileselector_folder_only_set(),
6572     * but now applied to a file selector button's internal file
6573     * selector.
6574     *
6575     * @see elm_fileselector_folder_only_get()
6576     */
6577    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6578
6579    /**
6580     * Get whether a given file selector button widget's internal file
6581     * selector is displaying folders only or the directory contents,
6582     * as well.
6583     *
6584     * @param obj The file selector button widget
6585     * @return @c EINA_TRUE if @p obj widget's internal file
6586     * selector is only displaying directories, @c EINA_FALSE if files
6587     * are being displayed in it too (and on errors)
6588     *
6589     * @see elm_fileselector_button_folder_only_set() for more details
6590     */
6591    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6592
6593    /**
6594     * Enable/disable the file name entry box where the user can type
6595     * in a name for a file, in a given file selector button widget's
6596     * internal file selector.
6597     *
6598     * @param obj The file selector button widget
6599     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6600     * file selector a "saving dialog", @c EINA_FALSE otherwise
6601     *
6602     * This has the same effect as elm_fileselector_is_save_set(),
6603     * but now applied to a file selector button's internal file
6604     * selector.
6605     *
6606     * @see elm_fileselector_is_save_get()
6607     */
6608    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6609
6610    /**
6611     * Get whether the given file selector button widget's internal
6612     * file selector is in "saving dialog" mode
6613     *
6614     * @param obj The file selector button widget
6615     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6616     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6617     * errors)
6618     *
6619     * @see elm_fileselector_button_is_save_set() for more details
6620     */
6621    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6622
6623    /**
6624     * Set whether a given file selector button widget's internal file
6625     * selector will raise an Elementary "inner window", instead of a
6626     * dedicated Elementary window. By default, it won't.
6627     *
6628     * @param obj The file selector button widget
6629     * @param value @c EINA_TRUE to make it use an inner window, @c
6630     * EINA_TRUE to make it use a dedicated window
6631     *
6632     * @see elm_win_inwin_add() for more information on inner windows
6633     * @see elm_fileselector_button_inwin_mode_get()
6634     */
6635    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6636
6637    /**
6638     * Get whether a given file selector button widget's internal file
6639     * selector will raise an Elementary "inner window", instead of a
6640     * dedicated Elementary window.
6641     *
6642     * @param obj The file selector button widget
6643     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6644     * if it will use a dedicated window
6645     *
6646     * @see elm_fileselector_button_inwin_mode_set() for more details
6647     */
6648    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6649
6650    /**
6651     * @}
6652     */
6653
6654     /**
6655     * @defgroup File_Selector_Entry File Selector Entry
6656     *
6657     * @image html img/widget/fileselector_entry/preview-00.png
6658     * @image latex img/widget/fileselector_entry/preview-00.eps
6659     *
6660     * This is an entry made to be filled with or display a <b>file
6661     * system path string</b>. Besides the entry itself, the widget has
6662     * a @ref File_Selector_Button "file selector button" on its side,
6663     * which will raise an internal @ref Fileselector "file selector widget",
6664     * when clicked, for path selection aided by file system
6665     * navigation.
6666     *
6667     * This file selector may appear in an Elementary window or in an
6668     * inner window. When a file is chosen from it, the (inner) window
6669     * is closed and the selected file's path string is exposed both as
6670     * an smart event and as the new text on the entry.
6671     *
6672     * This widget encapsulates operations on its internal file
6673     * selector on its own API. There is less control over its file
6674     * selector than that one would have instatiating one directly.
6675     *
6676     * Smart callbacks one can register to:
6677     * - @c "changed" - The text within the entry was changed
6678     * - @c "activated" - The entry has had editing finished and
6679     *   changes are to be "committed"
6680     * - @c "press" - The entry has been clicked
6681     * - @c "longpressed" - The entry has been clicked (and held) for a
6682     *   couple seconds
6683     * - @c "clicked" - The entry has been clicked
6684     * - @c "clicked,double" - The entry has been double clicked
6685     * - @c "focused" - The entry has received focus
6686     * - @c "unfocused" - The entry has lost focus
6687     * - @c "selection,paste" - A paste action has occurred on the
6688     *   entry
6689     * - @c "selection,copy" - A copy action has occurred on the entry
6690     * - @c "selection,cut" - A cut action has occurred on the entry
6691     * - @c "unpressed" - The file selector entry's button was released
6692     *   after being pressed.
6693     * - @c "file,chosen" - The user has selected a path via the file
6694     *   selector entry's internal file selector, whose string pointer
6695     *   comes as the @c event_info data (a stringshared string)
6696     *
6697     * Here is an example on its usage:
6698     * @li @ref fileselector_entry_example
6699     *
6700     * @see @ref File_Selector_Button for a similar widget.
6701     * @{
6702     */
6703
6704    /**
6705     * Add a new file selector entry widget to the given parent
6706     * Elementary (container) object
6707     *
6708     * @param parent The parent object
6709     * @return a new file selector entry widget handle or @c NULL, on
6710     * errors
6711     */
6712    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6713
6714    /**
6715     * Set the label for a given file selector entry widget's button
6716     *
6717     * @param obj The file selector entry widget
6718     * @param label The text label to be displayed on @p obj widget's
6719     * button
6720     *
6721     * @deprecated use elm_object_text_set() instead.
6722     */
6723    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6724
6725    /**
6726     * Get the label set for a given file selector entry widget's button
6727     *
6728     * @param obj The file selector entry widget
6729     * @return The widget button's label
6730     *
6731     * @deprecated use elm_object_text_set() instead.
6732     */
6733    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6734
6735    /**
6736     * Set the icon on a given file selector entry widget's button
6737     *
6738     * @param obj The file selector entry widget
6739     * @param icon The icon object for the entry's button
6740     *
6741     * Once the icon object is set, a previously set one will be
6742     * deleted. If you want to keep the latter, use the
6743     * elm_fileselector_entry_button_icon_unset() function.
6744     *
6745     * @see elm_fileselector_entry_button_icon_get()
6746     */
6747    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6748
6749    /**
6750     * Get the icon set for a given file selector entry widget's button
6751     *
6752     * @param obj The file selector entry widget
6753     * @return The icon object currently set on @p obj widget's button
6754     * or @c NULL, if none is
6755     *
6756     * @see elm_fileselector_entry_button_icon_set()
6757     */
6758    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6759
6760    /**
6761     * Unset the icon used in a given file selector entry widget's
6762     * button
6763     *
6764     * @param obj The file selector entry widget
6765     * @return The icon object that was being used on @p obj widget's
6766     * button or @c NULL, on errors
6767     *
6768     * Unparent and return the icon object which was set for this
6769     * widget's button.
6770     *
6771     * @see elm_fileselector_entry_button_icon_set()
6772     */
6773    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6774
6775    /**
6776     * Set the title for a given file selector entry widget's window
6777     *
6778     * @param obj The file selector entry widget
6779     * @param title The title string
6780     *
6781     * This will change the window's title, when the file selector pops
6782     * out after a click on the entry's button. Those windows have the
6783     * default (unlocalized) value of @c "Select a file" as titles.
6784     *
6785     * @note It will only take any effect if the file selector
6786     * entry widget is @b not under "inwin mode".
6787     *
6788     * @see elm_fileselector_entry_window_title_get()
6789     */
6790    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6791
6792    /**
6793     * Get the title set for a given file selector entry widget's
6794     * window
6795     *
6796     * @param obj The file selector entry widget
6797     * @return Title of the file selector entry's window
6798     *
6799     * @see elm_fileselector_entry_window_title_get() for more details
6800     */
6801    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6802
6803    /**
6804     * Set the size of a given file selector entry widget's window,
6805     * holding the file selector itself.
6806     *
6807     * @param obj The file selector entry widget
6808     * @param width The window's width
6809     * @param height The window's height
6810     *
6811     * @note it will only take any effect if the file selector entry
6812     * widget is @b not under "inwin mode". The default size for the
6813     * window (when applicable) is 400x400 pixels.
6814     *
6815     * @see elm_fileselector_entry_window_size_get()
6816     */
6817    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6818
6819    /**
6820     * Get the size of a given file selector entry widget's window,
6821     * holding the file selector itself.
6822     *
6823     * @param obj The file selector entry widget
6824     * @param width Pointer into which to store the width value
6825     * @param height Pointer into which to store the height value
6826     *
6827     * @note Use @c NULL pointers on the size values you're not
6828     * interested in: they'll be ignored by the function.
6829     *
6830     * @see elm_fileselector_entry_window_size_set(), for more details
6831     */
6832    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6833
6834    /**
6835     * Set the initial file system path and the entry's path string for
6836     * a given file selector entry widget
6837     *
6838     * @param obj The file selector entry widget
6839     * @param path The path string
6840     *
6841     * It must be a <b>directory</b> path, which will have the contents
6842     * displayed initially in the file selector's view, when invoked
6843     * from @p obj. The default initial path is the @c "HOME"
6844     * environment variable's value.
6845     *
6846     * @see elm_fileselector_entry_path_get()
6847     */
6848    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6849
6850    /**
6851     * Get the entry's path string for a given file selector entry
6852     * widget
6853     *
6854     * @param obj The file selector entry widget
6855     * @return path The path string
6856     *
6857     * @see elm_fileselector_entry_path_set() for more details
6858     */
6859    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6860
6861    /**
6862     * Enable/disable a tree view in the given file selector entry
6863     * widget's internal file selector
6864     *
6865     * @param obj The file selector entry widget
6866     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6867     * disable
6868     *
6869     * This has the same effect as elm_fileselector_expandable_set(),
6870     * but now applied to a file selector entry's internal file
6871     * selector.
6872     *
6873     * @note There's no way to put a file selector entry's internal
6874     * file selector in "grid mode", as one may do with "pure" file
6875     * selectors.
6876     *
6877     * @see elm_fileselector_expandable_get()
6878     */
6879    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6880
6881    /**
6882     * Get whether tree view is enabled for the given file selector
6883     * entry widget's internal file selector
6884     *
6885     * @param obj The file selector entry widget
6886     * @return @c EINA_TRUE if @p obj widget's internal file selector
6887     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6888     *
6889     * @see elm_fileselector_expandable_set() for more details
6890     */
6891    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6892
6893    /**
6894     * Set whether a given file selector entry widget's internal file
6895     * selector is to display folders only or the directory contents,
6896     * as well.
6897     *
6898     * @param obj The file selector entry widget
6899     * @param only @c EINA_TRUE to make @p obj widget's internal file
6900     * selector only display directories, @c EINA_FALSE to make files
6901     * to be displayed in it too
6902     *
6903     * This has the same effect as elm_fileselector_folder_only_set(),
6904     * but now applied to a file selector entry's internal file
6905     * selector.
6906     *
6907     * @see elm_fileselector_folder_only_get()
6908     */
6909    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6910
6911    /**
6912     * Get whether a given file selector entry widget's internal file
6913     * selector is displaying folders only or the directory contents,
6914     * as well.
6915     *
6916     * @param obj The file selector entry widget
6917     * @return @c EINA_TRUE if @p obj widget's internal file
6918     * selector is only displaying directories, @c EINA_FALSE if files
6919     * are being displayed in it too (and on errors)
6920     *
6921     * @see elm_fileselector_entry_folder_only_set() for more details
6922     */
6923    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6924
6925    /**
6926     * Enable/disable the file name entry box where the user can type
6927     * in a name for a file, in a given file selector entry widget's
6928     * internal file selector.
6929     *
6930     * @param obj The file selector entry widget
6931     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6932     * file selector a "saving dialog", @c EINA_FALSE otherwise
6933     *
6934     * This has the same effect as elm_fileselector_is_save_set(),
6935     * but now applied to a file selector entry's internal file
6936     * selector.
6937     *
6938     * @see elm_fileselector_is_save_get()
6939     */
6940    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6941
6942    /**
6943     * Get whether the given file selector entry widget's internal
6944     * file selector is in "saving dialog" mode
6945     *
6946     * @param obj The file selector entry widget
6947     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6948     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6949     * errors)
6950     *
6951     * @see elm_fileselector_entry_is_save_set() for more details
6952     */
6953    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6954
6955    /**
6956     * Set whether a given file selector entry widget's internal file
6957     * selector will raise an Elementary "inner window", instead of a
6958     * dedicated Elementary window. By default, it won't.
6959     *
6960     * @param obj The file selector entry widget
6961     * @param value @c EINA_TRUE to make it use an inner window, @c
6962     * EINA_TRUE to make it use a dedicated window
6963     *
6964     * @see elm_win_inwin_add() for more information on inner windows
6965     * @see elm_fileselector_entry_inwin_mode_get()
6966     */
6967    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6968
6969    /**
6970     * Get whether a given file selector entry widget's internal file
6971     * selector will raise an Elementary "inner window", instead of a
6972     * dedicated Elementary window.
6973     *
6974     * @param obj The file selector entry widget
6975     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6976     * if it will use a dedicated window
6977     *
6978     * @see elm_fileselector_entry_inwin_mode_set() for more details
6979     */
6980    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6981
6982    /**
6983     * Set the initial file system path for a given file selector entry
6984     * widget
6985     *
6986     * @param obj The file selector entry widget
6987     * @param path The path string
6988     *
6989     * It must be a <b>directory</b> path, which will have the contents
6990     * displayed initially in the file selector's view, when invoked
6991     * from @p obj. The default initial path is the @c "HOME"
6992     * environment variable's value.
6993     *
6994     * @see elm_fileselector_entry_path_get()
6995     */
6996    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6997
6998    /**
6999     * Get the parent directory's path to the latest file selection on
7000     * a given filer selector entry widget
7001     *
7002     * @param obj The file selector object
7003     * @return The (full) path of the directory of the last selection
7004     * on @p obj widget, a @b stringshared string
7005     *
7006     * @see elm_fileselector_entry_path_set()
7007     */
7008    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7009
7010    /**
7011     * @}
7012     */
7013
7014    /**
7015     * @defgroup Scroller Scroller
7016     *
7017     * A scroller holds a single object and "scrolls it around". This means that
7018     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7019     * region around, allowing to move through a much larger object that is
7020     * contained in the scroller. The scroller will always have a small minimum
7021     * size by default as it won't be limited by the contents of the scroller.
7022     *
7023     * Signals that you can add callbacks for are:
7024     * @li "edge,left" - the left edge of the content has been reached
7025     * @li "edge,right" - the right edge of the content has been reached
7026     * @li "edge,top" - the top edge of the content has been reached
7027     * @li "edge,bottom" - the bottom edge of the content has been reached
7028     * @li "scroll" - the content has been scrolled (moved)
7029     * @li "scroll,anim,start" - scrolling animation has started
7030     * @li "scroll,anim,stop" - scrolling animation has stopped
7031     * @li "scroll,drag,start" - dragging the contents around has started
7032     * @li "scroll,drag,stop" - dragging the contents around has stopped
7033     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7034     * user intervetion.
7035     *
7036     * @note When Elemementary is in embedded mode the scrollbars will not be
7037     * dragable, they appear merely as indicators of how much has been scrolled.
7038     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7039     * fingerscroll) won't work.
7040     *
7041     * Default contents parts of the scroller widget that you can use for are:
7042     * @li "default" - A content of the scroller
7043     *
7044     * In @ref tutorial_scroller you'll find an example of how to use most of
7045     * this API.
7046     * @{
7047     */
7048    /**
7049     * @brief Type that controls when scrollbars should appear.
7050     *
7051     * @see elm_scroller_policy_set()
7052     */
7053    typedef enum _Elm_Scroller_Policy
7054      {
7055         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7056         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7057         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7058         ELM_SCROLLER_POLICY_LAST
7059      } Elm_Scroller_Policy;
7060    /**
7061     * @brief Add a new scroller to the parent
7062     *
7063     * @param parent The parent object
7064     * @return The new object or NULL if it cannot be created
7065     */
7066    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7067    /**
7068     * @brief Set the content of the scroller widget (the object to be scrolled around).
7069     *
7070     * @param obj The scroller object
7071     * @param content The new content object
7072     *
7073     * Once the content object is set, a previously set one will be deleted.
7074     * If you want to keep that old content object, use the
7075     * elm_scroller_content_unset() function.
7076     * @deprecated use elm_object_content_set() instead
7077     */
7078    EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7079    /**
7080     * @brief Get the content of the scroller widget
7081     *
7082     * @param obj The slider object
7083     * @return The content that is being used
7084     *
7085     * Return the content object which is set for this widget
7086     *
7087     * @see elm_scroller_content_set()
7088     * @deprecated use elm_object_content_get() instead.
7089     */
7090    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7091    /**
7092     * @brief Unset the content of the scroller widget
7093     *
7094     * @param obj The slider object
7095     * @return The content that was being used
7096     *
7097     * Unparent and return the content object which was set for this widget
7098     *
7099     * @see elm_scroller_content_set()
7100     * @deprecated use elm_object_content_unset() instead.
7101     */
7102    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7103    /**
7104     * @brief Set custom theme elements for the scroller
7105     *
7106     * @param obj The scroller object
7107     * @param widget The widget name to use (default is "scroller")
7108     * @param base The base name to use (default is "base")
7109     */
7110    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7111    /**
7112     * @brief Make the scroller minimum size limited to the minimum size of the content
7113     *
7114     * @param obj The scroller object
7115     * @param w Enable limiting minimum size horizontally
7116     * @param h Enable limiting minimum size vertically
7117     *
7118     * By default the scroller will be as small as its design allows,
7119     * irrespective of its content. This will make the scroller minimum size the
7120     * right size horizontally and/or vertically to perfectly fit its content in
7121     * that direction.
7122     */
7123    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7124    /**
7125     * @brief Show a specific virtual region within the scroller content object
7126     *
7127     * @param obj The scroller object
7128     * @param x X coordinate of the region
7129     * @param y Y coordinate of the region
7130     * @param w Width of the region
7131     * @param h Height of the region
7132     *
7133     * This will ensure all (or part if it does not fit) of the designated
7134     * region in the virtual content object (0, 0 starting at the top-left of the
7135     * virtual content object) is shown within the scroller.
7136     */
7137    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);
7138    /**
7139     * @brief Set the scrollbar visibility policy
7140     *
7141     * @param obj The scroller object
7142     * @param policy_h Horizontal scrollbar policy
7143     * @param policy_v Vertical scrollbar policy
7144     *
7145     * This sets the scrollbar visibility policy for the given scroller.
7146     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7147     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7148     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7149     * respectively for the horizontal and vertical scrollbars.
7150     */
7151    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7152    /**
7153     * @brief Gets scrollbar visibility policy
7154     *
7155     * @param obj The scroller object
7156     * @param policy_h Horizontal scrollbar policy
7157     * @param policy_v Vertical scrollbar policy
7158     *
7159     * @see elm_scroller_policy_set()
7160     */
7161    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7162    /**
7163     * @brief Get the currently visible content region
7164     *
7165     * @param obj The scroller object
7166     * @param x X coordinate of the region
7167     * @param y Y coordinate of the region
7168     * @param w Width of the region
7169     * @param h Height of the region
7170     *
7171     * This gets the current region in the content object that is visible through
7172     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7173     * w, @p h values pointed to.
7174     *
7175     * @note All coordinates are relative to the content.
7176     *
7177     * @see elm_scroller_region_show()
7178     */
7179    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);
7180    /**
7181     * @brief Get the size of the content object
7182     *
7183     * @param obj The scroller object
7184     * @param w Width of the content object.
7185     * @param h Height of the content object.
7186     *
7187     * This gets the size of the content object of the scroller.
7188     */
7189    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7190    /**
7191     * @brief Set bouncing behavior
7192     *
7193     * @param obj The scroller object
7194     * @param h_bounce Allow bounce horizontally
7195     * @param v_bounce Allow bounce vertically
7196     *
7197     * When scrolling, the scroller may "bounce" when reaching an edge of the
7198     * content object. This is a visual way to indicate the end has been reached.
7199     * This is enabled by default for both axis. This API will set if it is enabled
7200     * for the given axis with the boolean parameters for each axis.
7201     */
7202    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7203    /**
7204     * @brief Get the bounce behaviour
7205     *
7206     * @param obj The Scroller object
7207     * @param h_bounce Will the scroller bounce horizontally or not
7208     * @param v_bounce Will the scroller bounce vertically or not
7209     *
7210     * @see elm_scroller_bounce_set()
7211     */
7212    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7213    /**
7214     * @brief Set scroll page size relative to viewport size.
7215     *
7216     * @param obj The scroller object
7217     * @param h_pagerel The horizontal page relative size
7218     * @param v_pagerel The vertical page relative size
7219     *
7220     * The scroller is capable of limiting scrolling by the user to "pages". That
7221     * is to jump by and only show a "whole page" at a time as if the continuous
7222     * area of the scroller content is split into page sized pieces. This sets
7223     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7224     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7225     * axis. This is mutually exclusive with page size
7226     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7227     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7228     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7229     * the other axis.
7230     */
7231    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7232    /**
7233     * @brief Set scroll page size.
7234     *
7235     * @param obj The scroller object
7236     * @param h_pagesize The horizontal page size
7237     * @param v_pagesize The vertical page size
7238     *
7239     * This sets the page size to an absolute fixed value, with 0 turning it off
7240     * for that axis.
7241     *
7242     * @see elm_scroller_page_relative_set()
7243     */
7244    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7245    /**
7246     * @brief Get scroll current page number.
7247     *
7248     * @param obj The scroller object
7249     * @param h_pagenumber The horizontal page number
7250     * @param v_pagenumber The vertical page number
7251     *
7252     * The page number starts from 0. 0 is the first page.
7253     * Current page means the page which meets the top-left of the viewport.
7254     * If there are two or more pages in the viewport, it returns the number of the page
7255     * which meets the top-left of the viewport.
7256     *
7257     * @see elm_scroller_last_page_get()
7258     * @see elm_scroller_page_show()
7259     * @see elm_scroller_page_brint_in()
7260     */
7261    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7262    /**
7263     * @brief Get scroll last 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     * The page number starts from 0. 0 is the first page.
7270     * This returns the last page number among the pages.
7271     *
7272     * @see elm_scroller_current_page_get()
7273     * @see elm_scroller_page_show()
7274     * @see elm_scroller_page_brint_in()
7275     */
7276    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7277    /**
7278     * Show a specific virtual region within the scroller content object by page number.
7279     *
7280     * @param obj The scroller object
7281     * @param h_pagenumber The horizontal page number
7282     * @param v_pagenumber The vertical page number
7283     *
7284     * 0, 0 of the indicated page is located at the top-left of the viewport.
7285     * This will jump to the page directly without animation.
7286     *
7287     * Example of usage:
7288     *
7289     * @code
7290     * sc = elm_scroller_add(win);
7291     * elm_scroller_content_set(sc, content);
7292     * elm_scroller_page_relative_set(sc, 1, 0);
7293     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7294     * elm_scroller_page_show(sc, h_page + 1, v_page);
7295     * @endcode
7296     *
7297     * @see elm_scroller_page_bring_in()
7298     */
7299    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7300    /**
7301     * Show a specific virtual region within the scroller content object by page number.
7302     *
7303     * @param obj The scroller object
7304     * @param h_pagenumber The horizontal page number
7305     * @param v_pagenumber The vertical page number
7306     *
7307     * 0, 0 of the indicated page is located at the top-left of the viewport.
7308     * This will slide to the page with animation.
7309     *
7310     * Example of usage:
7311     *
7312     * @code
7313     * sc = elm_scroller_add(win);
7314     * elm_scroller_content_set(sc, content);
7315     * elm_scroller_page_relative_set(sc, 1, 0);
7316     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7317     * elm_scroller_page_bring_in(sc, h_page, v_page);
7318     * @endcode
7319     *
7320     * @see elm_scroller_page_show()
7321     */
7322    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7323    /**
7324     * @brief Show a specific virtual region within the scroller content object.
7325     *
7326     * @param obj The scroller object
7327     * @param x X coordinate of the region
7328     * @param y Y coordinate of the region
7329     * @param w Width of the region
7330     * @param h Height of the region
7331     *
7332     * This will ensure all (or part if it does not fit) of the designated
7333     * region in the virtual content object (0, 0 starting at the top-left of the
7334     * virtual content object) is shown within the scroller. Unlike
7335     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7336     * to this location (if configuration in general calls for transitions). It
7337     * may not jump immediately to the new location and make take a while and
7338     * show other content along the way.
7339     *
7340     * @see elm_scroller_region_show()
7341     */
7342    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);
7343    /**
7344     * @brief Set event propagation on a scroller
7345     *
7346     * @param obj The scroller object
7347     * @param propagation If propagation is enabled or not
7348     *
7349     * This enables or disabled event propagation from the scroller content to
7350     * the scroller and its parent. By default event propagation is disabled.
7351     */
7352    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7353    /**
7354     * @brief Get event propagation for a scroller
7355     *
7356     * @param obj The scroller object
7357     * @return The propagation state
7358     *
7359     * This gets the event propagation for a scroller.
7360     *
7361     * @see elm_scroller_propagate_events_set()
7362     */
7363    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7364    /**
7365     * @brief Set scrolling gravity on a scroller
7366     *
7367     * @param obj The scroller object
7368     * @param x The scrolling horizontal gravity
7369     * @param y The scrolling vertical gravity
7370     *
7371     * The gravity, defines how the scroller will adjust its view
7372     * when the size of the scroller contents increase.
7373     *
7374     * The scroller will adjust the view to glue itself as follows.
7375     *
7376     *  x=0.0, for showing the left most region of the content.
7377     *  x=1.0, for showing the right most region of the content.
7378     *  y=0.0, for showing the bottom most region of the content.
7379     *  y=1.0, for showing the top most region of the content.
7380     *
7381     * Default values for x and y are 0.0
7382     */
7383    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7384    /**
7385     * @brief Get scrolling gravity values for a scroller
7386     *
7387     * @param obj The scroller object
7388     * @param x The scrolling horizontal gravity
7389     * @param y The scrolling vertical gravity
7390     *
7391     * This gets gravity values for a scroller.
7392     *
7393     * @see elm_scroller_gravity_set()
7394     *
7395     */
7396    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7397    /**
7398     * @}
7399     */
7400
7401    /**
7402     * @defgroup Label Label
7403     *
7404     * @image html img/widget/label/preview-00.png
7405     * @image latex img/widget/label/preview-00.eps
7406     *
7407     * @brief Widget to display text, with simple html-like markup.
7408     *
7409     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7410     * text doesn't fit the geometry of the label it will be ellipsized or be
7411     * cut. Elementary provides several styles for this widget:
7412     * @li default - No animation
7413     * @li marker - Centers the text in the label and make it bold by default
7414     * @li slide_long - The entire text appears from the right of the screen and
7415     * slides until it disappears in the left of the screen(reappering on the
7416     * right again).
7417     * @li slide_short - The text appears in the left of the label and slides to
7418     * the right to show the overflow. When all of the text has been shown the
7419     * position is reset.
7420     * @li slide_bounce - The text appears in the left of the label and slides to
7421     * the right to show the overflow. When all of the text has been shown the
7422     * animation reverses, moving the text to the left.
7423     *
7424     * Custom themes can of course invent new markup tags and style them any way
7425     * they like.
7426     *
7427     * The following signals may be emitted by the label widget:
7428     * @li "language,changed": The program's language changed.
7429     *
7430     * See @ref tutorial_label for a demonstration of how to use a label widget.
7431     * @{
7432     */
7433    /**
7434     * @brief Add a new label to the parent
7435     *
7436     * @param parent The parent object
7437     * @return The new object or NULL if it cannot be created
7438     */
7439    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7440    /**
7441     * @brief Set the label on the label object
7442     *
7443     * @param obj The label object
7444     * @param label The label will be used on the label object
7445     * @deprecated See elm_object_text_set()
7446     */
7447    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 */
7448    /**
7449     * @brief Get the label used on the label object
7450     *
7451     * @param obj The label object
7452     * @return The string inside the label
7453     * @deprecated See elm_object_text_get()
7454     */
7455    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7456    /**
7457     * @brief Set the wrapping behavior of the label
7458     *
7459     * @param obj The label object
7460     * @param wrap To wrap text or not
7461     *
7462     * By default no wrapping is done. Possible values for @p wrap are:
7463     * @li ELM_WRAP_NONE - No wrapping
7464     * @li ELM_WRAP_CHAR - wrap between characters
7465     * @li ELM_WRAP_WORD - wrap between words
7466     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7467     */
7468    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7469    /**
7470     * @brief Get the wrapping behavior of the label
7471     *
7472     * @param obj The label object
7473     * @return Wrap type
7474     *
7475     * @see elm_label_line_wrap_set()
7476     */
7477    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7478    /**
7479     * @brief Set wrap width of the label
7480     *
7481     * @param obj The label object
7482     * @param w The wrap width in pixels at a minimum where words need to wrap
7483     *
7484     * This function sets the maximum width size hint of the label.
7485     *
7486     * @warning This is only relevant if the label is inside a container.
7487     */
7488    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7489    /**
7490     * @brief Get wrap width of the label
7491     *
7492     * @param obj The label object
7493     * @return The wrap width in pixels at a minimum where words need to wrap
7494     *
7495     * @see elm_label_wrap_width_set()
7496     */
7497    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7498    /**
7499     * @brief Set wrap height of the label
7500     *
7501     * @param obj The label object
7502     * @param h The wrap height in pixels at a minimum where words need to wrap
7503     *
7504     * This function sets the maximum height size hint of the label.
7505     *
7506     * @warning This is only relevant if the label is inside a container.
7507     */
7508    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7509    /**
7510     * @brief get wrap width of the label
7511     *
7512     * @param obj The label object
7513     * @return The wrap height in pixels at a minimum where words need to wrap
7514     */
7515    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7516    /**
7517     * @brief Set the font size on the label object.
7518     *
7519     * @param obj The label object
7520     * @param size font size
7521     *
7522     * @warning NEVER use this. It is for hyper-special cases only. use styles
7523     * instead. e.g. "default", "marker", "slide_long" etc.
7524     */
7525    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7526    /**
7527     * @brief Set the text color on the label object
7528     *
7529     * @param obj The label object
7530     * @param r Red property background color of The label object
7531     * @param g Green property background color of The label object
7532     * @param b Blue property background color of The label object
7533     * @param a Alpha property background color of The label object
7534     *
7535     * @warning NEVER use this. It is for hyper-special cases only. use styles
7536     * instead. e.g. "default", "marker", "slide_long" etc.
7537     */
7538    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);
7539    /**
7540     * @brief Set the text align on the label object
7541     *
7542     * @param obj The label object
7543     * @param align align mode ("left", "center", "right")
7544     *
7545     * @warning NEVER use this. It is for hyper-special cases only. use styles
7546     * instead. e.g. "default", "marker", "slide_long" etc.
7547     */
7548    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7549    /**
7550     * @brief Set background color of the label
7551     *
7552     * @param obj The label object
7553     * @param r Red property background color of The label object
7554     * @param g Green property background color of The label object
7555     * @param b Blue property background color of The label object
7556     * @param a Alpha property background alpha of The label object
7557     *
7558     * @warning NEVER use this. It is for hyper-special cases only. use styles
7559     * instead. e.g. "default", "marker", "slide_long" etc.
7560     */
7561    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);
7562    /**
7563     * @brief Set the ellipsis behavior of the label
7564     *
7565     * @param obj The label object
7566     * @param ellipsis To ellipsis text or not
7567     *
7568     * If set to true and the text doesn't fit in the label an ellipsis("...")
7569     * will be shown at the end of the widget.
7570     *
7571     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7572     * choosen wrap method was ELM_WRAP_WORD.
7573     */
7574    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7575    /**
7576     * @brief Set the text slide of the label
7577     *
7578     * @param obj The label object
7579     * @param slide To start slide or stop
7580     *
7581     * If set to true, the text of the label will slide/scroll through the length of
7582     * label.
7583     *
7584     * @warning This only works with the themes "slide_short", "slide_long" and
7585     * "slide_bounce".
7586     */
7587    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7588    /**
7589     * @brief Get the text slide mode of the label
7590     *
7591     * @param obj The label object
7592     * @return slide slide mode value
7593     *
7594     * @see elm_label_slide_set()
7595     */
7596    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7597    /**
7598     * @brief Set the slide duration(speed) of the label
7599     *
7600     * @param obj The label object
7601     * @return The duration in seconds in moving text from slide begin position
7602     * to slide end position
7603     */
7604    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7605    /**
7606     * @brief Get the slide duration(speed) of the label
7607     *
7608     * @param obj The label object
7609     * @return The duration time in moving text from slide begin position to slide end position
7610     *
7611     * @see elm_label_slide_duration_set()
7612     */
7613    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7614    /**
7615     * @}
7616     */
7617
7618    /**
7619     * @defgroup Toggle Toggle
7620     *
7621     * @image html img/widget/toggle/preview-00.png
7622     * @image latex img/widget/toggle/preview-00.eps
7623     *
7624     * @brief A toggle is a slider which can be used to toggle between
7625     * two values.  It has two states: on and off.
7626     *
7627     * This widget is deprecated. Please use elm_check_add() instead using the
7628     * toggle style like:
7629     * 
7630     * @code
7631     * obj = elm_check_add(parent);
7632     * elm_object_style_set(obj, "toggle");
7633     * elm_object_part_text_set(obj, "on", "ON");
7634     * elm_object_part_text_set(obj, "off", "OFF");
7635     * @endcode
7636     * 
7637     * Signals that you can add callbacks for are:
7638     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7639     *                 until the toggle is released by the cursor (assuming it
7640     *                 has been triggered by the cursor in the first place).
7641     *
7642     * Default contents parts of the toggle widget that you can use for are:
7643     * @li "icon" - A icon of the toggle
7644     *
7645     * Default text parts of the toggle widget that you can use for are:
7646     * @li "elm.text" - Label of the toggle
7647     * 
7648     * @ref tutorial_toggle show how to use a toggle.
7649     * @{
7650     */
7651    /**
7652     * @brief Add a toggle to @p parent.
7653     *
7654     * @param parent The parent object
7655     *
7656     * @return The toggle object
7657     */
7658    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7659    /**
7660     * @brief Sets the label to be displayed with the toggle.
7661     *
7662     * @param obj The toggle object
7663     * @param label The label to be displayed
7664     *
7665     * @deprecated use elm_object_text_set() instead.
7666     */
7667    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7668    /**
7669     * @brief Gets the label of the toggle
7670     *
7671     * @param obj  toggle object
7672     * @return The label of the toggle
7673     *
7674     * @deprecated use elm_object_text_get() instead.
7675     */
7676    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7677    /**
7678     * @brief Set the icon used for the toggle
7679     *
7680     * @param obj The toggle object
7681     * @param icon The icon object for the button
7682     *
7683     * Once the icon object is set, a previously set one will be deleted
7684     * If you want to keep that old content object, use the
7685     * elm_toggle_icon_unset() function.
7686     *
7687     * @deprecated use elm_object_part_content_set() instead.
7688     */
7689    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7690    /**
7691     * @brief Get the icon used for the toggle
7692     *
7693     * @param obj The toggle object
7694     * @return The icon object that is being used
7695     *
7696     * Return the icon object which is set for this widget.
7697     *
7698     * @see elm_toggle_icon_set()
7699     *
7700     * @deprecated use elm_object_part_content_get() instead.
7701     */
7702    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7703    /**
7704     * @brief Unset the icon used for the toggle
7705     *
7706     * @param obj The toggle object
7707     * @return The icon object that was being used
7708     *
7709     * Unparent and return the icon object which was set for this widget.
7710     *
7711     * @see elm_toggle_icon_set()
7712     *
7713     * @deprecated use elm_object_part_content_unset() instead.
7714     */
7715    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7716    /**
7717     * @brief Sets the labels to be associated with the on and off states of the toggle.
7718     *
7719     * @param obj The toggle object
7720     * @param onlabel The label displayed when the toggle is in the "on" state
7721     * @param offlabel The label displayed when the toggle is in the "off" state
7722     *
7723     * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7724     * instead.
7725     */
7726    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7727    /**
7728     * @brief Gets the labels associated with the on and off states of the
7729     * toggle.
7730     *
7731     * @param obj The toggle object
7732     * @param onlabel A char** to place the onlabel of @p obj into
7733     * @param offlabel A char** to place the offlabel of @p obj into
7734     *
7735     * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7736     * instead.
7737     */
7738    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7739    /**
7740     * @brief Sets the state of the toggle to @p state.
7741     *
7742     * @param obj The toggle object
7743     * @param state The state of @p obj
7744     *
7745     * @deprecated use elm_check_state_set() instead.
7746     */
7747    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7748    /**
7749     * @brief Gets the state of the toggle to @p state.
7750     *
7751     * @param obj The toggle object
7752     * @return The state of @p obj
7753     *
7754     * @deprecated use elm_check_state_get() instead.
7755     */
7756    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7757    /**
7758     * @brief Sets the state pointer of the toggle to @p statep.
7759     *
7760     * @param obj The toggle object
7761     * @param statep The state pointer of @p obj
7762     *
7763     * @deprecated use elm_check_state_pointer_set() instead.
7764     */
7765    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7766    /**
7767     * @}
7768     */
7769
7770    /**
7771     * @defgroup Frame Frame
7772     *
7773     * @image html img/widget/frame/preview-00.png
7774     * @image latex img/widget/frame/preview-00.eps
7775     *
7776     * @brief Frame is a widget that holds some content and has a title.
7777     *
7778     * The default look is a frame with a title, but Frame supports multple
7779     * styles:
7780     * @li default
7781     * @li pad_small
7782     * @li pad_medium
7783     * @li pad_large
7784     * @li pad_huge
7785     * @li outdent_top
7786     * @li outdent_bottom
7787     *
7788     * Of all this styles only default shows the title. Frame emits no signals.
7789     *
7790     * Default contents parts of the frame widget that you can use for are:
7791     * @li "default" - A content of the frame
7792     *
7793     * Default text parts of the frame widget that you can use for are:
7794     * @li "elm.text" - Label of the frame
7795     *
7796     * For a detailed example see the @ref tutorial_frame.
7797     *
7798     * @{
7799     */
7800    /**
7801     * @brief Add a new frame to the parent
7802     *
7803     * @param parent The parent object
7804     * @return The new object or NULL if it cannot be created
7805     */
7806    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7807    /**
7808     * @brief Set the frame label
7809     *
7810     * @param obj The frame object
7811     * @param label The label of this frame object
7812     *
7813     * @deprecated use elm_object_text_set() instead.
7814     */
7815    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7816    /**
7817     * @brief Get the frame label
7818     *
7819     * @param obj The frame object
7820     *
7821     * @return The label of this frame objet or NULL if unable to get frame
7822     *
7823     * @deprecated use elm_object_text_get() instead.
7824     */
7825    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7826    /**
7827     * @brief Set the content of the frame widget
7828     *
7829     * Once the content object is set, a previously set one will be deleted.
7830     * If you want to keep that old content object, use the
7831     * elm_frame_content_unset() function.
7832     *
7833     * @param obj The frame object
7834     * @param content The content will be filled in this frame object
7835     *
7836     * @deprecated use elm_object_content_set() instead.
7837     */
7838    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7839    /**
7840     * @brief Get the content of the frame widget
7841     *
7842     * Return the content object which is set for this widget
7843     *
7844     * @param obj The frame object
7845     * @return The content that is being used
7846     *
7847     * @deprecated use elm_object_content_get() instead.
7848     */
7849    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7850    /**
7851     * @brief Unset the content of the frame widget
7852     *
7853     * Unparent and return the content object which was set for this widget
7854     *
7855     * @param obj The frame object
7856     * @return The content that was being used
7857     *
7858     * @deprecated use elm_object_content_unset() instead.
7859     */
7860    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7861    /**
7862     * @}
7863     */
7864
7865    /**
7866     * @defgroup Table Table
7867     *
7868     * A container widget to arrange other widgets in a table where items can
7869     * also span multiple columns or rows - even overlap (and then be raised or
7870     * lowered accordingly to adjust stacking if they do overlap).
7871     *
7872     * For a Table widget the row/column count is not fixed.
7873     * The table widget adjusts itself when subobjects are added to it dynamically.
7874     *
7875     * The followin are examples of how to use a table:
7876     * @li @ref tutorial_table_01
7877     * @li @ref tutorial_table_02
7878     *
7879     * @{
7880     */
7881    /**
7882     * @brief Add a new table to the parent
7883     *
7884     * @param parent The parent object
7885     * @return The new object or NULL if it cannot be created
7886     */
7887    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7888    /**
7889     * @brief Set the homogeneous layout in the table
7890     *
7891     * @param obj The layout object
7892     * @param homogeneous A boolean to set if the layout is homogeneous in the
7893     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7894     */
7895    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7896    /**
7897     * @brief Get the current table homogeneous mode.
7898     *
7899     * @param obj The table object
7900     * @return A boolean to indicating if the layout is homogeneous in the table
7901     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7902     */
7903    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7904    /**
7905     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7906     */
7907    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7908    /**
7909     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7910     */
7911    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7912    /**
7913     * @brief Set padding between cells.
7914     *
7915     * @param obj The layout object.
7916     * @param horizontal set the horizontal padding.
7917     * @param vertical set the vertical padding.
7918     *
7919     * Default value is 0.
7920     */
7921    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7922    /**
7923     * @brief Get padding between cells.
7924     *
7925     * @param obj The layout object.
7926     * @param horizontal set the horizontal padding.
7927     * @param vertical set the vertical padding.
7928     */
7929    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7930    /**
7931     * @brief Add a subobject on the table with the coordinates passed
7932     *
7933     * @param obj The table object
7934     * @param subobj The subobject to be added to the table
7935     * @param x Row number
7936     * @param y Column number
7937     * @param w rowspan
7938     * @param h colspan
7939     *
7940     * @note All positioning inside the table is relative to rows and columns, so
7941     * a value of 0 for x and y, means the top left cell of the table, and a
7942     * value of 1 for w and h means @p subobj only takes that 1 cell.
7943     */
7944    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7945    /**
7946     * @brief Remove child from table.
7947     *
7948     * @param obj The table object
7949     * @param subobj The subobject
7950     */
7951    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7952    /**
7953     * @brief Faster way to remove all child objects from a table object.
7954     *
7955     * @param obj The table object
7956     * @param clear If true, will delete children, else just remove from table.
7957     */
7958    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7959    /**
7960     * @brief Set the packing location of an existing child of the table
7961     *
7962     * @param subobj The subobject to be modified in the table
7963     * @param x Row number
7964     * @param y Column number
7965     * @param w rowspan
7966     * @param h colspan
7967     *
7968     * Modifies the position of an object already in the table.
7969     *
7970     * @note All positioning inside the table is relative to rows and columns, so
7971     * a value of 0 for x and y, means the top left cell of the table, and a
7972     * value of 1 for w and h means @p subobj only takes that 1 cell.
7973     */
7974    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7975    /**
7976     * @brief Get the packing location of an existing child of the table
7977     *
7978     * @param subobj The subobject to be modified in the table
7979     * @param x Row number
7980     * @param y Column number
7981     * @param w rowspan
7982     * @param h colspan
7983     *
7984     * @see elm_table_pack_set()
7985     */
7986    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7987    /**
7988     * @}
7989     */
7990
7991    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7992    typedef struct Elm_Gen_Item Elm_Gen_Item;
7993    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7994    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7995    typedef char        *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7996    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. */
7997    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. */
7998    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7999    struct _Elm_Gen_Item_Class
8000      {
8001         const char             *item_style;
8002         struct _Elm_Gen_Item_Class_Func
8003           {
8004              Elm_Gen_Item_Label_Get_Cb label_get;
8005              Elm_Gen_Item_Content_Get_Cb  content_get;
8006              Elm_Gen_Item_State_Get_Cb state_get;
8007              Elm_Gen_Item_Del_Cb       del;
8008           } func;
8009      };
8010    EAPI void elm_gen_clear(Evas_Object *obj);
8011    EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8012    EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8013    EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8014    EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8015    EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8016    EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8017    EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8018    EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8019    EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8020    EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8021    EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8022    EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8023    EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8024    EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8025    EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8026    EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8027    EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8028    EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8029    EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8030    EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8031
8032    /**
8033     * @defgroup Gengrid Gengrid (Generic grid)
8034     *
8035     * This widget aims to position objects in a grid layout while
8036     * actually creating and rendering only the visible ones, using the
8037     * same idea as the @ref Genlist "genlist": the user defines a @b
8038     * class for each item, specifying functions that will be called at
8039     * object creation, deletion, etc. When those items are selected by
8040     * the user, a callback function is issued. Users may interact with
8041     * a gengrid via the mouse (by clicking on items to select them and
8042     * clicking on the grid's viewport and swiping to pan the whole
8043     * view) or via the keyboard, navigating through item with the
8044     * arrow keys.
8045     *
8046     * @section Gengrid_Layouts Gengrid layouts
8047     *
8048     * Gengrid may layout its items in one of two possible layouts:
8049     * - horizontal or
8050     * - vertical.
8051     *
8052     * When in "horizontal mode", items will be placed in @b columns,
8053     * from top to bottom and, when the space for a column is filled,
8054     * another one is started on the right, thus expanding the grid
8055     * horizontally, making for horizontal scrolling. When in "vertical
8056     * mode" , though, items will be placed in @b rows, from left to
8057     * right and, when the space for a row is filled, another one is
8058     * started below, thus expanding the grid vertically (and making
8059     * for vertical scrolling).
8060     *
8061     * @section Gengrid_Items Gengrid items
8062     *
8063     * An item in a gengrid can have 0 or more text labels (they can be
8064     * regular text or textblock Evas objects - that's up to the style
8065     * to determine), 0 or more icons (which are simply objects
8066     * swallowed into the gengrid item's theming Edje object) and 0 or
8067     * more <b>boolean states</b>, which have the behavior left to the
8068     * user to define. The Edje part names for each of these properties
8069     * will be looked up, in the theme file for the gengrid, under the
8070     * Edje (string) data items named @c "labels", @c "icons" and @c
8071     * "states", respectively. For each of those properties, if more
8072     * than one part is provided, they must have names listed separated
8073     * by spaces in the data fields. For the default gengrid item
8074     * theme, we have @b one label part (@c "elm.text"), @b two icon
8075     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8076     * no state parts.
8077     *
8078     * A gengrid item may be at one of several styles. Elementary
8079     * provides one by default - "default", but this can be extended by
8080     * system or application custom themes/overlays/extensions (see
8081     * @ref Theme "themes" for more details).
8082     *
8083     * @section Gengrid_Item_Class Gengrid item classes
8084     *
8085     * In order to have the ability to add and delete items on the fly,
8086     * gengrid implements a class (callback) system where the
8087     * application provides a structure with information about that
8088     * type of item (gengrid may contain multiple different items with
8089     * different classes, states and styles). Gengrid will call the
8090     * functions in this struct (methods) when an item is "realized"
8091     * (i.e., created dynamically, while the user is scrolling the
8092     * grid). All objects will simply be deleted when no longer needed
8093     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8094     * contains the following members:
8095     * - @c item_style - This is a constant string and simply defines
8096     * the name of the item style. It @b must be specified and the
8097     * default should be @c "default".
8098     * - @c func.label_get - This function is called when an item
8099     * object is actually created. The @c data parameter will point to
8100     * the same data passed to elm_gengrid_item_append() and related
8101     * item creation functions. The @c obj parameter is the gengrid
8102     * object itself, while the @c part one is the name string of one
8103     * of the existing text parts in the Edje group implementing the
8104     * item's theme. This function @b must return a strdup'()ed string,
8105     * as the caller will free() it when done. See
8106     * #Elm_Gengrid_Item_Label_Get_Cb.
8107     * - @c func.content_get - This function is called when an item object
8108     * is actually created. The @c data parameter will point to the
8109     * same data passed to elm_gengrid_item_append() and related item
8110     * creation functions. The @c obj parameter is the gengrid object
8111     * itself, while the @c part one is the name string of one of the
8112     * existing (content) swallow parts in the Edje group implementing the
8113     * item's theme. It must return @c NULL, when no content is desired,
8114     * or a valid object handle, otherwise. The object will be deleted
8115     * by the gengrid on its deletion or when the item is "unrealized".
8116     * See #Elm_Gengrid_Item_Content_Get_Cb.
8117     * - @c func.state_get - This function is called when an item
8118     * object is actually created. The @c data parameter will point to
8119     * the same data passed to elm_gengrid_item_append() and related
8120     * item creation functions. The @c obj parameter is the gengrid
8121     * object itself, while the @c part one is the name string of one
8122     * of the state parts in the Edje group implementing the item's
8123     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8124     * true/on. Gengrids will emit a signal to its theming Edje object
8125     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8126     * "source" arguments, respectively, when the state is true (the
8127     * default is false), where @c XXX is the name of the (state) part.
8128     * See #Elm_Gengrid_Item_State_Get_Cb.
8129     * - @c func.del - This is called when elm_gengrid_item_del() is
8130     * called on an item or elm_gengrid_clear() is called on the
8131     * gengrid. This is intended for use when gengrid items are
8132     * deleted, so any data attached to the item (e.g. its data
8133     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8134     *
8135     * @section Gengrid_Usage_Hints Usage hints
8136     *
8137     * If the user wants to have multiple items selected at the same
8138     * time, elm_gengrid_multi_select_set() will permit it. If the
8139     * gengrid is single-selection only (the default), then
8140     * elm_gengrid_select_item_get() will return the selected item or
8141     * @c NULL, if none is selected. If the gengrid is under
8142     * multi-selection, then elm_gengrid_selected_items_get() will
8143     * return a list (that is only valid as long as no items are
8144     * modified (added, deleted, selected or unselected) of child items
8145     * on a gengrid.
8146     *
8147     * If an item changes (internal (boolean) state, label or content 
8148     * changes), then use elm_gengrid_item_update() to have gengrid
8149     * update the item with the new state. A gengrid will re-"realize"
8150     * the item, thus calling the functions in the
8151     * #Elm_Gengrid_Item_Class set for that item.
8152     *
8153     * To programmatically (un)select an item, use
8154     * elm_gengrid_item_selected_set(). To get its selected state use
8155     * elm_gengrid_item_selected_get(). To make an item disabled
8156     * (unable to be selected and appear differently) use
8157     * elm_gengrid_item_disabled_set() to set this and
8158     * elm_gengrid_item_disabled_get() to get the disabled state.
8159     *
8160     * Grid cells will only have their selection smart callbacks called
8161     * when firstly getting selected. Any further clicks will do
8162     * nothing, unless you enable the "always select mode", with
8163     * elm_gengrid_always_select_mode_set(), thus making every click to
8164     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8165     * turn off the ability to select items entirely in the widget and
8166     * they will neither appear selected nor call the selection smart
8167     * callbacks.
8168     *
8169     * Remember that you can create new styles and add your own theme
8170     * augmentation per application with elm_theme_extension_add(). If
8171     * you absolutely must have a specific style that overrides any
8172     * theme the user or system sets up you can use
8173     * elm_theme_overlay_add() to add such a file.
8174     *
8175     * @section Gengrid_Smart_Events Gengrid smart events
8176     *
8177     * Smart events that you can add callbacks for are:
8178     * - @c "activated" - The user has double-clicked or pressed
8179     *   (enter|return|spacebar) on an item. The @c event_info parameter
8180     *   is the gengrid item that was activated.
8181     * - @c "clicked,double" - The user has double-clicked an item.
8182     *   The @c event_info parameter is the gengrid item that was double-clicked.
8183     * - @c "longpressed" - This is called when the item is pressed for a certain
8184     *   amount of time. By default it's 1 second.
8185     * - @c "selected" - The user has made an item selected. The
8186     *   @c event_info parameter is the gengrid item that was selected.
8187     * - @c "unselected" - The user has made an item unselected. The
8188     *   @c event_info parameter is the gengrid item that was unselected.
8189     * - @c "realized" - This is called when the item in the gengrid
8190     *   has its implementing Evas object instantiated, de facto. @c
8191     *   event_info is the gengrid item that was created. The object
8192     *   may be deleted at any time, so it is highly advised to the
8193     *   caller @b not to use the object pointer returned from
8194     *   elm_gengrid_item_object_get(), because it may point to freed
8195     *   objects.
8196     * - @c "unrealized" - This is called when the implementing Evas
8197     *   object for this item is deleted. @c event_info is the gengrid
8198     *   item that was deleted.
8199     * - @c "changed" - Called when an item is added, removed, resized
8200     *   or moved and when the gengrid is resized or gets "horizontal"
8201     *   property changes.
8202     * - @c "scroll,anim,start" - This is called when scrolling animation has
8203     *   started.
8204     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8205     *   stopped.
8206     * - @c "drag,start,up" - Called when the item in the gengrid has
8207     *   been dragged (not scrolled) up.
8208     * - @c "drag,start,down" - Called when the item in the gengrid has
8209     *   been dragged (not scrolled) down.
8210     * - @c "drag,start,left" - Called when the item in the gengrid has
8211     *   been dragged (not scrolled) left.
8212     * - @c "drag,start,right" - Called when the item in the gengrid has
8213     *   been dragged (not scrolled) right.
8214     * - @c "drag,stop" - Called when the item in the gengrid has
8215     *   stopped being dragged.
8216     * - @c "drag" - Called when the item in the gengrid is being
8217     *   dragged.
8218     * - @c "scroll" - called when the content has been scrolled
8219     *   (moved).
8220     * - @c "scroll,drag,start" - called when dragging the content has
8221     *   started.
8222     * - @c "scroll,drag,stop" - called when dragging the content has
8223     *   stopped.
8224     * - @c "edge,top" - This is called when the gengrid is scrolled until
8225     *   the top edge.
8226     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8227     *   until the bottom edge.
8228     * - @c "edge,left" - This is called when the gengrid is scrolled
8229     *   until the left edge.
8230     * - @c "edge,right" - This is called when the gengrid is scrolled
8231     *   until the right edge.
8232     *
8233     * List of gengrid examples:
8234     * @li @ref gengrid_example
8235     */
8236
8237    /**
8238     * @addtogroup Gengrid
8239     * @{
8240     */
8241
8242    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8243    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8244    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8245    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8246    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8247    /**
8248     * Label fetching class function for Elm_Gen_Item_Class.
8249     * @param data The data passed in the item creation function
8250     * @param obj The base widget object
8251     * @param part The part name of the swallow
8252     * @return The allocated (NOT stringshared) string to set as the label
8253     */
8254    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8255    /**
8256     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8257     * @param data The data passed in the item creation function
8258     * @param obj The base widget object
8259     * @param part The part name of the swallow
8260     * @return The content object to swallow
8261     */
8262    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8263    /**
8264     * State fetching class function for Elm_Gen_Item_Class.
8265     * @param data The data passed in the item creation function
8266     * @param obj The base widget object
8267     * @param part The part name of the swallow
8268     * @return The hell if I know
8269     */
8270    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8271    /**
8272     * Deletion class function for Elm_Gen_Item_Class.
8273     * @param data The data passed in the item creation function
8274     * @param obj The base widget object
8275     */
8276    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8277
8278    /**
8279     * @struct _Elm_Gengrid_Item_Class
8280     *
8281     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8282     * field details.
8283     */
8284    struct _Elm_Gengrid_Item_Class
8285      {
8286         const char             *item_style;
8287         struct _Elm_Gengrid_Item_Class_Func
8288           {
8289              Elm_Gengrid_Item_Label_Get_Cb label_get;
8290              Elm_Gengrid_Item_Content_Get_Cb content_get;
8291              Elm_Gengrid_Item_State_Get_Cb state_get;
8292              Elm_Gengrid_Item_Del_Cb       del;
8293           } func;
8294      }; /**< #Elm_Gengrid_Item_Class member definitions */
8295    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8296    /**
8297     * Add a new gengrid widget to the given parent Elementary
8298     * (container) object
8299     *
8300     * @param parent The parent object
8301     * @return a new gengrid widget handle or @c NULL, on errors
8302     *
8303     * This function inserts a new gengrid widget on the canvas.
8304     *
8305     * @see elm_gengrid_item_size_set()
8306     * @see elm_gengrid_group_item_size_set()
8307     * @see elm_gengrid_horizontal_set()
8308     * @see elm_gengrid_item_append()
8309     * @see elm_gengrid_item_del()
8310     * @see elm_gengrid_clear()
8311     *
8312     * @ingroup Gengrid
8313     */
8314    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8315
8316    /**
8317     * Set the size for the items of a given gengrid widget
8318     *
8319     * @param obj The gengrid object.
8320     * @param w The items' width.
8321     * @param h The items' height;
8322     *
8323     * A gengrid, after creation, has still no information on the size
8324     * to give to each of its cells. So, you most probably will end up
8325     * with squares one @ref Fingers "finger" wide, the default
8326     * size. Use this function to force a custom size for you items,
8327     * making them as big as you wish.
8328     *
8329     * @see elm_gengrid_item_size_get()
8330     *
8331     * @ingroup Gengrid
8332     */
8333    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8334
8335    /**
8336     * Get the size set for the items of a given gengrid widget
8337     *
8338     * @param obj The gengrid object.
8339     * @param w Pointer to a variable where to store the items' width.
8340     * @param h Pointer to a variable where to store the items' height.
8341     *
8342     * @note Use @c NULL pointers on the size values you're not
8343     * interested in: they'll be ignored by the function.
8344     *
8345     * @see elm_gengrid_item_size_get() for more details
8346     *
8347     * @ingroup Gengrid
8348     */
8349    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8350
8351    /**
8352     * Set the size for the group items of a given gengrid widget
8353     *
8354     * @param obj The gengrid object.
8355     * @param w The group items' width.
8356     * @param h The group items' height;
8357     *
8358     * A gengrid, after creation, has still no information on the size
8359     * to give to each of its cells. So, you most probably will end up
8360     * with squares one @ref Fingers "finger" wide, the default
8361     * size. Use this function to force a custom size for you group items,
8362     * making them as big as you wish.
8363     *
8364     * @see elm_gengrid_group_item_size_get()
8365     *
8366     * @ingroup Gengrid
8367     */
8368    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8369
8370    /**
8371     * Get the size set for the group items of a given gengrid widget
8372     *
8373     * @param obj The gengrid object.
8374     * @param w Pointer to a variable where to store the group items' width.
8375     * @param h Pointer to a variable where to store the group items' height.
8376     *
8377     * @note Use @c NULL pointers on the size values you're not
8378     * interested in: they'll be ignored by the function.
8379     *
8380     * @see elm_gengrid_group_item_size_get() for more details
8381     *
8382     * @ingroup Gengrid
8383     */
8384    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8385
8386    /**
8387     * Set the items grid's alignment within a given gengrid widget
8388     *
8389     * @param obj The gengrid object.
8390     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8391     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8392     *
8393     * This sets the alignment of the whole grid of items of a gengrid
8394     * within its given viewport. By default, those values are both
8395     * 0.5, meaning that the gengrid will have its items grid placed
8396     * exactly in the middle of its viewport.
8397     *
8398     * @note If given alignment values are out of the cited ranges,
8399     * they'll be changed to the nearest boundary values on the valid
8400     * ranges.
8401     *
8402     * @see elm_gengrid_align_get()
8403     *
8404     * @ingroup Gengrid
8405     */
8406    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8407
8408    /**
8409     * Get the items grid's alignment values within a given gengrid
8410     * widget
8411     *
8412     * @param obj The gengrid object.
8413     * @param align_x Pointer to a variable where to store the
8414     * horizontal alignment.
8415     * @param align_y Pointer to a variable where to store the vertical
8416     * alignment.
8417     *
8418     * @note Use @c NULL pointers on the alignment values you're not
8419     * interested in: they'll be ignored by the function.
8420     *
8421     * @see elm_gengrid_align_set() for more details
8422     *
8423     * @ingroup Gengrid
8424     */
8425    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8426
8427    /**
8428     * Set whether a given gengrid widget is or not able have items
8429     * @b reordered
8430     *
8431     * @param obj The gengrid object
8432     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8433     * @c EINA_FALSE to turn it off
8434     *
8435     * If a gengrid is set to allow reordering, a click held for more
8436     * than 0.5 over a given item will highlight it specially,
8437     * signalling the gengrid has entered the reordering state. From
8438     * that time on, the user will be able to, while still holding the
8439     * mouse button down, move the item freely in the gengrid's
8440     * viewport, replacing to said item to the locations it goes to.
8441     * The replacements will be animated and, whenever the user
8442     * releases the mouse button, the item being replaced gets a new
8443     * definitive place in the grid.
8444     *
8445     * @see elm_gengrid_reorder_mode_get()
8446     *
8447     * @ingroup Gengrid
8448     */
8449    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8450
8451    /**
8452     * Get whether a given gengrid widget is or not able have items
8453     * @b reordered
8454     *
8455     * @param obj The gengrid object
8456     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8457     * off
8458     *
8459     * @see elm_gengrid_reorder_mode_set() for more details
8460     *
8461     * @ingroup Gengrid
8462     */
8463    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8464
8465    /**
8466     * Append a new item in a given gengrid widget.
8467     *
8468     * @param obj The gengrid object.
8469     * @param gic The item class for the item.
8470     * @param data The item data.
8471     * @param func Convenience function called when the item is
8472     * selected.
8473     * @param func_data Data to be passed to @p func.
8474     * @return A handle to the item added or @c NULL, on errors.
8475     *
8476     * This adds an item to the beginning of the gengrid.
8477     *
8478     * @see elm_gengrid_item_prepend()
8479     * @see elm_gengrid_item_insert_before()
8480     * @see elm_gengrid_item_insert_after()
8481     * @see elm_gengrid_item_del()
8482     *
8483     * @ingroup Gengrid
8484     */
8485    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);
8486
8487    /**
8488     * Prepend a new item in a given gengrid widget.
8489     *
8490     * @param obj The gengrid object.
8491     * @param gic The item class for the item.
8492     * @param data The item data.
8493     * @param func Convenience function called when the item is
8494     * selected.
8495     * @param func_data Data to be passed to @p func.
8496     * @return A handle to the item added or @c NULL, on errors.
8497     *
8498     * This adds an item to the end of the gengrid.
8499     *
8500     * @see elm_gengrid_item_append()
8501     * @see elm_gengrid_item_insert_before()
8502     * @see elm_gengrid_item_insert_after()
8503     * @see elm_gengrid_item_del()
8504     *
8505     * @ingroup Gengrid
8506     */
8507    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);
8508
8509    /**
8510     * Insert an item before another in a gengrid widget
8511     *
8512     * @param obj The gengrid object.
8513     * @param gic The item class for the item.
8514     * @param data The item data.
8515     * @param relative The item to place this new one before.
8516     * @param func Convenience function called when the item is
8517     * selected.
8518     * @param func_data Data to be passed to @p func.
8519     * @return A handle to the item added or @c NULL, on errors.
8520     *
8521     * This inserts an item before another in the gengrid.
8522     *
8523     * @see elm_gengrid_item_append()
8524     * @see elm_gengrid_item_prepend()
8525     * @see elm_gengrid_item_insert_after()
8526     * @see elm_gengrid_item_del()
8527     *
8528     * @ingroup Gengrid
8529     */
8530    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);
8531
8532    /**
8533     * Insert an item after another in a gengrid widget
8534     *
8535     * @param obj The gengrid object.
8536     * @param gic The item class for the item.
8537     * @param data The item data.
8538     * @param relative The item to place this new one after.
8539     * @param func Convenience function called when the item is
8540     * selected.
8541     * @param func_data Data to be passed to @p func.
8542     * @return A handle to the item added or @c NULL, on errors.
8543     *
8544     * This inserts an item after another in the gengrid.
8545     *
8546     * @see elm_gengrid_item_append()
8547     * @see elm_gengrid_item_prepend()
8548     * @see elm_gengrid_item_insert_after()
8549     * @see elm_gengrid_item_del()
8550     *
8551     * @ingroup Gengrid
8552     */
8553    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);
8554
8555    /**
8556     * Insert an item in a gengrid widget using a user-defined sort function.
8557     *
8558     * @param obj The gengrid object.
8559     * @param gic The item class for the item.
8560     * @param data The item data.
8561     * @param comp User defined comparison function that defines the sort order based on
8562     * Elm_Gen_Item and its data param.
8563     * @param func Convenience function called when the item is selected.
8564     * @param func_data Data to be passed to @p func.
8565     * @return A handle to the item added or @c NULL, on errors.
8566     *
8567     * This inserts an item in the gengrid based on user defined comparison function.
8568     *
8569     * @see elm_gengrid_item_append()
8570     * @see elm_gengrid_item_prepend()
8571     * @see elm_gengrid_item_insert_after()
8572     * @see elm_gengrid_item_del()
8573     * @see elm_gengrid_item_direct_sorted_insert()
8574     *
8575     * @ingroup Gengrid
8576     */
8577    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);
8578
8579    /**
8580     * Insert an item in a gengrid widget using a user-defined sort function.
8581     *
8582     * @param obj The gengrid object.
8583     * @param gic The item class for the item.
8584     * @param data The item data.
8585     * @param comp User defined comparison function that defines the sort order based on
8586     * Elm_Gen_Item.
8587     * @param func Convenience function called when the item is selected.
8588     * @param func_data Data to be passed to @p func.
8589     * @return A handle to the item added or @c NULL, on errors.
8590     *
8591     * This inserts an item in the gengrid based on user defined comparison function.
8592     *
8593     * @see elm_gengrid_item_append()
8594     * @see elm_gengrid_item_prepend()
8595     * @see elm_gengrid_item_insert_after()
8596     * @see elm_gengrid_item_del()
8597     * @see elm_gengrid_item_sorted_insert()
8598     *
8599     * @ingroup Gengrid
8600     */
8601    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);
8602
8603    /**
8604     * Set whether items on a given gengrid widget are to get their
8605     * selection callbacks issued for @b every subsequent selection
8606     * click on them or just for the first click.
8607     *
8608     * @param obj The gengrid object
8609     * @param always_select @c EINA_TRUE to make items "always
8610     * selected", @c EINA_FALSE, otherwise
8611     *
8612     * By default, grid items will only call their selection callback
8613     * function when firstly getting selected, any subsequent further
8614     * clicks will do nothing. With this call, you make those
8615     * subsequent clicks also to issue the selection callbacks.
8616     *
8617     * @note <b>Double clicks</b> will @b always be reported on items.
8618     *
8619     * @see elm_gengrid_always_select_mode_get()
8620     *
8621     * @ingroup Gengrid
8622     */
8623    EINA_DEPRECATED EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8624
8625    /**
8626     * Get whether items on a given gengrid widget have their selection
8627     * callbacks issued for @b every subsequent selection click on them
8628     * or just for the first click.
8629     *
8630     * @param obj The gengrid object.
8631     * @return @c EINA_TRUE if the gengrid items are "always selected",
8632     * @c EINA_FALSE, otherwise
8633     *
8634     * @see elm_gengrid_always_select_mode_set() for more details
8635     *
8636     * @ingroup Gengrid
8637     */
8638    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8639
8640    /**
8641     * Set whether items on a given gengrid widget can be selected or not.
8642     *
8643     * @param obj The gengrid object
8644     * @param no_select @c EINA_TRUE to make items selectable,
8645     * @c EINA_FALSE otherwise
8646     *
8647     * This will make items in @p obj selectable or not. In the latter
8648     * case, any user interaction on the gengrid items will neither make
8649     * them appear selected nor them call their selection callback
8650     * functions.
8651     *
8652     * @see elm_gengrid_no_select_mode_get()
8653     *
8654     * @ingroup Gengrid
8655     */
8656    EINA_DEPRECATED EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8657
8658    /**
8659     * Get whether items on a given gengrid widget can be selected or
8660     * not.
8661     *
8662     * @param obj The gengrid object
8663     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8664     * otherwise
8665     *
8666     * @see elm_gengrid_no_select_mode_set() for more details
8667     *
8668     * @ingroup Gengrid
8669     */
8670    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8671
8672    /**
8673     * Enable or disable multi-selection in a given gengrid widget
8674     *
8675     * @param obj The gengrid object.
8676     * @param multi @c EINA_TRUE, to enable multi-selection,
8677     * @c EINA_FALSE to disable it.
8678     *
8679     * Multi-selection is the ability to have @b more than one
8680     * item selected, on a given gengrid, simultaneously. When it is
8681     * enabled, a sequence of clicks on different items will make them
8682     * all selected, progressively. A click on an already selected item
8683     * will unselect it. If interacting via the keyboard,
8684     * multi-selection is enabled while holding the "Shift" key.
8685     *
8686     * @note By default, multi-selection is @b disabled on gengrids
8687     *
8688     * @see elm_gengrid_multi_select_get()
8689     *
8690     * @ingroup Gengrid
8691     */
8692    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8693
8694    /**
8695     * Get whether multi-selection is enabled or disabled for a given
8696     * gengrid widget
8697     *
8698     * @param obj The gengrid object.
8699     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8700     * EINA_FALSE otherwise
8701     *
8702     * @see elm_gengrid_multi_select_set() for more details
8703     *
8704     * @ingroup Gengrid
8705     */
8706    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8707
8708    /**
8709     * Enable or disable bouncing effect for a given gengrid widget
8710     *
8711     * @param obj The gengrid object
8712     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8713     * @c EINA_FALSE to disable it
8714     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8715     * @c EINA_FALSE to disable it
8716     *
8717     * The bouncing effect occurs whenever one reaches the gengrid's
8718     * edge's while panning it -- it will scroll past its limits a
8719     * little bit and return to the edge again, in a animated for,
8720     * automatically.
8721     *
8722     * @note By default, gengrids have bouncing enabled on both axis
8723     *
8724     * @see elm_gengrid_bounce_get()
8725     *
8726     * @ingroup Gengrid
8727     */
8728    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8729
8730    /**
8731     * Get whether bouncing effects are enabled or disabled, for a
8732     * given gengrid widget, on each axis
8733     *
8734     * @param obj The gengrid object
8735     * @param h_bounce Pointer to a variable where to store the
8736     * horizontal bouncing flag.
8737     * @param v_bounce Pointer to a variable where to store the
8738     * vertical bouncing flag.
8739     *
8740     * @see elm_gengrid_bounce_set() for more details
8741     *
8742     * @ingroup Gengrid
8743     */
8744    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8745
8746    /**
8747     * Set a given gengrid widget's scrolling page size, relative to
8748     * its viewport size.
8749     *
8750     * @param obj The gengrid object
8751     * @param h_pagerel The horizontal page (relative) size
8752     * @param v_pagerel The vertical page (relative) size
8753     *
8754     * The gengrid's scroller is capable of binding scrolling by the
8755     * user to "pages". It means that, while scrolling and, specially
8756     * after releasing the mouse button, the grid will @b snap to the
8757     * nearest displaying page's area. When page sizes are set, the
8758     * grid's continuous content area is split into (equal) page sized
8759     * pieces.
8760     *
8761     * This function sets the size of a page <b>relatively to the
8762     * viewport dimensions</b> of the gengrid, for each axis. A value
8763     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8764     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8765     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8766     * 1.0. Values beyond those will make it behave behave
8767     * inconsistently. If you only want one axis to snap to pages, use
8768     * the value @c 0.0 for the other one.
8769     *
8770     * There is a function setting page size values in @b absolute
8771     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8772     * is mutually exclusive to this one.
8773     *
8774     * @see elm_gengrid_page_relative_get()
8775     *
8776     * @ingroup Gengrid
8777     */
8778    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8779
8780    /**
8781     * Get a given gengrid widget's scrolling page size, relative to
8782     * its viewport size.
8783     *
8784     * @param obj The gengrid object
8785     * @param h_pagerel Pointer to a variable where to store the
8786     * horizontal page (relative) size
8787     * @param v_pagerel Pointer to a variable where to store the
8788     * vertical page (relative) size
8789     *
8790     * @see elm_gengrid_page_relative_set() for more details
8791     *
8792     * @ingroup Gengrid
8793     */
8794    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8795
8796    /**
8797     * Set a given gengrid widget's scrolling page size
8798     *
8799     * @param obj The gengrid object
8800     * @param h_pagerel The horizontal page size, in pixels
8801     * @param v_pagerel The vertical page size, in pixels
8802     *
8803     * The gengrid's scroller is capable of binding scrolling by the
8804     * user to "pages". It means that, while scrolling and, specially
8805     * after releasing the mouse button, the grid will @b snap to the
8806     * nearest displaying page's area. When page sizes are set, the
8807     * grid's continuous content area is split into (equal) page sized
8808     * pieces.
8809     *
8810     * This function sets the size of a page of the gengrid, in pixels,
8811     * for each axis. Sane usable values are, between @c 0 and the
8812     * dimensions of @p obj, for each axis. Values beyond those will
8813     * make it behave behave inconsistently. If you only want one axis
8814     * to snap to pages, use the value @c 0 for the other one.
8815     *
8816     * There is a function setting page size values in @b relative
8817     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8818     * use is mutually exclusive to this one.
8819     *
8820     * @ingroup Gengrid
8821     */
8822    EINA_DEPRECATED EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8823
8824    /**
8825     * @brief Get gengrid current page number.
8826     *
8827     * @param obj The gengrid object
8828     * @param h_pagenumber The horizontal page number
8829     * @param v_pagenumber The vertical page number
8830     *
8831     * The page number starts from 0. 0 is the first page.
8832     * Current page means the page which meet the top-left of the viewport.
8833     * If there are two or more pages in the viewport, it returns the number of page
8834     * which meet the top-left of the viewport.
8835     *
8836     * @see elm_gengrid_last_page_get()
8837     * @see elm_gengrid_page_show()
8838     * @see elm_gengrid_page_brint_in()
8839     */
8840    EINA_DEPRECATED EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8841
8842    /**
8843     * @brief Get scroll last page number.
8844     *
8845     * @param obj The gengrid object
8846     * @param h_pagenumber The horizontal page number
8847     * @param v_pagenumber The vertical page number
8848     *
8849     * The page number starts from 0. 0 is the first page.
8850     * This returns the last page number among the pages.
8851     *
8852     * @see elm_gengrid_current_page_get()
8853     * @see elm_gengrid_page_show()
8854     * @see elm_gengrid_page_brint_in()
8855     */
8856    EINA_DEPRECATED EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8857
8858    /**
8859     * Show a specific virtual region within the gengrid content object by page number.
8860     *
8861     * @param obj The gengrid object
8862     * @param h_pagenumber The horizontal page number
8863     * @param v_pagenumber The vertical page number
8864     *
8865     * 0, 0 of the indicated page is located at the top-left of the viewport.
8866     * This will jump to the page directly without animation.
8867     *
8868     * Example of usage:
8869     *
8870     * @code
8871     * sc = elm_gengrid_add(win);
8872     * elm_gengrid_content_set(sc, content);
8873     * elm_gengrid_page_relative_set(sc, 1, 0);
8874     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8875     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8876     * @endcode
8877     *
8878     * @see elm_gengrid_page_bring_in()
8879     */
8880    EINA_DEPRECATED EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8881
8882    /**
8883     * Show a specific virtual region within the gengrid content object by page number.
8884     *
8885     * @param obj The gengrid object
8886     * @param h_pagenumber The horizontal page number
8887     * @param v_pagenumber The vertical page number
8888     *
8889     * 0, 0 of the indicated page is located at the top-left of the viewport.
8890     * This will slide to the page with animation.
8891     *
8892     * Example of usage:
8893     *
8894     * @code
8895     * sc = elm_gengrid_add(win);
8896     * elm_gengrid_content_set(sc, content);
8897     * elm_gengrid_page_relative_set(sc, 1, 0);
8898     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8899     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8900     * @endcode
8901     *
8902     * @see elm_gengrid_page_show()
8903     */
8904     EINA_DEPRECATED EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8905
8906    /**
8907     * Set the direction in which a given gengrid widget will expand while
8908     * placing its items.
8909     *
8910     * @param obj The gengrid object.
8911     * @param setting @c EINA_TRUE to make the gengrid expand
8912     * horizontally, @c EINA_FALSE to expand vertically.
8913     *
8914     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8915     * in @b columns, from top to bottom and, when the space for a
8916     * column is filled, another one is started on the right, thus
8917     * expanding the grid horizontally. When in "vertical mode"
8918     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8919     * to right and, when the space for a row is filled, another one is
8920     * started below, thus expanding the grid vertically.
8921     *
8922     * @see elm_gengrid_horizontal_get()
8923     *
8924     * @ingroup Gengrid
8925     */
8926    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8927
8928    /**
8929     * Get for what direction a given gengrid widget will expand while
8930     * placing its items.
8931     *
8932     * @param obj The gengrid object.
8933     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8934     * @c EINA_FALSE if it's set to expand vertically.
8935     *
8936     * @see elm_gengrid_horizontal_set() for more detais
8937     *
8938     * @ingroup Gengrid
8939     */
8940    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8941
8942    /**
8943     * Get the first item in a given gengrid widget
8944     *
8945     * @param obj The gengrid object
8946     * @return The first item's handle or @c NULL, if there are no
8947     * items in @p obj (and on errors)
8948     *
8949     * This returns the first item in the @p obj's internal list of
8950     * items.
8951     *
8952     * @see elm_gengrid_last_item_get()
8953     *
8954     * @ingroup Gengrid
8955     */
8956    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8957
8958    /**
8959     * Get the last item in a given gengrid widget
8960     *
8961     * @param obj The gengrid object
8962     * @return The last item's handle or @c NULL, if there are no
8963     * items in @p obj (and on errors)
8964     *
8965     * This returns the last item in the @p obj's internal list of
8966     * items.
8967     *
8968     * @see elm_gengrid_first_item_get()
8969     *
8970     * @ingroup Gengrid
8971     */
8972    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8973
8974    /**
8975     * Get the @b next item in a gengrid widget's internal list of items,
8976     * given a handle to one of those items.
8977     *
8978     * @param item The gengrid item to fetch next from
8979     * @return The item after @p item, or @c NULL if there's none (and
8980     * on errors)
8981     *
8982     * This returns the item placed after the @p item, on the container
8983     * gengrid.
8984     *
8985     * @see elm_gengrid_item_prev_get()
8986     *
8987     * @ingroup Gengrid
8988     */
8989    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8990
8991    /**
8992     * Get the @b previous item in a gengrid widget's internal list of items,
8993     * given a handle to one of those items.
8994     *
8995     * @param item The gengrid item to fetch previous from
8996     * @return The item before @p item, or @c NULL if there's none (and
8997     * on errors)
8998     *
8999     * This returns the item placed before the @p item, on the container
9000     * gengrid.
9001     *
9002     * @see elm_gengrid_item_next_get()
9003     *
9004     * @ingroup Gengrid
9005     */
9006    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9007
9008    /**
9009     * Get the gengrid object's handle which contains a given gengrid
9010     * item
9011     *
9012     * @param item The item to fetch the container from
9013     * @return The gengrid (parent) object
9014     *
9015     * This returns the gengrid object itself that an item belongs to.
9016     *
9017     * @ingroup Gengrid
9018     */
9019    EINA_DEPRECATED EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9020
9021    /**
9022     * Remove a gengrid item from its parent, deleting it.
9023     *
9024     * @param item The item to be removed.
9025     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9026     *
9027     * @see elm_gengrid_clear(), to remove all items in a gengrid at
9028     * once.
9029     *
9030     * @ingroup Gengrid
9031     */
9032    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9033
9034    /**
9035     * Update the contents of a given gengrid item
9036     *
9037     * @param item The gengrid item
9038     *
9039     * This updates an item by calling all the item class functions
9040     * again to get the contents, labels and states. Use this when the
9041     * original item data has changed and you want the changes to be
9042     * reflected.
9043     *
9044     * @ingroup Gengrid
9045     */
9046    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9047
9048    /**
9049     * Get the Gengrid Item class for the given Gengrid Item.
9050     *
9051     * @param item The gengrid item
9052     *
9053     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9054     * the function pointers and item_style.
9055     *
9056     * @ingroup Gengrid
9057     */
9058    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9059
9060    /**
9061     * Get the Gengrid Item class for the given Gengrid Item.
9062     *
9063     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9064     * the function pointers and item_style.
9065     *
9066     * @param item The gengrid item
9067     * @param gic The gengrid item class describing the function pointers and the item style.
9068     *
9069     * @ingroup Gengrid
9070     */
9071    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9072
9073    /**
9074     * Return the data associated to a given gengrid item
9075     *
9076     * @param item The gengrid item.
9077     * @return the data associated with this item.
9078     *
9079     * This returns the @c data value passed on the
9080     * elm_gengrid_item_append() and related item addition calls.
9081     *
9082     * @see elm_gengrid_item_append()
9083     * @see elm_gengrid_item_data_set()
9084     *
9085     * @ingroup Gengrid
9086     */
9087    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9088
9089    /**
9090     * Set the data associated with a given gengrid item
9091     *
9092     * @param item The gengrid item
9093     * @param data The data pointer to set on it
9094     *
9095     * This @b overrides the @c data value passed on the
9096     * elm_gengrid_item_append() and related item addition calls. This
9097     * function @b won't call elm_gengrid_item_update() automatically,
9098     * so you'd issue it afterwards if you want to have the item
9099     * updated to reflect the new data.
9100     *
9101     * @see elm_gengrid_item_data_get()
9102     * @see elm_gengrid_item_update()
9103     *
9104     * @ingroup Gengrid
9105     */
9106    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9107
9108    /**
9109     * Get a given gengrid item's position, relative to the whole
9110     * gengrid's grid area.
9111     *
9112     * @param item The Gengrid item.
9113     * @param x Pointer to variable to store the item's <b>row number</b>.
9114     * @param y Pointer to variable to store the item's <b>column number</b>.
9115     *
9116     * This returns the "logical" position of the item within the
9117     * gengrid. For example, @c (0, 1) would stand for first row,
9118     * second column.
9119     *
9120     * @ingroup Gengrid
9121     */
9122    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9123
9124    /**
9125     * Set whether a given gengrid item is selected or not
9126     *
9127     * @param item The gengrid item
9128     * @param selected Use @c EINA_TRUE, to make it selected, @c
9129     * EINA_FALSE to make it unselected
9130     *
9131     * This sets the selected state of an item. If multi-selection is
9132     * not enabled on the containing gengrid and @p selected is @c
9133     * EINA_TRUE, any other previously selected items will get
9134     * unselected in favor of this new one.
9135     *
9136     * @see elm_gengrid_item_selected_get()
9137     *
9138     * @ingroup Gengrid
9139     */
9140    EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9141
9142    /**
9143     * Get whether a given gengrid item is selected or not
9144     *
9145     * @param item The gengrid item
9146     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9147     *
9148     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9149     *
9150     * @see elm_gengrid_item_selected_set() for more details
9151     *
9152     * @ingroup Gengrid
9153     */
9154    EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9155
9156    /**
9157     * Get the real Evas object created to implement the view of a
9158     * given gengrid item
9159     *
9160     * @param item The gengrid item.
9161     * @return the Evas object implementing this item's view.
9162     *
9163     * This returns the actual Evas object used to implement the
9164     * specified gengrid item's view. This may be @c NULL, as it may
9165     * not have been created or may have been deleted, at any time, by
9166     * the gengrid. <b>Do not modify this object</b> (move, resize,
9167     * show, hide, etc.), as the gengrid is controlling it. This
9168     * function is for querying, emitting custom signals or hooking
9169     * lower level callbacks for events on that object. Do not delete
9170     * this object under any circumstances.
9171     *
9172     * @see elm_gengrid_item_data_get()
9173     *
9174     * @ingroup Gengrid
9175     */
9176    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9177
9178    /**
9179     * Show the portion of a gengrid's internal grid containing a given
9180     * item, @b immediately.
9181     *
9182     * @param item The item to display
9183     *
9184     * This causes gengrid to @b redraw its viewport's contents to the
9185     * region contining the given @p item item, if it is not fully
9186     * visible.
9187     *
9188     * @see elm_gengrid_item_bring_in()
9189     *
9190     * @ingroup Gengrid
9191     */
9192    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9193
9194    /**
9195     * Animatedly bring in, to the visible area of a gengrid, a given
9196     * item on it.
9197     *
9198     * @param item The gengrid item to display
9199     *
9200     * This causes gengrid to jump to the given @p item and show
9201     * it (by scrolling), if it is not fully visible. This will use
9202     * animation to do so and take a period of time to complete.
9203     *
9204     * @see elm_gengrid_item_show()
9205     *
9206     * @ingroup Gengrid
9207     */
9208    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9209
9210    /**
9211     * Set whether a given gengrid item is disabled or not.
9212     *
9213     * @param item The gengrid item
9214     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9215     * to enable it back.
9216     *
9217     * A disabled item cannot be selected or unselected. It will also
9218     * change its appearance, to signal the user it's disabled.
9219     *
9220     * @see elm_gengrid_item_disabled_get()
9221     *
9222     * @ingroup Gengrid
9223     */
9224    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9225
9226    /**
9227     * Get whether a given gengrid item is disabled or not.
9228     *
9229     * @param item The gengrid item
9230     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9231     * (and on errors).
9232     *
9233     * @see elm_gengrid_item_disabled_set() for more details
9234     *
9235     * @ingroup Gengrid
9236     */
9237    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9238
9239    /**
9240     * Set the text to be shown in a given gengrid item's tooltips.
9241     *
9242     * @param item The gengrid item
9243     * @param text The text to set in the content
9244     *
9245     * This call will setup the text to be used as tooltip to that item
9246     * (analogous to elm_object_tooltip_text_set(), but being item
9247     * tooltips with higher precedence than object tooltips). It can
9248     * have only one tooltip at a time, so any previous tooltip data
9249     * will get removed.
9250     *
9251     * @ingroup Gengrid
9252     */
9253    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9254
9255    /**
9256     * Set the content to be shown in a given gengrid item's tooltip
9257     *
9258     * @param item The gengrid item.
9259     * @param func The function returning the tooltip contents.
9260     * @param data What to provide to @a func as callback data/context.
9261     * @param del_cb Called when data is not needed anymore, either when
9262     *        another callback replaces @p func, the tooltip is unset with
9263     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9264     *        dies. This callback receives as its first parameter the
9265     *        given @p data, being @c event_info the item handle.
9266     *
9267     * This call will setup the tooltip's contents to @p item
9268     * (analogous to elm_object_tooltip_content_cb_set(), but being
9269     * item tooltips with higher precedence than object tooltips). It
9270     * can have only one tooltip at a time, so any previous tooltip
9271     * content will get removed. @p func (with @p data) will be called
9272     * every time Elementary needs to show the tooltip and it should
9273     * return a valid Evas object, which will be fully managed by the
9274     * tooltip system, getting deleted when the tooltip is gone.
9275     *
9276     * @ingroup Gengrid
9277     */
9278    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);
9279
9280    /**
9281     * Unset a tooltip from a given gengrid item
9282     *
9283     * @param item gengrid item to remove a previously set tooltip from.
9284     *
9285     * This call removes any tooltip set on @p item. The callback
9286     * provided as @c del_cb to
9287     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9288     * notify it is not used anymore (and have resources cleaned, if
9289     * need be).
9290     *
9291     * @see elm_gengrid_item_tooltip_content_cb_set()
9292     *
9293     * @ingroup Gengrid
9294     */
9295    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9296
9297    /**
9298     * Set a different @b style for a given gengrid item's tooltip.
9299     *
9300     * @param item gengrid item with tooltip set
9301     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9302     * "default", @c "transparent", etc)
9303     *
9304     * Tooltips can have <b>alternate styles</b> to be displayed on,
9305     * which are defined by the theme set on Elementary. This function
9306     * works analogously as elm_object_tooltip_style_set(), but here
9307     * applied only to gengrid item objects. The default style for
9308     * tooltips is @c "default".
9309     *
9310     * @note before you set a style you should define a tooltip with
9311     *       elm_gengrid_item_tooltip_content_cb_set() or
9312     *       elm_gengrid_item_tooltip_text_set()
9313     *
9314     * @see elm_gengrid_item_tooltip_style_get()
9315     *
9316     * @ingroup Gengrid
9317     */
9318    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9319
9320    /**
9321     * Get the style set a given gengrid item's tooltip.
9322     *
9323     * @param item gengrid item with tooltip already set on.
9324     * @return style the theme style in use, which defaults to
9325     *         "default". If the object does not have a tooltip set,
9326     *         then @c NULL is returned.
9327     *
9328     * @see elm_gengrid_item_tooltip_style_set() for more details
9329     *
9330     * @ingroup Gengrid
9331     */
9332    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9333    /**
9334     * @brief Disable size restrictions on an object's tooltip
9335     * @param item The tooltip's anchor object
9336     * @param disable If EINA_TRUE, size restrictions are disabled
9337     * @return EINA_FALSE on failure, EINA_TRUE on success
9338     *
9339     * This function allows a tooltip to expand beyond its parant window's canvas.
9340     * It will instead be limited only by the size of the display.
9341     */
9342    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9343    /**
9344     * @brief Retrieve size restriction state of an object's tooltip
9345     * @param item The tooltip's anchor object
9346     * @return If EINA_TRUE, size restrictions are disabled
9347     *
9348     * This function returns whether a tooltip is allowed to expand beyond
9349     * its parant window's canvas.
9350     * It will instead be limited only by the size of the display.
9351     */
9352    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9353    /**
9354     * Set the type of mouse pointer/cursor decoration to be shown,
9355     * when the mouse pointer is over the given gengrid widget item
9356     *
9357     * @param item gengrid item to customize cursor on
9358     * @param cursor the cursor type's name
9359     *
9360     * This function works analogously as elm_object_cursor_set(), but
9361     * here the cursor's changing area is restricted to the item's
9362     * area, and not the whole widget's. Note that that item cursors
9363     * have precedence over widget cursors, so that a mouse over @p
9364     * item will always show cursor @p type.
9365     *
9366     * If this function is called twice for an object, a previously set
9367     * cursor will be unset on the second call.
9368     *
9369     * @see elm_object_cursor_set()
9370     * @see elm_gengrid_item_cursor_get()
9371     * @see elm_gengrid_item_cursor_unset()
9372     *
9373     * @ingroup Gengrid
9374     */
9375    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9376
9377    /**
9378     * Get the type of mouse pointer/cursor decoration set to be shown,
9379     * when the mouse pointer is over the given gengrid widget item
9380     *
9381     * @param item gengrid item with custom cursor set
9382     * @return the cursor type's name or @c NULL, if no custom cursors
9383     * were set to @p item (and on errors)
9384     *
9385     * @see elm_object_cursor_get()
9386     * @see elm_gengrid_item_cursor_set() for more details
9387     * @see elm_gengrid_item_cursor_unset()
9388     *
9389     * @ingroup Gengrid
9390     */
9391    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9392
9393    /**
9394     * Unset any custom mouse pointer/cursor decoration set to be
9395     * shown, when the mouse pointer is over the given gengrid widget
9396     * item, thus making it show the @b default cursor again.
9397     *
9398     * @param item a gengrid item
9399     *
9400     * Use this call to undo any custom settings on this item's cursor
9401     * decoration, bringing it back to defaults (no custom style set).
9402     *
9403     * @see elm_object_cursor_unset()
9404     * @see elm_gengrid_item_cursor_set() for more details
9405     *
9406     * @ingroup Gengrid
9407     */
9408    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9409
9410    /**
9411     * Set a different @b style for a given custom cursor set for a
9412     * gengrid item.
9413     *
9414     * @param item gengrid item with custom cursor set
9415     * @param style the <b>theme style</b> to use (e.g. @c "default",
9416     * @c "transparent", etc)
9417     *
9418     * This function only makes sense when one is using custom mouse
9419     * cursor decorations <b>defined in a theme file</b> , which can
9420     * have, given a cursor name/type, <b>alternate styles</b> on
9421     * it. It works analogously as elm_object_cursor_style_set(), but
9422     * here applied only to gengrid item objects.
9423     *
9424     * @warning Before you set a cursor style you should have defined a
9425     *       custom cursor previously on the item, with
9426     *       elm_gengrid_item_cursor_set()
9427     *
9428     * @see elm_gengrid_item_cursor_engine_only_set()
9429     * @see elm_gengrid_item_cursor_style_get()
9430     *
9431     * @ingroup Gengrid
9432     */
9433    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9434
9435    /**
9436     * Get the current @b style set for a given gengrid item's custom
9437     * cursor
9438     *
9439     * @param item gengrid item with custom cursor set.
9440     * @return style the cursor style in use. If the object does not
9441     *         have a cursor set, then @c NULL is returned.
9442     *
9443     * @see elm_gengrid_item_cursor_style_set() for more details
9444     *
9445     * @ingroup Gengrid
9446     */
9447    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9448
9449    /**
9450     * Set if the (custom) cursor for a given gengrid item should be
9451     * searched in its theme, also, or should only rely on the
9452     * rendering engine.
9453     *
9454     * @param item item with custom (custom) cursor already set on
9455     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9456     * only on those provided by the rendering engine, @c EINA_FALSE to
9457     * have them searched on the widget's theme, as well.
9458     *
9459     * @note This call is of use only if you've set a custom cursor
9460     * for gengrid items, with elm_gengrid_item_cursor_set().
9461     *
9462     * @note By default, cursors will only be looked for between those
9463     * provided by the rendering engine.
9464     *
9465     * @ingroup Gengrid
9466     */
9467    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9468
9469    /**
9470     * Get if the (custom) cursor for a given gengrid item is being
9471     * searched in its theme, also, or is only relying on the rendering
9472     * engine.
9473     *
9474     * @param item a gengrid item
9475     * @return @c EINA_TRUE, if cursors are being looked for only on
9476     * those provided by the rendering engine, @c EINA_FALSE if they
9477     * are being searched on the widget's theme, as well.
9478     *
9479     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9480     *
9481     * @ingroup Gengrid
9482     */
9483    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9484
9485    /**
9486     * Remove all items from a given gengrid widget
9487     *
9488     * @param obj The gengrid object.
9489     *
9490     * This removes (and deletes) all items in @p obj, leaving it
9491     * empty.
9492     *
9493     * @see elm_gengrid_item_del(), to remove just one item.
9494     *
9495     * @ingroup Gengrid
9496     */
9497    EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9498
9499    /**
9500     * Get the selected item in a given gengrid widget
9501     *
9502     * @param obj The gengrid object.
9503     * @return The selected item's handleor @c NULL, if none is
9504     * selected at the moment (and on errors)
9505     *
9506     * This returns the selected item in @p obj. If multi selection is
9507     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9508     * the first item in the list is selected, which might not be very
9509     * useful. For that case, see elm_gengrid_selected_items_get().
9510     *
9511     * @ingroup Gengrid
9512     */
9513    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9514
9515    /**
9516     * Get <b>a list</b> of selected items in a given gengrid
9517     *
9518     * @param obj The gengrid object.
9519     * @return The list of selected items or @c NULL, if none is
9520     * selected at the moment (and on errors)
9521     *
9522     * This returns a list of the selected items, in the order that
9523     * they appear in the grid. This list is only valid as long as no
9524     * more items are selected or unselected (or unselected implictly
9525     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9526     * data, naturally.
9527     *
9528     * @see elm_gengrid_selected_item_get()
9529     *
9530     * @ingroup Gengrid
9531     */
9532    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9533
9534    /**
9535     * @}
9536     */
9537
9538    /**
9539     * @defgroup Clock Clock
9540     *
9541     * @image html img/widget/clock/preview-00.png
9542     * @image latex img/widget/clock/preview-00.eps
9543     *
9544     * This is a @b digital clock widget. In its default theme, it has a
9545     * vintage "flipping numbers clock" appearance, which will animate
9546     * sheets of individual algarisms individually as time goes by.
9547     *
9548     * A newly created clock will fetch system's time (already
9549     * considering local time adjustments) to start with, and will tick
9550     * accondingly. It may or may not show seconds.
9551     *
9552     * Clocks have an @b edition mode. When in it, the sheets will
9553     * display extra arrow indications on the top and bottom and the
9554     * user may click on them to raise or lower the time values. After
9555     * it's told to exit edition mode, it will keep ticking with that
9556     * new time set (it keeps the difference from local time).
9557     *
9558     * Also, when under edition mode, user clicks on the cited arrows
9559     * which are @b held for some time will make the clock to flip the
9560     * sheet, thus editing the time, continuosly and automatically for
9561     * the user. The interval between sheet flips will keep growing in
9562     * time, so that it helps the user to reach a time which is distant
9563     * from the one set.
9564     *
9565     * The time display is, by default, in military mode (24h), but an
9566     * am/pm indicator may be optionally shown, too, when it will
9567     * switch to 12h.
9568     *
9569     * Smart callbacks one can register to:
9570     * - "changed" - the clock's user changed the time
9571     *
9572     * Here is an example on its usage:
9573     * @li @ref clock_example
9574     */
9575
9576    /**
9577     * @addtogroup Clock
9578     * @{
9579     */
9580
9581    /**
9582     * Identifiers for which clock digits should be editable, when a
9583     * clock widget is in edition mode. Values may be ORed together to
9584     * make a mask, naturally.
9585     *
9586     * @see elm_clock_edit_set()
9587     * @see elm_clock_digit_edit_set()
9588     */
9589    typedef enum _Elm_Clock_Digedit
9590      {
9591         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9592         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9593         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9594         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9595         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9596         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9597         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9598         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9599      } Elm_Clock_Digedit;
9600
9601    /**
9602     * Add a new clock widget to the given parent Elementary
9603     * (container) object
9604     *
9605     * @param parent The parent object
9606     * @return a new clock widget handle or @c NULL, on errors
9607     *
9608     * This function inserts a new clock widget on the canvas.
9609     *
9610     * @ingroup Clock
9611     */
9612    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9613
9614    /**
9615     * Set a clock widget's time, programmatically
9616     *
9617     * @param obj The clock widget object
9618     * @param hrs The hours to set
9619     * @param min The minutes to set
9620     * @param sec The secondes to set
9621     *
9622     * This function updates the time that is showed by the clock
9623     * widget.
9624     *
9625     *  Values @b must be set within the following ranges:
9626     * - 0 - 23, for hours
9627     * - 0 - 59, for minutes
9628     * - 0 - 59, for seconds,
9629     *
9630     * even if the clock is not in "military" mode.
9631     *
9632     * @warning The behavior for values set out of those ranges is @b
9633     * undefined.
9634     *
9635     * @ingroup Clock
9636     */
9637    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9638
9639    /**
9640     * Get a clock widget's time values
9641     *
9642     * @param obj The clock object
9643     * @param[out] hrs Pointer to the variable to get the hours value
9644     * @param[out] min Pointer to the variable to get the minutes value
9645     * @param[out] sec Pointer to the variable to get the seconds value
9646     *
9647     * This function gets the time set for @p obj, returning
9648     * it on the variables passed as the arguments to function
9649     *
9650     * @note Use @c NULL pointers on the time values you're not
9651     * interested in: they'll be ignored by the function.
9652     *
9653     * @ingroup Clock
9654     */
9655    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9656
9657    /**
9658     * Set whether a given clock widget is under <b>edition mode</b> or
9659     * under (default) displaying-only mode.
9660     *
9661     * @param obj The clock object
9662     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9663     * put it back to "displaying only" mode
9664     *
9665     * This function makes a clock's time to be editable or not <b>by
9666     * user interaction</b>. When in edition mode, clocks @b stop
9667     * ticking, until one brings them back to canonical mode. The
9668     * elm_clock_digit_edit_set() function will influence which digits
9669     * of the clock will be editable. By default, all of them will be
9670     * (#ELM_CLOCK_NONE).
9671     *
9672     * @note am/pm sheets, if being shown, will @b always be editable
9673     * under edition mode.
9674     *
9675     * @see elm_clock_edit_get()
9676     *
9677     * @ingroup Clock
9678     */
9679    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9680
9681    /**
9682     * Retrieve whether a given clock widget is under <b>edition
9683     * mode</b> or under (default) displaying-only mode.
9684     *
9685     * @param obj The clock object
9686     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9687     * otherwise
9688     *
9689     * This function retrieves whether the clock's time can be edited
9690     * or not by user interaction.
9691     *
9692     * @see elm_clock_edit_set() for more details
9693     *
9694     * @ingroup Clock
9695     */
9696    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9697
9698    /**
9699     * Set what digits of the given clock widget should be editable
9700     * when in edition mode.
9701     *
9702     * @param obj The clock object
9703     * @param digedit Bit mask indicating the digits to be editable
9704     * (values in #Elm_Clock_Digedit).
9705     *
9706     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9707     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9708     * EINA_FALSE).
9709     *
9710     * @see elm_clock_digit_edit_get()
9711     *
9712     * @ingroup Clock
9713     */
9714    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9715
9716    /**
9717     * Retrieve what digits of the given clock widget should be
9718     * editable when in edition mode.
9719     *
9720     * @param obj The clock object
9721     * @return Bit mask indicating the digits to be editable
9722     * (values in #Elm_Clock_Digedit).
9723     *
9724     * @see elm_clock_digit_edit_set() for more details
9725     *
9726     * @ingroup Clock
9727     */
9728    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9729
9730    /**
9731     * Set if the given clock widget must show hours in military or
9732     * am/pm mode
9733     *
9734     * @param obj The clock object
9735     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9736     * to military mode
9737     *
9738     * This function sets if the clock must show hours in military or
9739     * am/pm mode. In some countries like Brazil the military mode
9740     * (00-24h-format) is used, in opposition to the USA, where the
9741     * am/pm mode is more commonly used.
9742     *
9743     * @see elm_clock_show_am_pm_get()
9744     *
9745     * @ingroup Clock
9746     */
9747    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9748
9749    /**
9750     * Get if the given clock widget shows hours in military or am/pm
9751     * mode
9752     *
9753     * @param obj The clock object
9754     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9755     * military
9756     *
9757     * This function gets if the clock shows hours in military or am/pm
9758     * mode.
9759     *
9760     * @see elm_clock_show_am_pm_set() for more details
9761     *
9762     * @ingroup Clock
9763     */
9764    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9765
9766    /**
9767     * Set if the given clock widget must show time with seconds or not
9768     *
9769     * @param obj The clock object
9770     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9771     *
9772     * This function sets if the given clock must show or not elapsed
9773     * seconds. By default, they are @b not shown.
9774     *
9775     * @see elm_clock_show_seconds_get()
9776     *
9777     * @ingroup Clock
9778     */
9779    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9780
9781    /**
9782     * Get whether the given clock widget is showing time with seconds
9783     * or not
9784     *
9785     * @param obj The clock object
9786     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9787     *
9788     * This function gets whether @p obj is showing or not the elapsed
9789     * seconds.
9790     *
9791     * @see elm_clock_show_seconds_set()
9792     *
9793     * @ingroup Clock
9794     */
9795    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9796
9797    /**
9798     * Set the interval on time updates for an user mouse button hold
9799     * on clock widgets' time edition.
9800     *
9801     * @param obj The clock object
9802     * @param interval The (first) interval value in seconds
9803     *
9804     * This interval value is @b decreased while the user holds the
9805     * mouse pointer either incrementing or decrementing a given the
9806     * clock digit's value.
9807     *
9808     * This helps the user to get to a given time distant from the
9809     * current one easier/faster, as it will start to flip quicker and
9810     * quicker on mouse button holds.
9811     *
9812     * The calculation for the next flip interval value, starting from
9813     * the one set with this call, is the previous interval divided by
9814     * 1.05, so it decreases a little bit.
9815     *
9816     * The default starting interval value for automatic flips is
9817     * @b 0.85 seconds.
9818     *
9819     * @see elm_clock_interval_get()
9820     *
9821     * @ingroup Clock
9822     */
9823    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9824
9825    /**
9826     * Get the interval on time updates for an user mouse button hold
9827     * on clock widgets' time edition.
9828     *
9829     * @param obj The clock object
9830     * @return The (first) interval value, in seconds, set on it
9831     *
9832     * @see elm_clock_interval_set() for more details
9833     *
9834     * @ingroup Clock
9835     */
9836    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9837
9838    /**
9839     * @}
9840     */
9841
9842    /**
9843     * @defgroup Layout Layout
9844     *
9845     * @image html img/widget/layout/preview-00.png
9846     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9847     *
9848     * @image html img/layout-predefined.png
9849     * @image latex img/layout-predefined.eps width=\textwidth
9850     *
9851     * This is a container widget that takes a standard Edje design file and
9852     * wraps it very thinly in a widget.
9853     *
9854     * An Edje design (theme) file has a very wide range of possibilities to
9855     * describe the behavior of elements added to the Layout. Check out the Edje
9856     * documentation and the EDC reference to get more information about what can
9857     * be done with Edje.
9858     *
9859     * Just like @ref List, @ref Box, and other container widgets, any
9860     * object added to the Layout will become its child, meaning that it will be
9861     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9862     *
9863     * The Layout widget can contain as many Contents, Boxes or Tables as
9864     * described in its theme file. For instance, objects can be added to
9865     * different Tables by specifying the respective Table part names. The same
9866     * is valid for Content and Box.
9867     *
9868     * The objects added as child of the Layout will behave as described in the
9869     * part description where they were added. There are 3 possible types of
9870     * parts where a child can be added:
9871     *
9872     * @section secContent Content (SWALLOW part)
9873     *
9874     * Only one object can be added to the @c SWALLOW part (but you still can
9875     * have many @c SWALLOW parts and one object on each of them). Use the @c
9876     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9877     * objects as content of the @c SWALLOW. After being set to this part, the 
9878     * object size, position, visibility, clipping and other description 
9879     * properties will be totally controled by the description of the given part 
9880     * (inside the Edje theme file).
9881     *
9882     * One can use @c evas_object_size_hint_* functions on the child to have some
9883     * kind of control over its behavior, but the resulting behavior will still
9884     * depend heavily on the @c SWALLOW part description.
9885     *
9886     * The Edje theme also can change the part description, based on signals or
9887     * scripts running inside the theme. This change can also be animated. All of
9888     * this will affect the child object set as content accordingly. The object
9889     * size will be changed if the part size is changed, it will animate move if
9890     * the part is moving, and so on.
9891     *
9892     * The following picture demonstrates a Layout widget with a child object
9893     * added to its @c SWALLOW:
9894     *
9895     * @image html layout_swallow.png
9896     * @image latex layout_swallow.eps width=\textwidth
9897     *
9898     * @section secBox Box (BOX part)
9899     *
9900     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9901     * allows one to add objects to the box and have them distributed along its
9902     * area, accordingly to the specified @a layout property (now by @a layout we
9903     * mean the chosen layouting design of the Box, not the Layout widget
9904     * itself).
9905     *
9906     * A similar effect for having a box with its position, size and other things
9907     * controled by the Layout theme would be to create an Elementary @ref Box
9908     * widget and add it as a Content in the @c SWALLOW part.
9909     *
9910     * The main difference of using the Layout Box is that its behavior, the box
9911     * properties like layouting format, padding, align, etc. will be all
9912     * controled by the theme. This means, for example, that a signal could be
9913     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9914     * handled the signal by changing the box padding, or align, or both. Using
9915     * the Elementary @ref Box widget is not necessarily harder or easier, it
9916     * just depends on the circunstances and requirements.
9917     *
9918     * The Layout Box can be used through the @c elm_layout_box_* set of
9919     * functions.
9920     *
9921     * The following picture demonstrates a Layout widget with many child objects
9922     * added to its @c BOX part:
9923     *
9924     * @image html layout_box.png
9925     * @image latex layout_box.eps width=\textwidth
9926     *
9927     * @section secTable Table (TABLE part)
9928     *
9929     * Just like the @ref secBox, the Layout Table is very similar to the
9930     * Elementary @ref Table widget. It allows one to add objects to the Table
9931     * specifying the row and column where the object should be added, and any
9932     * column or row span if necessary.
9933     *
9934     * Again, we could have this design by adding a @ref Table widget to the @c
9935     * SWALLOW part using elm_object_part_content_set(). The same difference happens
9936     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9937     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9938     *
9939     * The Layout Table can be used through the @c elm_layout_table_* set of
9940     * functions.
9941     *
9942     * The following picture demonstrates a Layout widget with many child objects
9943     * added to its @c TABLE part:
9944     *
9945     * @image html layout_table.png
9946     * @image latex layout_table.eps width=\textwidth
9947     *
9948     * @section secPredef Predefined Layouts
9949     *
9950     * Another interesting thing about the Layout widget is that it offers some
9951     * predefined themes that come with the default Elementary theme. These
9952     * themes can be set by the call elm_layout_theme_set(), and provide some
9953     * basic functionality depending on the theme used.
9954     *
9955     * Most of them already send some signals, some already provide a toolbar or
9956     * back and next buttons.
9957     *
9958     * These are available predefined theme layouts. All of them have class = @c
9959     * layout, group = @c application, and style = one of the following options:
9960     *
9961     * @li @c toolbar-content - application with toolbar and main content area
9962     * @li @c toolbar-content-back - application with toolbar and main content
9963     * area with a back button and title area
9964     * @li @c toolbar-content-back-next - application with toolbar and main
9965     * content area with a back and next buttons and title area
9966     * @li @c content-back - application with a main content area with a back
9967     * button and title area
9968     * @li @c content-back-next - application with a main content area with a
9969     * back and next buttons and title area
9970     * @li @c toolbar-vbox - application with toolbar and main content area as a
9971     * vertical box
9972     * @li @c toolbar-table - application with toolbar and main content area as a
9973     * table
9974     *
9975     * @section secExamples Examples
9976     *
9977     * Some examples of the Layout widget can be found here:
9978     * @li @ref layout_example_01
9979     * @li @ref layout_example_02
9980     * @li @ref layout_example_03
9981     * @li @ref layout_example_edc
9982     *
9983     */
9984
9985    /**
9986     * Add a new layout to the parent
9987     *
9988     * @param parent The parent object
9989     * @return The new object or NULL if it cannot be created
9990     *
9991     * @see elm_layout_file_set()
9992     * @see elm_layout_theme_set()
9993     *
9994     * @ingroup Layout
9995     */
9996    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9997    /**
9998     * Set the file that will be used as layout
9999     *
10000     * @param obj The layout object
10001     * @param file The path to file (edj) that will be used as layout
10002     * @param group The group that the layout belongs in edje file
10003     *
10004     * @return (1 = success, 0 = error)
10005     *
10006     * @ingroup Layout
10007     */
10008    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10009    /**
10010     * Set the edje group from the elementary theme that will be used as layout
10011     *
10012     * @param obj The layout object
10013     * @param clas the clas of the group
10014     * @param group the group
10015     * @param style the style to used
10016     *
10017     * @return (1 = success, 0 = error)
10018     *
10019     * @ingroup Layout
10020     */
10021    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10022    /**
10023     * Set the layout content.
10024     *
10025     * @param obj The layout object
10026     * @param swallow The swallow part name in the edje file
10027     * @param content The child that will be added in this layout object
10028     *
10029     * Once the content object is set, a previously set one will be deleted.
10030     * If you want to keep that old content object, use the
10031     * elm_object_part_content_unset() function.
10032     *
10033     * @note In an Edje theme, the part used as a content container is called @c
10034     * SWALLOW. This is why the parameter name is called @p swallow, but it is
10035     * expected to be a part name just like the second parameter of
10036     * elm_layout_box_append().
10037     *
10038     * @see elm_layout_box_append()
10039     * @see elm_object_part_content_get()
10040     * @see elm_object_part_content_unset()
10041     * @see @ref secBox
10042     * @deprecated use elm_object_part_content_set() instead
10043     *
10044     * @ingroup Layout
10045     */
10046    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10047    /**
10048     * Get the child object in the given content part.
10049     *
10050     * @param obj The layout object
10051     * @param swallow The SWALLOW part to get its content
10052     *
10053     * @return The swallowed object or NULL if none or an error occurred
10054     *
10055     * @deprecated use elm_object_part_content_get() instead
10056     *
10057     * @ingroup Layout
10058     */
10059    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10060    /**
10061     * Unset the layout content.
10062     *
10063     * @param obj The layout object
10064     * @param swallow The swallow part name in the edje file
10065     * @return The content that was being used
10066     *
10067     * Unparent and return the content object which was set for this part.
10068     *
10069     * @deprecated use elm_object_part_content_unset() instead
10070     *
10071     * @ingroup Layout
10072     */
10073    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10074    /**
10075     * Set the text of the given part
10076     *
10077     * @param obj The layout object
10078     * @param part The TEXT part where to set the text
10079     * @param text The text to set
10080     *
10081     * @ingroup Layout
10082     * @deprecated use elm_object_part_text_set() instead.
10083     */
10084    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10085    /**
10086     * Get the text set in the given part
10087     *
10088     * @param obj The layout object
10089     * @param part The TEXT part to retrieve the text off
10090     *
10091     * @return The text set in @p part
10092     *
10093     * @ingroup Layout
10094     * @deprecated use elm_object_part_text_get() instead.
10095     */
10096    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10097    /**
10098     * Append child to layout box part.
10099     *
10100     * @param obj the layout object
10101     * @param part the box part to which the object will be appended.
10102     * @param child the child object to append to box.
10103     *
10104     * Once the object is appended, it will become child of the layout. Its
10105     * lifetime will be bound to the layout, whenever the layout dies the child
10106     * will be deleted automatically. One should use elm_layout_box_remove() to
10107     * make this layout forget about the object.
10108     *
10109     * @see elm_layout_box_prepend()
10110     * @see elm_layout_box_insert_before()
10111     * @see elm_layout_box_insert_at()
10112     * @see elm_layout_box_remove()
10113     *
10114     * @ingroup Layout
10115     */
10116    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10117    /**
10118     * Prepend child to layout box part.
10119     *
10120     * @param obj the layout object
10121     * @param part the box part to prepend.
10122     * @param child the child object to prepend to box.
10123     *
10124     * Once the object is prepended, it will become child of the layout. Its
10125     * lifetime will be bound to the layout, whenever the layout dies the child
10126     * will be deleted automatically. One should use elm_layout_box_remove() to
10127     * make this layout forget about the object.
10128     *
10129     * @see elm_layout_box_append()
10130     * @see elm_layout_box_insert_before()
10131     * @see elm_layout_box_insert_at()
10132     * @see elm_layout_box_remove()
10133     *
10134     * @ingroup Layout
10135     */
10136    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10137    /**
10138     * Insert child to layout box part before a reference object.
10139     *
10140     * @param obj the layout object
10141     * @param part the box part to insert.
10142     * @param child the child object to insert into box.
10143     * @param reference another reference object to insert before in box.
10144     *
10145     * Once the object is inserted, it will become child of the layout. Its
10146     * lifetime will be bound to the layout, whenever the layout dies the child
10147     * will be deleted automatically. One should use elm_layout_box_remove() to
10148     * make this layout forget about the object.
10149     *
10150     * @see elm_layout_box_append()
10151     * @see elm_layout_box_prepend()
10152     * @see elm_layout_box_insert_before()
10153     * @see elm_layout_box_remove()
10154     *
10155     * @ingroup Layout
10156     */
10157    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10158    /**
10159     * Insert child to layout box part at a given position.
10160     *
10161     * @param obj the layout object
10162     * @param part the box part to insert.
10163     * @param child the child object to insert into box.
10164     * @param pos the numeric position >=0 to insert the child.
10165     *
10166     * Once the object is inserted, it will become child of the layout. Its
10167     * lifetime will be bound to the layout, whenever the layout dies the child
10168     * will be deleted automatically. One should use elm_layout_box_remove() to
10169     * make this layout forget about the object.
10170     *
10171     * @see elm_layout_box_append()
10172     * @see elm_layout_box_prepend()
10173     * @see elm_layout_box_insert_before()
10174     * @see elm_layout_box_remove()
10175     *
10176     * @ingroup Layout
10177     */
10178    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10179    /**
10180     * Remove a child of the given part box.
10181     *
10182     * @param obj The layout object
10183     * @param part The box part name to remove child.
10184     * @param child The object to remove from box.
10185     * @return The object that was being used, or NULL if not found.
10186     *
10187     * The object will be removed from the box part and its lifetime will
10188     * not be handled by the layout anymore. This is equivalent to
10189     * elm_object_part_content_unset() for box.
10190     *
10191     * @see elm_layout_box_append()
10192     * @see elm_layout_box_remove_all()
10193     *
10194     * @ingroup Layout
10195     */
10196    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10197    /**
10198     * Remove all child of the given part box.
10199     *
10200     * @param obj The layout object
10201     * @param part The box part name to remove child.
10202     * @param clear If EINA_TRUE, then all objects will be deleted as
10203     *        well, otherwise they will just be removed and will be
10204     *        dangling on the canvas.
10205     *
10206     * The objects will be removed from the box part and their lifetime will
10207     * not be handled by the layout anymore. This is equivalent to
10208     * elm_layout_box_remove() for all box children.
10209     *
10210     * @see elm_layout_box_append()
10211     * @see elm_layout_box_remove()
10212     *
10213     * @ingroup Layout
10214     */
10215    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10216    /**
10217     * Insert child to layout table part.
10218     *
10219     * @param obj the layout object
10220     * @param part the box part to pack child.
10221     * @param child_obj the child object to pack into table.
10222     * @param col the column to which the child should be added. (>= 0)
10223     * @param row the row to which the child should be added. (>= 0)
10224     * @param colspan how many columns should be used to store this object. (>=
10225     *        1)
10226     * @param rowspan how many rows should be used to store this object. (>= 1)
10227     *
10228     * Once the object is inserted, it will become child of the table. Its
10229     * lifetime will be bound to the layout, and whenever the layout dies the
10230     * child will be deleted automatically. One should use
10231     * elm_layout_table_remove() to make this layout forget about the object.
10232     *
10233     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10234     * more space than a single cell. For instance, the following code:
10235     * @code
10236     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10237     * @endcode
10238     *
10239     * Would result in an object being added like the following picture:
10240     *
10241     * @image html layout_colspan.png
10242     * @image latex layout_colspan.eps width=\textwidth
10243     *
10244     * @see elm_layout_table_unpack()
10245     * @see elm_layout_table_clear()
10246     *
10247     * @ingroup Layout
10248     */
10249    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);
10250    /**
10251     * Unpack (remove) a child of the given part table.
10252     *
10253     * @param obj The layout object
10254     * @param part The table part name to remove child.
10255     * @param child_obj The object to remove from table.
10256     * @return The object that was being used, or NULL if not found.
10257     *
10258     * The object will be unpacked from the table part and its lifetime
10259     * will not be handled by the layout anymore. This is equivalent to
10260     * elm_object_part_content_unset() for table.
10261     *
10262     * @see elm_layout_table_pack()
10263     * @see elm_layout_table_clear()
10264     *
10265     * @ingroup Layout
10266     */
10267    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10268    /**
10269     * Remove all child of the given part table.
10270     *
10271     * @param obj The layout object
10272     * @param part The table part name to remove child.
10273     * @param clear If EINA_TRUE, then all objects will be deleted as
10274     *        well, otherwise they will just be removed and will be
10275     *        dangling on the canvas.
10276     *
10277     * The objects will be removed from the table part and their lifetime will
10278     * not be handled by the layout anymore. This is equivalent to
10279     * elm_layout_table_unpack() for all table children.
10280     *
10281     * @see elm_layout_table_pack()
10282     * @see elm_layout_table_unpack()
10283     *
10284     * @ingroup Layout
10285     */
10286    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10287    /**
10288     * Get the edje layout
10289     *
10290     * @param obj The layout object
10291     *
10292     * @return A Evas_Object with the edje layout settings loaded
10293     * with function elm_layout_file_set
10294     *
10295     * This returns the edje object. It is not expected to be used to then
10296     * swallow objects via edje_object_part_swallow() for example. Use
10297     * elm_object_part_content_set() instead so child object handling and sizing is
10298     * done properly.
10299     *
10300     * @note This function should only be used if you really need to call some
10301     * low level Edje function on this edje object. All the common stuff (setting
10302     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10303     * with proper elementary functions.
10304     *
10305     * @see elm_object_signal_callback_add()
10306     * @see elm_object_signal_emit()
10307     * @see elm_object_part_text_set()
10308     * @see elm_object_part_content_set()
10309     * @see elm_layout_box_append()
10310     * @see elm_layout_table_pack()
10311     * @see elm_layout_data_get()
10312     *
10313     * @ingroup Layout
10314     */
10315    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10316    /**
10317     * Get the edje data from the given layout
10318     *
10319     * @param obj The layout object
10320     * @param key The data key
10321     *
10322     * @return The edje data string
10323     *
10324     * This function fetches data specified inside the edje theme of this layout.
10325     * This function return NULL if data is not found.
10326     *
10327     * In EDC this comes from a data block within the group block that @p
10328     * obj was loaded from. E.g.
10329     *
10330     * @code
10331     * collections {
10332     *   group {
10333     *     name: "a_group";
10334     *     data {
10335     *       item: "key1" "value1";
10336     *       item: "key2" "value2";
10337     *     }
10338     *   }
10339     * }
10340     * @endcode
10341     *
10342     * @ingroup Layout
10343     */
10344    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10345    /**
10346     * Eval sizing
10347     *
10348     * @param obj The layout object
10349     *
10350     * Manually forces a sizing re-evaluation. This is useful when the minimum
10351     * size required by the edje theme of this layout has changed. The change on
10352     * the minimum size required by the edje theme is not immediately reported to
10353     * the elementary layout, so one needs to call this function in order to tell
10354     * the widget (layout) that it needs to reevaluate its own size.
10355     *
10356     * The minimum size of the theme is calculated based on minimum size of
10357     * parts, the size of elements inside containers like box and table, etc. All
10358     * of this can change due to state changes, and that's when this function
10359     * should be called.
10360     *
10361     * Also note that a standard signal of "size,eval" "elm" emitted from the
10362     * edje object will cause this to happen too.
10363     *
10364     * @ingroup Layout
10365     */
10366    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10367
10368    /**
10369     * Sets a specific cursor for an edje part.
10370     *
10371     * @param obj The layout object.
10372     * @param part_name a part from loaded edje group.
10373     * @param cursor cursor name to use, see Elementary_Cursor.h
10374     *
10375     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10376     *         part not exists or it has "mouse_events: 0".
10377     *
10378     * @ingroup Layout
10379     */
10380    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10381
10382    /**
10383     * Get the cursor to be shown when mouse is over an edje part
10384     *
10385     * @param obj The layout object.
10386     * @param part_name a part from loaded edje group.
10387     * @return the cursor name.
10388     *
10389     * @ingroup Layout
10390     */
10391    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10392
10393    /**
10394     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10395     *
10396     * @param obj The layout object.
10397     * @param part_name a part from loaded edje group, that had a cursor set
10398     *        with elm_layout_part_cursor_set().
10399     *
10400     * @ingroup Layout
10401     */
10402    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10403
10404    /**
10405     * Sets a specific cursor style for an edje part.
10406     *
10407     * @param obj The layout object.
10408     * @param part_name a part from loaded edje group.
10409     * @param style the theme style to use (default, transparent, ...)
10410     *
10411     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10412     *         part not exists or it did not had a cursor set.
10413     *
10414     * @ingroup Layout
10415     */
10416    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10417
10418    /**
10419     * Gets a specific cursor style for an edje part.
10420     *
10421     * @param obj The layout object.
10422     * @param part_name a part from loaded edje group.
10423     *
10424     * @return the theme style in use, defaults to "default". If the
10425     *         object does not have a cursor set, then NULL is returned.
10426     *
10427     * @ingroup Layout
10428     */
10429    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10430
10431    /**
10432     * Sets if the cursor set should be searched on the theme or should use
10433     * the provided by the engine, only.
10434     *
10435     * @note before you set if should look on theme you should define a
10436     * cursor with elm_layout_part_cursor_set(). By default it will only
10437     * look for cursors provided by the engine.
10438     *
10439     * @param obj The layout object.
10440     * @param part_name a part from loaded edje group.
10441     * @param engine_only if cursors should be just provided by the engine
10442     *        or should also search on widget's theme as well
10443     *
10444     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10445     *         part not exists or it did not had a cursor set.
10446     *
10447     * @ingroup Layout
10448     */
10449    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);
10450
10451    /**
10452     * Gets a specific cursor engine_only for an edje part.
10453     *
10454     * @param obj The layout object.
10455     * @param part_name a part from loaded edje group.
10456     *
10457     * @return whenever the cursor is just provided by engine or also from theme.
10458     *
10459     * @ingroup Layout
10460     */
10461    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10462
10463 /**
10464  * @def elm_layout_icon_set
10465  * Convienience macro to set the icon object in a layout that follows the
10466  * Elementary naming convention for its parts.
10467  *
10468  * @ingroup Layout
10469  */
10470 #define elm_layout_icon_set(_ly, _obj) \
10471   do { \
10472     const char *sig; \
10473     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10474     if ((_obj)) sig = "elm,state,icon,visible"; \
10475     else sig = "elm,state,icon,hidden"; \
10476     elm_object_signal_emit((_ly), sig, "elm"); \
10477   } while (0)
10478
10479 /**
10480  * @def elm_layout_icon_get
10481  * Convienience macro to get the icon object from a layout that follows the
10482  * Elementary naming convention for its parts.
10483  *
10484  * @ingroup Layout
10485  */
10486 #define elm_layout_icon_get(_ly) \
10487   elm_object_part_content_get((_ly), "elm.swallow.icon")
10488
10489 /**
10490  * @def elm_layout_end_set
10491  * Convienience macro to set the end object in a layout that follows the
10492  * Elementary naming convention for its parts.
10493  *
10494  * @ingroup Layout
10495  */
10496 #define elm_layout_end_set(_ly, _obj) \
10497   do { \
10498     const char *sig; \
10499     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10500     if ((_obj)) sig = "elm,state,end,visible"; \
10501     else sig = "elm,state,end,hidden"; \
10502     elm_object_signal_emit((_ly), sig, "elm"); \
10503   } while (0)
10504
10505 /**
10506  * @def elm_layout_end_get
10507  * Convienience macro to get the end object in a layout that follows the
10508  * Elementary naming convention for its parts.
10509  *
10510  * @ingroup Layout
10511  */
10512 #define elm_layout_end_get(_ly) \
10513   elm_object_part_content_get((_ly), "elm.swallow.end")
10514
10515 /**
10516  * @def elm_layout_label_set
10517  * Convienience macro to set 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_set(_ly, _txt) \
10524   elm_layout_text_set((_ly), "elm.text", (_txt))
10525
10526 /**
10527  * @def elm_layout_label_get
10528  * Convenience macro to get the label in a layout that follows the
10529  * Elementary naming convention for its parts.
10530  *
10531  * @ingroup Layout
10532  * @deprecated use elm_object_text_set() instead.
10533  */
10534 #define elm_layout_label_get(_ly) \
10535   elm_layout_text_get((_ly), "elm.text")
10536
10537    /* smart callbacks called:
10538     * "theme,changed" - when elm theme is changed.
10539     */
10540
10541    /**
10542     * @defgroup Notify Notify
10543     *
10544     * @image html img/widget/notify/preview-00.png
10545     * @image latex img/widget/notify/preview-00.eps
10546     *
10547     * Display a container in a particular region of the parent(top, bottom,
10548     * etc).  A timeout can be set to automatically hide the notify. This is so
10549     * that, after an evas_object_show() on a notify object, if a timeout was set
10550     * on it, it will @b automatically get hidden after that time.
10551     *
10552     * Signals that you can add callbacks for are:
10553     * @li "timeout" - when timeout happens on notify and it's hidden
10554     * @li "block,clicked" - when a click outside of the notify happens
10555     *
10556     * Default contents parts of the notify widget that you can use for are:
10557     * @li "default" - A content of the notify
10558     *
10559     * @ref tutorial_notify show usage of the API.
10560     *
10561     * @{
10562     */
10563    /**
10564     * @brief Possible orient values for notify.
10565     *
10566     * This values should be used in conjunction to elm_notify_orient_set() to
10567     * set the position in which the notify should appear(relative to its parent)
10568     * and in conjunction with elm_notify_orient_get() to know where the notify
10569     * is appearing.
10570     */
10571    typedef enum _Elm_Notify_Orient
10572      {
10573         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10574         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10575         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10576         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10577         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10578         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10579         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10580         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10581         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10582         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10583      } Elm_Notify_Orient;
10584    /**
10585     * @brief Add a new notify to the parent
10586     *
10587     * @param parent The parent object
10588     * @return The new object or NULL if it cannot be created
10589     */
10590    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10591    /**
10592     * @brief Set the content of the notify widget
10593     *
10594     * @param obj The notify object
10595     * @param content The content will be filled in this notify object
10596     *
10597     * Once the content object is set, a previously set one will be deleted. If
10598     * you want to keep that old content object, use the
10599     * elm_notify_content_unset() function.
10600     *
10601     * @deprecated use elm_object_content_set() instead
10602     *
10603     */
10604    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10605    /**
10606     * @brief Unset the content of the notify widget
10607     *
10608     * @param obj The notify object
10609     * @return The content that was being used
10610     *
10611     * Unparent and return the content object which was set for this widget
10612     *
10613     * @see elm_notify_content_set()
10614     * @deprecated use elm_object_content_unset() instead
10615     *
10616     */
10617    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10618    /**
10619     * @brief Return the content of the notify widget
10620     *
10621     * @param obj The notify object
10622     * @return The content that is being used
10623     *
10624     * @see elm_notify_content_set()
10625     * @deprecated use elm_object_content_get() instead
10626     *
10627     */
10628    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10629    /**
10630     * @brief Set the notify parent
10631     *
10632     * @param obj The notify object
10633     * @param content The new parent
10634     *
10635     * Once the parent object is set, a previously set one will be disconnected
10636     * and replaced.
10637     */
10638    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10639    /**
10640     * @brief Get the notify parent
10641     *
10642     * @param obj The notify object
10643     * @return The parent
10644     *
10645     * @see elm_notify_parent_set()
10646     */
10647    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10648    /**
10649     * @brief Set the orientation
10650     *
10651     * @param obj The notify object
10652     * @param orient The new orientation
10653     *
10654     * Sets the position in which the notify will appear in its parent.
10655     *
10656     * @see @ref Elm_Notify_Orient for possible values.
10657     */
10658    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10659    /**
10660     * @brief Return the orientation
10661     * @param obj The notify object
10662     * @return The orientation of the notification
10663     *
10664     * @see elm_notify_orient_set()
10665     * @see Elm_Notify_Orient
10666     */
10667    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10668    /**
10669     * @brief Set the time interval after which the notify window is going to be
10670     * hidden.
10671     *
10672     * @param obj The notify object
10673     * @param time The timeout in seconds
10674     *
10675     * This function sets a timeout and starts the timer controlling when the
10676     * notify is hidden. Since calling evas_object_show() on a notify restarts
10677     * the timer controlling when the notify is hidden, setting this before the
10678     * notify is shown will in effect mean starting the timer when the notify is
10679     * shown.
10680     *
10681     * @note Set a value <= 0.0 to disable a running timer.
10682     *
10683     * @note If the value > 0.0 and the notify is previously visible, the
10684     * timer will be started with this value, canceling any running timer.
10685     */
10686    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10687    /**
10688     * @brief Return the timeout value (in seconds)
10689     * @param obj the notify object
10690     *
10691     * @see elm_notify_timeout_set()
10692     */
10693    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10694    /**
10695     * @brief Sets whether events should be passed to by a click outside
10696     * its area.
10697     *
10698     * @param obj The notify object
10699     * @param repeats EINA_TRUE Events are repeats, else no
10700     *
10701     * When true if the user clicks outside the window the events will be caught
10702     * by the others widgets, else the events are blocked.
10703     *
10704     * @note The default value is EINA_TRUE.
10705     */
10706    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10707    /**
10708     * @brief Return true if events are repeat below the notify object
10709     * @param obj the notify object
10710     *
10711     * @see elm_notify_repeat_events_set()
10712     */
10713    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10714    /**
10715     * @}
10716     */
10717
10718    /**
10719     * @defgroup Hover Hover
10720     *
10721     * @image html img/widget/hover/preview-00.png
10722     * @image latex img/widget/hover/preview-00.eps
10723     *
10724     * A Hover object will hover over its @p parent object at the @p target
10725     * location. Anything in the background will be given a darker coloring to
10726     * indicate that the hover object is on top (at the default theme). When the
10727     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10728     * clicked that @b doesn't cause the hover to be dismissed.
10729     *
10730     * A Hover object has two parents. One parent that owns it during creation
10731     * and the other parent being the one over which the hover object spans.
10732     *
10733     *
10734     * @note The hover object will take up the entire space of @p target
10735     * object.
10736     *
10737     * Elementary has the following styles for the hover widget:
10738     * @li default
10739     * @li popout
10740     * @li menu
10741     * @li hoversel_vertical
10742     *
10743     * The following are the available position for content:
10744     * @li left
10745     * @li top-left
10746     * @li top
10747     * @li top-right
10748     * @li right
10749     * @li bottom-right
10750     * @li bottom
10751     * @li bottom-left
10752     * @li middle
10753     * @li smart
10754     *
10755     * Signals that you can add callbacks for are:
10756     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10757     * @li "smart,changed" - a content object placed under the "smart"
10758     *                   policy was replaced to a new slot direction.
10759     *
10760     * See @ref tutorial_hover for more information.
10761     *
10762     * @{
10763     */
10764    typedef enum _Elm_Hover_Axis
10765      {
10766         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10767         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10768         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10769         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10770      } Elm_Hover_Axis;
10771    /**
10772     * @brief Adds a hover object to @p parent
10773     *
10774     * @param parent The parent object
10775     * @return The hover object or NULL if one could not be created
10776     */
10777    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10778    /**
10779     * @brief Sets the target object for the hover.
10780     *
10781     * @param obj The hover object
10782     * @param target The object to center the hover onto. The hover
10783     *
10784     * This function will cause the hover to be centered on the target object.
10785     */
10786    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10787    /**
10788     * @brief Gets the target object for the hover.
10789     *
10790     * @param obj The hover object
10791     * @param parent The object to locate the hover over.
10792     *
10793     * @see elm_hover_target_set()
10794     */
10795    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10796    /**
10797     * @brief Sets the parent object for the hover.
10798     *
10799     * @param obj The hover object
10800     * @param parent The object to locate the hover over.
10801     *
10802     * This function will cause the hover to take up the entire space that the
10803     * parent object fills.
10804     */
10805    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10806    /**
10807     * @brief Gets the parent object for the hover.
10808     *
10809     * @param obj The hover object
10810     * @return The parent object to locate the hover over.
10811     *
10812     * @see elm_hover_parent_set()
10813     */
10814    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10815    /**
10816     * @brief Sets the content of the hover object and the direction in which it
10817     * will pop out.
10818     *
10819     * @param obj The hover object
10820     * @param swallow The direction that the object will be displayed
10821     * at. Accepted values are "left", "top-left", "top", "top-right",
10822     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10823     * "smart".
10824     * @param content The content to place at @p swallow
10825     *
10826     * Once the content object is set for a given direction, a previously
10827     * set one (on the same direction) will be deleted. If you want to
10828     * keep that old content object, use the elm_hover_content_unset()
10829     * function.
10830     *
10831     * All directions may have contents at the same time, except for
10832     * "smart". This is a special placement hint and its use case
10833     * independs of the calculations coming from
10834     * elm_hover_best_content_location_get(). Its use is for cases when
10835     * one desires only one hover content, but with a dinamic special
10836     * placement within the hover area. The content's geometry, whenever
10837     * it changes, will be used to decide on a best location not
10838     * extrapolating the hover's parent object view to show it in (still
10839     * being the hover's target determinant of its medium part -- move and
10840     * resize it to simulate finger sizes, for example). If one of the
10841     * directions other than "smart" are used, a previously content set
10842     * using it will be deleted, and vice-versa.
10843     */
10844    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10845    /**
10846     * @brief Get the content of the hover object, in a given direction.
10847     *
10848     * Return the content object which was set for this widget in the
10849     * @p swallow direction.
10850     *
10851     * @param obj The hover object
10852     * @param swallow The direction that the object was display at.
10853     * @return The content that was being used
10854     *
10855     * @see elm_hover_content_set()
10856     */
10857    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10858    /**
10859     * @brief Unset the content of the hover object, in a given direction.
10860     *
10861     * Unparent and return the content object set at @p swallow direction.
10862     *
10863     * @param obj The hover object
10864     * @param swallow The direction that the object was display at.
10865     * @return The content that was being used.
10866     *
10867     * @see elm_hover_content_set()
10868     */
10869    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10870    /**
10871     * @brief Returns the best swallow location for content in the hover.
10872     *
10873     * @param obj The hover object
10874     * @param pref_axis The preferred orientation axis for the hover object to use
10875     * @return The edje location to place content into the hover or @c
10876     *         NULL, on errors.
10877     *
10878     * Best is defined here as the location at which there is the most available
10879     * space.
10880     *
10881     * @p pref_axis may be one of
10882     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10883     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10884     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10885     * - @c ELM_HOVER_AXIS_BOTH -- both
10886     *
10887     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10888     * nescessarily be along the horizontal axis("left" or "right"). If
10889     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10890     * be along the vertical axis("top" or "bottom"). Chossing
10891     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10892     * returned position may be in either axis.
10893     *
10894     * @see elm_hover_content_set()
10895     */
10896    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10897    /**
10898     * @}
10899     */
10900
10901    /* entry */
10902    /**
10903     * @defgroup Entry Entry
10904     *
10905     * @image html img/widget/entry/preview-00.png
10906     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10907     * @image html img/widget/entry/preview-01.png
10908     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10909     * @image html img/widget/entry/preview-02.png
10910     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10911     * @image html img/widget/entry/preview-03.png
10912     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10913     *
10914     * An entry is a convenience widget which shows a box that the user can
10915     * enter text into. Entries by default don't scroll, so they grow to
10916     * accomodate the entire text, resizing the parent window as needed. This
10917     * can be changed with the elm_entry_scrollable_set() function.
10918     *
10919     * They can also be single line or multi line (the default) and when set
10920     * to multi line mode they support text wrapping in any of the modes
10921     * indicated by #Elm_Wrap_Type.
10922     *
10923     * Other features include password mode, filtering of inserted text with
10924     * elm_entry_text_filter_append() and related functions, inline "items" and
10925     * formatted markup text.
10926     *
10927     * @section entry-markup Formatted text
10928     *
10929     * The markup tags supported by the Entry are defined by the theme, but
10930     * even when writing new themes or extensions it's a good idea to stick to
10931     * a sane default, to maintain coherency and avoid application breakages.
10932     * Currently defined by the default theme are the following tags:
10933     * @li \<br\>: Inserts a line break.
10934     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10935     * breaks.
10936     * @li \<tab\>: Inserts a tab.
10937     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10938     * enclosed text.
10939     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10940     * @li \<link\>...\</link\>: Underlines the enclosed text.
10941     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10942     *
10943     * @section entry-special Special markups
10944     *
10945     * Besides those used to format text, entries support two special markup
10946     * tags used to insert clickable portions of text or items inlined within
10947     * the text.
10948     *
10949     * @subsection entry-anchors Anchors
10950     *
10951     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10952     * \</a\> tags and an event will be generated when this text is clicked,
10953     * like this:
10954     *
10955     * @code
10956     * This text is outside <a href=anc-01>but this one is an anchor</a>
10957     * @endcode
10958     *
10959     * The @c href attribute in the opening tag gives the name that will be
10960     * used to identify the anchor and it can be any valid utf8 string.
10961     *
10962     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10963     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10964     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10965     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10966     * an anchor.
10967     *
10968     * @subsection entry-items Items
10969     *
10970     * Inlined in the text, any other @c Evas_Object can be inserted by using
10971     * \<item\> tags this way:
10972     *
10973     * @code
10974     * <item size=16x16 vsize=full href=emoticon/haha></item>
10975     * @endcode
10976     *
10977     * Just like with anchors, the @c href identifies each item, but these need,
10978     * in addition, to indicate their size, which is done using any one of
10979     * @c size, @c absize or @c relsize attributes. These attributes take their
10980     * value in the WxH format, where W is the width and H the height of the
10981     * item.
10982     *
10983     * @li absize: Absolute pixel size for the item. Whatever value is set will
10984     * be the item's size regardless of any scale value the object may have
10985     * been set to. The final line height will be adjusted to fit larger items.
10986     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10987     * for the object.
10988     * @li relsize: Size is adjusted for the item to fit within the current
10989     * line height.
10990     *
10991     * Besides their size, items are specificed a @c vsize value that affects
10992     * how their final size and position are calculated. The possible values
10993     * are:
10994     * @li ascent: Item will be placed within the line's baseline and its
10995     * ascent. That is, the height between the line where all characters are
10996     * positioned and the highest point in the line. For @c size and @c absize
10997     * items, the descent value will be added to the total line height to make
10998     * them fit. @c relsize items will be adjusted to fit within this space.
10999     * @li full: Items will be placed between the descent and ascent, or the
11000     * lowest point in the line and its highest.
11001     *
11002     * The next image shows different configurations of items and how they
11003     * are the previously mentioned options affect their sizes. In all cases,
11004     * the green line indicates the ascent, blue for the baseline and red for
11005     * the descent.
11006     *
11007     * @image html entry_item.png
11008     * @image latex entry_item.eps width=\textwidth
11009     *
11010     * And another one to show how size differs from absize. In the first one,
11011     * the scale value is set to 1.0, while the second one is using one of 2.0.
11012     *
11013     * @image html entry_item_scale.png
11014     * @image latex entry_item_scale.eps width=\textwidth
11015     *
11016     * After the size for an item is calculated, the entry will request an
11017     * object to place in its space. For this, the functions set with
11018     * elm_entry_item_provider_append() and related functions will be called
11019     * in order until one of them returns a @c non-NULL value. If no providers
11020     * are available, or all of them return @c NULL, then the entry falls back
11021     * to one of the internal defaults, provided the name matches with one of
11022     * them.
11023     *
11024     * All of the following are currently supported:
11025     *
11026     * - emoticon/angry
11027     * - emoticon/angry-shout
11028     * - emoticon/crazy-laugh
11029     * - emoticon/evil-laugh
11030     * - emoticon/evil
11031     * - emoticon/goggle-smile
11032     * - emoticon/grumpy
11033     * - emoticon/grumpy-smile
11034     * - emoticon/guilty
11035     * - emoticon/guilty-smile
11036     * - emoticon/haha
11037     * - emoticon/half-smile
11038     * - emoticon/happy-panting
11039     * - emoticon/happy
11040     * - emoticon/indifferent
11041     * - emoticon/kiss
11042     * - emoticon/knowing-grin
11043     * - emoticon/laugh
11044     * - emoticon/little-bit-sorry
11045     * - emoticon/love-lots
11046     * - emoticon/love
11047     * - emoticon/minimal-smile
11048     * - emoticon/not-happy
11049     * - emoticon/not-impressed
11050     * - emoticon/omg
11051     * - emoticon/opensmile
11052     * - emoticon/smile
11053     * - emoticon/sorry
11054     * - emoticon/squint-laugh
11055     * - emoticon/surprised
11056     * - emoticon/suspicious
11057     * - emoticon/tongue-dangling
11058     * - emoticon/tongue-poke
11059     * - emoticon/uh
11060     * - emoticon/unhappy
11061     * - emoticon/very-sorry
11062     * - emoticon/what
11063     * - emoticon/wink
11064     * - emoticon/worried
11065     * - emoticon/wtf
11066     *
11067     * Alternatively, an item may reference an image by its path, using
11068     * the URI form @c file:///path/to/an/image.png and the entry will then
11069     * use that image for the item.
11070     *
11071     * @section entry-files Loading and saving files
11072     *
11073     * Entries have convinience functions to load text from a file and save
11074     * changes back to it after a short delay. The automatic saving is enabled
11075     * by default, but can be disabled with elm_entry_autosave_set() and files
11076     * can be loaded directly as plain text or have any markup in them
11077     * recognized. See elm_entry_file_set() for more details.
11078     *
11079     * @section entry-signals Emitted signals
11080     *
11081     * This widget emits the following signals:
11082     *
11083     * @li "changed": The text within the entry was changed.
11084     * @li "changed,user": The text within the entry was changed because of user interaction.
11085     * @li "activated": The enter key was pressed on a single line entry.
11086     * @li "press": A mouse button has been pressed on the entry.
11087     * @li "longpressed": A mouse button has been pressed and held for a couple
11088     * seconds.
11089     * @li "clicked": The entry has been clicked (mouse press and release).
11090     * @li "clicked,double": The entry has been double clicked.
11091     * @li "clicked,triple": The entry has been triple clicked.
11092     * @li "focused": The entry has received focus.
11093     * @li "unfocused": The entry has lost focus.
11094     * @li "selection,paste": A paste of the clipboard contents was requested.
11095     * @li "selection,copy": A copy of the selected text into the clipboard was
11096     * requested.
11097     * @li "selection,cut": A cut of the selected text into the clipboard was
11098     * requested.
11099     * @li "selection,start": A selection has begun and no previous selection
11100     * existed.
11101     * @li "selection,changed": The current selection has changed.
11102     * @li "selection,cleared": The current selection has been cleared.
11103     * @li "cursor,changed": The cursor has changed position.
11104     * @li "anchor,clicked": An anchor has been clicked. The event_info
11105     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11106     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11107     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11108     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11109     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11110     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11111     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11112     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11113     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11114     * @li "preedit,changed": The preedit string has changed.
11115     * @li "language,changed": Program language changed.
11116     *
11117     * @section entry-examples
11118     *
11119     * An overview of the Entry API can be seen in @ref entry_example_01
11120     *
11121     * @{
11122     */
11123    /**
11124     * @typedef Elm_Entry_Anchor_Info
11125     *
11126     * The info sent in the callback for the "anchor,clicked" signals emitted
11127     * by entries.
11128     */
11129    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11130    /**
11131     * @struct _Elm_Entry_Anchor_Info
11132     *
11133     * The info sent in the callback for the "anchor,clicked" signals emitted
11134     * by entries.
11135     */
11136    struct _Elm_Entry_Anchor_Info
11137      {
11138         const char *name; /**< The name of the anchor, as stated in its href */
11139         int         button; /**< The mouse button used to click on it */
11140         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11141                     y, /**< Anchor geometry, relative to canvas */
11142                     w, /**< Anchor geometry, relative to canvas */
11143                     h; /**< Anchor geometry, relative to canvas */
11144      };
11145    /**
11146     * @typedef Elm_Entry_Filter_Cb
11147     * This callback type is used by entry filters to modify text.
11148     * @param data The data specified as the last param when adding the filter
11149     * @param entry The entry object
11150     * @param text A pointer to the location of the text being filtered. This data can be modified,
11151     * but any additional allocations must be managed by the user.
11152     * @see elm_entry_text_filter_append
11153     * @see elm_entry_text_filter_prepend
11154     */
11155    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11156
11157    /**
11158     * @typedef Elm_Entry_Change_Info
11159     * This corresponds to Edje_Entry_Change_Info. Includes information about
11160     * a change in the entry.
11161     */
11162    typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11163
11164
11165    /**
11166     * This adds an entry to @p parent object.
11167     *
11168     * By default, entries are:
11169     * @li not scrolled
11170     * @li multi-line
11171     * @li word wrapped
11172     * @li autosave is enabled
11173     *
11174     * @param parent The parent object
11175     * @return The new object or NULL if it cannot be created
11176     */
11177    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11178    /**
11179     * Sets the entry to single line mode.
11180     *
11181     * In single line mode, entries don't ever wrap when the text reaches the
11182     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11183     * key will generate an @c "activate" event instead of adding a new line.
11184     *
11185     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11186     * and pressing enter will break the text into a different line
11187     * without generating any events.
11188     *
11189     * @param obj The entry object
11190     * @param single_line If true, the text in the entry
11191     * will be on a single line.
11192     */
11193    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11194    /**
11195     * Gets whether the entry is set to be single line.
11196     *
11197     * @param obj The entry object
11198     * @return single_line If true, the text in the entry is set to display
11199     * on a single line.
11200     *
11201     * @see elm_entry_single_line_set()
11202     */
11203    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11204    /**
11205     * Sets the entry to password mode.
11206     *
11207     * In password mode, entries are implicitly single line and the display of
11208     * any text in them is replaced with asterisks (*).
11209     *
11210     * @param obj The entry object
11211     * @param password If true, password mode is enabled.
11212     */
11213    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11214    /**
11215     * Gets whether the entry is set to password mode.
11216     *
11217     * @param obj The entry object
11218     * @return If true, the entry is set to display all characters
11219     * as asterisks (*).
11220     *
11221     * @see elm_entry_password_set()
11222     */
11223    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11224    /**
11225     * This sets the text displayed within the entry to @p entry.
11226     *
11227     * @param obj The entry object
11228     * @param entry The text to be displayed
11229     *
11230     * @deprecated Use elm_object_text_set() instead.
11231     * @note Using this function bypasses text filters
11232     */
11233    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11234    /**
11235     * This returns the text currently shown in object @p entry.
11236     * See also elm_entry_entry_set().
11237     *
11238     * @param obj The entry object
11239     * @return The currently displayed text or NULL on failure
11240     *
11241     * @deprecated Use elm_object_text_get() instead.
11242     */
11243    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11244    /**
11245     * Appends @p entry to the text of the entry.
11246     *
11247     * Adds the text in @p entry to the end of any text already present in the
11248     * widget.
11249     *
11250     * The appended text is subject to any filters set for the widget.
11251     *
11252     * @param obj The entry object
11253     * @param entry The text to be displayed
11254     *
11255     * @see elm_entry_text_filter_append()
11256     */
11257    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11258    /**
11259     * Gets whether the entry is empty.
11260     *
11261     * Empty means no text at all. If there are any markup tags, like an item
11262     * tag for which no provider finds anything, and no text is displayed, this
11263     * function still returns EINA_FALSE.
11264     *
11265     * @param obj The entry object
11266     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11267     */
11268    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11269    /**
11270     * Gets any selected text within the entry.
11271     *
11272     * If there's any selected text in the entry, this function returns it as
11273     * a string in markup format. NULL is returned if no selection exists or
11274     * if an error occurred.
11275     *
11276     * The returned value points to an internal string and should not be freed
11277     * or modified in any way. If the @p entry object is deleted or its
11278     * contents are changed, the returned pointer should be considered invalid.
11279     *
11280     * @param obj The entry object
11281     * @return The selected text within the entry or NULL on failure
11282     */
11283    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11284    /**
11285     * Returns the actual textblock object of the entry.
11286     *
11287     * This function exposes the internal textblock object that actually
11288     * contains and draws the text. This should be used for low-level
11289     * manipulations that are otherwise not possible.
11290     *
11291     * Changing the textblock directly from here will not notify edje/elm to
11292     * recalculate the textblock size automatically, so any modifications
11293     * done to the textblock returned by this function should be followed by
11294     * a call to elm_entry_calc_force().
11295     *
11296     * The return value is marked as const as an additional warning.
11297     * One should not use the returned object with any of the generic evas
11298     * functions (geometry_get/resize/move and etc), but only with the textblock
11299     * functions; The former will either not work at all, or break the correct
11300     * functionality.
11301     *
11302     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11303     * the internal textblock object. Do NOT cache the returned object, and try
11304     * not to mix calls on this object with regular elm_entry calls (which may
11305     * change the internal textblock object). This applies to all cursors
11306     * returned from textblock calls, and all the other derivative values.
11307     *
11308     * @param obj The entry object
11309     * @return The textblock object.
11310     */
11311    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11312    /**
11313     * Forces calculation of the entry size and text layouting.
11314     *
11315     * This should be used after modifying the textblock object directly. See
11316     * elm_entry_textblock_get() for more information.
11317     *
11318     * @param obj The entry object
11319     *
11320     * @see elm_entry_textblock_get()
11321     */
11322    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11323    /**
11324     * Inserts the given text into the entry at the current cursor position.
11325     *
11326     * This inserts text at the cursor position as if it was typed
11327     * by the user (note that this also allows markup which a user
11328     * can't just "type" as it would be converted to escaped text, so this
11329     * call can be used to insert things like emoticon items or bold push/pop
11330     * tags, other font and color change tags etc.)
11331     *
11332     * If any selection exists, it will be replaced by the inserted text.
11333     *
11334     * The inserted text is subject to any filters set for the widget.
11335     *
11336     * @param obj The entry object
11337     * @param entry The text to insert
11338     *
11339     * @see elm_entry_text_filter_append()
11340     */
11341    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11342    /**
11343     * Set the line wrap type to use on multi-line entries.
11344     *
11345     * Sets the wrap type used by the entry to any of the specified in
11346     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11347     * line (without inserting a line break or paragraph separator) when it
11348     * reaches the far edge of the widget.
11349     *
11350     * Note that this only makes sense for multi-line entries. A widget set
11351     * to be single line will never wrap.
11352     *
11353     * @param obj The entry object
11354     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11355     */
11356    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11357    /**
11358     * Gets the wrap mode the entry was set to use.
11359     *
11360     * @param obj The entry object
11361     * @return Wrap type
11362     *
11363     * @see also elm_entry_line_wrap_set()
11364     */
11365    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11366    /**
11367     * Sets if the entry is to be editable or not.
11368     *
11369     * By default, entries are editable and when focused, any text input by the
11370     * user will be inserted at the current cursor position. But calling this
11371     * function with @p editable as EINA_FALSE will prevent the user from
11372     * inputting text into the entry.
11373     *
11374     * The only way to change the text of a non-editable entry is to use
11375     * elm_object_text_set(), elm_entry_entry_insert() and other related
11376     * functions.
11377     *
11378     * @param obj The entry object
11379     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11380     * if not, the entry is read-only and no user input is allowed.
11381     */
11382    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11383    /**
11384     * Gets whether the entry is editable or not.
11385     *
11386     * @param obj The entry object
11387     * @return If true, the entry is editable by the user.
11388     * If false, it is not editable by the user
11389     *
11390     * @see elm_entry_editable_set()
11391     */
11392    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11393    /**
11394     * This drops any existing text selection within the entry.
11395     *
11396     * @param obj The entry object
11397     */
11398    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11399    /**
11400     * This selects all text within the entry.
11401     *
11402     * @param obj The entry object
11403     */
11404    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11405    /**
11406     * This moves the cursor one place to the right within the entry.
11407     *
11408     * @param obj The entry object
11409     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11410     */
11411    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11412    /**
11413     * This moves the cursor one place to the left within the entry.
11414     *
11415     * @param obj The entry object
11416     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11417     */
11418    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11419    /**
11420     * This moves the cursor one line up within the entry.
11421     *
11422     * @param obj The entry object
11423     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11424     */
11425    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11426    /**
11427     * This moves the cursor one line down within the entry.
11428     *
11429     * @param obj The entry object
11430     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11431     */
11432    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11433    /**
11434     * This moves the cursor to the beginning of the entry.
11435     *
11436     * @param obj The entry object
11437     */
11438    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11439    /**
11440     * This moves the cursor to the end of the entry.
11441     *
11442     * @param obj The entry object
11443     */
11444    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11445    /**
11446     * This moves the cursor to the beginning of the current line.
11447     *
11448     * @param obj The entry object
11449     */
11450    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11451    /**
11452     * This moves the cursor to the end of the current line.
11453     *
11454     * @param obj The entry object
11455     */
11456    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11457    /**
11458     * This begins a selection within the entry as though
11459     * the user were holding down the mouse button to make a selection.
11460     *
11461     * @param obj The entry object
11462     */
11463    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11464    /**
11465     * This ends a selection within the entry as though
11466     * the user had just released the mouse button while making a selection.
11467     *
11468     * @param obj The entry object
11469     */
11470    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11471    /**
11472     * Gets whether a format node exists at the current cursor position.
11473     *
11474     * A format node is anything that defines how the text is rendered. It can
11475     * be a visible format node, such as a line break or a paragraph separator,
11476     * or an invisible one, such as bold begin or end tag.
11477     * This function returns whether any format node exists at the current
11478     * cursor position.
11479     *
11480     * @param obj The entry object
11481     * @return EINA_TRUE if the current cursor position contains a format node,
11482     * EINA_FALSE otherwise.
11483     *
11484     * @see elm_entry_cursor_is_visible_format_get()
11485     */
11486    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11487    /**
11488     * Gets if the current cursor position holds a visible format node.
11489     *
11490     * @param obj The entry object
11491     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11492     * if it's an invisible one or no format exists.
11493     *
11494     * @see elm_entry_cursor_is_format_get()
11495     */
11496    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11497    /**
11498     * Gets the character pointed by the cursor at its current position.
11499     *
11500     * This function returns a string with the utf8 character stored at the
11501     * current cursor position.
11502     * Only the text is returned, any format that may exist will not be part
11503     * of the return value.
11504     *
11505     * @param obj The entry object
11506     * @return The text pointed by the cursors.
11507     */
11508    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11509    /**
11510     * This function returns the geometry of the cursor.
11511     *
11512     * It's useful if you want to draw something on the cursor (or where it is),
11513     * or for example in the case of scrolled entry where you want to show the
11514     * cursor.
11515     *
11516     * @param obj The entry object
11517     * @param x returned geometry
11518     * @param y returned geometry
11519     * @param w returned geometry
11520     * @param h returned geometry
11521     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11522     */
11523    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);
11524    /**
11525     * Sets the cursor position in the entry to the given value
11526     *
11527     * The value in @p pos is the index of the character position within the
11528     * contents of the string as returned by elm_entry_cursor_pos_get().
11529     *
11530     * @param obj The entry object
11531     * @param pos The position of the cursor
11532     */
11533    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11534    /**
11535     * Retrieves the current position of the cursor in the entry
11536     *
11537     * @param obj The entry object
11538     * @return The cursor position
11539     */
11540    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11541    /**
11542     * This executes a "cut" action on the selected text in the entry.
11543     *
11544     * @param obj The entry object
11545     */
11546    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11547    /**
11548     * This executes a "copy" action on the selected text in the entry.
11549     *
11550     * @param obj The entry object
11551     */
11552    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11553    /**
11554     * This executes a "paste" action in the entry.
11555     *
11556     * @param obj The entry object
11557     */
11558    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11559    /**
11560     * This clears and frees the items in a entry's contextual (longpress)
11561     * menu.
11562     *
11563     * @param obj The entry object
11564     *
11565     * @see elm_entry_context_menu_item_add()
11566     */
11567    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11568    /**
11569     * This adds an item to the entry's contextual menu.
11570     *
11571     * A longpress on an entry will make the contextual menu show up, if this
11572     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11573     * By default, this menu provides a few options like enabling selection mode,
11574     * which is useful on embedded devices that need to be explicit about it,
11575     * and when a selection exists it also shows the copy and cut actions.
11576     *
11577     * With this function, developers can add other options to this menu to
11578     * perform any action they deem necessary.
11579     *
11580     * @param obj The entry object
11581     * @param label The item's text label
11582     * @param icon_file The item's icon file
11583     * @param icon_type The item's icon type
11584     * @param func The callback to execute when the item is clicked
11585     * @param data The data to associate with the item for related functions
11586     */
11587    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);
11588    /**
11589     * This disables the entry's contextual (longpress) menu.
11590     *
11591     * @param obj The entry object
11592     * @param disabled If true, the menu is disabled
11593     */
11594    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11595    /**
11596     * This returns whether the entry's contextual (longpress) menu is
11597     * disabled.
11598     *
11599     * @param obj The entry object
11600     * @return If true, the menu is disabled
11601     */
11602    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11603    /**
11604     * This appends a custom item provider to the list for that entry
11605     *
11606     * This appends the given callback. The list is walked from beginning to end
11607     * with each function called given the item href string in the text. If the
11608     * function returns an object handle other than NULL (it should create an
11609     * object to do this), then this object is used to replace that item. If
11610     * not the next provider is called until one provides an item object, or the
11611     * default provider in entry does.
11612     *
11613     * @param obj The entry object
11614     * @param func The function called to provide the item object
11615     * @param data The data passed to @p func
11616     *
11617     * @see @ref entry-items
11618     */
11619    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);
11620    /**
11621     * This prepends a custom item provider to the list for that entry
11622     *
11623     * This prepends 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_prepend(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11631    /**
11632     * This removes a custom item provider to the list for that entry
11633     *
11634     * This removes the given callback. See elm_entry_item_provider_append() for
11635     * more information
11636     *
11637     * @param obj The entry object
11638     * @param func The function called to provide the item object
11639     * @param data The data passed to @p func
11640     */
11641    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);
11642    /**
11643     * Append a filter function for text inserted in the entry
11644     *
11645     * Append the given callback to the list. This functions will be called
11646     * whenever any text is inserted into the entry, with the text to be inserted
11647     * as a parameter. The callback function is free to alter the text in any way
11648     * it wants, but it must remember to free the given pointer and update it.
11649     * If the new text is to be discarded, the function can free it and set its
11650     * text parameter to NULL. This will also prevent any following filters from
11651     * being called.
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_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11658    /**
11659     * Prepend a filter function for text insdrted in the entry
11660     *
11661     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11662     * for more information
11663     *
11664     * @param obj The entry object
11665     * @param func The function to use as text filter
11666     * @param data User data to pass to @p func
11667     */
11668    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11669    /**
11670     * Remove a filter from the list
11671     *
11672     * Removes the given callback from the filter list. See
11673     * elm_entry_text_filter_append() for more information.
11674     *
11675     * @param obj The entry object
11676     * @param func The filter function to remove
11677     * @param data The user data passed when adding the function
11678     */
11679    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11680    /**
11681     * This converts a markup (HTML-like) string into UTF-8.
11682     *
11683     * The returned string is a malloc'ed buffer and it should be freed when
11684     * not needed anymore.
11685     *
11686     * @param s The string (in markup) to be converted
11687     * @return The converted string (in UTF-8). It should be freed.
11688     */
11689    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11690    /**
11691     * This converts a UTF-8 string into markup (HTML-like).
11692     *
11693     * The returned string is a malloc'ed buffer and it should be freed when
11694     * not needed anymore.
11695     *
11696     * @param s The string (in UTF-8) to be converted
11697     * @return The converted string (in markup). It should be freed.
11698     */
11699    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11700    /**
11701     * This sets the file (and implicitly loads it) for the text to display and
11702     * then edit. All changes are written back to the file after a short delay if
11703     * the entry object is set to autosave (which is the default).
11704     *
11705     * If the entry had any other file set previously, any changes made to it
11706     * will be saved if the autosave feature is enabled, otherwise, the file
11707     * will be silently discarded and any non-saved changes will be lost.
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_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11714    /**
11715     * Gets the file being edited by the entry.
11716     *
11717     * This function can be used to retrieve any file set on the entry for
11718     * edition, along with the format used to load and save it.
11719     *
11720     * @param obj The entry object
11721     * @param file The path to the file to load and save
11722     * @param format The file format
11723     */
11724    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11725    /**
11726     * This function writes any changes made to the file set with
11727     * elm_entry_file_set()
11728     *
11729     * @param obj The entry object
11730     */
11731    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11732    /**
11733     * This sets the entry object to 'autosave' the loaded text file or not.
11734     *
11735     * @param obj The entry object
11736     * @param autosave Autosave the loaded file or not
11737     *
11738     * @see elm_entry_file_set()
11739     */
11740    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11741    /**
11742     * This gets the entry object's 'autosave' status.
11743     *
11744     * @param obj The entry object
11745     * @return Autosave the loaded file or not
11746     *
11747     * @see elm_entry_file_set()
11748     */
11749    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11750    /**
11751     * Control pasting of text and images for the widget.
11752     *
11753     * Normally the entry allows both text and images to be pasted.  By setting
11754     * textonly to be true, this prevents images from being pasted.
11755     *
11756     * Note this only changes the behaviour of text.
11757     *
11758     * @param obj The entry object
11759     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11760     * text+image+other.
11761     */
11762    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11763    /**
11764     * Getting elm_entry text paste/drop mode.
11765     *
11766     * In textonly mode, only text may be pasted or dropped into the widget.
11767     *
11768     * @param obj The entry object
11769     * @return If the widget only accepts text from pastes.
11770     */
11771    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11772    /**
11773     * Enable or disable scrolling in entry
11774     *
11775     * Normally the entry is not scrollable unless you enable it with this call.
11776     *
11777     * @param obj The entry object
11778     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11779     */
11780    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11781    /**
11782     * Get the scrollable state of the entry
11783     *
11784     * Normally the entry is not scrollable. This gets the scrollable state
11785     * of the entry. See elm_entry_scrollable_set() for more information.
11786     *
11787     * @param obj The entry object
11788     * @return The scrollable state
11789     */
11790    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11791    /**
11792     * This sets a widget to be displayed to the left of a scrolled entry.
11793     *
11794     * @param obj The scrolled entry object
11795     * @param icon The widget to display on the left side of the scrolled
11796     * entry.
11797     *
11798     * @note A previously set widget will be destroyed.
11799     * @note If the object being set does not have minimum size hints set,
11800     * it won't get properly displayed.
11801     *
11802     * @see elm_entry_end_set()
11803     */
11804    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11805    /**
11806     * Gets the leftmost widget of the scrolled entry. This object is
11807     * owned by the scrolled entry and should not be modified.
11808     *
11809     * @param obj The scrolled entry object
11810     * @return the left widget inside the scroller
11811     */
11812    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11813    /**
11814     * Unset the leftmost widget of the scrolled entry, unparenting and
11815     * returning it.
11816     *
11817     * @param obj The scrolled entry object
11818     * @return the previously set icon sub-object of this entry, on
11819     * success.
11820     *
11821     * @see elm_entry_icon_set()
11822     */
11823    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11824    /**
11825     * Sets the visibility of the left-side widget of the scrolled entry,
11826     * set by elm_entry_icon_set().
11827     *
11828     * @param obj The scrolled entry object
11829     * @param setting EINA_TRUE if the object should be displayed,
11830     * EINA_FALSE if not.
11831     */
11832    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11833    /**
11834     * This sets a widget to be displayed to the end of a scrolled entry.
11835     *
11836     * @param obj The scrolled entry object
11837     * @param end The widget to display on the right side of the scrolled
11838     * entry.
11839     *
11840     * @note A previously set widget will be destroyed.
11841     * @note If the object being set does not have minimum size hints set,
11842     * it won't get properly displayed.
11843     *
11844     * @see elm_entry_icon_set
11845     */
11846    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11847    /**
11848     * Gets the endmost widget of the scrolled entry. This object is owned
11849     * by the scrolled entry and should not be modified.
11850     *
11851     * @param obj The scrolled entry object
11852     * @return the right widget inside the scroller
11853     */
11854    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11855    /**
11856     * Unset the endmost widget of the scrolled entry, unparenting and
11857     * returning it.
11858     *
11859     * @param obj The scrolled entry object
11860     * @return the previously set icon sub-object of this entry, on
11861     * success.
11862     *
11863     * @see elm_entry_icon_set()
11864     */
11865    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11866    /**
11867     * Sets the visibility of the end widget of the scrolled entry, set by
11868     * elm_entry_end_set().
11869     *
11870     * @param obj The scrolled entry object
11871     * @param setting EINA_TRUE if the object should be displayed,
11872     * EINA_FALSE if not.
11873     */
11874    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11875    /**
11876     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11877     * them).
11878     *
11879     * Setting an entry to single-line mode with elm_entry_single_line_set()
11880     * will automatically disable the display of scrollbars when the entry
11881     * moves inside its scroller.
11882     *
11883     * @param obj The scrolled entry object
11884     * @param h The horizontal scrollbar policy to apply
11885     * @param v The vertical scrollbar policy to apply
11886     */
11887    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11888    /**
11889     * This enables/disables bouncing within the entry.
11890     *
11891     * This function sets whether the entry will bounce when scrolling reaches
11892     * the end of the contained entry.
11893     *
11894     * @param obj The scrolled entry object
11895     * @param h The horizontal bounce state
11896     * @param v The vertical bounce state
11897     */
11898    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11899    /**
11900     * Get the bounce mode
11901     *
11902     * @param obj The Entry object
11903     * @param h_bounce Allow bounce horizontally
11904     * @param v_bounce Allow bounce vertically
11905     */
11906    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11907
11908    /* pre-made filters for entries */
11909    /**
11910     * @typedef Elm_Entry_Filter_Limit_Size
11911     *
11912     * Data for the elm_entry_filter_limit_size() entry filter.
11913     */
11914    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11915    /**
11916     * @struct _Elm_Entry_Filter_Limit_Size
11917     *
11918     * Data for the elm_entry_filter_limit_size() entry filter.
11919     */
11920    struct _Elm_Entry_Filter_Limit_Size
11921      {
11922         int max_char_count; /**< The maximum number of characters allowed. */
11923         int max_byte_count; /**< The maximum number of bytes allowed*/
11924      };
11925    /**
11926     * Filter inserted text based on user defined character and byte limits
11927     *
11928     * Add this filter to an entry to limit the characters that it will accept
11929     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11930     * The funtion works on the UTF-8 representation of the string, converting
11931     * it from the set markup, thus not accounting for any format in it.
11932     *
11933     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11934     * it as data when setting the filter. In it, it's possible to set limits
11935     * by character count or bytes (any of them is disabled if 0), and both can
11936     * be set at the same time. In that case, it first checks for characters,
11937     * then bytes.
11938     *
11939     * The function will cut the inserted text in order to allow only the first
11940     * number of characters that are still allowed. The cut is made in
11941     * characters, even when limiting by bytes, in order to always contain
11942     * valid ones and avoid half unicode characters making it in.
11943     *
11944     * This filter, like any others, does not apply when setting the entry text
11945     * directly with elm_object_text_set() (or the deprecated
11946     * elm_entry_entry_set()).
11947     */
11948    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11949    /**
11950     * @typedef Elm_Entry_Filter_Accept_Set
11951     *
11952     * Data for the elm_entry_filter_accept_set() entry filter.
11953     */
11954    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11955    /**
11956     * @struct _Elm_Entry_Filter_Accept_Set
11957     *
11958     * Data for the elm_entry_filter_accept_set() entry filter.
11959     */
11960    struct _Elm_Entry_Filter_Accept_Set
11961      {
11962         const char *accepted; /**< Set of characters accepted in the entry. */
11963         const char *rejected; /**< Set of characters rejected from the entry. */
11964      };
11965    /**
11966     * Filter inserted text based on accepted or rejected sets of characters
11967     *
11968     * Add this filter to an entry to restrict the set of accepted characters
11969     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11970     * This structure contains both accepted and rejected sets, but they are
11971     * mutually exclusive.
11972     *
11973     * The @c accepted set takes preference, so if it is set, the filter will
11974     * only work based on the accepted characters, ignoring anything in the
11975     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11976     *
11977     * In both cases, the function filters by matching utf8 characters to the
11978     * raw markup text, so it can be used to remove formatting tags.
11979     *
11980     * This filter, like any others, does not apply when setting the entry text
11981     * directly with elm_object_text_set() (or the deprecated
11982     * elm_entry_entry_set()).
11983     */
11984    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11985    /**
11986     * Set the input panel layout of the entry
11987     *
11988     * @param obj The entry object
11989     * @param layout layout type
11990     */
11991    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11992    /**
11993     * Get the input panel layout of the entry
11994     *
11995     * @param obj The entry object
11996     * @return layout type
11997     *
11998     * @see elm_entry_input_panel_layout_set
11999     */
12000    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12001    /**
12002     * Set the autocapitalization type on the immodule.
12003     *
12004     * @param obj The entry object
12005     * @param autocapital_type The type of autocapitalization
12006     */
12007    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12008    /**
12009     * Retrieve the autocapitalization type on the immodule.
12010     *
12011     * @param obj The entry object
12012     * @return autocapitalization type
12013     */
12014    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12015    /**
12016     * Sets the attribute to show the input panel automatically.
12017     *
12018     * @param obj The entry object
12019     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12020     */
12021    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12022    /**
12023     * Retrieve the attribute to show the input panel automatically.
12024     *
12025     * @param obj The entry object
12026     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12027     */
12028    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12029
12030    /**
12031     * @}
12032     */
12033
12034    /* composite widgets - these basically put together basic widgets above
12035     * in convenient packages that do more than basic stuff */
12036
12037    /* anchorview */
12038    /**
12039     * @defgroup Anchorview Anchorview
12040     *
12041     * @image html img/widget/anchorview/preview-00.png
12042     * @image latex img/widget/anchorview/preview-00.eps
12043     *
12044     * Anchorview is for displaying text that contains markup with anchors
12045     * like <c>\<a href=1234\>something\</\></c> in it.
12046     *
12047     * Besides being styled differently, the anchorview widget provides the
12048     * necessary functionality so that clicking on these anchors brings up a
12049     * popup with user defined content such as "call", "add to contacts" or
12050     * "open web page". This popup is provided using the @ref Hover widget.
12051     *
12052     * This widget is very similar to @ref Anchorblock, so refer to that
12053     * widget for an example. The only difference Anchorview has is that the
12054     * widget is already provided with scrolling functionality, so if the
12055     * text set to it is too large to fit in the given space, it will scroll,
12056     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12057     * text can be displayed.
12058     *
12059     * This widget emits the following signals:
12060     * @li "anchor,clicked": will be called when an anchor is clicked. The
12061     * @p event_info parameter on the callback will be a pointer of type
12062     * ::Elm_Entry_Anchorview_Info.
12063     *
12064     * See @ref Anchorblock for an example on how to use both of them.
12065     *
12066     * @see Anchorblock
12067     * @see Entry
12068     * @see Hover
12069     *
12070     * @{
12071     */
12072    /**
12073     * @typedef Elm_Entry_Anchorview_Info
12074     *
12075     * The info sent in the callback for "anchor,clicked" signals emitted by
12076     * the Anchorview widget.
12077     */
12078    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12079    /**
12080     * @struct _Elm_Entry_Anchorview_Info
12081     *
12082     * The info sent in the callback for "anchor,clicked" signals emitted by
12083     * the Anchorview widget.
12084     */
12085    struct _Elm_Entry_Anchorview_Info
12086      {
12087         const char     *name; /**< Name of the anchor, as indicated in its href
12088                                    attribute */
12089         int             button; /**< The mouse button used to click on it */
12090         Evas_Object    *hover; /**< The hover object to use for the popup */
12091         struct {
12092              Evas_Coord    x, y, w, h;
12093         } anchor, /**< Geometry selection of text used as anchor */
12094           hover_parent; /**< Geometry of the object used as parent by the
12095                              hover */
12096         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12097                                              for content on the left side of
12098                                              the hover. Before calling the
12099                                              callback, the widget will make the
12100                                              necessary calculations to check
12101                                              which sides are fit to be set with
12102                                              content, based on the position the
12103                                              hover is activated and its distance
12104                                              to the edges of its parent object
12105                                              */
12106         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12107                                               the right side of the hover.
12108                                               See @ref hover_left */
12109         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12110                                             of the hover. See @ref hover_left */
12111         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12112                                                below the hover. See @ref
12113                                                hover_left */
12114      };
12115    /**
12116     * Add a new Anchorview object
12117     *
12118     * @param parent The parent object
12119     * @return The new object or NULL if it cannot be created
12120     */
12121    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12122    /**
12123     * Set the text to show in the anchorview
12124     *
12125     * Sets the text of the anchorview to @p text. This text can include markup
12126     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12127     * text that will be specially styled and react to click events, ended with
12128     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12129     * "anchor,clicked" signal that you can attach a callback to with
12130     * evas_object_smart_callback_add(). The name of the anchor given in the
12131     * event info struct will be the one set in the href attribute, in this
12132     * case, anchorname.
12133     *
12134     * Other markup can be used to style the text in different ways, but it's
12135     * up to the style defined in the theme which tags do what.
12136     * @deprecated use elm_object_text_set() instead.
12137     */
12138    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12139    /**
12140     * Get the markup text set for the anchorview
12141     *
12142     * Retrieves the text set on the anchorview, with markup tags included.
12143     *
12144     * @param obj The anchorview object
12145     * @return The markup text set or @c NULL if nothing was set or an error
12146     * occurred
12147     * @deprecated use elm_object_text_set() instead.
12148     */
12149    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12150    /**
12151     * Set the parent of the hover popup
12152     *
12153     * Sets the parent object to use by the hover created by the anchorview
12154     * when an anchor is clicked. See @ref Hover for more details on this.
12155     * If no parent is set, the same anchorview object will be used.
12156     *
12157     * @param obj The anchorview object
12158     * @param parent The object to use as parent for the hover
12159     */
12160    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12161    /**
12162     * Get the parent of the hover popup
12163     *
12164     * Get the object used as parent for the hover created by the anchorview
12165     * widget. See @ref Hover for more details on this.
12166     *
12167     * @param obj The anchorview object
12168     * @return The object used as parent for the hover, NULL if none is set.
12169     */
12170    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12171    /**
12172     * Set the style that the hover should use
12173     *
12174     * When creating the popup hover, anchorview will request that it's
12175     * themed according to @p style.
12176     *
12177     * @param obj The anchorview object
12178     * @param style The style to use for the underlying hover
12179     *
12180     * @see elm_object_style_set()
12181     */
12182    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12183    /**
12184     * Get the style that the hover should use
12185     *
12186     * Get the style the hover created by anchorview will use.
12187     *
12188     * @param obj The anchorview object
12189     * @return The style to use by the hover. NULL means the default is used.
12190     *
12191     * @see elm_object_style_set()
12192     */
12193    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12194    /**
12195     * Ends the hover popup in the anchorview
12196     *
12197     * When an anchor is clicked, the anchorview widget will create a hover
12198     * object to use as a popup with user provided content. This function
12199     * terminates this popup, returning the anchorview to its normal state.
12200     *
12201     * @param obj The anchorview object
12202     */
12203    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12204    /**
12205     * Set bouncing behaviour when the scrolled content reaches an edge
12206     *
12207     * Tell the internal scroller object whether it should bounce or not
12208     * when it reaches the respective edges for each axis.
12209     *
12210     * @param obj The anchorview object
12211     * @param h_bounce Whether to bounce or not in the horizontal axis
12212     * @param v_bounce Whether to bounce or not in the vertical axis
12213     *
12214     * @see elm_scroller_bounce_set()
12215     */
12216    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12217    /**
12218     * Get the set bouncing behaviour of the internal scroller
12219     *
12220     * Get whether the internal scroller should bounce when the edge of each
12221     * axis is reached scrolling.
12222     *
12223     * @param obj The anchorview object
12224     * @param h_bounce Pointer where to store the bounce state of the horizontal
12225     *                 axis
12226     * @param v_bounce Pointer where to store the bounce state of the vertical
12227     *                 axis
12228     *
12229     * @see elm_scroller_bounce_get()
12230     */
12231    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12232    /**
12233     * Appends a custom item provider to the given anchorview
12234     *
12235     * Appends the given function to the list of items providers. This list is
12236     * called, one function at a time, with the given @p data pointer, the
12237     * anchorview object and, in the @p item parameter, the item name as
12238     * referenced in its href string. Following functions in the list will be
12239     * called in order until one of them returns something different to NULL,
12240     * which should be an Evas_Object which will be used in place of the item
12241     * element.
12242     *
12243     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12244     * href=item/name\>\</item\>
12245     *
12246     * @param obj The anchorview object
12247     * @param func The function to add to the list of providers
12248     * @param data User data that will be passed to the callback function
12249     *
12250     * @see elm_entry_item_provider_append()
12251     */
12252    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);
12253    /**
12254     * Prepend a custom item provider to the given anchorview
12255     *
12256     * Like elm_anchorview_item_provider_append(), but it adds the function
12257     * @p func to the beginning of the list, instead of the end.
12258     *
12259     * @param obj The anchorview object
12260     * @param func The function to add to the list of providers
12261     * @param data User data that will be passed to the callback function
12262     */
12263    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);
12264    /**
12265     * Remove a custom item provider from the list of the given anchorview
12266     *
12267     * Removes the function and data pairing that matches @p func and @p data.
12268     * That is, unless the same function and same user data are given, the
12269     * function will not be removed from the list. This allows us to add the
12270     * same callback several times, with different @p data pointers and be
12271     * able to remove them later without conflicts.
12272     *
12273     * @param obj The anchorview object
12274     * @param func The function to remove from the list
12275     * @param data The data matching the function to remove from the list
12276     */
12277    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);
12278    /**
12279     * @}
12280     */
12281
12282    /* anchorblock */
12283    /**
12284     * @defgroup Anchorblock Anchorblock
12285     *
12286     * @image html img/widget/anchorblock/preview-00.png
12287     * @image latex img/widget/anchorblock/preview-00.eps
12288     *
12289     * Anchorblock is for displaying text that contains markup with anchors
12290     * like <c>\<a href=1234\>something\</\></c> in it.
12291     *
12292     * Besides being styled differently, the anchorblock widget provides the
12293     * necessary functionality so that clicking on these anchors brings up a
12294     * popup with user defined content such as "call", "add to contacts" or
12295     * "open web page". This popup is provided using the @ref Hover widget.
12296     *
12297     * This widget emits the following signals:
12298     * @li "anchor,clicked": will be called when an anchor is clicked. The
12299     * @p event_info parameter on the callback will be a pointer of type
12300     * ::Elm_Entry_Anchorblock_Info.
12301     *
12302     * @see Anchorview
12303     * @see Entry
12304     * @see Hover
12305     *
12306     * Since examples are usually better than plain words, we might as well
12307     * try @ref tutorial_anchorblock_example "one".
12308     */
12309    /**
12310     * @addtogroup Anchorblock
12311     * @{
12312     */
12313    /**
12314     * @typedef Elm_Entry_Anchorblock_Info
12315     *
12316     * The info sent in the callback for "anchor,clicked" signals emitted by
12317     * the Anchorblock widget.
12318     */
12319    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12320    /**
12321     * @struct _Elm_Entry_Anchorblock_Info
12322     *
12323     * The info sent in the callback for "anchor,clicked" signals emitted by
12324     * the Anchorblock widget.
12325     */
12326    struct _Elm_Entry_Anchorblock_Info
12327      {
12328         const char     *name; /**< Name of the anchor, as indicated in its href
12329                                    attribute */
12330         int             button; /**< The mouse button used to click on it */
12331         Evas_Object    *hover; /**< The hover object to use for the popup */
12332         struct {
12333              Evas_Coord    x, y, w, h;
12334         } anchor, /**< Geometry selection of text used as anchor */
12335           hover_parent; /**< Geometry of the object used as parent by the
12336                              hover */
12337         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12338                                              for content on the left side of
12339                                              the hover. Before calling the
12340                                              callback, the widget will make the
12341                                              necessary calculations to check
12342                                              which sides are fit to be set with
12343                                              content, based on the position the
12344                                              hover is activated and its distance
12345                                              to the edges of its parent object
12346                                              */
12347         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12348                                               the right side of the hover.
12349                                               See @ref hover_left */
12350         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12351                                             of the hover. See @ref hover_left */
12352         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12353                                                below the hover. See @ref
12354                                                hover_left */
12355      };
12356    /**
12357     * Add a new Anchorblock object
12358     *
12359     * @param parent The parent object
12360     * @return The new object or NULL if it cannot be created
12361     */
12362    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12363    /**
12364     * Set the text to show in the anchorblock
12365     *
12366     * Sets the text of the anchorblock to @p text. This text can include markup
12367     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12368     * of text that will be specially styled and react to click events, ended
12369     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12370     * "anchor,clicked" signal that you can attach a callback to with
12371     * evas_object_smart_callback_add(). The name of the anchor given in the
12372     * event info struct will be the one set in the href attribute, in this
12373     * case, anchorname.
12374     *
12375     * Other markup can be used to style the text in different ways, but it's
12376     * up to the style defined in the theme which tags do what.
12377     * @deprecated use elm_object_text_set() instead.
12378     */
12379    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12380    /**
12381     * Get the markup text set for the anchorblock
12382     *
12383     * Retrieves the text set on the anchorblock, with markup tags included.
12384     *
12385     * @param obj The anchorblock object
12386     * @return The markup text set or @c NULL if nothing was set or an error
12387     * occurred
12388     * @deprecated use elm_object_text_set() instead.
12389     */
12390    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12391    /**
12392     * Set the parent of the hover popup
12393     *
12394     * Sets the parent object to use by the hover created by the anchorblock
12395     * when an anchor is clicked. See @ref Hover for more details on this.
12396     *
12397     * @param obj The anchorblock object
12398     * @param parent The object to use as parent for the hover
12399     */
12400    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12401    /**
12402     * Get the parent of the hover popup
12403     *
12404     * Get the object used as parent for the hover created by the anchorblock
12405     * widget. See @ref Hover for more details on this.
12406     * If no parent is set, the same anchorblock object will be used.
12407     *
12408     * @param obj The anchorblock object
12409     * @return The object used as parent for the hover, NULL if none is set.
12410     */
12411    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12412    /**
12413     * Set the style that the hover should use
12414     *
12415     * When creating the popup hover, anchorblock will request that it's
12416     * themed according to @p style.
12417     *
12418     * @param obj The anchorblock object
12419     * @param style The style to use for the underlying hover
12420     *
12421     * @see elm_object_style_set()
12422     */
12423    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12424    /**
12425     * Get the style that the hover should use
12426     *
12427     * Get the style, the hover created by anchorblock will use.
12428     *
12429     * @param obj The anchorblock object
12430     * @return The style to use by the hover. NULL means the default is used.
12431     *
12432     * @see elm_object_style_set()
12433     */
12434    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12435    /**
12436     * Ends the hover popup in the anchorblock
12437     *
12438     * When an anchor is clicked, the anchorblock widget will create a hover
12439     * object to use as a popup with user provided content. This function
12440     * terminates this popup, returning the anchorblock to its normal state.
12441     *
12442     * @param obj The anchorblock object
12443     */
12444    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12445    /**
12446     * Appends a custom item provider to the given anchorblock
12447     *
12448     * Appends the given function to the list of items providers. This list is
12449     * called, one function at a time, with the given @p data pointer, the
12450     * anchorblock object and, in the @p item parameter, the item name as
12451     * referenced in its href string. Following functions in the list will be
12452     * called in order until one of them returns something different to NULL,
12453     * which should be an Evas_Object which will be used in place of the item
12454     * element.
12455     *
12456     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12457     * href=item/name\>\</item\>
12458     *
12459     * @param obj The anchorblock object
12460     * @param func The function to add to the list of providers
12461     * @param data User data that will be passed to the callback function
12462     *
12463     * @see elm_entry_item_provider_append()
12464     */
12465    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);
12466    /**
12467     * Prepend a custom item provider to the given anchorblock
12468     *
12469     * Like elm_anchorblock_item_provider_append(), but it adds the function
12470     * @p func to the beginning of the list, instead of the end.
12471     *
12472     * @param obj The anchorblock object
12473     * @param func The function to add to the list of providers
12474     * @param data User data that will be passed to the callback function
12475     */
12476    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);
12477    /**
12478     * Remove a custom item provider from the list of the given anchorblock
12479     *
12480     * Removes the function and data pairing that matches @p func and @p data.
12481     * That is, unless the same function and same user data are given, the
12482     * function will not be removed from the list. This allows us to add the
12483     * same callback several times, with different @p data pointers and be
12484     * able to remove them later without conflicts.
12485     *
12486     * @param obj The anchorblock object
12487     * @param func The function to remove from the list
12488     * @param data The data matching the function to remove from the list
12489     */
12490    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);
12491    /**
12492     * @}
12493     */
12494
12495    /**
12496     * @defgroup Bubble Bubble
12497     *
12498     * @image html img/widget/bubble/preview-00.png
12499     * @image latex img/widget/bubble/preview-00.eps
12500     * @image html img/widget/bubble/preview-01.png
12501     * @image latex img/widget/bubble/preview-01.eps
12502     * @image html img/widget/bubble/preview-02.png
12503     * @image latex img/widget/bubble/preview-02.eps
12504     *
12505     * @brief The Bubble is a widget to show text similar to how speech is
12506     * represented in comics.
12507     *
12508     * The bubble widget contains 5 important visual elements:
12509     * @li The frame is a rectangle with rounded edjes and an "arrow".
12510     * @li The @p icon is an image to which the frame's arrow points to.
12511     * @li The @p label is a text which appears to the right of the icon if the
12512     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12513     * otherwise.
12514     * @li The @p info is a text which appears to the right of the label. Info's
12515     * font is of a ligther color than label.
12516     * @li The @p content is an evas object that is shown inside the frame.
12517     *
12518     * The position of the arrow, icon, label and info depends on which corner is
12519     * selected. The four available corners are:
12520     * @li "top_left" - Default
12521     * @li "top_right"
12522     * @li "bottom_left"
12523     * @li "bottom_right"
12524     *
12525     * Signals that you can add callbacks for are:
12526     * @li "clicked" - This is called when a user has clicked the bubble.
12527     *
12528     * Default contents parts of the bubble that you can use for are:
12529     * @li "default" - A content of the bubble
12530     * @li "icon" - An icon of the bubble
12531     *
12532     * Default text parts of the button widget that you can use for are:
12533     * @li NULL - Label of the bubble
12534     * 
12535          * For an example of using a buble see @ref bubble_01_example_page "this".
12536     *
12537     * @{
12538     */
12539
12540    /**
12541     * Add a new bubble to the parent
12542     *
12543     * @param parent The parent object
12544     * @return The new object or NULL if it cannot be created
12545     *
12546     * This function adds a text bubble to the given parent evas object.
12547     */
12548    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12549    /**
12550     * Set the label of the bubble
12551     *
12552     * @param obj The bubble object
12553     * @param label The string to set in the label
12554     *
12555     * This function sets the title of the bubble. Where this appears depends on
12556     * the selected corner.
12557     * @deprecated use elm_object_text_set() instead.
12558     */
12559    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12560    /**
12561     * Get the label of the bubble
12562     *
12563     * @param obj The bubble object
12564     * @return The string of set in the label
12565     *
12566     * This function gets the title of the bubble.
12567     * @deprecated use elm_object_text_get() instead.
12568     */
12569    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12570    /**
12571     * Set the info of the bubble
12572     *
12573     * @param obj The bubble object
12574     * @param info The given info about the bubble
12575     *
12576     * This function sets the info of the bubble. Where this appears depends on
12577     * the selected corner.
12578     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12579     */
12580    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12581    /**
12582     * Get the info of the bubble
12583     *
12584     * @param obj The bubble object
12585     *
12586     * @return The "info" string of the bubble
12587     *
12588     * This function gets the info text.
12589     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12590     */
12591    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12592    /**
12593     * Set the content to be shown in the bubble
12594     *
12595     * Once the content object is set, a previously set one will be deleted.
12596     * If you want to keep the old content object, use the
12597     * elm_bubble_content_unset() function.
12598     *
12599     * @param obj The bubble object
12600     * @param content The given content of the bubble
12601     *
12602     * This function sets the content shown on the middle of the bubble.
12603     * 
12604     * @deprecated use elm_object_content_set() instead
12605     *
12606     */
12607    EINA_DEPRECATED EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12608    /**
12609     * Get the content shown in the bubble
12610     *
12611     * Return the content object which is set for this widget.
12612     *
12613     * @param obj The bubble object
12614     * @return The content that is being used
12615     *
12616     * @deprecated use elm_object_content_get() instead
12617     *
12618     */
12619    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12620    /**
12621     * Unset the content shown in the bubble
12622     *
12623     * Unparent and return the content object which was set for this widget.
12624     *
12625     * @param obj The bubble object
12626     * @return The content that was being used
12627     *
12628     * @deprecated use elm_object_content_unset() instead
12629     *
12630     */
12631    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12632    /**
12633     * Set the icon of the bubble
12634     *
12635     * Once the icon object is set, a previously set one will be deleted.
12636     * If you want to keep the old content object, use the
12637     * elm_icon_content_unset() function.
12638     *
12639     * @param obj The bubble object
12640     * @param icon The given icon for the bubble
12641     *
12642     * @deprecated use elm_object_part_content_set() instead
12643     *
12644     */
12645    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12646    /**
12647     * Get the icon of the bubble
12648     *
12649     * @param obj The bubble object
12650     * @return The icon for the bubble
12651     *
12652     * This function gets the icon shown on the top left of bubble.
12653     *
12654     * @deprecated use elm_object_part_content_get() instead
12655     *
12656     */
12657    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12658    /**
12659     * Unset the icon of the bubble
12660     *
12661     * Unparent and return the icon object which was set for this widget.
12662     *
12663     * @param obj The bubble object
12664     * @return The icon that was being used
12665     *
12666     * @deprecated use elm_object_part_content_unset() instead
12667     *
12668     */
12669    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12670    /**
12671     * Set the corner of the bubble
12672     *
12673     * @param obj The bubble object.
12674     * @param corner The given corner for the bubble.
12675     *
12676     * This function sets the corner of the bubble. The corner will be used to
12677     * determine where the arrow in the frame points to and where label, icon and
12678     * info are shown.
12679     *
12680     * Possible values for corner are:
12681     * @li "top_left" - Default
12682     * @li "top_right"
12683     * @li "bottom_left"
12684     * @li "bottom_right"
12685     */
12686    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12687    /**
12688     * Get the corner of the bubble
12689     *
12690     * @param obj The bubble object.
12691     * @return The given corner for the bubble.
12692     *
12693     * This function gets the selected corner of the bubble.
12694     */
12695    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12696    /**
12697     * @}
12698     */
12699
12700    /**
12701     * @defgroup Photo Photo
12702     *
12703     * For displaying the photo of a person (contact). Simple, yet
12704     * with a very specific purpose.
12705     *
12706     * Signals that you can add callbacks for are:
12707     *
12708     * "clicked" - This is called when a user has clicked the photo
12709     * "drag,start" - Someone started dragging the image out of the object
12710     * "drag,end" - Dragged item was dropped (somewhere)
12711     *
12712     * @{
12713     */
12714
12715    /**
12716     * Add a new photo to the parent
12717     *
12718     * @param parent The parent object
12719     * @return The new object or NULL if it cannot be created
12720     *
12721     * @ingroup Photo
12722     */
12723    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12724
12725    /**
12726     * Set the file that will be used as photo
12727     *
12728     * @param obj The photo object
12729     * @param file The path to file that will be used as photo
12730     *
12731     * @return (1 = success, 0 = error)
12732     *
12733     * @ingroup Photo
12734     */
12735    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12736
12737     /**
12738     * Set the file that will be used as thumbnail in the photo.
12739     *
12740     * @param obj The photo object.
12741     * @param file The path to file that will be used as thumb.
12742     * @param group The key used in case of an EET file.
12743     *
12744     * @ingroup Photo
12745     */
12746    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12747
12748    /**
12749     * Set the size that will be used on the photo
12750     *
12751     * @param obj The photo object
12752     * @param size The size that the photo will be
12753     *
12754     * @ingroup Photo
12755     */
12756    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12757
12758    /**
12759     * Set if the photo should be completely visible or not.
12760     *
12761     * @param obj The photo object
12762     * @param fill if true the photo will be completely visible
12763     *
12764     * @ingroup Photo
12765     */
12766    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12767
12768    /**
12769     * Set editability of the photo.
12770     *
12771     * An editable photo can be dragged to or from, and can be cut or
12772     * pasted too.  Note that pasting an image or dropping an item on
12773     * the image will delete the existing content.
12774     *
12775     * @param obj The photo object.
12776     * @param set To set of clear editablity.
12777     */
12778    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12779
12780    /**
12781     * @}
12782     */
12783
12784    /* gesture layer */
12785    /**
12786     * @defgroup Elm_Gesture_Layer Gesture Layer
12787     * Gesture Layer Usage:
12788     *
12789     * Use Gesture Layer to detect gestures.
12790     * The advantage is that you don't have to implement
12791     * gesture detection, just set callbacks of gesture state.
12792     * By using gesture layer we make standard interface.
12793     *
12794     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12795     * with a parent object parameter.
12796     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12797     * call. Usually with same object as target (2nd parameter).
12798     *
12799     * Now you need to tell gesture layer what gestures you follow.
12800     * This is done with @ref elm_gesture_layer_cb_set call.
12801     * By setting the callback you actually saying to gesture layer:
12802     * I would like to know when the gesture @ref Elm_Gesture_Types
12803     * switches to state @ref Elm_Gesture_State.
12804     *
12805     * Next, you need to implement the actual action that follows the input
12806     * in your callback.
12807     *
12808     * Note that if you like to stop being reported about a gesture, just set
12809     * all callbacks referring this gesture to NULL.
12810     * (again with @ref elm_gesture_layer_cb_set)
12811     *
12812     * The information reported by gesture layer to your callback is depending
12813     * on @ref Elm_Gesture_Types:
12814     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12815     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12816     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12817     *
12818     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12819     * @ref ELM_GESTURE_MOMENTUM.
12820     *
12821     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12822     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12823     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12824     * Note that we consider a flick as a line-gesture that should be completed
12825     * in flick-time-limit as defined in @ref Config.
12826     *
12827     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12828     *
12829     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12830     *
12831     *
12832     * Gesture Layer Tweaks:
12833     *
12834     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12835     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12836     *
12837     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12838     * so gesture starts when user touches (a *DOWN event) touch-surface
12839     * and ends when no fingers touches surface (a *UP event).
12840     */
12841
12842    /**
12843     * @enum _Elm_Gesture_Types
12844     * Enum of supported gesture types.
12845     * @ingroup Elm_Gesture_Layer
12846     */
12847    enum _Elm_Gesture_Types
12848      {
12849         ELM_GESTURE_FIRST = 0,
12850
12851         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12852         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12853         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12854         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12855
12856         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12857
12858         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12859         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12860
12861         ELM_GESTURE_ZOOM, /**< Zoom */
12862         ELM_GESTURE_ROTATE, /**< Rotate */
12863
12864         ELM_GESTURE_LAST
12865      };
12866
12867    /**
12868     * @typedef Elm_Gesture_Types
12869     * gesture types enum
12870     * @ingroup Elm_Gesture_Layer
12871     */
12872    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12873
12874    /**
12875     * @enum _Elm_Gesture_State
12876     * Enum of gesture states.
12877     * @ingroup Elm_Gesture_Layer
12878     */
12879    enum _Elm_Gesture_State
12880      {
12881         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12882         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12883         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12884         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12885         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12886      };
12887
12888    /**
12889     * @typedef Elm_Gesture_State
12890     * gesture states enum
12891     * @ingroup Elm_Gesture_Layer
12892     */
12893    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12894
12895    /**
12896     * @struct _Elm_Gesture_Taps_Info
12897     * Struct holds taps info for user
12898     * @ingroup Elm_Gesture_Layer
12899     */
12900    struct _Elm_Gesture_Taps_Info
12901      {
12902         Evas_Coord x, y;         /**< Holds center point between fingers */
12903         unsigned int n;          /**< Number of fingers tapped           */
12904         unsigned int timestamp;  /**< event timestamp       */
12905      };
12906
12907    /**
12908     * @typedef Elm_Gesture_Taps_Info
12909     * holds taps info for user
12910     * @ingroup Elm_Gesture_Layer
12911     */
12912    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12913
12914    /**
12915     * @struct _Elm_Gesture_Momentum_Info
12916     * Struct holds momentum info for user
12917     * x1 and y1 are not necessarily in sync
12918     * x1 holds x value of x direction starting point
12919     * and same holds for y1.
12920     * This is noticeable when doing V-shape movement
12921     * @ingroup Elm_Gesture_Layer
12922     */
12923    struct _Elm_Gesture_Momentum_Info
12924      {  /* Report line ends, timestamps, and momentum computed        */
12925         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12926         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12927         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12928         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12929
12930         unsigned int tx; /**< Timestamp of start of final x-swipe */
12931         unsigned int ty; /**< Timestamp of start of final y-swipe */
12932
12933         Evas_Coord mx; /**< Momentum on X */
12934         Evas_Coord my; /**< Momentum on Y */
12935
12936         unsigned int n;  /**< Number of fingers */
12937      };
12938
12939    /**
12940     * @typedef Elm_Gesture_Momentum_Info
12941     * holds momentum info for user
12942     * @ingroup Elm_Gesture_Layer
12943     */
12944     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12945
12946    /**
12947     * @struct _Elm_Gesture_Line_Info
12948     * Struct holds line info for user
12949     * @ingroup Elm_Gesture_Layer
12950     */
12951    struct _Elm_Gesture_Line_Info
12952      {  /* Report line ends, timestamps, and momentum computed      */
12953         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12954         double angle;              /**< Angle (direction) of lines  */
12955      };
12956
12957    /**
12958     * @typedef Elm_Gesture_Line_Info
12959     * Holds line info for user
12960     * @ingroup Elm_Gesture_Layer
12961     */
12962     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12963
12964    /**
12965     * @struct _Elm_Gesture_Zoom_Info
12966     * Struct holds zoom info for user
12967     * @ingroup Elm_Gesture_Layer
12968     */
12969    struct _Elm_Gesture_Zoom_Info
12970      {
12971         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12972         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12973         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12974         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12975      };
12976
12977    /**
12978     * @typedef Elm_Gesture_Zoom_Info
12979     * Holds zoom info for user
12980     * @ingroup Elm_Gesture_Layer
12981     */
12982    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12983
12984    /**
12985     * @struct _Elm_Gesture_Rotate_Info
12986     * Struct holds rotation info for user
12987     * @ingroup Elm_Gesture_Layer
12988     */
12989    struct _Elm_Gesture_Rotate_Info
12990      {
12991         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12992         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12993         double base_angle; /**< Holds start-angle */
12994         double angle;      /**< Rotation value: 0.0 means no rotation         */
12995         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12996      };
12997
12998    /**
12999     * @typedef Elm_Gesture_Rotate_Info
13000     * Holds rotation info for user
13001     * @ingroup Elm_Gesture_Layer
13002     */
13003    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13004
13005    /**
13006     * @typedef Elm_Gesture_Event_Cb
13007     * User callback used to stream gesture info from gesture layer
13008     * @param data user data
13009     * @param event_info gesture report info
13010     * Returns a flag field to be applied on the causing event.
13011     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13012     * upon the event, in an irreversible way.
13013     *
13014     * @ingroup Elm_Gesture_Layer
13015     */
13016    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13017
13018    /**
13019     * Use function to set callbacks to be notified about
13020     * change of state of gesture.
13021     * When a user registers a callback with this function
13022     * this means this gesture has to be tested.
13023     *
13024     * When ALL callbacks for a gesture are set to NULL
13025     * it means user isn't interested in gesture-state
13026     * and it will not be tested.
13027     *
13028     * @param obj Pointer to gesture-layer.
13029     * @param idx The gesture you would like to track its state.
13030     * @param cb callback function pointer.
13031     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13032     * @param data user info to be sent to callback (usually, Smart Data)
13033     *
13034     * @ingroup Elm_Gesture_Layer
13035     */
13036    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);
13037
13038    /**
13039     * Call this function to get repeat-events settings.
13040     *
13041     * @param obj Pointer to gesture-layer.
13042     *
13043     * @return repeat events settings.
13044     * @see elm_gesture_layer_hold_events_set()
13045     * @ingroup Elm_Gesture_Layer
13046     */
13047    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13048
13049    /**
13050     * This function called in order to make gesture-layer repeat events.
13051     * Set this of you like to get the raw events only if gestures were not detected.
13052     * Clear this if you like gesture layer to fwd events as testing gestures.
13053     *
13054     * @param obj Pointer to gesture-layer.
13055     * @param r Repeat: TRUE/FALSE
13056     *
13057     * @ingroup Elm_Gesture_Layer
13058     */
13059    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13060
13061    /**
13062     * This function sets step-value for zoom action.
13063     * Set step to any positive value.
13064     * Cancel step setting by setting to 0.0
13065     *
13066     * @param obj Pointer to gesture-layer.
13067     * @param s new zoom step value.
13068     *
13069     * @ingroup Elm_Gesture_Layer
13070     */
13071    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13072
13073    /**
13074     * This function sets step-value for rotate action.
13075     * Set step to any positive value.
13076     * Cancel step setting by setting to 0.0
13077     *
13078     * @param obj Pointer to gesture-layer.
13079     * @param s new roatate step value.
13080     *
13081     * @ingroup Elm_Gesture_Layer
13082     */
13083    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13084
13085    /**
13086     * This function called to attach gesture-layer to an Evas_Object.
13087     * @param obj Pointer to gesture-layer.
13088     * @param t Pointer to underlying object (AKA Target)
13089     *
13090     * @return TRUE, FALSE on success, failure.
13091     *
13092     * @ingroup Elm_Gesture_Layer
13093     */
13094    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13095
13096    /**
13097     * Call this function to construct a new gesture-layer object.
13098     * This does not activate the gesture layer. You have to
13099     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13100     *
13101     * @param parent the parent object.
13102     *
13103     * @return Pointer to new gesture-layer object.
13104     *
13105     * @ingroup Elm_Gesture_Layer
13106     */
13107    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13108
13109    /**
13110     * @defgroup Thumb Thumb
13111     *
13112     * @image html img/widget/thumb/preview-00.png
13113     * @image latex img/widget/thumb/preview-00.eps
13114     *
13115     * A thumb object is used for displaying the thumbnail of an image or video.
13116     * You must have compiled Elementary with Ethumb_Client support and the DBus
13117     * service must be present and auto-activated in order to have thumbnails to
13118     * be generated.
13119     *
13120     * Once the thumbnail object becomes visible, it will check if there is a
13121     * previously generated thumbnail image for the file set on it. If not, it
13122     * will start generating this thumbnail.
13123     *
13124     * Different config settings will cause different thumbnails to be generated
13125     * even on the same file.
13126     *
13127     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13128     * Ethumb documentation to change this path, and to see other configuration
13129     * options.
13130     *
13131     * Signals that you can add callbacks for are:
13132     *
13133     * - "clicked" - This is called when a user has clicked the thumb without dragging
13134     *             around.
13135     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13136     * - "press" - This is called when a user has pressed down the thumb.
13137     * - "generate,start" - The thumbnail generation started.
13138     * - "generate,stop" - The generation process stopped.
13139     * - "generate,error" - The generation failed.
13140     * - "load,error" - The thumbnail image loading failed.
13141     *
13142     * available styles:
13143     * - default
13144     * - noframe
13145     *
13146     * An example of use of thumbnail:
13147     *
13148     * - @ref thumb_example_01
13149     */
13150
13151    /**
13152     * @addtogroup Thumb
13153     * @{
13154     */
13155
13156    /**
13157     * @enum _Elm_Thumb_Animation_Setting
13158     * @typedef Elm_Thumb_Animation_Setting
13159     *
13160     * Used to set if a video thumbnail is animating or not.
13161     *
13162     * @ingroup Thumb
13163     */
13164    typedef enum _Elm_Thumb_Animation_Setting
13165      {
13166         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13167         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13168         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13169         ELM_THUMB_ANIMATION_LAST
13170      } Elm_Thumb_Animation_Setting;
13171
13172    /**
13173     * Add a new thumb object to the parent.
13174     *
13175     * @param parent The parent object.
13176     * @return The new object or NULL if it cannot be created.
13177     *
13178     * @see elm_thumb_file_set()
13179     * @see elm_thumb_ethumb_client_get()
13180     *
13181     * @ingroup Thumb
13182     */
13183    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13184    /**
13185     * Reload thumbnail if it was generated before.
13186     *
13187     * @param obj The thumb object to reload
13188     *
13189     * This is useful if the ethumb client configuration changed, like its
13190     * size, aspect or any other property one set in the handle returned
13191     * by elm_thumb_ethumb_client_get().
13192     *
13193     * If the options didn't change, the thumbnail won't be generated again, but
13194     * the old one will still be used.
13195     *
13196     * @see elm_thumb_file_set()
13197     *
13198     * @ingroup Thumb
13199     */
13200    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13201    /**
13202     * Set the file that will be used as thumbnail.
13203     *
13204     * @param obj The thumb object.
13205     * @param file The path to file that will be used as thumb.
13206     * @param key The key used in case of an EET file.
13207     *
13208     * The file can be an image or a video (in that case, acceptable extensions are:
13209     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13210     * function elm_thumb_animate().
13211     *
13212     * @see elm_thumb_file_get()
13213     * @see elm_thumb_reload()
13214     * @see elm_thumb_animate()
13215     *
13216     * @ingroup Thumb
13217     */
13218    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13219    /**
13220     * Get the image or video path and key used to generate the thumbnail.
13221     *
13222     * @param obj The thumb object.
13223     * @param file Pointer to filename.
13224     * @param key Pointer to key.
13225     *
13226     * @see elm_thumb_file_set()
13227     * @see elm_thumb_path_get()
13228     *
13229     * @ingroup Thumb
13230     */
13231    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13232    /**
13233     * Get the path and key to the image or video generated by ethumb.
13234     *
13235     * One just need to make sure that the thumbnail was generated before getting
13236     * its path; otherwise, the path will be NULL. One way to do that is by asking
13237     * for the path when/after the "generate,stop" smart callback is called.
13238     *
13239     * @param obj The thumb object.
13240     * @param file Pointer to thumb path.
13241     * @param key Pointer to thumb key.
13242     *
13243     * @see elm_thumb_file_get()
13244     *
13245     * @ingroup Thumb
13246     */
13247    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13248    /**
13249     * Set the animation state for the thumb object. If its content is an animated
13250     * video, you may start/stop the animation or tell it to play continuously and
13251     * looping.
13252     *
13253     * @param obj The thumb object.
13254     * @param setting The animation setting.
13255     *
13256     * @see elm_thumb_file_set()
13257     *
13258     * @ingroup Thumb
13259     */
13260    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13261    /**
13262     * Get the animation state for the thumb object.
13263     *
13264     * @param obj The thumb object.
13265     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13266     * on errors.
13267     *
13268     * @see elm_thumb_animate_set()
13269     *
13270     * @ingroup Thumb
13271     */
13272    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13273    /**
13274     * Get the ethumb_client handle so custom configuration can be made.
13275     *
13276     * @return Ethumb_Client instance or NULL.
13277     *
13278     * This must be called before the objects are created to be sure no object is
13279     * visible and no generation started.
13280     *
13281     * Example of usage:
13282     *
13283     * @code
13284     * #include <Elementary.h>
13285     * #ifndef ELM_LIB_QUICKLAUNCH
13286     * EAPI_MAIN int
13287     * elm_main(int argc, char **argv)
13288     * {
13289     *    Ethumb_Client *client;
13290     *
13291     *    elm_need_ethumb();
13292     *
13293     *    // ... your code
13294     *
13295     *    client = elm_thumb_ethumb_client_get();
13296     *    if (!client)
13297     *      {
13298     *         ERR("could not get ethumb_client");
13299     *         return 1;
13300     *      }
13301     *    ethumb_client_size_set(client, 100, 100);
13302     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13303     *    // ... your code
13304     *
13305     *    // Create elm_thumb objects here
13306     *
13307     *    elm_run();
13308     *    elm_shutdown();
13309     *    return 0;
13310     * }
13311     * #endif
13312     * ELM_MAIN()
13313     * @endcode
13314     *
13315     * @note There's only one client handle for Ethumb, so once a configuration
13316     * change is done to it, any other request for thumbnails (for any thumbnail
13317     * object) will use that configuration. Thus, this configuration is global.
13318     *
13319     * @ingroup Thumb
13320     */
13321    EAPI void                        *elm_thumb_ethumb_client_get(void);
13322    /**
13323     * Get the ethumb_client connection state.
13324     *
13325     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13326     * otherwise.
13327     */
13328    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13329    /**
13330     * Make the thumbnail 'editable'.
13331     *
13332     * @param obj Thumb object.
13333     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13334     *
13335     * This means the thumbnail is a valid drag target for drag and drop, and can be
13336     * cut or pasted too.
13337     *
13338     * @see elm_thumb_editable_get()
13339     *
13340     * @ingroup Thumb
13341     */
13342    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13343    /**
13344     * Make the thumbnail 'editable'.
13345     *
13346     * @param obj Thumb object.
13347     * @return Editability.
13348     *
13349     * This means the thumbnail is a valid drag target for drag and drop, and can be
13350     * cut or pasted too.
13351     *
13352     * @see elm_thumb_editable_set()
13353     *
13354     * @ingroup Thumb
13355     */
13356    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13357
13358    /**
13359     * @}
13360     */
13361
13362    /**
13363     * @defgroup Web Web
13364     *
13365     * @image html img/widget/web/preview-00.png
13366     * @image latex img/widget/web/preview-00.eps
13367     *
13368     * A web object is used for displaying web pages (HTML/CSS/JS)
13369     * using WebKit-EFL. You must have compiled Elementary with
13370     * ewebkit support.
13371     *
13372     * Signals that you can add callbacks for are:
13373     * @li "download,request": A file download has been requested. Event info is
13374     * a pointer to a Elm_Web_Download
13375     * @li "editorclient,contents,changed": Editor client's contents changed
13376     * @li "editorclient,selection,changed": Editor client's selection changed
13377     * @li "frame,created": A new frame was created. Event info is an
13378     * Evas_Object which can be handled with WebKit's ewk_frame API
13379     * @li "icon,received": An icon was received by the main frame
13380     * @li "inputmethod,changed": Input method changed. Event info is an
13381     * Eina_Bool indicating whether it's enabled or not
13382     * @li "js,windowobject,clear": JS window object has been cleared
13383     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13384     * is a char *link[2], where the first string contains the URL the link
13385     * points to, and the second one the title of the link
13386     * @li "link,hover,out": Mouse cursor left the link
13387     * @li "load,document,finished": Loading of a document finished. Event info
13388     * is the frame that finished loading
13389     * @li "load,error": Load failed. Event info is a pointer to
13390     * Elm_Web_Frame_Load_Error
13391     * @li "load,finished": Load finished. Event info is NULL on success, on
13392     * error it's a pointer to Elm_Web_Frame_Load_Error
13393     * @li "load,newwindow,show": A new window was created and is ready to be
13394     * shown
13395     * @li "load,progress": Overall load progress. Event info is a pointer to
13396     * a double containing a value between 0.0 and 1.0
13397     * @li "load,provisional": Started provisional load
13398     * @li "load,started": Loading of a document started
13399     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13400     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13401     * the menubar is visible, or EINA_FALSE in case it's not
13402     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13403     * an Eina_Bool indicating the visibility
13404     * @li "popup,created": A dropdown widget was activated, requesting its
13405     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13406     * @li "popup,willdelete": The web object is ready to destroy the popup
13407     * object created. Event info is a pointer to Elm_Web_Menu
13408     * @li "ready": Page is fully loaded
13409     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13410     * info is a pointer to Eina_Bool where the visibility state should be set
13411     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13412     * is an Eina_Bool with the visibility state set
13413     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13414     * a string with the new text
13415     * @li "statusbar,visible,get": Queries visibility of the status bar.
13416     * Event info is a pointer to Eina_Bool where the visibility state should be
13417     * set.
13418     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13419     * an Eina_Bool with the visibility value
13420     * @li "title,changed": Title of the main frame changed. Event info is a
13421     * string with the new title
13422     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13423     * is a pointer to Eina_Bool where the visibility state should be set
13424     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13425     * info is an Eina_Bool with the visibility state
13426     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13427     * a string with the text to show
13428     * @li "uri,changed": URI of the main frame changed. Event info is a string
13429     * with the new URI
13430     * @li "view,resized": The web object internal's view changed sized
13431     * @li "windows,close,request": A JavaScript request to close the current
13432     * window was requested
13433     * @li "zoom,animated,end": Animated zoom finished
13434     *
13435     * available styles:
13436     * - default
13437     *
13438     * An example of use of web:
13439     *
13440     * - @ref web_example_01 TBD
13441     */
13442
13443    /**
13444     * @addtogroup Web
13445     * @{
13446     */
13447
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    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13459    /**
13460     * Structure used to report load errors.
13461     *
13462     * Load errors are reported as signal by elm_web. All the strings are
13463     * temporary references and should @b not be used after the signal
13464     * callback returns. If it's required, make copies with strdup() or
13465     * eina_stringshare_add() (they are not even guaranteed to be
13466     * stringshared, so must use eina_stringshare_add() and not
13467     * eina_stringshare_ref()).
13468     */
13469    struct _Elm_Web_Frame_Load_Error
13470      {
13471         int code; /**< Numeric error code */
13472         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13473         const char *domain; /**< Error domain name */
13474         const char *description; /**< Error description (already localized) */
13475         const char *failing_url; /**< The URL that failed to load */
13476         Evas_Object *frame; /**< Frame object that produced the error */
13477      };
13478
13479    /**
13480     * The possibles types that the items in a menu can be
13481     */
13482    typedef enum _Elm_Web_Menu_Item_Type
13483      {
13484         ELM_WEB_MENU_SEPARATOR,
13485         ELM_WEB_MENU_GROUP,
13486         ELM_WEB_MENU_OPTION
13487      } Elm_Web_Menu_Item_Type;
13488
13489    /**
13490     * Structure describing the items in a menu
13491     */
13492    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13493    /**
13494     * Structure describing the items in a menu
13495     */
13496    struct _Elm_Web_Menu_Item
13497      {
13498         const char *text; /**< The text for the item */
13499         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13500      };
13501
13502    /**
13503     * Structure describing the menu of a popup
13504     *
13505     * This structure will be passed as the @c event_info for the "popup,create"
13506     * signal, which is emitted when a dropdown menu is opened. Users wanting
13507     * to handle these popups by themselves should listen to this signal and
13508     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13509     * property as @c EINA_FALSE means that the user will not handle the popup
13510     * and the default implementation will be used.
13511     *
13512     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13513     * will be emitted to notify the user that it can destroy any objects and
13514     * free all data related to it.
13515     *
13516     * @see elm_web_popup_selected_set()
13517     * @see elm_web_popup_destroy()
13518     */
13519    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13520    /**
13521     * Structure describing the menu of a popup
13522     *
13523     * This structure will be passed as the @c event_info for the "popup,create"
13524     * signal, which is emitted when a dropdown menu is opened. Users wanting
13525     * to handle these popups by themselves should listen to this signal and
13526     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13527     * property as @c EINA_FALSE means that the user will not handle the popup
13528     * and the default implementation will be used.
13529     *
13530     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13531     * will be emitted to notify the user that it can destroy any objects and
13532     * free all data related to it.
13533     *
13534     * @see elm_web_popup_selected_set()
13535     * @see elm_web_popup_destroy()
13536     */
13537    struct _Elm_Web_Menu
13538      {
13539         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13540         int x; /**< The X position of the popup, relative to the elm_web object */
13541         int y; /**< The Y position of the popup, relative to the elm_web object */
13542         int width; /**< Width of the popup menu */
13543         int height; /**< Height of the popup menu */
13544
13545         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. */
13546      };
13547
13548    typedef struct _Elm_Web_Download Elm_Web_Download;
13549    struct _Elm_Web_Download
13550      {
13551         const char *url;
13552      };
13553
13554    /**
13555     * Types of zoom available.
13556     */
13557    typedef enum _Elm_Web_Zoom_Mode
13558      {
13559         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13560         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13561         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13562         ELM_WEB_ZOOM_MODE_LAST
13563      } Elm_Web_Zoom_Mode;
13564    /**
13565     * Opaque handler containing the features (such as statusbar, menubar, etc)
13566     * that are to be set on a newly requested window.
13567     */
13568    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13569    /**
13570     * Callback type for the create_window hook.
13571     *
13572     * The function parameters are:
13573     * @li @p data User data pointer set when setting the hook function
13574     * @li @p obj The elm_web object requesting the new window
13575     * @li @p js Set to @c EINA_TRUE if the request was originated from
13576     * JavaScript. @c EINA_FALSE otherwise.
13577     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13578     * the features requested for the new window.
13579     *
13580     * The returned value of the function should be the @c elm_web widget where
13581     * the request will be loaded. That is, if a new window or tab is created,
13582     * the elm_web widget in it should be returned, and @b NOT the window
13583     * object.
13584     * Returning @c NULL should cancel the request.
13585     *
13586     * @see elm_web_window_create_hook_set()
13587     */
13588    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13589    /**
13590     * Callback type for the JS alert hook.
13591     *
13592     * The function parameters are:
13593     * @li @p data User data pointer set when setting the hook function
13594     * @li @p obj The elm_web object requesting the new window
13595     * @li @p message The message to show in the alert dialog
13596     *
13597     * The function should return the object representing the alert dialog.
13598     * Elm_Web will run a second main loop to handle the dialog and normal
13599     * flow of the application will be restored when the object is deleted, so
13600     * the user should handle the popup properly in order to delete the object
13601     * when the action is finished.
13602     * If the function returns @c NULL the popup will be ignored.
13603     *
13604     * @see elm_web_dialog_alert_hook_set()
13605     */
13606    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13607    /**
13608     * Callback type for the JS confirm hook.
13609     *
13610     * The function parameters are:
13611     * @li @p data User data pointer set when setting the hook function
13612     * @li @p obj The elm_web object requesting the new window
13613     * @li @p message The message to show in the confirm dialog
13614     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13615     * the user selected @c Ok, @c EINA_FALSE otherwise.
13616     *
13617     * The function should return the object representing the confirm dialog.
13618     * Elm_Web will run a second main loop to handle the dialog and normal
13619     * flow of the application will be restored when the object is deleted, so
13620     * the user should handle the popup properly in order to delete the object
13621     * when the action is finished.
13622     * If the function returns @c NULL the popup will be ignored.
13623     *
13624     * @see elm_web_dialog_confirm_hook_set()
13625     */
13626    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13627    /**
13628     * Callback type for the JS prompt hook.
13629     *
13630     * The function parameters are:
13631     * @li @p data User data pointer set when setting the hook function
13632     * @li @p obj The elm_web object requesting the new window
13633     * @li @p message The message to show in the prompt dialog
13634     * @li @p def_value The default value to present the user in the entry
13635     * @li @p value Pointer where to store the value given by the user. Must
13636     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13637     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13638     * the user selected @c Ok, @c EINA_FALSE otherwise.
13639     *
13640     * The function should return the object representing the prompt dialog.
13641     * Elm_Web will run a second main loop to handle the dialog and normal
13642     * flow of the application will be restored when the object is deleted, so
13643     * the user should handle the popup properly in order to delete the object
13644     * when the action is finished.
13645     * If the function returns @c NULL the popup will be ignored.
13646     *
13647     * @see elm_web_dialog_prompt_hook_set()
13648     */
13649    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13650    /**
13651     * Callback type for the JS file selector hook.
13652     *
13653     * The function parameters are:
13654     * @li @p data User data pointer set when setting the hook function
13655     * @li @p obj The elm_web object requesting the new window
13656     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13657     * @li @p accept_types Mime types accepted
13658     * @li @p selected Pointer where to store the list of malloc'ed strings
13659     * containing the path to each file selected. Must be @c NULL if the file
13660     * dialog is cancelled
13661     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13662     * the user selected @c Ok, @c EINA_FALSE otherwise.
13663     *
13664     * The function should return the object representing the file selector
13665     * dialog.
13666     * Elm_Web will run a second main loop to handle the dialog and normal
13667     * flow of the application will be restored when the object is deleted, so
13668     * the user should handle the popup properly in order to delete the object
13669     * when the action is finished.
13670     * If the function returns @c NULL the popup will be ignored.
13671     *
13672     * @see elm_web_dialog_file selector_hook_set()
13673     */
13674    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);
13675    /**
13676     * Callback type for the JS console message hook.
13677     *
13678     * When a console message is added from JavaScript, any set function to the
13679     * console message hook will be called for the user to handle. There is no
13680     * default implementation of this hook.
13681     *
13682     * The function parameters are:
13683     * @li @p data User data pointer set when setting the hook function
13684     * @li @p obj The elm_web object that originated the message
13685     * @li @p message The message sent
13686     * @li @p line_number The line number
13687     * @li @p source_id Source id
13688     *
13689     * @see elm_web_console_message_hook_set()
13690     */
13691    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13692    /**
13693     * Add a new web object to the parent.
13694     *
13695     * @param parent The parent object.
13696     * @return The new object or NULL if it cannot be created.
13697     *
13698     * @see elm_web_uri_set()
13699     * @see elm_web_webkit_view_get()
13700     */
13701    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13702
13703    /**
13704     * Get internal ewk_view object from web object.
13705     *
13706     * Elementary may not provide some low level features of EWebKit,
13707     * instead of cluttering the API with proxy methods we opted to
13708     * return the internal reference. Be careful using it as it may
13709     * interfere with elm_web behavior.
13710     *
13711     * @param obj The web object.
13712     * @return The internal ewk_view object or NULL if it does not
13713     *         exist. (Failure to create or Elementary compiled without
13714     *         ewebkit)
13715     *
13716     * @see elm_web_add()
13717     */
13718    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13719
13720    /**
13721     * Sets the function to call when a new window is requested
13722     *
13723     * This hook will be called when a request to create a new window is
13724     * issued from the web page loaded.
13725     * There is no default implementation for this feature, so leaving this
13726     * unset or passing @c NULL in @p func will prevent new windows from
13727     * opening.
13728     *
13729     * @param obj The web object where to set the hook function
13730     * @param func The hook function to be called when a window is requested
13731     * @param data User data
13732     */
13733    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13734    /**
13735     * Sets the function to call when an alert dialog
13736     *
13737     * This hook will be called when a JavaScript alert dialog is requested.
13738     * If no function is set or @c NULL is passed in @p func, the default
13739     * implementation will take place.
13740     *
13741     * @param obj The web object where to set the hook function
13742     * @param func The callback function to be used
13743     * @param data User data
13744     *
13745     * @see elm_web_inwin_mode_set()
13746     */
13747    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13748    /**
13749     * Sets the function to call when an confirm dialog
13750     *
13751     * This hook will be called when a JavaScript confirm dialog is requested.
13752     * If no function is set or @c NULL is passed in @p func, the default
13753     * implementation will take place.
13754     *
13755     * @param obj The web object where to set the hook function
13756     * @param func The callback function to be used
13757     * @param data User data
13758     *
13759     * @see elm_web_inwin_mode_set()
13760     */
13761    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13762    /**
13763     * Sets the function to call when an prompt dialog
13764     *
13765     * This hook will be called when a JavaScript prompt dialog is requested.
13766     * If no function is set or @c NULL is passed in @p func, the default
13767     * implementation will take place.
13768     *
13769     * @param obj The web object where to set the hook function
13770     * @param func The callback function to be used
13771     * @param data User data
13772     *
13773     * @see elm_web_inwin_mode_set()
13774     */
13775    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13776    /**
13777     * Sets the function to call when an file selector dialog
13778     *
13779     * This hook will be called when a JavaScript file selector dialog is
13780     * requested.
13781     * If no function is set or @c NULL is passed in @p func, the default
13782     * implementation will take place.
13783     *
13784     * @param obj The web object where to set the hook function
13785     * @param func The callback function to be used
13786     * @param data User data
13787     *
13788     * @see elm_web_inwin_mode_set()
13789     */
13790    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13791    /**
13792     * Sets the function to call when a console message is emitted from JS
13793     *
13794     * This hook will be called when a console message is emitted from
13795     * JavaScript. There is no default implementation for this feature.
13796     *
13797     * @param obj The web object where to set the hook function
13798     * @param func The callback function to be used
13799     * @param data User data
13800     */
13801    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13802    /**
13803     * Gets the status of the tab propagation
13804     *
13805     * @param obj The web object to query
13806     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13807     *
13808     * @see elm_web_tab_propagate_set()
13809     */
13810    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13811    /**
13812     * Sets whether to use tab propagation
13813     *
13814     * If tab propagation is enabled, whenever the user presses the Tab key,
13815     * Elementary will handle it and switch focus to the next widget.
13816     * The default value is disabled, where WebKit will handle the Tab key to
13817     * cycle focus though its internal objects, jumping to the next widget
13818     * only when that cycle ends.
13819     *
13820     * @param obj The web object
13821     * @param propagate Whether to propagate Tab keys to Elementary or not
13822     */
13823    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13824    /**
13825     * Sets the URI for the web object
13826     *
13827     * It must be a full URI, with resource included, in the form
13828     * http://www.enlightenment.org or file:///tmp/something.html
13829     *
13830     * @param obj The web object
13831     * @param uri The URI to set
13832     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13833     */
13834    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13835    /**
13836     * Gets the current URI for the object
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 URI, or NULL on
13843     * failure
13844     */
13845    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13846    /**
13847     * Gets the current title
13848     *
13849     * The returned string must not be freed and is guaranteed to be
13850     * stringshared.
13851     *
13852     * @param obj The web object
13853     * @return A stringshared internal string with the current title, or NULL on
13854     * failure
13855     */
13856    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13857    /**
13858     * Sets the background color to be used by the web object
13859     *
13860     * This is the color that will be used by default when the loaded page
13861     * does not set it's own. Color values are pre-multiplied.
13862     *
13863     * @param obj The web object
13864     * @param r Red component
13865     * @param g Green component
13866     * @param b Blue component
13867     * @param a Alpha component
13868     */
13869    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13870    /**
13871     * Gets the background color to be used by the web object
13872     *
13873     * This is the color that will be used by default when the loaded page
13874     * does not set it's own. Color values are pre-multiplied.
13875     *
13876     * @param obj The web object
13877     * @param r Red component
13878     * @param g Green component
13879     * @param b Blue component
13880     * @param a Alpha component
13881     */
13882    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13883    /**
13884     * Gets a copy of the currently selected text
13885     *
13886     * The string returned must be freed by the user when it's done with it.
13887     *
13888     * @param obj The web object
13889     * @return A newly allocated string, or NULL if nothing is selected or an
13890     * error occurred
13891     */
13892    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13893    /**
13894     * Tells the web object which index in the currently open popup was selected
13895     *
13896     * When the user handles the popup creation from the "popup,created" signal,
13897     * it needs to tell the web object which item was selected by calling this
13898     * function with the index corresponding to the item.
13899     *
13900     * @param obj The web object
13901     * @param index The index selected
13902     *
13903     * @see elm_web_popup_destroy()
13904     */
13905    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13906    /**
13907     * Dismisses an open dropdown popup
13908     *
13909     * When the popup from a dropdown widget is to be dismissed, either after
13910     * selecting an option or to cancel it, this function must be called, which
13911     * will later emit an "popup,willdelete" signal to notify the user that
13912     * any memory and objects related to this popup can be freed.
13913     *
13914     * @param obj The web object
13915     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13916     * if there was no menu to destroy
13917     */
13918    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13919    /**
13920     * Searches the given string in a document.
13921     *
13922     * @param obj The web object where to search the text
13923     * @param string String to search
13924     * @param case_sensitive If search should be case sensitive or not
13925     * @param forward If search is from cursor and on or backwards
13926     * @param wrap If search should wrap at the end
13927     *
13928     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13929     * or failure
13930     */
13931    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13932    /**
13933     * Marks matches of the given string in a document.
13934     *
13935     * @param obj The web object where to search text
13936     * @param string String to match
13937     * @param case_sensitive If match should be case sensitive or not
13938     * @param highlight If matches should be highlighted
13939     * @param limit Maximum amount of matches, or zero to unlimited
13940     *
13941     * @return number of matched @a string
13942     */
13943    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13944    /**
13945     * Clears all marked matches in the document
13946     *
13947     * @param obj The web object
13948     *
13949     * @return EINA_TRUE on success, EINA_FALSE otherwise
13950     */
13951    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13952    /**
13953     * Sets whether to highlight the matched marks
13954     *
13955     * If enabled, marks set with elm_web_text_matches_mark() will be
13956     * highlighted.
13957     *
13958     * @param obj The web object
13959     * @param highlight Whether to highlight the marks or not
13960     *
13961     * @return EINA_TRUE on success, EINA_FALSE otherwise
13962     */
13963    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13964    /**
13965     * Gets whether highlighting marks is enabled
13966     *
13967     * @param The web object
13968     *
13969     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13970     * otherwise
13971     */
13972    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13973    /**
13974     * Gets the overall loading progress of the page
13975     *
13976     * Returns the estimated loading progress of the page, with a value between
13977     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13978     * included in the page.
13979     *
13980     * @param The web object
13981     *
13982     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13983     * failure
13984     */
13985    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13986    /**
13987     * Stops loading the current page
13988     *
13989     * Cancels the loading of the current page in the web object. This will
13990     * cause a "load,error" signal to be emitted, with the is_cancellation
13991     * flag set to EINA_TRUE.
13992     *
13993     * @param obj The web object
13994     *
13995     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13996     */
13997    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13998    /**
13999     * Requests a reload of the current document in the object
14000     *
14001     * @param obj The web object
14002     *
14003     * @return EINA_TRUE on success, EINA_FALSE otherwise
14004     */
14005    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
14006    /**
14007     * Requests a reload of the current document, avoiding any existing caches
14008     *
14009     * @param obj The web object
14010     *
14011     * @return EINA_TRUE on success, EINA_FALSE otherwise
14012     */
14013    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
14014    /**
14015     * Goes back one step in the browsing history
14016     *
14017     * This is equivalent to calling elm_web_object_navigate(obj, -1);
14018     *
14019     * @param obj The web object
14020     *
14021     * @return EINA_TRUE on success, EINA_FALSE otherwise
14022     *
14023     * @see elm_web_history_enable_set()
14024     * @see elm_web_back_possible()
14025     * @see elm_web_forward()
14026     * @see elm_web_navigate()
14027     */
14028    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
14029    /**
14030     * Goes forward one step in the browsing history
14031     *
14032     * This is equivalent to calling elm_web_object_navigate(obj, 1);
14033     *
14034     * @param obj The web object
14035     *
14036     * @return EINA_TRUE on success, EINA_FALSE otherwise
14037     *
14038     * @see elm_web_history_enable_set()
14039     * @see elm_web_forward_possible()
14040     * @see elm_web_back()
14041     * @see elm_web_navigate()
14042     */
14043    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14044    /**
14045     * Jumps the given number of steps in the browsing history
14046     *
14047     * The @p steps value can be a negative integer to back in history, or a
14048     * positive to move forward.
14049     *
14050     * @param obj The web object
14051     * @param steps The number of steps to jump
14052     *
14053     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14054     * history exists to jump the given number of steps
14055     *
14056     * @see elm_web_history_enable_set()
14057     * @see elm_web_navigate_possible()
14058     * @see elm_web_back()
14059     * @see elm_web_forward()
14060     */
14061    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14062    /**
14063     * Queries whether it's possible to go back in history
14064     *
14065     * @param obj The web object
14066     *
14067     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14068     * otherwise
14069     */
14070    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14071    /**
14072     * Queries whether it's possible to go forward in history
14073     *
14074     * @param obj The web object
14075     *
14076     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14077     * otherwise
14078     */
14079    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14080    /**
14081     * Queries whether it's possible to jump the given number of steps
14082     *
14083     * The @p steps value can be a negative integer to back in history, or a
14084     * positive to move forward.
14085     *
14086     * @param obj The web object
14087     * @param steps The number of steps to check for
14088     *
14089     * @return EINA_TRUE if enough history exists to perform the given jump,
14090     * EINA_FALSE otherwise
14091     */
14092    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14093    /**
14094     * Gets whether browsing history is enabled for the given object
14095     *
14096     * @param obj The web object
14097     *
14098     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14099     */
14100    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14101    /**
14102     * Enables or disables the browsing history
14103     *
14104     * @param obj The web object
14105     * @param enable Whether to enable or disable the browsing history
14106     */
14107    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14108    /**
14109     * Sets the zoom level of the web object
14110     *
14111     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14112     * values meaning zoom in and lower meaning zoom out. This function will
14113     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14114     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14115     *
14116     * @param obj The web object
14117     * @param zoom The zoom level to set
14118     */
14119    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14120    /**
14121     * Gets the current zoom level set on the web object
14122     *
14123     * Note that this is the zoom level set on the web object and not that
14124     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14125     * the two zoom levels should match, but for the other two modes the
14126     * Webkit zoom is calculated internally to match the chosen mode without
14127     * changing the zoom level set for the web object.
14128     *
14129     * @param obj The web object
14130     *
14131     * @return The zoom level set on the object
14132     */
14133    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14134    /**
14135     * Sets the zoom mode to use
14136     *
14137     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14138     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14139     *
14140     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14141     * with the elm_web_zoom_set() function.
14142     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14143     * make sure the entirety of the web object's contents are shown.
14144     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14145     * fit the contents in the web object's size, without leaving any space
14146     * unused.
14147     *
14148     * @param obj The web object
14149     * @param mode The mode to set
14150     */
14151    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14152    /**
14153     * Gets the currently set zoom mode
14154     *
14155     * @param obj The web object
14156     *
14157     * @return The current zoom mode set for the object, or
14158     * ::ELM_WEB_ZOOM_MODE_LAST on error
14159     */
14160    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14161    /**
14162     * Shows the given region in the web object
14163     *
14164     * @param obj The web object
14165     * @param x The x coordinate of the region to show
14166     * @param y The y coordinate of the region to show
14167     * @param w The width of the region to show
14168     * @param h The height of the region to show
14169     */
14170    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14171    /**
14172     * Brings in the region to the visible area
14173     *
14174     * Like elm_web_region_show(), but it animates the scrolling of the object
14175     * to show the area
14176     *
14177     * @param obj The web object
14178     * @param x The x coordinate of the region to show
14179     * @param y The y coordinate of the region to show
14180     * @param w The width of the region to show
14181     * @param h The height of the region to show
14182     */
14183    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14184    /**
14185     * Sets the default dialogs to use an Inwin instead of a normal window
14186     *
14187     * If set, then the default implementation for the JavaScript dialogs and
14188     * file selector will be opened in an Inwin. Otherwise they will use a
14189     * normal separated window.
14190     *
14191     * @param obj The web object
14192     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14193     */
14194    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14195    /**
14196     * Gets whether Inwin mode is set for the current object
14197     *
14198     * @param obj The web object
14199     *
14200     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14201     */
14202    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14203
14204    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14205    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14206    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);
14207    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14208
14209    /**
14210     * @}
14211     */
14212
14213    /**
14214     * @defgroup Hoversel Hoversel
14215     *
14216     * @image html img/widget/hoversel/preview-00.png
14217     * @image latex img/widget/hoversel/preview-00.eps
14218     *
14219     * A hoversel is a button that pops up a list of items (automatically
14220     * choosing the direction to display) that have a label and, optionally, an
14221     * icon to select from. It is a convenience widget to avoid the need to do
14222     * all the piecing together yourself. It is intended for a small number of
14223     * items in the hoversel menu (no more than 8), though is capable of many
14224     * more.
14225     *
14226     * Signals that you can add callbacks for are:
14227     * "clicked" - the user clicked the hoversel button and popped up the sel
14228     * "selected" - an item in the hoversel list is selected. event_info is the item
14229     * "dismissed" - the hover is dismissed
14230     *
14231     * See @ref tutorial_hoversel for an example.
14232     * @{
14233     */
14234    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14235    /**
14236     * @brief Add a new Hoversel object
14237     *
14238     * @param parent The parent object
14239     * @return The new object or NULL if it cannot be created
14240     */
14241    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14242    /**
14243     * @brief This sets the hoversel to expand horizontally.
14244     *
14245     * @param obj The hoversel object
14246     * @param horizontal If true, the hover will expand horizontally to the
14247     * right.
14248     *
14249     * @note The initial button will display horizontally regardless of this
14250     * setting.
14251     */
14252    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14253    /**
14254     * @brief This returns whether the hoversel is set to expand horizontally.
14255     *
14256     * @param obj The hoversel object
14257     * @return If true, the hover will expand horizontally to the right.
14258     *
14259     * @see elm_hoversel_horizontal_set()
14260     */
14261    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14262    /**
14263     * @brief Set the Hover parent
14264     *
14265     * @param obj The hoversel object
14266     * @param parent The parent to use
14267     *
14268     * Sets the hover parent object, the area that will be darkened when the
14269     * hoversel is clicked. Should probably be the window that the hoversel is
14270     * in. See @ref Hover objects for more information.
14271     */
14272    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14273    /**
14274     * @brief Get the Hover parent
14275     *
14276     * @param obj The hoversel object
14277     * @return The used parent
14278     *
14279     * Gets the hover parent object.
14280     *
14281     * @see elm_hoversel_hover_parent_set()
14282     */
14283    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14284    /**
14285     * @brief Set the hoversel button label
14286     *
14287     * @param obj The hoversel object
14288     * @param label The label text.
14289     *
14290     * This sets the label of the button that is always visible (before it is
14291     * clicked and expanded).
14292     *
14293     * @deprecated elm_object_text_set()
14294     */
14295    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14296    /**
14297     * @brief Get the hoversel button label
14298     *
14299     * @param obj The hoversel object
14300     * @return The label text.
14301     *
14302     * @deprecated elm_object_text_get()
14303     */
14304    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14305    /**
14306     * @brief Set the icon of the hoversel button
14307     *
14308     * @param obj The hoversel object
14309     * @param icon The icon object
14310     *
14311     * Sets the icon of the button that is always visible (before it is clicked
14312     * and expanded).  Once the icon object is set, a previously set one will be
14313     * deleted, if you want to keep that old content object, use the
14314     * elm_hoversel_icon_unset() function.
14315     *
14316     * @see elm_object_content_set() for the button widget
14317     */
14318    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14319    /**
14320     * @brief Get the icon of the hoversel button
14321     *
14322     * @param obj The hoversel object
14323     * @return The icon object
14324     *
14325     * Get the icon of the button that is always visible (before it is clicked
14326     * and expanded). Also see elm_object_content_get() for the button widget.
14327     *
14328     * @see elm_hoversel_icon_set()
14329     */
14330    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14331    /**
14332     * @brief Get and unparent the icon of the hoversel button
14333     *
14334     * @param obj The hoversel object
14335     * @return The icon object that was being used
14336     *
14337     * Unparent and return the icon of the button that is always visible
14338     * (before it is clicked and expanded).
14339     *
14340     * @see elm_hoversel_icon_set()
14341     * @see elm_object_content_unset() for the button widget
14342     */
14343    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14344    /**
14345     * @brief This triggers the hoversel popup from code, the same as if the user
14346     * had clicked the button.
14347     *
14348     * @param obj The hoversel object
14349     */
14350    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14351    /**
14352     * @brief This dismisses the hoversel popup as if the user had clicked
14353     * outside the hover.
14354     *
14355     * @param obj The hoversel object
14356     */
14357    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14358    /**
14359     * @brief Returns whether the hoversel is expanded.
14360     *
14361     * @param obj The hoversel object
14362     * @return  This will return EINA_TRUE if the hoversel is expanded or
14363     * EINA_FALSE if it is not expanded.
14364     */
14365    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14366    /**
14367     * @brief This will remove all the children items from the hoversel.
14368     *
14369     * @param obj The hoversel object
14370     *
14371     * @warning Should @b not be called while the hoversel is active; use
14372     * elm_hoversel_expanded_get() to check first.
14373     *
14374     * @see elm_hoversel_item_del_cb_set()
14375     * @see elm_hoversel_item_del()
14376     */
14377    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14378    /**
14379     * @brief Get the list of items within the given hoversel.
14380     *
14381     * @param obj The hoversel object
14382     * @return Returns a list of Elm_Hoversel_Item*
14383     *
14384     * @see elm_hoversel_item_add()
14385     */
14386    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14387    /**
14388     * @brief Add an item to the hoversel button
14389     *
14390     * @param obj The hoversel object
14391     * @param label The text label to use for the item (NULL if not desired)
14392     * @param icon_file An image file path on disk to use for the icon or standard
14393     * icon name (NULL if not desired)
14394     * @param icon_type The icon type if relevant
14395     * @param func Convenience function to call when this item is selected
14396     * @param data Data to pass to item-related functions
14397     * @return A handle to the item added.
14398     *
14399     * This adds an item to the hoversel to show when it is clicked. Note: if you
14400     * need to use an icon from an edje file then use
14401     * elm_hoversel_item_icon_set() right after the this function, and set
14402     * icon_file to NULL here.
14403     *
14404     * For more information on what @p icon_file and @p icon_type are see the
14405     * @ref Icon "icon documentation".
14406     */
14407    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);
14408    /**
14409     * @brief Delete an item from the hoversel
14410     *
14411     * @param item The item to delete
14412     *
14413     * This deletes the item from the hoversel (should not be called while the
14414     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14415     *
14416     * @see elm_hoversel_item_add()
14417     * @see elm_hoversel_item_del_cb_set()
14418     */
14419    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14420    /**
14421     * @brief Set the function to be called when an item from the hoversel is
14422     * freed.
14423     *
14424     * @param item The item to set the callback on
14425     * @param func The function called
14426     *
14427     * That function will receive these parameters:
14428     * @li void *item_data
14429     * @li Evas_Object *the_item_object
14430     * @li Elm_Hoversel_Item *the_object_struct
14431     *
14432     * @see elm_hoversel_item_add()
14433     */
14434    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14435    /**
14436     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14437     * that will be passed to associated function callbacks.
14438     *
14439     * @param item The item to get the data from
14440     * @return The data pointer set with elm_hoversel_item_add()
14441     *
14442     * @see elm_hoversel_item_add()
14443     */
14444    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14445    /**
14446     * @brief This returns the label text of the given hoversel item.
14447     *
14448     * @param item The item to get the label
14449     * @return The label text of the hoversel item
14450     *
14451     * @see elm_hoversel_item_add()
14452     */
14453    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14454    /**
14455     * @brief This sets the icon for the given hoversel item.
14456     *
14457     * @param item The item to set the icon
14458     * @param icon_file An image file path on disk to use for the icon or standard
14459     * icon name
14460     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14461     * to NULL if the icon is not an edje file
14462     * @param icon_type The icon type
14463     *
14464     * The icon can be loaded from the standard set, from an image file, or from
14465     * an edje file.
14466     *
14467     * @see elm_hoversel_item_add()
14468     */
14469    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);
14470    /**
14471     * @brief Get the icon object of the hoversel item
14472     *
14473     * @param item The item to get the icon from
14474     * @param icon_file The image file path on disk used for the icon or standard
14475     * icon name
14476     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14477     * if the icon is not an edje file
14478     * @param icon_type The icon type
14479     *
14480     * @see elm_hoversel_item_icon_set()
14481     * @see elm_hoversel_item_add()
14482     */
14483    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);
14484    /**
14485     * @}
14486     */
14487
14488    /**
14489     * @defgroup Toolbar Toolbar
14490     * @ingroup Elementary
14491     *
14492     * @image html img/widget/toolbar/preview-00.png
14493     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14494     *
14495     * @image html img/toolbar.png
14496     * @image latex img/toolbar.eps width=\textwidth
14497     *
14498     * A toolbar is a widget that displays a list of items inside
14499     * a box. It can be scrollable, show a menu with items that don't fit
14500     * to toolbar size or even crop them.
14501     *
14502     * Only one item can be selected at a time.
14503     *
14504     * Items can have multiple states, or show menus when selected by the user.
14505     *
14506     * Smart callbacks one can listen to:
14507     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14508     * - "language,changed" - when the program language changes
14509     *
14510     * Available styles for it:
14511     * - @c "default"
14512     * - @c "transparent" - no background or shadow, just show the content
14513     *
14514     * List of examples:
14515     * @li @ref toolbar_example_01
14516     * @li @ref toolbar_example_02
14517     * @li @ref toolbar_example_03
14518     */
14519
14520    /**
14521     * @addtogroup Toolbar
14522     * @{
14523     */
14524
14525    /**
14526     * @enum _Elm_Toolbar_Shrink_Mode
14527     * @typedef Elm_Toolbar_Shrink_Mode
14528     *
14529     * Set toolbar's items display behavior, it can be scrollabel,
14530     * show a menu with exceeding items, or simply hide them.
14531     *
14532     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14533     * from elm config.
14534     *
14535     * Values <b> don't </b> work as bitmask, only one can be choosen.
14536     *
14537     * @see elm_toolbar_mode_shrink_set()
14538     * @see elm_toolbar_mode_shrink_get()
14539     *
14540     * @ingroup Toolbar
14541     */
14542    typedef enum _Elm_Toolbar_Shrink_Mode
14543      {
14544         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14545         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14546         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14547         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14548         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14549      } Elm_Toolbar_Shrink_Mode;
14550
14551    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(). */
14552
14553    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(). */
14554
14555    /**
14556     * Add a new toolbar widget to the given parent Elementary
14557     * (container) object.
14558     *
14559     * @param parent The parent object.
14560     * @return a new toolbar widget handle or @c NULL, on errors.
14561     *
14562     * This function inserts a new toolbar widget on the canvas.
14563     *
14564     * @ingroup Toolbar
14565     */
14566    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14567
14568    /**
14569     * Set the icon size, in pixels, to be used by toolbar items.
14570     *
14571     * @param obj The toolbar object
14572     * @param icon_size The icon size in pixels
14573     *
14574     * @note Default value is @c 32. It reads value from elm config.
14575     *
14576     * @see elm_toolbar_icon_size_get()
14577     *
14578     * @ingroup Toolbar
14579     */
14580    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14581
14582    /**
14583     * Get the icon size, in pixels, to be used by toolbar items.
14584     *
14585     * @param obj The toolbar object.
14586     * @return The icon size in pixels.
14587     *
14588     * @see elm_toolbar_icon_size_set() for details.
14589     *
14590     * @ingroup Toolbar
14591     */
14592    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14593
14594    /**
14595     * Sets icon lookup order, for toolbar items' icons.
14596     *
14597     * @param obj The toolbar object.
14598     * @param order The icon lookup order.
14599     *
14600     * Icons added before calling this function will not be affected.
14601     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14602     *
14603     * @see elm_toolbar_icon_order_lookup_get()
14604     *
14605     * @ingroup Toolbar
14606     */
14607    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14608
14609    /**
14610     * Gets the icon lookup order.
14611     *
14612     * @param obj The toolbar object.
14613     * @return The icon lookup order.
14614     *
14615     * @see elm_toolbar_icon_order_lookup_set() for details.
14616     *
14617     * @ingroup Toolbar
14618     */
14619    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14620
14621    /**
14622     * Set whether the toolbar should always have an item selected.
14623     *
14624     * @param obj The toolbar object.
14625     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14626     * disable it.
14627     *
14628     * This will cause the toolbar to always have an item selected, and clicking
14629     * the selected item will not cause a selected event to be emitted. Enabling this mode
14630     * will immediately select the first toolbar item.
14631     *
14632     * Always-selected is disabled by default.
14633     *
14634     * @see elm_toolbar_always_select_mode_get().
14635     *
14636     * @ingroup Toolbar
14637     */
14638    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14639
14640    /**
14641     * Get whether the toolbar should always have an item selected.
14642     *
14643     * @param obj The toolbar object.
14644     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14645     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14646     *
14647     * @see elm_toolbar_always_select_mode_set() for details.
14648     *
14649     * @ingroup Toolbar
14650     */
14651    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14652
14653    /**
14654     * Set whether the toolbar items' should be selected by the user or not.
14655     *
14656     * @param obj The toolbar object.
14657     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14658     * enable it.
14659     *
14660     * This will turn off the ability to select items entirely and they will
14661     * neither appear selected nor emit selected signals. The clicked
14662     * callback function will still be called.
14663     *
14664     * Selection is enabled by default.
14665     *
14666     * @see elm_toolbar_no_select_mode_get().
14667     *
14668     * @ingroup Toolbar
14669     */
14670    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14671
14672    /**
14673     * Set whether the toolbar items' should be selected by the user or not.
14674     *
14675     * @param obj The toolbar object.
14676     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14677     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14678     *
14679     * @see elm_toolbar_no_select_mode_set() for details.
14680     *
14681     * @ingroup Toolbar
14682     */
14683    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14684
14685    /**
14686     * Append item to the toolbar.
14687     *
14688     * @param obj The toolbar object.
14689     * @param icon A string with icon name or the absolute path of an image file.
14690     * @param label The label of the item.
14691     * @param func The function to call when the item is clicked.
14692     * @param data The data to associate with the item for related callbacks.
14693     * @return The created item or @c NULL upon failure.
14694     *
14695     * A new item will be created and appended to the toolbar, i.e., will
14696     * be set as @b last item.
14697     *
14698     * Items created with this method can be deleted with
14699     * elm_toolbar_item_del().
14700     *
14701     * Associated @p data can be properly freed when item is deleted if a
14702     * callback function is set with elm_toolbar_item_del_cb_set().
14703     *
14704     * If a function is passed as argument, it will be called everytime this item
14705     * is selected, i.e., the user clicks over an unselected item.
14706     * If such function isn't needed, just passing
14707     * @c NULL as @p func is enough. The same should be done for @p data.
14708     *
14709     * Toolbar will load icon image from fdo or current theme.
14710     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14711     * If an absolute path is provided it will load it direct from a file.
14712     *
14713     * @see elm_toolbar_item_icon_set()
14714     * @see elm_toolbar_item_del()
14715     * @see elm_toolbar_item_del_cb_set()
14716     *
14717     * @ingroup Toolbar
14718     */
14719    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);
14720
14721    /**
14722     * Prepend item to the toolbar.
14723     *
14724     * @param obj The toolbar object.
14725     * @param icon A string with icon name or the absolute path of an image file.
14726     * @param label The label of the item.
14727     * @param func The function to call when the item is clicked.
14728     * @param data The data to associate with the item for related callbacks.
14729     * @return The created item or @c NULL upon failure.
14730     *
14731     * A new item will be created and prepended to the toolbar, i.e., will
14732     * be set as @b first item.
14733     *
14734     * Items created with this method can be deleted with
14735     * elm_toolbar_item_del().
14736     *
14737     * Associated @p data can be properly freed when item is deleted if a
14738     * callback function is set with elm_toolbar_item_del_cb_set().
14739     *
14740     * If a function is passed as argument, it will be called everytime this item
14741     * is selected, i.e., the user clicks over an unselected item.
14742     * If such function isn't needed, just passing
14743     * @c NULL as @p func is enough. The same should be done for @p data.
14744     *
14745     * Toolbar will load icon image from fdo or current theme.
14746     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14747     * If an absolute path is provided it will load it direct from a file.
14748     *
14749     * @see elm_toolbar_item_icon_set()
14750     * @see elm_toolbar_item_del()
14751     * @see elm_toolbar_item_del_cb_set()
14752     *
14753     * @ingroup Toolbar
14754     */
14755    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);
14756
14757    /**
14758     * Insert a new item into the toolbar object before item @p before.
14759     *
14760     * @param obj The toolbar object.
14761     * @param before The toolbar item to insert before.
14762     * @param icon A string with icon name or the absolute path of an image file.
14763     * @param label The label of the item.
14764     * @param func The function to call when the item is clicked.
14765     * @param data The data to associate with the item for related callbacks.
14766     * @return The created item or @c NULL upon failure.
14767     *
14768     * A new item will be created and added to the toolbar. Its position in
14769     * this toolbar will be just before item @p before.
14770     *
14771     * Items created with this method can be deleted with
14772     * elm_toolbar_item_del().
14773     *
14774     * Associated @p data can be properly freed when item is deleted if a
14775     * callback function is set with elm_toolbar_item_del_cb_set().
14776     *
14777     * If a function is passed as argument, it will be called everytime this item
14778     * is selected, i.e., the user clicks over an unselected item.
14779     * If such function isn't needed, just passing
14780     * @c NULL as @p func is enough. The same should be done for @p data.
14781     *
14782     * Toolbar will load icon image from fdo or current theme.
14783     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14784     * If an absolute path is provided it will load it direct from a file.
14785     *
14786     * @see elm_toolbar_item_icon_set()
14787     * @see elm_toolbar_item_del()
14788     * @see elm_toolbar_item_del_cb_set()
14789     *
14790     * @ingroup Toolbar
14791     */
14792    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);
14793
14794    /**
14795     * Insert a new item into the toolbar object after item @p after.
14796     *
14797     * @param obj The toolbar object.
14798     * @param after The toolbar item to insert after.
14799     * @param icon A string with icon name or the absolute path of an image file.
14800     * @param label The label of the item.
14801     * @param func The function to call when the item is clicked.
14802     * @param data The data to associate with the item for related callbacks.
14803     * @return The created item or @c NULL upon failure.
14804     *
14805     * A new item will be created and added to the toolbar. Its position in
14806     * this toolbar will be just after item @p after.
14807     *
14808     * Items created with this method can be deleted with
14809     * elm_toolbar_item_del().
14810     *
14811     * Associated @p data can be properly freed when item is deleted if a
14812     * callback function is set with elm_toolbar_item_del_cb_set().
14813     *
14814     * If a function is passed as argument, it will be called everytime this item
14815     * is selected, i.e., the user clicks over an unselected item.
14816     * If such function isn't needed, just passing
14817     * @c NULL as @p func is enough. The same should be done for @p data.
14818     *
14819     * Toolbar will load icon image from fdo or current theme.
14820     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14821     * If an absolute path is provided it will load it direct from a file.
14822     *
14823     * @see elm_toolbar_item_icon_set()
14824     * @see elm_toolbar_item_del()
14825     * @see elm_toolbar_item_del_cb_set()
14826     *
14827     * @ingroup Toolbar
14828     */
14829    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);
14830
14831    /**
14832     * Get the first item in the given toolbar widget's list of
14833     * items.
14834     *
14835     * @param obj The toolbar object
14836     * @return The first item or @c NULL, if it has no items (and on
14837     * errors)
14838     *
14839     * @see elm_toolbar_item_append()
14840     * @see elm_toolbar_last_item_get()
14841     *
14842     * @ingroup Toolbar
14843     */
14844    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14845
14846    /**
14847     * Get the last item in the given toolbar widget's list of
14848     * items.
14849     *
14850     * @param obj The toolbar object
14851     * @return The last item or @c NULL, if it has no items (and on
14852     * errors)
14853     *
14854     * @see elm_toolbar_item_prepend()
14855     * @see elm_toolbar_first_item_get()
14856     *
14857     * @ingroup Toolbar
14858     */
14859    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14860
14861    /**
14862     * Get the item after @p item in toolbar.
14863     *
14864     * @param item The toolbar item.
14865     * @return The item after @p item, or @c NULL if none or on failure.
14866     *
14867     * @note If it is the last item, @c NULL will be returned.
14868     *
14869     * @see elm_toolbar_item_append()
14870     *
14871     * @ingroup Toolbar
14872     */
14873    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14874
14875    /**
14876     * Get the item before @p item in toolbar.
14877     *
14878     * @param item The toolbar item.
14879     * @return The item before @p item, or @c NULL if none or on failure.
14880     *
14881     * @note If it is the first item, @c NULL will be returned.
14882     *
14883     * @see elm_toolbar_item_prepend()
14884     *
14885     * @ingroup Toolbar
14886     */
14887    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14888
14889    /**
14890     * Get the toolbar object from an item.
14891     *
14892     * @param item The item.
14893     * @return The toolbar object.
14894     *
14895     * This returns the toolbar object itself that an item belongs to.
14896     *
14897     * @ingroup Toolbar
14898     */
14899    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14900
14901    /**
14902     * Set the priority of a toolbar item.
14903     *
14904     * @param item The toolbar item.
14905     * @param priority The item priority. The default is zero.
14906     *
14907     * This is used only when the toolbar shrink mode is set to
14908     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14909     * When space is less than required, items with low priority
14910     * will be removed from the toolbar and added to a dynamically-created menu,
14911     * while items with higher priority will remain on the toolbar,
14912     * with the same order they were added.
14913     *
14914     * @see elm_toolbar_item_priority_get()
14915     *
14916     * @ingroup Toolbar
14917     */
14918    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14919
14920    /**
14921     * Get the priority of a toolbar item.
14922     *
14923     * @param item The toolbar item.
14924     * @return The @p item priority, or @c 0 on failure.
14925     *
14926     * @see elm_toolbar_item_priority_set() for details.
14927     *
14928     * @ingroup Toolbar
14929     */
14930    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14931
14932    /**
14933     * Get the label of item.
14934     *
14935     * @param item The item of toolbar.
14936     * @return The label of item.
14937     *
14938     * The return value is a pointer to the label associated to @p item when
14939     * it was created, with function elm_toolbar_item_append() or similar,
14940     * or later,
14941     * with function elm_toolbar_item_label_set. If no label
14942     * was passed as argument, it will return @c NULL.
14943     *
14944     * @see elm_toolbar_item_label_set() for more details.
14945     * @see elm_toolbar_item_append()
14946     *
14947     * @ingroup Toolbar
14948     */
14949    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14950
14951    /**
14952     * Set the label of item.
14953     *
14954     * @param item The item of toolbar.
14955     * @param text The label of item.
14956     *
14957     * The label to be displayed by the item.
14958     * Label will be placed at icons bottom (if set).
14959     *
14960     * If a label was passed as argument on item creation, with function
14961     * elm_toolbar_item_append() or similar, it will be already
14962     * displayed by the item.
14963     *
14964     * @see elm_toolbar_item_label_get()
14965     * @see elm_toolbar_item_append()
14966     *
14967     * @ingroup Toolbar
14968     */
14969    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14970
14971    /**
14972     * Return the data associated with a given toolbar widget item.
14973     *
14974     * @param item The toolbar widget item handle.
14975     * @return The data associated with @p item.
14976     *
14977     * @see elm_toolbar_item_data_set()
14978     *
14979     * @ingroup Toolbar
14980     */
14981    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14982
14983    /**
14984     * Set the data associated with a given toolbar widget item.
14985     *
14986     * @param item The toolbar widget item handle.
14987     * @param data The new data pointer to set to @p item.
14988     *
14989     * This sets new item data on @p item.
14990     *
14991     * @warning The old data pointer won't be touched by this function, so
14992     * the user had better to free that old data himself/herself.
14993     *
14994     * @ingroup Toolbar
14995     */
14996    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14997
14998    /**
14999     * Returns a pointer to a toolbar item by its label.
15000     *
15001     * @param obj The toolbar object.
15002     * @param label The label of the item to find.
15003     *
15004     * @return The pointer to the toolbar item matching @p label or @c NULL
15005     * on failure.
15006     *
15007     * @ingroup Toolbar
15008     */
15009    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15010
15011    /*
15012     * Get whether the @p item is selected or not.
15013     *
15014     * @param item The toolbar item.
15015     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15016     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15017     *
15018     * @see elm_toolbar_selected_item_set() for details.
15019     * @see elm_toolbar_item_selected_get()
15020     *
15021     * @ingroup Toolbar
15022     */
15023    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15024
15025    /**
15026     * Set the selected state of an item.
15027     *
15028     * @param item The toolbar item
15029     * @param selected The selected state
15030     *
15031     * This sets the selected state of the given item @p it.
15032     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15033     *
15034     * If a new item is selected the previosly selected will be unselected.
15035     * Previoulsy selected item can be get with function
15036     * elm_toolbar_selected_item_get().
15037     *
15038     * Selected items will be highlighted.
15039     *
15040     * @see elm_toolbar_item_selected_get()
15041     * @see elm_toolbar_selected_item_get()
15042     *
15043     * @ingroup Toolbar
15044     */
15045    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15046
15047    /**
15048     * Get the selected item.
15049     *
15050     * @param obj The toolbar object.
15051     * @return The selected toolbar item.
15052     *
15053     * The selected item can be unselected with function
15054     * elm_toolbar_item_selected_set().
15055     *
15056     * The selected item always will be highlighted on toolbar.
15057     *
15058     * @see elm_toolbar_selected_items_get()
15059     *
15060     * @ingroup Toolbar
15061     */
15062    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15063
15064    /**
15065     * Set the icon associated with @p item.
15066     *
15067     * @param obj The parent of this item.
15068     * @param item The toolbar item.
15069     * @param icon A string with icon name or the absolute path of an image file.
15070     *
15071     * Toolbar will load icon image from fdo or current theme.
15072     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15073     * If an absolute path is provided it will load it direct from a file.
15074     *
15075     * @see elm_toolbar_icon_order_lookup_set()
15076     * @see elm_toolbar_icon_order_lookup_get()
15077     *
15078     * @ingroup Toolbar
15079     */
15080    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15081
15082    /**
15083     * Get the string used to set the icon of @p item.
15084     *
15085     * @param item The toolbar item.
15086     * @return The string associated with the icon object.
15087     *
15088     * @see elm_toolbar_item_icon_set() for details.
15089     *
15090     * @ingroup Toolbar
15091     */
15092    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15093
15094    /**
15095     * Get the object of @p item.
15096     *
15097     * @param item The toolbar item.
15098     * @return The object
15099     *
15100     * @ingroup Toolbar
15101     */
15102    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15103
15104    /**
15105     * Get the icon object of @p item.
15106     *
15107     * @param item The toolbar item.
15108     * @return The icon object
15109     *
15110     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15111     *
15112     * @ingroup Toolbar
15113     */
15114    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15115
15116    /**
15117     * Set the icon associated with @p item to an image in a binary buffer.
15118     *
15119     * @param item The toolbar item.
15120     * @param img The binary data that will be used as an image
15121     * @param size The size of binary data @p img
15122     * @param format Optional format of @p img to pass to the image loader
15123     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15124     *
15125     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15126     *
15127     * @note The icon image set by this function can be changed by
15128     * elm_toolbar_item_icon_set().
15129     * 
15130     * @ingroup Toolbar
15131     */
15132    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);
15133
15134    /**
15135     * Delete them item from the toolbar.
15136     *
15137     * @param item The item of toolbar to be deleted.
15138     *
15139     * @see elm_toolbar_item_append()
15140     * @see elm_toolbar_item_del_cb_set()
15141     *
15142     * @ingroup Toolbar
15143     */
15144    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15145
15146    /**
15147     * Set the function called when a toolbar item is freed.
15148     *
15149     * @param item The item to set the callback on.
15150     * @param func The function called.
15151     *
15152     * If there is a @p func, then it will be called prior item's memory release.
15153     * That will be called with the following arguments:
15154     * @li item's data;
15155     * @li item's Evas object;
15156     * @li item itself;
15157     *
15158     * This way, a data associated to a toolbar item could be properly freed.
15159     *
15160     * @ingroup Toolbar
15161     */
15162    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15163
15164    /**
15165     * Get a value whether toolbar item is disabled or not.
15166     *
15167     * @param item The item.
15168     * @return The disabled state.
15169     *
15170     * @see elm_toolbar_item_disabled_set() for more details.
15171     *
15172     * @ingroup Toolbar
15173     */
15174    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15175
15176    /**
15177     * Sets the disabled/enabled state of a toolbar item.
15178     *
15179     * @param item The item.
15180     * @param disabled The disabled state.
15181     *
15182     * A disabled item cannot be selected or unselected. It will also
15183     * change its appearance (generally greyed out). This sets the
15184     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15185     * enabled).
15186     *
15187     * @ingroup Toolbar
15188     */
15189    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15190
15191    /**
15192     * Set or unset item as a separator.
15193     *
15194     * @param item The toolbar item.
15195     * @param setting @c EINA_TRUE to set item @p item as separator or
15196     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15197     *
15198     * Items aren't set as separator by default.
15199     *
15200     * If set as separator it will display separator theme, so won't display
15201     * icons or label.
15202     *
15203     * @see elm_toolbar_item_separator_get()
15204     *
15205     * @ingroup Toolbar
15206     */
15207    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15208
15209    /**
15210     * Get a value whether item is a separator or not.
15211     *
15212     * @param item The toolbar item.
15213     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15214     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15215     *
15216     * @see elm_toolbar_item_separator_set() for details.
15217     *
15218     * @ingroup Toolbar
15219     */
15220    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15221
15222    /**
15223     * Set the shrink state of toolbar @p obj.
15224     *
15225     * @param obj The toolbar object.
15226     * @param shrink_mode Toolbar's items display behavior.
15227     *
15228     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15229     * but will enforce a minimun size so all the items will fit, won't scroll
15230     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15231     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15232     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15233     *
15234     * @ingroup Toolbar
15235     */
15236    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15237
15238    /**
15239     * Get the shrink mode of toolbar @p obj.
15240     *
15241     * @param obj The toolbar object.
15242     * @return Toolbar's items display behavior.
15243     *
15244     * @see elm_toolbar_mode_shrink_set() for details.
15245     *
15246     * @ingroup Toolbar
15247     */
15248    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15249
15250    /**
15251     * Enable/disable homogenous mode.
15252     *
15253     * @param obj The toolbar object
15254     * @param homogeneous Assume the items within the toolbar are of the
15255     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15256     *
15257     * This will enable the homogeneous mode where items are of the same size.
15258     * @see elm_toolbar_homogeneous_get()
15259     *
15260     * @ingroup Toolbar
15261     */
15262    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15263
15264    /**
15265     * Get whether the homogenous mode is enabled.
15266     *
15267     * @param obj The toolbar object.
15268     * @return Assume the items within the toolbar are of the same height
15269     * and width (EINA_TRUE = on, EINA_FALSE = off).
15270     *
15271     * @see elm_toolbar_homogeneous_set()
15272     *
15273     * @ingroup Toolbar
15274     */
15275    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15276
15277    /**
15278     * Enable/disable homogenous mode.
15279     *
15280     * @param obj The toolbar object
15281     * @param homogeneous Assume the items within the toolbar are of the
15282     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15283     *
15284     * This will enable the homogeneous mode where items are of the same size.
15285     * @see elm_toolbar_homogeneous_get()
15286     *
15287     * @deprecated use elm_toolbar_homogeneous_set() instead.
15288     *
15289     * @ingroup Toolbar
15290     */
15291    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15292
15293    /**
15294     * Get whether the homogenous mode is enabled.
15295     *
15296     * @param obj The toolbar object.
15297     * @return Assume the items within the toolbar are of the same height
15298     * and width (EINA_TRUE = on, EINA_FALSE = off).
15299     *
15300     * @see elm_toolbar_homogeneous_set()
15301     * @deprecated use elm_toolbar_homogeneous_get() instead.
15302     *
15303     * @ingroup Toolbar
15304     */
15305    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15306
15307    /**
15308     * Set the parent object of the toolbar items' menus.
15309     *
15310     * @param obj The toolbar object.
15311     * @param parent The parent of the menu objects.
15312     *
15313     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15314     *
15315     * For more details about setting the parent for toolbar menus, see
15316     * elm_menu_parent_set().
15317     *
15318     * @see elm_menu_parent_set() for details.
15319     * @see elm_toolbar_item_menu_set() for details.
15320     *
15321     * @ingroup Toolbar
15322     */
15323    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15324
15325    /**
15326     * Get the parent object of the toolbar items' menus.
15327     *
15328     * @param obj The toolbar object.
15329     * @return The parent of the menu objects.
15330     *
15331     * @see elm_toolbar_menu_parent_set() for details.
15332     *
15333     * @ingroup Toolbar
15334     */
15335    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15336
15337    /**
15338     * Set the alignment of the items.
15339     *
15340     * @param obj The toolbar object.
15341     * @param align The new alignment, a float between <tt> 0.0 </tt>
15342     * and <tt> 1.0 </tt>.
15343     *
15344     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15345     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15346     * items.
15347     *
15348     * Centered items by default.
15349     *
15350     * @see elm_toolbar_align_get()
15351     *
15352     * @ingroup Toolbar
15353     */
15354    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15355
15356    /**
15357     * Get the alignment of the items.
15358     *
15359     * @param obj The toolbar object.
15360     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15361     * <tt> 1.0 </tt>.
15362     *
15363     * @see elm_toolbar_align_set() for details.
15364     *
15365     * @ingroup Toolbar
15366     */
15367    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15368
15369    /**
15370     * Set whether the toolbar item opens a menu.
15371     *
15372     * @param item The toolbar item.
15373     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15374     *
15375     * A toolbar item can be set to be a menu, using this function.
15376     *
15377     * Once it is set to be a menu, it can be manipulated through the
15378     * menu-like function elm_toolbar_menu_parent_set() and the other
15379     * elm_menu functions, using the Evas_Object @c menu returned by
15380     * elm_toolbar_item_menu_get().
15381     *
15382     * So, items to be displayed in this item's menu should be added with
15383     * elm_menu_item_add().
15384     *
15385     * The following code exemplifies the most basic usage:
15386     * @code
15387     * tb = elm_toolbar_add(win)
15388     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15389     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15390     * elm_toolbar_menu_parent_set(tb, win);
15391     * menu = elm_toolbar_item_menu_get(item);
15392     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15393     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15394     * NULL);
15395     * @endcode
15396     *
15397     * @see elm_toolbar_item_menu_get()
15398     *
15399     * @ingroup Toolbar
15400     */
15401    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15402
15403    /**
15404     * Get toolbar item's menu.
15405     *
15406     * @param item The toolbar item.
15407     * @return Item's menu object or @c NULL on failure.
15408     *
15409     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15410     * this function will set it.
15411     *
15412     * @see elm_toolbar_item_menu_set() for details.
15413     *
15414     * @ingroup Toolbar
15415     */
15416    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15417
15418    /**
15419     * Add a new state to @p item.
15420     *
15421     * @param item The item.
15422     * @param icon A string with icon name or the absolute path of an image file.
15423     * @param label The label of the new state.
15424     * @param func The function to call when the item is clicked when this
15425     * state is selected.
15426     * @param data The data to associate with the state.
15427     * @return The toolbar item state, or @c NULL upon failure.
15428     *
15429     * Toolbar will load icon image from fdo or current theme.
15430     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15431     * If an absolute path is provided it will load it direct from a file.
15432     *
15433     * States created with this function can be removed with
15434     * elm_toolbar_item_state_del().
15435     *
15436     * @see elm_toolbar_item_state_del()
15437     * @see elm_toolbar_item_state_sel()
15438     * @see elm_toolbar_item_state_get()
15439     *
15440     * @ingroup Toolbar
15441     */
15442    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);
15443
15444    /**
15445     * Delete a previoulsy added state to @p item.
15446     *
15447     * @param item The toolbar item.
15448     * @param state The state to be deleted.
15449     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15450     *
15451     * @see elm_toolbar_item_state_add()
15452     */
15453    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15454
15455    /**
15456     * Set @p state as the current state of @p it.
15457     *
15458     * @param it The item.
15459     * @param state The state to use.
15460     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15461     *
15462     * If @p state is @c NULL, it won't select any state and the default item's
15463     * icon and label will be used. It's the same behaviour than
15464     * elm_toolbar_item_state_unser().
15465     *
15466     * @see elm_toolbar_item_state_unset()
15467     *
15468     * @ingroup Toolbar
15469     */
15470    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15471
15472    /**
15473     * Unset the state of @p it.
15474     *
15475     * @param it The item.
15476     *
15477     * The default icon and label from this item will be displayed.
15478     *
15479     * @see elm_toolbar_item_state_set() for more details.
15480     *
15481     * @ingroup Toolbar
15482     */
15483    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15484
15485    /**
15486     * Get the current state of @p it.
15487     *
15488     * @param item The item.
15489     * @return The selected state or @c NULL if none is selected or on failure.
15490     *
15491     * @see elm_toolbar_item_state_set() for details.
15492     * @see elm_toolbar_item_state_unset()
15493     * @see elm_toolbar_item_state_add()
15494     *
15495     * @ingroup Toolbar
15496     */
15497    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15498
15499    /**
15500     * Get the state after selected state in toolbar's @p item.
15501     *
15502     * @param it The toolbar item to change state.
15503     * @return The state after current state, or @c NULL on failure.
15504     *
15505     * If last state is selected, this function will return first state.
15506     *
15507     * @see elm_toolbar_item_state_set()
15508     * @see elm_toolbar_item_state_add()
15509     *
15510     * @ingroup Toolbar
15511     */
15512    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15513
15514    /**
15515     * Get the state before selected state in toolbar's @p item.
15516     *
15517     * @param it The toolbar item to change state.
15518     * @return The state before current state, or @c NULL on failure.
15519     *
15520     * If first state is selected, this function will return last state.
15521     *
15522     * @see elm_toolbar_item_state_set()
15523     * @see elm_toolbar_item_state_add()
15524     *
15525     * @ingroup Toolbar
15526     */
15527    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15528
15529    /**
15530     * Set the text to be shown in a given toolbar item's tooltips.
15531     *
15532     * @param item Target item.
15533     * @param text The text to set in the content.
15534     *
15535     * Setup the text as tooltip to object. The item can have only one tooltip,
15536     * so any previous tooltip data - set with this function or
15537     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15538     *
15539     * @see elm_object_tooltip_text_set() for more details.
15540     *
15541     * @ingroup Toolbar
15542     */
15543    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15544
15545    /**
15546     * Set the content to be shown in the tooltip item.
15547     *
15548     * Setup the tooltip to item. The item can have only one tooltip,
15549     * so any previous tooltip data is removed. @p func(with @p data) will
15550     * be called every time that need show the tooltip and it should
15551     * return a valid Evas_Object. This object is then managed fully by
15552     * tooltip system and is deleted when the tooltip is gone.
15553     *
15554     * @param item the toolbar item being attached a tooltip.
15555     * @param func the function used to create the tooltip contents.
15556     * @param data what to provide to @a func as callback data/context.
15557     * @param del_cb called when data is not needed anymore, either when
15558     *        another callback replaces @a func, the tooltip is unset with
15559     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15560     *        dies. This callback receives as the first parameter the
15561     *        given @a data, and @c event_info is the item.
15562     *
15563     * @see elm_object_tooltip_content_cb_set() for more details.
15564     *
15565     * @ingroup Toolbar
15566     */
15567    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);
15568
15569    /**
15570     * Unset tooltip from item.
15571     *
15572     * @param item toolbar item to remove previously set tooltip.
15573     *
15574     * Remove tooltip from item. The callback provided as del_cb to
15575     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15576     * it is not used anymore.
15577     *
15578     * @see elm_object_tooltip_unset() for more details.
15579     * @see elm_toolbar_item_tooltip_content_cb_set()
15580     *
15581     * @ingroup Toolbar
15582     */
15583    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15584
15585    /**
15586     * Sets a different style for this item tooltip.
15587     *
15588     * @note before you set a style you should define a tooltip with
15589     *       elm_toolbar_item_tooltip_content_cb_set() or
15590     *       elm_toolbar_item_tooltip_text_set()
15591     *
15592     * @param item toolbar item with tooltip already set.
15593     * @param style the theme style to use (default, transparent, ...)
15594     *
15595     * @see elm_object_tooltip_style_set() for more details.
15596     *
15597     * @ingroup Toolbar
15598     */
15599    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15600
15601    /**
15602     * Get the style for this item tooltip.
15603     *
15604     * @param item toolbar item with tooltip already set.
15605     * @return style the theme style in use, defaults to "default". If the
15606     *         object does not have a tooltip set, then NULL is returned.
15607     *
15608     * @see elm_object_tooltip_style_get() for more details.
15609     * @see elm_toolbar_item_tooltip_style_set()
15610     *
15611     * @ingroup Toolbar
15612     */
15613    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15614
15615    /**
15616     * Set the type of mouse pointer/cursor decoration to be shown,
15617     * when the mouse pointer is over the given toolbar widget item
15618     *
15619     * @param item toolbar item to customize cursor on
15620     * @param cursor the cursor type's name
15621     *
15622     * This function works analogously as elm_object_cursor_set(), but
15623     * here the cursor's changing area is restricted to the item's
15624     * area, and not the whole widget's. Note that that item cursors
15625     * have precedence over widget cursors, so that a mouse over an
15626     * item with custom cursor set will always show @b that cursor.
15627     *
15628     * If this function is called twice for an object, a previously set
15629     * cursor will be unset on the second call.
15630     *
15631     * @see elm_object_cursor_set()
15632     * @see elm_toolbar_item_cursor_get()
15633     * @see elm_toolbar_item_cursor_unset()
15634     *
15635     * @ingroup Toolbar
15636     */
15637    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15638
15639    /*
15640     * Get the type of mouse pointer/cursor decoration set to be shown,
15641     * when the mouse pointer is over the given toolbar widget item
15642     *
15643     * @param item toolbar item with custom cursor set
15644     * @return the cursor type's name or @c NULL, if no custom cursors
15645     * were set to @p item (and on errors)
15646     *
15647     * @see elm_object_cursor_get()
15648     * @see elm_toolbar_item_cursor_set()
15649     * @see elm_toolbar_item_cursor_unset()
15650     *
15651     * @ingroup Toolbar
15652     */
15653    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15654
15655    /**
15656     * Unset any custom mouse pointer/cursor decoration set to be
15657     * shown, when the mouse pointer is over the given toolbar widget
15658     * item, thus making it show the @b default cursor again.
15659     *
15660     * @param item a toolbar item
15661     *
15662     * Use this call to undo any custom settings on this item's cursor
15663     * decoration, bringing it back to defaults (no custom style set).
15664     *
15665     * @see elm_object_cursor_unset()
15666     * @see elm_toolbar_item_cursor_set()
15667     *
15668     * @ingroup Toolbar
15669     */
15670    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15671
15672    /**
15673     * Set a different @b style for a given custom cursor set for a
15674     * toolbar item.
15675     *
15676     * @param item toolbar item with custom cursor set
15677     * @param style the <b>theme style</b> to use (e.g. @c "default",
15678     * @c "transparent", etc)
15679     *
15680     * This function only makes sense when one is using custom mouse
15681     * cursor decorations <b>defined in a theme file</b>, which can have,
15682     * given a cursor name/type, <b>alternate styles</b> on it. It
15683     * works analogously as elm_object_cursor_style_set(), but here
15684     * applyed only to toolbar item objects.
15685     *
15686     * @warning Before you set a cursor style you should have definen a
15687     *       custom cursor previously on the item, with
15688     *       elm_toolbar_item_cursor_set()
15689     *
15690     * @see elm_toolbar_item_cursor_engine_only_set()
15691     * @see elm_toolbar_item_cursor_style_get()
15692     *
15693     * @ingroup Toolbar
15694     */
15695    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15696
15697    /**
15698     * Get the current @b style set for a given toolbar item's custom
15699     * cursor
15700     *
15701     * @param item toolbar item with custom cursor set.
15702     * @return style the cursor style in use. If the object does not
15703     *         have a cursor set, then @c NULL is returned.
15704     *
15705     * @see elm_toolbar_item_cursor_style_set() for more details
15706     *
15707     * @ingroup Toolbar
15708     */
15709    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15710
15711    /**
15712     * Set if the (custom)cursor for a given toolbar item should be
15713     * searched in its theme, also, or should only rely on the
15714     * rendering engine.
15715     *
15716     * @param item item with custom (custom) cursor already set on
15717     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15718     * only on those provided by the rendering engine, @c EINA_FALSE to
15719     * have them searched on the widget's theme, as well.
15720     *
15721     * @note This call is of use only if you've set a custom cursor
15722     * for toolbar items, with elm_toolbar_item_cursor_set().
15723     *
15724     * @note By default, cursors will only be looked for between those
15725     * provided by the rendering engine.
15726     *
15727     * @ingroup Toolbar
15728     */
15729    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15730
15731    /**
15732     * Get if the (custom) cursor for a given toolbar item is being
15733     * searched in its theme, also, or is only relying on the rendering
15734     * engine.
15735     *
15736     * @param item a toolbar item
15737     * @return @c EINA_TRUE, if cursors are being looked for only on
15738     * those provided by the rendering engine, @c EINA_FALSE if they
15739     * are being searched on the widget's theme, as well.
15740     *
15741     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15742     *
15743     * @ingroup Toolbar
15744     */
15745    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15746
15747    /**
15748     * Change a toolbar's orientation
15749     * @param obj The toolbar object
15750     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15751     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15752     * @ingroup Toolbar
15753     * @deprecated use elm_toolbar_horizontal_set() instead.
15754     */
15755    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15756
15757    /**
15758     * Change a toolbar's orientation
15759     * @param obj The toolbar object
15760     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15761     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15762     * @ingroup Toolbar
15763     */
15764    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15765
15766    /**
15767     * Get a toolbar's orientation
15768     * @param obj The toolbar object
15769     * @return If @c EINA_TRUE, the toolbar is vertical
15770     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15771     * @ingroup Toolbar
15772     * @deprecated use elm_toolbar_horizontal_get() instead.
15773     */
15774    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15775
15776    /**
15777     * Get a toolbar's orientation
15778     * @param obj The toolbar object
15779     * @return If @c EINA_TRUE, the toolbar is horizontal
15780     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15781     * @ingroup Toolbar
15782     */
15783    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15784    /**
15785     * @}
15786     */
15787
15788    /**
15789     * @defgroup Tooltips Tooltips
15790     *
15791     * The Tooltip is an (internal, for now) smart object used to show a
15792     * content in a frame on mouse hover of objects(or widgets), with
15793     * tips/information about them.
15794     *
15795     * @{
15796     */
15797
15798    EAPI double       elm_tooltip_delay_get(void);
15799    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15800    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15801    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15802    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15803    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15804 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15805    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);
15806    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15807    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15808    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15809    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15810    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15811
15812    /**
15813     * @}
15814     */
15815
15816    /**
15817     * @defgroup Cursors Cursors
15818     *
15819     * The Elementary cursor is an internal smart object used to
15820     * customize the mouse cursor displayed over objects (or
15821     * widgets). In the most common scenario, the cursor decoration
15822     * comes from the graphical @b engine Elementary is running
15823     * on. Those engines may provide different decorations for cursors,
15824     * and Elementary provides functions to choose them (think of X11
15825     * cursors, as an example).
15826     *
15827     * There's also the possibility of, besides using engine provided
15828     * cursors, also use ones coming from Edje theming files. Both
15829     * globally and per widget, Elementary makes it possible for one to
15830     * make the cursors lookup to be held on engines only or on
15831     * Elementary's theme file, too. To set cursor's hot spot,
15832     * two data items should be added to cursor's theme: "hot_x" and
15833     * "hot_y", that are the offset from upper-left corner of the cursor
15834     * (coordinates 0,0).
15835     *
15836     * @{
15837     */
15838
15839    /**
15840     * Set the cursor to be shown when mouse is over the object
15841     *
15842     * Set the cursor that will be displayed when mouse is over the
15843     * object. The object can have only one cursor set to it, so if
15844     * this function is called twice for an object, the previous set
15845     * will be unset.
15846     * If using X cursors, a definition of all the valid cursor names
15847     * is listed on Elementary_Cursors.h. If an invalid name is set
15848     * the default cursor will be used.
15849     *
15850     * @param obj the object being set a cursor.
15851     * @param cursor the cursor name to be used.
15852     *
15853     * @ingroup Cursors
15854     */
15855    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15856
15857    /**
15858     * Get the cursor to be shown when mouse is over the object
15859     *
15860     * @param obj an object with cursor already set.
15861     * @return the cursor name.
15862     *
15863     * @ingroup Cursors
15864     */
15865    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15866
15867    /**
15868     * Unset cursor for object
15869     *
15870     * Unset cursor for object, and set the cursor to default if the mouse
15871     * was over this object.
15872     *
15873     * @param obj Target object
15874     * @see elm_object_cursor_set()
15875     *
15876     * @ingroup Cursors
15877     */
15878    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15879
15880    /**
15881     * Sets a different style for this object cursor.
15882     *
15883     * @note before you set a style you should define a cursor with
15884     *       elm_object_cursor_set()
15885     *
15886     * @param obj an object with cursor already set.
15887     * @param style the theme style to use (default, transparent, ...)
15888     *
15889     * @ingroup Cursors
15890     */
15891    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15892
15893    /**
15894     * Get the style for this object cursor.
15895     *
15896     * @param obj an object with cursor already set.
15897     * @return style the theme style in use, defaults to "default". If the
15898     *         object does not have a cursor set, then NULL is returned.
15899     *
15900     * @ingroup Cursors
15901     */
15902    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15903
15904    /**
15905     * Set if the cursor set should be searched on the theme or should use
15906     * the provided by the engine, only.
15907     *
15908     * @note before you set if should look on theme you should define a cursor
15909     * with elm_object_cursor_set(). By default it will only look for cursors
15910     * provided by the engine.
15911     *
15912     * @param obj an object with cursor already set.
15913     * @param engine_only boolean to define it cursors should be looked only
15914     * between the provided by the engine or searched on widget's theme as well.
15915     *
15916     * @ingroup Cursors
15917     */
15918    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15919
15920    /**
15921     * Get the cursor engine only usage for this object cursor.
15922     *
15923     * @param obj an object with cursor already set.
15924     * @return engine_only boolean to define it cursors should be
15925     * looked only between the provided by the engine or searched on
15926     * widget's theme as well. If the object does not have a cursor
15927     * set, then EINA_FALSE is returned.
15928     *
15929     * @ingroup Cursors
15930     */
15931    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15932
15933    /**
15934     * Get the configured cursor engine only usage
15935     *
15936     * This gets the globally configured exclusive usage of engine cursors.
15937     *
15938     * @return 1 if only engine cursors should be used
15939     * @ingroup Cursors
15940     */
15941    EAPI int          elm_cursor_engine_only_get(void);
15942
15943    /**
15944     * Set the configured cursor engine only usage
15945     *
15946     * This sets the globally configured exclusive usage of engine cursors.
15947     * It won't affect cursors set before changing this value.
15948     *
15949     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15950     * look for them on theme before.
15951     * @return EINA_TRUE if value is valid and setted (0 or 1)
15952     * @ingroup Cursors
15953     */
15954    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15955
15956    /**
15957     * @}
15958     */
15959
15960    /**
15961     * @defgroup Menu Menu
15962     *
15963     * @image html img/widget/menu/preview-00.png
15964     * @image latex img/widget/menu/preview-00.eps
15965     *
15966     * A menu is a list of items displayed above its parent. When the menu is
15967     * showing its parent is darkened. Each item can have a sub-menu. The menu
15968     * object can be used to display a menu on a right click event, in a toolbar,
15969     * anywhere.
15970     *
15971     * Signals that you can add callbacks for are:
15972     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15973     *             event_info is NULL.
15974     *
15975     * @see @ref tutorial_menu
15976     * @{
15977     */
15978    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15979    /**
15980     * @brief Add a new menu to the parent
15981     *
15982     * @param parent The parent object.
15983     * @return The new object or NULL if it cannot be created.
15984     */
15985    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15986    /**
15987     * @brief Set the parent for the given menu widget
15988     *
15989     * @param obj The menu object.
15990     * @param parent The new parent.
15991     */
15992    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15993    /**
15994     * @brief Get the parent for the given menu widget
15995     *
15996     * @param obj The menu object.
15997     * @return The parent.
15998     *
15999     * @see elm_menu_parent_set()
16000     */
16001    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16002    /**
16003     * @brief Move the menu to a new position
16004     *
16005     * @param obj The menu object.
16006     * @param x The new position.
16007     * @param y The new position.
16008     *
16009     * Sets the top-left position of the menu to (@p x,@p y).
16010     *
16011     * @note @p x and @p y coordinates are relative to parent.
16012     */
16013    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16014    /**
16015     * @brief Close a opened menu
16016     *
16017     * @param obj the menu object
16018     * @return void
16019     *
16020     * Hides the menu and all it's sub-menus.
16021     */
16022    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16023    /**
16024     * @brief Returns a list of @p item's items.
16025     *
16026     * @param obj The menu object
16027     * @return An Eina_List* of @p item's items
16028     */
16029    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16030    /**
16031     * @brief Get the Evas_Object of an Elm_Menu_Item
16032     *
16033     * @param item The menu item object.
16034     * @return The edje object containing the swallowed content
16035     *
16036     * @warning Don't manipulate this object!
16037     */
16038    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16039    /**
16040     * @brief Add an item at the end of the given menu widget
16041     *
16042     * @param obj The menu object.
16043     * @param parent The parent menu item (optional)
16044     * @param icon A icon display on the item. The icon will be destryed by the menu.
16045     * @param label The label of the item.
16046     * @param func Function called when the user select the item.
16047     * @param data Data sent by the callback.
16048     * @return Returns the new item.
16049     */
16050    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);
16051    /**
16052     * @brief Add an object swallowed in an item at the end of the given menu
16053     * widget
16054     *
16055     * @param obj The menu object.
16056     * @param parent The parent menu item (optional)
16057     * @param subobj The object to swallow
16058     * @param func Function called when the user select the item.
16059     * @param data Data sent by the callback.
16060     * @return Returns the new item.
16061     *
16062     * Add an evas object as an item to the menu.
16063     */
16064    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);
16065    /**
16066     * @brief Set the label of a menu item
16067     *
16068     * @param item The menu item object.
16069     * @param label The label to set for @p item
16070     *
16071     * @warning Don't use this funcion on items created with
16072     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16073     */
16074    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16075    /**
16076     * @brief Get the label of a menu item
16077     *
16078     * @param item The menu item object.
16079     * @return The label of @p item
16080     */
16081    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16082    /**
16083     * @brief Set the icon of a menu item to the standard icon with name @p icon
16084     *
16085     * @param item The menu item object.
16086     * @param icon The icon object to set for the content of @p item
16087     *
16088     * Once this icon is set, any previously set icon will be deleted.
16089     */
16090    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16091    /**
16092     * @brief Get the string representation from the icon of a menu item
16093     *
16094     * @param item The menu item object.
16095     * @return The string representation of @p item's icon or NULL
16096     *
16097     * @see elm_menu_item_object_icon_name_set()
16098     */
16099    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16100    /**
16101     * @brief Set the content object of a menu item
16102     *
16103     * @param item The menu item object
16104     * @param The content object or NULL
16105     * @return EINA_TRUE on success, else EINA_FALSE
16106     *
16107     * Use this function to change the object swallowed by a menu item, deleting
16108     * any previously swallowed object.
16109     */
16110    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16111    /**
16112     * @brief Get the content object of a menu item
16113     *
16114     * @param item The menu item object
16115     * @return The content object or NULL
16116     * @note If @p item was added with elm_menu_item_add_object, this
16117     * function will return the object passed, else it will return the
16118     * icon object.
16119     *
16120     * @see elm_menu_item_object_content_set()
16121     */
16122    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16123    /**
16124     * @brief Set the selected state of @p item.
16125     *
16126     * @param item The menu item object.
16127     * @param selected The selected/unselected state of the item
16128     */
16129    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16130    /**
16131     * @brief Get the selected state of @p item.
16132     *
16133     * @param item The menu item object.
16134     * @return The selected/unselected state of the item
16135     *
16136     * @see elm_menu_item_selected_set()
16137     */
16138    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16139    /**
16140     * @brief Set the disabled state of @p item.
16141     *
16142     * @param item The menu item object.
16143     * @param disabled The enabled/disabled state of the item
16144     */
16145    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16146    /**
16147     * @brief Get the disabled state of @p item.
16148     *
16149     * @param item The menu item object.
16150     * @return The enabled/disabled state of the item
16151     *
16152     * @see elm_menu_item_disabled_set()
16153     */
16154    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16155    /**
16156     * @brief Add a separator item to menu @p obj under @p parent.
16157     *
16158     * @param obj The menu object
16159     * @param parent The item to add the separator under
16160     * @return The created item or NULL on failure
16161     *
16162     * This is item is a @ref Separator.
16163     */
16164    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16165    /**
16166     * @brief Returns whether @p item is a separator.
16167     *
16168     * @param item The item to check
16169     * @return If true, @p item is a separator
16170     *
16171     * @see elm_menu_item_separator_add()
16172     */
16173    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16174    /**
16175     * @brief Deletes an item from the menu.
16176     *
16177     * @param item The item to delete.
16178     *
16179     * @see elm_menu_item_add()
16180     */
16181    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16182    /**
16183     * @brief Set the function called when a menu item is deleted.
16184     *
16185     * @param item The item to set the callback on
16186     * @param func The function called
16187     *
16188     * @see elm_menu_item_add()
16189     * @see elm_menu_item_del()
16190     */
16191    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16192    /**
16193     * @brief Returns the data associated with menu item @p item.
16194     *
16195     * @param item The item
16196     * @return The data associated with @p item or NULL if none was set.
16197     *
16198     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16199     */
16200    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16201    /**
16202     * @brief Sets the data to be associated with menu item @p item.
16203     *
16204     * @param item The item
16205     * @param data The data to be associated with @p item
16206     */
16207    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16208    /**
16209     * @brief Returns a list of @p item's subitems.
16210     *
16211     * @param item The item
16212     * @return An Eina_List* of @p item's subitems
16213     *
16214     * @see elm_menu_add()
16215     */
16216    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16217    /**
16218     * @brief Get the position of a menu item
16219     *
16220     * @param item The menu item
16221     * @return The item's index
16222     *
16223     * This function returns the index position of a menu item in a menu.
16224     * For a sub-menu, this number is relative to the first item in the sub-menu.
16225     *
16226     * @note Index values begin with 0
16227     */
16228    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16229    /**
16230     * @brief @brief Return a menu item's owner menu
16231     *
16232     * @param item The menu item
16233     * @return The menu object owning @p item, or NULL on failure
16234     *
16235     * Use this function to get the menu object owning an item.
16236     */
16237    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16238    /**
16239     * @brief Get the selected item in the menu
16240     *
16241     * @param obj The menu object
16242     * @return The selected item, or NULL if none
16243     *
16244     * @see elm_menu_item_selected_get()
16245     * @see elm_menu_item_selected_set()
16246     */
16247    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16248    /**
16249     * @brief Get the last item in the menu
16250     *
16251     * @param obj The menu object
16252     * @return The last item, or NULL if none
16253     */
16254    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16255    /**
16256     * @brief Get the first item in the menu
16257     *
16258     * @param obj The menu object
16259     * @return The first item, or NULL if none
16260     */
16261    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16262    /**
16263     * @brief Get the next item in the menu.
16264     *
16265     * @param item The menu item object.
16266     * @return The item after it, or NULL if none
16267     */
16268    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16269    /**
16270     * @brief Get the previous item in the menu.
16271     *
16272     * @param item The menu item object.
16273     * @return The item before it, or NULL if none
16274     */
16275    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16276    /**
16277     * @}
16278     */
16279
16280    /**
16281     * @defgroup List List
16282     * @ingroup Elementary
16283     *
16284     * @image html img/widget/list/preview-00.png
16285     * @image latex img/widget/list/preview-00.eps width=\textwidth
16286     *
16287     * @image html img/list.png
16288     * @image latex img/list.eps width=\textwidth
16289     *
16290     * A list widget is a container whose children are displayed vertically or
16291     * horizontally, in order, and can be selected.
16292     * The list can accept only one or multiple items selection. Also has many
16293     * modes of items displaying.
16294     *
16295     * A list is a very simple type of list widget.  For more robust
16296     * lists, @ref Genlist should probably be used.
16297     *
16298     * Smart callbacks one can listen to:
16299     * - @c "activated" - The user has double-clicked or pressed
16300     *   (enter|return|spacebar) on an item. The @c event_info parameter
16301     *   is the item that was activated.
16302     * - @c "clicked,double" - The user has double-clicked an item.
16303     *   The @c event_info parameter is the item that was double-clicked.
16304     * - "selected" - when the user selected an item
16305     * - "unselected" - when the user unselected an item
16306     * - "longpressed" - an item in the list is long-pressed
16307     * - "edge,top" - the list is scrolled until the top edge
16308     * - "edge,bottom" - the list is scrolled until the bottom edge
16309     * - "edge,left" - the list is scrolled until the left edge
16310     * - "edge,right" - the list is scrolled until the right edge
16311     * - "language,changed" - the program's language changed
16312     *
16313     * Available styles for it:
16314     * - @c "default"
16315     *
16316     * List of examples:
16317     * @li @ref list_example_01
16318     * @li @ref list_example_02
16319     * @li @ref list_example_03
16320     */
16321
16322    /**
16323     * @addtogroup List
16324     * @{
16325     */
16326
16327    /**
16328     * @enum _Elm_List_Mode
16329     * @typedef Elm_List_Mode
16330     *
16331     * Set list's resize behavior, transverse axis scroll and
16332     * items cropping. See each mode's description for more details.
16333     *
16334     * @note Default value is #ELM_LIST_SCROLL.
16335     *
16336     * Values <b> don't </b> work as bitmask, only one can be choosen.
16337     *
16338     * @see elm_list_mode_set()
16339     * @see elm_list_mode_get()
16340     *
16341     * @ingroup List
16342     */
16343    typedef enum _Elm_List_Mode
16344      {
16345         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. */
16346         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). */
16347         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. */
16348         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. */
16349         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16350      } Elm_List_Mode;
16351
16352    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().  */
16353
16354    /**
16355     * Add a new list widget to the given parent Elementary
16356     * (container) object.
16357     *
16358     * @param parent The parent object.
16359     * @return a new list widget handle or @c NULL, on errors.
16360     *
16361     * This function inserts a new list widget on the canvas.
16362     *
16363     * @ingroup List
16364     */
16365    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16366
16367    /**
16368     * Starts the list.
16369     *
16370     * @param obj The list object
16371     *
16372     * @note Call before running show() on the list object.
16373     * @warning If not called, it won't display the list properly.
16374     *
16375     * @code
16376     * li = elm_list_add(win);
16377     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16378     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16379     * elm_list_go(li);
16380     * evas_object_show(li);
16381     * @endcode
16382     *
16383     * @ingroup List
16384     */
16385    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16386
16387    /**
16388     * Enable or disable multiple items selection on the list object.
16389     *
16390     * @param obj The list object
16391     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16392     * disable it.
16393     *
16394     * Disabled by default. If disabled, the user can select a single item of
16395     * the list each time. Selected items are highlighted on list.
16396     * If enabled, many items can be selected.
16397     *
16398     * If a selected item is selected again, it will be unselected.
16399     *
16400     * @see elm_list_multi_select_get()
16401     *
16402     * @ingroup List
16403     */
16404    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16405
16406    /**
16407     * Get a value whether multiple items selection is enabled or not.
16408     *
16409     * @see elm_list_multi_select_set() for details.
16410     *
16411     * @param obj The list object.
16412     * @return @c EINA_TRUE means multiple items selection is enabled.
16413     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16414     * @c EINA_FALSE is returned.
16415     *
16416     * @ingroup List
16417     */
16418    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16419
16420    /**
16421     * Set which mode to use for the list object.
16422     *
16423     * @param obj The list object
16424     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16425     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16426     *
16427     * Set list's resize behavior, transverse axis scroll and
16428     * items cropping. See each mode's description for more details.
16429     *
16430     * @note Default value is #ELM_LIST_SCROLL.
16431     *
16432     * Only one can be set, if a previous one was set, it will be changed
16433     * by the new mode set. Bitmask won't work as well.
16434     *
16435     * @see elm_list_mode_get()
16436     *
16437     * @ingroup List
16438     */
16439    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16440
16441    /**
16442     * Get the mode the list is at.
16443     *
16444     * @param obj The list object
16445     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16446     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16447     *
16448     * @note see elm_list_mode_set() for more information.
16449     *
16450     * @ingroup List
16451     */
16452    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16453
16454    /**
16455     * Enable or disable horizontal mode on the list object.
16456     *
16457     * @param obj The list object.
16458     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16459     * disable it, i.e., to enable vertical mode.
16460     *
16461     * @note Vertical mode is set by default.
16462     *
16463     * On horizontal mode items are displayed on list from left to right,
16464     * instead of from top to bottom. Also, the list will scroll horizontally.
16465     * Each item will presents left icon on top and right icon, or end, at
16466     * the bottom.
16467     *
16468     * @see elm_list_horizontal_get()
16469     *
16470     * @ingroup List
16471     */
16472    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16473
16474    /**
16475     * Get a value whether horizontal mode is enabled or not.
16476     *
16477     * @param obj The list object.
16478     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16479     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16480     * @c EINA_FALSE is returned.
16481     *
16482     * @see elm_list_horizontal_set() for details.
16483     *
16484     * @ingroup List
16485     */
16486    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16487
16488    /**
16489     * Enable or disable always select mode on the list object.
16490     *
16491     * @param obj The list object
16492     * @param always_select @c EINA_TRUE to enable always select mode or
16493     * @c EINA_FALSE to disable it.
16494     *
16495     * @note Always select mode is disabled by default.
16496     *
16497     * Default behavior of list items is to only call its callback function
16498     * the first time it's pressed, i.e., when it is selected. If a selected
16499     * item is pressed again, and multi-select is disabled, it won't call
16500     * this function (if multi-select is enabled it will unselect the item).
16501     *
16502     * If always select is enabled, it will call the callback function
16503     * everytime a item is pressed, so it will call when the item is selected,
16504     * and again when a selected item is pressed.
16505     *
16506     * @see elm_list_always_select_mode_get()
16507     * @see elm_list_multi_select_set()
16508     *
16509     * @ingroup List
16510     */
16511    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16512
16513    /**
16514     * Get a value whether always select mode is enabled or not, meaning that
16515     * an item will always call its callback function, even if already selected.
16516     *
16517     * @param obj The list object
16518     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16519     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16520     * @c EINA_FALSE is returned.
16521     *
16522     * @see elm_list_always_select_mode_set() for details.
16523     *
16524     * @ingroup List
16525     */
16526    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16527
16528    /**
16529     * Set bouncing behaviour when the scrolled content reaches an edge.
16530     *
16531     * Tell the internal scroller object whether it should bounce or not
16532     * when it reaches the respective edges for each axis.
16533     *
16534     * @param obj The list object
16535     * @param h_bounce Whether to bounce or not in the horizontal axis.
16536     * @param v_bounce Whether to bounce or not in the vertical axis.
16537     *
16538     * @see elm_scroller_bounce_set()
16539     *
16540     * @ingroup List
16541     */
16542    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16543
16544    /**
16545     * Get the bouncing behaviour of the internal scroller.
16546     *
16547     * Get whether the internal scroller should bounce when the edge of each
16548     * axis is reached scrolling.
16549     *
16550     * @param obj The list object.
16551     * @param h_bounce Pointer where to store the bounce state of the horizontal
16552     * axis.
16553     * @param v_bounce Pointer where to store the bounce state of the vertical
16554     * axis.
16555     *
16556     * @see elm_scroller_bounce_get()
16557     * @see elm_list_bounce_set()
16558     *
16559     * @ingroup List
16560     */
16561    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16562
16563    /**
16564     * Set the scrollbar policy.
16565     *
16566     * @param obj The list object
16567     * @param policy_h Horizontal scrollbar policy.
16568     * @param policy_v Vertical scrollbar policy.
16569     *
16570     * This sets the scrollbar visibility policy for the given scroller.
16571     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16572     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16573     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16574     * This applies respectively for the horizontal and vertical scrollbars.
16575     *
16576     * The both are disabled by default, i.e., are set to
16577     * #ELM_SCROLLER_POLICY_OFF.
16578     *
16579     * @ingroup List
16580     */
16581    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16582
16583    /**
16584     * Get the scrollbar policy.
16585     *
16586     * @see elm_list_scroller_policy_get() for details.
16587     *
16588     * @param obj The list object.
16589     * @param policy_h Pointer where to store horizontal scrollbar policy.
16590     * @param policy_v Pointer where to store vertical scrollbar policy.
16591     *
16592     * @ingroup List
16593     */
16594    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);
16595
16596    /**
16597     * Append a new item to the list object.
16598     *
16599     * @param obj The list object.
16600     * @param label The label of the list item.
16601     * @param icon The icon object to use for the left side of the item. An
16602     * icon can be any Evas object, but usually it is an icon created
16603     * with elm_icon_add().
16604     * @param end The icon object to use for the right side of the item. An
16605     * icon can be any Evas object.
16606     * @param func The function to call when the item is clicked.
16607     * @param data The data to associate with the item for related callbacks.
16608     *
16609     * @return The created item or @c NULL upon failure.
16610     *
16611     * A new item will be created and appended to the list, i.e., will
16612     * be set as @b last item.
16613     *
16614     * Items created with this method can be deleted with
16615     * elm_list_item_del().
16616     *
16617     * Associated @p data can be properly freed when item is deleted if a
16618     * callback function is set with elm_list_item_del_cb_set().
16619     *
16620     * If a function is passed as argument, it will be called everytime this item
16621     * is selected, i.e., the user clicks over an unselected item.
16622     * If always select is enabled it will call this function every time
16623     * user clicks over an item (already selected or not).
16624     * If such function isn't needed, just passing
16625     * @c NULL as @p func is enough. The same should be done for @p data.
16626     *
16627     * Simple example (with no function callback or data associated):
16628     * @code
16629     * li = elm_list_add(win);
16630     * ic = elm_icon_add(win);
16631     * elm_icon_file_set(ic, "path/to/image", NULL);
16632     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16633     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16634     * elm_list_go(li);
16635     * evas_object_show(li);
16636     * @endcode
16637     *
16638     * @see elm_list_always_select_mode_set()
16639     * @see elm_list_item_del()
16640     * @see elm_list_item_del_cb_set()
16641     * @see elm_list_clear()
16642     * @see elm_icon_add()
16643     *
16644     * @ingroup List
16645     */
16646    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);
16647
16648    /**
16649     * Prepend a new item to the list object.
16650     *
16651     * @param obj The list object.
16652     * @param label The label of the list item.
16653     * @param icon The icon object to use for the left side of the item. An
16654     * icon can be any Evas object, but usually it is an icon created
16655     * with elm_icon_add().
16656     * @param end The icon object to use for the right side of the item. An
16657     * icon can be any Evas object.
16658     * @param func The function to call when the item is clicked.
16659     * @param data The data to associate with the item for related callbacks.
16660     *
16661     * @return The created item or @c NULL upon failure.
16662     *
16663     * A new item will be created and prepended to the list, i.e., will
16664     * be set as @b first item.
16665     *
16666     * Items created with this method can be deleted with
16667     * elm_list_item_del().
16668     *
16669     * Associated @p data can be properly freed when item is deleted if a
16670     * callback function is set with elm_list_item_del_cb_set().
16671     *
16672     * If a function is passed as argument, it will be called everytime this item
16673     * is selected, i.e., the user clicks over an unselected item.
16674     * If always select is enabled it will call this function every time
16675     * user clicks over an item (already selected or not).
16676     * If such function isn't needed, just passing
16677     * @c NULL as @p func is enough. The same should be done for @p data.
16678     *
16679     * @see elm_list_item_append() for a simple code example.
16680     * @see elm_list_always_select_mode_set()
16681     * @see elm_list_item_del()
16682     * @see elm_list_item_del_cb_set()
16683     * @see elm_list_clear()
16684     * @see elm_icon_add()
16685     *
16686     * @ingroup List
16687     */
16688    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);
16689
16690    /**
16691     * Insert a new item into the list object before item @p before.
16692     *
16693     * @param obj The list object.
16694     * @param before The list item to insert before.
16695     * @param label The label of the list item.
16696     * @param icon The icon object to use for the left side of the item. An
16697     * icon can be any Evas object, but usually it is an icon created
16698     * with elm_icon_add().
16699     * @param end The icon object to use for the right side of the item. An
16700     * icon can be any Evas object.
16701     * @param func The function to call when the item is clicked.
16702     * @param data The data to associate with the item for related callbacks.
16703     *
16704     * @return The created item or @c NULL upon failure.
16705     *
16706     * A new item will be created and added to the list. Its position in
16707     * this list will be just before item @p before.
16708     *
16709     * Items created with this method can be deleted with
16710     * elm_list_item_del().
16711     *
16712     * Associated @p data can be properly freed when item is deleted if a
16713     * callback function is set with elm_list_item_del_cb_set().
16714     *
16715     * If a function is passed as argument, it will be called everytime this item
16716     * is selected, i.e., the user clicks over an unselected item.
16717     * If always select is enabled it will call this function every time
16718     * user clicks over an item (already selected or not).
16719     * If such function isn't needed, just passing
16720     * @c NULL as @p func is enough. The same should be done for @p data.
16721     *
16722     * @see elm_list_item_append() for a simple code example.
16723     * @see elm_list_always_select_mode_set()
16724     * @see elm_list_item_del()
16725     * @see elm_list_item_del_cb_set()
16726     * @see elm_list_clear()
16727     * @see elm_icon_add()
16728     *
16729     * @ingroup List
16730     */
16731    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);
16732
16733    /**
16734     * Insert a new item into the list object after item @p after.
16735     *
16736     * @param obj The list object.
16737     * @param after The list item to insert after.
16738     * @param label The label of the list item.
16739     * @param icon The icon object to use for the left side of the item. An
16740     * icon can be any Evas object, but usually it is an icon created
16741     * with elm_icon_add().
16742     * @param end The icon object to use for the right side of the item. An
16743     * icon can be any Evas object.
16744     * @param func The function to call when the item is clicked.
16745     * @param data The data to associate with the item for related callbacks.
16746     *
16747     * @return The created item or @c NULL upon failure.
16748     *
16749     * A new item will be created and added to the list. Its position in
16750     * this list will be just after item @p after.
16751     *
16752     * Items created with this method can be deleted with
16753     * elm_list_item_del().
16754     *
16755     * Associated @p data can be properly freed when item is deleted if a
16756     * callback function is set with elm_list_item_del_cb_set().
16757     *
16758     * If a function is passed as argument, it will be called everytime this item
16759     * is selected, i.e., the user clicks over an unselected item.
16760     * If always select is enabled it will call this function every time
16761     * user clicks over an item (already selected or not).
16762     * If such function isn't needed, just passing
16763     * @c NULL as @p func is enough. The same should be done for @p data.
16764     *
16765     * @see elm_list_item_append() for a simple code example.
16766     * @see elm_list_always_select_mode_set()
16767     * @see elm_list_item_del()
16768     * @see elm_list_item_del_cb_set()
16769     * @see elm_list_clear()
16770     * @see elm_icon_add()
16771     *
16772     * @ingroup List
16773     */
16774    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);
16775
16776    /**
16777     * Insert a new item into the sorted list object.
16778     *
16779     * @param obj The list object.
16780     * @param label The label of the list item.
16781     * @param icon The icon object to use for the left side of the item. An
16782     * icon can be any Evas object, but usually it is an icon created
16783     * with elm_icon_add().
16784     * @param end The icon object to use for the right side of the item. An
16785     * icon can be any Evas object.
16786     * @param func The function to call when the item is clicked.
16787     * @param data The data to associate with the item for related callbacks.
16788     * @param cmp_func The comparing function to be used to sort list
16789     * items <b>by #Elm_List_Item item handles</b>. This function will
16790     * receive two items and compare them, returning a non-negative integer
16791     * if the second item should be place after the first, or negative value
16792     * if should be placed before.
16793     *
16794     * @return The created item or @c NULL upon failure.
16795     *
16796     * @note This function inserts values into a list object assuming it was
16797     * sorted and the result will be sorted.
16798     *
16799     * A new item will be created and added to the list. Its position in
16800     * this list will be found comparing the new item with previously inserted
16801     * items using function @p cmp_func.
16802     *
16803     * Items created with this method can be deleted with
16804     * elm_list_item_del().
16805     *
16806     * Associated @p data can be properly freed when item is deleted if a
16807     * callback function is set with elm_list_item_del_cb_set().
16808     *
16809     * If a function is passed as argument, it will be called everytime this item
16810     * is selected, i.e., the user clicks over an unselected item.
16811     * If always select is enabled it will call this function every time
16812     * user clicks over an item (already selected or not).
16813     * If such function isn't needed, just passing
16814     * @c NULL as @p func is enough. The same should be done for @p data.
16815     *
16816     * @see elm_list_item_append() for a simple code example.
16817     * @see elm_list_always_select_mode_set()
16818     * @see elm_list_item_del()
16819     * @see elm_list_item_del_cb_set()
16820     * @see elm_list_clear()
16821     * @see elm_icon_add()
16822     *
16823     * @ingroup List
16824     */
16825    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);
16826
16827    /**
16828     * Remove all list's items.
16829     *
16830     * @param obj The list object
16831     *
16832     * @see elm_list_item_del()
16833     * @see elm_list_item_append()
16834     *
16835     * @ingroup List
16836     */
16837    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16838
16839    /**
16840     * Get a list of all the list items.
16841     *
16842     * @param obj The list object
16843     * @return An @c Eina_List of list items, #Elm_List_Item,
16844     * or @c NULL on failure.
16845     *
16846     * @see elm_list_item_append()
16847     * @see elm_list_item_del()
16848     * @see elm_list_clear()
16849     *
16850     * @ingroup List
16851     */
16852    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16853
16854    /**
16855     * Get the selected item.
16856     *
16857     * @param obj The list object.
16858     * @return The selected list item.
16859     *
16860     * The selected item can be unselected with function
16861     * elm_list_item_selected_set().
16862     *
16863     * The selected item always will be highlighted on list.
16864     *
16865     * @see elm_list_selected_items_get()
16866     *
16867     * @ingroup List
16868     */
16869    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16870
16871    /**
16872     * Return a list of the currently selected list items.
16873     *
16874     * @param obj The list object.
16875     * @return An @c Eina_List of list items, #Elm_List_Item,
16876     * or @c NULL on failure.
16877     *
16878     * Multiple items can be selected if multi select is enabled. It can be
16879     * done with elm_list_multi_select_set().
16880     *
16881     * @see elm_list_selected_item_get()
16882     * @see elm_list_multi_select_set()
16883     *
16884     * @ingroup List
16885     */
16886    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16887
16888    /**
16889     * Set the selected state of an item.
16890     *
16891     * @param item The list item
16892     * @param selected The selected state
16893     *
16894     * This sets the selected state of the given item @p it.
16895     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16896     *
16897     * If a new item is selected the previosly selected will be unselected,
16898     * unless multiple selection is enabled with elm_list_multi_select_set().
16899     * Previoulsy selected item can be get with function
16900     * elm_list_selected_item_get().
16901     *
16902     * Selected items will be highlighted.
16903     *
16904     * @see elm_list_item_selected_get()
16905     * @see elm_list_selected_item_get()
16906     * @see elm_list_multi_select_set()
16907     *
16908     * @ingroup List
16909     */
16910    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16911
16912    /*
16913     * Get whether the @p item is selected or not.
16914     *
16915     * @param item The list item.
16916     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16917     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16918     *
16919     * @see elm_list_selected_item_set() for details.
16920     * @see elm_list_item_selected_get()
16921     *
16922     * @ingroup List
16923     */
16924    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16925
16926    /**
16927     * Set or unset item as a separator.
16928     *
16929     * @param it The list item.
16930     * @param setting @c EINA_TRUE to set item @p it as separator or
16931     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16932     *
16933     * Items aren't set as separator by default.
16934     *
16935     * If set as separator it will display separator theme, so won't display
16936     * icons or label.
16937     *
16938     * @see elm_list_item_separator_get()
16939     *
16940     * @ingroup List
16941     */
16942    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16943
16944    /**
16945     * Get a value whether item is a separator or not.
16946     *
16947     * @see elm_list_item_separator_set() for details.
16948     *
16949     * @param it The list item.
16950     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16951     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16952     *
16953     * @ingroup List
16954     */
16955    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16956
16957    /**
16958     * Show @p item in the list view.
16959     *
16960     * @param item The list item to be shown.
16961     *
16962     * It won't animate list until item is visible. If such behavior is wanted,
16963     * use elm_list_bring_in() intead.
16964     *
16965     * @ingroup List
16966     */
16967    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16968
16969    /**
16970     * Bring in the given item to list view.
16971     *
16972     * @param item The item.
16973     *
16974     * This causes list to jump to the given item @p item and show it
16975     * (by scrolling), if it is not fully visible.
16976     *
16977     * This may use animation to do so and take a period of time.
16978     *
16979     * If animation isn't wanted, elm_list_item_show() can be used.
16980     *
16981     * @ingroup List
16982     */
16983    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16984
16985    /**
16986     * Delete them item from the list.
16987     *
16988     * @param item The item of list to be deleted.
16989     *
16990     * If deleting all list items is required, elm_list_clear()
16991     * should be used instead of getting items list and deleting each one.
16992     *
16993     * @see elm_list_clear()
16994     * @see elm_list_item_append()
16995     * @see elm_list_item_del_cb_set()
16996     *
16997     * @ingroup List
16998     */
16999    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17000
17001    /**
17002     * Set the function called when a list item is freed.
17003     *
17004     * @param item The item to set the callback on
17005     * @param func The function called
17006     *
17007     * If there is a @p func, then it will be called prior item's memory release.
17008     * That will be called with the following arguments:
17009     * @li item's data;
17010     * @li item's Evas object;
17011     * @li item itself;
17012     *
17013     * This way, a data associated to a list item could be properly freed.
17014     *
17015     * @ingroup List
17016     */
17017    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17018
17019    /**
17020     * Get the data associated to the item.
17021     *
17022     * @param item The list item
17023     * @return The data associated to @p item
17024     *
17025     * The return value is a pointer to data associated to @p item when it was
17026     * created, with function elm_list_item_append() or similar. If no data
17027     * was passed as argument, it will return @c NULL.
17028     *
17029     * @see elm_list_item_append()
17030     *
17031     * @ingroup List
17032     */
17033    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17034
17035    /**
17036     * Get the left side icon associated to the item.
17037     *
17038     * @param item The list item
17039     * @return The left side icon associated to @p item
17040     *
17041     * The return value is a pointer to the icon associated to @p item when
17042     * it was
17043     * created, with function elm_list_item_append() or similar, or later
17044     * with function elm_list_item_icon_set(). If no icon
17045     * was passed as argument, it will return @c NULL.
17046     *
17047     * @see elm_list_item_append()
17048     * @see elm_list_item_icon_set()
17049     *
17050     * @ingroup List
17051     */
17052    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17053
17054    /**
17055     * Set the left side icon associated to the item.
17056     *
17057     * @param item The list item
17058     * @param icon The left side icon object to associate with @p item
17059     *
17060     * The icon object to use at left side of the item. An
17061     * icon can be any Evas object, but usually it is an icon created
17062     * with elm_icon_add().
17063     *
17064     * Once the icon object is set, a previously set one will be deleted.
17065     * @warning Setting the same icon for two items will cause the icon to
17066     * dissapear from the first item.
17067     *
17068     * If an icon was passed as argument on item creation, with function
17069     * elm_list_item_append() or similar, it will be already
17070     * associated to the item.
17071     *
17072     * @see elm_list_item_append()
17073     * @see elm_list_item_icon_get()
17074     *
17075     * @ingroup List
17076     */
17077    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17078
17079    /**
17080     * Get the right side icon associated to the item.
17081     *
17082     * @param item The list item
17083     * @return The right side icon associated to @p item
17084     *
17085     * The return value is a pointer to the icon associated to @p item when
17086     * it was
17087     * created, with function elm_list_item_append() or similar, or later
17088     * with function elm_list_item_icon_set(). If no icon
17089     * was passed as argument, it will return @c NULL.
17090     *
17091     * @see elm_list_item_append()
17092     * @see elm_list_item_icon_set()
17093     *
17094     * @ingroup List
17095     */
17096    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17097
17098    /**
17099     * Set the right side icon associated to the item.
17100     *
17101     * @param item The list item
17102     * @param end The right side icon object to associate with @p item
17103     *
17104     * The icon object to use at right side of the item. An
17105     * icon can be any Evas object, but usually it is an icon created
17106     * with elm_icon_add().
17107     *
17108     * Once the icon object is set, a previously set one will be deleted.
17109     * @warning Setting the same icon for two items will cause the icon to
17110     * dissapear from the first item.
17111     *
17112     * If an icon was passed as argument on item creation, with function
17113     * elm_list_item_append() or similar, it will be already
17114     * associated to the item.
17115     *
17116     * @see elm_list_item_append()
17117     * @see elm_list_item_end_get()
17118     *
17119     * @ingroup List
17120     */
17121    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17122
17123    /**
17124     * Gets the base object of the item.
17125     *
17126     * @param item The list item
17127     * @return The base object associated with @p item
17128     *
17129     * Base object is the @c Evas_Object that represents that item.
17130     *
17131     * @ingroup List
17132     */
17133    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17134    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17135
17136    /**
17137     * Get the label of item.
17138     *
17139     * @param item The item of list.
17140     * @return The label of item.
17141     *
17142     * The return value is a pointer to the label associated to @p item when
17143     * it was created, with function elm_list_item_append(), or later
17144     * with function elm_list_item_label_set. If no label
17145     * was passed as argument, it will return @c NULL.
17146     *
17147     * @see elm_list_item_label_set() for more details.
17148     * @see elm_list_item_append()
17149     *
17150     * @ingroup List
17151     */
17152    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17153
17154    /**
17155     * Set the label of item.
17156     *
17157     * @param item The item of list.
17158     * @param text The label of item.
17159     *
17160     * The label to be displayed by the item.
17161     * Label will be placed between left and right side icons (if set).
17162     *
17163     * If a label was passed as argument on item creation, with function
17164     * elm_list_item_append() or similar, it will be already
17165     * displayed by the item.
17166     *
17167     * @see elm_list_item_label_get()
17168     * @see elm_list_item_append()
17169     *
17170     * @ingroup List
17171     */
17172    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17173
17174
17175    /**
17176     * Get the item before @p it in list.
17177     *
17178     * @param it The list item.
17179     * @return The item before @p it, or @c NULL if none or on failure.
17180     *
17181     * @note If it is the first item, @c NULL will be returned.
17182     *
17183     * @see elm_list_item_append()
17184     * @see elm_list_items_get()
17185     *
17186     * @ingroup List
17187     */
17188    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17189
17190    /**
17191     * Get the item after @p it in list.
17192     *
17193     * @param it The list item.
17194     * @return The item after @p it, or @c NULL if none or on failure.
17195     *
17196     * @note If it is the last item, @c NULL will be returned.
17197     *
17198     * @see elm_list_item_append()
17199     * @see elm_list_items_get()
17200     *
17201     * @ingroup List
17202     */
17203    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17204
17205    /**
17206     * Sets the disabled/enabled state of a list item.
17207     *
17208     * @param it The item.
17209     * @param disabled The disabled state.
17210     *
17211     * A disabled item cannot be selected or unselected. It will also
17212     * change its appearance (generally greyed out). This sets the
17213     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17214     * enabled).
17215     *
17216     * @ingroup List
17217     */
17218    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17219
17220    /**
17221     * Get a value whether list item is disabled or not.
17222     *
17223     * @param it The item.
17224     * @return The disabled state.
17225     *
17226     * @see elm_list_item_disabled_set() for more details.
17227     *
17228     * @ingroup List
17229     */
17230    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17231
17232    /**
17233     * Set the text to be shown in a given list item's tooltips.
17234     *
17235     * @param item Target item.
17236     * @param text The text to set in the content.
17237     *
17238     * Setup the text as tooltip to object. The item can have only one tooltip,
17239     * so any previous tooltip data - set with this function or
17240     * elm_list_item_tooltip_content_cb_set() - is removed.
17241     *
17242     * @see elm_object_tooltip_text_set() for more details.
17243     *
17244     * @ingroup List
17245     */
17246    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17247
17248
17249    /**
17250     * @brief Disable size restrictions on an object's tooltip
17251     * @param item The tooltip's anchor object
17252     * @param disable If EINA_TRUE, size restrictions are disabled
17253     * @return EINA_FALSE on failure, EINA_TRUE on success
17254     *
17255     * This function allows a tooltip to expand beyond its parant window's canvas.
17256     * It will instead be limited only by the size of the display.
17257     */
17258    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17259    /**
17260     * @brief Retrieve size restriction state of an object's tooltip
17261     * @param obj The tooltip's anchor object
17262     * @return If EINA_TRUE, size restrictions are disabled
17263     *
17264     * This function returns whether a tooltip is allowed to expand beyond
17265     * its parant window's canvas.
17266     * It will instead be limited only by the size of the display.
17267     */
17268    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17269
17270    /**
17271     * Set the content to be shown in the tooltip item.
17272     *
17273     * Setup the tooltip to item. The item can have only one tooltip,
17274     * so any previous tooltip data is removed. @p func(with @p data) will
17275     * be called every time that need show the tooltip and it should
17276     * return a valid Evas_Object. This object is then managed fully by
17277     * tooltip system and is deleted when the tooltip is gone.
17278     *
17279     * @param item the list item being attached a tooltip.
17280     * @param func the function used to create the tooltip contents.
17281     * @param data what to provide to @a func as callback data/context.
17282     * @param del_cb called when data is not needed anymore, either when
17283     *        another callback replaces @a func, the tooltip is unset with
17284     *        elm_list_item_tooltip_unset() or the owner @a item
17285     *        dies. This callback receives as the first parameter the
17286     *        given @a data, and @c event_info is the item.
17287     *
17288     * @see elm_object_tooltip_content_cb_set() for more details.
17289     *
17290     * @ingroup List
17291     */
17292    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);
17293
17294    /**
17295     * Unset tooltip from item.
17296     *
17297     * @param item list item to remove previously set tooltip.
17298     *
17299     * Remove tooltip from item. The callback provided as del_cb to
17300     * elm_list_item_tooltip_content_cb_set() will be called to notify
17301     * it is not used anymore.
17302     *
17303     * @see elm_object_tooltip_unset() for more details.
17304     * @see elm_list_item_tooltip_content_cb_set()
17305     *
17306     * @ingroup List
17307     */
17308    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17309
17310    /**
17311     * Sets a different style for this item tooltip.
17312     *
17313     * @note before you set a style you should define a tooltip with
17314     *       elm_list_item_tooltip_content_cb_set() or
17315     *       elm_list_item_tooltip_text_set()
17316     *
17317     * @param item list item with tooltip already set.
17318     * @param style the theme style to use (default, transparent, ...)
17319     *
17320     * @see elm_object_tooltip_style_set() for more details.
17321     *
17322     * @ingroup List
17323     */
17324    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17325
17326    /**
17327     * Get the style for this item tooltip.
17328     *
17329     * @param item list item with tooltip already set.
17330     * @return style the theme style in use, defaults to "default". If the
17331     *         object does not have a tooltip set, then NULL is returned.
17332     *
17333     * @see elm_object_tooltip_style_get() for more details.
17334     * @see elm_list_item_tooltip_style_set()
17335     *
17336     * @ingroup List
17337     */
17338    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17339
17340    /**
17341     * Set the type of mouse pointer/cursor decoration to be shown,
17342     * when the mouse pointer is over the given list widget item
17343     *
17344     * @param item list item to customize cursor on
17345     * @param cursor the cursor type's name
17346     *
17347     * This function works analogously as elm_object_cursor_set(), but
17348     * here the cursor's changing area is restricted to the item's
17349     * area, and not the whole widget's. Note that that item cursors
17350     * have precedence over widget cursors, so that a mouse over an
17351     * item with custom cursor set will always show @b that cursor.
17352     *
17353     * If this function is called twice for an object, a previously set
17354     * cursor will be unset on the second call.
17355     *
17356     * @see elm_object_cursor_set()
17357     * @see elm_list_item_cursor_get()
17358     * @see elm_list_item_cursor_unset()
17359     *
17360     * @ingroup List
17361     */
17362    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17363
17364    /*
17365     * Get the type of mouse pointer/cursor decoration set to be shown,
17366     * when the mouse pointer is over the given list widget item
17367     *
17368     * @param item list item with custom cursor set
17369     * @return the cursor type's name or @c NULL, if no custom cursors
17370     * were set to @p item (and on errors)
17371     *
17372     * @see elm_object_cursor_get()
17373     * @see elm_list_item_cursor_set()
17374     * @see elm_list_item_cursor_unset()
17375     *
17376     * @ingroup List
17377     */
17378    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17379
17380    /**
17381     * Unset any custom mouse pointer/cursor decoration set to be
17382     * shown, when the mouse pointer is over the given list widget
17383     * item, thus making it show the @b default cursor again.
17384     *
17385     * @param item a list item
17386     *
17387     * Use this call to undo any custom settings on this item's cursor
17388     * decoration, bringing it back to defaults (no custom style set).
17389     *
17390     * @see elm_object_cursor_unset()
17391     * @see elm_list_item_cursor_set()
17392     *
17393     * @ingroup List
17394     */
17395    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17396
17397    /**
17398     * Set a different @b style for a given custom cursor set for a
17399     * list item.
17400     *
17401     * @param item list item with custom cursor set
17402     * @param style the <b>theme style</b> to use (e.g. @c "default",
17403     * @c "transparent", etc)
17404     *
17405     * This function only makes sense when one is using custom mouse
17406     * cursor decorations <b>defined in a theme file</b>, which can have,
17407     * given a cursor name/type, <b>alternate styles</b> on it. It
17408     * works analogously as elm_object_cursor_style_set(), but here
17409     * applyed only to list item objects.
17410     *
17411     * @warning Before you set a cursor style you should have definen a
17412     *       custom cursor previously on the item, with
17413     *       elm_list_item_cursor_set()
17414     *
17415     * @see elm_list_item_cursor_engine_only_set()
17416     * @see elm_list_item_cursor_style_get()
17417     *
17418     * @ingroup List
17419     */
17420    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17421
17422    /**
17423     * Get the current @b style set for a given list item's custom
17424     * cursor
17425     *
17426     * @param item list item with custom cursor set.
17427     * @return style the cursor style in use. If the object does not
17428     *         have a cursor set, then @c NULL is returned.
17429     *
17430     * @see elm_list_item_cursor_style_set() for more details
17431     *
17432     * @ingroup List
17433     */
17434    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17435
17436    /**
17437     * Set if the (custom)cursor for a given list item should be
17438     * searched in its theme, also, or should only rely on the
17439     * rendering engine.
17440     *
17441     * @param item item with custom (custom) cursor already set on
17442     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17443     * only on those provided by the rendering engine, @c EINA_FALSE to
17444     * have them searched on the widget's theme, as well.
17445     *
17446     * @note This call is of use only if you've set a custom cursor
17447     * for list items, with elm_list_item_cursor_set().
17448     *
17449     * @note By default, cursors will only be looked for between those
17450     * provided by the rendering engine.
17451     *
17452     * @ingroup List
17453     */
17454    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17455
17456    /**
17457     * Get if the (custom) cursor for a given list item is being
17458     * searched in its theme, also, or is only relying on the rendering
17459     * engine.
17460     *
17461     * @param item a list item
17462     * @return @c EINA_TRUE, if cursors are being looked for only on
17463     * those provided by the rendering engine, @c EINA_FALSE if they
17464     * are being searched on the widget's theme, as well.
17465     *
17466     * @see elm_list_item_cursor_engine_only_set(), for more details
17467     *
17468     * @ingroup List
17469     */
17470    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17471
17472    /**
17473     * @}
17474     */
17475
17476    /**
17477     * @defgroup Slider Slider
17478     * @ingroup Elementary
17479     *
17480     * @image html img/widget/slider/preview-00.png
17481     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17482     *
17483     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
17484     * something within a range.
17485     *
17486     * A slider can be horizontal or vertical. It can contain an Icon and has a
17487     * primary label as well as a units label (that is formatted with floating
17488     * point values and thus accepts a printf-style format string, like
17489     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
17490     * else (like on the slider itself) that also accepts a format string like
17491     * units. Label, Icon Unit and Indicator strings/objects are optional.
17492     *
17493     * A slider may be inverted which means values invert, with high vales being
17494     * on the left or top and low values on the right or bottom (as opposed to
17495     * normally being low on the left or top and high on the bottom and right).
17496     *
17497     * The slider should have its minimum and maximum values set by the
17498     * application with  elm_slider_min_max_set() and value should also be set by
17499     * the application before use with  elm_slider_value_set(). The span of the
17500     * slider is its length (horizontally or vertically). This will be scaled by
17501     * the object or applications scaling factor. At any point code can query the
17502     * slider for its value with elm_slider_value_get().
17503     *
17504     * Smart callbacks one can listen to:
17505     * - "changed" - Whenever the slider value is changed by the user.
17506     * - "slider,drag,start" - dragging the slider indicator around has started.
17507     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17508     * - "delay,changed" - A short time after the value is changed by the user.
17509     * This will be called only when the user stops dragging for
17510     * a very short period or when they release their
17511     * finger/mouse, so it avoids possibly expensive reactions to
17512     * the value change.
17513     *
17514     * Available styles for it:
17515     * - @c "default"
17516     *
17517     * Default contents parts of the slider widget that you can use for are:
17518     * @li "icon" - A icon of the slider
17519     * @li "end" - A end part content of the slider
17520     * 
17521     * Default text parts of the silder widget that you can use for are:
17522     * @li "default" - Label of the silder
17523     * Here is an example on its usage:
17524     * @li @ref slider_example
17525     */
17526
17527    /**
17528     * @addtogroup Slider
17529     * @{
17530     */
17531
17532    /**
17533     * Add a new slider widget to the given parent Elementary
17534     * (container) object.
17535     *
17536     * @param parent The parent object.
17537     * @return a new slider widget handle or @c NULL, on errors.
17538     *
17539     * This function inserts a new slider widget on the canvas.
17540     *
17541     * @ingroup Slider
17542     */
17543    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17544
17545    /**
17546     * Set the label of a given slider widget
17547     *
17548     * @param obj The progress bar object
17549     * @param label The text label string, in UTF-8
17550     *
17551     * @ingroup Slider
17552     * @deprecated use elm_object_text_set() instead.
17553     */
17554    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17555
17556    /**
17557     * Get the label of a given slider widget
17558     *
17559     * @param obj The progressbar object
17560     * @return The text label string, in UTF-8
17561     *
17562     * @ingroup Slider
17563     * @deprecated use elm_object_text_get() instead.
17564     */
17565    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17566
17567    /**
17568     * Set the icon object of the slider object.
17569     *
17570     * @param obj The slider object.
17571     * @param icon The icon object.
17572     *
17573     * On horizontal mode, icon is placed at left, and on vertical mode,
17574     * placed at top.
17575     *
17576     * @note Once the icon object is set, a previously set one will be deleted.
17577     * If you want to keep that old content object, use the
17578     * elm_slider_icon_unset() function.
17579     *
17580     * @warning If the object being set does not have minimum size hints set,
17581     * it won't get properly displayed.
17582     *
17583     * @ingroup Slider
17584     * @deprecated use elm_object_part_content_set() instead.
17585     */
17586    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17587
17588    /**
17589     * Unset an icon set on a given slider widget.
17590     *
17591     * @param obj The slider object.
17592     * @return The icon object that was being used, if any was set, or
17593     * @c NULL, otherwise (and on errors).
17594     *
17595     * On horizontal mode, icon is placed at left, and on vertical mode,
17596     * placed at top.
17597     *
17598     * This call will unparent and return the icon object which was set
17599     * for this widget, previously, on success.
17600     *
17601     * @see elm_slider_icon_set() for more details
17602     * @see elm_slider_icon_get()
17603     * @deprecated use elm_object_part_content_unset() instead.
17604     *
17605     * @ingroup Slider
17606     */
17607    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17608
17609    /**
17610     * Retrieve the icon object set for a given slider widget.
17611     *
17612     * @param obj The slider object.
17613     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17614     * otherwise (and on errors).
17615     *
17616     * On horizontal mode, icon is placed at left, and on vertical mode,
17617     * placed at top.
17618     *
17619     * @see elm_slider_icon_set() for more details
17620     * @see elm_slider_icon_unset()
17621     *
17622     * @deprecated use elm_object_part_content_get() instead.
17623     *
17624     * @ingroup Slider
17625     */
17626    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17627
17628    /**
17629     * Set the end object of the slider object.
17630     *
17631     * @param obj The slider object.
17632     * @param end The end object.
17633     *
17634     * On horizontal mode, end is placed at left, and on vertical mode,
17635     * placed at bottom.
17636     *
17637     * @note Once the icon object is set, a previously set one will be deleted.
17638     * If you want to keep that old content object, use the
17639     * elm_slider_end_unset() function.
17640     *
17641     * @warning If the object being set does not have minimum size hints set,
17642     * it won't get properly displayed.
17643     *
17644     * @deprecated use elm_object_part_content_set() instead.
17645     *
17646     * @ingroup Slider
17647     */
17648    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17649
17650    /**
17651     * Unset an end object set on a given slider widget.
17652     *
17653     * @param obj The slider object.
17654     * @return The end object that was being used, if any was set, or
17655     * @c NULL, otherwise (and on errors).
17656     *
17657     * On horizontal mode, end is placed at left, and on vertical mode,
17658     * placed at bottom.
17659     *
17660     * This call will unparent and return the icon object which was set
17661     * for this widget, previously, on success.
17662     *
17663     * @see elm_slider_end_set() for more details.
17664     * @see elm_slider_end_get()
17665     *
17666     * @deprecated use elm_object_part_content_unset() instead
17667     * instead.
17668     *
17669     * @ingroup Slider
17670     */
17671    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17672
17673    /**
17674     * Retrieve the end object set for a given slider widget.
17675     *
17676     * @param obj The slider object.
17677     * @return The end object's handle, if @p obj had one set, or @c NULL,
17678     * otherwise (and on errors).
17679     *
17680     * On horizontal mode, icon is placed at right, and on vertical mode,
17681     * placed at bottom.
17682     *
17683     * @see elm_slider_end_set() for more details.
17684     * @see elm_slider_end_unset()
17685     *
17686     *
17687     * @deprecated use elm_object_part_content_get() instead 
17688     * instead.
17689     *
17690     * @ingroup Slider
17691     */
17692    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17693
17694    /**
17695     * Set the (exact) length of the bar region of a given slider widget.
17696     *
17697     * @param obj The slider object.
17698     * @param size The length of the slider's bar region.
17699     *
17700     * This sets the minimum width (when in horizontal mode) or height
17701     * (when in vertical mode) of the actual bar area of the slider
17702     * @p obj. This in turn affects the object's minimum size. Use
17703     * this when you're not setting other size hints expanding on the
17704     * given direction (like weight and alignment hints) and you would
17705     * like it to have a specific size.
17706     *
17707     * @note Icon, end, label, indicator and unit text around @p obj
17708     * will require their
17709     * own space, which will make @p obj to require more the @p size,
17710     * actually.
17711     *
17712     * @see elm_slider_span_size_get()
17713     *
17714     * @ingroup Slider
17715     */
17716    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17717
17718    /**
17719     * Get the length set for the bar region of a given slider widget
17720     *
17721     * @param obj The slider object.
17722     * @return The length of the slider's bar region.
17723     *
17724     * If that size was not set previously, with
17725     * elm_slider_span_size_set(), this call will return @c 0.
17726     *
17727     * @ingroup Slider
17728     */
17729    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17730
17731    /**
17732     * Set the format string for the unit label.
17733     *
17734     * @param obj The slider object.
17735     * @param format The format string for the unit display.
17736     *
17737     * Unit label is displayed all the time, if set, after slider's bar.
17738     * In horizontal mode, at right and in vertical mode, at bottom.
17739     *
17740     * If @c NULL, unit label won't be visible. If not it sets the format
17741     * string for the label text. To the label text is provided a floating point
17742     * value, so the label text can display up to 1 floating point value.
17743     * Note that this is optional.
17744     *
17745     * Use a format string such as "%1.2f meters" for example, and it will
17746     * display values like: "3.14 meters" for a value equal to 3.14159.
17747     *
17748     * Default is unit label disabled.
17749     *
17750     * @see elm_slider_indicator_format_get()
17751     *
17752     * @ingroup Slider
17753     */
17754    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17755
17756    /**
17757     * Get the unit label format of the slider.
17758     *
17759     * @param obj The slider object.
17760     * @return The unit label format string in UTF-8.
17761     *
17762     * Unit label is displayed all the time, if set, after slider's bar.
17763     * In horizontal mode, at right and in vertical mode, at bottom.
17764     *
17765     * @see elm_slider_unit_format_set() for more
17766     * information on how this works.
17767     *
17768     * @ingroup Slider
17769     */
17770    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17771
17772    /**
17773     * Set the format string for the indicator label.
17774     *
17775     * @param obj The slider object.
17776     * @param indicator The format string for the indicator display.
17777     *
17778     * The slider may display its value somewhere else then unit label,
17779     * for example, above the slider knob that is dragged around. This function
17780     * sets the format string used for this.
17781     *
17782     * If @c NULL, indicator label won't be visible. If not it sets the format
17783     * string for the label text. To the label text is provided a floating point
17784     * value, so the label text can display up to 1 floating point value.
17785     * Note that this is optional.
17786     *
17787     * Use a format string such as "%1.2f meters" for example, and it will
17788     * display values like: "3.14 meters" for a value equal to 3.14159.
17789     *
17790     * Default is indicator label disabled.
17791     *
17792     * @see elm_slider_indicator_format_get()
17793     *
17794     * @ingroup Slider
17795     */
17796    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17797
17798    /**
17799     * Get the indicator label format of the slider.
17800     *
17801     * @param obj The slider object.
17802     * @return The indicator label format string in UTF-8.
17803     *
17804     * The slider may display its value somewhere else then unit label,
17805     * for example, above the slider knob that is dragged around. This function
17806     * gets the format string used for this.
17807     *
17808     * @see elm_slider_indicator_format_set() for more
17809     * information on how this works.
17810     *
17811     * @ingroup Slider
17812     */
17813    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17814
17815    /**
17816     * Set the format function pointer for the indicator label
17817     *
17818     * @param obj The slider object.
17819     * @param func The indicator format function.
17820     * @param free_func The freeing function for the format string.
17821     *
17822     * Set the callback function to format the indicator string.
17823     *
17824     * @see elm_slider_indicator_format_set() for more info on how this works.
17825     *
17826     * @ingroup Slider
17827     */
17828   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);
17829
17830   /**
17831    * Set the format function pointer for the units label
17832    *
17833    * @param obj The slider object.
17834    * @param func The units format function.
17835    * @param free_func The freeing function for the format string.
17836    *
17837    * Set the callback function to format the indicator string.
17838    *
17839    * @see elm_slider_units_format_set() for more info on how this works.
17840    *
17841    * @ingroup Slider
17842    */
17843   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);
17844
17845   /**
17846    * Set the orientation of a given slider widget.
17847    *
17848    * @param obj The slider object.
17849    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17850    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17851    *
17852    * Use this function to change how your slider is to be
17853    * disposed: vertically or horizontally.
17854    *
17855    * By default it's displayed horizontally.
17856    *
17857    * @see elm_slider_horizontal_get()
17858    *
17859    * @ingroup Slider
17860    */
17861    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17862
17863    /**
17864     * Retrieve the orientation of a given slider widget
17865     *
17866     * @param obj The slider object.
17867     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17868     * @c EINA_FALSE if it's @b vertical (and on errors).
17869     *
17870     * @see elm_slider_horizontal_set() for more details.
17871     *
17872     * @ingroup Slider
17873     */
17874    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17875
17876    /**
17877     * Set the minimum and maximum values for the slider.
17878     *
17879     * @param obj The slider object.
17880     * @param min The minimum value.
17881     * @param max The maximum value.
17882     *
17883     * Define the allowed range of values to be selected by the user.
17884     *
17885     * If actual value is less than @p min, it will be updated to @p min. If it
17886     * is bigger then @p max, will be updated to @p max. Actual value can be
17887     * get with elm_slider_value_get().
17888     *
17889     * By default, min is equal to 0.0, and max is equal to 1.0.
17890     *
17891     * @warning Maximum must be greater than minimum, otherwise behavior
17892     * is undefined.
17893     *
17894     * @see elm_slider_min_max_get()
17895     *
17896     * @ingroup Slider
17897     */
17898    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17899
17900    /**
17901     * Get the minimum and maximum values of the slider.
17902     *
17903     * @param obj The slider object.
17904     * @param min Pointer where to store the minimum value.
17905     * @param max Pointer where to store the maximum value.
17906     *
17907     * @note If only one value is needed, the other pointer can be passed
17908     * as @c NULL.
17909     *
17910     * @see elm_slider_min_max_set() for details.
17911     *
17912     * @ingroup Slider
17913     */
17914    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17915
17916    /**
17917     * Set the value the slider displays.
17918     *
17919     * @param obj The slider object.
17920     * @param val The value to be displayed.
17921     *
17922     * Value will be presented on the unit label following format specified with
17923     * elm_slider_unit_format_set() and on indicator with
17924     * elm_slider_indicator_format_set().
17925     *
17926     * @warning The value must to be between min and max values. This values
17927     * are set by elm_slider_min_max_set().
17928     *
17929     * @see elm_slider_value_get()
17930     * @see elm_slider_unit_format_set()
17931     * @see elm_slider_indicator_format_set()
17932     * @see elm_slider_min_max_set()
17933     *
17934     * @ingroup Slider
17935     */
17936    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17937
17938    /**
17939     * Get the value displayed by the spinner.
17940     *
17941     * @param obj The spinner object.
17942     * @return The value displayed.
17943     *
17944     * @see elm_spinner_value_set() for details.
17945     *
17946     * @ingroup Slider
17947     */
17948    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17949
17950    /**
17951     * Invert a given slider widget's displaying values order
17952     *
17953     * @param obj The slider object.
17954     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17955     * @c EINA_FALSE to bring it back to default, non-inverted values.
17956     *
17957     * A slider may be @b inverted, in which state it gets its
17958     * values inverted, with high vales being on the left or top and
17959     * low values on the right or bottom, as opposed to normally have
17960     * the low values on the former and high values on the latter,
17961     * respectively, for horizontal and vertical modes.
17962     *
17963     * @see elm_slider_inverted_get()
17964     *
17965     * @ingroup Slider
17966     */
17967    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17968
17969    /**
17970     * Get whether a given slider widget's displaying values are
17971     * inverted or not.
17972     *
17973     * @param obj The slider object.
17974     * @return @c EINA_TRUE, if @p obj has inverted values,
17975     * @c EINA_FALSE otherwise (and on errors).
17976     *
17977     * @see elm_slider_inverted_set() for more details.
17978     *
17979     * @ingroup Slider
17980     */
17981    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17982
17983    /**
17984     * Set whether to enlarge slider indicator (augmented knob) or not.
17985     *
17986     * @param obj The slider object.
17987     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17988     * let the knob always at default size.
17989     *
17990     * By default, indicator will be bigger while dragged by the user.
17991     *
17992     * @warning It won't display values set with
17993     * elm_slider_indicator_format_set() if you disable indicator.
17994     *
17995     * @ingroup Slider
17996     */
17997    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17998
17999    /**
18000     * Get whether a given slider widget's enlarging indicator or not.
18001     *
18002     * @param obj The slider object.
18003     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18004     * @c EINA_FALSE otherwise (and on errors).
18005     *
18006     * @see elm_slider_indicator_show_set() for details.
18007     *
18008     * @ingroup Slider
18009     */
18010    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18011
18012    /**
18013     * @}
18014     */
18015
18016    /**
18017     * @addtogroup Actionslider Actionslider
18018     *
18019     * @image html img/widget/actionslider/preview-00.png
18020     * @image latex img/widget/actionslider/preview-00.eps
18021     *
18022     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18023     * properties. The user drags and releases the indicator, to choose a label.
18024     *
18025     * Labels occupy the following positions.
18026     * a. Left
18027     * b. Right
18028     * c. Center
18029     *
18030     * Positions can be enabled or disabled.
18031     *
18032     * Magnets can be set on the above positions.
18033     *
18034     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18035     *
18036     * @note By default all positions are set as enabled.
18037     *
18038     * Signals that you can add callbacks for are:
18039     *
18040     * "selected" - when user selects an enabled position (the label is passed
18041     *              as event info)".
18042     * @n
18043     * "pos_changed" - when the indicator reaches any of the positions("left",
18044     *                 "right" or "center").
18045     *
18046     * See an example of actionslider usage @ref actionslider_example_page "here"
18047     * @{
18048     */
18049    typedef enum _Elm_Actionslider_Pos
18050      {
18051         ELM_ACTIONSLIDER_NONE = 0,
18052         ELM_ACTIONSLIDER_LEFT = 1 << 0,
18053         ELM_ACTIONSLIDER_CENTER = 1 << 1,
18054         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18055         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18056      } Elm_Actionslider_Pos;
18057
18058    /**
18059     * Add a new actionslider to the parent.
18060     *
18061     * @param parent The parent object
18062     * @return The new actionslider object or NULL if it cannot be created
18063     */
18064    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18065    /**
18066     * Set actionslider labels.
18067     *
18068     * @param obj The actionslider object
18069     * @param left_label The label to be set on the left.
18070     * @param center_label The label to be set on the center.
18071     * @param right_label The label to be set on the right.
18072     * @deprecated use elm_object_text_set() instead.
18073     */
18074    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);
18075    /**
18076     * Get actionslider labels.
18077     *
18078     * @param obj The actionslider object
18079     * @param left_label A char** to place the left_label of @p obj into.
18080     * @param center_label A char** to place the center_label of @p obj into.
18081     * @param right_label A char** to place the right_label of @p obj into.
18082     * @deprecated use elm_object_text_set() instead.
18083     */
18084    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);
18085    /**
18086     * Get actionslider selected label.
18087     *
18088     * @param obj The actionslider object
18089     * @return The selected label
18090     */
18091    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18092    /**
18093     * Set actionslider indicator position.
18094     *
18095     * @param obj The actionslider object.
18096     * @param pos The position of the indicator.
18097     */
18098    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18099    /**
18100     * Get actionslider indicator position.
18101     *
18102     * @param obj The actionslider object.
18103     * @return The position of the indicator.
18104     */
18105    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18106    /**
18107     * Set actionslider magnet position. To make multiple positions magnets @c or
18108     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18109     *
18110     * @param obj The actionslider object.
18111     * @param pos Bit mask indicating the magnet positions.
18112     */
18113    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18114    /**
18115     * Get actionslider magnet position.
18116     *
18117     * @param obj The actionslider object.
18118     * @return The positions with magnet property.
18119     */
18120    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18121    /**
18122     * Set actionslider enabled position. To set multiple positions as enabled @c or
18123     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18124     *
18125     * @note All the positions are enabled by default.
18126     *
18127     * @param obj The actionslider object.
18128     * @param pos Bit mask indicating the enabled positions.
18129     */
18130    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18131    /**
18132     * Get actionslider enabled position.
18133     *
18134     * @param obj The actionslider object.
18135     * @return The enabled positions.
18136     */
18137    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18138    /**
18139     * Set the label used on the indicator.
18140     *
18141     * @param obj The actionslider object
18142     * @param label The label to be set on the indicator.
18143     * @deprecated use elm_object_text_set() instead.
18144     */
18145    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18146    /**
18147     * Get the label used on the indicator object.
18148     *
18149     * @param obj The actionslider object
18150     * @return The indicator label
18151     * @deprecated use elm_object_text_get() instead.
18152     */
18153    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18154    /**
18155     * @}
18156     */
18157
18158    /**
18159     * @defgroup Genlist Genlist
18160     *
18161     * @image html img/widget/genlist/preview-00.png
18162     * @image latex img/widget/genlist/preview-00.eps
18163     * @image html img/genlist.png
18164     * @image latex img/genlist.eps
18165     *
18166     * This widget aims to have more expansive list than the simple list in
18167     * Elementary that could have more flexible items and allow many more entries
18168     * while still being fast and low on memory usage. At the same time it was
18169     * also made to be able to do tree structures. But the price to pay is more
18170     * complexity when it comes to usage. If all you want is a simple list with
18171     * icons and a single label, use the normal @ref List object.
18172     *
18173     * Genlist has a fairly large API, mostly because it's relatively complex,
18174     * trying to be both expansive, powerful and efficient. First we will begin
18175     * an overview on the theory behind genlist.
18176     *
18177     * @section Genlist_Item_Class Genlist item classes - creating items
18178     *
18179     * In order to have the ability to add and delete items on the fly, genlist
18180     * implements a class (callback) system where the application provides a
18181     * structure with information about that type of item (genlist may contain
18182     * multiple different items with different classes, states and styles).
18183     * Genlist will call the functions in this struct (methods) when an item is
18184     * "realized" (i.e., created dynamically, while the user is scrolling the
18185     * grid). All objects will simply be deleted when no longer needed with
18186     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18187     * following members:
18188     * - @c item_style - This is a constant string and simply defines the name
18189     *   of the item style. It @b must be specified and the default should be @c
18190     *   "default".
18191     *
18192     * - @c func - A struct with pointers to functions that will be called when
18193     *   an item is going to be actually created. All of them receive a @c data
18194     *   parameter that will point to the same data passed to
18195     *   elm_genlist_item_append() and related item creation functions, and a @c
18196     *   obj parameter that points to the genlist object itself.
18197     *
18198     * The function pointers inside @c func are @c label_get, @c icon_get, @c
18199     * state_get and @c del. The 3 first functions also receive a @c part
18200     * parameter described below. A brief description of these functions follows:
18201     *
18202     * - @c label_get - The @c part parameter is the name string of one of the
18203     *   existing text parts in the Edje group implementing the item's theme.
18204     *   This function @b must return a strdup'()ed string, as the caller will
18205     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18206     * - @c content_get - The @c part parameter is the name string of one of the
18207     *   existing (content) swallow parts in the Edje group implementing the item's
18208     *   theme. It must return @c NULL, when no content is desired, or a valid
18209     *   object handle, otherwise.  The object will be deleted by the genlist on
18210     *   its deletion or when the item is "unrealized".  See
18211     *   #Elm_Genlist_Item_Content_Get_Cb.
18212     * - @c func.state_get - The @c part parameter is the name string of one of
18213     *   the state parts in the Edje group implementing the item's theme. Return
18214     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18215     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18216     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18217     *   the state is true (the default is false), where @c XXX is the name of
18218     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18219     * - @c func.del - This is intended for use when genlist items are deleted,
18220     *   so any data attached to the item (e.g. its data parameter on creation)
18221     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18222     *
18223     * available item styles:
18224     * - default
18225     * - default_style - The text part is a textblock
18226     *
18227     * @image html img/widget/genlist/preview-04.png
18228     * @image latex img/widget/genlist/preview-04.eps
18229     *
18230     * - double_label
18231     *
18232     * @image html img/widget/genlist/preview-01.png
18233     * @image latex img/widget/genlist/preview-01.eps
18234     *
18235     * - icon_top_text_bottom
18236     *
18237     * @image html img/widget/genlist/preview-02.png
18238     * @image latex img/widget/genlist/preview-02.eps
18239     *
18240     * - group_index
18241     *
18242     * @image html img/widget/genlist/preview-03.png
18243     * @image latex img/widget/genlist/preview-03.eps
18244     *
18245     * @section Genlist_Items Structure of items
18246     *
18247     * An item in a genlist can have 0 or more text labels (they can be regular
18248     * text or textblock Evas objects - that's up to the style to determine), 0
18249     * or more contents (which are simply objects swallowed into the genlist item's
18250     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18251     * behavior left to the user to define. The Edje part names for each of
18252     * these properties will be looked up, in the theme file for the genlist,
18253     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18254     * "states", respectively. For each of those properties, if more than one
18255     * part is provided, they must have names listed separated by spaces in the
18256     * data fields. For the default genlist item theme, we have @b one label
18257     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18258     * "elm.swallow.end") and @b no state parts.
18259     *
18260     * A genlist item may be at one of several styles. Elementary provides one
18261     * by default - "default", but this can be extended by system or application
18262     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18263     * details).
18264     *
18265     * @section Genlist_Manipulation Editing and Navigating
18266     *
18267     * Items can be added by several calls. All of them return a @ref
18268     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18269     * They all take a data parameter that is meant to be used for a handle to
18270     * the applications internal data (eg the struct with the original item
18271     * data). The parent parameter is the parent genlist item this belongs to if
18272     * it is a tree or an indexed group, and NULL if there is no parent. The
18273     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18274     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18275     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18276     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18277     * is set then this item is group index item that is displayed at the top
18278     * until the next group comes. The func parameter is a convenience callback
18279     * that is called when the item is selected and the data parameter will be
18280     * the func_data parameter, obj be the genlist object and event_info will be
18281     * the genlist item.
18282     *
18283     * elm_genlist_item_append() adds an item to the end of the list, or if
18284     * there is a parent, to the end of all the child items of the parent.
18285     * elm_genlist_item_prepend() is the same but adds to the beginning of
18286     * the list or children list. elm_genlist_item_insert_before() inserts at
18287     * item before another item and elm_genlist_item_insert_after() inserts after
18288     * the indicated item.
18289     *
18290     * The application can clear the list with elm_gen_clear() which deletes
18291     * all the items in the list and elm_genlist_item_del() will delete a specific
18292     * item. elm_genlist_item_subitems_clear() will clear all items that are
18293     * children of the indicated parent item.
18294     *
18295     * To help inspect list items you can jump to the item at the top of the list
18296     * with elm_genlist_first_item_get() which will return the item pointer, and
18297     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18298     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18299     * and previous items respectively relative to the indicated item. Using
18300     * these calls you can walk the entire item list/tree. Note that as a tree
18301     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18302     * let you know which item is the parent (and thus know how to skip them if
18303     * wanted).
18304     *
18305     * @section Genlist_Muti_Selection Multi-selection
18306     *
18307     * If the application wants multiple items to be able to be selected,
18308     * elm_genlist_multi_select_set() can enable this. If the list is
18309     * single-selection only (the default), then elm_genlist_selected_item_get()
18310     * will return the selected item, if any, or NULL if none is selected. If the
18311     * list is multi-select then elm_genlist_selected_items_get() will return a
18312     * list (that is only valid as long as no items are modified (added, deleted,
18313     * selected or unselected)).
18314     *
18315     * @section Genlist_Usage_Hints Usage hints
18316     *
18317     * There are also convenience functions. elm_gen_item_genlist_get() will
18318     * return the genlist object the item belongs to. elm_genlist_item_show()
18319     * will make the scroller scroll to show that specific item so its visible.
18320     * elm_genlist_item_data_get() returns the data pointer set by the item
18321     * creation functions.
18322     *
18323     * If an item changes (state of boolean changes, label or contents change),
18324     * then use elm_genlist_item_update() to have genlist update the item with
18325     * the new state. Genlist will re-realize the item thus call the functions
18326     * in the _Elm_Genlist_Item_Class for that item.
18327     *
18328     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18329     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18330     * to expand/contract an item and get its expanded state, use
18331     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18332     * again to make an item disabled (unable to be selected and appear
18333     * differently) use elm_genlist_item_disabled_set() to set this and
18334     * elm_genlist_item_disabled_get() to get the disabled state.
18335     *
18336     * In general to indicate how the genlist should expand items horizontally to
18337     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18338     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18339     * mode means that if items are too wide to fit, the scroller will scroll
18340     * horizontally. Otherwise items are expanded to fill the width of the
18341     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18342     * to the viewport width and limited to that size. This can be combined with
18343     * a different style that uses edjes' ellipsis feature (cutting text off like
18344     * this: "tex...").
18345     *
18346     * Items will only call their selection func and callback when first becoming
18347     * selected. Any further clicks will do nothing, unless you enable always
18348     * select with elm_gen_always_select_mode_set(). This means even if
18349     * selected, every click will make the selected callbacks be called.
18350     * elm_genlist_no_select_mode_set() will turn off the ability to select
18351     * items entirely and they will neither appear selected nor call selected
18352     * callback functions.
18353     *
18354     * Remember that you can create new styles and add your own theme augmentation
18355     * per application with elm_theme_extension_add(). If you absolutely must
18356     * have a specific style that overrides any theme the user or system sets up
18357     * you can use elm_theme_overlay_add() to add such a file.
18358     *
18359     * @section Genlist_Implementation Implementation
18360     *
18361     * Evas tracks every object you create. Every time it processes an event
18362     * (mouse move, down, up etc.) it needs to walk through objects and find out
18363     * what event that affects. Even worse every time it renders display updates,
18364     * in order to just calculate what to re-draw, it needs to walk through many
18365     * many many objects. Thus, the more objects you keep active, the more
18366     * overhead Evas has in just doing its work. It is advisable to keep your
18367     * active objects to the minimum working set you need. Also remember that
18368     * object creation and deletion carries an overhead, so there is a
18369     * middle-ground, which is not easily determined. But don't keep massive lists
18370     * of objects you can't see or use. Genlist does this with list objects. It
18371     * creates and destroys them dynamically as you scroll around. It groups them
18372     * into blocks so it can determine the visibility etc. of a whole block at
18373     * once as opposed to having to walk the whole list. This 2-level list allows
18374     * for very large numbers of items to be in the list (tests have used up to
18375     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18376     * may be different sizes, every item added needs to be calculated as to its
18377     * size and thus this presents a lot of overhead on populating the list, this
18378     * genlist employs a queue. Any item added is queued and spooled off over
18379     * time, actually appearing some time later, so if your list has many members
18380     * you may find it takes a while for them to all appear, with your process
18381     * consuming a lot of CPU while it is busy spooling.
18382     *
18383     * Genlist also implements a tree structure, but it does so with callbacks to
18384     * the application, with the application filling in tree structures when
18385     * requested (allowing for efficient building of a very deep tree that could
18386     * even be used for file-management). See the above smart signal callbacks for
18387     * details.
18388     *
18389     * @section Genlist_Smart_Events Genlist smart events
18390     *
18391     * Signals that you can add callbacks for are:
18392     * - @c "activated" - The user has double-clicked or pressed
18393     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18394     *   item that was activated.
18395     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18396     *   event_info parameter is the item that was double-clicked.
18397     * - @c "selected" - This is called when a user has made an item selected.
18398     *   The event_info parameter is the genlist item that was selected.
18399     * - @c "unselected" - This is called when a user has made an item
18400     *   unselected. The event_info parameter is the genlist item that was
18401     *   unselected.
18402     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18403     *   called and the item is now meant to be expanded. The event_info
18404     *   parameter is the genlist item that was indicated to expand.  It is the
18405     *   job of this callback to then fill in the child items.
18406     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18407     *   called and the item is now meant to be contracted. The event_info
18408     *   parameter is the genlist item that was indicated to contract. It is the
18409     *   job of this callback to then delete the child items.
18410     * - @c "expand,request" - This is called when a user has indicated they want
18411     *   to expand a tree branch item. The callback should decide if the item can
18412     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18413     *   appropriately to set the state. The event_info parameter is the genlist
18414     *   item that was indicated to expand.
18415     * - @c "contract,request" - This is called when a user has indicated they
18416     *   want to contract a tree branch item. The callback should decide if the
18417     *   item can contract (has any children) and then call
18418     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18419     *   event_info parameter is the genlist item that was indicated to contract.
18420     * - @c "realized" - This is called when the item in the list is created as a
18421     *   real evas object. event_info parameter is the genlist item that was
18422     *   created. The object may be deleted at any time, so it is up to the
18423     *   caller to not use the object pointer from elm_genlist_item_object_get()
18424     *   in a way where it may point to freed objects.
18425     * - @c "unrealized" - This is called just before an item is unrealized.
18426     *   After this call content objects provided will be deleted and the item
18427     *   object itself delete or be put into a floating cache.
18428     * - @c "drag,start,up" - This is called when the item in the list has been
18429     *   dragged (not scrolled) up.
18430     * - @c "drag,start,down" - This is called when the item in the list has been
18431     *   dragged (not scrolled) down.
18432     * - @c "drag,start,left" - This is called when the item in the list has been
18433     *   dragged (not scrolled) left.
18434     * - @c "drag,start,right" - This is called when the item in the list has
18435     *   been dragged (not scrolled) right.
18436     * - @c "drag,stop" - This is called when the item in the list has stopped
18437     *   being dragged.
18438     * - @c "drag" - This is called when the item in the list is being dragged.
18439     * - @c "longpressed" - This is called when the item is pressed for a certain
18440     *   amount of time. By default it's 1 second.
18441     * - @c "scroll,anim,start" - This is called when scrolling animation has
18442     *   started.
18443     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18444     *   stopped.
18445     * - @c "scroll,drag,start" - This is called when dragging the content has
18446     *   started.
18447     * - @c "scroll,drag,stop" - This is called when dragging the content has
18448     *   stopped.
18449     * - @c "edge,top" - This is called when the genlist is scrolled until
18450     *   the top edge.
18451     * - @c "edge,bottom" - This is called when the genlist is scrolled
18452     *   until the bottom edge.
18453     * - @c "edge,left" - This is called when the genlist is scrolled
18454     *   until the left edge.
18455     * - @c "edge,right" - This is called when the genlist is scrolled
18456     *   until the right edge.
18457     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18458     *   swiped left.
18459     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18460     *   swiped right.
18461     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18462     *   swiped up.
18463     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18464     *   swiped down.
18465     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18466     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18467     *   multi-touch pinched in.
18468     * - @c "swipe" - This is called when the genlist is swiped.
18469     * - @c "moved" - This is called when a genlist item is moved.
18470     * - @c "language,changed" - This is called when the program's language is
18471     *   changed.
18472     *
18473     * @section Genlist_Examples Examples
18474     *
18475     * Here is a list of examples that use the genlist, trying to show some of
18476     * its capabilities:
18477     * - @ref genlist_example_01
18478     * - @ref genlist_example_02
18479     * - @ref genlist_example_03
18480     * - @ref genlist_example_04
18481     * - @ref genlist_example_05
18482     */
18483
18484    /**
18485     * @addtogroup Genlist
18486     * @{
18487     */
18488
18489    /**
18490     * @enum _Elm_Genlist_Item_Flags
18491     * @typedef Elm_Genlist_Item_Flags
18492     *
18493     * Defines if the item is of any special type (has subitems or it's the
18494     * index of a group), or is just a simple item.
18495     *
18496     * @ingroup Genlist
18497     */
18498    typedef enum _Elm_Genlist_Item_Flags
18499      {
18500         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18501         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18502         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18503      } Elm_Genlist_Item_Flags;
18504    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18505    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18506    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18507    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18508    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18509    /**
18510     * Label fetching class function for Elm_Gen_Item_Class.
18511     * @param data The data passed in the item creation function
18512     * @param obj The base widget object
18513     * @param part The part name of the swallow
18514     * @return The allocated (NOT stringshared) string to set as the label
18515     */
18516    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18517    /**
18518     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18519     * @param data The data passed in the item creation function
18520     * @param obj The base widget object
18521     * @param part The part name of the swallow
18522     * @return The content object to swallow
18523     */
18524    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
18525    /**
18526     * State fetching class function for Elm_Gen_Item_Class.
18527     * @param data The data passed in the item creation function
18528     * @param obj The base widget object
18529     * @param part The part name of the swallow
18530     * @return The hell if I know
18531     */
18532    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18533    /**
18534     * Deletion class function for Elm_Gen_Item_Class.
18535     * @param data The data passed in the item creation function
18536     * @param obj The base widget object
18537     */
18538    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj);
18539
18540    /**
18541     * @struct _Elm_Genlist_Item_Class
18542     *
18543     * Genlist item class definition structs.
18544     *
18545     * This struct contains the style and fetching functions that will define the
18546     * contents of each item.
18547     *
18548     * @see @ref Genlist_Item_Class
18549     */
18550    struct _Elm_Genlist_Item_Class
18551      {
18552         const char                *item_style; /**< style of this class. */
18553         struct Elm_Genlist_Item_Class_Func
18554           {
18555              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
18556              Elm_Genlist_Item_Content_Get_Cb   content_get; /**< Content fetching class function for genlist item classes. */
18557              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
18558              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
18559           } func;
18560      };
18561    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18562    /**
18563     * Add a new genlist widget to the given parent Elementary
18564     * (container) object
18565     *
18566     * @param parent The parent object
18567     * @return a new genlist widget handle or @c NULL, on errors
18568     *
18569     * This function inserts a new genlist widget on the canvas.
18570     *
18571     * @see elm_genlist_item_append()
18572     * @see elm_genlist_item_del()
18573     * @see elm_gen_clear()
18574     *
18575     * @ingroup Genlist
18576     */
18577    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18578    /**
18579     * Remove all items from a given genlist widget.
18580     *
18581     * @param obj The genlist object
18582     *
18583     * This removes (and deletes) all items in @p obj, leaving it empty.
18584     *
18585     * This is deprecated. Please use elm_gen_clear() instead.
18586     * 
18587     * @see elm_genlist_item_del(), to remove just one item.
18588     *
18589     * @ingroup Genlist
18590     */
18591    EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18592    /**
18593     * Enable or disable multi-selection in the genlist
18594     *
18595     * @param obj The genlist object
18596     * @param multi Multi-select enable/disable. Default is disabled.
18597     *
18598     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18599     * the list. This allows more than 1 item to be selected. To retrieve the list
18600     * of selected items, use elm_genlist_selected_items_get().
18601     *
18602     * @see elm_genlist_selected_items_get()
18603     * @see elm_genlist_multi_select_get()
18604     *
18605     * @ingroup Genlist
18606     */
18607    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18608    /**
18609     * Gets if multi-selection in genlist is enabled or disabled.
18610     *
18611     * @param obj The genlist object
18612     * @return Multi-select enabled/disabled
18613     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18614     *
18615     * @see elm_genlist_multi_select_set()
18616     *
18617     * @ingroup Genlist
18618     */
18619    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18620    /**
18621     * This sets the horizontal stretching mode.
18622     *
18623     * @param obj The genlist object
18624     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18625     *
18626     * This sets the mode used for sizing items horizontally. Valid modes
18627     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18628     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18629     * the scroller will scroll horizontally. Otherwise items are expanded
18630     * to fill the width of the viewport of the scroller. If it is
18631     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18632     * limited to that size.
18633     *
18634     * @see elm_genlist_horizontal_get()
18635     *
18636     * @ingroup Genlist
18637     */
18638    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18639    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18640    /**
18641     * Gets the horizontal stretching mode.
18642     *
18643     * @param obj The genlist object
18644     * @return The mode to use
18645     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18646     *
18647     * @see elm_genlist_horizontal_set()
18648     *
18649     * @ingroup Genlist
18650     */
18651    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18652    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18653    /**
18654     * Set the always select mode.
18655     *
18656     * @param obj The genlist object
18657     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18658     * EINA_FALSE = off). Default is @c EINA_FALSE.
18659     *
18660     * Items will only call their selection func and callback when first
18661     * becoming selected. Any further clicks will do nothing, unless you
18662     * enable always select with elm_gen_always_select_mode_set().
18663     * This means that, even if selected, every click will make the selected
18664     * callbacks be called.
18665     * 
18666     * This function is deprecated. please see elm_gen_always_select_mode_set()
18667     *
18668     * @see elm_genlist_always_select_mode_get()
18669     *
18670     * @ingroup Genlist
18671     */
18672    EINA_DEPRECATED EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18673    /**
18674     * Get the always select mode.
18675     *
18676     * @param obj The genlist object
18677     * @return The always select mode
18678     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18679     *
18680     * @see elm_genlist_always_select_mode_set()
18681     *
18682     * @ingroup Genlist
18683     */
18684    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18685    /**
18686     * Enable/disable the no select mode.
18687     *
18688     * @param obj The genlist object
18689     * @param no_select The no select mode
18690     * (EINA_TRUE = on, EINA_FALSE = off)
18691     *
18692     * This will turn off the ability to select items entirely and they
18693     * will neither appear selected nor call selected callback functions.
18694     *
18695     * @see elm_genlist_no_select_mode_get()
18696     *
18697     * @ingroup Genlist
18698     */
18699    EINA_DEPRECATED EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18700    /**
18701     * Gets whether the no select mode is enabled.
18702     *
18703     * @param obj The genlist object
18704     * @return The no select mode
18705     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18706     *
18707     * @see elm_genlist_no_select_mode_set()
18708     *
18709     * @ingroup Genlist
18710     */
18711    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18712    /**
18713     * Enable/disable compress mode.
18714     *
18715     * @param obj The genlist object
18716     * @param compress The compress mode
18717     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18718     *
18719     * This will enable the compress mode where items are "compressed"
18720     * horizontally to fit the genlist scrollable viewport width. This is
18721     * special for genlist.  Do not rely on
18722     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18723     * work as genlist needs to handle it specially.
18724     *
18725     * @see elm_genlist_compress_mode_get()
18726     *
18727     * @ingroup Genlist
18728     */
18729    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18730    /**
18731     * Get whether the compress mode is enabled.
18732     *
18733     * @param obj The genlist object
18734     * @return The compress mode
18735     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18736     *
18737     * @see elm_genlist_compress_mode_set()
18738     *
18739     * @ingroup Genlist
18740     */
18741    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18742    /**
18743     * Enable/disable height-for-width mode.
18744     *
18745     * @param obj The genlist object
18746     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18747     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18748     *
18749     * With height-for-width mode the item width will be fixed (restricted
18750     * to a minimum of) to the list width when calculating its size in
18751     * order to allow the height to be calculated based on it. This allows,
18752     * for instance, text block to wrap lines if the Edje part is
18753     * configured with "text.min: 0 1".
18754     *
18755     * @note This mode will make list resize slower as it will have to
18756     *       recalculate every item height again whenever the list width
18757     *       changes!
18758     *
18759     * @note When height-for-width mode is enabled, it also enables
18760     *       compress mode (see elm_genlist_compress_mode_set()) and
18761     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18762     *
18763     * @ingroup Genlist
18764     */
18765    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18766    /**
18767     * Get whether the height-for-width mode is enabled.
18768     *
18769     * @param obj The genlist object
18770     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18771     * off)
18772     *
18773     * @ingroup Genlist
18774     */
18775    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18776    /**
18777     * Enable/disable horizontal and vertical bouncing effect.
18778     *
18779     * @param obj The genlist object
18780     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18781     * EINA_FALSE = off). Default is @c EINA_FALSE.
18782     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18783     * EINA_FALSE = off). Default is @c EINA_TRUE.
18784     *
18785     * This will enable or disable the scroller bouncing effect for the
18786     * genlist. See elm_scroller_bounce_set() for details.
18787     *
18788     * @see elm_scroller_bounce_set()
18789     * @see elm_genlist_bounce_get()
18790     *
18791     * @ingroup Genlist
18792     */
18793    EINA_DEPRECATED EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18794    /**
18795     * Get whether the horizontal and vertical bouncing effect is enabled.
18796     *
18797     * @param obj The genlist object
18798     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18799     * option is set.
18800     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18801     * option is set.
18802     *
18803     * @see elm_genlist_bounce_set()
18804     *
18805     * @ingroup Genlist
18806     */
18807    EINA_DEPRECATED EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18808    /**
18809     * Enable/disable homogenous mode.
18810     *
18811     * @param obj The genlist object
18812     * @param homogeneous Assume the items within the genlist are of the
18813     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18814     * EINA_FALSE.
18815     *
18816     * This will enable the homogeneous mode where items are of the same
18817     * height and width so that genlist may do the lazy-loading at its
18818     * maximum (which increases the performance for scrolling the list). This
18819     * implies 'compressed' mode.
18820     *
18821     * @see elm_genlist_compress_mode_set()
18822     * @see elm_genlist_homogeneous_get()
18823     *
18824     * @ingroup Genlist
18825     */
18826    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18827    /**
18828     * Get whether the homogenous mode is enabled.
18829     *
18830     * @param obj The genlist object
18831     * @return Assume the items within the genlist are of the same height
18832     * and width (EINA_TRUE = on, EINA_FALSE = off)
18833     *
18834     * @see elm_genlist_homogeneous_set()
18835     *
18836     * @ingroup Genlist
18837     */
18838    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18839    /**
18840     * Set the maximum number of items within an item block
18841     *
18842     * @param obj The genlist object
18843     * @param n   Maximum number of items within an item block. Default is 32.
18844     *
18845     * This will configure the block count to tune to the target with
18846     * particular performance matrix.
18847     *
18848     * A block of objects will be used to reduce the number of operations due to
18849     * many objects in the screen. It can determine the visibility, or if the
18850     * object has changed, it theme needs to be updated, etc. doing this kind of
18851     * calculation to the entire block, instead of per object.
18852     *
18853     * The default value for the block count is enough for most lists, so unless
18854     * you know you will have a lot of objects visible in the screen at the same
18855     * time, don't try to change this.
18856     *
18857     * @see elm_genlist_block_count_get()
18858     * @see @ref Genlist_Implementation
18859     *
18860     * @ingroup Genlist
18861     */
18862    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18863    /**
18864     * Get the maximum number of items within an item block
18865     *
18866     * @param obj The genlist object
18867     * @return Maximum number of items within an item block
18868     *
18869     * @see elm_genlist_block_count_set()
18870     *
18871     * @ingroup Genlist
18872     */
18873    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18874    /**
18875     * Set the timeout in seconds for the longpress event.
18876     *
18877     * @param obj The genlist object
18878     * @param timeout timeout in seconds. Default is 1.
18879     *
18880     * This option will change how long it takes to send an event "longpressed"
18881     * after the mouse down signal is sent to the list. If this event occurs, no
18882     * "clicked" event will be sent.
18883     *
18884     * @see elm_genlist_longpress_timeout_set()
18885     *
18886     * @ingroup Genlist
18887     */
18888    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18889    /**
18890     * Get the timeout in seconds for the longpress event.
18891     *
18892     * @param obj The genlist object
18893     * @return timeout in seconds
18894     *
18895     * @see elm_genlist_longpress_timeout_get()
18896     *
18897     * @ingroup Genlist
18898     */
18899    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18900    /**
18901     * Append a new item in a given genlist widget.
18902     *
18903     * @param obj The genlist object
18904     * @param itc The item class for the item
18905     * @param data The item data
18906     * @param parent The parent item, or NULL if none
18907     * @param flags Item flags
18908     * @param func Convenience function called when the item is selected
18909     * @param func_data Data passed to @p func above.
18910     * @return A handle to the item added or @c NULL if not possible
18911     *
18912     * This adds the given item to the end of the list or the end of
18913     * the children list if the @p parent is given.
18914     *
18915     * @see elm_genlist_item_prepend()
18916     * @see elm_genlist_item_insert_before()
18917     * @see elm_genlist_item_insert_after()
18918     * @see elm_genlist_item_del()
18919     *
18920     * @ingroup Genlist
18921     */
18922    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);
18923    /**
18924     * Prepend a new item in a given genlist widget.
18925     *
18926     * @param obj The genlist object
18927     * @param itc The item class for the item
18928     * @param data The item data
18929     * @param parent The parent item, or NULL if none
18930     * @param flags Item flags
18931     * @param func Convenience function called when the item is selected
18932     * @param func_data Data passed to @p func above.
18933     * @return A handle to the item added or NULL if not possible
18934     *
18935     * This adds an item to the beginning of the list or beginning of the
18936     * children of the parent if given.
18937     *
18938     * @see elm_genlist_item_append()
18939     * @see elm_genlist_item_insert_before()
18940     * @see elm_genlist_item_insert_after()
18941     * @see elm_genlist_item_del()
18942     *
18943     * @ingroup Genlist
18944     */
18945    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);
18946    /**
18947     * Insert an item before another in a genlist widget
18948     *
18949     * @param obj The genlist object
18950     * @param itc The item class for the item
18951     * @param data The item data
18952     * @param before The item to place this new one before.
18953     * @param flags Item flags
18954     * @param func Convenience function called when the item is selected
18955     * @param func_data Data passed to @p func above.
18956     * @return A handle to the item added or @c NULL if not possible
18957     *
18958     * This inserts an item before another in the list. It will be in the
18959     * same tree level or group as the item it is inserted before.
18960     *
18961     * @see elm_genlist_item_append()
18962     * @see elm_genlist_item_prepend()
18963     * @see elm_genlist_item_insert_after()
18964     * @see elm_genlist_item_del()
18965     *
18966     * @ingroup Genlist
18967     */
18968    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);
18969    /**
18970     * Insert an item after another in a genlist widget
18971     *
18972     * @param obj The genlist object
18973     * @param itc The item class for the item
18974     * @param data The item data
18975     * @param after The item to place this new one after.
18976     * @param flags Item flags
18977     * @param func Convenience function called when the item is selected
18978     * @param func_data Data passed to @p func above.
18979     * @return A handle to the item added or @c NULL if not possible
18980     *
18981     * This inserts an item after another in the list. It will be in the
18982     * same tree level or group as the item it is inserted after.
18983     *
18984     * @see elm_genlist_item_append()
18985     * @see elm_genlist_item_prepend()
18986     * @see elm_genlist_item_insert_before()
18987     * @see elm_genlist_item_del()
18988     *
18989     * @ingroup Genlist
18990     */
18991    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);
18992    /**
18993     * Insert a new item into the sorted genlist object
18994     *
18995     * @param obj The genlist object
18996     * @param itc The item class for the item
18997     * @param data The item data
18998     * @param parent The parent item, or NULL if none
18999     * @param flags Item flags
19000     * @param comp The function called for the sort
19001     * @param func Convenience function called when item selected
19002     * @param func_data Data passed to @p func above.
19003     * @return A handle to the item added or NULL if not possible
19004     *
19005     * @ingroup Genlist
19006     */
19007    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);
19008    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);
19009    /* operations to retrieve existing items */
19010    /**
19011     * Get the selectd item in the genlist.
19012     *
19013     * @param obj The genlist object
19014     * @return The selected item, or NULL if none is selected.
19015     *
19016     * This gets the selected item in the list (if multi-selection is enabled, only
19017     * the item that was first selected in the list is returned - which is not very
19018     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19019     * used).
19020     *
19021     * If no item is selected, NULL is returned.
19022     *
19023     * @see elm_genlist_selected_items_get()
19024     *
19025     * @ingroup Genlist
19026     */
19027    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19028    /**
19029     * Get a list of selected items in the genlist.
19030     *
19031     * @param obj The genlist object
19032     * @return The list of selected items, or NULL if none are selected.
19033     *
19034     * It returns a list of the selected items. This list pointer is only valid so
19035     * long as the selection doesn't change (no items are selected or unselected, or
19036     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19037     * pointers. The order of the items in this list is the order which they were
19038     * selected, i.e. the first item in this list is the first item that was
19039     * selected, and so on.
19040     *
19041     * @note If not in multi-select mode, consider using function
19042     * elm_genlist_selected_item_get() instead.
19043     *
19044     * @see elm_genlist_multi_select_set()
19045     * @see elm_genlist_selected_item_get()
19046     *
19047     * @ingroup Genlist
19048     */
19049    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19050    /**
19051     * Get the mode item style of items in the genlist
19052     * @param obj The genlist object
19053     * @return The mode item style string, or NULL if none is specified
19054     * 
19055     * This is a constant string and simply defines the name of the
19056     * style that will be used for mode animations. It can be
19057     * @c NULL if you don't plan to use Genlist mode. See
19058     * elm_genlist_item_mode_set() for more info.
19059     * 
19060     * @ingroup Genlist
19061     */
19062    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19063    /**
19064     * Set the mode item style of items in the genlist
19065     * @param obj The genlist object
19066     * @param style The mode item style string, or NULL if none is desired
19067     * 
19068     * This is a constant string and simply defines the name of the
19069     * style that will be used for mode animations. It can be
19070     * @c NULL if you don't plan to use Genlist mode. See
19071     * elm_genlist_item_mode_set() for more info.
19072     * 
19073     * @ingroup Genlist
19074     */
19075    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19076    /**
19077     * Get a list of realized items in genlist
19078     *
19079     * @param obj The genlist object
19080     * @return The list of realized items, nor NULL if none are realized.
19081     *
19082     * This returns a list of the realized items in the genlist. The list
19083     * contains Elm_Genlist_Item pointers. The list must be freed by the
19084     * caller when done with eina_list_free(). The item pointers in the
19085     * list are only valid so long as those items are not deleted or the
19086     * genlist is not deleted.
19087     *
19088     * @see elm_genlist_realized_items_update()
19089     *
19090     * @ingroup Genlist
19091     */
19092    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19093    /**
19094     * Get the item that is at the x, y canvas coords.
19095     *
19096     * @param obj The gelinst object.
19097     * @param x The input x coordinate
19098     * @param y The input y coordinate
19099     * @param posret The position relative to the item returned here
19100     * @return The item at the coordinates or NULL if none
19101     *
19102     * This returns the item at the given coordinates (which are canvas
19103     * relative, not object-relative). If an item is at that coordinate,
19104     * that item handle is returned, and if @p posret is not NULL, the
19105     * integer pointed to is set to a value of -1, 0 or 1, depending if
19106     * the coordinate is on the upper portion of that item (-1), on the
19107     * middle section (0) or on the lower part (1). If NULL is returned as
19108     * an item (no item found there), then posret may indicate -1 or 1
19109     * based if the coordinate is above or below all items respectively in
19110     * the genlist.
19111     *
19112     * @ingroup Genlist
19113     */
19114    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);
19115    /**
19116     * Get the first item in the genlist
19117     *
19118     * This returns the first item in the list.
19119     *
19120     * @param obj The genlist object
19121     * @return The first item, or NULL if none
19122     *
19123     * @ingroup Genlist
19124     */
19125    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19126    /**
19127     * Get the last item in the genlist
19128     *
19129     * This returns the last item in the list.
19130     *
19131     * @return The last item, or NULL if none
19132     *
19133     * @ingroup Genlist
19134     */
19135    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19136    /**
19137     * Set the scrollbar policy
19138     *
19139     * @param obj The genlist object
19140     * @param policy_h Horizontal scrollbar policy.
19141     * @param policy_v Vertical scrollbar policy.
19142     *
19143     * This sets the scrollbar visibility policy for the given genlist
19144     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19145     * made visible if it is needed, and otherwise kept hidden.
19146     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19147     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19148     * respectively for the horizontal and vertical scrollbars. Default is
19149     * #ELM_SMART_SCROLLER_POLICY_AUTO
19150     *
19151     * @see elm_genlist_scroller_policy_get()
19152     *
19153     * @ingroup Genlist
19154     */
19155    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19156    /**
19157     * Get the scrollbar policy
19158     *
19159     * @param obj The genlist object
19160     * @param policy_h Pointer to store the horizontal scrollbar policy.
19161     * @param policy_v Pointer to store the vertical scrollbar policy.
19162     *
19163     * @see elm_genlist_scroller_policy_set()
19164     *
19165     * @ingroup Genlist
19166     */
19167    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);
19168    /**
19169     * Get the @b next item in a genlist widget's internal list of items,
19170     * given a handle to one of those items.
19171     *
19172     * @param item The genlist item to fetch next from
19173     * @return The item after @p item, or @c NULL if there's none (and
19174     * on errors)
19175     *
19176     * This returns the item placed after the @p item, on the container
19177     * genlist.
19178     *
19179     * @see elm_genlist_item_prev_get()
19180     *
19181     * @ingroup Genlist
19182     */
19183    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19184    /**
19185     * Get the @b previous item in a genlist widget's internal list of items,
19186     * given a handle to one of those items.
19187     *
19188     * @param item The genlist item to fetch previous from
19189     * @return The item before @p item, or @c NULL if there's none (and
19190     * on errors)
19191     *
19192     * This returns the item placed before the @p item, on the container
19193     * genlist.
19194     *
19195     * @see elm_genlist_item_next_get()
19196     *
19197     * @ingroup Genlist
19198     */
19199    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19200    /**
19201     * Get the genlist object's handle which contains a given genlist
19202     * item
19203     *
19204     * @param item The item to fetch the container from
19205     * @return The genlist (parent) object
19206     *
19207     * This returns the genlist object itself that an item belongs to.
19208     *
19209     * This function is deprecated. Please use elm_gen_item_widget_get()
19210     * 
19211     * @ingroup Genlist
19212     */
19213    EINA_DEPRECATED EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19214    /**
19215     * Get the parent item of the given item
19216     *
19217     * @param it The item
19218     * @return The parent of the item or @c NULL if it has no parent.
19219     *
19220     * This returns the item that was specified as parent of the item @p it on
19221     * elm_genlist_item_append() and insertion related functions.
19222     *
19223     * @ingroup Genlist
19224     */
19225    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19226    /**
19227     * Remove all sub-items (children) of the given item
19228     *
19229     * @param it The item
19230     *
19231     * This removes all items that are children (and their descendants) of the
19232     * given item @p it.
19233     *
19234     * @see elm_genlist_clear()
19235     * @see elm_genlist_item_del()
19236     *
19237     * @ingroup Genlist
19238     */
19239    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19240    /**
19241     * Set whether a given genlist item is selected or not
19242     *
19243     * @param it The item
19244     * @param selected Use @c EINA_TRUE, to make it selected, @c
19245     * EINA_FALSE to make it unselected
19246     *
19247     * This sets the selected state of an item. If multi selection is
19248     * not enabled on the containing genlist and @p selected is @c
19249     * EINA_TRUE, any other previously selected items will get
19250     * unselected in favor of this new one.
19251     *
19252     * @see elm_genlist_item_selected_get()
19253     *
19254     * @ingroup Genlist
19255     */
19256    EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19257    /**
19258     * Get whether a given genlist item is selected or not
19259     *
19260     * @param it The item
19261     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19262     *
19263     * @see elm_genlist_item_selected_set() for more details
19264     *
19265     * @ingroup Genlist
19266     */
19267    EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19268    /**
19269     * Sets the expanded state of an item.
19270     *
19271     * @param it The item
19272     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19273     *
19274     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19275     * expanded or not.
19276     *
19277     * The theme will respond to this change visually, and a signal "expanded" or
19278     * "contracted" will be sent from the genlist with a pointer to the item that
19279     * has been expanded/contracted.
19280     *
19281     * Calling this function won't show or hide any child of this item (if it is
19282     * a parent). You must manually delete and create them on the callbacks fo
19283     * the "expanded" or "contracted" signals.
19284     *
19285     * @see elm_genlist_item_expanded_get()
19286     *
19287     * @ingroup Genlist
19288     */
19289    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19290    /**
19291     * Get the expanded state of an item
19292     *
19293     * @param it The item
19294     * @return The expanded state
19295     *
19296     * This gets the expanded state of an item.
19297     *
19298     * @see elm_genlist_item_expanded_set()
19299     *
19300     * @ingroup Genlist
19301     */
19302    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19303    /**
19304     * Get the depth of expanded item
19305     *
19306     * @param it The genlist item object
19307     * @return The depth of expanded item
19308     *
19309     * @ingroup Genlist
19310     */
19311    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19312    /**
19313     * Set whether a given genlist item is disabled or not.
19314     *
19315     * @param it The item
19316     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19317     * to enable it back.
19318     *
19319     * A disabled item cannot be selected or unselected. It will also
19320     * change its appearance, to signal the user it's disabled.
19321     *
19322     * @see elm_genlist_item_disabled_get()
19323     *
19324     * @ingroup Genlist
19325     */
19326    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19327    /**
19328     * Get whether a given genlist item is disabled or not.
19329     *
19330     * @param it The item
19331     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19332     * (and on errors).
19333     *
19334     * @see elm_genlist_item_disabled_set() for more details
19335     *
19336     * @ingroup Genlist
19337     */
19338    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19339    /**
19340     * Sets the display only state of an item.
19341     *
19342     * @param it The item
19343     * @param display_only @c EINA_TRUE if the item is display only, @c
19344     * EINA_FALSE otherwise.
19345     *
19346     * A display only item cannot be selected or unselected. It is for
19347     * display only and not selecting or otherwise clicking, dragging
19348     * etc. by the user, thus finger size rules will not be applied to
19349     * this item.
19350     *
19351     * It's good to set group index items to display only state.
19352     *
19353     * @see elm_genlist_item_display_only_get()
19354     *
19355     * @ingroup Genlist
19356     */
19357    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19358    /**
19359     * Get the display only state of an item
19360     *
19361     * @param it The item
19362     * @return @c EINA_TRUE if the item is display only, @c
19363     * EINA_FALSE otherwise.
19364     *
19365     * @see elm_genlist_item_display_only_set()
19366     *
19367     * @ingroup Genlist
19368     */
19369    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19370    /**
19371     * Show the portion of a genlist's internal list containing a given
19372     * item, immediately.
19373     *
19374     * @param it The item to display
19375     *
19376     * This causes genlist to jump to the given item @p it and show it (by
19377     * immediately scrolling to that position), if it is not fully visible.
19378     *
19379     * @see elm_genlist_item_bring_in()
19380     * @see elm_genlist_item_top_show()
19381     * @see elm_genlist_item_middle_show()
19382     *
19383     * @ingroup Genlist
19384     */
19385    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19386    /**
19387     * Animatedly bring in, to the visible are of a genlist, a given
19388     * item on it.
19389     *
19390     * @param it The item to display
19391     *
19392     * This causes genlist to jump to the given item @p it and show it (by
19393     * animatedly scrolling), if it is not fully visible. This may use animation
19394     * to do so and take a period of time
19395     *
19396     * @see elm_genlist_item_show()
19397     * @see elm_genlist_item_top_bring_in()
19398     * @see elm_genlist_item_middle_bring_in()
19399     *
19400     * @ingroup Genlist
19401     */
19402    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19403    /**
19404     * Show the portion of a genlist's internal list containing a given
19405     * item, immediately.
19406     *
19407     * @param it The item to display
19408     *
19409     * This causes genlist to jump to the given item @p it and show it (by
19410     * immediately scrolling to that position), if it is not fully visible.
19411     *
19412     * The item will be positioned at the top of the genlist viewport.
19413     *
19414     * @see elm_genlist_item_show()
19415     * @see elm_genlist_item_top_bring_in()
19416     *
19417     * @ingroup Genlist
19418     */
19419    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19420    /**
19421     * Animatedly bring in, to the visible are of a genlist, a given
19422     * item on it.
19423     *
19424     * @param it The item
19425     *
19426     * This causes genlist to jump to the given item @p it and show it (by
19427     * animatedly scrolling), if it is not fully visible. This may use animation
19428     * to do so and take a period of time
19429     *
19430     * The item will be positioned at the top of the genlist viewport.
19431     *
19432     * @see elm_genlist_item_bring_in()
19433     * @see elm_genlist_item_top_show()
19434     *
19435     * @ingroup Genlist
19436     */
19437    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19438    /**
19439     * Show the portion of a genlist's internal list containing a given
19440     * item, immediately.
19441     *
19442     * @param it The item to display
19443     *
19444     * This causes genlist to jump to the given item @p it and show it (by
19445     * immediately scrolling to that position), if it is not fully visible.
19446     *
19447     * The item will be positioned at the middle of the genlist viewport.
19448     *
19449     * @see elm_genlist_item_show()
19450     * @see elm_genlist_item_middle_bring_in()
19451     *
19452     * @ingroup Genlist
19453     */
19454    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19455    /**
19456     * Animatedly bring in, to the visible are of a genlist, a given
19457     * item on it.
19458     *
19459     * @param it The item
19460     *
19461     * This causes genlist to jump to the given item @p it and show it (by
19462     * animatedly scrolling), if it is not fully visible. This may use animation
19463     * to do so and take a period of time
19464     *
19465     * The item will be positioned at the middle of the genlist viewport.
19466     *
19467     * @see elm_genlist_item_bring_in()
19468     * @see elm_genlist_item_middle_show()
19469     *
19470     * @ingroup Genlist
19471     */
19472    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19473    /**
19474     * Remove a genlist item from the its parent, deleting it.
19475     *
19476     * @param item The item to be removed.
19477     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19478     *
19479     * @see elm_genlist_clear(), to remove all items in a genlist at
19480     * once.
19481     *
19482     * @ingroup Genlist
19483     */
19484    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19485    /**
19486     * Return the data associated to a given genlist item
19487     *
19488     * @param item The genlist item.
19489     * @return the data associated to this item.
19490     *
19491     * This returns the @c data value passed on the
19492     * elm_genlist_item_append() and related item addition calls.
19493     *
19494     * @see elm_genlist_item_append()
19495     * @see elm_genlist_item_data_set()
19496     *
19497     * @ingroup Genlist
19498     */
19499    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19500    /**
19501     * Set the data associated to a given genlist item
19502     *
19503     * @param item The genlist item
19504     * @param data The new data pointer to set on it
19505     *
19506     * This @b overrides the @c data value passed on the
19507     * elm_genlist_item_append() and related item addition calls. This
19508     * function @b won't call elm_genlist_item_update() automatically,
19509     * so you'd issue it afterwards if you want to hove the item
19510     * updated to reflect the that new data.
19511     *
19512     * @see elm_genlist_item_data_get()
19513     *
19514     * @ingroup Genlist
19515     */
19516    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19517    /**
19518     * Tells genlist to "orphan" icons fetchs by the item class
19519     *
19520     * @param it The item
19521     *
19522     * This instructs genlist to release references to icons in the item,
19523     * meaning that they will no longer be managed by genlist and are
19524     * floating "orphans" that can be re-used elsewhere if the user wants
19525     * to.
19526     *
19527     * @ingroup Genlist
19528     */
19529    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19530    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19531    /**
19532     * Get the real Evas object created to implement the view of a
19533     * given genlist item
19534     *
19535     * @param item The genlist item.
19536     * @return the Evas object implementing this item's view.
19537     *
19538     * This returns the actual Evas object used to implement the
19539     * specified genlist item's view. This may be @c NULL, as it may
19540     * not have been created or may have been deleted, at any time, by
19541     * the genlist. <b>Do not modify this object</b> (move, resize,
19542     * show, hide, etc.), as the genlist is controlling it. This
19543     * function is for querying, emitting custom signals or hooking
19544     * lower level callbacks for events on that object. Do not delete
19545     * this object under any circumstances.
19546     *
19547     * @see elm_genlist_item_data_get()
19548     *
19549     * @ingroup Genlist
19550     */
19551    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19552    /**
19553     * Update the contents of an item
19554     *
19555     * @param it The item
19556     *
19557     * This updates an item by calling all the item class functions again
19558     * to get the icons, labels and states. Use this when the original
19559     * item data has changed and the changes are desired to be reflected.
19560     *
19561     * Use elm_genlist_realized_items_update() to update all already realized
19562     * items.
19563     *
19564     * @see elm_genlist_realized_items_update()
19565     *
19566     * @ingroup Genlist
19567     */
19568    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19569    /**
19570     * Update the item class of an item
19571     *
19572     * @param it The item
19573     * @param itc The item class for the item
19574     *
19575     * This sets another class fo the item, changing the way that it is
19576     * displayed. After changing the item class, elm_genlist_item_update() is
19577     * called on the item @p it.
19578     *
19579     * @ingroup Genlist
19580     */
19581    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19582    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19583    /**
19584     * Set the text to be shown in a given genlist item's tooltips.
19585     *
19586     * @param item The genlist item
19587     * @param text The text to set in the content
19588     *
19589     * This call will setup the text to be used as tooltip to that item
19590     * (analogous to elm_object_tooltip_text_set(), but being item
19591     * tooltips with higher precedence than object tooltips). It can
19592     * have only one tooltip at a time, so any previous tooltip data
19593     * will get removed.
19594     *
19595     * In order to set an icon or something else as a tooltip, look at
19596     * elm_genlist_item_tooltip_content_cb_set().
19597     *
19598     * @ingroup Genlist
19599     */
19600    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19601    /**
19602     * Set the content to be shown in a given genlist item's tooltips
19603     *
19604     * @param item The genlist item.
19605     * @param func The function returning the tooltip contents.
19606     * @param data What to provide to @a func as callback data/context.
19607     * @param del_cb Called when data is not needed anymore, either when
19608     *        another callback replaces @p func, the tooltip is unset with
19609     *        elm_genlist_item_tooltip_unset() or the owner @p item
19610     *        dies. This callback receives as its first parameter the
19611     *        given @p data, being @c event_info the item handle.
19612     *
19613     * This call will setup the tooltip's contents to @p item
19614     * (analogous to elm_object_tooltip_content_cb_set(), but being
19615     * item tooltips with higher precedence than object tooltips). It
19616     * can have only one tooltip at a time, so any previous tooltip
19617     * content will get removed. @p func (with @p data) will be called
19618     * every time Elementary needs to show the tooltip and it should
19619     * return a valid Evas object, which will be fully managed by the
19620     * tooltip system, getting deleted when the tooltip is gone.
19621     *
19622     * In order to set just a text as a tooltip, look at
19623     * elm_genlist_item_tooltip_text_set().
19624     *
19625     * @ingroup Genlist
19626     */
19627    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);
19628    /**
19629     * Unset a tooltip from a given genlist item
19630     *
19631     * @param item genlist item to remove a previously set tooltip from.
19632     *
19633     * This call removes any tooltip set on @p item. The callback
19634     * provided as @c del_cb to
19635     * elm_genlist_item_tooltip_content_cb_set() will be called to
19636     * notify it is not used anymore (and have resources cleaned, if
19637     * need be).
19638     *
19639     * @see elm_genlist_item_tooltip_content_cb_set()
19640     *
19641     * @ingroup Genlist
19642     */
19643    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19644    /**
19645     * Set a different @b style for a given genlist item's tooltip.
19646     *
19647     * @param item genlist item with tooltip set
19648     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19649     * "default", @c "transparent", etc)
19650     *
19651     * Tooltips can have <b>alternate styles</b> to be displayed on,
19652     * which are defined by the theme set on Elementary. This function
19653     * works analogously as elm_object_tooltip_style_set(), but here
19654     * applied only to genlist item objects. The default style for
19655     * tooltips is @c "default".
19656     *
19657     * @note before you set a style you should define a tooltip with
19658     *       elm_genlist_item_tooltip_content_cb_set() or
19659     *       elm_genlist_item_tooltip_text_set()
19660     *
19661     * @see elm_genlist_item_tooltip_style_get()
19662     *
19663     * @ingroup Genlist
19664     */
19665    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19666    /**
19667     * Get the style set a given genlist item's tooltip.
19668     *
19669     * @param item genlist item with tooltip already set on.
19670     * @return style the theme style in use, which defaults to
19671     *         "default". If the object does not have a tooltip set,
19672     *         then @c NULL is returned.
19673     *
19674     * @see elm_genlist_item_tooltip_style_set() for more details
19675     *
19676     * @ingroup Genlist
19677     */
19678    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19679    /**
19680     * @brief Disable size restrictions on an object's tooltip
19681     * @param item The tooltip's anchor object
19682     * @param disable If EINA_TRUE, size restrictions are disabled
19683     * @return EINA_FALSE on failure, EINA_TRUE on success
19684     *
19685     * This function allows a tooltip to expand beyond its parant window's canvas.
19686     * It will instead be limited only by the size of the display.
19687     */
19688    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19689    /**
19690     * @brief Retrieve size restriction state of an object's tooltip
19691     * @param item The tooltip's anchor object
19692     * @return If EINA_TRUE, size restrictions are disabled
19693     *
19694     * This function returns whether a tooltip is allowed to expand beyond
19695     * its parant window's canvas.
19696     * It will instead be limited only by the size of the display.
19697     */
19698    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19699    /**
19700     * Set the type of mouse pointer/cursor decoration to be shown,
19701     * when the mouse pointer is over the given genlist widget item
19702     *
19703     * @param item genlist item to customize cursor on
19704     * @param cursor the cursor type's name
19705     *
19706     * This function works analogously as elm_object_cursor_set(), but
19707     * here the cursor's changing area is restricted to the item's
19708     * area, and not the whole widget's. Note that that item cursors
19709     * have precedence over widget cursors, so that a mouse over @p
19710     * item will always show cursor @p type.
19711     *
19712     * If this function is called twice for an object, a previously set
19713     * cursor will be unset on the second call.
19714     *
19715     * @see elm_object_cursor_set()
19716     * @see elm_genlist_item_cursor_get()
19717     * @see elm_genlist_item_cursor_unset()
19718     *
19719     * @ingroup Genlist
19720     */
19721    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19722    /**
19723     * Get the type of mouse pointer/cursor decoration set to be shown,
19724     * when the mouse pointer is over the given genlist widget item
19725     *
19726     * @param item genlist item with custom cursor set
19727     * @return the cursor type's name or @c NULL, if no custom cursors
19728     * were set to @p item (and on errors)
19729     *
19730     * @see elm_object_cursor_get()
19731     * @see elm_genlist_item_cursor_set() for more details
19732     * @see elm_genlist_item_cursor_unset()
19733     *
19734     * @ingroup Genlist
19735     */
19736    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19737    /**
19738     * Unset any custom mouse pointer/cursor decoration set to be
19739     * shown, when the mouse pointer is over the given genlist widget
19740     * item, thus making it show the @b default cursor again.
19741     *
19742     * @param item a genlist item
19743     *
19744     * Use this call to undo any custom settings on this item's cursor
19745     * decoration, bringing it back to defaults (no custom style set).
19746     *
19747     * @see elm_object_cursor_unset()
19748     * @see elm_genlist_item_cursor_set() for more details
19749     *
19750     * @ingroup Genlist
19751     */
19752    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19753    /**
19754     * Set a different @b style for a given custom cursor set for a
19755     * genlist item.
19756     *
19757     * @param item genlist item with custom cursor set
19758     * @param style the <b>theme style</b> to use (e.g. @c "default",
19759     * @c "transparent", etc)
19760     *
19761     * This function only makes sense when one is using custom mouse
19762     * cursor decorations <b>defined in a theme file</b> , which can
19763     * have, given a cursor name/type, <b>alternate styles</b> on
19764     * it. It works analogously as elm_object_cursor_style_set(), but
19765     * here applied only to genlist item objects.
19766     *
19767     * @warning Before you set a cursor style you should have defined a
19768     *       custom cursor previously on the item, with
19769     *       elm_genlist_item_cursor_set()
19770     *
19771     * @see elm_genlist_item_cursor_engine_only_set()
19772     * @see elm_genlist_item_cursor_style_get()
19773     *
19774     * @ingroup Genlist
19775     */
19776    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19777    /**
19778     * Get the current @b style set for a given genlist item's custom
19779     * cursor
19780     *
19781     * @param item genlist item with custom cursor set.
19782     * @return style the cursor style in use. If the object does not
19783     *         have a cursor set, then @c NULL is returned.
19784     *
19785     * @see elm_genlist_item_cursor_style_set() for more details
19786     *
19787     * @ingroup Genlist
19788     */
19789    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19790    /**
19791     * Set if the (custom) cursor for a given genlist item should be
19792     * searched in its theme, also, or should only rely on the
19793     * rendering engine.
19794     *
19795     * @param item item with custom (custom) cursor already set on
19796     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19797     * only on those provided by the rendering engine, @c EINA_FALSE to
19798     * have them searched on the widget's theme, as well.
19799     *
19800     * @note This call is of use only if you've set a custom cursor
19801     * for genlist items, with elm_genlist_item_cursor_set().
19802     *
19803     * @note By default, cursors will only be looked for between those
19804     * provided by the rendering engine.
19805     *
19806     * @ingroup Genlist
19807     */
19808    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19809    /**
19810     * Get if the (custom) cursor for a given genlist item is being
19811     * searched in its theme, also, or is only relying on the rendering
19812     * engine.
19813     *
19814     * @param item a genlist item
19815     * @return @c EINA_TRUE, if cursors are being looked for only on
19816     * those provided by the rendering engine, @c EINA_FALSE if they
19817     * are being searched on the widget's theme, as well.
19818     *
19819     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19820     *
19821     * @ingroup Genlist
19822     */
19823    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19824    /**
19825     * Update the contents of all realized items.
19826     *
19827     * @param obj The genlist object.
19828     *
19829     * This updates all realized items by calling all the item class functions again
19830     * to get the icons, labels and states. Use this when the original
19831     * item data has changed and the changes are desired to be reflected.
19832     *
19833     * To update just one item, use elm_genlist_item_update().
19834     *
19835     * @see elm_genlist_realized_items_get()
19836     * @see elm_genlist_item_update()
19837     *
19838     * @ingroup Genlist
19839     */
19840    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19841    /**
19842     * Activate a genlist mode on an item
19843     *
19844     * @param item The genlist item
19845     * @param mode Mode name
19846     * @param mode_set Boolean to define set or unset mode.
19847     *
19848     * A genlist mode is a different way of selecting an item. Once a mode is
19849     * activated on an item, any other selected item is immediately unselected.
19850     * This feature provides an easy way of implementing a new kind of animation
19851     * for selecting an item, without having to entirely rewrite the item style
19852     * theme. However, the elm_genlist_selected_* API can't be used to get what
19853     * item is activate for a mode.
19854     *
19855     * The current item style will still be used, but applying a genlist mode to
19856     * an item will select it using a different kind of animation.
19857     *
19858     * The current active item for a mode can be found by
19859     * elm_genlist_mode_item_get().
19860     *
19861     * The characteristics of genlist mode are:
19862     * - Only one mode can be active at any time, and for only one item.
19863     * - Genlist handles deactivating other items when one item is activated.
19864     * - A mode is defined in the genlist theme (edc), and more modes can easily
19865     *   be added.
19866     * - A mode style and the genlist item style are different things. They
19867     *   can be combined to provide a default style to the item, with some kind
19868     *   of animation for that item when the mode is activated.
19869     *
19870     * When a mode is activated on an item, a new view for that item is created.
19871     * The theme of this mode defines the animation that will be used to transit
19872     * the item from the old view to the new view. This second (new) view will be
19873     * active for that item while the mode is active on the item, and will be
19874     * destroyed after the mode is totally deactivated from that item.
19875     *
19876     * @see elm_genlist_mode_get()
19877     * @see elm_genlist_mode_item_get()
19878     *
19879     * @ingroup Genlist
19880     */
19881    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19882    /**
19883     * Get the last (or current) genlist mode used.
19884     *
19885     * @param obj The genlist object
19886     *
19887     * This function just returns the name of the last used genlist mode. It will
19888     * be the current mode if it's still active.
19889     *
19890     * @see elm_genlist_item_mode_set()
19891     * @see elm_genlist_mode_item_get()
19892     *
19893     * @ingroup Genlist
19894     */
19895    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19896    /**
19897     * Get active genlist mode item
19898     *
19899     * @param obj The genlist object
19900     * @return The active item for that current mode. Or @c NULL if no item is
19901     * activated with any mode.
19902     *
19903     * This function returns the item that was activated with a mode, by the
19904     * function elm_genlist_item_mode_set().
19905     *
19906     * @see elm_genlist_item_mode_set()
19907     * @see elm_genlist_mode_get()
19908     *
19909     * @ingroup Genlist
19910     */
19911    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19912
19913    /**
19914     * Set reorder mode
19915     *
19916     * @param obj The genlist object
19917     * @param reorder_mode The reorder mode
19918     * (EINA_TRUE = on, EINA_FALSE = off)
19919     *
19920     * @ingroup Genlist
19921     */
19922    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19923
19924    /**
19925     * Get the reorder mode
19926     *
19927     * @param obj The genlist object
19928     * @return The reorder mode
19929     * (EINA_TRUE = on, EINA_FALSE = off)
19930     *
19931     * @ingroup Genlist
19932     */
19933    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19934
19935    /**
19936     * @}
19937     */
19938
19939    /**
19940     * @defgroup Check Check
19941     *
19942     * @image html img/widget/check/preview-00.png
19943     * @image latex img/widget/check/preview-00.eps
19944     * @image html img/widget/check/preview-01.png
19945     * @image latex img/widget/check/preview-01.eps
19946     * @image html img/widget/check/preview-02.png
19947     * @image latex img/widget/check/preview-02.eps
19948     *
19949     * @brief The check widget allows for toggling a value between true and
19950     * false.
19951     *
19952     * Check objects are a lot like radio objects in layout and functionality
19953     * except they do not work as a group, but independently and only toggle the
19954     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19955     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19956     * returns the current state. For convenience, like the radio objects, you
19957     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19958     * for it to modify.
19959     *
19960     * Signals that you can add callbacks for are:
19961     * "changed" - This is called whenever the user changes the state of one of
19962     *             the check object(event_info is NULL).
19963     *
19964     * Default contents parts of the check widget that you can use for are:
19965     * @li "icon" - A icon of the check
19966     *
19967     * Default text parts of the check widget that you can use for are:
19968     * @li "elm.text" - Label of the check
19969     *
19970     * @ref tutorial_check should give you a firm grasp of how to use this widget
19971     * .
19972     * @{
19973     */
19974    /**
19975     * @brief Add a new Check object
19976     *
19977     * @param parent The parent object
19978     * @return The new object or NULL if it cannot be created
19979     */
19980    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19981    /**
19982     * @brief Set the text label of the check object
19983     *
19984     * @param obj The check object
19985     * @param label The text label string in UTF-8
19986     *
19987     * @deprecated use elm_object_text_set() instead.
19988     */
19989    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19990    /**
19991     * @brief Get the text label of the check object
19992     *
19993     * @param obj The check object
19994     * @return The text label string in UTF-8
19995     *
19996     * @deprecated use elm_object_text_get() instead.
19997     */
19998    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19999    /**
20000     * @brief Set the icon object of the check object
20001     *
20002     * @param obj The check object
20003     * @param icon The icon object
20004     *
20005     * Once the icon object is set, a previously set one will be deleted.
20006     * If you want to keep that old content object, use the
20007     * elm_object_content_unset() function.
20008     *
20009     * @deprecated use elm_object_part_content_set() instead.
20010     *
20011     */
20012    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20013    /**
20014     * @brief Get the icon object of the check object
20015     *
20016     * @param obj The check object
20017     * @return The icon object
20018     *
20019     * @deprecated use elm_object_part_content_get() instead.
20020     *  
20021     */
20022    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20023    /**
20024     * @brief Unset the icon used for the check object
20025     *
20026     * @param obj The check object
20027     * @return The icon object that was being used
20028     *
20029     * Unparent and return the icon object which was set for this widget.
20030     *
20031     * @deprecated use elm_object_part_content_unset() instead.
20032     *
20033     */
20034    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20035    /**
20036     * @brief Set the on/off state of the check object
20037     *
20038     * @param obj The check object
20039     * @param state The state to use (1 == on, 0 == off)
20040     *
20041     * This sets the state of the check. If set
20042     * with elm_check_state_pointer_set() the state of that variable is also
20043     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20044     */
20045    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20046    /**
20047     * @brief Get the state of the check object
20048     *
20049     * @param obj The check object
20050     * @return The boolean state
20051     */
20052    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20053    /**
20054     * @brief Set a convenience pointer to a boolean to change
20055     *
20056     * @param obj The check object
20057     * @param statep Pointer to the boolean to modify
20058     *
20059     * This sets a pointer to a boolean, that, in addition to the check objects
20060     * state will also be modified directly. To stop setting the object pointed
20061     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20062     * then when this is called, the check objects state will also be modified to
20063     * reflect the value of the boolean @p statep points to, just like calling
20064     * elm_check_state_set().
20065     */
20066    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20067    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20068    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);
20069
20070    /**
20071     * @}
20072     */
20073
20074    /**
20075     * @defgroup Radio Radio
20076     *
20077     * @image html img/widget/radio/preview-00.png
20078     * @image latex img/widget/radio/preview-00.eps
20079     *
20080     * @brief Radio is a widget that allows for 1 or more options to be displayed
20081     * and have the user choose only 1 of them.
20082     *
20083     * A radio object contains an indicator, an optional Label and an optional
20084     * icon object. While it's possible to have a group of only one radio they,
20085     * are normally used in groups of 2 or more. To add a radio to a group use
20086     * elm_radio_group_add(). The radio object(s) will select from one of a set
20087     * of integer values, so any value they are configuring needs to be mapped to
20088     * a set of integers. To configure what value that radio object represents,
20089     * use  elm_radio_state_value_set() to set the integer it represents. To set
20090     * the value the whole group(which one is currently selected) is to indicate
20091     * use elm_radio_value_set() on any group member, and to get the groups value
20092     * use elm_radio_value_get(). For convenience the radio objects are also able
20093     * to directly set an integer(int) to the value that is selected. To specify
20094     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20095     * The radio objects will modify this directly. That implies the pointer must
20096     * point to valid memory for as long as the radio objects exist.
20097     *
20098     * Signals that you can add callbacks for are:
20099     * @li changed - This is called whenever the user changes the state of one of
20100     * the radio objects within the group of radio objects that work together.
20101     *
20102     * Default contents parts of the radio widget that you can use for are:
20103     * @li "icon" - A icon of the radio
20104     *
20105     * @ref tutorial_radio show most of this API in action.
20106     * @{
20107     */
20108    /**
20109     * @brief Add a new radio to the parent
20110     *
20111     * @param parent The parent object
20112     * @return The new object or NULL if it cannot be created
20113     */
20114    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20115    /**
20116     * @brief Set the text label of the radio object
20117     *
20118     * @param obj The radio object
20119     * @param label The text label string in UTF-8
20120     *
20121     * @deprecated use elm_object_text_set() instead.
20122     */
20123    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20124    /**
20125     * @brief Get the text label of the radio object
20126     *
20127     * @param obj The radio object
20128     * @return The text label string in UTF-8
20129     *
20130     * @deprecated use elm_object_text_set() instead.
20131     */
20132    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20133    /**
20134     * @brief Set the icon object of the radio object
20135     *
20136     * @param obj The radio object
20137     * @param icon The icon object
20138     *
20139     * Once the icon object is set, a previously set one will be deleted. If you
20140     * want to keep that old content object, use the elm_radio_icon_unset()
20141     * function.
20142     *
20143     * @deprecated use elm_object_part_content_set() instead.
20144     *
20145     */
20146    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20147    /**
20148     * @brief Get the icon object of the radio object
20149     *
20150     * @param obj The radio object
20151     * @return The icon object
20152     *
20153     * @see elm_radio_icon_set()
20154     *
20155     * @deprecated use elm_object_part_content_get() instead.
20156     *
20157     */
20158    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20159    /**
20160     * @brief Unset the icon used for the radio object
20161     *
20162     * @param obj The radio object
20163     * @return The icon object that was being used
20164     *
20165     * Unparent and return the icon object which was set for this widget.
20166     *
20167     * @see elm_radio_icon_set()
20168     * @deprecated use elm_object_part_content_unset() instead.
20169     *
20170     */
20171    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20172    /**
20173     * @brief Add this radio to a group of other radio objects
20174     *
20175     * @param obj The radio object
20176     * @param group Any object whose group the @p obj is to join.
20177     *
20178     * Radio objects work in groups. Each member should have a different integer
20179     * value assigned. In order to have them work as a group, they need to know
20180     * about each other. This adds the given radio object to the group of which
20181     * the group object indicated is a member.
20182     */
20183    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20184    /**
20185     * @brief Set the integer value that this radio object represents
20186     *
20187     * @param obj The radio object
20188     * @param value The value to use if this radio object is selected
20189     *
20190     * This sets the value of the radio.
20191     */
20192    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20193    /**
20194     * @brief Get the integer value that this radio object represents
20195     *
20196     * @param obj The radio object
20197     * @return The value used if this radio object is selected
20198     *
20199     * This gets the value of the radio.
20200     *
20201     * @see elm_radio_value_set()
20202     */
20203    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20204    /**
20205     * @brief Set the value of the radio.
20206     *
20207     * @param obj The radio object
20208     * @param value The value to use for the group
20209     *
20210     * This sets the value of the radio group and will also set the value if
20211     * pointed to, to the value supplied, but will not call any callbacks.
20212     */
20213    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20214    /**
20215     * @brief Get the state of the radio object
20216     *
20217     * @param obj The radio object
20218     * @return The integer state
20219     */
20220    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20221    /**
20222     * @brief Set a convenience pointer to a integer to change
20223     *
20224     * @param obj The radio object
20225     * @param valuep Pointer to the integer to modify
20226     *
20227     * This sets a pointer to a integer, that, in addition to the radio objects
20228     * state will also be modified directly. To stop setting the object pointed
20229     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20230     * when this is called, the radio objects state will also be modified to
20231     * reflect the value of the integer valuep points to, just like calling
20232     * elm_radio_value_set().
20233     */
20234    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20235    /**
20236     * @}
20237     */
20238
20239    /**
20240     * @defgroup Pager Pager
20241     *
20242     * @image html img/widget/pager/preview-00.png
20243     * @image latex img/widget/pager/preview-00.eps
20244     *
20245     * @brief Widget that allows flipping between one or more ā€œpagesā€
20246     * of objects.
20247     *
20248     * The flipping between pages of objects is animated. All content
20249     * in the pager is kept in a stack, being the last content added
20250     * (visible one) on the top of that stack.
20251     *
20252     * Objects can be pushed or popped from the stack or deleted as
20253     * well. Pushes and pops will animate the widget accordingly to its
20254     * style (a pop will also delete the child object once the
20255     * animation is finished). Any object already in the pager can be
20256     * promoted to the top (from its current stacking position) through
20257     * the use of elm_pager_content_promote(). New objects are pushed
20258     * to the top with elm_pager_content_push(). When the top item is
20259     * no longer wanted, simply pop it with elm_pager_content_pop() and
20260     * it will also be deleted. If an object is no longer needed and is
20261     * not the top item, just delete it as normal. You can query which
20262     * objects are the top and bottom with
20263     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20264     *
20265     * Signals that you can add callbacks for are:
20266     * - @c "show,finished" - when a new page is actually shown on the top
20267     * - @c "hide,finished" - when a previous page is hidden
20268     *
20269     * Only after the first of that signals the child object is
20270     * guaranteed to be visible, as in @c evas_object_visible_get().
20271     *
20272     * This widget has the following styles available:
20273     * - @c "default"
20274     * - @c "fade"
20275     * - @c "fade_translucide"
20276     * - @c "fade_invisible"
20277     *
20278     * @note These styles affect only the flipping animations on the
20279     * default theme; the appearance when not animating is unaffected
20280     * by them.
20281     *
20282     * @ref tutorial_pager gives a good overview of the usage of the API.
20283     * @{
20284     */
20285
20286    /**
20287     * Add a new pager to the parent
20288     *
20289     * @param parent The parent object
20290     * @return The new object or NULL if it cannot be created
20291     *
20292     * @ingroup Pager
20293     */
20294    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20295
20296    /**
20297     * @brief Push an object to the top of the pager stack (and show it).
20298     *
20299     * @param obj The pager object
20300     * @param content The object to push
20301     *
20302     * The object pushed becomes a child of the pager, it will be controlled and
20303     * deleted when the pager is deleted.
20304     *
20305     * @note If the content is already in the stack use
20306     * elm_pager_content_promote().
20307     * @warning Using this function on @p content already in the stack results in
20308     * undefined behavior.
20309     */
20310    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20311
20312    /**
20313     * @brief Pop the object that is on top of the stack
20314     *
20315     * @param obj The pager object
20316     *
20317     * This pops the object that is on the top(visible) of the pager, makes it
20318     * disappear, then deletes the object. The object that was underneath it on
20319     * the stack will become visible.
20320     */
20321    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20322
20323    /**
20324     * @brief Moves an object already in the pager stack to the top of the stack.
20325     *
20326     * @param obj The pager object
20327     * @param content The object to promote
20328     *
20329     * This will take the @p content and move it to the top of the stack as
20330     * if it had been pushed there.
20331     *
20332     * @note If the content isn't already in the stack use
20333     * elm_pager_content_push().
20334     * @warning Using this function on @p content not already in the stack
20335     * results in undefined behavior.
20336     */
20337    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20338
20339    /**
20340     * @brief Return the object at the bottom of the pager stack
20341     *
20342     * @param obj The pager object
20343     * @return The bottom object or NULL if none
20344     */
20345    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20346
20347    /**
20348     * @brief  Return the object at the top of the pager stack
20349     *
20350     * @param obj The pager object
20351     * @return The top object or NULL if none
20352     */
20353    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20354
20355    /**
20356     * @}
20357     */
20358
20359    /**
20360     * @defgroup Slideshow Slideshow
20361     *
20362     * @image html img/widget/slideshow/preview-00.png
20363     * @image latex img/widget/slideshow/preview-00.eps
20364     *
20365     * This widget, as the name indicates, is a pre-made image
20366     * slideshow panel, with API functions acting on (child) image
20367     * items presentation. Between those actions, are:
20368     * - advance to next/previous image
20369     * - select the style of image transition animation
20370     * - set the exhibition time for each image
20371     * - start/stop the slideshow
20372     *
20373     * The transition animations are defined in the widget's theme,
20374     * consequently new animations can be added without having to
20375     * update the widget's code.
20376     *
20377     * @section Slideshow_Items Slideshow items
20378     *
20379     * For slideshow items, just like for @ref Genlist "genlist" ones,
20380     * the user defines a @b classes, specifying functions that will be
20381     * called on the item's creation and deletion times.
20382     *
20383     * The #Elm_Slideshow_Item_Class structure contains the following
20384     * members:
20385     *
20386     * - @c func.get - When an item is displayed, this function is
20387     *   called, and it's where one should create the item object, de
20388     *   facto. For example, the object can be a pure Evas image object
20389     *   or an Elementary @ref Photocam "photocam" widget. See
20390     *   #SlideshowItemGetFunc.
20391     * - @c func.del - When an item is no more displayed, this function
20392     *   is called, where the user must delete any data associated to
20393     *   the item. See #SlideshowItemDelFunc.
20394     *
20395     * @section Slideshow_Caching Slideshow caching
20396     *
20397     * The slideshow provides facilities to have items adjacent to the
20398     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20399     * you, so that the system does not have to decode image data
20400     * anymore at the time it has to actually switch images on its
20401     * viewport. The user is able to set the numbers of items to be
20402     * cached @b before and @b after the current item, in the widget's
20403     * item list.
20404     *
20405     * Smart events one can add callbacks for are:
20406     *
20407     * - @c "changed" - when the slideshow switches its view to a new
20408     *   item
20409     *
20410     * List of examples for the slideshow widget:
20411     * @li @ref slideshow_example
20412     */
20413
20414    /**
20415     * @addtogroup Slideshow
20416     * @{
20417     */
20418
20419    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20420    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20421    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20422    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20423    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20424
20425    /**
20426     * @struct _Elm_Slideshow_Item_Class
20427     *
20428     * Slideshow item class definition. See @ref Slideshow_Items for
20429     * field details.
20430     */
20431    struct _Elm_Slideshow_Item_Class
20432      {
20433         struct _Elm_Slideshow_Item_Class_Func
20434           {
20435              SlideshowItemGetFunc get;
20436              SlideshowItemDelFunc del;
20437           } func;
20438      }; /**< #Elm_Slideshow_Item_Class member definitions */
20439
20440    /**
20441     * Add a new slideshow widget to the given parent Elementary
20442     * (container) object
20443     *
20444     * @param parent The parent object
20445     * @return A new slideshow widget handle or @c NULL, on errors
20446     *
20447     * This function inserts a new slideshow widget on the canvas.
20448     *
20449     * @ingroup Slideshow
20450     */
20451    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20452
20453    /**
20454     * Add (append) a new item in a given slideshow widget.
20455     *
20456     * @param obj The slideshow object
20457     * @param itc The item class for the item
20458     * @param data The item's data
20459     * @return A handle to the item added or @c NULL, on errors
20460     *
20461     * Add a new item to @p obj's internal list of items, appending it.
20462     * The item's class must contain the function really fetching the
20463     * image object to show for this item, which could be an Evas image
20464     * object or an Elementary photo, for example. The @p data
20465     * parameter is going to be passed to both class functions of the
20466     * item.
20467     *
20468     * @see #Elm_Slideshow_Item_Class
20469     * @see elm_slideshow_item_sorted_insert()
20470     *
20471     * @ingroup Slideshow
20472     */
20473    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20474
20475    /**
20476     * Insert a new item into the given slideshow widget, using the @p func
20477     * function to sort items (by item handles).
20478     *
20479     * @param obj The slideshow object
20480     * @param itc The item class for the item
20481     * @param data The item's data
20482     * @param func The comparing function to be used to sort slideshow
20483     * items <b>by #Elm_Slideshow_Item item handles</b>
20484     * @return Returns The slideshow item handle, on success, or
20485     * @c NULL, on errors
20486     *
20487     * Add a new item to @p obj's internal list of items, in a position
20488     * determined by the @p func comparing function. The item's class
20489     * must contain the function really fetching the image object to
20490     * show for this item, which could be an Evas image object or an
20491     * Elementary photo, for example. The @p data parameter is going to
20492     * be passed to both class functions of the item.
20493     *
20494     * @see #Elm_Slideshow_Item_Class
20495     * @see elm_slideshow_item_add()
20496     *
20497     * @ingroup Slideshow
20498     */
20499    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);
20500
20501    /**
20502     * Display a given slideshow widget's item, programmatically.
20503     *
20504     * @param obj The slideshow object
20505     * @param item The item to display on @p obj's viewport
20506     *
20507     * The change between the current item and @p item will use the
20508     * transition @p obj is set to use (@see
20509     * elm_slideshow_transition_set()).
20510     *
20511     * @ingroup Slideshow
20512     */
20513    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20514
20515    /**
20516     * Slide to the @b next item, in a given slideshow widget
20517     *
20518     * @param obj The slideshow object
20519     *
20520     * The sliding animation @p obj is set to use will be the
20521     * transition effect used, after this call is issued.
20522     *
20523     * @note If the end of the slideshow's internal list of items is
20524     * reached, it'll wrap around to the list's beginning, again.
20525     *
20526     * @ingroup Slideshow
20527     */
20528    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20529
20530    /**
20531     * Slide to the @b previous item, in a given slideshow widget
20532     *
20533     * @param obj The slideshow object
20534     *
20535     * The sliding animation @p obj is set to use will be the
20536     * transition effect used, after this call is issued.
20537     *
20538     * @note If the beginning of the slideshow's internal list of items
20539     * is reached, it'll wrap around to the list's end, again.
20540     *
20541     * @ingroup Slideshow
20542     */
20543    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20544
20545    /**
20546     * Returns the list of sliding transition/effect names available, for a
20547     * given slideshow widget.
20548     *
20549     * @param obj The slideshow object
20550     * @return The list of transitions (list of @b stringshared strings
20551     * as data)
20552     *
20553     * The transitions, which come from @p obj's theme, must be an EDC
20554     * data item named @c "transitions" on the theme file, with (prefix)
20555     * names of EDC programs actually implementing them.
20556     *
20557     * The available transitions for slideshows on the default theme are:
20558     * - @c "fade" - the current item fades out, while the new one
20559     *   fades in to the slideshow's viewport.
20560     * - @c "black_fade" - the current item fades to black, and just
20561     *   then, the new item will fade in.
20562     * - @c "horizontal" - the current item slides horizontally, until
20563     *   it gets out of the slideshow's viewport, while the new item
20564     *   comes from the left to take its place.
20565     * - @c "vertical" - the current item slides vertically, until it
20566     *   gets out of the slideshow's viewport, while the new item comes
20567     *   from the bottom to take its place.
20568     * - @c "square" - the new item starts to appear from the middle of
20569     *   the current one, but with a tiny size, growing until its
20570     *   target (full) size and covering the old one.
20571     *
20572     * @warning The stringshared strings get no new references
20573     * exclusive to the user grabbing the list, here, so if you'd like
20574     * to use them out of this call's context, you'd better @c
20575     * eina_stringshare_ref() them.
20576     *
20577     * @see elm_slideshow_transition_set()
20578     *
20579     * @ingroup Slideshow
20580     */
20581    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20582
20583    /**
20584     * Set the current slide transition/effect in use for a given
20585     * slideshow widget
20586     *
20587     * @param obj The slideshow object
20588     * @param transition The new transition's name string
20589     *
20590     * If @p transition is implemented in @p obj's theme (i.e., is
20591     * contained in the list returned by
20592     * elm_slideshow_transitions_get()), this new sliding effect will
20593     * be used on the widget.
20594     *
20595     * @see elm_slideshow_transitions_get() for more details
20596     *
20597     * @ingroup Slideshow
20598     */
20599    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20600
20601    /**
20602     * Get the current slide transition/effect in use for a given
20603     * slideshow widget
20604     *
20605     * @param obj The slideshow object
20606     * @return The current transition's name
20607     *
20608     * @see elm_slideshow_transition_set() for more details
20609     *
20610     * @ingroup Slideshow
20611     */
20612    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20613
20614    /**
20615     * Set the interval between each image transition on a given
20616     * slideshow widget, <b>and start the slideshow, itself</b>
20617     *
20618     * @param obj The slideshow object
20619     * @param timeout The new displaying timeout for images
20620     *
20621     * After this call, the slideshow widget will start cycling its
20622     * view, sequentially and automatically, with the images of the
20623     * items it has. The time between each new image displayed is going
20624     * to be @p timeout, in @b seconds. If a different timeout was set
20625     * previously and an slideshow was in progress, it will continue
20626     * with the new time between transitions, after this call.
20627     *
20628     * @note A value less than or equal to 0 on @p timeout will disable
20629     * the widget's internal timer, thus halting any slideshow which
20630     * could be happening on @p obj.
20631     *
20632     * @see elm_slideshow_timeout_get()
20633     *
20634     * @ingroup Slideshow
20635     */
20636    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20637
20638    /**
20639     * Get the interval set for image transitions on a given slideshow
20640     * widget.
20641     *
20642     * @param obj The slideshow object
20643     * @return Returns the timeout set on it
20644     *
20645     * @see elm_slideshow_timeout_set() for more details
20646     *
20647     * @ingroup Slideshow
20648     */
20649    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20650
20651    /**
20652     * Set if, after a slideshow is started, for a given slideshow
20653     * widget, its items should be displayed cyclically or not.
20654     *
20655     * @param obj The slideshow object
20656     * @param loop Use @c EINA_TRUE to make it cycle through items or
20657     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20658     * list of items
20659     *
20660     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20661     * ignore what is set by this functions, i.e., they'll @b always
20662     * cycle through items. This affects only the "automatic"
20663     * slideshow, as set by elm_slideshow_timeout_set().
20664     *
20665     * @see elm_slideshow_loop_get()
20666     *
20667     * @ingroup Slideshow
20668     */
20669    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20670
20671    /**
20672     * Get if, after a slideshow is started, for a given slideshow
20673     * widget, its items are to be displayed cyclically or not.
20674     *
20675     * @param obj The slideshow object
20676     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20677     * through or @c EINA_FALSE, otherwise
20678     *
20679     * @see elm_slideshow_loop_set() for more details
20680     *
20681     * @ingroup Slideshow
20682     */
20683    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20684
20685    /**
20686     * Remove all items from a given slideshow widget
20687     *
20688     * @param obj The slideshow object
20689     *
20690     * This removes (and deletes) all items in @p obj, leaving it
20691     * empty.
20692     *
20693     * @see elm_slideshow_item_del(), to remove just one item.
20694     *
20695     * @ingroup Slideshow
20696     */
20697    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20698
20699    /**
20700     * Get the internal list of items in a given slideshow widget.
20701     *
20702     * @param obj The slideshow object
20703     * @return The list of items (#Elm_Slideshow_Item as data) or
20704     * @c NULL on errors.
20705     *
20706     * This list is @b not to be modified in any way and must not be
20707     * freed. Use the list members with functions like
20708     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20709     *
20710     * @warning This list is only valid until @p obj object's internal
20711     * items list is changed. It should be fetched again with another
20712     * call to this function when changes happen.
20713     *
20714     * @ingroup Slideshow
20715     */
20716    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20717
20718    /**
20719     * Delete a given item from a slideshow widget.
20720     *
20721     * @param item The slideshow item
20722     *
20723     * @ingroup Slideshow
20724     */
20725    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20726
20727    /**
20728     * Return the data associated with a given slideshow item
20729     *
20730     * @param item The slideshow item
20731     * @return Returns the data associated to this item
20732     *
20733     * @ingroup Slideshow
20734     */
20735    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20736
20737    /**
20738     * Returns the currently displayed item, in a given slideshow widget
20739     *
20740     * @param obj The slideshow object
20741     * @return A handle to the item being displayed in @p obj or
20742     * @c NULL, if none is (and on errors)
20743     *
20744     * @ingroup Slideshow
20745     */
20746    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20747
20748    /**
20749     * Get the real Evas object created to implement the view of a
20750     * given slideshow item
20751     *
20752     * @param item The slideshow item.
20753     * @return the Evas object implementing this item's view.
20754     *
20755     * This returns the actual Evas object used to implement the
20756     * specified slideshow item's view. This may be @c NULL, as it may
20757     * not have been created or may have been deleted, at any time, by
20758     * the slideshow. <b>Do not modify this object</b> (move, resize,
20759     * show, hide, etc.), as the slideshow is controlling it. This
20760     * function is for querying, emitting custom signals or hooking
20761     * lower level callbacks for events on that object. Do not delete
20762     * this object under any circumstances.
20763     *
20764     * @see elm_slideshow_item_data_get()
20765     *
20766     * @ingroup Slideshow
20767     */
20768    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20769
20770    /**
20771     * Get the the item, in a given slideshow widget, placed at
20772     * position @p nth, in its internal items list
20773     *
20774     * @param obj The slideshow object
20775     * @param nth The number of the item to grab a handle to (0 being
20776     * the first)
20777     * @return The item stored in @p obj at position @p nth or @c NULL,
20778     * if there's no item with that index (and on errors)
20779     *
20780     * @ingroup Slideshow
20781     */
20782    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20783
20784    /**
20785     * Set the current slide layout in use for a given slideshow widget
20786     *
20787     * @param obj The slideshow object
20788     * @param layout The new layout's name string
20789     *
20790     * If @p layout is implemented in @p obj's theme (i.e., is contained
20791     * in the list returned by elm_slideshow_layouts_get()), this new
20792     * images layout will be used on the widget.
20793     *
20794     * @see elm_slideshow_layouts_get() for more details
20795     *
20796     * @ingroup Slideshow
20797     */
20798    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20799
20800    /**
20801     * Get the current slide layout in use for a given slideshow widget
20802     *
20803     * @param obj The slideshow object
20804     * @return The current layout's name
20805     *
20806     * @see elm_slideshow_layout_set() for more details
20807     *
20808     * @ingroup Slideshow
20809     */
20810    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20811
20812    /**
20813     * Returns the list of @b layout names available, for a given
20814     * slideshow widget.
20815     *
20816     * @param obj The slideshow object
20817     * @return The list of layouts (list of @b stringshared strings
20818     * as data)
20819     *
20820     * Slideshow layouts will change how the widget is to dispose each
20821     * image item in its viewport, with regard to cropping, scaling,
20822     * etc.
20823     *
20824     * The layouts, which come from @p obj's theme, must be an EDC
20825     * data item name @c "layouts" on the theme file, with (prefix)
20826     * names of EDC programs actually implementing them.
20827     *
20828     * The available layouts for slideshows on the default theme are:
20829     * - @c "fullscreen" - item images with original aspect, scaled to
20830     *   touch top and down slideshow borders or, if the image's heigh
20831     *   is not enough, left and right slideshow borders.
20832     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20833     *   one, but always leaving 10% of the slideshow's dimensions of
20834     *   distance between the item image's borders and the slideshow
20835     *   borders, for each axis.
20836     *
20837     * @warning The stringshared strings get no new references
20838     * exclusive to the user grabbing the list, here, so if you'd like
20839     * to use them out of this call's context, you'd better @c
20840     * eina_stringshare_ref() them.
20841     *
20842     * @see elm_slideshow_layout_set()
20843     *
20844     * @ingroup Slideshow
20845     */
20846    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20847
20848    /**
20849     * Set the number of items to cache, on a given slideshow widget,
20850     * <b>before the current item</b>
20851     *
20852     * @param obj The slideshow object
20853     * @param count Number of items to cache before the current one
20854     *
20855     * The default value for this property is @c 2. See
20856     * @ref Slideshow_Caching "slideshow caching" for more details.
20857     *
20858     * @see elm_slideshow_cache_before_get()
20859     *
20860     * @ingroup Slideshow
20861     */
20862    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20863
20864    /**
20865     * Retrieve the number of items to cache, on a given slideshow widget,
20866     * <b>before the current item</b>
20867     *
20868     * @param obj The slideshow object
20869     * @return The number of items set to be cached before the current one
20870     *
20871     * @see elm_slideshow_cache_before_set() for more details
20872     *
20873     * @ingroup Slideshow
20874     */
20875    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20876
20877    /**
20878     * Set the number of items to cache, on a given slideshow widget,
20879     * <b>after the current item</b>
20880     *
20881     * @param obj The slideshow object
20882     * @param count Number of items to cache after the current one
20883     *
20884     * The default value for this property is @c 2. See
20885     * @ref Slideshow_Caching "slideshow caching" for more details.
20886     *
20887     * @see elm_slideshow_cache_after_get()
20888     *
20889     * @ingroup Slideshow
20890     */
20891    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20892
20893    /**
20894     * Retrieve the number of items to cache, on a given slideshow widget,
20895     * <b>after the current item</b>
20896     *
20897     * @param obj The slideshow object
20898     * @return The number of items set to be cached after the current one
20899     *
20900     * @see elm_slideshow_cache_after_set() for more details
20901     *
20902     * @ingroup Slideshow
20903     */
20904    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20905
20906    /**
20907     * Get the number of items stored in a given slideshow widget
20908     *
20909     * @param obj The slideshow object
20910     * @return The number of items on @p obj, at the moment of this call
20911     *
20912     * @ingroup Slideshow
20913     */
20914    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20915
20916    /**
20917     * @}
20918     */
20919
20920    /**
20921     * @defgroup Fileselector File Selector
20922     *
20923     * @image html img/widget/fileselector/preview-00.png
20924     * @image latex img/widget/fileselector/preview-00.eps
20925     *
20926     * A file selector is a widget that allows a user to navigate
20927     * through a file system, reporting file selections back via its
20928     * API.
20929     *
20930     * It contains shortcut buttons for home directory (@c ~) and to
20931     * jump one directory upwards (..), as well as cancel/ok buttons to
20932     * confirm/cancel a given selection. After either one of those two
20933     * former actions, the file selector will issue its @c "done" smart
20934     * callback.
20935     *
20936     * There's a text entry on it, too, showing the name of the current
20937     * selection. There's the possibility of making it editable, so it
20938     * is useful on file saving dialogs on applications, where one
20939     * gives a file name to save contents to, in a given directory in
20940     * the system. This custom file name will be reported on the @c
20941     * "done" smart callback (explained in sequence).
20942     *
20943     * Finally, it has a view to display file system items into in two
20944     * possible forms:
20945     * - list
20946     * - grid
20947     *
20948     * If Elementary is built with support of the Ethumb thumbnailing
20949     * library, the second form of view will display preview thumbnails
20950     * of files which it supports.
20951     *
20952     * Smart callbacks one can register to:
20953     *
20954     * - @c "selected" - the user has clicked on a file (when not in
20955     *      folders-only mode) or directory (when in folders-only mode)
20956     * - @c "directory,open" - the list has been populated with new
20957     *      content (@c event_info is a pointer to the directory's
20958     *      path, a @b stringshared string)
20959     * - @c "done" - the user has clicked on the "ok" or "cancel"
20960     *      buttons (@c event_info is a pointer to the selection's
20961     *      path, a @b stringshared string)
20962     *
20963     * Here is an example on its usage:
20964     * @li @ref fileselector_example
20965     */
20966
20967    /**
20968     * @addtogroup Fileselector
20969     * @{
20970     */
20971
20972    /**
20973     * Defines how a file selector widget is to layout its contents
20974     * (file system entries).
20975     */
20976    typedef enum _Elm_Fileselector_Mode
20977      {
20978         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20979         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20980         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20981      } Elm_Fileselector_Mode;
20982
20983    /**
20984     * Add a new file selector widget to the given parent Elementary
20985     * (container) object
20986     *
20987     * @param parent The parent object
20988     * @return a new file selector widget handle or @c NULL, on errors
20989     *
20990     * This function inserts a new file selector widget on the canvas.
20991     *
20992     * @ingroup Fileselector
20993     */
20994    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20995
20996    /**
20997     * Enable/disable the file name entry box where the user can type
20998     * in a name for a file, in a given file selector widget
20999     *
21000     * @param obj The file selector object
21001     * @param is_save @c EINA_TRUE to make the file selector a "saving
21002     * dialog", @c EINA_FALSE otherwise
21003     *
21004     * Having the entry editable is useful on file saving dialogs on
21005     * applications, where one gives a file name to save contents to,
21006     * in a given directory in the system. This custom file name will
21007     * be reported on the @c "done" smart callback.
21008     *
21009     * @see elm_fileselector_is_save_get()
21010     *
21011     * @ingroup Fileselector
21012     */
21013    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21014
21015    /**
21016     * Get whether the given file selector is in "saving dialog" mode
21017     *
21018     * @param obj The file selector object
21019     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21020     * mode, @c EINA_FALSE otherwise (and on errors)
21021     *
21022     * @see elm_fileselector_is_save_set() for more details
21023     *
21024     * @ingroup Fileselector
21025     */
21026    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21027
21028    /**
21029     * Enable/disable folder-only view for a given file selector widget
21030     *
21031     * @param obj The file selector object
21032     * @param only @c EINA_TRUE to make @p obj only display
21033     * directories, @c EINA_FALSE to make files to be displayed in it
21034     * too
21035     *
21036     * If enabled, the widget's view will only display folder items,
21037     * naturally.
21038     *
21039     * @see elm_fileselector_folder_only_get()
21040     *
21041     * @ingroup Fileselector
21042     */
21043    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21044
21045    /**
21046     * Get whether folder-only view is set for a given file selector
21047     * widget
21048     *
21049     * @param obj The file selector object
21050     * @return only @c EINA_TRUE if @p obj is only displaying
21051     * directories, @c EINA_FALSE if files are being displayed in it
21052     * too (and on errors)
21053     *
21054     * @see elm_fileselector_folder_only_get()
21055     *
21056     * @ingroup Fileselector
21057     */
21058    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21059
21060    /**
21061     * Enable/disable the "ok" and "cancel" buttons on a given file
21062     * selector widget
21063     *
21064     * @param obj The file selector object
21065     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21066     *
21067     * @note A file selector without those buttons will never emit the
21068     * @c "done" smart event, and is only usable if one is just hooking
21069     * to the other two events.
21070     *
21071     * @see elm_fileselector_buttons_ok_cancel_get()
21072     *
21073     * @ingroup Fileselector
21074     */
21075    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21076
21077    /**
21078     * Get whether the "ok" and "cancel" buttons on a given file
21079     * selector widget are being shown.
21080     *
21081     * @param obj The file selector object
21082     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21083     * otherwise (and on errors)
21084     *
21085     * @see elm_fileselector_buttons_ok_cancel_set() for more details
21086     *
21087     * @ingroup Fileselector
21088     */
21089    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21090
21091    /**
21092     * Enable/disable a tree view in the given file selector widget,
21093     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21094     *
21095     * @param obj The file selector object
21096     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21097     * disable
21098     *
21099     * In a tree view, arrows are created on the sides of directories,
21100     * allowing them to expand in place.
21101     *
21102     * @note If it's in other mode, the changes made by this function
21103     * will only be visible when one switches back to "list" mode.
21104     *
21105     * @see elm_fileselector_expandable_get()
21106     *
21107     * @ingroup Fileselector
21108     */
21109    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21110
21111    /**
21112     * Get whether tree view is enabled for the given file selector
21113     * widget
21114     *
21115     * @param obj The file selector object
21116     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21117     * otherwise (and or errors)
21118     *
21119     * @see elm_fileselector_expandable_set() for more details
21120     *
21121     * @ingroup Fileselector
21122     */
21123    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21124
21125    /**
21126     * Set, programmatically, the @b directory that a given file
21127     * selector widget will display contents from
21128     *
21129     * @param obj The file selector object
21130     * @param path The path to display in @p obj
21131     *
21132     * This will change the @b directory that @p obj is displaying. It
21133     * will also clear the text entry area on the @p obj object, which
21134     * displays select files' names.
21135     *
21136     * @see elm_fileselector_path_get()
21137     *
21138     * @ingroup Fileselector
21139     */
21140    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21141
21142    /**
21143     * Get the parent directory's path that a given file selector
21144     * widget is displaying
21145     *
21146     * @param obj The file selector object
21147     * @return The (full) path of the directory the file selector is
21148     * displaying, a @b stringshared string
21149     *
21150     * @see elm_fileselector_path_set()
21151     *
21152     * @ingroup Fileselector
21153     */
21154    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21155
21156    /**
21157     * Set, programmatically, the currently selected file/directory in
21158     * the given file selector widget
21159     *
21160     * @param obj The file selector object
21161     * @param path The (full) path to a file or directory
21162     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21163     * latter case occurs if the directory or file pointed to do not
21164     * exist.
21165     *
21166     * @see elm_fileselector_selected_get()
21167     *
21168     * @ingroup Fileselector
21169     */
21170    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21171
21172    /**
21173     * Get the currently selected item's (full) path, in the given file
21174     * selector widget
21175     *
21176     * @param obj The file selector object
21177     * @return The absolute path of the selected item, a @b
21178     * stringshared string
21179     *
21180     * @note Custom editions on @p obj object's text entry, if made,
21181     * will appear on the return string of this function, naturally.
21182     *
21183     * @see elm_fileselector_selected_set() for more details
21184     *
21185     * @ingroup Fileselector
21186     */
21187    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21188
21189    /**
21190     * Set the mode in which a given file selector widget will display
21191     * (layout) file system entries in its view
21192     *
21193     * @param obj The file selector object
21194     * @param mode The mode of the fileselector, being it one of
21195     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21196     * first one, naturally, will display the files in a list. The
21197     * latter will make the widget to display its entries in a grid
21198     * form.
21199     *
21200     * @note By using elm_fileselector_expandable_set(), the user may
21201     * trigger a tree view for that list.
21202     *
21203     * @note If Elementary is built with support of the Ethumb
21204     * thumbnailing library, the second form of view will display
21205     * preview thumbnails of files which it supports. You must have
21206     * elm_need_ethumb() called in your Elementary for thumbnailing to
21207     * work, though.
21208     *
21209     * @see elm_fileselector_expandable_set().
21210     * @see elm_fileselector_mode_get().
21211     *
21212     * @ingroup Fileselector
21213     */
21214    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21215
21216    /**
21217     * Get the mode in which a given file selector widget is displaying
21218     * (layouting) file system entries in its view
21219     *
21220     * @param obj The fileselector object
21221     * @return The mode in which the fileselector is at
21222     *
21223     * @see elm_fileselector_mode_set() for more details
21224     *
21225     * @ingroup Fileselector
21226     */
21227    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21228
21229    /**
21230     * @}
21231     */
21232
21233    /**
21234     * @defgroup Progressbar Progress bar
21235     *
21236     * The progress bar is a widget for visually representing the
21237     * progress status of a given job/task.
21238     *
21239     * A progress bar may be horizontal or vertical. It may display an
21240     * icon besides it, as well as primary and @b units labels. The
21241     * former is meant to label the widget as a whole, while the
21242     * latter, which is formatted with floating point values (and thus
21243     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21244     * units"</c>), is meant to label the widget's <b>progress
21245     * value</b>. Label, icon and unit strings/objects are @b optional
21246     * for progress bars.
21247     *
21248     * A progress bar may be @b inverted, in which state it gets its
21249     * values inverted, with high values being on the left or top and
21250     * low values on the right or bottom, as opposed to normally have
21251     * the low values on the former and high values on the latter,
21252     * respectively, for horizontal and vertical modes.
21253     *
21254     * The @b span of the progress, as set by
21255     * elm_progressbar_span_size_set(), is its length (horizontally or
21256     * vertically), unless one puts size hints on the widget to expand
21257     * on desired directions, by any container. That length will be
21258     * scaled by the object or applications scaling factor. At any
21259     * point code can query the progress bar for its value with
21260     * elm_progressbar_value_get().
21261     *
21262     * Available widget styles for progress bars:
21263     * - @c "default"
21264     * - @c "wheel" (simple style, no text, no progression, only
21265     *      "pulse" effect is available)
21266     *
21267     * Default contents parts of the progressbar widget that you can use for are:
21268     * @li "icon" - A icon of the progressbar
21269     * 
21270     * Here is an example on its usage:
21271     * @li @ref progressbar_example
21272     */
21273
21274    /**
21275     * Add a new progress bar widget to the given parent Elementary
21276     * (container) object
21277     *
21278     * @param parent The parent object
21279     * @return a new progress bar widget handle or @c NULL, on errors
21280     *
21281     * This function inserts a new progress bar widget on the canvas.
21282     *
21283     * @ingroup Progressbar
21284     */
21285    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21286
21287    /**
21288     * Set whether a given progress bar widget is at "pulsing mode" or
21289     * not.
21290     *
21291     * @param obj The progress bar object
21292     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21293     * @c EINA_FALSE to put it back to its default one
21294     *
21295     * By default, progress bars will display values from the low to
21296     * high value boundaries. There are, though, contexts in which the
21297     * state of progression of a given task is @b unknown.  For those,
21298     * one can set a progress bar widget to a "pulsing state", to give
21299     * the user an idea that some computation is being held, but
21300     * without exact progress values. In the default theme it will
21301     * animate its bar with the contents filling in constantly and back
21302     * to non-filled, in a loop. To start and stop this pulsing
21303     * animation, one has to explicitly call elm_progressbar_pulse().
21304     *
21305     * @see elm_progressbar_pulse_get()
21306     * @see elm_progressbar_pulse()
21307     *
21308     * @ingroup Progressbar
21309     */
21310    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21311
21312    /**
21313     * Get whether a given progress bar widget is at "pulsing mode" or
21314     * not.
21315     *
21316     * @param obj The progress bar object
21317     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21318     * if it's in the default one (and on errors)
21319     *
21320     * @ingroup Progressbar
21321     */
21322    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21323
21324    /**
21325     * Start/stop a given progress bar "pulsing" animation, if its
21326     * under that mode
21327     *
21328     * @param obj The progress bar object
21329     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21330     * @c EINA_FALSE to @b stop it
21331     *
21332     * @note This call won't do anything if @p obj is not under "pulsing mode".
21333     *
21334     * @see elm_progressbar_pulse_set() for more details.
21335     *
21336     * @ingroup Progressbar
21337     */
21338    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21339
21340    /**
21341     * Set the progress value (in percentage) on a given progress bar
21342     * widget
21343     *
21344     * @param obj The progress bar object
21345     * @param val The progress value (@b must be between @c 0.0 and @c
21346     * 1.0)
21347     *
21348     * Use this call to set progress bar levels.
21349     *
21350     * @note If you passes a value out of the specified range for @p
21351     * val, it will be interpreted as the @b closest of the @b boundary
21352     * values in the range.
21353     *
21354     * @ingroup Progressbar
21355     */
21356    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21357
21358    /**
21359     * Get the progress value (in percentage) on a given progress bar
21360     * widget
21361     *
21362     * @param obj The progress bar object
21363     * @return The value of the progressbar
21364     *
21365     * @see elm_progressbar_value_set() for more details
21366     *
21367     * @ingroup Progressbar
21368     */
21369    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21370
21371    /**
21372     * Set the label of a given progress bar widget
21373     *
21374     * @param obj The progress bar object
21375     * @param label The text label string, in UTF-8
21376     *
21377     * @ingroup Progressbar
21378     * @deprecated use elm_object_text_set() instead.
21379     */
21380    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21381
21382    /**
21383     * Get the label of a given progress bar widget
21384     *
21385     * @param obj The progressbar object
21386     * @return The text label string, in UTF-8
21387     *
21388     * @ingroup Progressbar
21389     * @deprecated use elm_object_text_set() instead.
21390     */
21391    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21392
21393    /**
21394     * Set the icon object of a given progress bar widget
21395     *
21396     * @param obj The progress bar object
21397     * @param icon The icon object
21398     *
21399     * Use this call to decorate @p obj with an icon next to it.
21400     *
21401     * @note Once the icon object is set, a previously set one will be
21402     * deleted. If you want to keep that old content object, use the
21403     * elm_progressbar_icon_unset() function.
21404     *
21405     * @see elm_progressbar_icon_get()
21406     * @deprecated use elm_object_part_content_set() instead.
21407     *
21408     * @ingroup Progressbar
21409     */
21410    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21411
21412    /**
21413     * Retrieve the icon object set for a given progress bar widget
21414     *
21415     * @param obj The progress bar object
21416     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21417     * otherwise (and on errors)
21418     *
21419     * @see elm_progressbar_icon_set() for more details
21420     * @deprecated use elm_object_part_content_get() instead.
21421     *
21422     * @ingroup Progressbar
21423     */
21424    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21425
21426    /**
21427     * Unset an icon set on a given progress bar widget
21428     *
21429     * @param obj The progress bar object
21430     * @return The icon object that was being used, if any was set, or
21431     * @c NULL, otherwise (and on errors)
21432     *
21433     * This call will unparent and return the icon object which was set
21434     * for this widget, previously, on success.
21435     *
21436     * @see elm_progressbar_icon_set() for more details
21437     * @deprecated use elm_object_part_content_unset() instead.
21438     *
21439     * @ingroup Progressbar
21440     */
21441    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21442
21443    /**
21444     * Set the (exact) length of the bar region of a given progress bar
21445     * widget
21446     *
21447     * @param obj The progress bar object
21448     * @param size The length of the progress bar's bar region
21449     *
21450     * This sets the minimum width (when in horizontal mode) or height
21451     * (when in vertical mode) of the actual bar area of the progress
21452     * bar @p obj. This in turn affects the object's minimum size. Use
21453     * this when you're not setting other size hints expanding on the
21454     * given direction (like weight and alignment hints) and you would
21455     * like it to have a specific size.
21456     *
21457     * @note Icon, label and unit text around @p obj will require their
21458     * own space, which will make @p obj to require more the @p size,
21459     * actually.
21460     *
21461     * @see elm_progressbar_span_size_get()
21462     *
21463     * @ingroup Progressbar
21464     */
21465    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21466
21467    /**
21468     * Get the length set for the bar region of a given progress bar
21469     * widget
21470     *
21471     * @param obj The progress bar object
21472     * @return The length of the progress bar's bar region
21473     *
21474     * If that size was not set previously, with
21475     * elm_progressbar_span_size_set(), this call will return @c 0.
21476     *
21477     * @ingroup Progressbar
21478     */
21479    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21480
21481    /**
21482     * Set the format string for a given progress bar widget's units
21483     * label
21484     *
21485     * @param obj The progress bar object
21486     * @param format The format string for @p obj's units label
21487     *
21488     * If @c NULL is passed on @p format, it will make @p obj's units
21489     * area to be hidden completely. If not, it'll set the <b>format
21490     * string</b> for the units label's @b text. The units label is
21491     * provided a floating point value, so the units text is up display
21492     * at most one floating point falue. Note that the units label is
21493     * optional. Use a format string such as "%1.2f meters" for
21494     * example.
21495     *
21496     * @note The default format string for a progress bar is an integer
21497     * percentage, as in @c "%.0f %%".
21498     *
21499     * @see elm_progressbar_unit_format_get()
21500     *
21501     * @ingroup Progressbar
21502     */
21503    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21504
21505    /**
21506     * Retrieve the format string set for a given progress bar widget's
21507     * units label
21508     *
21509     * @param obj The progress bar object
21510     * @return The format set string for @p obj's units label or
21511     * @c NULL, if none was set (and on errors)
21512     *
21513     * @see elm_progressbar_unit_format_set() for more details
21514     *
21515     * @ingroup Progressbar
21516     */
21517    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21518
21519    /**
21520     * Set the orientation of a given progress bar widget
21521     *
21522     * @param obj The progress bar object
21523     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21524     * @b horizontal, @c EINA_FALSE to make it @b vertical
21525     *
21526     * Use this function to change how your progress bar is to be
21527     * disposed: vertically or horizontally.
21528     *
21529     * @see elm_progressbar_horizontal_get()
21530     *
21531     * @ingroup Progressbar
21532     */
21533    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21534
21535    /**
21536     * Retrieve the orientation of a given progress bar widget
21537     *
21538     * @param obj The progress bar object
21539     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21540     * @c EINA_FALSE if it's @b vertical (and on errors)
21541     *
21542     * @see elm_progressbar_horizontal_set() for more details
21543     *
21544     * @ingroup Progressbar
21545     */
21546    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21547
21548    /**
21549     * Invert a given progress bar widget's displaying values order
21550     *
21551     * @param obj The progress bar object
21552     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21553     * @c EINA_FALSE to bring it back to default, non-inverted values.
21554     *
21555     * A progress bar may be @b inverted, in which state it gets its
21556     * values inverted, with high values being on the left or top and
21557     * low values on the right or bottom, as opposed to normally have
21558     * the low values on the former and high values on the latter,
21559     * respectively, for horizontal and vertical modes.
21560     *
21561     * @see elm_progressbar_inverted_get()
21562     *
21563     * @ingroup Progressbar
21564     */
21565    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21566
21567    /**
21568     * Get whether a given progress bar widget's displaying values are
21569     * inverted or not
21570     *
21571     * @param obj The progress bar object
21572     * @return @c EINA_TRUE, if @p obj has inverted values,
21573     * @c EINA_FALSE otherwise (and on errors)
21574     *
21575     * @see elm_progressbar_inverted_set() for more details
21576     *
21577     * @ingroup Progressbar
21578     */
21579    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21580
21581    /**
21582     * @defgroup Separator Separator
21583     *
21584     * @brief Separator is a very thin object used to separate other objects.
21585     *
21586     * A separator can be vertical or horizontal.
21587     *
21588     * @ref tutorial_separator is a good example of how to use a separator.
21589     * @{
21590     */
21591    /**
21592     * @brief Add a separator object to @p parent
21593     *
21594     * @param parent The parent object
21595     *
21596     * @return The separator object, or NULL upon failure
21597     */
21598    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21599    /**
21600     * @brief Set the horizontal mode of a separator object
21601     *
21602     * @param obj The separator object
21603     * @param horizontal If true, the separator is horizontal
21604     */
21605    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21606    /**
21607     * @brief Get the horizontal mode of a separator object
21608     *
21609     * @param obj The separator object
21610     * @return If true, the separator is horizontal
21611     *
21612     * @see elm_separator_horizontal_set()
21613     */
21614    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21615    /**
21616     * @}
21617     */
21618
21619    /**
21620     * @defgroup Spinner Spinner
21621     * @ingroup Elementary
21622     *
21623     * @image html img/widget/spinner/preview-00.png
21624     * @image latex img/widget/spinner/preview-00.eps
21625     *
21626     * A spinner is a widget which allows the user to increase or decrease
21627     * numeric values using arrow buttons, or edit values directly, clicking
21628     * over it and typing the new value.
21629     *
21630     * By default the spinner will not wrap and has a label
21631     * of "%.0f" (just showing the integer value of the double).
21632     *
21633     * A spinner has a label that is formatted with floating
21634     * point values and thus accepts a printf-style format string, like
21635     * ā€œ%1.2f unitsā€.
21636     *
21637     * It also allows specific values to be replaced by pre-defined labels.
21638     *
21639     * Smart callbacks one can register to:
21640     *
21641     * - "changed" - Whenever the spinner value is changed.
21642     * - "delay,changed" - A short time after the value is changed by the user.
21643     *    This will be called only when the user stops dragging for a very short
21644     *    period or when they release their finger/mouse, so it avoids possibly
21645     *    expensive reactions to the value change.
21646     *
21647     * Available styles for it:
21648     * - @c "default";
21649     * - @c "vertical": up/down buttons at the right side and text left aligned.
21650     *
21651     * Here is an example on its usage:
21652     * @ref spinner_example
21653     */
21654
21655    /**
21656     * @addtogroup Spinner
21657     * @{
21658     */
21659
21660    /**
21661     * Add a new spinner widget to the given parent Elementary
21662     * (container) object.
21663     *
21664     * @param parent The parent object.
21665     * @return a new spinner widget handle or @c NULL, on errors.
21666     *
21667     * This function inserts a new spinner widget on the canvas.
21668     *
21669     * @ingroup Spinner
21670     *
21671     */
21672    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21673
21674    /**
21675     * Set the format string of the displayed label.
21676     *
21677     * @param obj The spinner object.
21678     * @param fmt The format string for the label display.
21679     *
21680     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21681     * string for the label text. The label text is provided a floating point
21682     * value, so the label text can display up to 1 floating point value.
21683     * Note that this is optional.
21684     *
21685     * Use a format string such as "%1.2f meters" for example, and it will
21686     * display values like: "3.14 meters" for a value equal to 3.14159.
21687     *
21688     * Default is "%0.f".
21689     *
21690     * @see elm_spinner_label_format_get()
21691     *
21692     * @ingroup Spinner
21693     */
21694    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21695
21696    /**
21697     * Get the label format of the spinner.
21698     *
21699     * @param obj The spinner object.
21700     * @return The text label format string in UTF-8.
21701     *
21702     * @see elm_spinner_label_format_set() for details.
21703     *
21704     * @ingroup Spinner
21705     */
21706    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21707
21708    /**
21709     * Set the minimum and maximum values for the spinner.
21710     *
21711     * @param obj The spinner object.
21712     * @param min The minimum value.
21713     * @param max The maximum value.
21714     *
21715     * Define the allowed range of values to be selected by the user.
21716     *
21717     * If actual value is less than @p min, it will be updated to @p min. If it
21718     * is bigger then @p max, will be updated to @p max. Actual value can be
21719     * get with elm_spinner_value_get().
21720     *
21721     * By default, min is equal to 0, and max is equal to 100.
21722     *
21723     * @warning Maximum must be greater than minimum.
21724     *
21725     * @see elm_spinner_min_max_get()
21726     *
21727     * @ingroup Spinner
21728     */
21729    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21730
21731    /**
21732     * Get the minimum and maximum values of the spinner.
21733     *
21734     * @param obj The spinner object.
21735     * @param min Pointer where to store the minimum value.
21736     * @param max Pointer where to store the maximum value.
21737     *
21738     * @note If only one value is needed, the other pointer can be passed
21739     * as @c NULL.
21740     *
21741     * @see elm_spinner_min_max_set() for details.
21742     *
21743     * @ingroup Spinner
21744     */
21745    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21746
21747    /**
21748     * Set the step used to increment or decrement the spinner value.
21749     *
21750     * @param obj The spinner object.
21751     * @param step The step value.
21752     *
21753     * This value will be incremented or decremented to the displayed value.
21754     * It will be incremented while the user keep right or top arrow pressed,
21755     * and will be decremented while the user keep left or bottom arrow pressed.
21756     *
21757     * The interval to increment / decrement can be set with
21758     * elm_spinner_interval_set().
21759     *
21760     * By default step value is equal to 1.
21761     *
21762     * @see elm_spinner_step_get()
21763     *
21764     * @ingroup Spinner
21765     */
21766    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21767
21768    /**
21769     * Get the step used to increment or decrement the spinner value.
21770     *
21771     * @param obj The spinner object.
21772     * @return The step value.
21773     *
21774     * @see elm_spinner_step_get() for more details.
21775     *
21776     * @ingroup Spinner
21777     */
21778    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21779
21780    /**
21781     * Set the value the spinner displays.
21782     *
21783     * @param obj The spinner object.
21784     * @param val The value to be displayed.
21785     *
21786     * Value will be presented on the label following format specified with
21787     * elm_spinner_format_set().
21788     *
21789     * @warning The value must to be between min and max values. This values
21790     * are set by elm_spinner_min_max_set().
21791     *
21792     * @see elm_spinner_value_get().
21793     * @see elm_spinner_format_set().
21794     * @see elm_spinner_min_max_set().
21795     *
21796     * @ingroup Spinner
21797     */
21798    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21799
21800    /**
21801     * Get the value displayed by the spinner.
21802     *
21803     * @param obj The spinner object.
21804     * @return The value displayed.
21805     *
21806     * @see elm_spinner_value_set() for details.
21807     *
21808     * @ingroup Spinner
21809     */
21810    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21811
21812    /**
21813     * Set whether the spinner should wrap when it reaches its
21814     * minimum or maximum value.
21815     *
21816     * @param obj The spinner object.
21817     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21818     * disable it.
21819     *
21820     * Disabled by default. If disabled, when the user tries to increment the
21821     * value,
21822     * but displayed value plus step value is bigger than maximum value,
21823     * the spinner
21824     * won't allow it. The same happens when the user tries to decrement it,
21825     * but the value less step is less than minimum value.
21826     *
21827     * When wrap is enabled, in such situations it will allow these changes,
21828     * but will get the value that would be less than minimum and subtracts
21829     * from maximum. Or add the value that would be more than maximum to
21830     * the minimum.
21831     *
21832     * E.g.:
21833     * @li min value = 10
21834     * @li max value = 50
21835     * @li step value = 20
21836     * @li displayed value = 20
21837     *
21838     * When the user decrement value (using left or bottom arrow), it will
21839     * displays @c 40, because max - (min - (displayed - step)) is
21840     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21841     *
21842     * @see elm_spinner_wrap_get().
21843     *
21844     * @ingroup Spinner
21845     */
21846    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21847
21848    /**
21849     * Get whether the spinner should wrap when it reaches its
21850     * minimum or maximum value.
21851     *
21852     * @param obj The spinner object
21853     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21854     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21855     *
21856     * @see elm_spinner_wrap_set() for details.
21857     *
21858     * @ingroup Spinner
21859     */
21860    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21861
21862    /**
21863     * Set whether the spinner can be directly edited by the user or not.
21864     *
21865     * @param obj The spinner object.
21866     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21867     * don't allow users to edit it directly.
21868     *
21869     * Spinner objects can have edition @b disabled, in which state they will
21870     * be changed only by arrows.
21871     * Useful for contexts
21872     * where you don't want your users to interact with it writting the value.
21873     * Specially
21874     * when using special values, the user can see real value instead
21875     * of special label on edition.
21876     *
21877     * It's enabled by default.
21878     *
21879     * @see elm_spinner_editable_get()
21880     *
21881     * @ingroup Spinner
21882     */
21883    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21884
21885    /**
21886     * Get whether the spinner can be directly edited by the user or not.
21887     *
21888     * @param obj The spinner object.
21889     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21890     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21891     *
21892     * @see elm_spinner_editable_set() for details.
21893     *
21894     * @ingroup Spinner
21895     */
21896    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21897
21898    /**
21899     * Set a special string to display in the place of the numerical value.
21900     *
21901     * @param obj The spinner object.
21902     * @param value The value to be replaced.
21903     * @param label The label to be used.
21904     *
21905     * It's useful for cases when a user should select an item that is
21906     * better indicated by a label than a value. For example, weekdays or months.
21907     *
21908     * E.g.:
21909     * @code
21910     * sp = elm_spinner_add(win);
21911     * elm_spinner_min_max_set(sp, 1, 3);
21912     * elm_spinner_special_value_add(sp, 1, "January");
21913     * elm_spinner_special_value_add(sp, 2, "February");
21914     * elm_spinner_special_value_add(sp, 3, "March");
21915     * evas_object_show(sp);
21916     * @endcode
21917     *
21918     * @ingroup Spinner
21919     */
21920    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21921
21922    /**
21923     * Set the interval on time updates for an user mouse button hold
21924     * on spinner widgets' arrows.
21925     *
21926     * @param obj The spinner object.
21927     * @param interval The (first) interval value in seconds.
21928     *
21929     * This interval value is @b decreased while the user holds the
21930     * mouse pointer either incrementing or decrementing spinner's value.
21931     *
21932     * This helps the user to get to a given value distant from the
21933     * current one easier/faster, as it will start to change quicker and
21934     * quicker on mouse button holds.
21935     *
21936     * The calculation for the next change interval value, starting from
21937     * the one set with this call, is the previous interval divided by
21938     * @c 1.05, so it decreases a little bit.
21939     *
21940     * The default starting interval value for automatic changes is
21941     * @c 0.85 seconds.
21942     *
21943     * @see elm_spinner_interval_get()
21944     *
21945     * @ingroup Spinner
21946     */
21947    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21948
21949    /**
21950     * Get the interval on time updates for an user mouse button hold
21951     * on spinner widgets' arrows.
21952     *
21953     * @param obj The spinner object.
21954     * @return The (first) interval value, in seconds, set on it.
21955     *
21956     * @see elm_spinner_interval_set() for more details.
21957     *
21958     * @ingroup Spinner
21959     */
21960    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21961
21962    /**
21963     * @}
21964     */
21965
21966    /**
21967     * @defgroup Index Index
21968     *
21969     * @image html img/widget/index/preview-00.png
21970     * @image latex img/widget/index/preview-00.eps
21971     *
21972     * An index widget gives you an index for fast access to whichever
21973     * group of other UI items one might have. It's a list of text
21974     * items (usually letters, for alphabetically ordered access).
21975     *
21976     * Index widgets are by default hidden and just appear when the
21977     * user clicks over it's reserved area in the canvas. In its
21978     * default theme, it's an area one @ref Fingers "finger" wide on
21979     * the right side of the index widget's container.
21980     *
21981     * When items on the index are selected, smart callbacks get
21982     * called, so that its user can make other container objects to
21983     * show a given area or child object depending on the index item
21984     * selected. You'd probably be using an index together with @ref
21985     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21986     * "general grids".
21987     *
21988     * Smart events one  can add callbacks for are:
21989     * - @c "changed" - When the selected index item changes. @c
21990     *      event_info is the selected item's data pointer.
21991     * - @c "delay,changed" - When the selected index item changes, but
21992     *      after a small idling period. @c event_info is the selected
21993     *      item's data pointer.
21994     * - @c "selected" - When the user releases a mouse button and
21995     *      selects an item. @c event_info is the selected item's data
21996     *      pointer.
21997     * - @c "level,up" - when the user moves a finger from the first
21998     *      level to the second level
21999     * - @c "level,down" - when the user moves a finger from the second
22000     *      level to the first level
22001     *
22002     * The @c "delay,changed" event is so that it'll wait a small time
22003     * before actually reporting those events and, moreover, just the
22004     * last event happening on those time frames will actually be
22005     * reported.
22006     *
22007     * Here are some examples on its usage:
22008     * @li @ref index_example_01
22009     * @li @ref index_example_02
22010     */
22011
22012    /**
22013     * @addtogroup Index
22014     * @{
22015     */
22016
22017    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22018
22019    /**
22020     * Add a new index widget to the given parent Elementary
22021     * (container) object
22022     *
22023     * @param parent The parent object
22024     * @return a new index widget handle or @c NULL, on errors
22025     *
22026     * This function inserts a new index widget on the canvas.
22027     *
22028     * @ingroup Index
22029     */
22030    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22031
22032    /**
22033     * Set whether a given index widget is or not visible,
22034     * programatically.
22035     *
22036     * @param obj The index object
22037     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22038     *
22039     * Not to be confused with visible as in @c evas_object_show() --
22040     * visible with regard to the widget's auto hiding feature.
22041     *
22042     * @see elm_index_active_get()
22043     *
22044     * @ingroup Index
22045     */
22046    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22047
22048    /**
22049     * Get whether a given index widget is currently visible or not.
22050     *
22051     * @param obj The index object
22052     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22053     *
22054     * @see elm_index_active_set() for more details
22055     *
22056     * @ingroup Index
22057     */
22058    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22059
22060    /**
22061     * Set the items level for a given index widget.
22062     *
22063     * @param obj The index object.
22064     * @param level @c 0 or @c 1, the currently implemented levels.
22065     *
22066     * @see elm_index_item_level_get()
22067     *
22068     * @ingroup Index
22069     */
22070    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22071
22072    /**
22073     * Get the items level set for a given index widget.
22074     *
22075     * @param obj The index object.
22076     * @return @c 0 or @c 1, which are the levels @p obj might be at.
22077     *
22078     * @see elm_index_item_level_set() for more information
22079     *
22080     * @ingroup Index
22081     */
22082    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22083
22084    /**
22085     * Returns the last selected item's data, for a given index widget.
22086     *
22087     * @param obj The index object.
22088     * @return The item @b data associated to the last selected item on
22089     * @p obj (or @c NULL, on errors).
22090     *
22091     * @warning The returned value is @b not an #Elm_Index_Item item
22092     * handle, but the data associated to it (see the @c item parameter
22093     * in elm_index_item_append(), as an example).
22094     *
22095     * @ingroup Index
22096     */
22097    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22098
22099    /**
22100     * Append a new item on a given index widget.
22101     *
22102     * @param obj The index object.
22103     * @param letter Letter under which the item should be indexed
22104     * @param item The item data to set for the index's item
22105     *
22106     * Despite the most common usage of the @p letter argument is for
22107     * single char strings, one could use arbitrary strings as index
22108     * entries.
22109     *
22110     * @c item will be the pointer returned back on @c "changed", @c
22111     * "delay,changed" and @c "selected" smart events.
22112     *
22113     * @ingroup Index
22114     */
22115    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22116
22117    /**
22118     * Prepend a new item on a given index widget.
22119     *
22120     * @param obj The index object.
22121     * @param letter Letter under which the item should be indexed
22122     * @param item The item data to set for the index's item
22123     *
22124     * Despite the most common usage of the @p letter argument is for
22125     * single char strings, one could use arbitrary strings as index
22126     * entries.
22127     *
22128     * @c item will be the pointer returned back on @c "changed", @c
22129     * "delay,changed" and @c "selected" smart events.
22130     *
22131     * @ingroup Index
22132     */
22133    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22134
22135    /**
22136     * Append a new item, on a given index widget, <b>after the item
22137     * having @p relative as data</b>.
22138     *
22139     * @param obj The index object.
22140     * @param letter Letter under which the item should be indexed
22141     * @param item The item data to set for the index's item
22142     * @param relative The item data of the index item to be the
22143     * predecessor of this new one
22144     *
22145     * Despite the most common usage of the @p letter argument is for
22146     * single char strings, one could use arbitrary strings as index
22147     * entries.
22148     *
22149     * @c item will be the pointer returned back on @c "changed", @c
22150     * "delay,changed" and @c "selected" smart events.
22151     *
22152     * @note If @p relative is @c NULL or if it's not found to be data
22153     * set on any previous item on @p obj, this function will behave as
22154     * elm_index_item_append().
22155     *
22156     * @ingroup Index
22157     */
22158    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22159
22160    /**
22161     * Prepend a new item, on a given index widget, <b>after the item
22162     * having @p relative as data</b>.
22163     *
22164     * @param obj The index object.
22165     * @param letter Letter under which the item should be indexed
22166     * @param item The item data to set for the index's item
22167     * @param relative The item data of the index item to be the
22168     * successor of this new one
22169     *
22170     * Despite the most common usage of the @p letter argument is for
22171     * single char strings, one could use arbitrary strings as index
22172     * entries.
22173     *
22174     * @c item will be the pointer returned back on @c "changed", @c
22175     * "delay,changed" and @c "selected" smart events.
22176     *
22177     * @note If @p relative is @c NULL or if it's not found to be data
22178     * set on any previous item on @p obj, this function will behave as
22179     * elm_index_item_prepend().
22180     *
22181     * @ingroup Index
22182     */
22183    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22184
22185    /**
22186     * Insert a new item into the given index widget, using @p cmp_func
22187     * function to sort items (by item handles).
22188     *
22189     * @param obj The index object.
22190     * @param letter Letter under which the item should be indexed
22191     * @param item The item data to set for the index's item
22192     * @param cmp_func The comparing function to be used to sort index
22193     * items <b>by #Elm_Index_Item item handles</b>
22194     * @param cmp_data_func A @b fallback function to be called for the
22195     * sorting of index items <b>by item data</b>). It will be used
22196     * when @p cmp_func returns @c 0 (equality), which means an index
22197     * item with provided item data already exists. To decide which
22198     * data item should be pointed to by the index item in question, @p
22199     * cmp_data_func will be used. If @p cmp_data_func returns a
22200     * non-negative value, the previous index item data will be
22201     * replaced by the given @p item pointer. If the previous data need
22202     * to be freed, it should be done by the @p cmp_data_func function,
22203     * because all references to it will be lost. If this function is
22204     * not provided (@c NULL is given), index items will be @b
22205     * duplicated, if @p cmp_func returns @c 0.
22206     *
22207     * Despite the most common usage of the @p letter argument is for
22208     * single char strings, one could use arbitrary strings as index
22209     * entries.
22210     *
22211     * @c item will be the pointer returned back on @c "changed", @c
22212     * "delay,changed" and @c "selected" smart events.
22213     *
22214     * @ingroup Index
22215     */
22216    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);
22217
22218    /**
22219     * Remove an item from a given index widget, <b>to be referenced by
22220     * it's data value</b>.
22221     *
22222     * @param obj The index object
22223     * @param item The item's data pointer for the item to be removed
22224     * from @p obj
22225     *
22226     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22227     * that callback function will be called by this one.
22228     *
22229     * @warning The item to be removed from @p obj will be found via
22230     * its item data pointer, and not by an #Elm_Index_Item handle.
22231     *
22232     * @ingroup Index
22233     */
22234    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22235
22236    /**
22237     * Find a given index widget's item, <b>using item data</b>.
22238     *
22239     * @param obj The index object
22240     * @param item The item data pointed to by the desired index item
22241     * @return The index item handle, if found, or @c NULL otherwise
22242     *
22243     * @ingroup Index
22244     */
22245    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22246
22247    /**
22248     * Removes @b all items from a given index widget.
22249     *
22250     * @param obj The index object.
22251     *
22252     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22253     * that callback function will be called for each item in @p obj.
22254     *
22255     * @ingroup Index
22256     */
22257    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22258
22259    /**
22260     * Go to a given items level on a index widget
22261     *
22262     * @param obj The index object
22263     * @param level The index level (one of @c 0 or @c 1)
22264     *
22265     * @ingroup Index
22266     */
22267    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22268
22269    /**
22270     * Return the data associated with a given index widget item
22271     *
22272     * @param it The index widget item handle
22273     * @return The data associated with @p it
22274     *
22275     * @see elm_index_item_data_set()
22276     *
22277     * @ingroup Index
22278     */
22279    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22280
22281    /**
22282     * Set the data associated with a given index widget item
22283     *
22284     * @param it The index widget item handle
22285     * @param data The new data pointer to set to @p it
22286     *
22287     * This sets new item data on @p it.
22288     *
22289     * @warning The old data pointer won't be touched by this function, so
22290     * the user had better to free that old data himself/herself.
22291     *
22292     * @ingroup Index
22293     */
22294    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22295
22296    /**
22297     * Set the function to be called when a given index widget item is freed.
22298     *
22299     * @param it The item to set the callback on
22300     * @param func The function to call on the item's deletion
22301     *
22302     * When called, @p func will have both @c data and @c event_info
22303     * arguments with the @p it item's data value and, naturally, the
22304     * @c obj argument with a handle to the parent index widget.
22305     *
22306     * @ingroup Index
22307     */
22308    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22309
22310    /**
22311     * Get the letter (string) set on a given index widget item.
22312     *
22313     * @param it The index item handle
22314     * @return The letter string set on @p it
22315     *
22316     * @ingroup Index
22317     */
22318    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22319
22320    /**
22321     * @}
22322     */
22323
22324    /**
22325     * @defgroup Photocam Photocam
22326     *
22327     * @image html img/widget/photocam/preview-00.png
22328     * @image latex img/widget/photocam/preview-00.eps
22329     *
22330     * This is a widget specifically for displaying high-resolution digital
22331     * camera photos giving speedy feedback (fast load), low memory footprint
22332     * and zooming and panning as well as fitting logic. It is entirely focused
22333     * on jpeg images, and takes advantage of properties of the jpeg format (via
22334     * evas loader features in the jpeg loader).
22335     *
22336     * Signals that you can add callbacks for are:
22337     * @li "clicked" - This is called when a user has clicked the photo without
22338     *                 dragging around.
22339     * @li "press" - This is called when a user has pressed down on the photo.
22340     * @li "longpressed" - This is called when a user has pressed down on the
22341     *                     photo for a long time without dragging around.
22342     * @li "clicked,double" - This is called when a user has double-clicked the
22343     *                        photo.
22344     * @li "load" - Photo load begins.
22345     * @li "loaded" - This is called when the image file load is complete for the
22346     *                first view (low resolution blurry version).
22347     * @li "load,detail" - Photo detailed data load begins.
22348     * @li "loaded,detail" - This is called when the image file load is complete
22349     *                      for the detailed image data (full resolution needed).
22350     * @li "zoom,start" - Zoom animation started.
22351     * @li "zoom,stop" - Zoom animation stopped.
22352     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22353     * @li "scroll" - the content has been scrolled (moved)
22354     * @li "scroll,anim,start" - scrolling animation has started
22355     * @li "scroll,anim,stop" - scrolling animation has stopped
22356     * @li "scroll,drag,start" - dragging the contents around has started
22357     * @li "scroll,drag,stop" - dragging the contents around has stopped
22358     *
22359     * @ref tutorial_photocam shows the API in action.
22360     * @{
22361     */
22362    /**
22363     * @brief Types of zoom available.
22364     */
22365    typedef enum _Elm_Photocam_Zoom_Mode
22366      {
22367         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22368         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22369         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22370         ELM_PHOTOCAM_ZOOM_MODE_LAST
22371      } Elm_Photocam_Zoom_Mode;
22372    /**
22373     * @brief Add a new Photocam object
22374     *
22375     * @param parent The parent object
22376     * @return The new object or NULL if it cannot be created
22377     */
22378    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22379    /**
22380     * @brief Set the photo file to be shown
22381     *
22382     * @param obj The photocam object
22383     * @param file The photo file
22384     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22385     *
22386     * This sets (and shows) the specified file (with a relative or absolute
22387     * path) and will return a load error (same error that
22388     * evas_object_image_load_error_get() will return). The image will change and
22389     * adjust its size at this point and begin a background load process for this
22390     * photo that at some time in the future will be displayed at the full
22391     * quality needed.
22392     */
22393    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22394    /**
22395     * @brief Returns the path of the current image file
22396     *
22397     * @param obj The photocam object
22398     * @return Returns the path
22399     *
22400     * @see elm_photocam_file_set()
22401     */
22402    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22403    /**
22404     * @brief Set the zoom level of the photo
22405     *
22406     * @param obj The photocam object
22407     * @param zoom The zoom level to set
22408     *
22409     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22410     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22411     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22412     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22413     * 16, 32, etc.).
22414     */
22415    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22416    /**
22417     * @brief Get the zoom level of the photo
22418     *
22419     * @param obj The photocam object
22420     * @return The current zoom level
22421     *
22422     * This returns the current zoom level of the photocam object. Note that if
22423     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22424     * (which is the default), the zoom level may be changed at any time by the
22425     * photocam object itself to account for photo size and photocam viewpoer
22426     * size.
22427     *
22428     * @see elm_photocam_zoom_set()
22429     * @see elm_photocam_zoom_mode_set()
22430     */
22431    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22432    /**
22433     * @brief Set the zoom mode
22434     *
22435     * @param obj The photocam object
22436     * @param mode The desired mode
22437     *
22438     * This sets the zoom mode to manual or one of several automatic levels.
22439     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22440     * elm_photocam_zoom_set() and will stay at that level until changed by code
22441     * or until zoom mode is changed. This is the default mode. The Automatic
22442     * modes will allow the photocam object to automatically adjust zoom mode
22443     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22444     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22445     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22446     * pixels within the frame are left unfilled.
22447     */
22448    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22449    /**
22450     * @brief Get the zoom mode
22451     *
22452     * @param obj The photocam object
22453     * @return The current zoom mode
22454     *
22455     * This gets the current zoom mode of the photocam object.
22456     *
22457     * @see elm_photocam_zoom_mode_set()
22458     */
22459    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22460    /**
22461     * @brief Get the current image pixel width and height
22462     *
22463     * @param obj The photocam object
22464     * @param w A pointer to the width return
22465     * @param h A pointer to the height return
22466     *
22467     * This gets the current photo pixel width and height (for the original).
22468     * The size will be returned in the integers @p w and @p h that are pointed
22469     * to.
22470     */
22471    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22472    /**
22473     * @brief Get the area of the image that is currently shown
22474     *
22475     * @param obj
22476     * @param x A pointer to the X-coordinate of region
22477     * @param y A pointer to the Y-coordinate of region
22478     * @param w A pointer to the width
22479     * @param h A pointer to the height
22480     *
22481     * @see elm_photocam_image_region_show()
22482     * @see elm_photocam_image_region_bring_in()
22483     */
22484    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22485    /**
22486     * @brief Set the viewed portion of the image
22487     *
22488     * @param obj The photocam object
22489     * @param x X-coordinate of region in image original pixels
22490     * @param y Y-coordinate of region in image original pixels
22491     * @param w Width of region in image original pixels
22492     * @param h Height of region in image original pixels
22493     *
22494     * This shows the region of the image without using animation.
22495     */
22496    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22497    /**
22498     * @brief Bring in the viewed portion of the image
22499     *
22500     * @param obj The photocam object
22501     * @param x X-coordinate of region in image original pixels
22502     * @param y Y-coordinate of region in image original pixels
22503     * @param w Width of region in image original pixels
22504     * @param h Height of region in image original pixels
22505     *
22506     * This shows the region of the image using animation.
22507     */
22508    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22509    /**
22510     * @brief Set the paused state for photocam
22511     *
22512     * @param obj The photocam object
22513     * @param paused The pause state to set
22514     *
22515     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22516     * photocam. The default is off. This will stop zooming using animation on
22517     * zoom levels changes and change instantly. This will stop any existing
22518     * animations that are running.
22519     */
22520    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22521    /**
22522     * @brief Get the paused state for photocam
22523     *
22524     * @param obj The photocam object
22525     * @return The current paused state
22526     *
22527     * This gets the current paused state for the photocam object.
22528     *
22529     * @see elm_photocam_paused_set()
22530     */
22531    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22532    /**
22533     * @brief Get the internal low-res image used for photocam
22534     *
22535     * @param obj The photocam object
22536     * @return The internal image object handle, or NULL if none exists
22537     *
22538     * This gets the internal image object inside photocam. Do not modify it. It
22539     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22540     * deleted at any time as well.
22541     */
22542    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22543    /**
22544     * @brief Set the photocam scrolling bouncing.
22545     *
22546     * @param obj The photocam object
22547     * @param h_bounce bouncing for horizontal
22548     * @param v_bounce bouncing for vertical
22549     */
22550    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22551    /**
22552     * @brief Get the photocam scrolling bouncing.
22553     *
22554     * @param obj The photocam object
22555     * @param h_bounce bouncing for horizontal
22556     * @param v_bounce bouncing for vertical
22557     *
22558     * @see elm_photocam_bounce_set()
22559     */
22560    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22561    /**
22562     * @}
22563     */
22564
22565    /**
22566     * @defgroup Map Map
22567     * @ingroup Elementary
22568     *
22569     * @image html img/widget/map/preview-00.png
22570     * @image latex img/widget/map/preview-00.eps
22571     *
22572     * This is a widget specifically for displaying a map. It uses basically
22573     * OpenStreetMap provider http://www.openstreetmap.org/,
22574     * but custom providers can be added.
22575     *
22576     * It supports some basic but yet nice features:
22577     * @li zoom and scroll
22578     * @li markers with content to be displayed when user clicks over it
22579     * @li group of markers
22580     * @li routes
22581     *
22582     * Smart callbacks one can listen to:
22583     *
22584     * - "clicked" - This is called when a user has clicked the map without
22585     *   dragging around.
22586     * - "press" - This is called when a user has pressed down on the map.
22587     * - "longpressed" - This is called when a user has pressed down on the map
22588     *   for a long time without dragging around.
22589     * - "clicked,double" - This is called when a user has double-clicked
22590     *   the map.
22591     * - "load,detail" - Map detailed data load begins.
22592     * - "loaded,detail" - This is called when all currently visible parts of
22593     *   the map are loaded.
22594     * - "zoom,start" - Zoom animation started.
22595     * - "zoom,stop" - Zoom animation stopped.
22596     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22597     * - "scroll" - the content has been scrolled (moved).
22598     * - "scroll,anim,start" - scrolling animation has started.
22599     * - "scroll,anim,stop" - scrolling animation has stopped.
22600     * - "scroll,drag,start" - dragging the contents around has started.
22601     * - "scroll,drag,stop" - dragging the contents around has stopped.
22602     * - "downloaded" - This is called when all currently required map images
22603     *   are downloaded.
22604     * - "route,load" - This is called when route request begins.
22605     * - "route,loaded" - This is called when route request ends.
22606     * - "name,load" - This is called when name request begins.
22607     * - "name,loaded- This is called when name request ends.
22608     *
22609     * Available style for map widget:
22610     * - @c "default"
22611     *
22612     * Available style for markers:
22613     * - @c "radio"
22614     * - @c "radio2"
22615     * - @c "empty"
22616     *
22617     * Available style for marker bubble:
22618     * - @c "default"
22619     *
22620     * List of examples:
22621     * @li @ref map_example_01
22622     * @li @ref map_example_02
22623     * @li @ref map_example_03
22624     */
22625
22626    /**
22627     * @addtogroup Map
22628     * @{
22629     */
22630
22631    /**
22632     * @enum _Elm_Map_Zoom_Mode
22633     * @typedef Elm_Map_Zoom_Mode
22634     *
22635     * Set map's zoom behavior. It can be set to manual or automatic.
22636     *
22637     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22638     *
22639     * Values <b> don't </b> work as bitmask, only one can be choosen.
22640     *
22641     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22642     * than the scroller view.
22643     *
22644     * @see elm_map_zoom_mode_set()
22645     * @see elm_map_zoom_mode_get()
22646     *
22647     * @ingroup Map
22648     */
22649    typedef enum _Elm_Map_Zoom_Mode
22650      {
22651         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22652         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22653         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22654         ELM_MAP_ZOOM_MODE_LAST
22655      } Elm_Map_Zoom_Mode;
22656
22657    /**
22658     * @enum _Elm_Map_Route_Sources
22659     * @typedef Elm_Map_Route_Sources
22660     *
22661     * Set route service to be used. By default used source is
22662     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22663     *
22664     * @see elm_map_route_source_set()
22665     * @see elm_map_route_source_get()
22666     *
22667     * @ingroup Map
22668     */
22669    typedef enum _Elm_Map_Route_Sources
22670      {
22671         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22672         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. */
22673         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22674         ELM_MAP_ROUTE_SOURCE_LAST
22675      } Elm_Map_Route_Sources;
22676
22677    typedef enum _Elm_Map_Name_Sources
22678      {
22679         ELM_MAP_NAME_SOURCE_NOMINATIM,
22680         ELM_MAP_NAME_SOURCE_LAST
22681      } Elm_Map_Name_Sources;
22682
22683    /**
22684     * @enum _Elm_Map_Route_Type
22685     * @typedef Elm_Map_Route_Type
22686     *
22687     * Set type of transport used on route.
22688     *
22689     * @see elm_map_route_add()
22690     *
22691     * @ingroup Map
22692     */
22693    typedef enum _Elm_Map_Route_Type
22694      {
22695         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22696         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22697         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22698         ELM_MAP_ROUTE_TYPE_LAST
22699      } Elm_Map_Route_Type;
22700
22701    /**
22702     * @enum _Elm_Map_Route_Method
22703     * @typedef Elm_Map_Route_Method
22704     *
22705     * Set the routing method, what should be priorized, time or distance.
22706     *
22707     * @see elm_map_route_add()
22708     *
22709     * @ingroup Map
22710     */
22711    typedef enum _Elm_Map_Route_Method
22712      {
22713         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22714         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22715         ELM_MAP_ROUTE_METHOD_LAST
22716      } Elm_Map_Route_Method;
22717
22718    typedef enum _Elm_Map_Name_Method
22719      {
22720         ELM_MAP_NAME_METHOD_SEARCH,
22721         ELM_MAP_NAME_METHOD_REVERSE,
22722         ELM_MAP_NAME_METHOD_LAST
22723      } Elm_Map_Name_Method;
22724
22725    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(). */
22726    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(). */
22727    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(). */
22728    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(). */
22729    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22730    typedef struct _Elm_Map_Track           Elm_Map_Track;
22731
22732    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. */
22733    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22734    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22735    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22736
22737    typedef char        *(*ElmMapModuleSourceFunc) (void);
22738    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22739    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22740    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22741    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22742    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22743    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22744    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22745    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22746
22747    /**
22748     * Add a new map widget to the given parent Elementary (container) object.
22749     *
22750     * @param parent The parent object.
22751     * @return a new map widget handle or @c NULL, on errors.
22752     *
22753     * This function inserts a new map widget on the canvas.
22754     *
22755     * @ingroup Map
22756     */
22757    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22758
22759    /**
22760     * Set the zoom level of the map.
22761     *
22762     * @param obj The map object.
22763     * @param zoom The zoom level to set.
22764     *
22765     * This sets the zoom level.
22766     *
22767     * It will respect limits defined by elm_map_source_zoom_min_set() and
22768     * elm_map_source_zoom_max_set().
22769     *
22770     * By default these values are 0 (world map) and 18 (maximum zoom).
22771     *
22772     * This function should be used when zoom mode is set to
22773     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22774     * with elm_map_zoom_mode_set().
22775     *
22776     * @see elm_map_zoom_mode_set().
22777     * @see elm_map_zoom_get().
22778     *
22779     * @ingroup Map
22780     */
22781    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22782
22783    /**
22784     * Get the zoom level of the map.
22785     *
22786     * @param obj The map object.
22787     * @return The current zoom level.
22788     *
22789     * This returns the current zoom level of the map object.
22790     *
22791     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22792     * (which is the default), the zoom level may be changed at any time by the
22793     * map object itself to account for map size and map viewport size.
22794     *
22795     * @see elm_map_zoom_set() for details.
22796     *
22797     * @ingroup Map
22798     */
22799    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22800
22801    /**
22802     * Set the zoom mode used by the map object.
22803     *
22804     * @param obj The map object.
22805     * @param mode The zoom mode of the map, being it one of
22806     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22807     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22808     *
22809     * This sets the zoom mode to manual or one of the automatic levels.
22810     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22811     * elm_map_zoom_set() and will stay at that level until changed by code
22812     * or until zoom mode is changed. This is the default mode.
22813     *
22814     * The Automatic modes will allow the map object to automatically
22815     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22816     * adjust zoom so the map fits inside the scroll frame with no pixels
22817     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22818     * ensure no pixels within the frame are left unfilled. Do not forget that
22819     * the valid sizes are 2^zoom, consequently the map may be smaller than
22820     * the scroller view.
22821     *
22822     * @see elm_map_zoom_set()
22823     *
22824     * @ingroup Map
22825     */
22826    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22827
22828    /**
22829     * Get the zoom mode used by the map object.
22830     *
22831     * @param obj The map object.
22832     * @return The zoom mode of the map, being it one of
22833     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22834     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22835     *
22836     * This function returns the current zoom mode used by the map object.
22837     *
22838     * @see elm_map_zoom_mode_set() for more details.
22839     *
22840     * @ingroup Map
22841     */
22842    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22843
22844    /**
22845     * Get the current coordinates of the map.
22846     *
22847     * @param obj The map object.
22848     * @param lon Pointer where to store longitude.
22849     * @param lat Pointer where to store latitude.
22850     *
22851     * This gets the current center coordinates of the map object. It can be
22852     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22853     *
22854     * @see elm_map_geo_region_bring_in()
22855     * @see elm_map_geo_region_show()
22856     *
22857     * @ingroup Map
22858     */
22859    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22860
22861    /**
22862     * Animatedly bring in given coordinates to the center of the map.
22863     *
22864     * @param obj The map object.
22865     * @param lon Longitude to center at.
22866     * @param lat Latitude to center at.
22867     *
22868     * This causes map to jump to the given @p lat and @p lon coordinates
22869     * and show it (by scrolling) in the center of the viewport, if it is not
22870     * already centered. This will use animation to do so and take a period
22871     * of time to complete.
22872     *
22873     * @see elm_map_geo_region_show() for a function to avoid animation.
22874     * @see elm_map_geo_region_get()
22875     *
22876     * @ingroup Map
22877     */
22878    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22879
22880    /**
22881     * Show the given coordinates at the center of the map, @b immediately.
22882     *
22883     * @param obj The map object.
22884     * @param lon Longitude to center at.
22885     * @param lat Latitude to center at.
22886     *
22887     * This causes map to @b redraw its viewport's contents to the
22888     * region contining the given @p lat and @p lon, that will be moved to the
22889     * center of the map.
22890     *
22891     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22892     * @see elm_map_geo_region_get()
22893     *
22894     * @ingroup Map
22895     */
22896    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22897
22898    /**
22899     * Pause or unpause the map.
22900     *
22901     * @param obj The map object.
22902     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22903     * to unpause it.
22904     *
22905     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22906     * for map.
22907     *
22908     * The default is off.
22909     *
22910     * This will stop zooming using animation, changing zoom levels will
22911     * change instantly. This will stop any existing animations that are running.
22912     *
22913     * @see elm_map_paused_get()
22914     *
22915     * @ingroup Map
22916     */
22917    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22918
22919    /**
22920     * Get a value whether map is paused or not.
22921     *
22922     * @param obj The map object.
22923     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22924     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22925     *
22926     * This gets the current paused state for the map object.
22927     *
22928     * @see elm_map_paused_set() for details.
22929     *
22930     * @ingroup Map
22931     */
22932    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22933
22934    /**
22935     * Set to show markers during zoom level changes or not.
22936     *
22937     * @param obj The map object.
22938     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22939     * to show them.
22940     *
22941     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22942     * for map.
22943     *
22944     * The default is off.
22945     *
22946     * This will stop zooming using animation, changing zoom levels will
22947     * change instantly. This will stop any existing animations that are running.
22948     *
22949     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22950     * for the markers.
22951     *
22952     * The default  is off.
22953     *
22954     * Enabling it will force the map to stop displaying the markers during
22955     * zoom level changes. Set to on if you have a large number of markers.
22956     *
22957     * @see elm_map_paused_markers_get()
22958     *
22959     * @ingroup Map
22960     */
22961    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22962
22963    /**
22964     * Get a value whether markers will be displayed on zoom level changes or not
22965     *
22966     * @param obj The map object.
22967     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22968     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22969     *
22970     * This gets the current markers paused state for the map object.
22971     *
22972     * @see elm_map_paused_markers_set() for details.
22973     *
22974     * @ingroup Map
22975     */
22976    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22977
22978    /**
22979     * Get the information of downloading status.
22980     *
22981     * @param obj The map object.
22982     * @param try_num Pointer where to store number of tiles being downloaded.
22983     * @param finish_num Pointer where to store number of tiles successfully
22984     * downloaded.
22985     *
22986     * This gets the current downloading status for the map object, the number
22987     * of tiles being downloaded and the number of tiles already downloaded.
22988     *
22989     * @ingroup Map
22990     */
22991    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22992
22993    /**
22994     * Convert a pixel coordinate (x,y) into a geographic coordinate
22995     * (longitude, latitude).
22996     *
22997     * @param obj The map object.
22998     * @param x the coordinate.
22999     * @param y the coordinate.
23000     * @param size the size in pixels of the map.
23001     * The map is a square and generally his size is : pow(2.0, zoom)*256.
23002     * @param lon Pointer where to store the longitude that correspond to x.
23003     * @param lat Pointer where to store the latitude that correspond to y.
23004     *
23005     * @note Origin pixel point is the top left corner of the viewport.
23006     * Map zoom and size are taken on account.
23007     *
23008     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23009     *
23010     * @ingroup Map
23011     */
23012    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);
23013
23014    /**
23015     * Convert a geographic coordinate (longitude, latitude) into a pixel
23016     * coordinate (x, y).
23017     *
23018     * @param obj The map object.
23019     * @param lon the longitude.
23020     * @param lat the latitude.
23021     * @param size the size in pixels of the map. The map is a square
23022     * and generally his size is : pow(2.0, zoom)*256.
23023     * @param x Pointer where to store the horizontal pixel coordinate that
23024     * correspond to the longitude.
23025     * @param y Pointer where to store the vertical pixel coordinate that
23026     * correspond to the latitude.
23027     *
23028     * @note Origin pixel point is the top left corner of the viewport.
23029     * Map zoom and size are taken on account.
23030     *
23031     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23032     *
23033     * @ingroup Map
23034     */
23035    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);
23036
23037    /**
23038     * Convert a geographic coordinate (longitude, latitude) into a name
23039     * (address).
23040     *
23041     * @param obj The map object.
23042     * @param lon the longitude.
23043     * @param lat the latitude.
23044     * @return name A #Elm_Map_Name handle for this coordinate.
23045     *
23046     * To get the string for this address, elm_map_name_address_get()
23047     * should be used.
23048     *
23049     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23050     *
23051     * @ingroup Map
23052     */
23053    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23054
23055    /**
23056     * Convert a name (address) into a geographic coordinate
23057     * (longitude, latitude).
23058     *
23059     * @param obj The map object.
23060     * @param name The address.
23061     * @return name A #Elm_Map_Name handle for this address.
23062     *
23063     * To get the longitude and latitude, elm_map_name_region_get()
23064     * should be used.
23065     *
23066     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23067     *
23068     * @ingroup Map
23069     */
23070    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23071
23072    /**
23073     * Convert a pixel coordinate into a rotated pixel coordinate.
23074     *
23075     * @param obj The map object.
23076     * @param x horizontal coordinate of the point to rotate.
23077     * @param y vertical coordinate of the point to rotate.
23078     * @param cx rotation's center horizontal position.
23079     * @param cy rotation's center vertical position.
23080     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23081     * @param xx Pointer where to store rotated x.
23082     * @param yy Pointer where to store rotated y.
23083     *
23084     * @ingroup Map
23085     */
23086    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);
23087
23088    /**
23089     * Add a new marker to the map object.
23090     *
23091     * @param obj The map object.
23092     * @param lon The longitude of the marker.
23093     * @param lat The latitude of the marker.
23094     * @param clas The class, to use when marker @b isn't grouped to others.
23095     * @param clas_group The class group, to use when marker is grouped to others
23096     * @param data The data passed to the callbacks.
23097     *
23098     * @return The created marker or @c NULL upon failure.
23099     *
23100     * A marker will be created and shown in a specific point of the map, defined
23101     * by @p lon and @p lat.
23102     *
23103     * It will be displayed using style defined by @p class when this marker
23104     * is displayed alone (not grouped). A new class can be created with
23105     * elm_map_marker_class_new().
23106     *
23107     * If the marker is grouped to other markers, it will be displayed with
23108     * style defined by @p class_group. Markers with the same group are grouped
23109     * if they are close. A new group class can be created with
23110     * elm_map_marker_group_class_new().
23111     *
23112     * Markers created with this method can be deleted with
23113     * elm_map_marker_remove().
23114     *
23115     * A marker can have associated content to be displayed by a bubble,
23116     * when a user click over it, as well as an icon. These objects will
23117     * be fetch using class' callback functions.
23118     *
23119     * @see elm_map_marker_class_new()
23120     * @see elm_map_marker_group_class_new()
23121     * @see elm_map_marker_remove()
23122     *
23123     * @ingroup Map
23124     */
23125    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);
23126
23127    /**
23128     * Set the maximum numbers of markers' content to be displayed in a group.
23129     *
23130     * @param obj The map object.
23131     * @param max The maximum numbers of items displayed in a bubble.
23132     *
23133     * A bubble will be displayed when the user clicks over the group,
23134     * and will place the content of markers that belong to this group
23135     * inside it.
23136     *
23137     * A group can have a long list of markers, consequently the creation
23138     * of the content of the bubble can be very slow.
23139     *
23140     * In order to avoid this, a maximum number of items is displayed
23141     * in a bubble.
23142     *
23143     * By default this number is 30.
23144     *
23145     * Marker with the same group class are grouped if they are close.
23146     *
23147     * @see elm_map_marker_add()
23148     *
23149     * @ingroup Map
23150     */
23151    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23152
23153    /**
23154     * Remove a marker from the map.
23155     *
23156     * @param marker The marker to remove.
23157     *
23158     * @see elm_map_marker_add()
23159     *
23160     * @ingroup Map
23161     */
23162    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23163
23164    /**
23165     * Get the current coordinates of the marker.
23166     *
23167     * @param marker marker.
23168     * @param lat Pointer where to store the marker's latitude.
23169     * @param lon Pointer where to store the marker's longitude.
23170     *
23171     * These values are set when adding markers, with function
23172     * elm_map_marker_add().
23173     *
23174     * @see elm_map_marker_add()
23175     *
23176     * @ingroup Map
23177     */
23178    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23179
23180    /**
23181     * Animatedly bring in given marker to the center of the map.
23182     *
23183     * @param marker The marker to center at.
23184     *
23185     * This causes map to jump to the given @p marker's coordinates
23186     * and show it (by scrolling) in the center of the viewport, if it is not
23187     * already centered. This will use animation to do so and take a period
23188     * of time to complete.
23189     *
23190     * @see elm_map_marker_show() for a function to avoid animation.
23191     * @see elm_map_marker_region_get()
23192     *
23193     * @ingroup Map
23194     */
23195    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23196
23197    /**
23198     * Show the given marker at the center of the map, @b immediately.
23199     *
23200     * @param marker The marker to center at.
23201     *
23202     * This causes map to @b redraw its viewport's contents to the
23203     * region contining the given @p marker's coordinates, that will be
23204     * moved to the center of the map.
23205     *
23206     * @see elm_map_marker_bring_in() for a function to move with animation.
23207     * @see elm_map_markers_list_show() if more than one marker need to be
23208     * displayed.
23209     * @see elm_map_marker_region_get()
23210     *
23211     * @ingroup Map
23212     */
23213    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23214
23215    /**
23216     * Move and zoom the map to display a list of markers.
23217     *
23218     * @param markers A list of #Elm_Map_Marker handles.
23219     *
23220     * The map will be centered on the center point of the markers in the list.
23221     * Then the map will be zoomed in order to fit the markers using the maximum
23222     * zoom which allows display of all the markers.
23223     *
23224     * @warning All the markers should belong to the same map object.
23225     *
23226     * @see elm_map_marker_show() to show a single marker.
23227     * @see elm_map_marker_bring_in()
23228     *
23229     * @ingroup Map
23230     */
23231    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23232
23233    /**
23234     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23235     *
23236     * @param marker The marker wich content should be returned.
23237     * @return Return the evas object if it exists, else @c NULL.
23238     *
23239     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23240     * elm_map_marker_class_get_cb_set() should be used.
23241     *
23242     * This content is what will be inside the bubble that will be displayed
23243     * when an user clicks over the marker.
23244     *
23245     * This returns the actual Evas object used to be placed inside
23246     * the bubble. This may be @c NULL, as it may
23247     * not have been created or may have been deleted, at any time, by
23248     * the map. <b>Do not modify this object</b> (move, resize,
23249     * show, hide, etc.), as the map is controlling it. This
23250     * function is for querying, emitting custom signals or hooking
23251     * lower level callbacks for events on that object. Do not delete
23252     * this object under any circumstances.
23253     *
23254     * @ingroup Map
23255     */
23256    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23257
23258    /**
23259     * Update the marker
23260     *
23261     * @param marker The marker to be updated.
23262     *
23263     * If a content is set to this marker, it will call function to delete it,
23264     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23265     * #ElmMapMarkerGetFunc.
23266     *
23267     * These functions are set for the marker class with
23268     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23269     *
23270     * @ingroup Map
23271     */
23272    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23273
23274    /**
23275     * Close all the bubbles opened by the user.
23276     *
23277     * @param obj The map object.
23278     *
23279     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23280     * when the user clicks on a marker.
23281     *
23282     * This functions is set for the marker class with
23283     * elm_map_marker_class_get_cb_set().
23284     *
23285     * @ingroup Map
23286     */
23287    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23288
23289    /**
23290     * Create a new group class.
23291     *
23292     * @param obj The map object.
23293     * @return Returns the new group class.
23294     *
23295     * Each marker must be associated to a group class. Markers in the same
23296     * group are grouped if they are close.
23297     *
23298     * The group class defines the style of the marker when a marker is grouped
23299     * to others markers. When it is alone, another class will be used.
23300     *
23301     * A group class will need to be provided when creating a marker with
23302     * elm_map_marker_add().
23303     *
23304     * Some properties and functions can be set by class, as:
23305     * - style, with elm_map_group_class_style_set()
23306     * - data - to be associated to the group class. It can be set using
23307     *   elm_map_group_class_data_set().
23308     * - min zoom to display markers, set with
23309     *   elm_map_group_class_zoom_displayed_set().
23310     * - max zoom to group markers, set using
23311     *   elm_map_group_class_zoom_grouped_set().
23312     * - visibility - set if markers will be visible or not, set with
23313     *   elm_map_group_class_hide_set().
23314     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23315     *   It can be set using elm_map_group_class_icon_cb_set().
23316     *
23317     * @see elm_map_marker_add()
23318     * @see elm_map_group_class_style_set()
23319     * @see elm_map_group_class_data_set()
23320     * @see elm_map_group_class_zoom_displayed_set()
23321     * @see elm_map_group_class_zoom_grouped_set()
23322     * @see elm_map_group_class_hide_set()
23323     * @see elm_map_group_class_icon_cb_set()
23324     *
23325     * @ingroup Map
23326     */
23327    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23328
23329    /**
23330     * Set the marker's style of a group class.
23331     *
23332     * @param clas The group class.
23333     * @param style The style to be used by markers.
23334     *
23335     * Each marker must be associated to a group class, and will use the style
23336     * defined by such class when grouped to other markers.
23337     *
23338     * The following styles are provided by default theme:
23339     * @li @c radio - blue circle
23340     * @li @c radio2 - green circle
23341     * @li @c empty
23342     *
23343     * @see elm_map_group_class_new() for more details.
23344     * @see elm_map_marker_add()
23345     *
23346     * @ingroup Map
23347     */
23348    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23349
23350    /**
23351     * Set the icon callback function of a group class.
23352     *
23353     * @param clas The group class.
23354     * @param icon_get The callback function that will return the icon.
23355     *
23356     * Each marker must be associated to a group class, and it can display a
23357     * custom icon. The function @p icon_get must return this icon.
23358     *
23359     * @see elm_map_group_class_new() for more details.
23360     * @see elm_map_marker_add()
23361     *
23362     * @ingroup Map
23363     */
23364    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23365
23366    /**
23367     * Set the data associated to the group class.
23368     *
23369     * @param clas The group class.
23370     * @param data The new user data.
23371     *
23372     * This data will be passed for callback functions, like icon get callback,
23373     * that can be set with elm_map_group_class_icon_cb_set().
23374     *
23375     * If a data was previously set, the object will lose the pointer for it,
23376     * so if needs to be freed, you must do it yourself.
23377     *
23378     * @see elm_map_group_class_new() for more details.
23379     * @see elm_map_group_class_icon_cb_set()
23380     * @see elm_map_marker_add()
23381     *
23382     * @ingroup Map
23383     */
23384    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23385
23386    /**
23387     * Set the minimum zoom from where the markers are displayed.
23388     *
23389     * @param clas The group class.
23390     * @param zoom The minimum zoom.
23391     *
23392     * Markers only will be displayed when the map is displayed at @p zoom
23393     * or bigger.
23394     *
23395     * @see elm_map_group_class_new() for more details.
23396     * @see elm_map_marker_add()
23397     *
23398     * @ingroup Map
23399     */
23400    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23401
23402    /**
23403     * Set the zoom from where the markers are no more grouped.
23404     *
23405     * @param clas The group class.
23406     * @param zoom The maximum zoom.
23407     *
23408     * Markers only will be grouped when the map is displayed at
23409     * less than @p zoom.
23410     *
23411     * @see elm_map_group_class_new() for more details.
23412     * @see elm_map_marker_add()
23413     *
23414     * @ingroup Map
23415     */
23416    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23417
23418    /**
23419     * Set if the markers associated to the group class @clas are hidden or not.
23420     *
23421     * @param clas The group class.
23422     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23423     * to show them.
23424     *
23425     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23426     * is to show them.
23427     *
23428     * @ingroup Map
23429     */
23430    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23431
23432    /**
23433     * Create a new marker class.
23434     *
23435     * @param obj The map object.
23436     * @return Returns the new group class.
23437     *
23438     * Each marker must be associated to a class.
23439     *
23440     * The marker class defines the style of the marker when a marker is
23441     * displayed alone, i.e., not grouped to to others markers. When grouped
23442     * it will use group class style.
23443     *
23444     * A marker class will need to be provided when creating a marker with
23445     * elm_map_marker_add().
23446     *
23447     * Some properties and functions can be set by class, as:
23448     * - style, with elm_map_marker_class_style_set()
23449     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23450     *   It can be set using elm_map_marker_class_icon_cb_set().
23451     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23452     *   Set using elm_map_marker_class_get_cb_set().
23453     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23454     *   Set using elm_map_marker_class_del_cb_set().
23455     *
23456     * @see elm_map_marker_add()
23457     * @see elm_map_marker_class_style_set()
23458     * @see elm_map_marker_class_icon_cb_set()
23459     * @see elm_map_marker_class_get_cb_set()
23460     * @see elm_map_marker_class_del_cb_set()
23461     *
23462     * @ingroup Map
23463     */
23464    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23465
23466    /**
23467     * Set the marker's style of a marker class.
23468     *
23469     * @param clas The marker class.
23470     * @param style The style to be used by markers.
23471     *
23472     * Each marker must be associated to a marker class, and will use the style
23473     * defined by such class when alone, i.e., @b not grouped to other markers.
23474     *
23475     * The following styles are provided by default theme:
23476     * @li @c radio
23477     * @li @c radio2
23478     * @li @c empty
23479     *
23480     * @see elm_map_marker_class_new() for more details.
23481     * @see elm_map_marker_add()
23482     *
23483     * @ingroup Map
23484     */
23485    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23486
23487    /**
23488     * Set the icon callback function of a marker class.
23489     *
23490     * @param clas The marker class.
23491     * @param icon_get The callback function that will return the icon.
23492     *
23493     * Each marker must be associated to a marker class, and it can display a
23494     * custom icon. The function @p icon_get must return this icon.
23495     *
23496     * @see elm_map_marker_class_new() for more details.
23497     * @see elm_map_marker_add()
23498     *
23499     * @ingroup Map
23500     */
23501    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23502
23503    /**
23504     * Set the bubble content callback function of a marker class.
23505     *
23506     * @param clas The marker class.
23507     * @param get The callback function that will return the content.
23508     *
23509     * Each marker must be associated to a marker class, and it can display a
23510     * a content on a bubble that opens when the user click over the marker.
23511     * The function @p get must return this content object.
23512     *
23513     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23514     * can be used.
23515     *
23516     * @see elm_map_marker_class_new() for more details.
23517     * @see elm_map_marker_class_del_cb_set()
23518     * @see elm_map_marker_add()
23519     *
23520     * @ingroup Map
23521     */
23522    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23523
23524    /**
23525     * Set the callback function used to delete bubble content of a marker class.
23526     *
23527     * @param clas The marker class.
23528     * @param del The callback function that will delete the content.
23529     *
23530     * Each marker must be associated to a marker class, and it can display a
23531     * a content on a bubble that opens when the user click over the marker.
23532     * The function to return such content can be set with
23533     * elm_map_marker_class_get_cb_set().
23534     *
23535     * If this content must be freed, a callback function need to be
23536     * set for that task with this function.
23537     *
23538     * If this callback is defined it will have to delete (or not) the
23539     * object inside, but if the callback is not defined the object will be
23540     * destroyed with evas_object_del().
23541     *
23542     * @see elm_map_marker_class_new() for more details.
23543     * @see elm_map_marker_class_get_cb_set()
23544     * @see elm_map_marker_add()
23545     *
23546     * @ingroup Map
23547     */
23548    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23549
23550    /**
23551     * Get the list of available sources.
23552     *
23553     * @param obj The map object.
23554     * @return The source names list.
23555     *
23556     * It will provide a list with all available sources, that can be set as
23557     * current source with elm_map_source_name_set(), or get with
23558     * elm_map_source_name_get().
23559     *
23560     * Available sources:
23561     * @li "Mapnik"
23562     * @li "Osmarender"
23563     * @li "CycleMap"
23564     * @li "Maplint"
23565     *
23566     * @see elm_map_source_name_set() for more details.
23567     * @see elm_map_source_name_get()
23568     *
23569     * @ingroup Map
23570     */
23571    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23572
23573    /**
23574     * Set the source of the map.
23575     *
23576     * @param obj The map object.
23577     * @param source The source to be used.
23578     *
23579     * Map widget retrieves images that composes the map from a web service.
23580     * This web service can be set with this method.
23581     *
23582     * A different service can return a different maps with different
23583     * information and it can use different zoom values.
23584     *
23585     * The @p source_name need to match one of the names provided by
23586     * elm_map_source_names_get().
23587     *
23588     * The current source can be get using elm_map_source_name_get().
23589     *
23590     * @see elm_map_source_names_get()
23591     * @see elm_map_source_name_get()
23592     *
23593     *
23594     * @ingroup Map
23595     */
23596    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23597
23598    /**
23599     * Get the name of currently used source.
23600     *
23601     * @param obj The map object.
23602     * @return Returns the name of the source in use.
23603     *
23604     * @see elm_map_source_name_set() for more details.
23605     *
23606     * @ingroup Map
23607     */
23608    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23609
23610    /**
23611     * Set the source of the route service to be used by the map.
23612     *
23613     * @param obj The map object.
23614     * @param source The route service to be used, being it one of
23615     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23616     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23617     *
23618     * Each one has its own algorithm, so the route retrieved may
23619     * differ depending on the source route. Now, only the default is working.
23620     *
23621     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23622     * http://www.yournavigation.org/.
23623     *
23624     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23625     * assumptions. Its routing core is based on Contraction Hierarchies.
23626     *
23627     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23628     *
23629     * @see elm_map_route_source_get().
23630     *
23631     * @ingroup Map
23632     */
23633    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23634
23635    /**
23636     * Get the current route source.
23637     *
23638     * @param obj The map object.
23639     * @return The source of the route service used by the map.
23640     *
23641     * @see elm_map_route_source_set() for details.
23642     *
23643     * @ingroup Map
23644     */
23645    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23646
23647    /**
23648     * Set the minimum zoom of the source.
23649     *
23650     * @param obj The map object.
23651     * @param zoom New minimum zoom value to be used.
23652     *
23653     * By default, it's 0.
23654     *
23655     * @ingroup Map
23656     */
23657    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23658
23659    /**
23660     * Get the minimum zoom of the source.
23661     *
23662     * @param obj The map object.
23663     * @return Returns the minimum zoom of the source.
23664     *
23665     * @see elm_map_source_zoom_min_set() for details.
23666     *
23667     * @ingroup Map
23668     */
23669    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23670
23671    /**
23672     * Set the maximum zoom of the source.
23673     *
23674     * @param obj The map object.
23675     * @param zoom New maximum zoom value to be used.
23676     *
23677     * By default, it's 18.
23678     *
23679     * @ingroup Map
23680     */
23681    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23682
23683    /**
23684     * Get the maximum zoom of the source.
23685     *
23686     * @param obj The map object.
23687     * @return Returns the maximum zoom of the source.
23688     *
23689     * @see elm_map_source_zoom_min_set() for details.
23690     *
23691     * @ingroup Map
23692     */
23693    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23694
23695    /**
23696     * Set the user agent used by the map object to access routing services.
23697     *
23698     * @param obj The map object.
23699     * @param user_agent The user agent to be used by the map.
23700     *
23701     * User agent is a client application implementing a network protocol used
23702     * in communications within a clientā€“server distributed computing system
23703     *
23704     * The @p user_agent identification string will transmitted in a header
23705     * field @c User-Agent.
23706     *
23707     * @see elm_map_user_agent_get()
23708     *
23709     * @ingroup Map
23710     */
23711    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23712
23713    /**
23714     * Get the user agent used by the map object.
23715     *
23716     * @param obj The map object.
23717     * @return The user agent identification string used by the map.
23718     *
23719     * @see elm_map_user_agent_set() for details.
23720     *
23721     * @ingroup Map
23722     */
23723    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23724
23725    /**
23726     * Add a new route to the map object.
23727     *
23728     * @param obj The map object.
23729     * @param type The type of transport to be considered when tracing a route.
23730     * @param method The routing method, what should be priorized.
23731     * @param flon The start longitude.
23732     * @param flat The start latitude.
23733     * @param tlon The destination longitude.
23734     * @param tlat The destination latitude.
23735     *
23736     * @return The created route or @c NULL upon failure.
23737     *
23738     * A route will be traced by point on coordinates (@p flat, @p flon)
23739     * to point on coordinates (@p tlat, @p tlon), using the route service
23740     * set with elm_map_route_source_set().
23741     *
23742     * It will take @p type on consideration to define the route,
23743     * depending if the user will be walking or driving, the route may vary.
23744     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23745     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23746     *
23747     * Another parameter is what the route should priorize, the minor distance
23748     * or the less time to be spend on the route. So @p method should be one
23749     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23750     *
23751     * Routes created with this method can be deleted with
23752     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23753     * and distance can be get with elm_map_route_distance_get().
23754     *
23755     * @see elm_map_route_remove()
23756     * @see elm_map_route_color_set()
23757     * @see elm_map_route_distance_get()
23758     * @see elm_map_route_source_set()
23759     *
23760     * @ingroup Map
23761     */
23762    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);
23763
23764    /**
23765     * Remove a route from the map.
23766     *
23767     * @param route The route to remove.
23768     *
23769     * @see elm_map_route_add()
23770     *
23771     * @ingroup Map
23772     */
23773    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23774
23775    /**
23776     * Set the route color.
23777     *
23778     * @param route The route object.
23779     * @param r Red channel value, from 0 to 255.
23780     * @param g Green channel value, from 0 to 255.
23781     * @param b Blue channel value, from 0 to 255.
23782     * @param a Alpha channel value, from 0 to 255.
23783     *
23784     * It uses an additive color model, so each color channel represents
23785     * how much of each primary colors must to be used. 0 represents
23786     * ausence of this color, so if all of the three are set to 0,
23787     * the color will be black.
23788     *
23789     * These component values should be integers in the range 0 to 255,
23790     * (single 8-bit byte).
23791     *
23792     * This sets the color used for the route. By default, it is set to
23793     * solid red (r = 255, g = 0, b = 0, a = 255).
23794     *
23795     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23796     *
23797     * @see elm_map_route_color_get()
23798     *
23799     * @ingroup Map
23800     */
23801    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23802
23803    /**
23804     * Get the route color.
23805     *
23806     * @param route The route object.
23807     * @param r Pointer where to store the red channel value.
23808     * @param g Pointer where to store the green channel value.
23809     * @param b Pointer where to store the blue channel value.
23810     * @param a Pointer where to store the alpha channel value.
23811     *
23812     * @see elm_map_route_color_set() for details.
23813     *
23814     * @ingroup Map
23815     */
23816    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23817
23818    /**
23819     * Get the route distance in kilometers.
23820     *
23821     * @param route The route object.
23822     * @return The distance of route (unit : km).
23823     *
23824     * @ingroup Map
23825     */
23826    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23827
23828    /**
23829     * Get the information of route nodes.
23830     *
23831     * @param route The route object.
23832     * @return Returns a string with the nodes of route.
23833     *
23834     * @ingroup Map
23835     */
23836    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23837
23838    /**
23839     * Get the information of route waypoint.
23840     *
23841     * @param route the route object.
23842     * @return Returns a string with information about waypoint of route.
23843     *
23844     * @ingroup Map
23845     */
23846    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23847
23848    /**
23849     * Get the address of the name.
23850     *
23851     * @param name The name handle.
23852     * @return Returns the address string of @p name.
23853     *
23854     * This gets the coordinates of the @p name, created with one of the
23855     * conversion functions.
23856     *
23857     * @see elm_map_utils_convert_name_into_coord()
23858     * @see elm_map_utils_convert_coord_into_name()
23859     *
23860     * @ingroup Map
23861     */
23862    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23863
23864    /**
23865     * Get the current coordinates of the name.
23866     *
23867     * @param name The name handle.
23868     * @param lat Pointer where to store the latitude.
23869     * @param lon Pointer where to store The longitude.
23870     *
23871     * This gets the coordinates of the @p name, created with one of the
23872     * conversion functions.
23873     *
23874     * @see elm_map_utils_convert_name_into_coord()
23875     * @see elm_map_utils_convert_coord_into_name()
23876     *
23877     * @ingroup Map
23878     */
23879    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23880
23881    /**
23882     * Remove a name from the map.
23883     *
23884     * @param name The name to remove.
23885     *
23886     * Basically the struct handled by @p name will be freed, so convertions
23887     * between address and coordinates will be lost.
23888     *
23889     * @see elm_map_utils_convert_name_into_coord()
23890     * @see elm_map_utils_convert_coord_into_name()
23891     *
23892     * @ingroup Map
23893     */
23894    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23895
23896    /**
23897     * Rotate the map.
23898     *
23899     * @param obj The map object.
23900     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23901     * @param cx Rotation's center horizontal position.
23902     * @param cy Rotation's center vertical position.
23903     *
23904     * @see elm_map_rotate_get()
23905     *
23906     * @ingroup Map
23907     */
23908    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23909
23910    /**
23911     * Get the rotate degree of the map
23912     *
23913     * @param obj The map object
23914     * @param degree Pointer where to store degrees from 0.0 to 360.0
23915     * to rotate arount Z axis.
23916     * @param cx Pointer where to store rotation's center horizontal position.
23917     * @param cy Pointer where to store rotation's center vertical position.
23918     *
23919     * @see elm_map_rotate_set() to set map rotation.
23920     *
23921     * @ingroup Map
23922     */
23923    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);
23924
23925    /**
23926     * Enable or disable mouse wheel to be used to zoom in / out the map.
23927     *
23928     * @param obj The map object.
23929     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23930     * to enable it.
23931     *
23932     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23933     *
23934     * It's disabled by default.
23935     *
23936     * @see elm_map_wheel_disabled_get()
23937     *
23938     * @ingroup Map
23939     */
23940    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23941
23942    /**
23943     * Get a value whether mouse wheel is enabled or not.
23944     *
23945     * @param obj The map object.
23946     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23947     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23948     *
23949     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23950     *
23951     * @see elm_map_wheel_disabled_set() for details.
23952     *
23953     * @ingroup Map
23954     */
23955    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23956
23957 #ifdef ELM_EMAP
23958    /**
23959     * Add a track on the map
23960     *
23961     * @param obj The map object.
23962     * @param emap The emap route object.
23963     * @return The route object. This is an elm object of type Route.
23964     *
23965     * @see elm_route_add() for details.
23966     *
23967     * @ingroup Map
23968     */
23969    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23970 #endif
23971
23972    /**
23973     * Remove a track from the map
23974     *
23975     * @param obj The map object.
23976     * @param route The track to remove.
23977     *
23978     * @ingroup Map
23979     */
23980    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23981
23982    /**
23983     * @}
23984     */
23985
23986    /* Route */
23987    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23988 #ifdef ELM_EMAP
23989    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23990 #endif
23991    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23992    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23993    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23994    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23995
23996
23997    /**
23998     * @defgroup Panel Panel
23999     *
24000     * @image html img/widget/panel/preview-00.png
24001     * @image latex img/widget/panel/preview-00.eps
24002     *
24003     * @brief A panel is a type of animated container that contains subobjects.
24004     * It can be expanded or contracted by clicking the button on it's edge.
24005     *
24006     * Orientations are as follows:
24007     * @li ELM_PANEL_ORIENT_TOP
24008     * @li ELM_PANEL_ORIENT_LEFT
24009     * @li ELM_PANEL_ORIENT_RIGHT
24010     *
24011     * Default contents parts of the panel widget that you can use for are:
24012     * @li "default" - A content of the panel
24013     *
24014     * @ref tutorial_panel shows one way to use this widget.
24015     * @{
24016     */
24017    typedef enum _Elm_Panel_Orient
24018      {
24019         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24020         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24021         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24022         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24023      } Elm_Panel_Orient;
24024    /**
24025     * @brief Adds a panel object
24026     *
24027     * @param parent The parent object
24028     *
24029     * @return The panel object, or NULL on failure
24030     */
24031    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24032    /**
24033     * @brief Sets the orientation of the panel
24034     *
24035     * @param parent The parent object
24036     * @param orient The panel orientation. Can be one of the following:
24037     * @li ELM_PANEL_ORIENT_TOP
24038     * @li ELM_PANEL_ORIENT_LEFT
24039     * @li ELM_PANEL_ORIENT_RIGHT
24040     *
24041     * Sets from where the panel will (dis)appear.
24042     */
24043    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24044    /**
24045     * @brief Get the orientation of the panel.
24046     *
24047     * @param obj The panel object
24048     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24049     */
24050    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24051    /**
24052     * @brief Set the content of the panel.
24053     *
24054     * @param obj The panel object
24055     * @param content The panel content
24056     *
24057     * Once the content object is set, a previously set one will be deleted.
24058     * If you want to keep that old content object, use the
24059     * elm_panel_content_unset() function.
24060     *
24061     * @deprecated use elm_object_content_set() instead
24062     *
24063     */
24064    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24065    /**
24066     * @brief Get the content of the panel.
24067     *
24068     * @param obj The panel object
24069     * @return The content that is being used
24070     *
24071     * Return the content object which is set for this widget.
24072     *
24073     * @see elm_panel_content_set()
24074     * 
24075     * @deprecated use elm_object_content_get() instead
24076     *
24077     */
24078    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24079    /**
24080     * @brief Unset the content of the panel.
24081     *
24082     * @param obj The panel object
24083     * @return The content that was being used
24084     *
24085     * Unparent and return the content object which was set for this widget.
24086     *
24087     * @see elm_panel_content_set()
24088     *
24089     * @deprecated use elm_object_content_unset() instead
24090     *
24091     */
24092    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24093    /**
24094     * @brief Set the state of the panel.
24095     *
24096     * @param obj The panel object
24097     * @param hidden If true, the panel will run the animation to contract
24098     */
24099    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24100    /**
24101     * @brief Get the state of the panel.
24102     *
24103     * @param obj The panel object
24104     * @param hidden If true, the panel is in the "hide" state
24105     */
24106    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24107    /**
24108     * @brief Toggle the hidden state of the panel from code
24109     *
24110     * @param obj The panel object
24111     */
24112    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24113    /**
24114     * @}
24115     */
24116
24117    /**
24118     * @defgroup Panes Panes
24119     * @ingroup Elementary
24120     *
24121     * @image html img/widget/panes/preview-00.png
24122     * @image latex img/widget/panes/preview-00.eps width=\textwidth
24123     *
24124     * @image html img/panes.png
24125     * @image latex img/panes.eps width=\textwidth
24126     *
24127     * The panes adds a dragable bar between two contents. When dragged
24128     * this bar will resize contents size.
24129     *
24130     * Panes can be displayed vertically or horizontally, and contents
24131     * size proportion can be customized (homogeneous by default).
24132     *
24133     * Smart callbacks one can listen to:
24134     * - "press" - The panes has been pressed (button wasn't released yet).
24135     * - "unpressed" - The panes was released after being pressed.
24136     * - "clicked" - The panes has been clicked>
24137     * - "clicked,double" - The panes has been double clicked
24138     *
24139     * Available styles for it:
24140     * - @c "default"
24141     *
24142     * Default contents parts of the panes widget that you can use for are:
24143     * @li "left" - A leftside content of the panes
24144     * @li "right" - A rightside content of the panes
24145     *
24146     * If panes is displayed vertically, left content will be displayed at
24147     * top.
24148     * 
24149     * Here is an example on its usage:
24150     * @li @ref panes_example
24151     */
24152
24153    /**
24154     * @addtogroup Panes
24155     * @{
24156     */
24157
24158    /**
24159     * Add a new panes widget to the given parent Elementary
24160     * (container) object.
24161     *
24162     * @param parent The parent object.
24163     * @return a new panes widget handle or @c NULL, on errors.
24164     *
24165     * This function inserts a new panes widget on the canvas.
24166     *
24167     * @ingroup Panes
24168     */
24169    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24170
24171    /**
24172     * Set the left content of the panes widget.
24173     *
24174     * @param obj The panes object.
24175     * @param content The new left content object.
24176     *
24177     * Once the content object is set, a previously set one will be deleted.
24178     * If you want to keep that old content object, use the
24179     * elm_panes_content_left_unset() function.
24180     *
24181     * If panes is displayed vertically, left content will be displayed at
24182     * top.
24183     *
24184     * @see elm_panes_content_left_get()
24185     * @see elm_panes_content_right_set() to set content on the other side.
24186     *
24187     * @deprecated use elm_object_part_content_set() instead
24188     *
24189     * @ingroup Panes
24190     */
24191    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24192
24193    /**
24194     * Set the right content of the panes widget.
24195     *
24196     * @param obj The panes object.
24197     * @param content The new right content object.
24198     *
24199     * Once the content object is set, a previously set one will be deleted.
24200     * If you want to keep that old content object, use the
24201     * elm_panes_content_right_unset() function.
24202     *
24203     * If panes is displayed vertically, left content will be displayed at
24204     * bottom.
24205     *
24206     * @see elm_panes_content_right_get()
24207     * @see elm_panes_content_left_set() to set content on the other side.
24208     *
24209     * @deprecated use elm_object_part_content_set() instead
24210     *
24211     * @ingroup Panes
24212     */
24213    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24214
24215    /**
24216     * Get the left content of the panes.
24217     *
24218     * @param obj The panes object.
24219     * @return The left content object that is being used.
24220     *
24221     * Return the left content object which is set for this widget.
24222     *
24223     * @see elm_panes_content_left_set() for details.
24224     *
24225     * @deprecated use elm_object_part_content_get() instead
24226     *
24227     * @ingroup Panes
24228     */
24229    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24230
24231    /**
24232     * Get the right content of the panes.
24233     *
24234     * @param obj The panes object
24235     * @return The right content object that is being used
24236     *
24237     * Return the right content object which is set for this widget.
24238     *
24239     * @see elm_panes_content_right_set() for details.
24240     *
24241     * @deprecated use elm_object_part_content_get() instead
24242     *
24243     * @ingroup Panes
24244     */
24245    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24246
24247    /**
24248     * Unset the left content used for the panes.
24249     *
24250     * @param obj The panes object.
24251     * @return The left content object that was being used.
24252     *
24253     * Unparent and return the left content object which was set for this widget.
24254     *
24255     * @see elm_panes_content_left_set() for details.
24256     * @see elm_panes_content_left_get().
24257     *
24258     * @deprecated use elm_object_part_content_unset() instead
24259     *
24260     * @ingroup Panes
24261     */
24262    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24263
24264    /**
24265     * Unset the right content used for the panes.
24266     *
24267     * @param obj The panes object.
24268     * @return The right content object that was being used.
24269     *
24270     * Unparent and return the right content object which was set for this
24271     * widget.
24272     *
24273     * @see elm_panes_content_right_set() for details.
24274     * @see elm_panes_content_right_get().
24275     *
24276     * @deprecated use elm_object_part_content_unset() instead
24277     *
24278     * @ingroup Panes
24279     */
24280    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24281
24282    /**
24283     * Get the size proportion of panes widget's left side.
24284     *
24285     * @param obj The panes object.
24286     * @return float value between 0.0 and 1.0 representing size proportion
24287     * of left side.
24288     *
24289     * @see elm_panes_content_left_size_set() for more details.
24290     *
24291     * @ingroup Panes
24292     */
24293    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24294
24295    /**
24296     * Set the size proportion of panes widget's left side.
24297     *
24298     * @param obj The panes object.
24299     * @param size Value between 0.0 and 1.0 representing size proportion
24300     * of left side.
24301     *
24302     * By default it's homogeneous, i.e., both sides have the same size.
24303     *
24304     * If something different is required, it can be set with this function.
24305     * For example, if the left content should be displayed over
24306     * 75% of the panes size, @p size should be passed as @c 0.75.
24307     * This way, right content will be resized to 25% of panes size.
24308     *
24309     * If displayed vertically, left content is displayed at top, and
24310     * right content at bottom.
24311     *
24312     * @note This proportion will change when user drags the panes bar.
24313     *
24314     * @see elm_panes_content_left_size_get()
24315     *
24316     * @ingroup Panes
24317     */
24318    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24319
24320   /**
24321    * Set the orientation of a given panes widget.
24322    *
24323    * @param obj The panes object.
24324    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24325    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24326    *
24327    * Use this function to change how your panes is to be
24328    * disposed: vertically or horizontally.
24329    *
24330    * By default it's displayed horizontally.
24331    *
24332    * @see elm_panes_horizontal_get()
24333    *
24334    * @ingroup Panes
24335    */
24336    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24337
24338    /**
24339     * Retrieve the orientation of a given panes widget.
24340     *
24341     * @param obj The panes object.
24342     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24343     * @c EINA_FALSE if it's @b vertical (and on errors).
24344     *
24345     * @see elm_panes_horizontal_set() for more details.
24346     *
24347     * @ingroup Panes
24348     */
24349    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24350    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24351    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24352
24353    /**
24354     * @}
24355     */
24356
24357    /**
24358     * @defgroup Flip Flip
24359     *
24360     * @image html img/widget/flip/preview-00.png
24361     * @image latex img/widget/flip/preview-00.eps
24362     *
24363     * This widget holds 2 content objects(Evas_Object): one on the front and one
24364     * on the back. It allows you to flip from front to back and vice-versa using
24365     * various animations.
24366     *
24367     * If either the front or back contents are not set the flip will treat that
24368     * as transparent. So if you wore to set the front content but not the back,
24369     * and then call elm_flip_go() you would see whatever is below the flip.
24370     *
24371     * For a list of supported animations see elm_flip_go().
24372     *
24373     * Signals that you can add callbacks for are:
24374     * "animate,begin" - when a flip animation was started
24375     * "animate,done" - when a flip animation is finished
24376     *
24377     * @ref tutorial_flip show how to use most of the API.
24378     *
24379     * @{
24380     */
24381    typedef enum _Elm_Flip_Mode
24382      {
24383         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24384         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24385         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24386         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24387         ELM_FLIP_CUBE_LEFT,
24388         ELM_FLIP_CUBE_RIGHT,
24389         ELM_FLIP_CUBE_UP,
24390         ELM_FLIP_CUBE_DOWN,
24391         ELM_FLIP_PAGE_LEFT,
24392         ELM_FLIP_PAGE_RIGHT,
24393         ELM_FLIP_PAGE_UP,
24394         ELM_FLIP_PAGE_DOWN
24395      } Elm_Flip_Mode;
24396    typedef enum _Elm_Flip_Interaction
24397      {
24398         ELM_FLIP_INTERACTION_NONE,
24399         ELM_FLIP_INTERACTION_ROTATE,
24400         ELM_FLIP_INTERACTION_CUBE,
24401         ELM_FLIP_INTERACTION_PAGE
24402      } Elm_Flip_Interaction;
24403    typedef enum _Elm_Flip_Direction
24404      {
24405         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24406         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24407         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24408         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24409      } Elm_Flip_Direction;
24410    /**
24411     * @brief Add a new flip to the parent
24412     *
24413     * @param parent The parent object
24414     * @return The new object or NULL if it cannot be created
24415     */
24416    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24417    /**
24418     * @brief Set the front content of the flip widget.
24419     *
24420     * @param obj The flip object
24421     * @param content The new front 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_front_unset() function.
24426     */
24427    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24428    /**
24429     * @brief Set the back content of the flip widget.
24430     *
24431     * @param obj The flip object
24432     * @param content The new back content object
24433     *
24434     * Once the content object is set, a previously set one will be deleted.
24435     * If you want to keep that old content object, use the
24436     * elm_flip_content_back_unset() function.
24437     */
24438    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24439    /**
24440     * @brief Get the front content used for the flip
24441     *
24442     * @param obj The flip object
24443     * @return The front content object that is being used
24444     *
24445     * Return the front content object which is set for this widget.
24446     */
24447    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24448    /**
24449     * @brief Get the back content used for the flip
24450     *
24451     * @param obj The flip object
24452     * @return The back content object that is being used
24453     *
24454     * Return the back content object which is set for this widget.
24455     */
24456    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24457    /**
24458     * @brief Unset the front content used for the flip
24459     *
24460     * @param obj The flip object
24461     * @return The front content object that was being used
24462     *
24463     * Unparent and return the front content object which was set for this widget.
24464     */
24465    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24466    /**
24467     * @brief Unset the back content used for the flip
24468     *
24469     * @param obj The flip object
24470     * @return The back content object that was being used
24471     *
24472     * Unparent and return the back content object which was set for this widget.
24473     */
24474    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24475    /**
24476     * @brief Get flip front visibility state
24477     *
24478     * @param obj The flip objct
24479     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24480     * showing.
24481     */
24482    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24483    /**
24484     * @brief Set flip perspective
24485     *
24486     * @param obj The flip object
24487     * @param foc The coordinate to set the focus on
24488     * @param x The X coordinate
24489     * @param y The Y coordinate
24490     *
24491     * @warning This function currently does nothing.
24492     */
24493    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24494    /**
24495     * @brief Runs the flip animation
24496     *
24497     * @param obj The flip object
24498     * @param mode The mode type
24499     *
24500     * Flips the front and back contents using the @p mode animation. This
24501     * efectively hides the currently visible content and shows the hidden one.
24502     *
24503     * There a number of possible animations to use for the flipping:
24504     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24505     * around a horizontal axis in the middle of its height, the other content
24506     * is shown as the other side of the flip.
24507     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24508     * around a vertical axis in the middle of its width, the other content is
24509     * shown as the other side of the flip.
24510     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24511     * around a diagonal axis in the middle of its width, the other content is
24512     * shown as the other side of the flip.
24513     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24514     * around a diagonal axis in the middle of its height, the other content is
24515     * shown as the other side of the flip.
24516     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24517     * as if the flip was a cube, the other content is show as the right face of
24518     * the cube.
24519     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24520     * right as if the flip was a cube, the other content is show as the left
24521     * face of the cube.
24522     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24523     * flip was a cube, the other content is show as the bottom face of the cube.
24524     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24525     * the flip was a cube, the other content is show as the upper face of the
24526     * cube.
24527     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24528     * if the flip was a book, the other content is shown as the page below that.
24529     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24530     * as if the flip was a book, the other content is shown as the page below
24531     * that.
24532     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24533     * flip was a book, the other content is shown as the page below that.
24534     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24535     * flip was a book, the other content is shown as the page below that.
24536     *
24537     * @image html elm_flip.png
24538     * @image latex elm_flip.eps width=\textwidth
24539     */
24540    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24541    /**
24542     * @brief Set the interactive flip mode
24543     *
24544     * @param obj The flip object
24545     * @param mode The interactive flip mode to use
24546     *
24547     * This sets if the flip should be interactive (allow user to click and
24548     * drag a side of the flip to reveal the back page and cause it to flip).
24549     * By default a flip is not interactive. You may also need to set which
24550     * sides of the flip are "active" for flipping and how much space they use
24551     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24552     * and elm_flip_interacton_direction_hitsize_set()
24553     *
24554     * The four avilable mode of interaction are:
24555     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24556     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24557     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24558     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24559     *
24560     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24561     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24562     * happen, those can only be acheived with elm_flip_go();
24563     */
24564    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24565    /**
24566     * @brief Get the interactive flip mode
24567     *
24568     * @param obj The flip object
24569     * @return The interactive flip mode
24570     *
24571     * Returns the interactive flip mode set by elm_flip_interaction_set()
24572     */
24573    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24574    /**
24575     * @brief Set which directions of the flip respond to interactive flip
24576     *
24577     * @param obj The flip object
24578     * @param dir The direction to change
24579     * @param enabled If that direction is enabled or not
24580     *
24581     * By default all directions are disabled, so you may want to enable the
24582     * desired directions for flipping if you need interactive flipping. You must
24583     * call this function once for each direction that should be enabled.
24584     *
24585     * @see elm_flip_interaction_set()
24586     */
24587    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24588    /**
24589     * @brief Get the enabled state of that flip direction
24590     *
24591     * @param obj The flip object
24592     * @param dir The direction to check
24593     * @return If that direction is enabled or not
24594     *
24595     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24596     *
24597     * @see elm_flip_interaction_set()
24598     */
24599    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24600    /**
24601     * @brief Set the amount of the flip that is sensitive to interactive flip
24602     *
24603     * @param obj The flip object
24604     * @param dir The direction to modify
24605     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24606     *
24607     * Set the amount of the flip that is sensitive to interactive flip, with 0
24608     * representing no area in the flip and 1 representing the entire flip. There
24609     * is however a consideration to be made in that the area will never be
24610     * smaller than the finger size set(as set in your Elementary configuration).
24611     *
24612     * @see elm_flip_interaction_set()
24613     */
24614    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24615    /**
24616     * @brief Get the amount of the flip that is sensitive to interactive flip
24617     *
24618     * @param obj The flip object
24619     * @param dir The direction to check
24620     * @return The size set for that direction
24621     *
24622     * Returns the amount os sensitive area set by
24623     * elm_flip_interacton_direction_hitsize_set().
24624     */
24625    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24626    /**
24627     * @}
24628     */
24629
24630    /* scrolledentry */
24631    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24632    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24633    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24634    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24635    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24636    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24637    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24638    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24639    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24640    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24641    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24642    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24643    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24644    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24645    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24646    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24647    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24648    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24649    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24650    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24651    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24652    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24653    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24654    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24655    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24656    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24657    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24658    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24659    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24660    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24661    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24662    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24663    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24664    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24665    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24666    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);
24667    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24668    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24669    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);
24670    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24671    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);
24672    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24673    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24674    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24675    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24676    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24677    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24678    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24679    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24680    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);
24681    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);
24682    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);
24683    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);
24684    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);
24685    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);
24686    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24687    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24688    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24689    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24690    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24691    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24692    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24693
24694    /**
24695     * @defgroup Conformant Conformant
24696     * @ingroup Elementary
24697     *
24698     * @image html img/widget/conformant/preview-00.png
24699     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24700     *
24701     * @image html img/conformant.png
24702     * @image latex img/conformant.eps width=\textwidth
24703     *
24704     * The aim is to provide a widget that can be used in elementary apps to
24705     * account for space taken up by the indicator, virtual keypad & softkey
24706     * windows when running the illume2 module of E17.
24707     *
24708     * So conformant content will be sized and positioned considering the
24709     * space required for such stuff, and when they popup, as a keyboard
24710     * shows when an entry is selected, conformant content won't change.
24711     *
24712     * Available styles for it:
24713     * - @c "default"
24714     *
24715     * Default contents parts of the conformant widget that you can use for are:
24716     * @li "default" - A content of the conformant
24717     *
24718     * See how to use this widget in this example:
24719     * @ref conformant_example
24720     */
24721
24722    /**
24723     * @addtogroup Conformant
24724     * @{
24725     */
24726
24727    /**
24728     * Add a new conformant widget to the given parent Elementary
24729     * (container) object.
24730     *
24731     * @param parent The parent object.
24732     * @return A new conformant widget handle or @c NULL, on errors.
24733     *
24734     * This function inserts a new conformant widget on the canvas.
24735     *
24736     * @ingroup Conformant
24737     */
24738    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24739
24740    /**
24741     * Set the content of the conformant widget.
24742     *
24743     * @param obj The conformant object.
24744     * @param content The content to be displayed by the conformant.
24745     *
24746     * Content will be sized and positioned considering the space required
24747     * to display a virtual keyboard. So it won't fill all the conformant
24748     * size. This way is possible to be sure that content won't resize
24749     * or be re-positioned after the keyboard is displayed.
24750     *
24751     * Once the content object is set, a previously set one will be deleted.
24752     * If you want to keep that old content object, use the
24753     * elm_object_content_unset() function.
24754     *
24755     * @see elm_object_content_unset()
24756     * @see elm_object_content_get()
24757     *
24758     * @deprecated use elm_object_content_set() instead
24759     *
24760     * @ingroup Conformant
24761     */
24762    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24763
24764    /**
24765     * Get the content of the conformant widget.
24766     *
24767     * @param obj The conformant object.
24768     * @return The content that is being used.
24769     *
24770     * Return the content object which is set for this widget.
24771     * It won't be unparent from conformant. For that, use
24772     * elm_object_content_unset().
24773     *
24774     * @see elm_object_content_set().
24775     * @see elm_object_content_unset()
24776     *
24777     * @deprecated use elm_object_content_get() instead
24778     *
24779     * @ingroup Conformant
24780     */
24781    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24782
24783    /**
24784     * Unset the content of the conformant widget.
24785     *
24786     * @param obj The conformant object.
24787     * @return The content that was being used.
24788     *
24789     * Unparent and return the content object which was set for this widget.
24790     *
24791     * @see elm_object_content_set().
24792     *
24793     * @deprecated use elm_object_content_unset() instead
24794     *
24795     * @ingroup Conformant
24796     */
24797    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24798
24799    /**
24800     * Returns the Evas_Object that represents the content area.
24801     *
24802     * @param obj The conformant object.
24803     * @return The content area of the widget.
24804     *
24805     * @ingroup Conformant
24806     */
24807    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24808
24809    /**
24810     * @}
24811     */
24812
24813    /**
24814     * @defgroup Mapbuf Mapbuf
24815     * @ingroup Elementary
24816     *
24817     * @image html img/widget/mapbuf/preview-00.png
24818     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24819     *
24820     * This holds one content object and uses an Evas Map of transformation
24821     * points to be later used with this content. So the content will be
24822     * moved, resized, etc as a single image. So it will improve performance
24823     * when you have a complex interafce, with a lot of elements, and will
24824     * need to resize or move it frequently (the content object and its
24825     * children).
24826     *
24827     * Default contents parts of the mapbuf widget that you can use for are:
24828     * @li "default" - A content of the mapbuf
24829     *
24830     * To enable map, elm_mapbuf_enabled_set() should be used.
24831     * 
24832     * See how to use this widget in this example:
24833     * @ref mapbuf_example
24834     */
24835
24836    /**
24837     * @addtogroup Mapbuf
24838     * @{
24839     */
24840
24841    /**
24842     * Add a new mapbuf widget to the given parent Elementary
24843     * (container) object.
24844     *
24845     * @param parent The parent object.
24846     * @return A new mapbuf widget handle or @c NULL, on errors.
24847     *
24848     * This function inserts a new mapbuf widget on the canvas.
24849     *
24850     * @ingroup Mapbuf
24851     */
24852    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24853
24854    /**
24855     * Set the content of the mapbuf.
24856     *
24857     * @param obj The mapbuf object.
24858     * @param content The content that will be filled in this mapbuf object.
24859     *
24860     * Once the content object is set, a previously set one will be deleted.
24861     * If you want to keep that old content object, use the
24862     * elm_mapbuf_content_unset() function.
24863     *
24864     * To enable map, elm_mapbuf_enabled_set() should be used.
24865     *
24866     * @deprecated use elm_object_content_set() instead
24867     *
24868     * @ingroup Mapbuf
24869     */
24870    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24871
24872    /**
24873     * Get the content of the mapbuf.
24874     *
24875     * @param obj The mapbuf object.
24876     * @return The content that is being used.
24877     *
24878     * Return the content object which is set for this widget.
24879     *
24880     * @see elm_mapbuf_content_set() for details.
24881     *
24882     * @deprecated use elm_object_content_get() instead
24883     *
24884     * @ingroup Mapbuf
24885     */
24886    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24887
24888    /**
24889     * Unset the content of the mapbuf.
24890     *
24891     * @param obj The mapbuf object.
24892     * @return The content that was being used.
24893     *
24894     * Unparent and return the content object which was set for this widget.
24895     *
24896     * @see elm_mapbuf_content_set() for details.
24897     *
24898     * @deprecated use elm_object_content_unset() instead
24899     *
24900     * @ingroup Mapbuf
24901     */
24902    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24903
24904    /**
24905     * Enable or disable the map.
24906     *
24907     * @param obj The mapbuf object.
24908     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24909     *
24910     * This enables the map that is set or disables it. On enable, the object
24911     * geometry will be saved, and the new geometry will change (position and
24912     * size) to reflect the map geometry set.
24913     *
24914     * Also, when enabled, alpha and smooth states will be used, so if the
24915     * content isn't solid, alpha should be enabled, for example, otherwise
24916     * a black retangle will fill the content.
24917     *
24918     * When disabled, the stored map will be freed and geometry prior to
24919     * enabling the map will be restored.
24920     *
24921     * It's disabled by default.
24922     *
24923     * @see elm_mapbuf_alpha_set()
24924     * @see elm_mapbuf_smooth_set()
24925     *
24926     * @ingroup Mapbuf
24927     */
24928    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24929
24930    /**
24931     * Get a value whether map is enabled or not.
24932     *
24933     * @param obj The mapbuf object.
24934     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24935     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24936     *
24937     * @see elm_mapbuf_enabled_set() for details.
24938     *
24939     * @ingroup Mapbuf
24940     */
24941    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24942
24943    /**
24944     * Enable or disable smooth map rendering.
24945     *
24946     * @param obj The mapbuf object.
24947     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24948     * to disable it.
24949     *
24950     * This sets smoothing for map rendering. If the object is a type that has
24951     * its own smoothing settings, then both the smooth settings for this object
24952     * and the map must be turned off.
24953     *
24954     * By default smooth maps are enabled.
24955     *
24956     * @ingroup Mapbuf
24957     */
24958    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24959
24960    /**
24961     * Get a value whether smooth map rendering is enabled or not.
24962     *
24963     * @param obj The mapbuf object.
24964     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24965     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24966     *
24967     * @see elm_mapbuf_smooth_set() for details.
24968     *
24969     * @ingroup Mapbuf
24970     */
24971    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24972
24973    /**
24974     * Set or unset alpha flag for map rendering.
24975     *
24976     * @param obj The mapbuf object.
24977     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24978     * to disable it.
24979     *
24980     * This sets alpha flag for map rendering. If the object is a type that has
24981     * its own alpha settings, then this will take precedence. Only image objects
24982     * have this currently. It stops alpha blending of the map area, and is
24983     * useful if you know the object and/or all sub-objects is 100% solid.
24984     *
24985     * Alpha is enabled by default.
24986     *
24987     * @ingroup Mapbuf
24988     */
24989    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24990
24991    /**
24992     * Get a value whether alpha blending is enabled or not.
24993     *
24994     * @param obj The mapbuf object.
24995     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24996     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24997     *
24998     * @see elm_mapbuf_alpha_set() for details.
24999     *
25000     * @ingroup Mapbuf
25001     */
25002    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25003
25004    /**
25005     * @}
25006     */
25007
25008    /**
25009     * @defgroup Flipselector Flip Selector
25010     *
25011     * @image html img/widget/flipselector/preview-00.png
25012     * @image latex img/widget/flipselector/preview-00.eps
25013     *
25014     * A flip selector is a widget to show a set of @b text items, one
25015     * at a time, with the same sheet switching style as the @ref Clock
25016     * "clock" widget, when one changes the current displaying sheet
25017     * (thus, the "flip" in the name).
25018     *
25019     * User clicks to flip sheets which are @b held for some time will
25020     * make the flip selector to flip continuosly and automatically for
25021     * the user. The interval between flips will keep growing in time,
25022     * so that it helps the user to reach an item which is distant from
25023     * the current selection.
25024     *
25025     * Smart callbacks one can register to:
25026     * - @c "selected" - when the widget's selected text item is changed
25027     * - @c "overflowed" - when the widget's current selection is changed
25028     *   from the first item in its list to the last
25029     * - @c "underflowed" - when the widget's current selection is changed
25030     *   from the last item in its list to the first
25031     *
25032     * Available styles for it:
25033     * - @c "default"
25034     *
25035          * To set/get the label of the flipselector item, you can use
25036          * elm_object_item_text_set/get APIs.
25037          * Once the text is set, a previously set one will be deleted.
25038          * 
25039     * Here is an example on its usage:
25040     * @li @ref flipselector_example
25041     */
25042
25043    /**
25044     * @addtogroup Flipselector
25045     * @{
25046     */
25047
25048    /**
25049     * Add a new flip selector widget to the given parent Elementary
25050     * (container) widget
25051     *
25052     * @param parent The parent object
25053     * @return a new flip selector widget handle or @c NULL, on errors
25054     *
25055     * This function inserts a new flip selector widget on the canvas.
25056     *
25057     * @ingroup Flipselector
25058     */
25059    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25060
25061    /**
25062     * Programmatically select the next item of a flip selector widget
25063     *
25064     * @param obj The flipselector object
25065     *
25066     * @note The selection will be animated. Also, if it reaches the
25067     * end of its list of member items, it will continue with the first
25068     * one onwards.
25069     *
25070     * @ingroup Flipselector
25071     */
25072    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25073
25074    /**
25075     * Programmatically select the previous item of a flip selector
25076     * widget
25077     *
25078     * @param obj The flipselector object
25079     *
25080     * @note The selection will be animated.  Also, if it reaches the
25081     * beginning of its list of member items, it will continue with the
25082     * last one backwards.
25083     *
25084     * @ingroup Flipselector
25085     */
25086    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25087
25088    /**
25089     * Append a (text) item to a flip selector widget
25090     *
25091     * @param obj The flipselector object
25092     * @param label The (text) label of the new item
25093     * @param func Convenience callback function to take place when
25094     * item is selected
25095     * @param data Data passed to @p func, above
25096     * @return A handle to the item added or @c NULL, on errors
25097     *
25098     * The widget's list of labels to show will be appended with the
25099     * given value. If the user wishes so, a callback function pointer
25100     * can be passed, which will get called when this same item is
25101     * selected.
25102     *
25103     * @note The current selection @b won't be modified by appending an
25104     * element to the list.
25105     *
25106     * @note The maximum length of the text label is going to be
25107     * determined <b>by the widget's theme</b>. Strings larger than
25108     * that value are going to be @b truncated.
25109     *
25110     * @ingroup Flipselector
25111     */
25112    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25113
25114    /**
25115     * Prepend a (text) item to a flip selector widget
25116     *
25117     * @param obj The flipselector object
25118     * @param label The (text) label of the new item
25119     * @param func Convenience callback function to take place when
25120     * item is selected
25121     * @param data Data passed to @p func, above
25122     * @return A handle to the item added or @c NULL, on errors
25123     *
25124     * The widget's list of labels to show will be prepended with the
25125     * given value. If the user wishes so, a callback function pointer
25126     * can be passed, which will get called when this same item is
25127     * selected.
25128     *
25129     * @note The current selection @b won't be modified by prepending
25130     * an element to the list.
25131     *
25132     * @note The maximum length of the text label is going to be
25133     * determined <b>by the widget's theme</b>. Strings larger than
25134     * that value are going to be @b truncated.
25135     *
25136     * @ingroup Flipselector
25137     */
25138    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25139
25140    /**
25141     * Get the internal list of items in a given flip selector widget.
25142     *
25143     * @param obj The flipselector object
25144     * @return The list of items (#Elm_Object_Item as data) or
25145     * @c NULL on errors.
25146     *
25147     * This list is @b not to be modified in any way and must not be
25148     * freed. Use the list members with functions like
25149     * elm_object_item_text_set(),
25150     * elm_object_item_text_get(),
25151     * elm_flipselector_item_del(),
25152     * elm_flipselector_item_selected_get(),
25153     * elm_flipselector_item_selected_set().
25154     *
25155     * @warning This list is only valid until @p obj object's internal
25156     * items list is changed. It should be fetched again with another
25157     * call to this function when changes happen.
25158     *
25159     * @ingroup Flipselector
25160     */
25161    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25162
25163    /**
25164     * Get the first item in the given flip selector widget's list of
25165     * items.
25166     *
25167     * @param obj The flipselector object
25168     * @return The first item or @c NULL, if it has no items (and on
25169     * errors)
25170     *
25171     * @see elm_flipselector_item_append()
25172     * @see elm_flipselector_last_item_get()
25173     *
25174     * @ingroup Flipselector
25175     */
25176    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25177
25178    /**
25179     * Get the last item in the given flip selector widget's list of
25180     * items.
25181     *
25182     * @param obj The flipselector object
25183     * @return The last item or @c NULL, if it has no items (and on
25184     * errors)
25185     *
25186     * @see elm_flipselector_item_prepend()
25187     * @see elm_flipselector_first_item_get()
25188     *
25189     * @ingroup Flipselector
25190     */
25191    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25192
25193    /**
25194     * Get the currently selected item in a flip selector widget.
25195     *
25196     * @param obj The flipselector object
25197     * @return The selected item or @c NULL, if the widget has no items
25198     * (and on erros)
25199     *
25200     * @ingroup Flipselector
25201     */
25202    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25203
25204    /**
25205     * Set whether a given flip selector widget's item should be the
25206     * currently selected one.
25207     *
25208     * @param it The flip selector item
25209     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25210     *
25211     * This sets whether @p item is or not the selected (thus, under
25212     * display) one. If @p item is different than one under display,
25213     * the latter will be unselected. If the @p item is set to be
25214     * unselected, on the other hand, the @b first item in the widget's
25215     * internal members list will be the new selected one.
25216     *
25217     * @see elm_flipselector_item_selected_get()
25218     *
25219     * @ingroup Flipselector
25220     */
25221    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25222
25223    /**
25224     * Get whether a given flip selector widget's item is the currently
25225     * selected one.
25226     *
25227     * @param it The flip selector item
25228     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25229     * (or on errors).
25230     *
25231     * @see elm_flipselector_item_selected_set()
25232     *
25233     * @ingroup Flipselector
25234     */
25235    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25236
25237    /**
25238     * Delete a given item from a flip selector widget.
25239     *
25240     * @param it The item to delete
25241     *
25242     * @ingroup Flipselector
25243     */
25244    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25245
25246    /**
25247     * Get the label of a given flip selector widget's item.
25248     *
25249     * @param it The item to get label from
25250     * @return The text label of @p item or @c NULL, on errors
25251     *
25252     * @see elm_object_item_text_set()
25253     *
25254     * @deprecated see elm_object_item_text_get() instead
25255     * @ingroup Flipselector
25256     */
25257    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25258
25259    /**
25260     * Set the label of a given flip selector widget's item.
25261     *
25262     * @param it The item to set label on
25263     * @param label The text label string, in UTF-8 encoding
25264     *
25265     * @see elm_object_item_text_get()
25266     *
25267          * @deprecated see elm_object_item_text_set() instead
25268     * @ingroup Flipselector
25269     */
25270    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25271
25272    /**
25273     * Gets the item before @p item in a flip selector widget's
25274     * internal list of items.
25275     *
25276     * @param it The item to fetch previous from
25277     * @return The item before the @p item, in its parent's list. If
25278     *         there is no previous item for @p item or there's an
25279     *         error, @c NULL is returned.
25280     *
25281     * @see elm_flipselector_item_next_get()
25282     *
25283     * @ingroup Flipselector
25284     */
25285    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25286
25287    /**
25288     * Gets the item after @p item in a flip selector widget's
25289     * internal list of items.
25290     *
25291     * @param it The item to fetch next from
25292     * @return The item after the @p item, in its parent's list. If
25293     *         there is no next item for @p item or there's an
25294     *         error, @c NULL is returned.
25295     *
25296     * @see elm_flipselector_item_next_get()
25297     *
25298     * @ingroup Flipselector
25299     */
25300    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25301
25302    /**
25303     * Set the interval on time updates for an user mouse button hold
25304     * on a flip selector widget.
25305     *
25306     * @param obj The flip selector object
25307     * @param interval The (first) interval value in seconds
25308     *
25309     * This interval value is @b decreased while the user holds the
25310     * mouse pointer either flipping up or flipping doww a given flip
25311     * selector.
25312     *
25313     * This helps the user to get to a given item distant from the
25314     * current one easier/faster, as it will start to flip quicker and
25315     * quicker on mouse button holds.
25316     *
25317     * The calculation for the next flip interval value, starting from
25318     * the one set with this call, is the previous interval divided by
25319     * 1.05, so it decreases a little bit.
25320     *
25321     * The default starting interval value for automatic flips is
25322     * @b 0.85 seconds.
25323     *
25324     * @see elm_flipselector_interval_get()
25325     *
25326     * @ingroup Flipselector
25327     */
25328    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25329
25330    /**
25331     * Get the interval on time updates for an user mouse button hold
25332     * on a flip selector widget.
25333     *
25334     * @param obj The flip selector object
25335     * @return The (first) interval value, in seconds, set on it
25336     *
25337     * @see elm_flipselector_interval_set() for more details
25338     *
25339     * @ingroup Flipselector
25340     */
25341    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25342    /**
25343     * @}
25344     */
25345
25346    /**
25347     * @addtogroup Calendar
25348     * @{
25349     */
25350
25351    /**
25352     * @enum _Elm_Calendar_Mark_Repeat
25353     * @typedef Elm_Calendar_Mark_Repeat
25354     *
25355     * Event periodicity, used to define if a mark should be repeated
25356     * @b beyond event's day. It's set when a mark is added.
25357     *
25358     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25359     * there will be marks every week after this date. Marks will be displayed
25360     * at 13th, 20th, 27th, 3rd June ...
25361     *
25362     * Values don't work as bitmask, only one can be choosen.
25363     *
25364     * @see elm_calendar_mark_add()
25365     *
25366     * @ingroup Calendar
25367     */
25368    typedef enum _Elm_Calendar_Mark_Repeat
25369      {
25370         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25371         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25372         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25373         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*/
25374         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. */
25375      } Elm_Calendar_Mark_Repeat;
25376
25377    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(). */
25378
25379    /**
25380     * Add a new calendar widget to the given parent Elementary
25381     * (container) object.
25382     *
25383     * @param parent The parent object.
25384     * @return a new calendar widget handle or @c NULL, on errors.
25385     *
25386     * This function inserts a new calendar widget on the canvas.
25387     *
25388     * @ref calendar_example_01
25389     *
25390     * @ingroup Calendar
25391     */
25392    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25393
25394    /**
25395     * Get weekdays names displayed by the calendar.
25396     *
25397     * @param obj The calendar object.
25398     * @return Array of seven strings to be used as weekday names.
25399     *
25400     * By default, weekdays abbreviations get from system are displayed:
25401     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25402     * The first string is related to Sunday, the second to Monday...
25403     *
25404     * @see elm_calendar_weekdays_name_set()
25405     *
25406     * @ref calendar_example_05
25407     *
25408     * @ingroup Calendar
25409     */
25410    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25411
25412    /**
25413     * Set weekdays names to be displayed by the calendar.
25414     *
25415     * @param obj The calendar object.
25416     * @param weekdays Array of seven strings to be used as weekday names.
25417     * @warning It must have 7 elements, or it will access invalid memory.
25418     * @warning The strings must be NULL terminated ('@\0').
25419     *
25420     * By default, weekdays abbreviations get from system are displayed:
25421     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25422     *
25423     * The first string should be related to Sunday, the second to Monday...
25424     *
25425     * The usage should be like this:
25426     * @code
25427     *   const char *weekdays[] =
25428     *   {
25429     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25430     *      "Thursday", "Friday", "Saturday"
25431     *   };
25432     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25433     * @endcode
25434     *
25435     * @see elm_calendar_weekdays_name_get()
25436     *
25437     * @ref calendar_example_02
25438     *
25439     * @ingroup Calendar
25440     */
25441    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25442
25443    /**
25444     * Set the minimum and maximum values for the year
25445     *
25446     * @param obj The calendar object
25447     * @param min The minimum year, greater than 1901;
25448     * @param max The maximum year;
25449     *
25450     * Maximum must be greater than minimum, except if you don't wan't to set
25451     * maximum year.
25452     * Default values are 1902 and -1.
25453     *
25454     * If the maximum year is a negative value, it will be limited depending
25455     * on the platform architecture (year 2037 for 32 bits);
25456     *
25457     * @see elm_calendar_min_max_year_get()
25458     *
25459     * @ref calendar_example_03
25460     *
25461     * @ingroup Calendar
25462     */
25463    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25464
25465    /**
25466     * Get the minimum and maximum values for the year
25467     *
25468     * @param obj The calendar object.
25469     * @param min The minimum year.
25470     * @param max The maximum year.
25471     *
25472     * Default values are 1902 and -1.
25473     *
25474     * @see elm_calendar_min_max_year_get() for more details.
25475     *
25476     * @ref calendar_example_05
25477     *
25478     * @ingroup Calendar
25479     */
25480    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25481
25482    /**
25483     * Enable or disable day selection
25484     *
25485     * @param obj The calendar object.
25486     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25487     * disable it.
25488     *
25489     * Enabled by default. If disabled, the user still can select months,
25490     * but not days. Selected days are highlighted on calendar.
25491     * It should be used if you won't need such selection for the widget usage.
25492     *
25493     * When a day is selected, or month is changed, smart callbacks for
25494     * signal "changed" will be called.
25495     *
25496     * @see elm_calendar_day_selection_enable_get()
25497     *
25498     * @ref calendar_example_04
25499     *
25500     * @ingroup Calendar
25501     */
25502    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25503
25504    /**
25505     * Get a value whether day selection is enabled or not.
25506     *
25507     * @see elm_calendar_day_selection_enable_set() for details.
25508     *
25509     * @param obj The calendar object.
25510     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25511     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25512     *
25513     * @ref calendar_example_05
25514     *
25515     * @ingroup Calendar
25516     */
25517    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25518
25519
25520    /**
25521     * Set selected date to be highlighted on calendar.
25522     *
25523     * @param obj The calendar object.
25524     * @param selected_time A @b tm struct to represent the selected date.
25525     *
25526     * Set the selected date, changing the displayed month if needed.
25527     * Selected date changes when the user goes to next/previous month or
25528     * select a day pressing over it on calendar.
25529     *
25530     * @see elm_calendar_selected_time_get()
25531     *
25532     * @ref calendar_example_04
25533     *
25534     * @ingroup Calendar
25535     */
25536    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25537
25538    /**
25539     * Get selected date.
25540     *
25541     * @param obj The calendar object
25542     * @param selected_time A @b tm struct to point to selected date
25543     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25544     * be considered.
25545     *
25546     * Get date selected by the user or set by function
25547     * elm_calendar_selected_time_set().
25548     * Selected date changes when the user goes to next/previous month or
25549     * select a day pressing over it on calendar.
25550     *
25551     * @see elm_calendar_selected_time_get()
25552     *
25553     * @ref calendar_example_05
25554     *
25555     * @ingroup Calendar
25556     */
25557    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25558
25559    /**
25560     * Set a function to format the string that will be used to display
25561     * month and year;
25562     *
25563     * @param obj The calendar object
25564     * @param format_function Function to set the month-year string given
25565     * the selected date
25566     *
25567     * By default it uses strftime with "%B %Y" format string.
25568     * It should allocate the memory that will be used by the string,
25569     * that will be freed by the widget after usage.
25570     * A pointer to the string and a pointer to the time struct will be provided.
25571     *
25572     * Example:
25573     * @code
25574     * static char *
25575     * _format_month_year(struct tm *selected_time)
25576     * {
25577     *    char buf[32];
25578     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25579     *    return strdup(buf);
25580     * }
25581     *
25582     * elm_calendar_format_function_set(calendar, _format_month_year);
25583     * @endcode
25584     *
25585     * @ref calendar_example_02
25586     *
25587     * @ingroup Calendar
25588     */
25589    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25590
25591    /**
25592     * Add a new mark to the calendar
25593     *
25594     * @param obj The calendar object
25595     * @param mark_type A string used to define the type of mark. It will be
25596     * emitted to the theme, that should display a related modification on these
25597     * days representation.
25598     * @param mark_time A time struct to represent the date of inclusion of the
25599     * mark. For marks that repeats it will just be displayed after the inclusion
25600     * date in the calendar.
25601     * @param repeat Repeat the event following this periodicity. Can be a unique
25602     * mark (that don't repeat), daily, weekly, monthly or annually.
25603     * @return The created mark or @p NULL upon failure.
25604     *
25605     * Add a mark that will be drawn in the calendar respecting the insertion
25606     * time and periodicity. It will emit the type as signal to the widget theme.
25607     * Default theme supports "holiday" and "checked", but it can be extended.
25608     *
25609     * It won't immediately update the calendar, drawing the marks.
25610     * For this, call elm_calendar_marks_draw(). However, when user selects
25611     * next or previous month calendar forces marks drawn.
25612     *
25613     * Marks created with this method can be deleted with
25614     * elm_calendar_mark_del().
25615     *
25616     * Example
25617     * @code
25618     * struct tm selected_time;
25619     * time_t current_time;
25620     *
25621     * current_time = time(NULL) + 5 * 84600;
25622     * localtime_r(&current_time, &selected_time);
25623     * elm_calendar_mark_add(cal, "holiday", selected_time,
25624     *     ELM_CALENDAR_ANNUALLY);
25625     *
25626     * current_time = time(NULL) + 1 * 84600;
25627     * localtime_r(&current_time, &selected_time);
25628     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25629     *
25630     * elm_calendar_marks_draw(cal);
25631     * @endcode
25632     *
25633     * @see elm_calendar_marks_draw()
25634     * @see elm_calendar_mark_del()
25635     *
25636     * @ref calendar_example_06
25637     *
25638     * @ingroup Calendar
25639     */
25640    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);
25641
25642    /**
25643     * Delete mark from the calendar.
25644     *
25645     * @param mark The mark to be deleted.
25646     *
25647     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25648     * should be used instead of getting marks list and deleting each one.
25649     *
25650     * @see elm_calendar_mark_add()
25651     *
25652     * @ref calendar_example_06
25653     *
25654     * @ingroup Calendar
25655     */
25656    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25657
25658    /**
25659     * Remove all calendar's marks
25660     *
25661     * @param obj The calendar object.
25662     *
25663     * @see elm_calendar_mark_add()
25664     * @see elm_calendar_mark_del()
25665     *
25666     * @ingroup Calendar
25667     */
25668    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25669
25670
25671    /**
25672     * Get a list of all the calendar marks.
25673     *
25674     * @param obj The calendar object.
25675     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25676     *
25677     * @see elm_calendar_mark_add()
25678     * @see elm_calendar_mark_del()
25679     * @see elm_calendar_marks_clear()
25680     *
25681     * @ingroup Calendar
25682     */
25683    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25684
25685    /**
25686     * Draw calendar marks.
25687     *
25688     * @param obj The calendar object.
25689     *
25690     * Should be used after adding, removing or clearing marks.
25691     * It will go through the entire marks list updating the calendar.
25692     * If lots of marks will be added, add all the marks and then call
25693     * this function.
25694     *
25695     * When the month is changed, i.e. user selects next or previous month,
25696     * marks will be drawed.
25697     *
25698     * @see elm_calendar_mark_add()
25699     * @see elm_calendar_mark_del()
25700     * @see elm_calendar_marks_clear()
25701     *
25702     * @ref calendar_example_06
25703     *
25704     * @ingroup Calendar
25705     */
25706    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25707
25708    /**
25709     * Set a day text color to the same that represents Saturdays.
25710     *
25711     * @param obj The calendar object.
25712     * @param pos The text position. Position is the cell counter, from left
25713     * to right, up to down. It starts on 0 and ends on 41.
25714     *
25715     * @deprecated use elm_calendar_mark_add() instead like:
25716     *
25717     * @code
25718     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25719     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25720     * @endcode
25721     *
25722     * @see elm_calendar_mark_add()
25723     *
25724     * @ingroup Calendar
25725     */
25726    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25727
25728    /**
25729     * Set a day text color to the same that represents Sundays.
25730     *
25731     * @param obj The calendar object.
25732     * @param pos The text position. Position is the cell counter, from left
25733     * to right, up to down. It starts on 0 and ends on 41.
25734
25735     * @deprecated use elm_calendar_mark_add() instead like:
25736     *
25737     * @code
25738     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25739     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25740     * @endcode
25741     *
25742     * @see elm_calendar_mark_add()
25743     *
25744     * @ingroup Calendar
25745     */
25746    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25747
25748    /**
25749     * Set a day text color to the same that represents Weekdays.
25750     *
25751     * @param obj The calendar object
25752     * @param pos The text position. Position is the cell counter, from left
25753     * to right, up to down. It starts on 0 and ends on 41.
25754     *
25755     * @deprecated use elm_calendar_mark_add() instead like:
25756     *
25757     * @code
25758     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25759     *
25760     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25761     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25762     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25763     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25764     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25765     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25766     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25767     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25768     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25769     * @endcode
25770     *
25771     * @see elm_calendar_mark_add()
25772     *
25773     * @ingroup Calendar
25774     */
25775    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25776
25777    /**
25778     * Set the interval on time updates for an user mouse button hold
25779     * on calendar widgets' month selection.
25780     *
25781     * @param obj The calendar object
25782     * @param interval The (first) interval value in seconds
25783     *
25784     * This interval value is @b decreased while the user holds the
25785     * mouse pointer either selecting next or previous month.
25786     *
25787     * This helps the user to get to a given month distant from the
25788     * current one easier/faster, as it will start to change quicker and
25789     * quicker on mouse button holds.
25790     *
25791     * The calculation for the next change interval value, starting from
25792     * the one set with this call, is the previous interval divided by
25793     * 1.05, so it decreases a little bit.
25794     *
25795     * The default starting interval value for automatic changes is
25796     * @b 0.85 seconds.
25797     *
25798     * @see elm_calendar_interval_get()
25799     *
25800     * @ingroup Calendar
25801     */
25802    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25803
25804    /**
25805     * Get the interval on time updates for an user mouse button hold
25806     * on calendar widgets' month selection.
25807     *
25808     * @param obj The calendar object
25809     * @return The (first) interval value, in seconds, set on it
25810     *
25811     * @see elm_calendar_interval_set() for more details
25812     *
25813     * @ingroup Calendar
25814     */
25815    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25816
25817    /**
25818     * @}
25819     */
25820
25821    /**
25822     * @defgroup Diskselector Diskselector
25823     * @ingroup Elementary
25824     *
25825     * @image html img/widget/diskselector/preview-00.png
25826     * @image latex img/widget/diskselector/preview-00.eps
25827     *
25828     * A diskselector is a kind of list widget. It scrolls horizontally,
25829     * and can contain label and icon objects. Three items are displayed
25830     * with the selected one in the middle.
25831     *
25832     * It can act like a circular list with round mode and labels can be
25833     * reduced for a defined length for side items.
25834     *
25835     * Smart callbacks one can listen to:
25836     * - "selected" - when item is selected, i.e. scroller stops.
25837     *
25838     * Available styles for it:
25839     * - @c "default"
25840     *
25841     * List of examples:
25842     * @li @ref diskselector_example_01
25843     * @li @ref diskselector_example_02
25844     */
25845
25846    /**
25847     * @addtogroup Diskselector
25848     * @{
25849     */
25850
25851    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(). */
25852
25853    /**
25854     * Add a new diskselector widget to the given parent Elementary
25855     * (container) object.
25856     *
25857     * @param parent The parent object.
25858     * @return a new diskselector widget handle or @c NULL, on errors.
25859     *
25860     * This function inserts a new diskselector widget on the canvas.
25861     *
25862     * @ingroup Diskselector
25863     */
25864    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25865
25866    /**
25867     * Enable or disable round mode.
25868     *
25869     * @param obj The diskselector object.
25870     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25871     * disable it.
25872     *
25873     * Disabled by default. If round mode is enabled the items list will
25874     * work like a circle list, so when the user reaches the last item,
25875     * the first one will popup.
25876     *
25877     * @see elm_diskselector_round_get()
25878     *
25879     * @ingroup Diskselector
25880     */
25881    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25882
25883    /**
25884     * Get a value whether round mode is enabled or not.
25885     *
25886     * @see elm_diskselector_round_set() for details.
25887     *
25888     * @param obj The diskselector object.
25889     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25890     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25891     *
25892     * @ingroup Diskselector
25893     */
25894    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25895
25896    /**
25897     * Get the side labels max length.
25898     *
25899     * @deprecated use elm_diskselector_side_label_length_get() instead:
25900     *
25901     * @param obj The diskselector object.
25902     * @return The max length defined for side labels, or 0 if not a valid
25903     * diskselector.
25904     *
25905     * @ingroup Diskselector
25906     */
25907    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25908
25909    /**
25910     * Set the side labels max length.
25911     *
25912     * @deprecated use elm_diskselector_side_label_length_set() instead:
25913     *
25914     * @param obj The diskselector object.
25915     * @param len The max length defined for side labels.
25916     *
25917     * @ingroup Diskselector
25918     */
25919    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25920
25921    /**
25922     * Get the side labels max length.
25923     *
25924     * @see elm_diskselector_side_label_length_set() for details.
25925     *
25926     * @param obj The diskselector object.
25927     * @return The max length defined for side labels, or 0 if not a valid
25928     * diskselector.
25929     *
25930     * @ingroup Diskselector
25931     */
25932    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25933
25934    /**
25935     * Set the side labels max length.
25936     *
25937     * @param obj The diskselector object.
25938     * @param len The max length defined for side labels.
25939     *
25940     * Length is the number of characters of items' label that will be
25941     * visible when it's set on side positions. It will just crop
25942     * the string after defined size. E.g.:
25943     *
25944     * An item with label "January" would be displayed on side position as
25945     * "Jan" if max length is set to 3, or "Janu", if this property
25946     * is set to 4.
25947     *
25948     * When it's selected, the entire label will be displayed, except for
25949     * width restrictions. In this case label will be cropped and "..."
25950     * will be concatenated.
25951     *
25952     * Default side label max length is 3.
25953     *
25954     * This property will be applyed over all items, included before or
25955     * later this function call.
25956     *
25957     * @ingroup Diskselector
25958     */
25959    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25960
25961    /**
25962     * Set the number of items to be displayed.
25963     *
25964     * @param obj The diskselector object.
25965     * @param num The number of items the diskselector will display.
25966     *
25967     * Default value is 3, and also it's the minimun. If @p num is less
25968     * than 3, it will be set to 3.
25969     *
25970     * Also, it can be set on theme, using data item @c display_item_num
25971     * on group "elm/diskselector/item/X", where X is style set.
25972     * E.g.:
25973     *
25974     * group { name: "elm/diskselector/item/X";
25975     * data {
25976     *     item: "display_item_num" "5";
25977     *     }
25978     *
25979     * @ingroup Diskselector
25980     */
25981    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25982
25983    /**
25984     * Get the number of items in the diskselector object.
25985     *
25986     * @param obj The diskselector object.
25987     *
25988     * @ingroup Diskselector
25989     */
25990    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25991
25992    /**
25993     * Set bouncing behaviour when the scrolled content reaches an edge.
25994     *
25995     * Tell the internal scroller object whether it should bounce or not
25996     * when it reaches the respective edges for each axis.
25997     *
25998     * @param obj The diskselector object.
25999     * @param h_bounce Whether to bounce or not in the horizontal axis.
26000     * @param v_bounce Whether to bounce or not in the vertical axis.
26001     *
26002     * @see elm_scroller_bounce_set()
26003     *
26004     * @ingroup Diskselector
26005     */
26006    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26007
26008    /**
26009     * Get the bouncing behaviour of the internal scroller.
26010     *
26011     * Get whether the internal scroller should bounce when the edge of each
26012     * axis is reached scrolling.
26013     *
26014     * @param obj The diskselector object.
26015     * @param h_bounce Pointer where to store the bounce state of the horizontal
26016     * axis.
26017     * @param v_bounce Pointer where to store the bounce state of the vertical
26018     * axis.
26019     *
26020     * @see elm_scroller_bounce_get()
26021     * @see elm_diskselector_bounce_set()
26022     *
26023     * @ingroup Diskselector
26024     */
26025    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26026
26027    /**
26028     * Get the scrollbar policy.
26029     *
26030     * @see elm_diskselector_scroller_policy_get() for details.
26031     *
26032     * @param obj The diskselector object.
26033     * @param policy_h Pointer where to store horizontal scrollbar policy.
26034     * @param policy_v Pointer where to store vertical scrollbar policy.
26035     *
26036     * @ingroup Diskselector
26037     */
26038    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);
26039
26040    /**
26041     * Set the scrollbar policy.
26042     *
26043     * @param obj The diskselector object.
26044     * @param policy_h Horizontal scrollbar policy.
26045     * @param policy_v Vertical scrollbar policy.
26046     *
26047     * This sets the scrollbar visibility policy for the given scroller.
26048     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26049     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26050     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26051     * This applies respectively for the horizontal and vertical scrollbars.
26052     *
26053     * The both are disabled by default, i.e., are set to
26054     * #ELM_SCROLLER_POLICY_OFF.
26055     *
26056     * @ingroup Diskselector
26057     */
26058    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26059
26060    /**
26061     * Remove all diskselector's items.
26062     *
26063     * @param obj The diskselector object.
26064     *
26065     * @see elm_diskselector_item_del()
26066     * @see elm_diskselector_item_append()
26067     *
26068     * @ingroup Diskselector
26069     */
26070    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26071
26072    /**
26073     * Get a list of all the diskselector items.
26074     *
26075     * @param obj The diskselector object.
26076     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26077     * or @c NULL on failure.
26078     *
26079     * @see elm_diskselector_item_append()
26080     * @see elm_diskselector_item_del()
26081     * @see elm_diskselector_clear()
26082     *
26083     * @ingroup Diskselector
26084     */
26085    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26086
26087    /**
26088     * Appends a new item to the diskselector object.
26089     *
26090     * @param obj The diskselector object.
26091     * @param label The label of the diskselector item.
26092     * @param icon The icon object to use at left side of the item. An
26093     * icon can be any Evas object, but usually it is an icon created
26094     * with elm_icon_add().
26095     * @param func The function to call when the item is selected.
26096     * @param data The data to associate with the item for related callbacks.
26097     *
26098     * @return The created item or @c NULL upon failure.
26099     *
26100     * A new item will be created and appended to the diskselector, i.e., will
26101     * be set as last item. Also, if there is no selected item, it will
26102     * be selected. This will always happens for the first appended item.
26103     *
26104     * If no icon is set, label will be centered on item position, otherwise
26105     * the icon will be placed at left of the label, that will be shifted
26106     * to the right.
26107     *
26108     * Items created with this method can be deleted with
26109     * elm_diskselector_item_del().
26110     *
26111     * Associated @p data can be properly freed when item is deleted if a
26112     * callback function is set with elm_diskselector_item_del_cb_set().
26113     *
26114     * If a function is passed as argument, it will be called everytime this item
26115     * is selected, i.e., the user stops the diskselector with this
26116     * item on center position. If such function isn't needed, just passing
26117     * @c NULL as @p func is enough. The same should be done for @p data.
26118     *
26119     * Simple example (with no function callback or data associated):
26120     * @code
26121     * disk = elm_diskselector_add(win);
26122     * ic = elm_icon_add(win);
26123     * elm_icon_file_set(ic, "path/to/image", NULL);
26124     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26125     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26126     * @endcode
26127     *
26128     * @see elm_diskselector_item_del()
26129     * @see elm_diskselector_item_del_cb_set()
26130     * @see elm_diskselector_clear()
26131     * @see elm_icon_add()
26132     *
26133     * @ingroup Diskselector
26134     */
26135    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);
26136
26137
26138    /**
26139     * Delete them item from the diskselector.
26140     *
26141     * @param it The item of diskselector to be deleted.
26142     *
26143     * If deleting all diskselector items is required, elm_diskselector_clear()
26144     * should be used instead of getting items list and deleting each one.
26145     *
26146     * @see elm_diskselector_clear()
26147     * @see elm_diskselector_item_append()
26148     * @see elm_diskselector_item_del_cb_set()
26149     *
26150     * @ingroup Diskselector
26151     */
26152    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26153
26154    /**
26155     * Set the function called when a diskselector item is freed.
26156     *
26157     * @param it The item to set the callback on
26158     * @param func The function called
26159     *
26160     * If there is a @p func, then it will be called prior item's memory release.
26161     * That will be called with the following arguments:
26162     * @li item's data;
26163     * @li item's Evas object;
26164     * @li item itself;
26165     *
26166     * This way, a data associated to a diskselector item could be properly
26167     * freed.
26168     *
26169     * @ingroup Diskselector
26170     */
26171    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26172
26173    /**
26174     * Get the data associated to the item.
26175     *
26176     * @param it The diskselector item
26177     * @return The data associated to @p it
26178     *
26179     * The return value is a pointer to data associated to @p item when it was
26180     * created, with function elm_diskselector_item_append(). If no data
26181     * was passed as argument, it will return @c NULL.
26182     *
26183     * @see elm_diskselector_item_append()
26184     *
26185     * @ingroup Diskselector
26186     */
26187    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26188
26189    /**
26190     * Set the icon associated to the item.
26191     *
26192     * @param it The diskselector item
26193     * @param icon The icon object to associate with @p it
26194     *
26195     * The icon object to use at left side of the item. An
26196     * icon can be any Evas object, but usually it is an icon created
26197     * with elm_icon_add().
26198     *
26199     * Once the icon object is set, a previously set one will be deleted.
26200     * @warning Setting the same icon for two items will cause the icon to
26201     * dissapear from the first item.
26202     *
26203     * If an icon was passed as argument on item creation, with function
26204     * elm_diskselector_item_append(), it will be already
26205     * associated to the item.
26206     *
26207     * @see elm_diskselector_item_append()
26208     * @see elm_diskselector_item_icon_get()
26209     *
26210     * @ingroup Diskselector
26211     */
26212    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26213
26214    /**
26215     * Get the icon associated to the item.
26216     *
26217     * @param it The diskselector item
26218     * @return The icon associated to @p it
26219     *
26220     * The return value is a pointer to the icon associated to @p item when it was
26221     * created, with function elm_diskselector_item_append(), or later
26222     * with function elm_diskselector_item_icon_set. If no icon
26223     * was passed as argument, it will return @c NULL.
26224     *
26225     * @see elm_diskselector_item_append()
26226     * @see elm_diskselector_item_icon_set()
26227     *
26228     * @ingroup Diskselector
26229     */
26230    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26231
26232    /**
26233     * Set the label of item.
26234     *
26235     * @param it The item of diskselector.
26236     * @param label The label of item.
26237     *
26238     * The label to be displayed by the item.
26239     *
26240     * If no icon is set, label will be centered on item position, otherwise
26241     * the icon will be placed at left of the label, that will be shifted
26242     * to the right.
26243     *
26244     * An item with label "January" would be displayed on side position as
26245     * "Jan" if max length is set to 3 with function
26246     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26247     * is set to 4.
26248     *
26249     * When this @p item is selected, the entire label will be displayed,
26250     * except for width restrictions.
26251     * In this case label will be cropped and "..." will be concatenated,
26252     * but only for display purposes. It will keep the entire string, so
26253     * if diskselector is resized the remaining characters will be displayed.
26254     *
26255     * If a label was passed as argument on item creation, with function
26256     * elm_diskselector_item_append(), it will be already
26257     * displayed by the item.
26258     *
26259     * @see elm_diskselector_side_label_lenght_set()
26260     * @see elm_diskselector_item_label_get()
26261     * @see elm_diskselector_item_append()
26262     *
26263     * @ingroup Diskselector
26264     */
26265    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26266
26267    /**
26268     * Get the label of item.
26269     *
26270     * @param it The item of diskselector.
26271     * @return The label of item.
26272     *
26273     * The return value is a pointer to the label associated to @p item when it was
26274     * created, with function elm_diskselector_item_append(), or later
26275     * with function elm_diskselector_item_label_set. If no label
26276     * was passed as argument, it will return @c NULL.
26277     *
26278     * @see elm_diskselector_item_label_set() for more details.
26279     * @see elm_diskselector_item_append()
26280     *
26281     * @ingroup Diskselector
26282     */
26283    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26284
26285    /**
26286     * Get the selected item.
26287     *
26288     * @param obj The diskselector object.
26289     * @return The selected diskselector item.
26290     *
26291     * The selected item can be unselected with function
26292     * elm_diskselector_item_selected_set(), and the first item of
26293     * diskselector will be selected.
26294     *
26295     * The selected item always will be centered on diskselector, with
26296     * full label displayed, i.e., max lenght set to side labels won't
26297     * apply on the selected item. More details on
26298     * elm_diskselector_side_label_length_set().
26299     *
26300     * @ingroup Diskselector
26301     */
26302    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26303
26304    /**
26305     * Set the selected state of an item.
26306     *
26307     * @param it The diskselector item
26308     * @param selected The selected state
26309     *
26310     * This sets the selected state of the given item @p it.
26311     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26312     *
26313     * If a new item is selected the previosly selected will be unselected.
26314     * Previoulsy selected item can be get with function
26315     * elm_diskselector_selected_item_get().
26316     *
26317     * If the item @p it is unselected, the first item of diskselector will
26318     * be selected.
26319     *
26320     * Selected items will be visible on center position of diskselector.
26321     * So if it was on another position before selected, or was invisible,
26322     * diskselector will animate items until the selected item reaches center
26323     * position.
26324     *
26325     * @see elm_diskselector_item_selected_get()
26326     * @see elm_diskselector_selected_item_get()
26327     *
26328     * @ingroup Diskselector
26329     */
26330    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26331
26332    /*
26333     * Get whether the @p item is selected or not.
26334     *
26335     * @param it The diskselector item.
26336     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26337     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26338     *
26339     * @see elm_diskselector_selected_item_set() for details.
26340     * @see elm_diskselector_item_selected_get()
26341     *
26342     * @ingroup Diskselector
26343     */
26344    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26345
26346    /**
26347     * Get the first item of the diskselector.
26348     *
26349     * @param obj The diskselector object.
26350     * @return The first item, or @c NULL if none.
26351     *
26352     * The list of items follows append order. So it will return the first
26353     * item appended to the widget that wasn't deleted.
26354     *
26355     * @see elm_diskselector_item_append()
26356     * @see elm_diskselector_items_get()
26357     *
26358     * @ingroup Diskselector
26359     */
26360    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26361
26362    /**
26363     * Get the last item of the diskselector.
26364     *
26365     * @param obj The diskselector object.
26366     * @return The last item, or @c NULL if none.
26367     *
26368     * The list of items follows append order. So it will return last first
26369     * item appended to the widget that wasn't deleted.
26370     *
26371     * @see elm_diskselector_item_append()
26372     * @see elm_diskselector_items_get()
26373     *
26374     * @ingroup Diskselector
26375     */
26376    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26377
26378    /**
26379     * Get the item before @p item in diskselector.
26380     *
26381     * @param it The diskselector item.
26382     * @return The item before @p item, or @c NULL if none or on failure.
26383     *
26384     * The list of items follows append order. So it will return item appended
26385     * just before @p item and that wasn't deleted.
26386     *
26387     * If it is the first item, @c NULL will be returned.
26388     * First item can be get by elm_diskselector_first_item_get().
26389     *
26390     * @see elm_diskselector_item_append()
26391     * @see elm_diskselector_items_get()
26392     *
26393     * @ingroup Diskselector
26394     */
26395    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26396
26397    /**
26398     * Get the item after @p item in diskselector.
26399     *
26400     * @param it The diskselector item.
26401     * @return The item after @p item, or @c NULL if none or on failure.
26402     *
26403     * The list of items follows append order. So it will return item appended
26404     * just after @p item and that wasn't deleted.
26405     *
26406     * If it is the last item, @c NULL will be returned.
26407     * Last item can be get by elm_diskselector_last_item_get().
26408     *
26409     * @see elm_diskselector_item_append()
26410     * @see elm_diskselector_items_get()
26411     *
26412     * @ingroup Diskselector
26413     */
26414    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26415
26416    /**
26417     * Set the text to be shown in the diskselector item.
26418     *
26419     * @param item Target item
26420     * @param text The text to set in the content
26421     *
26422     * Setup the text as tooltip to object. The item can have only one tooltip,
26423     * so any previous tooltip data is removed.
26424     *
26425     * @see elm_object_tooltip_text_set() for more details.
26426     *
26427     * @ingroup Diskselector
26428     */
26429    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26430
26431    /**
26432     * Set the content to be shown in the tooltip item.
26433     *
26434     * Setup the tooltip to item. The item can have only one tooltip,
26435     * so any previous tooltip data is removed. @p func(with @p data) will
26436     * be called every time that need show the tooltip and it should
26437     * return a valid Evas_Object. This object is then managed fully by
26438     * tooltip system and is deleted when the tooltip is gone.
26439     *
26440     * @param item the diskselector item being attached a tooltip.
26441     * @param func the function used to create the tooltip contents.
26442     * @param data what to provide to @a func as callback data/context.
26443     * @param del_cb called when data is not needed anymore, either when
26444     *        another callback replaces @p func, the tooltip is unset with
26445     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26446     *        dies. This callback receives as the first parameter the
26447     *        given @a data, and @c event_info is the item.
26448     *
26449     * @see elm_object_tooltip_content_cb_set() for more details.
26450     *
26451     * @ingroup Diskselector
26452     */
26453    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);
26454
26455    /**
26456     * Unset tooltip from item.
26457     *
26458     * @param item diskselector item to remove previously set tooltip.
26459     *
26460     * Remove tooltip from item. The callback provided as del_cb to
26461     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26462     * it is not used anymore.
26463     *
26464     * @see elm_object_tooltip_unset() for more details.
26465     * @see elm_diskselector_item_tooltip_content_cb_set()
26466     *
26467     * @ingroup Diskselector
26468     */
26469    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26470
26471
26472    /**
26473     * Sets a different style for this item tooltip.
26474     *
26475     * @note before you set a style you should define a tooltip with
26476     *       elm_diskselector_item_tooltip_content_cb_set() or
26477     *       elm_diskselector_item_tooltip_text_set()
26478     *
26479     * @param item diskselector item with tooltip already set.
26480     * @param style the theme style to use (default, transparent, ...)
26481     *
26482     * @see elm_object_tooltip_style_set() for more details.
26483     *
26484     * @ingroup Diskselector
26485     */
26486    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26487
26488    /**
26489     * Get the style for this item tooltip.
26490     *
26491     * @param item diskselector item with tooltip already set.
26492     * @return style the theme style in use, defaults to "default". If the
26493     *         object does not have a tooltip set, then NULL is returned.
26494     *
26495     * @see elm_object_tooltip_style_get() for more details.
26496     * @see elm_diskselector_item_tooltip_style_set()
26497     *
26498     * @ingroup Diskselector
26499     */
26500    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26501
26502    /**
26503     * Set the cursor to be shown when mouse is over the diskselector item
26504     *
26505     * @param item Target item
26506     * @param cursor the cursor name to be used.
26507     *
26508     * @see elm_object_cursor_set() for more details.
26509     *
26510     * @ingroup Diskselector
26511     */
26512    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26513
26514    /**
26515     * Get the cursor to be shown when mouse is over the diskselector item
26516     *
26517     * @param item diskselector item with cursor already set.
26518     * @return the cursor name.
26519     *
26520     * @see elm_object_cursor_get() for more details.
26521     * @see elm_diskselector_cursor_set()
26522     *
26523     * @ingroup Diskselector
26524     */
26525    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26526
26527
26528    /**
26529     * Unset the cursor to be shown when mouse is over the diskselector item
26530     *
26531     * @param item Target item
26532     *
26533     * @see elm_object_cursor_unset() for more details.
26534     * @see elm_diskselector_cursor_set()
26535     *
26536     * @ingroup Diskselector
26537     */
26538    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26539
26540    /**
26541     * Sets a different style for this item cursor.
26542     *
26543     * @note before you set a style you should define a cursor with
26544     *       elm_diskselector_item_cursor_set()
26545     *
26546     * @param item diskselector item with cursor already set.
26547     * @param style the theme style to use (default, transparent, ...)
26548     *
26549     * @see elm_object_cursor_style_set() for more details.
26550     *
26551     * @ingroup Diskselector
26552     */
26553    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26554
26555
26556    /**
26557     * Get the style for this item cursor.
26558     *
26559     * @param item diskselector item with cursor already set.
26560     * @return style the theme style in use, defaults to "default". If the
26561     *         object does not have a cursor set, then @c NULL is returned.
26562     *
26563     * @see elm_object_cursor_style_get() for more details.
26564     * @see elm_diskselector_item_cursor_style_set()
26565     *
26566     * @ingroup Diskselector
26567     */
26568    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26569
26570
26571    /**
26572     * Set if the cursor set should be searched on the theme or should use
26573     * the provided by the engine, only.
26574     *
26575     * @note before you set if should look on theme you should define a cursor
26576     * with elm_diskselector_item_cursor_set().
26577     * By default it will only look for cursors provided by the engine.
26578     *
26579     * @param item widget item with cursor already set.
26580     * @param engine_only boolean to define if cursors set with
26581     * elm_diskselector_item_cursor_set() should be searched only
26582     * between cursors provided by the engine or searched on widget's
26583     * theme as well.
26584     *
26585     * @see elm_object_cursor_engine_only_set() for more details.
26586     *
26587     * @ingroup Diskselector
26588     */
26589    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26590
26591    /**
26592     * Get the cursor engine only usage for this item cursor.
26593     *
26594     * @param item widget item with cursor already set.
26595     * @return engine_only boolean to define it cursors should be looked only
26596     * between the provided by the engine or searched on widget's theme as well.
26597     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26598     *
26599     * @see elm_object_cursor_engine_only_get() for more details.
26600     * @see elm_diskselector_item_cursor_engine_only_set()
26601     *
26602     * @ingroup Diskselector
26603     */
26604    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26605
26606    /**
26607     * @}
26608     */
26609
26610    /**
26611     * @defgroup Colorselector Colorselector
26612     *
26613     * @{
26614     *
26615     * @image html img/widget/colorselector/preview-00.png
26616     * @image latex img/widget/colorselector/preview-00.eps
26617     *
26618     * @brief Widget for user to select a color.
26619     *
26620     * Signals that you can add callbacks for are:
26621     * "changed" - When the color value changes(event_info is NULL).
26622     *
26623     * See @ref tutorial_colorselector.
26624     */
26625    /**
26626     * @brief Add a new colorselector to the parent
26627     *
26628     * @param parent The parent object
26629     * @return The new object or NULL if it cannot be created
26630     *
26631     * @ingroup Colorselector
26632     */
26633    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26634    /**
26635     * Set a color for the colorselector
26636     *
26637     * @param obj   Colorselector object
26638     * @param r     r-value of color
26639     * @param g     g-value of color
26640     * @param b     b-value of color
26641     * @param a     a-value of color
26642     *
26643     * @ingroup Colorselector
26644     */
26645    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26646    /**
26647     * Get a color from the colorselector
26648     *
26649     * @param obj   Colorselector object
26650     * @param r     integer pointer for r-value of color
26651     * @param g     integer pointer for g-value of color
26652     * @param b     integer pointer for b-value of color
26653     * @param a     integer pointer for a-value of color
26654     *
26655     * @ingroup Colorselector
26656     */
26657    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26658    /**
26659     * @}
26660     */
26661
26662    /**
26663     * @defgroup Ctxpopup Ctxpopup
26664     *
26665     * @image html img/widget/ctxpopup/preview-00.png
26666     * @image latex img/widget/ctxpopup/preview-00.eps
26667     *
26668     * @brief Context popup widet.
26669     *
26670     * A ctxpopup is a widget that, when shown, pops up a list of items.
26671     * It automatically chooses an area inside its parent object's view
26672     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26673     * optimally fit into it. In the default theme, it will also point an
26674     * arrow to it's top left position at the time one shows it. Ctxpopup
26675     * items have a label and/or an icon. It is intended for a small
26676     * number of items (hence the use of list, not genlist).
26677     *
26678     * @note Ctxpopup is a especialization of @ref Hover.
26679     *
26680     * Signals that you can add callbacks for are:
26681     * "dismissed" - the ctxpopup was dismissed
26682     *
26683     * Default contents parts of the ctxpopup widget that you can use for are:
26684     * @li "default" - A content of the ctxpopup
26685     *
26686     * Default contents parts of the naviframe items that you can use for are:
26687     * @li "icon" - A icon in the title area
26688     * 
26689     * Default text parts of the naviframe items that you can use for are:
26690     * @li "default" - Title label in the title area
26691     *
26692     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26693     * @{
26694     */
26695    typedef enum _Elm_Ctxpopup_Direction
26696      {
26697         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26698                                           area */
26699         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26700                                            the clicked area */
26701         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26702                                           the clicked area */
26703         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26704                                         area */
26705         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26706      } Elm_Ctxpopup_Direction;
26707
26708    /**
26709     * @brief Add a new Ctxpopup object to the parent.
26710     *
26711     * @param parent Parent object
26712     * @return New object or @c NULL, if it cannot be created
26713     */
26714    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26715    /**
26716     * @brief Set the Ctxpopup's parent
26717     *
26718     * @param obj The ctxpopup object
26719     * @param area The parent to use
26720     *
26721     * Set the parent object.
26722     *
26723     * @note elm_ctxpopup_add() will automatically call this function
26724     * with its @c parent argument.
26725     *
26726     * @see elm_ctxpopup_add()
26727     * @see elm_hover_parent_set()
26728     */
26729    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26730    /**
26731     * @brief Get the Ctxpopup's parent
26732     *
26733     * @param obj The ctxpopup object
26734     *
26735     * @see elm_ctxpopup_hover_parent_set() for more information
26736     */
26737    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26738    /**
26739     * @brief Clear all items in the given ctxpopup object.
26740     *
26741     * @param obj Ctxpopup object
26742     */
26743    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26744    /**
26745     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26746     *
26747     * @param obj Ctxpopup object
26748     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26749     */
26750    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26751    /**
26752     * @brief Get the value of current ctxpopup object's orientation.
26753     *
26754     * @param obj Ctxpopup object
26755     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26756     *
26757     * @see elm_ctxpopup_horizontal_set()
26758     */
26759    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26760    /**
26761     * @brief Add a new item to a ctxpopup object.
26762     *
26763     * @param obj Ctxpopup object
26764     * @param icon Icon to be set on new item
26765     * @param label The Label of the new item
26766     * @param func Convenience function called when item selected
26767     * @param data Data passed to @p func
26768     * @return A handle to the item added or @c NULL, on errors
26769     *
26770     * @warning Ctxpopup can't hold both an item list and a content at the same
26771     * time. When an item is added, any previous content will be removed.
26772     *
26773     * @see elm_ctxpopup_content_set()
26774     */
26775    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);
26776    /**
26777     * @brief Delete the given item in a ctxpopup object.
26778     *
26779     * @param it Ctxpopup item to be deleted
26780     *
26781     * @see elm_ctxpopup_item_append()
26782     */
26783    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26784    /**
26785     * @brief Set the ctxpopup item's state as disabled or enabled.
26786     *
26787     * @param it Ctxpopup item to be enabled/disabled
26788     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26789     *
26790     * When disabled the item is greyed out to indicate it's state.
26791     * @deprecated use elm_object_item_disabled_set() instead
26792     */
26793    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26794    /**
26795     * @brief Get the ctxpopup item's disabled/enabled state.
26796     *
26797     * @param it Ctxpopup item to be enabled/disabled
26798     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26799     *
26800     * @see elm_ctxpopup_item_disabled_set()
26801     * @deprecated use elm_object_item_disabled_get() instead
26802     */
26803    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26804    /**
26805     * @brief Get the icon object for the given ctxpopup item.
26806     *
26807     * @param it Ctxpopup item
26808     * @return icon object or @c NULL, if the item does not have icon or an error
26809     * occurred
26810     *
26811     * @see elm_ctxpopup_item_append()
26812     * @see elm_ctxpopup_item_icon_set()
26813     *
26814     * @deprecated use elm_object_item_part_content_get() instead
26815     */
26816    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26817    /**
26818     * @brief Sets the side icon associated with the ctxpopup item
26819     *
26820     * @param it Ctxpopup item
26821     * @param icon Icon object to be set
26822     *
26823     * Once the icon object is set, a previously set one will be deleted.
26824     * @warning Setting the same icon for two items will cause the icon to
26825     * dissapear from the first item.
26826     *
26827     * @see elm_ctxpopup_item_append()
26828     *  
26829     * @deprecated use elm_object_item_part_content_set() instead
26830     *
26831     */
26832    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26833    /**
26834     * @brief Get the label for the given ctxpopup item.
26835     *
26836     * @param it Ctxpopup item
26837     * @return label string or @c NULL, if the item does not have label or an
26838     * error occured
26839     *
26840     * @see elm_ctxpopup_item_append()
26841     * @see elm_ctxpopup_item_label_set()
26842     *
26843     * @deprecated use elm_object_item_text_get() instead
26844     */
26845    EINA_DEPRECATED EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26846    /**
26847     * @brief (Re)set the label on the given ctxpopup item.
26848     *
26849     * @param it Ctxpopup item
26850     * @param label String to set as label
26851     *
26852     * @deprecated use elm_object_item_text_set() instead
26853     */
26854    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26855    /**
26856     * @brief Set an elm widget as the content of the ctxpopup.
26857     *
26858     * @param obj Ctxpopup object
26859     * @param content Content to be swallowed
26860     *
26861     * If the content object is already set, a previous one will bedeleted. If
26862     * you want to keep that old content object, use the
26863     * elm_ctxpopup_content_unset() function.
26864     *
26865     * @warning Ctxpopup can't hold both a item list and a content at the same
26866     * time. When a content is set, any previous items will be removed.
26867     * 
26868     * @deprecated use elm_object_content_set() instead
26869     *
26870     */
26871    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26872    /**
26873     * @brief Unset the ctxpopup content
26874     *
26875     * @param obj Ctxpopup object
26876     * @return The content that was being used
26877     *
26878     * Unparent and return the content object which was set for this widget.
26879     *
26880     * @deprecated use elm_object_content_unset()
26881     *
26882     * @see elm_ctxpopup_content_set()
26883     *
26884     * @deprecated use elm_object_content_unset() instead
26885     *
26886     */
26887    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26888    /**
26889     * @brief Set the direction priority of a ctxpopup.
26890     *
26891     * @param obj Ctxpopup object
26892     * @param first 1st priority of direction
26893     * @param second 2nd priority of direction
26894     * @param third 3th priority of direction
26895     * @param fourth 4th priority of direction
26896     *
26897     * This functions gives a chance to user to set the priority of ctxpopup
26898     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26899     * requested direction.
26900     *
26901     * @see Elm_Ctxpopup_Direction
26902     */
26903    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);
26904    /**
26905     * @brief Get the direction priority of a ctxpopup.
26906     *
26907     * @param obj Ctxpopup object
26908     * @param first 1st priority of direction to be returned
26909     * @param second 2nd priority of direction to be returned
26910     * @param third 3th priority of direction to be returned
26911     * @param fourth 4th priority of direction to be returned
26912     *
26913     * @see elm_ctxpopup_direction_priority_set() for more information.
26914     */
26915    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);
26916
26917    /**
26918     * @brief Get the current direction of a ctxpopup.
26919     *
26920     * @param obj Ctxpopup object
26921     * @return current direction of a ctxpopup
26922     *
26923     * @warning Once the ctxpopup showed up, the direction would be determined
26924     */
26925    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26926
26927    /**
26928     * @}
26929     */
26930
26931    /* transit */
26932    /**
26933     *
26934     * @defgroup Transit Transit
26935     * @ingroup Elementary
26936     *
26937     * Transit is designed to apply various animated transition effects to @c
26938     * Evas_Object, such like translation, rotation, etc. For using these
26939     * effects, create an @ref Elm_Transit and add the desired transition effects.
26940     *
26941     * Once the effects are added into transit, they will be automatically
26942     * managed (their callback will be called until the duration is ended, and
26943     * they will be deleted on completion).
26944     *
26945     * Example:
26946     * @code
26947     * Elm_Transit *trans = elm_transit_add();
26948     * elm_transit_object_add(trans, obj);
26949     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26950     * elm_transit_duration_set(transit, 1);
26951     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26952     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26953     * elm_transit_repeat_times_set(transit, 3);
26954     * @endcode
26955     *
26956     * Some transition effects are used to change the properties of objects. They
26957     * are:
26958     * @li @ref elm_transit_effect_translation_add
26959     * @li @ref elm_transit_effect_color_add
26960     * @li @ref elm_transit_effect_rotation_add
26961     * @li @ref elm_transit_effect_wipe_add
26962     * @li @ref elm_transit_effect_zoom_add
26963     * @li @ref elm_transit_effect_resizing_add
26964     *
26965     * Other transition effects are used to make one object disappear and another
26966     * object appear on its old place. These effects are:
26967     *
26968     * @li @ref elm_transit_effect_flip_add
26969     * @li @ref elm_transit_effect_resizable_flip_add
26970     * @li @ref elm_transit_effect_fade_add
26971     * @li @ref elm_transit_effect_blend_add
26972     *
26973     * It's also possible to make a transition chain with @ref
26974     * elm_transit_chain_transit_add.
26975     *
26976     * @warning We strongly recommend to use elm_transit just when edje can not do
26977     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26978     * animations can be manipulated inside the theme.
26979     *
26980     * List of examples:
26981     * @li @ref transit_example_01_explained
26982     * @li @ref transit_example_02_explained
26983     * @li @ref transit_example_03_c
26984     * @li @ref transit_example_04_c
26985     *
26986     * @{
26987     */
26988
26989    /**
26990     * @enum Elm_Transit_Tween_Mode
26991     *
26992     * The type of acceleration used in the transition.
26993     */
26994    typedef enum
26995      {
26996         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26997         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26998                                              over time, then decrease again
26999                                              and stop slowly */
27000         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27001                                              speed over time */
27002         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27003                                             over time */
27004      } Elm_Transit_Tween_Mode;
27005
27006    /**
27007     * @enum Elm_Transit_Effect_Flip_Axis
27008     *
27009     * The axis where flip effect should be applied.
27010     */
27011    typedef enum
27012      {
27013         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27014         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27015      } Elm_Transit_Effect_Flip_Axis;
27016    /**
27017     * @enum Elm_Transit_Effect_Wipe_Dir
27018     *
27019     * The direction where the wipe effect should occur.
27020     */
27021    typedef enum
27022      {
27023         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27024         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27025         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27026         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27027      } Elm_Transit_Effect_Wipe_Dir;
27028    /** @enum Elm_Transit_Effect_Wipe_Type
27029     *
27030     * Whether the wipe effect should show or hide the object.
27031     */
27032    typedef enum
27033      {
27034         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27035                                              animation */
27036         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27037                                             animation */
27038      } Elm_Transit_Effect_Wipe_Type;
27039
27040    /**
27041     * @typedef Elm_Transit
27042     *
27043     * The Transit created with elm_transit_add(). This type has the information
27044     * about the objects which the transition will be applied, and the
27045     * transition effects that will be used. It also contains info about
27046     * duration, number of repetitions, auto-reverse, etc.
27047     */
27048    typedef struct _Elm_Transit Elm_Transit;
27049    typedef void Elm_Transit_Effect;
27050    /**
27051     * @typedef Elm_Transit_Effect_Transition_Cb
27052     *
27053     * Transition callback called for this effect on each transition iteration.
27054     */
27055    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27056    /**
27057     * Elm_Transit_Effect_End_Cb
27058     *
27059     * Transition callback called for this effect when the transition is over.
27060     */
27061    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27062
27063    /**
27064     * Elm_Transit_Del_Cb
27065     *
27066     * A callback called when the transit is deleted.
27067     */
27068    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27069
27070    /**
27071     * Add new transit.
27072     *
27073     * @note Is not necessary to delete the transit object, it will be deleted at
27074     * the end of its operation.
27075     * @note The transit will start playing when the program enter in the main loop, is not
27076     * necessary to give a start to the transit.
27077     *
27078     * @return The transit object.
27079     *
27080     * @ingroup Transit
27081     */
27082    EAPI Elm_Transit                *elm_transit_add(void);
27083
27084    /**
27085     * Stops the animation and delete the @p transit object.
27086     *
27087     * Call this function if you wants to stop the animation before the duration
27088     * time. Make sure the @p transit object is still alive with
27089     * elm_transit_del_cb_set() function.
27090     * All added effects will be deleted, calling its repective data_free_cb
27091     * functions. The function setted by elm_transit_del_cb_set() will be called.
27092     *
27093     * @see elm_transit_del_cb_set()
27094     *
27095     * @param transit The transit object to be deleted.
27096     *
27097     * @ingroup Transit
27098     * @warning Just call this function if you are sure the transit is alive.
27099     */
27100    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27101
27102    /**
27103     * Add a new effect to the transit.
27104     *
27105     * @note The cb function and the data are the key to the effect. If you try to
27106     * add an already added effect, nothing is done.
27107     * @note After the first addition of an effect in @p transit, if its
27108     * effect list become empty again, the @p transit will be killed by
27109     * elm_transit_del(transit) function.
27110     *
27111     * Exemple:
27112     * @code
27113     * Elm_Transit *transit = elm_transit_add();
27114     * elm_transit_effect_add(transit,
27115     *                        elm_transit_effect_blend_op,
27116     *                        elm_transit_effect_blend_context_new(),
27117     *                        elm_transit_effect_blend_context_free);
27118     * @endcode
27119     *
27120     * @param transit The transit object.
27121     * @param transition_cb The operation function. It is called when the
27122     * animation begins, it is the function that actually performs the animation.
27123     * It is called with the @p data, @p transit and the time progression of the
27124     * animation (a double value between 0.0 and 1.0).
27125     * @param effect The context data of the effect.
27126     * @param end_cb The function to free the context data, it will be called
27127     * at the end of the effect, it must finalize the animation and free the
27128     * @p data.
27129     *
27130     * @ingroup Transit
27131     * @warning The transit free the context data at the and of the transition with
27132     * the data_free_cb function, do not use the context data in another transit.
27133     */
27134    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);
27135
27136    /**
27137     * Delete an added effect.
27138     *
27139     * This function will remove the effect from the @p transit, calling the
27140     * data_free_cb to free the @p data.
27141     *
27142     * @see elm_transit_effect_add()
27143     *
27144     * @note If the effect is not found, nothing is done.
27145     * @note If the effect list become empty, this function will call
27146     * elm_transit_del(transit), that is, it will kill the @p transit.
27147     *
27148     * @param transit The transit object.
27149     * @param transition_cb The operation function.
27150     * @param effect The context data of the effect.
27151     *
27152     * @ingroup Transit
27153     */
27154    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);
27155
27156    /**
27157     * Add new object to apply the effects.
27158     *
27159     * @note After the first addition of an object in @p transit, if its
27160     * object list become empty again, the @p transit will be killed by
27161     * elm_transit_del(transit) function.
27162     * @note If the @p obj belongs to another transit, the @p obj will be
27163     * removed from it and it will only belong to the @p transit. If the old
27164     * transit stays without objects, it will die.
27165     * @note When you add an object into the @p transit, its state from
27166     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27167     * transit ends, if you change this state whith evas_object_pass_events_set()
27168     * after add the object, this state will change again when @p transit stops to
27169     * run.
27170     *
27171     * @param transit The transit object.
27172     * @param obj Object to be animated.
27173     *
27174     * @ingroup Transit
27175     * @warning It is not allowed to add a new object after transit begins to go.
27176     */
27177    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27178
27179    /**
27180     * Removes an added object from the transit.
27181     *
27182     * @note If the @p obj is not in the @p transit, nothing is done.
27183     * @note If the list become empty, this function will call
27184     * elm_transit_del(transit), that is, it will kill the @p transit.
27185     *
27186     * @param transit The transit object.
27187     * @param obj Object to be removed from @p transit.
27188     *
27189     * @ingroup Transit
27190     * @warning It is not allowed to remove objects after transit begins to go.
27191     */
27192    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27193
27194    /**
27195     * Get the objects of the transit.
27196     *
27197     * @param transit The transit object.
27198     * @return a Eina_List with the objects from the transit.
27199     *
27200     * @ingroup Transit
27201     */
27202    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27203
27204    /**
27205     * Enable/disable keeping up the objects states.
27206     * If it is not kept, the objects states will be reset when transition ends.
27207     *
27208     * @note @p transit can not be NULL.
27209     * @note One state includes geometry, color, map data.
27210     *
27211     * @param transit The transit object.
27212     * @param state_keep Keeping or Non Keeping.
27213     *
27214     * @ingroup Transit
27215     */
27216    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27217
27218    /**
27219     * Get a value whether the objects states will be reset or not.
27220     *
27221     * @note @p transit can not be NULL
27222     *
27223     * @see elm_transit_objects_final_state_keep_set()
27224     *
27225     * @param transit The transit object.
27226     * @return EINA_TRUE means the states of the objects will be reset.
27227     * If @p transit is NULL, EINA_FALSE is returned
27228     *
27229     * @ingroup Transit
27230     */
27231    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27232
27233    /**
27234     * Set the event enabled when transit is operating.
27235     *
27236     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27237     * events from mouse and keyboard during the animation.
27238     * @note When you add an object with elm_transit_object_add(), its state from
27239     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27240     * transit ends, if you change this state with evas_object_pass_events_set()
27241     * after adding the object, this state will change again when @p transit stops
27242     * to run.
27243     *
27244     * @param transit The transit object.
27245     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27246     * ignored otherwise.
27247     *
27248     * @ingroup Transit
27249     */
27250    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27251
27252    /**
27253     * Get the value of event enabled status.
27254     *
27255     * @see elm_transit_event_enabled_set()
27256     *
27257     * @param transit The Transit object
27258     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27259     * EINA_FALSE is returned
27260     *
27261     * @ingroup Transit
27262     */
27263    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27264
27265    /**
27266     * Set the user-callback function when the transit is deleted.
27267     *
27268     * @note Using this function twice will overwrite the first function setted.
27269     * @note the @p transit object will be deleted after call @p cb function.
27270     *
27271     * @param transit The transit object.
27272     * @param cb Callback function pointer. This function will be called before
27273     * the deletion of the transit.
27274     * @param data Callback funtion user data. It is the @p op parameter.
27275     *
27276     * @ingroup Transit
27277     */
27278    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27279
27280    /**
27281     * Set reverse effect automatically.
27282     *
27283     * If auto reverse is setted, after running the effects with the progress
27284     * parameter from 0 to 1, it will call the effecs again with the progress
27285     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27286     * where the duration was setted with the function elm_transit_add and
27287     * the repeat with the function elm_transit_repeat_times_set().
27288     *
27289     * @param transit The transit object.
27290     * @param reverse EINA_TRUE means the auto_reverse is on.
27291     *
27292     * @ingroup Transit
27293     */
27294    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27295
27296    /**
27297     * Get if the auto reverse is on.
27298     *
27299     * @see elm_transit_auto_reverse_set()
27300     *
27301     * @param transit The transit object.
27302     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27303     * EINA_FALSE is returned
27304     *
27305     * @ingroup Transit
27306     */
27307    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27308
27309    /**
27310     * Set the transit repeat count. Effect will be repeated by repeat count.
27311     *
27312     * This function sets the number of repetition the transit will run after
27313     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27314     * If the @p repeat is a negative number, it will repeat infinite times.
27315     *
27316     * @note If this function is called during the transit execution, the transit
27317     * will run @p repeat times, ignoring the times it already performed.
27318     *
27319     * @param transit The transit object
27320     * @param repeat Repeat count
27321     *
27322     * @ingroup Transit
27323     */
27324    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27325
27326    /**
27327     * Get the transit repeat count.
27328     *
27329     * @see elm_transit_repeat_times_set()
27330     *
27331     * @param transit The Transit object.
27332     * @return The repeat count. If @p transit is NULL
27333     * 0 is returned
27334     *
27335     * @ingroup Transit
27336     */
27337    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27338
27339    /**
27340     * Set the transit animation acceleration type.
27341     *
27342     * This function sets the tween mode of the transit that can be:
27343     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27344     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27345     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27346     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27347     *
27348     * @param transit The transit object.
27349     * @param tween_mode The tween type.
27350     *
27351     * @ingroup Transit
27352     */
27353    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27354
27355    /**
27356     * Get the transit animation acceleration type.
27357     *
27358     * @note @p transit can not be NULL
27359     *
27360     * @param transit The transit object.
27361     * @return The tween type. If @p transit is NULL
27362     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27363     *
27364     * @ingroup Transit
27365     */
27366    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27367
27368    /**
27369     * Set the transit animation time
27370     *
27371     * @note @p transit can not be NULL
27372     *
27373     * @param transit The transit object.
27374     * @param duration The animation time.
27375     *
27376     * @ingroup Transit
27377     */
27378    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27379
27380    /**
27381     * Get the transit animation time
27382     *
27383     * @note @p transit can not be NULL
27384     *
27385     * @param transit The transit object.
27386     *
27387     * @return The transit animation time.
27388     *
27389     * @ingroup Transit
27390     */
27391    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27392
27393    /**
27394     * Starts the transition.
27395     * Once this API is called, the transit begins to measure the time.
27396     *
27397     * @note @p transit can not be NULL
27398     *
27399     * @param transit The transit object.
27400     *
27401     * @ingroup Transit
27402     */
27403    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27404
27405    /**
27406     * Pause/Resume the transition.
27407     *
27408     * If you call elm_transit_go again, the transit will be started from the
27409     * beginning, and will be unpaused.
27410     *
27411     * @note @p transit can not be NULL
27412     *
27413     * @param transit The transit object.
27414     * @param paused Whether the transition should be paused or not.
27415     *
27416     * @ingroup Transit
27417     */
27418    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27419
27420    /**
27421     * Get the value of paused status.
27422     *
27423     * @see elm_transit_paused_set()
27424     *
27425     * @note @p transit can not be NULL
27426     *
27427     * @param transit The transit object.
27428     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27429     * EINA_FALSE is returned
27430     *
27431     * @ingroup Transit
27432     */
27433    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27434
27435    /**
27436     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27437     *
27438     * The value returned is a fraction (current time / total time). It
27439     * represents the progression position relative to the total.
27440     *
27441     * @note @p transit can not be NULL
27442     *
27443     * @param transit The transit object.
27444     *
27445     * @return The time progression value. If @p transit is NULL
27446     * 0 is returned
27447     *
27448     * @ingroup Transit
27449     */
27450    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27451
27452    /**
27453     * Makes the chain relationship between two transits.
27454     *
27455     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27456     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27457     *
27458     * @param transit The transit object.
27459     * @param chain_transit The chain transit object. This transit will be operated
27460     *        after transit is done.
27461     *
27462     * This function adds @p chain_transit transition to a chain after the @p
27463     * transit, and will be started as soon as @p transit ends. See @ref
27464     * transit_example_02_explained for a full example.
27465     *
27466     * @ingroup Transit
27467     */
27468    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27469
27470    /**
27471     * Cut off the chain relationship between two transits.
27472     *
27473     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27474     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27475     *
27476     * @param transit The transit object.
27477     * @param chain_transit The chain transit object.
27478     *
27479     * This function remove the @p chain_transit transition from the @p transit.
27480     *
27481     * @ingroup Transit
27482     */
27483    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27484
27485    /**
27486     * Get the current chain transit list.
27487     *
27488     * @note @p transit can not be NULL.
27489     *
27490     * @param transit The transit object.
27491     * @return chain transit list.
27492     *
27493     * @ingroup Transit
27494     */
27495    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27496
27497    /**
27498     * Add the Resizing Effect to Elm_Transit.
27499     *
27500     * @note This API is one of the facades. It creates resizing effect context
27501     * and add it's required APIs to elm_transit_effect_add.
27502     *
27503     * @see elm_transit_effect_add()
27504     *
27505     * @param transit Transit object.
27506     * @param from_w Object width size when effect begins.
27507     * @param from_h Object height size when effect begins.
27508     * @param to_w Object width size when effect ends.
27509     * @param to_h Object height size when effect ends.
27510     * @return Resizing effect context data.
27511     *
27512     * @ingroup Transit
27513     */
27514    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);
27515
27516    /**
27517     * Add the Translation Effect to Elm_Transit.
27518     *
27519     * @note This API is one of the facades. It creates translation effect context
27520     * and add it's required APIs to elm_transit_effect_add.
27521     *
27522     * @see elm_transit_effect_add()
27523     *
27524     * @param transit Transit object.
27525     * @param from_dx X Position variation when effect begins.
27526     * @param from_dy Y Position variation when effect begins.
27527     * @param to_dx X Position variation when effect ends.
27528     * @param to_dy Y Position variation when effect ends.
27529     * @return Translation effect context data.
27530     *
27531     * @ingroup Transit
27532     * @warning It is highly recommended just create a transit with this effect when
27533     * the window that the objects of the transit belongs has already been created.
27534     * This is because this effect needs the geometry information about the objects,
27535     * and if the window was not created yet, it can get a wrong information.
27536     */
27537    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);
27538
27539    /**
27540     * Add the Zoom Effect to Elm_Transit.
27541     *
27542     * @note This API is one of the facades. It creates zoom effect context
27543     * and add it's required APIs to elm_transit_effect_add.
27544     *
27545     * @see elm_transit_effect_add()
27546     *
27547     * @param transit Transit object.
27548     * @param from_rate Scale rate when effect begins (1 is current rate).
27549     * @param to_rate Scale rate when effect ends.
27550     * @return Zoom effect context data.
27551     *
27552     * @ingroup Transit
27553     * @warning It is highly recommended just create a transit with this effect when
27554     * the window that the objects of the transit belongs has already been created.
27555     * This is because this effect needs the geometry information about the objects,
27556     * and if the window was not created yet, it can get a wrong information.
27557     */
27558    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27559
27560    /**
27561     * Add the Flip Effect to Elm_Transit.
27562     *
27563     * @note This API is one of the facades. It creates flip effect context
27564     * and add it's required APIs to elm_transit_effect_add.
27565     * @note This effect is applied to each pair of objects in the order they are listed
27566     * in the transit list of objects. The first object in the pair will be the
27567     * "front" object and the second will be the "back" object.
27568     *
27569     * @see elm_transit_effect_add()
27570     *
27571     * @param transit Transit object.
27572     * @param axis Flipping Axis(X or Y).
27573     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27574     * @return Flip effect context data.
27575     *
27576     * @ingroup Transit
27577     * @warning It is highly recommended just create a transit with this effect when
27578     * the window that the objects of the transit belongs has already been created.
27579     * This is because this effect needs the geometry information about the objects,
27580     * and if the window was not created yet, it can get a wrong information.
27581     */
27582    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27583
27584    /**
27585     * Add the Resizable Flip Effect to Elm_Transit.
27586     *
27587     * @note This API is one of the facades. It creates resizable flip effect context
27588     * and add it's required APIs to elm_transit_effect_add.
27589     * @note This effect is applied to each pair of objects in the order they are listed
27590     * in the transit list of objects. The first object in the pair will be the
27591     * "front" object and the second will be the "back" object.
27592     *
27593     * @see elm_transit_effect_add()
27594     *
27595     * @param transit Transit object.
27596     * @param axis Flipping Axis(X or Y).
27597     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27598     * @return Resizable flip effect context data.
27599     *
27600     * @ingroup Transit
27601     * @warning It is highly recommended just create a transit with this effect when
27602     * the window that the objects of the transit belongs has already been created.
27603     * This is because this effect needs the geometry information about the objects,
27604     * and if the window was not created yet, it can get a wrong information.
27605     */
27606    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27607
27608    /**
27609     * Add the Wipe Effect to Elm_Transit.
27610     *
27611     * @note This API is one of the facades. It creates wipe effect context
27612     * and add it's required APIs to elm_transit_effect_add.
27613     *
27614     * @see elm_transit_effect_add()
27615     *
27616     * @param transit Transit object.
27617     * @param type Wipe type. Hide or show.
27618     * @param dir Wipe Direction.
27619     * @return Wipe effect context data.
27620     *
27621     * @ingroup Transit
27622     * @warning It is highly recommended just create a transit with this effect when
27623     * the window that the objects of the transit belongs has already been created.
27624     * This is because this effect needs the geometry information about the objects,
27625     * and if the window was not created yet, it can get a wrong information.
27626     */
27627    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27628
27629    /**
27630     * Add the Color Effect to Elm_Transit.
27631     *
27632     * @note This API is one of the facades. It creates color effect context
27633     * and add it's required APIs to elm_transit_effect_add.
27634     *
27635     * @see elm_transit_effect_add()
27636     *
27637     * @param transit        Transit object.
27638     * @param  from_r        RGB R when effect begins.
27639     * @param  from_g        RGB G when effect begins.
27640     * @param  from_b        RGB B when effect begins.
27641     * @param  from_a        RGB A when effect begins.
27642     * @param  to_r          RGB R when effect ends.
27643     * @param  to_g          RGB G when effect ends.
27644     * @param  to_b          RGB B when effect ends.
27645     * @param  to_a          RGB A when effect ends.
27646     * @return               Color effect context data.
27647     *
27648     * @ingroup Transit
27649     */
27650    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);
27651
27652    /**
27653     * Add the Fade Effect to Elm_Transit.
27654     *
27655     * @note This API is one of the facades. It creates fade effect context
27656     * and add it's required APIs to elm_transit_effect_add.
27657     * @note This effect is applied to each pair of objects in the order they are listed
27658     * in the transit list of objects. The first object in the pair will be the
27659     * "before" object and the second will be the "after" object.
27660     *
27661     * @see elm_transit_effect_add()
27662     *
27663     * @param transit Transit object.
27664     * @return Fade effect context data.
27665     *
27666     * @ingroup Transit
27667     * @warning It is highly recommended just create a transit with this effect when
27668     * the window that the objects of the transit belongs has already been created.
27669     * This is because this effect needs the color information about the objects,
27670     * and if the window was not created yet, it can get a wrong information.
27671     */
27672    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27673
27674    /**
27675     * Add the Blend Effect to Elm_Transit.
27676     *
27677     * @note This API is one of the facades. It creates blend effect context
27678     * and add it's required APIs to elm_transit_effect_add.
27679     * @note This effect is applied to each pair of objects in the order they are listed
27680     * in the transit list of objects. The first object in the pair will be the
27681     * "before" object and the second will be the "after" object.
27682     *
27683     * @see elm_transit_effect_add()
27684     *
27685     * @param transit Transit object.
27686     * @return Blend effect context data.
27687     *
27688     * @ingroup Transit
27689     * @warning It is highly recommended just create a transit with this effect when
27690     * the window that the objects of the transit belongs has already been created.
27691     * This is because this effect needs the color information about the objects,
27692     * and if the window was not created yet, it can get a wrong information.
27693     */
27694    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27695
27696    /**
27697     * Add the Rotation Effect to Elm_Transit.
27698     *
27699     * @note This API is one of the facades. It creates rotation effect context
27700     * and add it's required APIs to elm_transit_effect_add.
27701     *
27702     * @see elm_transit_effect_add()
27703     *
27704     * @param transit Transit object.
27705     * @param from_degree Degree when effect begins.
27706     * @param to_degree Degree when effect is ends.
27707     * @return Rotation effect context data.
27708     *
27709     * @ingroup Transit
27710     * @warning It is highly recommended just create a transit with this effect when
27711     * the window that the objects of the transit belongs has already been created.
27712     * This is because this effect needs the geometry information about the objects,
27713     * and if the window was not created yet, it can get a wrong information.
27714     */
27715    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27716
27717    /**
27718     * Add the ImageAnimation Effect to Elm_Transit.
27719     *
27720     * @note This API is one of the facades. It creates image animation effect context
27721     * and add it's required APIs to elm_transit_effect_add.
27722     * The @p images parameter is a list images paths. This list and
27723     * its contents will be deleted at the end of the effect by
27724     * elm_transit_effect_image_animation_context_free() function.
27725     *
27726     * Example:
27727     * @code
27728     * char buf[PATH_MAX];
27729     * Eina_List *images = NULL;
27730     * Elm_Transit *transi = elm_transit_add();
27731     *
27732     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27733     * images = eina_list_append(images, eina_stringshare_add(buf));
27734     *
27735     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27736     * images = eina_list_append(images, eina_stringshare_add(buf));
27737     * elm_transit_effect_image_animation_add(transi, images);
27738     *
27739     * @endcode
27740     *
27741     * @see elm_transit_effect_add()
27742     *
27743     * @param transit Transit object.
27744     * @param images Eina_List of images file paths. This list and
27745     * its contents will be deleted at the end of the effect by
27746     * elm_transit_effect_image_animation_context_free() function.
27747     * @return Image Animation effect context data.
27748     *
27749     * @ingroup Transit
27750     */
27751    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27752    /**
27753     * @}
27754     */
27755
27756    typedef struct _Elm_Store                      Elm_Store;
27757    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27758    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27759    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27760    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27761    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27762    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27763    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27764    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27765    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27766    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27767
27768    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27769    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27770    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27771    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27772
27773    typedef enum
27774      {
27775         ELM_STORE_ITEM_MAPPING_NONE = 0,
27776         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27777         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27778         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27779         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27780         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27781         // can add more here as needed by common apps
27782         ELM_STORE_ITEM_MAPPING_LAST
27783      } Elm_Store_Item_Mapping_Type;
27784
27785    struct _Elm_Store_Item_Mapping_Icon
27786      {
27787         // FIXME: allow edje file icons
27788         int                   w, h;
27789         Elm_Icon_Lookup_Order lookup_order;
27790         Eina_Bool             standard_name : 1;
27791         Eina_Bool             no_scale : 1;
27792         Eina_Bool             smooth : 1;
27793         Eina_Bool             scale_up : 1;
27794         Eina_Bool             scale_down : 1;
27795      };
27796
27797    struct _Elm_Store_Item_Mapping_Empty
27798      {
27799         Eina_Bool             dummy;
27800      };
27801
27802    struct _Elm_Store_Item_Mapping_Photo
27803      {
27804         int                   size;
27805      };
27806
27807    struct _Elm_Store_Item_Mapping_Custom
27808      {
27809         Elm_Store_Item_Mapping_Cb func;
27810      };
27811
27812    struct _Elm_Store_Item_Mapping
27813      {
27814         Elm_Store_Item_Mapping_Type     type;
27815         const char                     *part;
27816         int                             offset;
27817         union
27818           {
27819              Elm_Store_Item_Mapping_Empty  empty;
27820              Elm_Store_Item_Mapping_Icon   icon;
27821              Elm_Store_Item_Mapping_Photo  photo;
27822              Elm_Store_Item_Mapping_Custom custom;
27823              // add more types here
27824           } details;
27825      };
27826
27827    struct _Elm_Store_Item_Info
27828      {
27829         Elm_Genlist_Item_Class       *item_class;
27830         const Elm_Store_Item_Mapping *mapping;
27831         void                         *data;
27832         char                         *sort_id;
27833      };
27834
27835    struct _Elm_Store_Item_Info_Filesystem
27836      {
27837         Elm_Store_Item_Info  base;
27838         char                *path;
27839      };
27840
27841 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27842 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27843
27844    EAPI void                    elm_store_free(Elm_Store *st);
27845
27846    EAPI Elm_Store              *elm_store_filesystem_new(void);
27847    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27848    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27849    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27850
27851    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27852
27853    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27854    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27855    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27856    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27857    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27858    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27859
27860    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27861    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27862    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27863    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27864    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27865    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27866    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27867
27868    /**
27869     * @defgroup SegmentControl SegmentControl
27870     * @ingroup Elementary
27871     *
27872     * @image html img/widget/segment_control/preview-00.png
27873     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27874     *
27875     * @image html img/segment_control.png
27876     * @image latex img/segment_control.eps width=\textwidth
27877     *
27878     * Segment control widget is a horizontal control made of multiple segment
27879     * items, each segment item functioning similar to discrete two state button.
27880     * A segment control groups the items together and provides compact
27881     * single button with multiple equal size segments.
27882     *
27883     * Segment item size is determined by base widget
27884     * size and the number of items added.
27885     * Only one segment item can be at selected state. A segment item can display
27886     * combination of Text and any Evas_Object like Images or other widget.
27887     *
27888     * Smart callbacks one can listen to:
27889     * - "changed" - When the user clicks on a segment item which is not
27890     *   previously selected and get selected. The event_info parameter is the
27891     *   segment item pointer.
27892     *
27893     * Available styles for it:
27894     * - @c "default"
27895     *
27896     * Here is an example on its usage:
27897     * @li @ref segment_control_example
27898     */
27899
27900    /**
27901     * @addtogroup SegmentControl
27902     * @{
27903     */
27904
27905    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27906
27907    /**
27908     * Add a new segment control widget to the given parent Elementary
27909     * (container) object.
27910     *
27911     * @param parent The parent object.
27912     * @return a new segment control widget handle or @c NULL, on errors.
27913     *
27914     * This function inserts a new segment control widget on the canvas.
27915     *
27916     * @ingroup SegmentControl
27917     */
27918    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27919
27920    /**
27921     * Append a new item to the segment control object.
27922     *
27923     * @param obj The segment control object.
27924     * @param icon The icon object to use for the left side of the item. An
27925     * icon can be any Evas object, but usually it is an icon created
27926     * with elm_icon_add().
27927     * @param label The label of the item.
27928     *        Note that, NULL is different from empty string "".
27929     * @return The created item or @c NULL upon failure.
27930     *
27931     * A new item will be created and appended to the segment control, i.e., will
27932     * be set as @b last item.
27933     *
27934     * If it should be inserted at another position,
27935     * elm_segment_control_item_insert_at() should be used instead.
27936     *
27937     * Items created with this function can be deleted with function
27938     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27939     *
27940     * @note @p label set to @c NULL is different from empty string "".
27941     * If an item
27942     * only has icon, it will be displayed bigger and centered. If it has
27943     * icon and label, even that an empty string, icon will be smaller and
27944     * positioned at left.
27945     *
27946     * Simple example:
27947     * @code
27948     * sc = elm_segment_control_add(win);
27949     * ic = elm_icon_add(win);
27950     * elm_icon_file_set(ic, "path/to/image", NULL);
27951     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27952     * elm_segment_control_item_add(sc, ic, "label");
27953     * evas_object_show(sc);
27954     * @endcode
27955     *
27956     * @see elm_segment_control_item_insert_at()
27957     * @see elm_segment_control_item_del()
27958     *
27959     * @ingroup SegmentControl
27960     */
27961    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27962
27963    /**
27964     * Insert a new item to the segment control object at specified position.
27965     *
27966     * @param obj The segment control object.
27967     * @param icon The icon object to use for the left side of the item. An
27968     * icon can be any Evas object, but usually it is an icon created
27969     * with elm_icon_add().
27970     * @param label The label of the item.
27971     * @param index Item position. Value should be between 0 and items count.
27972     * @return The created item or @c NULL upon failure.
27973
27974     * Index values must be between @c 0, when item will be prepended to
27975     * segment control, and items count, that can be get with
27976     * elm_segment_control_item_count_get(), case when item will be appended
27977     * to segment control, just like elm_segment_control_item_add().
27978     *
27979     * Items created with this function can be deleted with function
27980     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27981     *
27982     * @note @p label set to @c NULL is different from empty string "".
27983     * If an item
27984     * only has icon, it will be displayed bigger and centered. If it has
27985     * icon and label, even that an empty string, icon will be smaller and
27986     * positioned at left.
27987     *
27988     * @see elm_segment_control_item_add()
27989     * @see elm_segment_control_item_count_get()
27990     * @see elm_segment_control_item_del()
27991     *
27992     * @ingroup SegmentControl
27993     */
27994    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);
27995
27996    /**
27997     * Remove a segment control item from its parent, deleting it.
27998     *
27999     * @param it The item to be removed.
28000     *
28001     * Items can be added with elm_segment_control_item_add() or
28002     * elm_segment_control_item_insert_at().
28003     *
28004     * @ingroup SegmentControl
28005     */
28006    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28007
28008    /**
28009     * Remove a segment control item at given index from its parent,
28010     * deleting it.
28011     *
28012     * @param obj The segment control object.
28013     * @param index The position of the segment control item to be deleted.
28014     *
28015     * Items can be added with elm_segment_control_item_add() or
28016     * elm_segment_control_item_insert_at().
28017     *
28018     * @ingroup SegmentControl
28019     */
28020    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28021
28022    /**
28023     * Get the Segment items count from segment control.
28024     *
28025     * @param obj The segment control object.
28026     * @return Segment items count.
28027     *
28028     * It will just return the number of items added to segment control @p obj.
28029     *
28030     * @ingroup SegmentControl
28031     */
28032    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28033
28034    /**
28035     * Get the item placed at specified index.
28036     *
28037     * @param obj The segment control object.
28038     * @param index The index of the segment item.
28039     * @return The segment control item or @c NULL on failure.
28040     *
28041     * Index is the position of an item in segment control widget. Its
28042     * range is from @c 0 to <tt> count - 1 </tt>.
28043     * Count is the number of items, that can be get with
28044     * elm_segment_control_item_count_get().
28045     *
28046     * @ingroup SegmentControl
28047     */
28048    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28049
28050    /**
28051     * Get the label of item.
28052     *
28053     * @param obj The segment control object.
28054     * @param index The index of the segment item.
28055     * @return The label of the item at @p index.
28056     *
28057     * The return value is a pointer to the label associated to the item when
28058     * it was created, with function elm_segment_control_item_add(), or later
28059     * with function elm_segment_control_item_label_set. If no label
28060     * was passed as argument, it will return @c NULL.
28061     *
28062     * @see elm_segment_control_item_label_set() for more details.
28063     * @see elm_segment_control_item_add()
28064     *
28065     * @ingroup SegmentControl
28066     */
28067    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28068
28069    /**
28070     * Set the label of item.
28071     *
28072     * @param it The item of segment control.
28073     * @param text The label of item.
28074     *
28075     * The label to be displayed by the item.
28076     * Label will be at right of the icon (if set).
28077     *
28078     * If a label was passed as argument on item creation, with function
28079     * elm_control_segment_item_add(), it will be already
28080     * displayed by the item.
28081     *
28082     * @see elm_segment_control_item_label_get()
28083     * @see elm_segment_control_item_add()
28084     *
28085     * @ingroup SegmentControl
28086     */
28087    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28088
28089    /**
28090     * Get the icon associated to the item.
28091     *
28092     * @param obj The segment control object.
28093     * @param index The index of the segment item.
28094     * @return The left side icon associated to the item at @p index.
28095     *
28096     * The return value is a pointer to the icon associated to the item when
28097     * it was created, with function elm_segment_control_item_add(), or later
28098     * with function elm_segment_control_item_icon_set(). If no icon
28099     * was passed as argument, it will return @c NULL.
28100     *
28101     * @see elm_segment_control_item_add()
28102     * @see elm_segment_control_item_icon_set()
28103     *
28104     * @ingroup SegmentControl
28105     */
28106    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28107
28108    /**
28109     * Set the icon associated to the item.
28110     *
28111     * @param it The segment control item.
28112     * @param icon The icon object to associate with @p it.
28113     *
28114     * The icon object to use at left side of the item. An
28115     * icon can be any Evas object, but usually it is an icon created
28116     * with elm_icon_add().
28117     *
28118     * Once the icon object is set, a previously set one will be deleted.
28119     * @warning Setting the same icon for two items will cause the icon to
28120     * dissapear from the first item.
28121     *
28122     * If an icon was passed as argument on item creation, with function
28123     * elm_segment_control_item_add(), it will be already
28124     * associated to the item.
28125     *
28126     * @see elm_segment_control_item_add()
28127     * @see elm_segment_control_item_icon_get()
28128     *
28129     * @ingroup SegmentControl
28130     */
28131    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28132
28133    /**
28134     * Get the index of an item.
28135     *
28136     * @param it The segment control item.
28137     * @return The position of item in segment control widget.
28138     *
28139     * Index is the position of an item in segment control widget. Its
28140     * range is from @c 0 to <tt> count - 1 </tt>.
28141     * Count is the number of items, that can be get with
28142     * elm_segment_control_item_count_get().
28143     *
28144     * @ingroup SegmentControl
28145     */
28146    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28147
28148    /**
28149     * Get the base object of the item.
28150     *
28151     * @param it The segment control item.
28152     * @return The base object associated with @p it.
28153     *
28154     * Base object is the @c Evas_Object that represents that item.
28155     *
28156     * @ingroup SegmentControl
28157     */
28158    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28159
28160    /**
28161     * Get the selected item.
28162     *
28163     * @param obj The segment control object.
28164     * @return The selected item or @c NULL if none of segment items is
28165     * selected.
28166     *
28167     * The selected item can be unselected with function
28168     * elm_segment_control_item_selected_set().
28169     *
28170     * The selected item always will be highlighted on segment control.
28171     *
28172     * @ingroup SegmentControl
28173     */
28174    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28175
28176    /**
28177     * Set the selected state of an item.
28178     *
28179     * @param it The segment control item
28180     * @param select The selected state
28181     *
28182     * This sets the selected state of the given item @p it.
28183     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28184     *
28185     * If a new item is selected the previosly selected will be unselected.
28186     * Previoulsy selected item can be get with function
28187     * elm_segment_control_item_selected_get().
28188     *
28189     * The selected item always will be highlighted on segment control.
28190     *
28191     * @see elm_segment_control_item_selected_get()
28192     *
28193     * @ingroup SegmentControl
28194     */
28195    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28196
28197    /**
28198     * @}
28199     */
28200
28201    /**
28202     * @defgroup Grid Grid
28203     *
28204     * The grid is a grid layout widget that lays out a series of children as a
28205     * fixed "grid" of widgets using a given percentage of the grid width and
28206     * height each using the child object.
28207     *
28208     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28209     * widgets size itself. The default is 100 x 100, so that means the
28210     * position and sizes of children will effectively be percentages (0 to 100)
28211     * of the width or height of the grid widget
28212     *
28213     * @{
28214     */
28215
28216    /**
28217     * Add a new grid to the parent
28218     *
28219     * @param parent The parent object
28220     * @return The new object or NULL if it cannot be created
28221     *
28222     * @ingroup Grid
28223     */
28224    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28225
28226    /**
28227     * Set the virtual size of the grid
28228     *
28229     * @param obj The grid object
28230     * @param w The virtual width of the grid
28231     * @param h The virtual height of the grid
28232     *
28233     * @ingroup Grid
28234     */
28235    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28236
28237    /**
28238     * Get the virtual size of the grid
28239     *
28240     * @param obj The grid object
28241     * @param w Pointer to integer to store the virtual width of the grid
28242     * @param h Pointer to integer to store the virtual height of the grid
28243     *
28244     * @ingroup Grid
28245     */
28246    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28247
28248    /**
28249     * Pack child at given position and size
28250     *
28251     * @param obj The grid object
28252     * @param subobj The child to pack
28253     * @param x The virtual x coord at which to pack it
28254     * @param y The virtual y coord at which to pack it
28255     * @param w The virtual width at which to pack it
28256     * @param h The virtual height at which to pack it
28257     *
28258     * @ingroup Grid
28259     */
28260    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28261
28262    /**
28263     * Unpack a child from a grid object
28264     *
28265     * @param obj The grid object
28266     * @param subobj The child to unpack
28267     *
28268     * @ingroup Grid
28269     */
28270    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28271
28272    /**
28273     * Faster way to remove all child objects from a grid object.
28274     *
28275     * @param obj The grid object
28276     * @param clear If true, it will delete just removed children
28277     *
28278     * @ingroup Grid
28279     */
28280    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28281
28282    /**
28283     * Set packing of an existing child at to position and size
28284     *
28285     * @param subobj The child to set packing of
28286     * @param x The virtual x coord at which to pack it
28287     * @param y The virtual y coord at which to pack it
28288     * @param w The virtual width at which to pack it
28289     * @param h The virtual height at which to pack it
28290     *
28291     * @ingroup Grid
28292     */
28293    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28294
28295    /**
28296     * get packing of a child
28297     *
28298     * @param subobj The child to query
28299     * @param x Pointer to integer to store the virtual x coord
28300     * @param y Pointer to integer to store the virtual y coord
28301     * @param w Pointer to integer to store the virtual width
28302     * @param h Pointer to integer to store the virtual height
28303     *
28304     * @ingroup Grid
28305     */
28306    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28307
28308    /**
28309     * @}
28310     */
28311
28312    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28313    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28314    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28315    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28316    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28317    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28318
28319    /**
28320     * @defgroup Video Video
28321     *
28322     * @addtogroup Video
28323     * @{
28324     *
28325     * Elementary comes with two object that help design application that need
28326     * to display video. The main one, Elm_Video, display a video by using Emotion.
28327     * It does embedded the video inside an Edje object, so you can do some
28328     * animation depending on the video state change. It does also implement a
28329     * ressource management policy to remove this burden from the application writer.
28330     *
28331     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28332     * It take care of updating its content according to Emotion event and provide a
28333     * way to theme itself. It also does automatically raise the priority of the
28334     * linked Elm_Video so it will use the video decoder if available. It also does
28335     * activate the remember function on the linked Elm_Video object.
28336     *
28337     * Signals that you can add callback for are :
28338     *
28339     * "forward,clicked" - the user clicked the forward button.
28340     * "info,clicked" - the user clicked the info button.
28341     * "next,clicked" - the user clicked the next button.
28342     * "pause,clicked" - the user clicked the pause button.
28343     * "play,clicked" - the user clicked the play button.
28344     * "prev,clicked" - the user clicked the prev button.
28345     * "rewind,clicked" - the user clicked the rewind button.
28346     * "stop,clicked" - the user clicked the stop button.
28347     * 
28348     * Default contents parts of the player widget that you can use for are:
28349     * @li "video" - A video of the player
28350     * 
28351     */
28352
28353    /**
28354     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28355     *
28356     * @param parent The parent object
28357     * @return a new player widget handle or @c NULL, on errors.
28358     *
28359     * This function inserts a new player widget on the canvas.
28360     *
28361     * @see elm_object_part_content_set()
28362     *
28363     * @ingroup Video
28364     */
28365    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28366
28367    /**
28368     * @brief Link a Elm_Payer with an Elm_Video object.
28369     *
28370     * @param player the Elm_Player object.
28371     * @param video The Elm_Video object.
28372     *
28373     * This mean that action on the player widget will affect the
28374     * video object and the state of the video will be reflected in
28375     * the player itself.
28376     *
28377     * @see elm_player_add()
28378     * @see elm_video_add()
28379     * @deprecated use elm_object_part_content_set() instead
28380     *
28381     * @ingroup Video
28382     */
28383    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28384
28385    /**
28386     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28387     *
28388     * @param parent The parent object
28389     * @return a new video widget handle or @c NULL, on errors.
28390     *
28391     * This function inserts a new video widget on the canvas.
28392     *
28393     * @seeelm_video_file_set()
28394     * @see elm_video_uri_set()
28395     *
28396     * @ingroup Video
28397     */
28398    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28399
28400    /**
28401     * @brief Define the file that will be the video source.
28402     *
28403     * @param video The video object to define the file for.
28404     * @param filename The file to target.
28405     *
28406     * This function will explicitly define a filename as a source
28407     * for the video of the Elm_Video object.
28408     *
28409     * @see elm_video_uri_set()
28410     * @see elm_video_add()
28411     * @see elm_player_add()
28412     *
28413     * @ingroup Video
28414     */
28415    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28416
28417    /**
28418     * @brief Define the uri that will be the video source.
28419     *
28420     * @param video The video object to define the file for.
28421     * @param uri The uri to target.
28422     *
28423     * This function will define an uri as a source for the video of the
28424     * Elm_Video object. URI could be remote source of video, like http:// or local source
28425     * like for example WebCam who are most of the time v4l2:// (but that depend and
28426     * you should use Emotion API to request and list the available Webcam on your system).
28427     *
28428     * @see elm_video_file_set()
28429     * @see elm_video_add()
28430     * @see elm_player_add()
28431     *
28432     * @ingroup Video
28433     */
28434    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28435
28436    /**
28437     * @brief Get the underlying Emotion object.
28438     *
28439     * @param video The video object to proceed the request on.
28440     * @return the underlying Emotion object.
28441     *
28442     * @ingroup Video
28443     */
28444    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28445
28446    /**
28447     * @brief Start to play the video
28448     *
28449     * @param video The video object to proceed the request on.
28450     *
28451     * Start to play the video and cancel all suspend state.
28452     *
28453     * @ingroup Video
28454     */
28455    EAPI void elm_video_play(Evas_Object *video);
28456
28457    /**
28458     * @brief Pause the video
28459     *
28460     * @param video The video object to proceed the request on.
28461     *
28462     * Pause the video and start a timer to trigger suspend mode.
28463     *
28464     * @ingroup Video
28465     */
28466    EAPI void elm_video_pause(Evas_Object *video);
28467
28468    /**
28469     * @brief Stop the video
28470     *
28471     * @param video The video object to proceed the request on.
28472     *
28473     * Stop the video and put the emotion in deep sleep mode.
28474     *
28475     * @ingroup Video
28476     */
28477    EAPI void elm_video_stop(Evas_Object *video);
28478
28479    /**
28480     * @brief Is the video actually playing.
28481     *
28482     * @param video The video object to proceed the request on.
28483     * @return EINA_TRUE if the video is actually playing.
28484     *
28485     * You should consider watching event on the object instead of polling
28486     * the object state.
28487     *
28488     * @ingroup Video
28489     */
28490    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28491
28492    /**
28493     * @brief Is it possible to seek inside the video.
28494     *
28495     * @param video The video object to proceed the request on.
28496     * @return EINA_TRUE if is possible to seek inside the video.
28497     *
28498     * @ingroup Video
28499     */
28500    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28501
28502    /**
28503     * @brief Is the audio muted.
28504     *
28505     * @param video The video object to proceed the request on.
28506     * @return EINA_TRUE if the audio is muted.
28507     *
28508     * @ingroup Video
28509     */
28510    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28511
28512    /**
28513     * @brief Change the mute state of the Elm_Video object.
28514     *
28515     * @param video The video object to proceed the request on.
28516     * @param mute The new mute state.
28517     *
28518     * @ingroup Video
28519     */
28520    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28521
28522    /**
28523     * @brief Get the audio level of the current video.
28524     *
28525     * @param video The video object to proceed the request on.
28526     * @return the current audio level.
28527     *
28528     * @ingroup Video
28529     */
28530    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28531
28532    /**
28533     * @brief Set the audio level of anElm_Video object.
28534     *
28535     * @param video The video object to proceed the request on.
28536     * @param volume The new audio volume.
28537     *
28538     * @ingroup Video
28539     */
28540    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28541
28542    EAPI double elm_video_play_position_get(const Evas_Object *video);
28543    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28544    EAPI double elm_video_play_length_get(const Evas_Object *video);
28545    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28546    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28547    EAPI const char *elm_video_title_get(const Evas_Object *video);
28548    /**
28549     * @}
28550     */
28551
28552    /**
28553     * @defgroup Naviframe Naviframe
28554     * @ingroup Elementary
28555     *
28556     * @brief Naviframe is a kind of view manager for the applications.
28557     *
28558     * Naviframe provides functions to switch different pages with stack
28559     * mechanism. It means if one page(item) needs to be changed to the new one,
28560     * then naviframe would push the new page to it's internal stack. Of course,
28561     * it can be back to the previous page by popping the top page. Naviframe
28562     * provides some transition effect while the pages are switching (same as
28563     * pager).
28564     *
28565     * Since each item could keep the different styles, users could keep the
28566     * same look & feel for the pages or different styles for the items in it's
28567     * application.
28568     *
28569     * Signals that you can add callback for are:
28570     * @li "transition,finished" - When the transition is finished in changing
28571     *     the item
28572     * @li "title,clicked" - User clicked title area
28573     *
28574     * Default contents parts of the naviframe items that you can use for are:
28575     * @li "default" - A main content of the page
28576     * @li "icon" - A icon in the title area
28577     * @li "prev_btn" - A button to go to the previous page
28578     * @li "next_btn" - A button to go to the next page
28579     *
28580     * Default text parts of the naviframe items that you can use for are:
28581     * @li "default" - Title label in the title area
28582     * @li "subtitle" - Sub-title label in the title area
28583     *
28584     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28585     */
28586
28587    /**
28588     * @addtogroup Naviframe
28589     * @{
28590     */
28591
28592    /**
28593     * @brief Add a new Naviframe object to the parent.
28594     *
28595     * @param parent Parent object
28596     * @return New object or @c NULL, if it cannot be created
28597     *
28598     * @ingroup Naviframe
28599     */
28600    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28601    /**
28602     * @brief Push a new item to the top of the naviframe stack (and show it).
28603     *
28604     * @param obj The naviframe object
28605     * @param title_label The label in the title area. The name of the title
28606     *        label part is "elm.text.title"
28607     * @param prev_btn The button to go to the previous item. If it is NULL,
28608     *        then naviframe will create a back button automatically. The name of
28609     *        the prev_btn part is "elm.swallow.prev_btn"
28610     * @param next_btn The button to go to the next item. Or It could be just an
28611     *        extra function button. The name of the next_btn part is
28612     *        "elm.swallow.next_btn"
28613     * @param content The main content object. The name of content part is
28614     *        "elm.swallow.content"
28615     * @param item_style The current item style name. @c NULL would be default.
28616     * @return The created item or @c NULL upon failure.
28617     *
28618     * The item pushed becomes one page of the naviframe, this item will be
28619     * deleted when it is popped.
28620     *
28621     * @see also elm_naviframe_item_style_set()
28622     * @see also elm_naviframe_item_insert_before()
28623     * @see also elm_naviframe_item_insert_after()
28624     *
28625     * The following styles are available for this item:
28626     * @li @c "default"
28627     *
28628     * @ingroup Naviframe
28629     */
28630    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);
28631     /**
28632     * @brief Insert a new item into the naviframe before item @p before.
28633     *
28634     * @param before The naviframe item to insert before.
28635     * @param title_label The label in the title area. The name of the title
28636     *        label part is "elm.text.title"
28637     * @param prev_btn The button to go to the previous item. If it is NULL,
28638     *        then naviframe will create a back button automatically. The name of
28639     *        the prev_btn part is "elm.swallow.prev_btn"
28640     * @param next_btn The button to go to the next item. Or It could be just an
28641     *        extra function button. The name of the next_btn part is
28642     *        "elm.swallow.next_btn"
28643     * @param content The main content object. The name of content part is
28644     *        "elm.swallow.content"
28645     * @param item_style The current item style name. @c NULL would be default.
28646     * @return The created item or @c NULL upon failure.
28647     *
28648     * The item is inserted into the naviframe straight away without any
28649     * transition operations. This item will be deleted when it is popped.
28650     *
28651     * @see also elm_naviframe_item_style_set()
28652     * @see also elm_naviframe_item_push()
28653     * @see also elm_naviframe_item_insert_after()
28654     *
28655     * The following styles are available for this item:
28656     * @li @c "default"
28657     *
28658     * @ingroup Naviframe
28659     */
28660    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);
28661    /**
28662     * @brief Insert a new item into the naviframe after item @p after.
28663     *
28664     * @param after The naviframe item to insert after.
28665     * @param title_label The label in the title area. The name of the title
28666     *        label part is "elm.text.title"
28667     * @param prev_btn The button to go to the previous item. If it is NULL,
28668     *        then naviframe will create a back button automatically. The name of
28669     *        the prev_btn part is "elm.swallow.prev_btn"
28670     * @param next_btn The button to go to the next item. Or It could be just an
28671     *        extra function button. The name of the next_btn part is
28672     *        "elm.swallow.next_btn"
28673     * @param content The main content object. The name of content part is
28674     *        "elm.swallow.content"
28675     * @param item_style The current item style name. @c NULL would be default.
28676     * @return The created item or @c NULL upon failure.
28677     *
28678     * The item is inserted into the naviframe straight away without any
28679     * transition operations. This item will be deleted when it is popped.
28680     *
28681     * @see also elm_naviframe_item_style_set()
28682     * @see also elm_naviframe_item_push()
28683     * @see also elm_naviframe_item_insert_before()
28684     *
28685     * The following styles are available for this item:
28686     * @li @c "default"
28687     *
28688     * @ingroup Naviframe
28689     */
28690    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);
28691    /**
28692     * @brief Pop an item that is on top of the stack
28693     *
28694     * @param obj The naviframe object
28695     * @return @c NULL or the content object(if the
28696     *         elm_naviframe_content_preserve_on_pop_get is true).
28697     *
28698     * This pops an item that is on the top(visible) of the naviframe, makes it
28699     * disappear, then deletes the item. The item that was underneath it on the
28700     * stack will become visible.
28701     *
28702     * @see also elm_naviframe_content_preserve_on_pop_get()
28703     *
28704     * @ingroup Naviframe
28705     */
28706    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28707    /**
28708     * @brief Pop the items between the top and the above one on the given item.
28709     *
28710     * @param it The naviframe item
28711     *
28712     * @ingroup Naviframe
28713     */
28714    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28715    /**
28716    * Promote an item already in the naviframe stack to the top of the stack
28717    *
28718    * @param it The naviframe item
28719    *
28720    * This will take the indicated item and promote it to the top of the stack
28721    * as if it had been pushed there. The item must already be inside the
28722    * naviframe stack to work.
28723    *
28724    */
28725    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28726    /**
28727     * @brief Delete the given item instantly.
28728     *
28729     * @param it The naviframe item
28730     *
28731     * This just deletes the given item from the naviframe item list instantly.
28732     * So this would not emit any signals for view transitions but just change
28733     * the current view if the given item is a top one.
28734     *
28735     * @ingroup Naviframe
28736     */
28737    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28738    /**
28739     * @brief preserve the content objects when items are popped.
28740     *
28741     * @param obj The naviframe object
28742     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28743     *
28744     * @see also elm_naviframe_content_preserve_on_pop_get()
28745     *
28746     * @ingroup Naviframe
28747     */
28748    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28749    /**
28750     * @brief Get a value whether preserve mode is enabled or not.
28751     *
28752     * @param obj The naviframe object
28753     * @return If @c EINA_TRUE, preserve mode is enabled
28754     *
28755     * @see also elm_naviframe_content_preserve_on_pop_set()
28756     *
28757     * @ingroup Naviframe
28758     */
28759    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28760    /**
28761     * @brief Get a top item on the naviframe stack
28762     *
28763     * @param obj The naviframe object
28764     * @return The top item on the naviframe stack or @c NULL, if the stack is
28765     *         empty
28766     *
28767     * @ingroup Naviframe
28768     */
28769    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28770    /**
28771     * @brief Get a bottom item on the naviframe stack
28772     *
28773     * @param obj The naviframe object
28774     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28775     *         empty
28776     *
28777     * @ingroup Naviframe
28778     */
28779    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28780    /**
28781     * @brief Set an item style
28782     *
28783     * @param obj The naviframe item
28784     * @param item_style The current item style name. @c NULL would be default
28785     *
28786     * The following styles are available for this item:
28787     * @li @c "default"
28788     *
28789     * @see also elm_naviframe_item_style_get()
28790     *
28791     * @ingroup Naviframe
28792     */
28793    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28794    /**
28795     * @brief Get an item style
28796     *
28797     * @param obj The naviframe item
28798     * @return The current item style name
28799     *
28800     * @see also elm_naviframe_item_style_set()
28801     *
28802     * @ingroup Naviframe
28803     */
28804    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28805    /**
28806     * @brief Show/Hide the title area
28807     *
28808     * @param it The naviframe item
28809     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28810     *        otherwise
28811     *
28812     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28813     *
28814     * @see also elm_naviframe_item_title_visible_get()
28815     *
28816     * @ingroup Naviframe
28817     */
28818    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28819    /**
28820     * @brief Get a value whether title area is visible or not.
28821     *
28822     * @param it The naviframe item
28823     * @return If @c EINA_TRUE, title area is visible
28824     *
28825     * @see also elm_naviframe_item_title_visible_set()
28826     *
28827     * @ingroup Naviframe
28828     */
28829    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28830
28831    /**
28832     * @brief Set creating prev button automatically or not
28833     *
28834     * @param obj The naviframe object
28835     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28836     *        be created internally when you pass the @c NULL to the prev_btn
28837     *        parameter in elm_naviframe_item_push
28838     *
28839     * @see also elm_naviframe_item_push()
28840     */
28841    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28842    /**
28843     * @brief Get a value whether prev button(back button) will be auto pushed or
28844     *        not.
28845     *
28846     * @param obj The naviframe object
28847     * @return If @c EINA_TRUE, prev button will be auto pushed.
28848     *
28849     * @see also elm_naviframe_item_push()
28850     *           elm_naviframe_prev_btn_auto_pushed_set()
28851     */
28852    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28853    /**
28854     * @brief Get a list of all the naviframe items.
28855     *
28856     * @param obj The naviframe object
28857     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28858     * or @c NULL on failure.
28859     */
28860    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28861
28862    /**
28863     * @}
28864     */
28865
28866 #ifdef __cplusplus
28867 }
28868 #endif
28869
28870 #endif