elm: change elm_object_content_part_set/get/unset to elm_object_part_content_set...
[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
321 /* Standard headers for standard system calls etc. */
322 #include <stdio.h>
323 #include <stdlib.h>
324 #include <unistd.h>
325 #include <string.h>
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
330 #include <dlfcn.h>
331 #include <math.h>
332 #include <fnmatch.h>
333 #include <limits.h>
334 #include <ctype.h>
335 #include <time.h>
336 #include <dirent.h>
337 #include <pwd.h>
338 #include <errno.h>
339
340 #ifdef ELM_UNIX
341 # include <locale.h>
342 # ifdef ELM_LIBINTL_H
343 #  include <libintl.h>
344 # endif
345 # include <signal.h>
346 # include <grp.h>
347 # include <glob.h>
348 #endif
349
350 #ifdef ELM_ALLOCA_H
351 # include <alloca.h>
352 #endif
353
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
355 # include <malloc.h>
356 # ifndef alloca
357 #  define alloca _alloca
358 # endif
359 #endif
360
361
362 /* EFL headers */
363 #include <Eina.h>
364 #include <Eet.h>
365 #include <Evas.h>
366 #include <Evas_GL.h>
367 #include <Ecore.h>
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
372 #include <Edje.h>
373
374 #ifdef ELM_EDBUS
375 # include <E_DBus.h>
376 #endif
377
378 #ifdef ELM_EFREET
379 # include <Efreet.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
382 #endif
383
384 #ifdef ELM_ETHUMB
385 # include <Ethumb_Client.h>
386 #endif
387
388 #ifdef ELM_EMAP
389 # include <EMap.h>
390 #endif
391
392 #ifdef EAPI
393 # undef EAPI
394 #endif
395
396 #ifdef _WIN32
397 # ifdef ELEMENTARY_BUILD
398 #  ifdef DLL_EXPORT
399 #   define EAPI __declspec(dllexport)
400 #  else
401 #   define EAPI
402 #  endif /* ! DLL_EXPORT */
403 # else
404 #  define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
406 #else
407 # ifdef __GNUC__
408 #  if __GNUC__ >= 4
409 #   define EAPI __attribute__ ((visibility("default")))
410 #  else
411 #   define EAPI
412 #  endif
413 # else
414 #  define EAPI
415 # endif
416 #endif /* ! _WIN32 */
417
418 #ifdef _WIN32
419 # define EAPI_MAIN
420 #else
421 # define EAPI_MAIN EAPI
422 #endif
423
424 /* allow usage from c++ */
425 #ifdef __cplusplus
426 extern "C" {
427 #endif
428
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
431
432    typedef struct _Elm_Version
433      {
434         int major;
435         int minor;
436         int micro;
437         int revision;
438      } Elm_Version;
439
440    EAPI extern Elm_Version *elm_version;
441
442 /* handy macros */
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
445
446    /**
447     * @defgroup General General
448     *
449     * @brief General Elementary API. Functions that don't relate to
450     * Elementary objects specifically.
451     *
452     * Here are documented functions which init/shutdown the library,
453     * that apply to generic Elementary objects, that deal with
454     * configuration, et cetera.
455     *
456     * @ref general_functions_example_page "This" example contemplates
457     * some of these functions.
458     */
459
460    /**
461     * @addtogroup General
462     * @{
463     */
464
465   /**
466    * Defines couple of standard Evas_Object layers to be used
467    * with evas_object_layer_set().
468    *
469    * @note whenever extending with new values, try to keep some padding
470    *       to siblings so there is room for further extensions.
471    */
472   typedef enum _Elm_Object_Layer
473     {
474        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
480     } Elm_Object_Layer;
481
482 /**************************************************************************/
483    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
484
485    /**
486     * Emitted when any Elementary's policy value is changed.
487     */
488    EAPI extern int ELM_EVENT_POLICY_CHANGED;
489
490    /**
491     * @typedef Elm_Event_Policy_Changed
492     *
493     * Data on the event when an Elementary policy has changed
494     */
495     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
496
497    /**
498     * @struct _Elm_Event_Policy_Changed
499     *
500     * Data on the event when an Elementary policy has changed
501     */
502     struct _Elm_Event_Policy_Changed
503      {
504         unsigned int policy; /**< the policy identifier */
505         int          new_value; /**< value the policy had before the change */
506         int          old_value; /**< new value the policy got */
507     };
508
509    /**
510     * Policy identifiers.
511     */
512     typedef enum _Elm_Policy
513     {
514         ELM_POLICY_QUIT, /**< under which circumstances the application
515                           * should quit automatically. @see
516                           * Elm_Policy_Quit.
517                           */
518         ELM_POLICY_LAST
519     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
520  */
521
522    typedef enum _Elm_Policy_Quit
523      {
524         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
525                                    * automatically */
526         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
527                                             * application's last
528                                             * window is closed */
529      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
530
531    typedef enum _Elm_Focus_Direction
532      {
533         ELM_FOCUS_PREVIOUS,
534         ELM_FOCUS_NEXT
535      } Elm_Focus_Direction;
536
537    typedef enum _Elm_Text_Format
538      {
539         ELM_TEXT_FORMAT_PLAIN_UTF8,
540         ELM_TEXT_FORMAT_MARKUP_UTF8
541      } Elm_Text_Format;
542
543    /**
544     * Line wrapping types.
545     */
546    typedef enum _Elm_Wrap_Type
547      {
548         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
552         ELM_WRAP_LAST
553      } Elm_Wrap_Type;
554
555    typedef enum
556      {
557         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
558         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
559         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
560         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
561         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
562         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
563         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
564         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
565         ELM_INPUT_PANEL_LAYOUT_INVALID
566      } Elm_Input_Panel_Layout;
567
568    typedef enum
569      {
570         ELM_AUTOCAPITAL_TYPE_NONE,
571         ELM_AUTOCAPITAL_TYPE_WORD,
572         ELM_AUTOCAPITAL_TYPE_SENTENCE,
573         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
574      } Elm_Autocapital_Type;
575
576    /**
577     * @typedef Elm_Object_Item
578     * An Elementary Object item handle.
579     * @ingroup General
580     */
581    typedef struct _Elm_Object_Item Elm_Object_Item;
582
583
584    /**
585     * Called back when a widget's tooltip is activated and needs content.
586     * @param data user-data given to elm_object_tooltip_content_cb_set()
587     * @param obj owner widget.
588     */
589    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
590
591    /**
592     * Called back when a widget's item tooltip is activated and needs content.
593     * @param data user-data given to elm_object_tooltip_content_cb_set()
594     * @param obj owner widget.
595     * @param item context dependent item. As an example, if tooltip was
596     *        set on Elm_List_Item, then it is of this type.
597     */
598    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
599
600    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
601
602 #ifndef ELM_LIB_QUICKLAUNCH
603 #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 */
604 #else
605 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
606 #endif
607
608 /**************************************************************************/
609    /* General calls */
610
611    /**
612     * Initialize Elementary
613     *
614     * @param[in] argc System's argument count value
615     * @param[in] argv System's pointer to array of argument strings
616     * @return The init counter value.
617     *
618     * This function initializes Elementary and increments a counter of
619     * the number of calls to it. It returns the new counter's value.
620     *
621     * @warning This call is exported only for use by the @c ELM_MAIN()
622     * macro. There is no need to use this if you use this macro (which
623     * is highly advisable). An elm_main() should contain the entry
624     * point code for your application, having the same prototype as
625     * elm_init(), and @b not being static (putting the @c EAPI symbol
626     * in front of its type declaration is advisable). The @c
627     * ELM_MAIN() call should be placed just after it.
628     *
629     * Example:
630     * @dontinclude bg_example_01.c
631     * @skip static void
632     * @until ELM_MAIN
633     *
634     * See the full @ref bg_example_01_c "example".
635     *
636     * @see elm_shutdown().
637     * @ingroup General
638     */
639    EAPI int          elm_init(int argc, char **argv);
640
641    /**
642     * Shut down Elementary
643     *
644     * @return The init counter value.
645     *
646     * This should be called at the end of your application, just
647     * before it ceases to do any more processing. This will clean up
648     * any permanent resources your application may have allocated via
649     * Elementary that would otherwise persist.
650     *
651     * @see elm_init() for an example
652     *
653     * @ingroup General
654     */
655    EAPI int          elm_shutdown(void);
656
657    /**
658     * Run Elementary's main loop
659     *
660     * This call should be issued just after all initialization is
661     * completed. This function will not return until elm_exit() is
662     * called. It will keep looping, running the main
663     * (event/processing) loop for Elementary.
664     *
665     * @see elm_init() for an example
666     *
667     * @ingroup General
668     */
669    EAPI void         elm_run(void);
670
671    /**
672     * Exit Elementary's main loop
673     *
674     * If this call is issued, it will flag the main loop to cease
675     * processing and return back to its parent function (usually your
676     * elm_main() function).
677     *
678     * @see elm_init() for an example. There, just after a request to
679     * close the window comes, the main loop will be left.
680     *
681     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
682     * applications, you'll be able to get this function called automatically for you.
683     *
684     * @ingroup General
685     */
686    EAPI void         elm_exit(void);
687
688    /**
689     * Provide information in order to make Elementary determine the @b
690     * run time location of the software in question, so other data files
691     * such as images, sound files, executable utilities, libraries,
692     * modules and locale files can be found.
693     *
694     * @param mainfunc This is your application's main function name,
695     *        whose binary's location is to be found. Providing @c NULL
696     *        will make Elementary not to use it
697     * @param dom This will be used as the application's "domain", in the
698     *        form of a prefix to any environment variables that may
699     *        override prefix detection and the directory name, inside the
700     *        standard share or data directories, where the software's
701     *        data files will be looked for.
702     * @param checkfile This is an (optional) magic file's path to check
703     *        for existence (and it must be located in the data directory,
704     *        under the share directory provided above). Its presence will
705     *        help determine the prefix found was correct. Pass @c NULL if
706     *        the check is not to be done.
707     *
708     * This function allows one to re-locate the application somewhere
709     * else after compilation, if the developer wishes for easier
710     * distribution of pre-compiled binaries.
711     *
712     * The prefix system is designed to locate where the given software is
713     * installed (under a common path prefix) at run time and then report
714     * specific locations of this prefix and common directories inside
715     * this prefix like the binary, library, data and locale directories,
716     * through the @c elm_app_*_get() family of functions.
717     *
718     * Call elm_app_info_set() early on before you change working
719     * directory or anything about @c argv[0], so it gets accurate
720     * information.
721     *
722     * It will then try and trace back which file @p mainfunc comes from,
723     * if provided, to determine the application's prefix directory.
724     *
725     * The @p dom parameter provides a string prefix to prepend before
726     * environment variables, allowing a fallback to @b specific
727     * environment variables to locate the software. You would most
728     * probably provide a lowercase string there, because it will also
729     * serve as directory domain, explained next. For environment
730     * variables purposes, this string is made uppercase. For example if
731     * @c "myapp" is provided as the prefix, then the program would expect
732     * @c "MYAPP_PREFIX" as a master environment variable to specify the
733     * exact install prefix for the software, or more specific environment
734     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
735     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
736     * the user or scripts before launching. If not provided (@c NULL),
737     * environment variables will not be used to override compiled-in
738     * defaults or auto detections.
739     *
740     * The @p dom string also provides a subdirectory inside the system
741     * shared data directory for data files. For example, if the system
742     * directory is @c /usr/local/share, then this directory name is
743     * appended, creating @c /usr/local/share/myapp, if it @p was @c
744     * "myapp". It is expected that the application installs data files in
745     * this directory.
746     *
747     * The @p checkfile is a file name or path of something inside the
748     * share or data directory to be used to test that the prefix
749     * detection worked. For example, your app will install a wallpaper
750     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
751     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
752     * checkfile string.
753     *
754     * @see elm_app_compile_bin_dir_set()
755     * @see elm_app_compile_lib_dir_set()
756     * @see elm_app_compile_data_dir_set()
757     * @see elm_app_compile_locale_set()
758     * @see elm_app_prefix_dir_get()
759     * @see elm_app_bin_dir_get()
760     * @see elm_app_lib_dir_get()
761     * @see elm_app_data_dir_get()
762     * @see elm_app_locale_dir_get()
763     */
764    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
765
766    /**
767     * Provide information on the @b fallback application's binaries
768     * directory, in scenarios where they get overriden by
769     * elm_app_info_set().
770     *
771     * @param dir The path to the default binaries directory (compile time
772     * one)
773     *
774     * @note Elementary will as well use this path to determine actual
775     * names of binaries' directory paths, maybe changing it to be @c
776     * something/local/bin instead of @c something/bin, only, for
777     * example.
778     *
779     * @warning You should call this function @b before
780     * elm_app_info_set().
781     */
782    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
783
784    /**
785     * Provide information on the @b fallback application's libraries
786     * directory, on scenarios where they get overriden by
787     * elm_app_info_set().
788     *
789     * @param dir The path to the default libraries directory (compile
790     * time one)
791     *
792     * @note Elementary will as well use this path to determine actual
793     * names of libraries' directory paths, maybe changing it to be @c
794     * something/lib32 or @c something/lib64 instead of @c something/lib,
795     * only, for example.
796     *
797     * @warning You should call this function @b before
798     * elm_app_info_set().
799     */
800    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
801
802    /**
803     * Provide information on the @b fallback application's data
804     * directory, on scenarios where they get overriden by
805     * elm_app_info_set().
806     *
807     * @param dir The path to the default data directory (compile time
808     * one)
809     *
810     * @note Elementary will as well use this path to determine actual
811     * names of data directory paths, maybe changing it to be @c
812     * something/local/share instead of @c something/share, only, for
813     * example.
814     *
815     * @warning You should call this function @b before
816     * elm_app_info_set().
817     */
818    EAPI void         elm_app_compile_data_dir_set(const char *dir);
819
820    /**
821     * Provide information on the @b fallback application's locale
822     * directory, on scenarios where they get overriden by
823     * elm_app_info_set().
824     *
825     * @param dir The path to the default locale directory (compile time
826     * one)
827     *
828     * @warning You should call this function @b before
829     * elm_app_info_set().
830     */
831    EAPI void         elm_app_compile_locale_set(const char *dir);
832
833    /**
834     * Retrieve the application's run time prefix directory, as set by
835     * elm_app_info_set() and the way (environment) the application was
836     * run from.
837     *
838     * @return The directory prefix the application is actually using.
839     */
840    EAPI const char  *elm_app_prefix_dir_get(void);
841
842    /**
843     * Retrieve the application's run time binaries prefix directory, as
844     * set by elm_app_info_set() and the way (environment) the application
845     * was run from.
846     *
847     * @return The binaries directory prefix the application is actually
848     * using.
849     */
850    EAPI const char  *elm_app_bin_dir_get(void);
851
852    /**
853     * Retrieve the application's run time libraries prefix directory, as
854     * set by elm_app_info_set() and the way (environment) the application
855     * was run from.
856     *
857     * @return The libraries directory prefix the application is actually
858     * using.
859     */
860    EAPI const char  *elm_app_lib_dir_get(void);
861
862    /**
863     * Retrieve the application's run time data prefix directory, as
864     * set by elm_app_info_set() and the way (environment) the application
865     * was run from.
866     *
867     * @return The data directory prefix the application is actually
868     * using.
869     */
870    EAPI const char  *elm_app_data_dir_get(void);
871
872    /**
873     * Retrieve the application's run time locale prefix directory, as
874     * set by elm_app_info_set() and the way (environment) the application
875     * was run from.
876     *
877     * @return The locale directory prefix the application is actually
878     * using.
879     */
880    EAPI const char  *elm_app_locale_dir_get(void);
881
882    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
883    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
884    EAPI int          elm_quicklaunch_init(int argc, char **argv);
885    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
886    EAPI int          elm_quicklaunch_sub_shutdown(void);
887    EAPI int          elm_quicklaunch_shutdown(void);
888    EAPI void         elm_quicklaunch_seed(void);
889    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
890    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
891    EAPI void         elm_quicklaunch_cleanup(void);
892    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
893    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
894
895    EAPI Eina_Bool    elm_need_efreet(void);
896    EAPI Eina_Bool    elm_need_e_dbus(void);
897
898    /**
899     * This must be called before any other function that deals with
900     * elm_thumb objects or ethumb_client instances.
901     *
902     * @ingroup Thumb
903     */
904    EAPI Eina_Bool    elm_need_ethumb(void);
905
906    /**
907     * This must be called before any other function that deals with
908     * elm_web objects or ewk_view instances.
909     *
910     * @ingroup Web
911     */
912    EAPI Eina_Bool    elm_need_web(void);
913
914    /**
915     * Set a new policy's value (for a given policy group/identifier).
916     *
917     * @param policy policy identifier, as in @ref Elm_Policy.
918     * @param value policy value, which depends on the identifier
919     *
920     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
921     *
922     * Elementary policies define applications' behavior,
923     * somehow. These behaviors are divided in policy groups (see
924     * #Elm_Policy enumeration). This call will emit the Ecore event
925     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
926     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
927     * then.
928     *
929     * @note Currently, we have only one policy identifier/group
930     * (#ELM_POLICY_QUIT), which has two possible values.
931     *
932     * @ingroup General
933     */
934    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
935
936    /**
937     * Gets the policy value for given policy identifier.
938     *
939     * @param policy policy identifier, as in #Elm_Policy.
940     * @return The currently set policy value, for that
941     * identifier. Will be @c 0 if @p policy passed is invalid.
942     *
943     * @ingroup General
944     */
945    EAPI int          elm_policy_get(unsigned int policy);
946
947    /**
948     * Change the language of the current application
949     *
950     * The @p lang passed must be the full name of the locale to use, for
951     * example "en_US.utf8" or "es_ES@euro".
952     *
953     * Changing language with this function will make Elementary run through
954     * all its widgets, translating strings set with
955     * elm_object_domain_translatable_text_part_set(). This way, an entire
956     * UI can have its language changed without having to restart the program.
957     *
958     * For more complex cases, like having formatted strings that need
959     * translation, widgets will also emit a "language,changed" signal that
960     * the user can listen to to manually translate the text.
961     *
962     * @param lang Language to set, must be the full name of the locale
963     *
964     * @ingroup General
965     */
966    EAPI void         elm_language_set(const char *lang);
967
968    /**
969     * Set a label of an object
970     *
971     * @param obj The Elementary object
972     * @param part The text part name to set (NULL for the default label)
973     * @param label The new text of the label
974     *
975     * @note Elementary objects may have many labels (e.g. Action Slider)
976     * @deprecated Use elm_object_part_text_set() instead.
977     * @ingroup General
978     */
979    EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
980
981    /**
982     * Set a label of an object
983     *
984     * @param obj The Elementary object
985     * @param part The text part name to set (NULL for the default label)
986     * @param label The new text of the label
987     *
988     * @note Elementary objects may have many labels (e.g. Action Slider)
989     *
990     * @ingroup General
991     */
992    EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
993
994 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
995
996    /**
997     * Get a label of an object
998     *
999     * @param obj The Elementary object
1000     * @param part The text part name to get (NULL for the default label)
1001     * @return text of the label or NULL for any error
1002     *
1003     * @note Elementary objects may have many labels (e.g. Action Slider)
1004     * @deprecated Use elm_object_part_text_get() instead.
1005     * @ingroup General
1006     */
1007    EINA_DEPRECATED EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1008
1009    /**
1010     * Get a label of an object
1011     *
1012     * @param obj The Elementary object
1013     * @param part The text part name to get (NULL for the default label)
1014     * @return text of the label or NULL for any error
1015     *
1016     * @note Elementary objects may have many labels (e.g. Action Slider)
1017     *
1018     * @ingroup General
1019     */
1020    EAPI const char  *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1021
1022 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1023
1024    /**
1025     * Set the text for an objects' part, marking it as translatable.
1026     *
1027     * The string to set as @p text must be the original one. Do not pass the
1028     * return of @c gettext() here. Elementary will translate the string
1029     * internally and set it on the object using elm_object_part_text_set(),
1030     * also storing the original string so that it can be automatically
1031     * translated when the language is changed with elm_language_set().
1032     *
1033     * The @p domain will be stored along to find the translation in the
1034     * correct catalog. It can be NULL, in which case it will use whatever
1035     * domain was set by the application with @c textdomain(). This is useful
1036     * in case you are building a library on top of Elementary that will have
1037     * its own translatable strings, that should not be mixed with those of
1038     * programs using the library.
1039     *
1040     * @param obj The object containing the text part
1041     * @param part The name of the part to set
1042     * @param domain The translation domain to use
1043     * @param text The original, non-translated text to set
1044     *
1045     * @ingroup General
1046     */
1047    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1048
1049 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1050
1051 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1052
1053    /**
1054     * Gets the original string set as translatable for an object
1055     *
1056     * When setting translated strings, the function elm_object_part_text_get()
1057     * will return the translation returned by @c gettext(). To get the
1058     * original string use this function.
1059     *
1060     * @param obj The object
1061     * @param part The name of the part that was set
1062     *
1063     * @return The original, untranslated string
1064     *
1065     * @ingroup General
1066     */
1067    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1068
1069 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1070
1071    /**
1072     * Set a content of an object
1073     *
1074     * @param obj The Elementary object
1075     * @param part The content part name to set (NULL for the default content)
1076     * @param content The new content of the object
1077     *
1078     * @note Elementary objects may have many contents
1079     * @deprecated Use elm_object_part_content_set instead.
1080     * @ingroup General
1081     */
1082    EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1083
1084    /**
1085     * Set a content of an object
1086     *
1087     * @param obj The Elementary object
1088     * @param part The content part name to set (NULL for the default content)
1089     * @param content The new content of the object
1090     *
1091     * @note Elementary objects may have many contents
1092     *
1093     * @ingroup General
1094     */
1095    EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1096
1097 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1098
1099    /**
1100     * Get a content of an object
1101     *
1102     * @param obj The Elementary object
1103     * @param item The content part name to get (NULL for the default content)
1104     * @return content of the object or NULL for any error
1105     *
1106     * @note Elementary objects may have many contents
1107     * @deprecated Use elm_object_part_content_get instead.
1108     * @ingroup General
1109     */
1110    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1111
1112    /**
1113     * Get a content of an object
1114     *
1115     * @param obj The Elementary object
1116     * @param item The content part name to get (NULL for the default content)
1117     * @return content of the object or NULL for any error
1118     *
1119     * @note Elementary objects may have many contents
1120     *
1121     * @ingroup General
1122     */
1123    EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1124
1125 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1126
1127    /**
1128     * Unset a content of an object
1129     *
1130     * @param obj The Elementary object
1131     * @param item The content part name to unset (NULL for the default content)
1132     *
1133     * @note Elementary objects may have many contents
1134     * @deprecated Use elm_object_part_content_unset instead.
1135     * @ingroup General
1136     */
1137    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1138
1139    /**
1140     * Unset a content of an object
1141     *
1142     * @param obj The Elementary object
1143     * @param item The content part name to unset (NULL for the default content)
1144     *
1145     * @note Elementary objects may have many contents
1146     *
1147     * @ingroup General
1148     */
1149    EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1150
1151 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1152
1153    /**
1154     * Get the widget object's handle which contains a given item
1155     *
1156     * @param item The Elementary object item
1157     * @return The widget object
1158     *
1159     * @note This returns the widget object itself that an item belongs to.
1160     *
1161     * @ingroup General
1162     */
1163    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1164
1165    /**
1166     * Set a content of an object item
1167     *
1168     * @param it The Elementary object item
1169     * @param part The content part name to set (NULL for the default content)
1170     * @param content The new content of the object item
1171     *
1172     * @note Elementary object items may have many contents
1173     *
1174     * @ingroup General
1175     */
1176    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1177
1178 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1179
1180    /**
1181     * Get a content of an object item
1182     *
1183     * @param it The Elementary object item
1184     * @param part The content part name to unset (NULL for the default content)
1185     * @return content of the object item or NULL for any error
1186     *
1187     * @note Elementary object items may have many contents
1188     *
1189     * @ingroup General
1190     */
1191    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1192
1193 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1194
1195    /**
1196     * Unset a content of an object item
1197     *
1198     * @param it The Elementary object item
1199     * @param part The content part name to unset (NULL for the default content)
1200     *
1201     * @note Elementary object items may have many contents
1202     *
1203     * @ingroup General
1204     */
1205    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1206
1207 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1208
1209    /**
1210     * Set a label of an object item
1211     *
1212     * @param it The Elementary object item
1213     * @param part The text part name to set (NULL for the default label)
1214     * @param label The new text of the label
1215     *
1216     * @note Elementary object items may have many labels
1217     *
1218     * @ingroup General
1219     */
1220    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1221
1222 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1223
1224    /**
1225     * Get a label of an object item
1226     *
1227     * @param it The Elementary object item
1228     * @param part The text part name to get (NULL for the default label)
1229     * @return text of the label or NULL for any error
1230     *
1231     * @note Elementary object items may have many labels
1232     *
1233     * @ingroup General
1234     */
1235    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1236
1237    /**
1238     * Set the text to read out when in accessibility mode
1239     *
1240     * @param obj The object which is to be described
1241     * @param txt The text that describes the widget to people with poor or no vision
1242     *
1243     * @ingroup General
1244     */
1245    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1246
1247    /**
1248     * Set the text to read out when in accessibility mode
1249     *
1250     * @param it The object item which is to be described
1251     * @param txt The text that describes the widget to people with poor or no vision
1252     *
1253     * @ingroup General
1254     */
1255    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1256
1257
1258 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1259
1260    /**
1261     * Set the text to read out when in accessibility mode
1262     *
1263     * @param obj The object which is to be described
1264     * @param txt The text that describes the widget to people with poor or no vision
1265     *
1266     * @ingroup General
1267     */
1268    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1269
1270    /**
1271     * Set the text to read out when in accessibility mode
1272     *
1273     * @param it The object item which is to be described
1274     * @param txt The text that describes the widget to people with poor or no vision
1275     *
1276     * @ingroup General
1277     */
1278    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1279
1280    /**
1281     * Get the data associated with an object item
1282     * @param it The Elementary object item
1283     * @return The data associated with @p it
1284     *
1285     * @ingroup General
1286     */
1287    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1288
1289    /**
1290     * Set the data associated with an object item
1291     * @param it The Elementary object item
1292     * @param data The data to be associated with @p it
1293     *
1294     * @ingroup General
1295     */
1296    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1297
1298    /**
1299     * Send a signal to the edje object of the widget item.
1300     *
1301     * This function sends a signal to the edje object of the obj item. An
1302     * edje program can respond to a signal by specifying matching
1303     * 'signal' and 'source' fields.
1304     *
1305     * @param it The Elementary object item
1306     * @param emission The signal's name.
1307     * @param source The signal's source.
1308     * @ingroup General
1309     */
1310    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1311
1312    /**
1313     * @}
1314     */
1315
1316    /**
1317     * @defgroup Caches Caches
1318     *
1319     * These are functions which let one fine-tune some cache values for
1320     * Elementary applications, thus allowing for performance adjustments.
1321     *
1322     * @{
1323     */
1324
1325    /**
1326     * @brief Flush all caches.
1327     *
1328     * Frees all data that was in cache and is not currently being used to reduce
1329     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1330     * to calling all of the following functions:
1331     * @li edje_file_cache_flush()
1332     * @li edje_collection_cache_flush()
1333     * @li eet_clearcache()
1334     * @li evas_image_cache_flush()
1335     * @li evas_font_cache_flush()
1336     * @li evas_render_dump()
1337     * @note Evas caches are flushed for every canvas associated with a window.
1338     *
1339     * @ingroup Caches
1340     */
1341    EAPI void         elm_all_flush(void);
1342
1343    /**
1344     * Get the configured cache flush interval time
1345     *
1346     * This gets the globally configured cache flush interval time, in
1347     * ticks
1348     *
1349     * @return The cache flush interval time
1350     * @ingroup Caches
1351     *
1352     * @see elm_all_flush()
1353     */
1354    EAPI int          elm_cache_flush_interval_get(void);
1355
1356    /**
1357     * Set the configured cache flush interval time
1358     *
1359     * This sets the globally configured cache flush interval time, in ticks
1360     *
1361     * @param size The cache flush interval time
1362     * @ingroup Caches
1363     *
1364     * @see elm_all_flush()
1365     */
1366    EAPI void         elm_cache_flush_interval_set(int size);
1367
1368    /**
1369     * Set the configured cache flush interval time for all applications on the
1370     * display
1371     *
1372     * This sets the globally configured cache flush interval time -- in ticks
1373     * -- for all applications on the display.
1374     *
1375     * @param size The cache flush interval time
1376     * @ingroup Caches
1377     */
1378    EAPI void         elm_cache_flush_interval_all_set(int size);
1379
1380    /**
1381     * Get the configured cache flush enabled state
1382     *
1383     * This gets the globally configured cache flush state - if it is enabled
1384     * or not. When cache flushing is enabled, elementary will regularly
1385     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1386     * memory and allow usage to re-seed caches and data in memory where it
1387     * can do so. An idle application will thus minimise its memory usage as
1388     * data will be freed from memory and not be re-loaded as it is idle and
1389     * not rendering or doing anything graphically right now.
1390     *
1391     * @return The cache flush state
1392     * @ingroup Caches
1393     *
1394     * @see elm_all_flush()
1395     */
1396    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1397
1398    /**
1399     * Set the configured cache flush enabled state
1400     *
1401     * This sets the globally configured cache flush enabled state.
1402     *
1403     * @param size The cache flush enabled state
1404     * @ingroup Caches
1405     *
1406     * @see elm_all_flush()
1407     */
1408    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1409
1410    /**
1411     * Set the configured cache flush enabled state for all applications on the
1412     * display
1413     *
1414     * This sets the globally configured cache flush enabled state for all
1415     * applications on the display.
1416     *
1417     * @param size The cache flush enabled state
1418     * @ingroup Caches
1419     */
1420    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1421
1422    /**
1423     * Get the configured font cache size
1424     *
1425     * This gets the globally configured font cache size, in bytes.
1426     *
1427     * @return The font cache size
1428     * @ingroup Caches
1429     */
1430    EAPI int          elm_font_cache_get(void);
1431
1432    /**
1433     * Set the configured font cache size
1434     *
1435     * This sets the globally configured font cache size, in bytes
1436     *
1437     * @param size The font cache size
1438     * @ingroup Caches
1439     */
1440    EAPI void         elm_font_cache_set(int size);
1441
1442    /**
1443     * Set the configured font cache size for all applications on the
1444     * display
1445     *
1446     * This sets the globally configured font cache size -- in bytes
1447     * -- for all applications on the display.
1448     *
1449     * @param size The font cache size
1450     * @ingroup Caches
1451     */
1452    EAPI void         elm_font_cache_all_set(int size);
1453
1454    /**
1455     * Get the configured image cache size
1456     *
1457     * This gets the globally configured image cache size, in bytes
1458     *
1459     * @return The image cache size
1460     * @ingroup Caches
1461     */
1462    EAPI int          elm_image_cache_get(void);
1463
1464    /**
1465     * Set the configured image cache size
1466     *
1467     * This sets the globally configured image cache size, in bytes
1468     *
1469     * @param size The image cache size
1470     * @ingroup Caches
1471     */
1472    EAPI void         elm_image_cache_set(int size);
1473
1474    /**
1475     * Set the configured image cache size for all applications on the
1476     * display
1477     *
1478     * This sets the globally configured image cache size -- in bytes
1479     * -- for all applications on the display.
1480     *
1481     * @param size The image cache size
1482     * @ingroup Caches
1483     */
1484    EAPI void         elm_image_cache_all_set(int size);
1485
1486    /**
1487     * Get the configured edje file cache size.
1488     *
1489     * This gets the globally configured edje file cache size, in number
1490     * of files.
1491     *
1492     * @return The edje file cache size
1493     * @ingroup Caches
1494     */
1495    EAPI int          elm_edje_file_cache_get(void);
1496
1497    /**
1498     * Set the configured edje file cache size
1499     *
1500     * This sets the globally configured edje file cache size, in number
1501     * of files.
1502     *
1503     * @param size The edje file cache size
1504     * @ingroup Caches
1505     */
1506    EAPI void         elm_edje_file_cache_set(int size);
1507
1508    /**
1509     * Set the configured edje file cache size for all applications on the
1510     * display
1511     *
1512     * This sets the globally configured edje file cache size -- in number
1513     * of files -- for all applications on the display.
1514     *
1515     * @param size The edje file cache size
1516     * @ingroup Caches
1517     */
1518    EAPI void         elm_edje_file_cache_all_set(int size);
1519
1520    /**
1521     * Get the configured edje collections (groups) cache size.
1522     *
1523     * This gets the globally configured edje collections cache size, in
1524     * number of collections.
1525     *
1526     * @return The edje collections cache size
1527     * @ingroup Caches
1528     */
1529    EAPI int          elm_edje_collection_cache_get(void);
1530
1531    /**
1532     * Set the configured edje collections (groups) cache size
1533     *
1534     * This sets the globally configured edje collections cache size, in
1535     * number of collections.
1536     *
1537     * @param size The edje collections cache size
1538     * @ingroup Caches
1539     */
1540    EAPI void         elm_edje_collection_cache_set(int size);
1541
1542    /**
1543     * Set the configured edje collections (groups) cache size for all
1544     * applications on the display
1545     *
1546     * This sets the globally configured edje collections cache size -- in
1547     * number of collections -- for all applications on the display.
1548     *
1549     * @param size The edje collections cache size
1550     * @ingroup Caches
1551     */
1552    EAPI void         elm_edje_collection_cache_all_set(int size);
1553
1554    /**
1555     * @}
1556     */
1557
1558    /**
1559     * @defgroup Scaling Widget Scaling
1560     *
1561     * Different widgets can be scaled independently. These functions
1562     * allow you to manipulate this scaling on a per-widget basis. The
1563     * object and all its children get their scaling factors multiplied
1564     * by the scale factor set. This is multiplicative, in that if a
1565     * child also has a scale size set it is in turn multiplied by its
1566     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1567     * double size, @c 0.5 is half, etc.
1568     *
1569     * @ref general_functions_example_page "This" example contemplates
1570     * some of these functions.
1571     */
1572
1573    /**
1574     * Get the global scaling factor
1575     *
1576     * This gets the globally configured scaling factor that is applied to all
1577     * objects.
1578     *
1579     * @return The scaling factor
1580     * @ingroup Scaling
1581     */
1582    EAPI double       elm_scale_get(void);
1583
1584    /**
1585     * Set the global scaling factor
1586     *
1587     * This sets the globally configured scaling factor that is applied to all
1588     * objects.
1589     *
1590     * @param scale The scaling factor to set
1591     * @ingroup Scaling
1592     */
1593    EAPI void         elm_scale_set(double scale);
1594
1595    /**
1596     * Set the global scaling factor for all applications on the display
1597     *
1598     * This sets the globally configured scaling factor that is applied to all
1599     * objects for all applications.
1600     * @param scale The scaling factor to set
1601     * @ingroup Scaling
1602     */
1603    EAPI void         elm_scale_all_set(double scale);
1604
1605    /**
1606     * Set the scaling factor for a given Elementary object
1607     *
1608     * @param obj The Elementary to operate on
1609     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1610     * no scaling)
1611     *
1612     * @ingroup Scaling
1613     */
1614    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1615
1616    /**
1617     * Get the scaling factor for a given Elementary object
1618     *
1619     * @param obj The object
1620     * @return The scaling factor set by elm_object_scale_set()
1621     *
1622     * @ingroup Scaling
1623     */
1624    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1625
1626    /**
1627     * @defgroup Password_last_show Password last input show
1628     *
1629     * Last show feature of password mode enables user to view
1630     * the last input entered for few seconds before masking it.
1631     * These functions allow to set this feature in password mode
1632     * of entry widget and also allow to manipulate the duration
1633     * for which the input has to be visible.
1634     *
1635     * @{
1636     */
1637
1638    /**
1639     * Get show last setting of password mode.
1640     *
1641     * This gets the show last input setting of password mode which might be
1642     * enabled or disabled.
1643     *
1644     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1645     *            if it's disabled.
1646     * @ingroup Password_last_show
1647     */
1648    EAPI Eina_Bool elm_password_show_last_get(void);
1649
1650    /**
1651     * Set show last setting in password mode.
1652     *
1653     * This enables or disables show last setting of password mode.
1654     *
1655     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1656     * @see elm_password_show_last_timeout_set()
1657     * @ingroup Password_last_show
1658     */
1659    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1660
1661    /**
1662     * Get's the timeout value in last show password mode.
1663     *
1664     * This gets the time out value for which the last input entered in password
1665     * mode will be visible.
1666     *
1667     * @return The timeout value of last show password mode.
1668     * @ingroup Password_last_show
1669     */
1670    EAPI double elm_password_show_last_timeout_get(void);
1671
1672    /**
1673     * Set's the timeout value in last show password mode.
1674     *
1675     * This sets the time out value for which the last input entered in password
1676     * mode will be visible.
1677     *
1678     * @param password_show_last_timeout The timeout value.
1679     * @see elm_password_show_last_set()
1680     * @ingroup Password_last_show
1681     */
1682    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1683
1684    /**
1685     * @}
1686     */
1687
1688    /**
1689     * @defgroup UI-Mirroring Selective Widget mirroring
1690     *
1691     * These functions allow you to set ui-mirroring on specific
1692     * widgets or the whole interface. Widgets can be in one of two
1693     * modes, automatic and manual.  Automatic means they'll be changed
1694     * according to the system mirroring mode and manual means only
1695     * explicit changes will matter. You are not supposed to change
1696     * mirroring state of a widget set to automatic, will mostly work,
1697     * but the behavior is not really defined.
1698     *
1699     * @{
1700     */
1701
1702    EAPI Eina_Bool    elm_mirrored_get(void);
1703    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1704
1705    /**
1706     * Get the system mirrored mode. This determines the default mirrored mode
1707     * of widgets.
1708     *
1709     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1710     */
1711    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1712
1713    /**
1714     * Set the system mirrored mode. This determines the default mirrored mode
1715     * of widgets.
1716     *
1717     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1718     */
1719    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1720
1721    /**
1722     * Returns the widget's mirrored mode setting.
1723     *
1724     * @param obj The widget.
1725     * @return mirrored mode setting of the object.
1726     *
1727     **/
1728    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1729
1730    /**
1731     * Sets the widget's mirrored mode setting.
1732     * When widget in automatic mode, it follows the system mirrored mode set by
1733     * elm_mirrored_set().
1734     * @param obj The widget.
1735     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1736     */
1737    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1738
1739    /**
1740     * @}
1741     */
1742
1743    /**
1744     * Set the style to use by a widget
1745     *
1746     * Sets the style name that will define the appearance of a widget. Styles
1747     * vary from widget to widget and may also be defined by other themes
1748     * by means of extensions and overlays.
1749     *
1750     * @param obj The Elementary widget to style
1751     * @param style The style name to use
1752     *
1753     * @see elm_theme_extension_add()
1754     * @see elm_theme_extension_del()
1755     * @see elm_theme_overlay_add()
1756     * @see elm_theme_overlay_del()
1757     *
1758     * @ingroup Styles
1759     */
1760    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1761    /**
1762     * Get the style used by the widget
1763     *
1764     * This gets the style being used for that widget. Note that the string
1765     * pointer is only valid as longas the object is valid and the style doesn't
1766     * change.
1767     *
1768     * @param obj The Elementary widget to query for its style
1769     * @return The style name used
1770     *
1771     * @see elm_object_style_set()
1772     *
1773     * @ingroup Styles
1774     */
1775    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1776
1777    /**
1778     * @defgroup Styles Styles
1779     *
1780     * Widgets can have different styles of look. These generic API's
1781     * set styles of widgets, if they support them (and if the theme(s)
1782     * do).
1783     *
1784     * @ref general_functions_example_page "This" example contemplates
1785     * some of these functions.
1786     */
1787
1788    /**
1789     * Set the disabled state of an Elementary object.
1790     *
1791     * @param obj The Elementary object to operate on
1792     * @param disabled The state to put in in: @c EINA_TRUE for
1793     *        disabled, @c EINA_FALSE for enabled
1794     *
1795     * Elementary objects can be @b disabled, in which state they won't
1796     * receive input and, in general, will be themed differently from
1797     * their normal state, usually greyed out. Useful for contexts
1798     * where you don't want your users to interact with some of the
1799     * parts of you interface.
1800     *
1801     * This sets the state for the widget, either disabling it or
1802     * enabling it back.
1803     *
1804     * @ingroup Styles
1805     */
1806    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1807
1808    /**
1809     * Get the disabled state of an Elementary object.
1810     *
1811     * @param obj The Elementary object to operate on
1812     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1813     *            if it's enabled (or on errors)
1814     *
1815     * This gets the state of the widget, which might be enabled or disabled.
1816     *
1817     * @ingroup Styles
1818     */
1819    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1820
1821    /**
1822     * @defgroup WidgetNavigation Widget Tree Navigation.
1823     *
1824     * How to check if an Evas Object is an Elementary widget? How to
1825     * get the first elementary widget that is parent of the given
1826     * object?  These are all covered in widget tree navigation.
1827     *
1828     * @ref general_functions_example_page "This" example contemplates
1829     * some of these functions.
1830     */
1831
1832    /**
1833     * Check if the given Evas Object is an Elementary widget.
1834     *
1835     * @param obj the object to query.
1836     * @return @c EINA_TRUE if it is an elementary widget variant,
1837     *         @c EINA_FALSE otherwise
1838     * @ingroup WidgetNavigation
1839     */
1840    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1841
1842    /**
1843     * Get the first parent of the given object that is an Elementary
1844     * widget.
1845     *
1846     * @param obj the Elementary object to query parent from.
1847     * @return the parent object that is an Elementary widget, or @c
1848     *         NULL, if it was not found.
1849     *
1850     * Use this to query for an object's parent widget.
1851     *
1852     * @note Most of Elementary users wouldn't be mixing non-Elementary
1853     * smart objects in the objects tree of an application, as this is
1854     * an advanced usage of Elementary with Evas. So, except for the
1855     * application's window, which is the root of that tree, all other
1856     * objects would have valid Elementary widget parents.
1857     *
1858     * @ingroup WidgetNavigation
1859     */
1860    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1861
1862    /**
1863     * Get the top level parent of an Elementary widget.
1864     *
1865     * @param obj The object to query.
1866     * @return The top level Elementary widget, or @c NULL if parent cannot be
1867     * found.
1868     * @ingroup WidgetNavigation
1869     */
1870    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1871
1872    /**
1873     * Get the string that represents this Elementary widget.
1874     *
1875     * @note Elementary is weird and exposes itself as a single
1876     *       Evas_Object_Smart_Class of type "elm_widget", so
1877     *       evas_object_type_get() always return that, making debug and
1878     *       language bindings hard. This function tries to mitigate this
1879     *       problem, but the solution is to change Elementary to use
1880     *       proper inheritance.
1881     *
1882     * @param obj the object to query.
1883     * @return Elementary widget name, or @c NULL if not a valid widget.
1884     * @ingroup WidgetNavigation
1885     */
1886    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1887
1888    /**
1889     * @defgroup Config Elementary Config
1890     *
1891     * Elementary configuration is formed by a set options bounded to a
1892     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1893     * "finger size", etc. These are functions with which one syncronizes
1894     * changes made to those values to the configuration storing files, de
1895     * facto. You most probably don't want to use the functions in this
1896     * group unlees you're writing an elementary configuration manager.
1897     *
1898     * @{
1899     */
1900
1901    /**
1902     * Save back Elementary's configuration, so that it will persist on
1903     * future sessions.
1904     *
1905     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1906     * @ingroup Config
1907     *
1908     * This function will take effect -- thus, do I/O -- immediately. Use
1909     * it when you want to apply all configuration changes at once. The
1910     * current configuration set will get saved onto the current profile
1911     * configuration file.
1912     *
1913     */
1914    EAPI Eina_Bool    elm_config_save(void);
1915
1916    /**
1917     * Reload Elementary's configuration, bounded to current selected
1918     * profile.
1919     *
1920     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1921     * @ingroup Config
1922     *
1923     * Useful when you want to force reloading of configuration values for
1924     * a profile. If one removes user custom configuration directories,
1925     * for example, it will force a reload with system values instead.
1926     *
1927     */
1928    EAPI void         elm_config_reload(void);
1929
1930    /**
1931     * @}
1932     */
1933
1934    /**
1935     * @defgroup Profile Elementary Profile
1936     *
1937     * Profiles are pre-set options that affect the whole look-and-feel of
1938     * Elementary-based applications. There are, for example, profiles
1939     * aimed at desktop computer applications and others aimed at mobile,
1940     * touchscreen-based ones. You most probably don't want to use the
1941     * functions in this group unlees you're writing an elementary
1942     * configuration manager.
1943     *
1944     * @{
1945     */
1946
1947    /**
1948     * Get Elementary's profile in use.
1949     *
1950     * This gets the global profile that is applied to all Elementary
1951     * applications.
1952     *
1953     * @return The profile's name
1954     * @ingroup Profile
1955     */
1956    EAPI const char  *elm_profile_current_get(void);
1957
1958    /**
1959     * Get an Elementary's profile directory path in the filesystem. One
1960     * may want to fetch a system profile's dir or an user one (fetched
1961     * inside $HOME).
1962     *
1963     * @param profile The profile's name
1964     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1965     *                or a system one (@c EINA_FALSE)
1966     * @return The profile's directory path.
1967     * @ingroup Profile
1968     *
1969     * @note You must free it with elm_profile_dir_free().
1970     */
1971    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1972
1973    /**
1974     * Free an Elementary's profile directory path, as returned by
1975     * elm_profile_dir_get().
1976     *
1977     * @param p_dir The profile's path
1978     * @ingroup Profile
1979     *
1980     */
1981    EAPI void         elm_profile_dir_free(const char *p_dir);
1982
1983    /**
1984     * Get Elementary's list of available profiles.
1985     *
1986     * @return The profiles list. List node data are the profile name
1987     *         strings.
1988     * @ingroup Profile
1989     *
1990     * @note One must free this list, after usage, with the function
1991     *       elm_profile_list_free().
1992     */
1993    EAPI Eina_List   *elm_profile_list_get(void);
1994
1995    /**
1996     * Free Elementary's list of available profiles.
1997     *
1998     * @param l The profiles list, as returned by elm_profile_list_get().
1999     * @ingroup Profile
2000     *
2001     */
2002    EAPI void         elm_profile_list_free(Eina_List *l);
2003
2004    /**
2005     * Set Elementary's profile.
2006     *
2007     * This sets the global profile that is applied to Elementary
2008     * applications. Just the process the call comes from will be
2009     * affected.
2010     *
2011     * @param profile The profile's name
2012     * @ingroup Profile
2013     *
2014     */
2015    EAPI void         elm_profile_set(const char *profile);
2016
2017    /**
2018     * Set Elementary's profile.
2019     *
2020     * This sets the global profile that is applied to all Elementary
2021     * applications. All running Elementary windows will be affected.
2022     *
2023     * @param profile The profile's name
2024     * @ingroup Profile
2025     *
2026     */
2027    EAPI void         elm_profile_all_set(const char *profile);
2028
2029    /**
2030     * @}
2031     */
2032
2033    /**
2034     * @defgroup Engine Elementary Engine
2035     *
2036     * These are functions setting and querying which rendering engine
2037     * Elementary will use for drawing its windows' pixels.
2038     *
2039     * The following are the available engines:
2040     * @li "software_x11"
2041     * @li "fb"
2042     * @li "directfb"
2043     * @li "software_16_x11"
2044     * @li "software_8_x11"
2045     * @li "xrender_x11"
2046     * @li "opengl_x11"
2047     * @li "software_gdi"
2048     * @li "software_16_wince_gdi"
2049     * @li "sdl"
2050     * @li "software_16_sdl"
2051     * @li "opengl_sdl"
2052     * @li "buffer"
2053     * @li "ews"
2054     * @li "opengl_cocoa"
2055     * @li "psl1ght"
2056     *
2057     * @{
2058     */
2059
2060    /**
2061     * @brief Get Elementary's rendering engine in use.
2062     *
2063     * @return The rendering engine's name
2064     * @note there's no need to free the returned string, here.
2065     *
2066     * This gets the global rendering engine that is applied to all Elementary
2067     * applications.
2068     *
2069     * @see elm_engine_set()
2070     */
2071    EAPI const char  *elm_engine_current_get(void);
2072
2073    /**
2074     * @brief Set Elementary's rendering engine for use.
2075     *
2076     * @param engine The rendering engine's name
2077     *
2078     * This sets global rendering engine that is applied to all Elementary
2079     * applications. Note that it will take effect only to Elementary windows
2080     * created after this is called.
2081     *
2082     * @see elm_win_add()
2083     */
2084    EAPI void         elm_engine_set(const char *engine);
2085
2086    /**
2087     * @}
2088     */
2089
2090    /**
2091     * @defgroup Fonts Elementary Fonts
2092     *
2093     * These are functions dealing with font rendering, selection and the
2094     * like for Elementary applications. One might fetch which system
2095     * fonts are there to use and set custom fonts for individual classes
2096     * of UI items containing text (text classes).
2097     *
2098     * @{
2099     */
2100
2101   typedef struct _Elm_Text_Class
2102     {
2103        const char *name;
2104        const char *desc;
2105     } Elm_Text_Class;
2106
2107   typedef struct _Elm_Font_Overlay
2108     {
2109        const char     *text_class;
2110        const char     *font;
2111        Evas_Font_Size  size;
2112     } Elm_Font_Overlay;
2113
2114   typedef struct _Elm_Font_Properties
2115     {
2116        const char *name;
2117        Eina_List  *styles;
2118     } Elm_Font_Properties;
2119
2120    /**
2121     * Get Elementary's list of supported text classes.
2122     *
2123     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2124     * @ingroup Fonts
2125     *
2126     * Release the list with elm_text_classes_list_free().
2127     */
2128    EAPI const Eina_List     *elm_text_classes_list_get(void);
2129
2130    /**
2131     * Free Elementary's list of supported text classes.
2132     *
2133     * @ingroup Fonts
2134     *
2135     * @see elm_text_classes_list_get().
2136     */
2137    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2138
2139    /**
2140     * Get Elementary's list of font overlays, set with
2141     * elm_font_overlay_set().
2142     *
2143     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2144     * data.
2145     *
2146     * @ingroup Fonts
2147     *
2148     * For each text class, one can set a <b>font overlay</b> for it,
2149     * overriding the default font properties for that class coming from
2150     * the theme in use. There is no need to free this list.
2151     *
2152     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2153     */
2154    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2155
2156    /**
2157     * Set a font overlay for a given Elementary text class.
2158     *
2159     * @param text_class Text class name
2160     * @param font Font name and style string
2161     * @param size Font size
2162     *
2163     * @ingroup Fonts
2164     *
2165     * @p font has to be in the format returned by
2166     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2167     * and elm_font_overlay_unset().
2168     */
2169    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2170
2171    /**
2172     * Unset a font overlay for a given Elementary text class.
2173     *
2174     * @param text_class Text class name
2175     *
2176     * @ingroup Fonts
2177     *
2178     * This will bring back text elements belonging to text class
2179     * @p text_class back to their default font settings.
2180     */
2181    EAPI void                 elm_font_overlay_unset(const char *text_class);
2182
2183    /**
2184     * Apply the changes made with elm_font_overlay_set() and
2185     * elm_font_overlay_unset() on the current Elementary window.
2186     *
2187     * @ingroup Fonts
2188     *
2189     * This applies all font overlays set to all objects in the UI.
2190     */
2191    EAPI void                 elm_font_overlay_apply(void);
2192
2193    /**
2194     * Apply the changes made with elm_font_overlay_set() and
2195     * elm_font_overlay_unset() on all Elementary application windows.
2196     *
2197     * @ingroup Fonts
2198     *
2199     * This applies all font overlays set to all objects in the UI.
2200     */
2201    EAPI void                 elm_font_overlay_all_apply(void);
2202
2203    /**
2204     * Translate a font (family) name string in fontconfig's font names
2205     * syntax into an @c Elm_Font_Properties struct.
2206     *
2207     * @param font The font name and styles string
2208     * @return the font properties struct
2209     *
2210     * @ingroup Fonts
2211     *
2212     * @note The reverse translation can be achived with
2213     * elm_font_fontconfig_name_get(), for one style only (single font
2214     * instance, not family).
2215     */
2216    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2217
2218    /**
2219     * Free font properties return by elm_font_properties_get().
2220     *
2221     * @param efp the font properties struct
2222     *
2223     * @ingroup Fonts
2224     */
2225    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2226
2227    /**
2228     * Translate a font name, bound to a style, into fontconfig's font names
2229     * syntax.
2230     *
2231     * @param name The font (family) name
2232     * @param style The given style (may be @c NULL)
2233     *
2234     * @return the font name and style string
2235     *
2236     * @ingroup Fonts
2237     *
2238     * @note The reverse translation can be achived with
2239     * elm_font_properties_get(), for one style only (single font
2240     * instance, not family).
2241     */
2242    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2243
2244    /**
2245     * Free the font string return by elm_font_fontconfig_name_get().
2246     *
2247     * @param efp the font properties struct
2248     *
2249     * @ingroup Fonts
2250     */
2251    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2252
2253    /**
2254     * Create a font hash table of available system fonts.
2255     *
2256     * One must call it with @p list being the return value of
2257     * evas_font_available_list(). The hash will be indexed by font
2258     * (family) names, being its values @c Elm_Font_Properties blobs.
2259     *
2260     * @param list The list of available system fonts, as returned by
2261     * evas_font_available_list().
2262     * @return the font hash.
2263     *
2264     * @ingroup Fonts
2265     *
2266     * @note The user is supposed to get it populated at least with 3
2267     * default font families (Sans, Serif, Monospace), which should be
2268     * present on most systems.
2269     */
2270    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2271
2272    /**
2273     * Free the hash return by elm_font_available_hash_add().
2274     *
2275     * @param hash the hash to be freed.
2276     *
2277     * @ingroup Fonts
2278     */
2279    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2280
2281    /**
2282     * @}
2283     */
2284
2285    /**
2286     * @defgroup Fingers Fingers
2287     *
2288     * Elementary is designed to be finger-friendly for touchscreens,
2289     * and so in addition to scaling for display resolution, it can
2290     * also scale based on finger "resolution" (or size). You can then
2291     * customize the granularity of the areas meant to receive clicks
2292     * on touchscreens.
2293     *
2294     * Different profiles may have pre-set values for finger sizes.
2295     *
2296     * @ref general_functions_example_page "This" example contemplates
2297     * some of these functions.
2298     *
2299     * @{
2300     */
2301
2302    /**
2303     * Get the configured "finger size"
2304     *
2305     * @return The finger size
2306     *
2307     * This gets the globally configured finger size, <b>in pixels</b>
2308     *
2309     * @ingroup Fingers
2310     */
2311    EAPI Evas_Coord       elm_finger_size_get(void);
2312
2313    /**
2314     * Set the configured finger size
2315     *
2316     * This sets the globally configured finger size in pixels
2317     *
2318     * @param size The finger size
2319     * @ingroup Fingers
2320     */
2321    EAPI void             elm_finger_size_set(Evas_Coord size);
2322
2323    /**
2324     * Set the configured finger size for all applications on the display
2325     *
2326     * This sets the globally configured finger size in pixels for all
2327     * applications on the display
2328     *
2329     * @param size The finger size
2330     * @ingroup Fingers
2331     */
2332    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2333
2334    /**
2335     * @}
2336     */
2337
2338    /**
2339     * @defgroup Focus Focus
2340     *
2341     * An Elementary application has, at all times, one (and only one)
2342     * @b focused object. This is what determines where the input
2343     * events go to within the application's window. Also, focused
2344     * objects can be decorated differently, in order to signal to the
2345     * user where the input is, at a given moment.
2346     *
2347     * Elementary applications also have the concept of <b>focus
2348     * chain</b>: one can cycle through all the windows' focusable
2349     * objects by input (tab key) or programmatically. The default
2350     * focus chain for an application is the one define by the order in
2351     * which the widgets where added in code. One will cycle through
2352     * top level widgets, and, for each one containg sub-objects, cycle
2353     * through them all, before returning to the level
2354     * above. Elementary also allows one to set @b custom focus chains
2355     * for their applications.
2356     *
2357     * Besides the focused decoration a widget may exhibit, when it
2358     * gets focus, Elementary has a @b global focus highlight object
2359     * that can be enabled for a window. If one chooses to do so, this
2360     * extra highlight effect will surround the current focused object,
2361     * too.
2362     *
2363     * @note Some Elementary widgets are @b unfocusable, after
2364     * creation, by their very nature: they are not meant to be
2365     * interacted with input events, but are there just for visual
2366     * purposes.
2367     *
2368     * @ref general_functions_example_page "This" example contemplates
2369     * some of these functions.
2370     */
2371
2372    /**
2373     * Get the enable status of the focus highlight
2374     *
2375     * This gets whether the highlight on focused objects is enabled or not
2376     * @ingroup Focus
2377     */
2378    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2379
2380    /**
2381     * Set the enable status of the focus highlight
2382     *
2383     * Set whether to show or not the highlight on focused objects
2384     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2385     * @ingroup Focus
2386     */
2387    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2388
2389    /**
2390     * Get the enable status of the highlight animation
2391     *
2392     * Get whether the focus highlight, if enabled, will animate its switch from
2393     * one object to the next
2394     * @ingroup Focus
2395     */
2396    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2397
2398    /**
2399     * Set the enable status of the highlight animation
2400     *
2401     * Set whether the focus highlight, if enabled, will animate its switch from
2402     * one object to the next
2403     * @param animate Enable animation if EINA_TRUE, disable otherwise
2404     * @ingroup Focus
2405     */
2406    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2407
2408    /**
2409     * Get the whether an Elementary object has the focus or not.
2410     *
2411     * @param obj The Elementary object to get the information from
2412     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2413     *            not (and on errors).
2414     *
2415     * @see elm_object_focus_set()
2416     *
2417     * @ingroup Focus
2418     */
2419    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2420
2421    /**
2422     * Set/unset focus to a given Elementary object.
2423     *
2424     * @param obj The Elementary object to operate on.
2425     * @param enable @c EINA_TRUE Set focus to a given object,
2426     *               @c EINA_FALSE Unset focus to a given object.
2427     *
2428     * @note When you set focus to this object, if it can handle focus, will
2429     * take the focus away from the one who had it previously and will, for
2430     * now on, be the one receiving input events. Unsetting focus will remove
2431     * the focus from @p obj, passing it back to the previous element in the
2432     * focus chain list.
2433     *
2434     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2435     *
2436     * @ingroup Focus
2437     */
2438    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2439
2440    /**
2441     * Make a given Elementary object the focused one.
2442     *
2443     * @param obj The Elementary object to make focused.
2444     *
2445     * @note This object, if it can handle focus, will take the focus
2446     * away from the one who had it previously and will, for now on, be
2447     * the one receiving input events.
2448     *
2449     * @see elm_object_focus_get()
2450     *
2451     * @ingroup Focus
2452     */
2453    EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2454
2455    /**
2456     * Remove the focus from an Elementary object
2457     *
2458     * @param obj The Elementary to take focus from
2459     *
2460     * This removes the focus from @p obj, passing it back to the
2461     * previous element in the focus chain list.
2462     *
2463     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2464     *
2465     * @ingroup Focus
2466     */
2467    EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2468
2469    /**
2470     * Set the ability for an Element object to be focused
2471     *
2472     * @param obj The Elementary object to operate on
2473     * @param enable @c EINA_TRUE if the object can be focused, @c
2474     *        EINA_FALSE if not (and on errors)
2475     *
2476     * This sets whether the object @p obj is able to take focus or
2477     * not. Unfocusable objects do nothing when programmatically
2478     * focused, being the nearest focusable parent object the one
2479     * really getting focus. Also, when they receive mouse input, they
2480     * will get the event, but not take away the focus from where it
2481     * was previously.
2482     *
2483     * @ingroup Focus
2484     */
2485    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2486
2487    /**
2488     * Get whether an Elementary object is focusable or not
2489     *
2490     * @param obj The Elementary object to operate on
2491     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2492     *             EINA_FALSE if not (and on errors)
2493     *
2494     * @note Objects which are meant to be interacted with by input
2495     * events are created able to be focused, by default. All the
2496     * others are not.
2497     *
2498     * @ingroup Focus
2499     */
2500    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2501
2502    /**
2503     * Set custom focus chain.
2504     *
2505     * This function overwrites any previous custom focus chain within
2506     * the list of objects. The previous list will be deleted and this list
2507     * will be managed by elementary. After it is set, don't modify it.
2508     *
2509     * @note On focus cycle, only will be evaluated children of this container.
2510     *
2511     * @param obj The container object
2512     * @param objs Chain of objects to pass focus
2513     * @ingroup Focus
2514     */
2515    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2516
2517    /**
2518     * Unset a custom focus chain on a given Elementary widget
2519     *
2520     * @param obj The container object to remove focus chain from
2521     *
2522     * Any focus chain previously set on @p obj (for its child objects)
2523     * is removed entirely after this call.
2524     *
2525     * @ingroup Focus
2526     */
2527    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2528
2529    /**
2530     * Get custom focus chain
2531     *
2532     * @param obj The container object
2533     * @ingroup Focus
2534     */
2535    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2536
2537    /**
2538     * Append object to custom focus chain.
2539     *
2540     * @note If relative_child equal to NULL or not in custom chain, the object
2541     * will be added in end.
2542     *
2543     * @note On focus cycle, only will be evaluated children of this container.
2544     *
2545     * @param obj The container object
2546     * @param child The child to be added in custom chain
2547     * @param relative_child The relative object to position the child
2548     * @ingroup Focus
2549     */
2550    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2551
2552    /**
2553     * Prepend object to custom focus chain.
2554     *
2555     * @note If relative_child equal to NULL or not in custom chain, the object
2556     * will be added in begin.
2557     *
2558     * @note On focus cycle, only will be evaluated children of this container.
2559     *
2560     * @param obj The container object
2561     * @param child The child to be added in custom chain
2562     * @param relative_child The relative object to position the child
2563     * @ingroup Focus
2564     */
2565    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2566
2567    /**
2568     * Give focus to next object in object tree.
2569     *
2570     * Give focus to next object in focus chain of one object sub-tree.
2571     * If the last object of chain already have focus, the focus will go to the
2572     * first object of chain.
2573     *
2574     * @param obj The object root of sub-tree
2575     * @param dir Direction to cycle the focus
2576     *
2577     * @ingroup Focus
2578     */
2579    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2580
2581    /**
2582     * Give focus to near object in one direction.
2583     *
2584     * Give focus to near object in direction of one object.
2585     * If none focusable object in given direction, the focus will not change.
2586     *
2587     * @param obj The reference object
2588     * @param x Horizontal component of direction to focus
2589     * @param y Vertical component of direction to focus
2590     *
2591     * @ingroup Focus
2592     */
2593    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2594
2595    /**
2596     * Make the elementary object and its children to be unfocusable
2597     * (or focusable).
2598     *
2599     * @param obj The Elementary object to operate on
2600     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2601     *        @c EINA_FALSE for focusable.
2602     *
2603     * This sets whether the object @p obj and its children objects
2604     * are able to take focus or not. If the tree is set as unfocusable,
2605     * newest focused object which is not in this tree will get focus.
2606     * This API can be helpful for an object to be deleted.
2607     * When an object will be deleted soon, it and its children may not
2608     * want to get focus (by focus reverting or by other focus controls).
2609     * Then, just use this API before deleting.
2610     *
2611     * @see elm_object_tree_unfocusable_get()
2612     *
2613     * @ingroup Focus
2614     */
2615    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2616
2617    /**
2618     * Get whether an Elementary object and its children are unfocusable or not.
2619     *
2620     * @param obj The Elementary object to get the information from
2621     * @return @c EINA_TRUE, if the tree is unfocussable,
2622     *         @c EINA_FALSE if not (and on errors).
2623     *
2624     * @see elm_object_tree_unfocusable_set()
2625     *
2626     * @ingroup Focus
2627     */
2628    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2629
2630    /**
2631     * @defgroup Scrolling Scrolling
2632     *
2633     * These are functions setting how scrollable views in Elementary
2634     * widgets should behave on user interaction.
2635     *
2636     * @{
2637     */
2638
2639    /**
2640     * Get whether scrollers should bounce when they reach their
2641     * viewport's edge during a scroll.
2642     *
2643     * @return the thumb scroll bouncing state
2644     *
2645     * This is the default behavior for touch screens, in general.
2646     * @ingroup Scrolling
2647     */
2648    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2649
2650    /**
2651     * Set whether scrollers should bounce when they reach their
2652     * viewport's edge during a scroll.
2653     *
2654     * @param enabled the thumb scroll bouncing state
2655     *
2656     * @see elm_thumbscroll_bounce_enabled_get()
2657     * @ingroup Scrolling
2658     */
2659    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2660
2661    /**
2662     * Set whether scrollers should bounce when they reach their
2663     * viewport's edge during a scroll, for all Elementary application
2664     * windows.
2665     *
2666     * @param enabled the thumb scroll bouncing state
2667     *
2668     * @see elm_thumbscroll_bounce_enabled_get()
2669     * @ingroup Scrolling
2670     */
2671    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2672
2673    /**
2674     * Get the amount of inertia a scroller will impose at bounce
2675     * animations.
2676     *
2677     * @return the thumb scroll bounce friction
2678     *
2679     * @ingroup Scrolling
2680     */
2681    EAPI double           elm_scroll_bounce_friction_get(void);
2682
2683    /**
2684     * Set the amount of inertia a scroller will impose at bounce
2685     * animations.
2686     *
2687     * @param friction the thumb scroll bounce friction
2688     *
2689     * @see elm_thumbscroll_bounce_friction_get()
2690     * @ingroup Scrolling
2691     */
2692    EAPI void             elm_scroll_bounce_friction_set(double friction);
2693
2694    /**
2695     * Set the amount of inertia a scroller will impose at bounce
2696     * animations, for all Elementary application windows.
2697     *
2698     * @param friction the thumb scroll bounce friction
2699     *
2700     * @see elm_thumbscroll_bounce_friction_get()
2701     * @ingroup Scrolling
2702     */
2703    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2704
2705    /**
2706     * Get the amount of inertia a <b>paged</b> scroller will impose at
2707     * page fitting animations.
2708     *
2709     * @return the page scroll friction
2710     *
2711     * @ingroup Scrolling
2712     */
2713    EAPI double           elm_scroll_page_scroll_friction_get(void);
2714
2715    /**
2716     * Set the amount of inertia a <b>paged</b> scroller will impose at
2717     * page fitting animations.
2718     *
2719     * @param friction the page scroll friction
2720     *
2721     * @see elm_thumbscroll_page_scroll_friction_get()
2722     * @ingroup Scrolling
2723     */
2724    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2725
2726    /**
2727     * Set the amount of inertia a <b>paged</b> scroller will impose at
2728     * page fitting animations, for all Elementary application windows.
2729     *
2730     * @param friction the page scroll friction
2731     *
2732     * @see elm_thumbscroll_page_scroll_friction_get()
2733     * @ingroup Scrolling
2734     */
2735    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2736
2737    /**
2738     * Get the amount of inertia a scroller will impose at region bring
2739     * animations.
2740     *
2741     * @return the bring in scroll friction
2742     *
2743     * @ingroup Scrolling
2744     */
2745    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2746
2747    /**
2748     * Set the amount of inertia a scroller will impose at region bring
2749     * animations.
2750     *
2751     * @param friction the bring in scroll friction
2752     *
2753     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2754     * @ingroup Scrolling
2755     */
2756    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2757
2758    /**
2759     * Set the amount of inertia a scroller will impose at region bring
2760     * animations, for all Elementary application windows.
2761     *
2762     * @param friction the bring in scroll friction
2763     *
2764     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2765     * @ingroup Scrolling
2766     */
2767    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2768
2769    /**
2770     * Get the amount of inertia scrollers will impose at animations
2771     * triggered by Elementary widgets' zooming API.
2772     *
2773     * @return the zoom friction
2774     *
2775     * @ingroup Scrolling
2776     */
2777    EAPI double           elm_scroll_zoom_friction_get(void);
2778
2779    /**
2780     * Set the amount of inertia scrollers will impose at animations
2781     * triggered by Elementary widgets' zooming API.
2782     *
2783     * @param friction the zoom friction
2784     *
2785     * @see elm_thumbscroll_zoom_friction_get()
2786     * @ingroup Scrolling
2787     */
2788    EAPI void             elm_scroll_zoom_friction_set(double friction);
2789
2790    /**
2791     * Set the amount of inertia scrollers will impose at animations
2792     * triggered by Elementary widgets' zooming API, for all Elementary
2793     * application windows.
2794     *
2795     * @param friction the zoom friction
2796     *
2797     * @see elm_thumbscroll_zoom_friction_get()
2798     * @ingroup Scrolling
2799     */
2800    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2801
2802    /**
2803     * Get whether scrollers should be draggable from any point in their
2804     * views.
2805     *
2806     * @return the thumb scroll state
2807     *
2808     * @note This is the default behavior for touch screens, in general.
2809     * @note All other functions namespaced with "thumbscroll" will only
2810     *       have effect if this mode is enabled.
2811     *
2812     * @ingroup Scrolling
2813     */
2814    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2815
2816    /**
2817     * Set whether scrollers should be draggable from any point in their
2818     * views.
2819     *
2820     * @param enabled the thumb scroll state
2821     *
2822     * @see elm_thumbscroll_enabled_get()
2823     * @ingroup Scrolling
2824     */
2825    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2826
2827    /**
2828     * Set whether scrollers should be draggable from any point in their
2829     * views, for all Elementary application windows.
2830     *
2831     * @param enabled the thumb scroll state
2832     *
2833     * @see elm_thumbscroll_enabled_get()
2834     * @ingroup Scrolling
2835     */
2836    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2837
2838    /**
2839     * Get the number of pixels one should travel while dragging a
2840     * scroller's view to actually trigger scrolling.
2841     *
2842     * @return the thumb scroll threshould
2843     *
2844     * One would use higher values for touch screens, in general, because
2845     * of their inherent imprecision.
2846     * @ingroup Scrolling
2847     */
2848    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2849
2850    /**
2851     * Set the number of pixels one should travel while dragging a
2852     * scroller's view to actually trigger scrolling.
2853     *
2854     * @param threshold the thumb scroll threshould
2855     *
2856     * @see elm_thumbscroll_threshould_get()
2857     * @ingroup Scrolling
2858     */
2859    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2860
2861    /**
2862     * Set the number of pixels one should travel while dragging a
2863     * scroller's view to actually trigger scrolling, for all Elementary
2864     * application windows.
2865     *
2866     * @param threshold the thumb scroll threshould
2867     *
2868     * @see elm_thumbscroll_threshould_get()
2869     * @ingroup Scrolling
2870     */
2871    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2872
2873    /**
2874     * Get the minimum speed of mouse cursor movement which will trigger
2875     * list self scrolling animation after a mouse up event
2876     * (pixels/second).
2877     *
2878     * @return the thumb scroll momentum threshould
2879     *
2880     * @ingroup Scrolling
2881     */
2882    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2883
2884    /**
2885     * Set the minimum speed of mouse cursor movement which will trigger
2886     * list self scrolling animation after a mouse up event
2887     * (pixels/second).
2888     *
2889     * @param threshold the thumb scroll momentum threshould
2890     *
2891     * @see elm_thumbscroll_momentum_threshould_get()
2892     * @ingroup Scrolling
2893     */
2894    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2895
2896    /**
2897     * Set the minimum speed of mouse cursor movement which will trigger
2898     * list self scrolling animation after a mouse up event
2899     * (pixels/second), for all Elementary application windows.
2900     *
2901     * @param threshold the thumb scroll momentum threshould
2902     *
2903     * @see elm_thumbscroll_momentum_threshould_get()
2904     * @ingroup Scrolling
2905     */
2906    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2907
2908    /**
2909     * Get the amount of inertia a scroller will impose at self scrolling
2910     * animations.
2911     *
2912     * @return the thumb scroll friction
2913     *
2914     * @ingroup Scrolling
2915     */
2916    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2917
2918    /**
2919     * Set the amount of inertia a scroller will impose at self scrolling
2920     * animations.
2921     *
2922     * @param friction the thumb scroll friction
2923     *
2924     * @see elm_thumbscroll_friction_get()
2925     * @ingroup Scrolling
2926     */
2927    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2928
2929    /**
2930     * Set the amount of inertia a scroller will impose at self scrolling
2931     * animations, for all Elementary application windows.
2932     *
2933     * @param friction the thumb scroll friction
2934     *
2935     * @see elm_thumbscroll_friction_get()
2936     * @ingroup Scrolling
2937     */
2938    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2939
2940    /**
2941     * Get the amount of lag between your actual mouse cursor dragging
2942     * movement and a scroller's view movement itself, while pushing it
2943     * into bounce state manually.
2944     *
2945     * @return the thumb scroll border friction
2946     *
2947     * @ingroup Scrolling
2948     */
2949    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2950
2951    /**
2952     * Set the amount of lag between your actual mouse cursor dragging
2953     * movement and a scroller's view movement itself, while pushing it
2954     * into bounce state manually.
2955     *
2956     * @param friction the thumb scroll border friction. @c 0.0 for
2957     *        perfect synchrony between two movements, @c 1.0 for maximum
2958     *        lag.
2959     *
2960     * @see elm_thumbscroll_border_friction_get()
2961     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2962     *
2963     * @ingroup Scrolling
2964     */
2965    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2966
2967    /**
2968     * Set the amount of lag between your actual mouse cursor dragging
2969     * movement and a scroller's view movement itself, while pushing it
2970     * into bounce state manually, for all Elementary application windows.
2971     *
2972     * @param friction the thumb scroll border friction. @c 0.0 for
2973     *        perfect synchrony between two movements, @c 1.0 for maximum
2974     *        lag.
2975     *
2976     * @see elm_thumbscroll_border_friction_get()
2977     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2978     *
2979     * @ingroup Scrolling
2980     */
2981    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2982
2983    /**
2984     * Get the sensitivity amount which is be multiplied by the length of
2985     * mouse dragging.
2986     *
2987     * @return the thumb scroll sensitivity friction
2988     *
2989     * @ingroup Scrolling
2990     */
2991    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
2992
2993    /**
2994     * Set the sensitivity amount which is be multiplied by the length of
2995     * mouse dragging.
2996     *
2997     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2998     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2999     *        is proper.
3000     *
3001     * @see elm_thumbscroll_sensitivity_friction_get()
3002     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3003     *
3004     * @ingroup Scrolling
3005     */
3006    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3007
3008    /**
3009     * Set the sensitivity amount which is be multiplied by the length of
3010     * mouse dragging, for all Elementary application windows.
3011     *
3012     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3013     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3014     *        is proper.
3015     *
3016     * @see elm_thumbscroll_sensitivity_friction_get()
3017     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3018     *
3019     * @ingroup Scrolling
3020     */
3021    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3022
3023    /**
3024     * @}
3025     */
3026
3027    /**
3028     * @defgroup Scrollhints Scrollhints
3029     *
3030     * Objects when inside a scroller can scroll, but this may not always be
3031     * desirable in certain situations. This allows an object to hint to itself
3032     * and parents to "not scroll" in one of 2 ways. If any child object of a
3033     * scroller has pushed a scroll freeze or hold then it affects all parent
3034     * scrollers until all children have released them.
3035     *
3036     * 1. To hold on scrolling. This means just flicking and dragging may no
3037     * longer scroll, but pressing/dragging near an edge of the scroller will
3038     * still scroll. This is automatically used by the entry object when
3039     * selecting text.
3040     *
3041     * 2. To totally freeze scrolling. This means it stops. until
3042     * popped/released.
3043     *
3044     * @{
3045     */
3046
3047    /**
3048     * Push the scroll hold by 1
3049     *
3050     * This increments the scroll hold count by one. If it is more than 0 it will
3051     * take effect on the parents of the indicated object.
3052     *
3053     * @param obj The object
3054     * @ingroup Scrollhints
3055     */
3056    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3057
3058    /**
3059     * Pop the scroll hold by 1
3060     *
3061     * This decrements the scroll hold count by one. If it is more than 0 it will
3062     * take effect on the parents of the indicated object.
3063     *
3064     * @param obj The object
3065     * @ingroup Scrollhints
3066     */
3067    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3068
3069    /**
3070     * Push the scroll freeze by 1
3071     *
3072     * This increments the scroll freeze count by one. If it is more
3073     * than 0 it will take effect on the parents of the indicated
3074     * object.
3075     *
3076     * @param obj The object
3077     * @ingroup Scrollhints
3078     */
3079    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3080
3081    /**
3082     * Pop the scroll freeze by 1
3083     *
3084     * This decrements the scroll freeze count by one. If it is more
3085     * than 0 it will take effect on the parents of the indicated
3086     * object.
3087     *
3088     * @param obj The object
3089     * @ingroup Scrollhints
3090     */
3091    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3092
3093    /**
3094     * Lock the scrolling of the given widget (and thus all parents)
3095     *
3096     * This locks the given object from scrolling in the X axis (and implicitly
3097     * also locks all parent scrollers too from doing the same).
3098     *
3099     * @param obj The object
3100     * @param lock The lock state (1 == locked, 0 == unlocked)
3101     * @ingroup Scrollhints
3102     */
3103    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3104
3105    /**
3106     * Lock the scrolling of the given widget (and thus all parents)
3107     *
3108     * This locks the given object from scrolling in the Y axis (and implicitly
3109     * also locks all parent scrollers too from doing the same).
3110     *
3111     * @param obj The object
3112     * @param lock The lock state (1 == locked, 0 == unlocked)
3113     * @ingroup Scrollhints
3114     */
3115    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3116
3117    /**
3118     * Get the scrolling lock of the given widget
3119     *
3120     * This gets the lock for X axis scrolling.
3121     *
3122     * @param obj The object
3123     * @ingroup Scrollhints
3124     */
3125    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3126
3127    /**
3128     * Get the scrolling lock of the given widget
3129     *
3130     * This gets the lock for X axis scrolling.
3131     *
3132     * @param obj The object
3133     * @ingroup Scrollhints
3134     */
3135    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3136
3137    /**
3138     * @}
3139     */
3140
3141    /**
3142     * Send a signal to the widget edje object.
3143     *
3144     * This function sends a signal to the edje object of the obj. An
3145     * edje program can respond to a signal by specifying matching
3146     * 'signal' and 'source' fields.
3147     *
3148     * @param obj The object
3149     * @param emission The signal's name.
3150     * @param source The signal's source.
3151     * @ingroup General
3152     */
3153    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3154
3155    /**
3156     * Add a callback for a signal emitted by widget edje object.
3157     *
3158     * This function connects a callback function to a signal emitted by the
3159     * edje object of the obj.
3160     * Globs can occur in either the emission or source name.
3161     *
3162     * @param obj The object
3163     * @param emission The signal's name.
3164     * @param source The signal's source.
3165     * @param func The callback function to be executed when the signal is
3166     * emitted.
3167     * @param data A pointer to data to pass in to the callback function.
3168     * @ingroup General
3169     */
3170    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);
3171
3172    /**
3173     * Remove a signal-triggered callback from a widget edje object.
3174     *
3175     * This function removes a callback, previoulsy attached to a
3176     * signal emitted by the edje object of the obj.  The parameters
3177     * emission, source and func must match exactly those passed to a
3178     * previous call to elm_object_signal_callback_add(). The data
3179     * pointer that was passed to this call will be returned.
3180     *
3181     * @param obj The object
3182     * @param emission The signal's name.
3183     * @param source The signal's source.
3184     * @param func The callback function to be executed when the signal is
3185     * emitted.
3186     * @return The data pointer
3187     * @ingroup General
3188     */
3189    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);
3190
3191    /**
3192     * Add a callback for input events (key up, key down, mouse wheel)
3193     * on a given Elementary widget
3194     *
3195     * @param obj The widget to add an event callback on
3196     * @param func The callback function to be executed when the event
3197     * happens
3198     * @param data Data to pass in to @p func
3199     *
3200     * Every widget in an Elementary interface set to receive focus,
3201     * with elm_object_focus_allow_set(), will propagate @b all of its
3202     * key up, key down and mouse wheel input events up to its parent
3203     * object, and so on. All of the focusable ones in this chain which
3204     * had an event callback set, with this call, will be able to treat
3205     * those events. There are two ways of making the propagation of
3206     * these event upwards in the tree of widgets to @b cease:
3207     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3208     *   the event was @b not processed, so the propagation will go on.
3209     * - The @c event_info pointer passed to @p func will contain the
3210     *   event's structure and, if you OR its @c event_flags inner
3211     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3212     *   one has already handled it, thus killing the event's
3213     *   propagation, too.
3214     *
3215     * @note Your event callback will be issued on those events taking
3216     * place only if no other child widget of @obj has consumed the
3217     * event already.
3218     *
3219     * @note Not to be confused with @c
3220     * evas_object_event_callback_add(), which will add event callbacks
3221     * per type on general Evas objects (no event propagation
3222     * infrastructure taken in account).
3223     *
3224     * @note Not to be confused with @c
3225     * elm_object_signal_callback_add(), which will add callbacks to @b
3226     * signals coming from a widget's theme, not input events.
3227     *
3228     * @note Not to be confused with @c
3229     * edje_object_signal_callback_add(), which does the same as
3230     * elm_object_signal_callback_add(), but directly on an Edje
3231     * object.
3232     *
3233     * @note Not to be confused with @c
3234     * evas_object_smart_callback_add(), which adds callbacks to smart
3235     * objects' <b>smart events</b>, and not input events.
3236     *
3237     * @see elm_object_event_callback_del()
3238     *
3239     * @ingroup General
3240     */
3241    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3242
3243    /**
3244     * Remove an event callback from a widget.
3245     *
3246     * This function removes a callback, previoulsy attached to event emission
3247     * by the @p obj.
3248     * The parameters func and data must match exactly those passed to
3249     * a previous call to elm_object_event_callback_add(). The data pointer that
3250     * was passed to this call will be returned.
3251     *
3252     * @param obj The object
3253     * @param func The callback function to be executed when the event is
3254     * emitted.
3255     * @param data Data to pass in to the callback function.
3256     * @return The data pointer
3257     * @ingroup General
3258     */
3259    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3260
3261    /**
3262     * Adjust size of an element for finger usage.
3263     *
3264     * @param times_w How many fingers should fit horizontally
3265     * @param w Pointer to the width size to adjust
3266     * @param times_h How many fingers should fit vertically
3267     * @param h Pointer to the height size to adjust
3268     *
3269     * This takes width and height sizes (in pixels) as input and a
3270     * size multiple (which is how many fingers you want to place
3271     * within the area, being "finger" the size set by
3272     * elm_finger_size_set()), and adjusts the size to be large enough
3273     * to accommodate the resulting size -- if it doesn't already
3274     * accommodate it. On return the @p w and @p h sizes pointed to by
3275     * these parameters will be modified, on those conditions.
3276     *
3277     * @note This is kind of a low level Elementary call, most useful
3278     * on size evaluation times for widgets. An external user wouldn't
3279     * be calling, most of the time.
3280     *
3281     * @ingroup Fingers
3282     */
3283    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3284
3285    /**
3286     * Get the duration for occuring long press event.
3287     *
3288     * @return Timeout for long press event
3289     * @ingroup Longpress
3290     */
3291    EAPI double           elm_longpress_timeout_get(void);
3292
3293    /**
3294     * Set the duration for occuring long press event.
3295     *
3296     * @param lonpress_timeout Timeout for long press event
3297     * @ingroup Longpress
3298     */
3299    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3300
3301    /**
3302     * @defgroup Debug Debug
3303     * don't use it unless you are sure
3304     *
3305     * @{
3306     */
3307
3308    /**
3309     * Print Tree object hierarchy in stdout
3310     *
3311     * @param obj The root object
3312     * @ingroup Debug
3313     */
3314    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3315    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3316
3317    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3318    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3319    /**
3320     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3321     *
3322     * @param obj The root object
3323     * @param file The path of output file
3324     * @ingroup Debug
3325     */
3326    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3327
3328    /**
3329     * @}
3330     */
3331
3332    /**
3333     * @defgroup Theme Theme
3334     *
3335     * Elementary uses Edje to theme its widgets, naturally. But for the most
3336     * part this is hidden behind a simpler interface that lets the user set
3337     * extensions and choose the style of widgets in a much easier way.
3338     *
3339     * Instead of thinking in terms of paths to Edje files and their groups
3340     * each time you want to change the appearance of a widget, Elementary
3341     * works so you can add any theme file with extensions or replace the
3342     * main theme at one point in the application, and then just set the style
3343     * of widgets with elm_object_style_set() and related functions. Elementary
3344     * will then look in its list of themes for a matching group and apply it,
3345     * and when the theme changes midway through the application, all widgets
3346     * will be updated accordingly.
3347     *
3348     * There are three concepts you need to know to understand how Elementary
3349     * theming works: default theme, extensions and overlays.
3350     *
3351     * Default theme, obviously enough, is the one that provides the default
3352     * look of all widgets. End users can change the theme used by Elementary
3353     * by setting the @c ELM_THEME environment variable before running an
3354     * application, or globally for all programs using the @c elementary_config
3355     * utility. Applications can change the default theme using elm_theme_set(),
3356     * but this can go against the user wishes, so it's not an adviced practice.
3357     *
3358     * Ideally, applications should find everything they need in the already
3359     * provided theme, but there may be occasions when that's not enough and
3360     * custom styles are required to correctly express the idea. For this
3361     * cases, Elementary has extensions.
3362     *
3363     * Extensions allow the application developer to write styles of its own
3364     * to apply to some widgets. This requires knowledge of how each widget
3365     * is themed, as extensions will always replace the entire group used by
3366     * the widget, so important signals and parts need to be there for the
3367     * object to behave properly (see documentation of Edje for details).
3368     * Once the theme for the extension is done, the application needs to add
3369     * it to the list of themes Elementary will look into, using
3370     * elm_theme_extension_add(), and set the style of the desired widgets as
3371     * he would normally with elm_object_style_set().
3372     *
3373     * Overlays, on the other hand, can replace the look of all widgets by
3374     * overriding the default style. Like extensions, it's up to the application
3375     * developer to write the theme for the widgets it wants, the difference
3376     * being that when looking for the theme, Elementary will check first the
3377     * list of overlays, then the set theme and lastly the list of extensions,
3378     * so with overlays it's possible to replace the default view and every
3379     * widget will be affected. This is very much alike to setting the whole
3380     * theme for the application and will probably clash with the end user
3381     * options, not to mention the risk of ending up with not matching styles
3382     * across the program. Unless there's a very special reason to use them,
3383     * overlays should be avoided for the resons exposed before.
3384     *
3385     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3386     * keeps one default internally and every function that receives one of
3387     * these can be called with NULL to refer to this default (except for
3388     * elm_theme_free()). It's possible to create a new instance of a
3389     * ::Elm_Theme to set other theme for a specific widget (and all of its
3390     * children), but this is as discouraged, if not even more so, than using
3391     * overlays. Don't use this unless you really know what you are doing.
3392     *
3393     * But to be less negative about things, you can look at the following
3394     * examples:
3395     * @li @ref theme_example_01 "Using extensions"
3396     * @li @ref theme_example_02 "Using overlays"
3397     *
3398     * @{
3399     */
3400    /**
3401     * @typedef Elm_Theme
3402     *
3403     * Opaque handler for the list of themes Elementary looks for when
3404     * rendering widgets.
3405     *
3406     * Stay out of this unless you really know what you are doing. For most
3407     * cases, sticking to the default is all a developer needs.
3408     */
3409    typedef struct _Elm_Theme Elm_Theme;
3410
3411    /**
3412     * Create a new specific theme
3413     *
3414     * This creates an empty specific theme that only uses the default theme. A
3415     * specific theme has its own private set of extensions and overlays too
3416     * (which are empty by default). Specific themes do not fall back to themes
3417     * of parent objects. They are not intended for this use. Use styles, overlays
3418     * and extensions when needed, but avoid specific themes unless there is no
3419     * other way (example: you want to have a preview of a new theme you are
3420     * selecting in a "theme selector" window. The preview is inside a scroller
3421     * and should display what the theme you selected will look like, but not
3422     * actually apply it yet. The child of the scroller will have a specific
3423     * theme set to show this preview before the user decides to apply it to all
3424     * applications).
3425     */
3426    EAPI Elm_Theme       *elm_theme_new(void);
3427    /**
3428     * Free a specific theme
3429     *
3430     * @param th The theme to free
3431     *
3432     * This frees a theme created with elm_theme_new().
3433     */
3434    EAPI void             elm_theme_free(Elm_Theme *th);
3435    /**
3436     * Copy the theme fom the source to the destination theme
3437     *
3438     * @param th The source theme to copy from
3439     * @param thdst The destination theme to copy data to
3440     *
3441     * This makes a one-time static copy of all the theme config, extensions
3442     * and overlays from @p th to @p thdst. If @p th references a theme, then
3443     * @p thdst is also set to reference it, with all the theme settings,
3444     * overlays and extensions that @p th had.
3445     */
3446    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3447    /**
3448     * Tell the source theme to reference the ref theme
3449     *
3450     * @param th The theme that will do the referencing
3451     * @param thref The theme that is the reference source
3452     *
3453     * This clears @p th to be empty and then sets it to refer to @p thref
3454     * so @p th acts as an override to @p thref, but where its overrides
3455     * don't apply, it will fall through to @p thref for configuration.
3456     */
3457    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3458    /**
3459     * Return the theme referred to
3460     *
3461     * @param th The theme to get the reference from
3462     * @return The referenced theme handle
3463     *
3464     * This gets the theme set as the reference theme by elm_theme_ref_set().
3465     * If no theme is set as a reference, NULL is returned.
3466     */
3467    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3468    /**
3469     * Return the default theme
3470     *
3471     * @return The default theme handle
3472     *
3473     * This returns the internal default theme setup handle that all widgets
3474     * use implicitly unless a specific theme is set. This is also often use
3475     * as a shorthand of NULL.
3476     */
3477    EAPI Elm_Theme       *elm_theme_default_get(void);
3478    /**
3479     * Prepends a theme overlay to the list of overlays
3480     *
3481     * @param th The theme to add to, or if NULL, the default theme
3482     * @param item The Edje file path to be used
3483     *
3484     * Use this if your application needs to provide some custom overlay theme
3485     * (An Edje file that replaces some default styles of widgets) where adding
3486     * new styles, or changing system theme configuration is not possible. Do
3487     * NOT use this instead of a proper system theme configuration. Use proper
3488     * configuration files, profiles, environment variables etc. to set a theme
3489     * so that the theme can be altered by simple confiugration by a user. Using
3490     * this call to achieve that effect is abusing the API and will create lots
3491     * of trouble.
3492     *
3493     * @see elm_theme_extension_add()
3494     */
3495    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3496    /**
3497     * Delete a theme overlay from the list of overlays
3498     *
3499     * @param th The theme to delete from, or if NULL, the default theme
3500     * @param item The name of the theme overlay
3501     *
3502     * @see elm_theme_overlay_add()
3503     */
3504    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3505    /**
3506     * Appends a theme extension to the list of extensions.
3507     *
3508     * @param th The theme to add to, or if NULL, the default theme
3509     * @param item The Edje file path to be used
3510     *
3511     * This is intended when an application needs more styles of widgets or new
3512     * widget themes that the default does not provide (or may not provide). The
3513     * application has "extended" usage by coming up with new custom style names
3514     * for widgets for specific uses, but as these are not "standard", they are
3515     * not guaranteed to be provided by a default theme. This means the
3516     * application is required to provide these extra elements itself in specific
3517     * Edje files. This call adds one of those Edje files to the theme search
3518     * path to be search after the default theme. The use of this call is
3519     * encouraged when default styles do not meet the needs of the application.
3520     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3521     *
3522     * @see elm_object_style_set()
3523     */
3524    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3525    /**
3526     * Deletes a theme extension from the list of extensions.
3527     *
3528     * @param th The theme to delete from, or if NULL, the default theme
3529     * @param item The name of the theme extension
3530     *
3531     * @see elm_theme_extension_add()
3532     */
3533    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3534    /**
3535     * Set the theme search order for the given theme
3536     *
3537     * @param th The theme to set the search order, or if NULL, the default theme
3538     * @param theme Theme search string
3539     *
3540     * This sets the search string for the theme in path-notation from first
3541     * theme to search, to last, delimited by the : character. Example:
3542     *
3543     * "shiny:/path/to/file.edj:default"
3544     *
3545     * See the ELM_THEME environment variable for more information.
3546     *
3547     * @see elm_theme_get()
3548     * @see elm_theme_list_get()
3549     */
3550    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3551    /**
3552     * Return the theme search order
3553     *
3554     * @param th The theme to get the search order, or if NULL, the default theme
3555     * @return The internal search order path
3556     *
3557     * This function returns a colon separated string of theme elements as
3558     * returned by elm_theme_list_get().
3559     *
3560     * @see elm_theme_set()
3561     * @see elm_theme_list_get()
3562     */
3563    EAPI const char      *elm_theme_get(Elm_Theme *th);
3564    /**
3565     * Return a list of theme elements to be used in a theme.
3566     *
3567     * @param th Theme to get the list of theme elements from.
3568     * @return The internal list of theme elements
3569     *
3570     * This returns the internal list of theme elements (will only be valid as
3571     * long as the theme is not modified by elm_theme_set() or theme is not
3572     * freed by elm_theme_free(). This is a list of strings which must not be
3573     * altered as they are also internal. If @p th is NULL, then the default
3574     * theme element list is returned.
3575     *
3576     * A theme element can consist of a full or relative path to a .edj file,
3577     * or a name, without extension, for a theme to be searched in the known
3578     * theme paths for Elemementary.
3579     *
3580     * @see elm_theme_set()
3581     * @see elm_theme_get()
3582     */
3583    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3584    /**
3585     * Return the full patrh for a theme element
3586     *
3587     * @param f The theme element name
3588     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3589     * @return The full path to the file found.
3590     *
3591     * This returns a string you should free with free() on success, NULL on
3592     * failure. This will search for the given theme element, and if it is a
3593     * full or relative path element or a simple searchable name. The returned
3594     * path is the full path to the file, if searched, and the file exists, or it
3595     * is simply the full path given in the element or a resolved path if
3596     * relative to home. The @p in_search_path boolean pointed to is set to
3597     * EINA_TRUE if the file was a searchable file andis in the search path,
3598     * and EINA_FALSE otherwise.
3599     */
3600    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3601    /**
3602     * Flush the current theme.
3603     *
3604     * @param th Theme to flush
3605     *
3606     * This flushes caches that let elementary know where to find theme elements
3607     * in the given theme. If @p th is NULL, then the default theme is flushed.
3608     * Call this function if source theme data has changed in such a way as to
3609     * make any caches Elementary kept invalid.
3610     */
3611    EAPI void             elm_theme_flush(Elm_Theme *th);
3612    /**
3613     * This flushes all themes (default and specific ones).
3614     *
3615     * This will flush all themes in the current application context, by calling
3616     * elm_theme_flush() on each of them.
3617     */
3618    EAPI void             elm_theme_full_flush(void);
3619    /**
3620     * Set the theme for all elementary using applications on the current display
3621     *
3622     * @param theme The name of the theme to use. Format same as the ELM_THEME
3623     * environment variable.
3624     */
3625    EAPI void             elm_theme_all_set(const char *theme);
3626    /**
3627     * Return a list of theme elements in the theme search path
3628     *
3629     * @return A list of strings that are the theme element names.
3630     *
3631     * This lists all available theme files in the standard Elementary search path
3632     * for theme elements, and returns them in alphabetical order as theme
3633     * element names in a list of strings. Free this with
3634     * elm_theme_name_available_list_free() when you are done with the list.
3635     */
3636    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3637    /**
3638     * Free the list returned by elm_theme_name_available_list_new()
3639     *
3640     * This frees the list of themes returned by
3641     * elm_theme_name_available_list_new(). Once freed the list should no longer
3642     * be used. a new list mys be created.
3643     */
3644    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3645    /**
3646     * Set a specific theme to be used for this object and its children
3647     *
3648     * @param obj The object to set the theme on
3649     * @param th The theme to set
3650     *
3651     * This sets a specific theme that will be used for the given object and any
3652     * child objects it has. If @p th is NULL then the theme to be used is
3653     * cleared and the object will inherit its theme from its parent (which
3654     * ultimately will use the default theme if no specific themes are set).
3655     *
3656     * Use special themes with great care as this will annoy users and make
3657     * configuration difficult. Avoid any custom themes at all if it can be
3658     * helped.
3659     */
3660    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3661    /**
3662     * Get the specific theme to be used
3663     *
3664     * @param obj The object to get the specific theme from
3665     * @return The specifc theme set.
3666     *
3667     * This will return a specific theme set, or NULL if no specific theme is
3668     * set on that object. It will not return inherited themes from parents, only
3669     * the specific theme set for that specific object. See elm_object_theme_set()
3670     * for more information.
3671     */
3672    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3673
3674    /**
3675     * Get a data item from a theme
3676     *
3677     * @param th The theme, or NULL for default theme
3678     * @param key The data key to search with
3679     * @return The data value, or NULL on failure
3680     *
3681     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3682     * It works the same way as edje_file_data_get() except that the return is stringshared.
3683     */
3684    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3685    /**
3686     * @}
3687     */
3688
3689    /* win */
3690    /** @defgroup Win Win
3691     *
3692     * @image html img/widget/win/preview-00.png
3693     * @image latex img/widget/win/preview-00.eps
3694     *
3695     * The window class of Elementary.  Contains functions to manipulate
3696     * windows. The Evas engine used to render the window contents is specified
3697     * in the system or user elementary config files (whichever is found last),
3698     * and can be overridden with the ELM_ENGINE environment variable for
3699     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3700     * compilation setup and modules actually installed at runtime) are (listed
3701     * in order of best supported and most likely to be complete and work to
3702     * lowest quality).
3703     *
3704     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3705     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3706     * rendering in X11)
3707     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3708     * exits)
3709     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3710     * rendering)
3711     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3712     * buffer)
3713     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3714     * rendering using SDL as the buffer)
3715     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3716     * GDI with software)
3717     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3718     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3719     * grayscale using dedicated 8bit software engine in X11)
3720     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3721     * X11 using 16bit software engine)
3722     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3723     * (Windows CE rendering via GDI with 16bit software renderer)
3724     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3725     * buffer with 16bit software renderer)
3726     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3727     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3728     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3729     *
3730     * All engines use a simple string to select the engine to render, EXCEPT
3731     * the "shot" engine. This actually encodes the output of the virtual
3732     * screenshot and how long to delay in the engine string. The engine string
3733     * is encoded in the following way:
3734     *
3735     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3736     *
3737     * Where options are separated by a ":" char if more than one option is
3738     * given, with delay, if provided being the first option and file the last
3739     * (order is important). The delay specifies how long to wait after the
3740     * window is shown before doing the virtual "in memory" rendering and then
3741     * save the output to the file specified by the file option (and then exit).
3742     * If no delay is given, the default is 0.5 seconds. If no file is given the
3743     * default output file is "out.png". Repeat option is for continous
3744     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3745     * fixed to "out001.png" Some examples of using the shot engine:
3746     *
3747     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3748     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3749     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3750     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3751     *   ELM_ENGINE="shot:" elementary_test
3752     *
3753     * Signals that you can add callbacks for are:
3754     *
3755     * @li "delete,request": the user requested to close the window. See
3756     * elm_win_autodel_set().
3757     * @li "focus,in": window got focus
3758     * @li "focus,out": window lost focus
3759     * @li "moved": window that holds the canvas was moved
3760     *
3761     * Examples:
3762     * @li @ref win_example_01
3763     *
3764     * @{
3765     */
3766    /**
3767     * Defines the types of window that can be created
3768     *
3769     * These are hints set on the window so that a running Window Manager knows
3770     * how the window should be handled and/or what kind of decorations it
3771     * should have.
3772     *
3773     * Currently, only the X11 backed engines use them.
3774     */
3775    typedef enum _Elm_Win_Type
3776      {
3777         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3778                          window. Almost every window will be created with this
3779                          type. */
3780         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3781         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3782                            window holding desktop icons. */
3783         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3784                         be kept on top of any other window by the Window
3785                         Manager. */
3786         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3787                            similar. */
3788         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3789         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3790                            pallete. */
3791         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3792         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3793                                  entry in a menubar is clicked. Typically used
3794                                  with elm_win_override_set(). This hint exists
3795                                  for completion only, as the EFL way of
3796                                  implementing a menu would not normally use a
3797                                  separate window for its contents. */
3798         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3799                               triggered by right-clicking an object. */
3800         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3801                            explanatory text that typically appear after the
3802                            mouse cursor hovers over an object for a while.
3803                            Typically used with elm_win_override_set() and also
3804                            not very commonly used in the EFL. */
3805         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3806                                 battery life or a new E-Mail received. */
3807         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3808                          usually used in the EFL. */
3809         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3810                        object being dragged across different windows, or even
3811                        applications. Typically used with
3812                        elm_win_override_set(). */
3813         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3814                                  buffer. No actual window is created for this
3815                                  type, instead the window and all of its
3816                                  contents will be rendered to an image buffer.
3817                                  This allows to have children window inside a
3818                                  parent one just like any other object would
3819                                  be, and do other things like applying @c
3820                                  Evas_Map effects to it. This is the only type
3821                                  of window that requires the @c parent
3822                                  parameter of elm_win_add() to be a valid @c
3823                                  Evas_Object. */
3824      } Elm_Win_Type;
3825
3826    /**
3827     * The differents layouts that can be requested for the virtual keyboard.
3828     *
3829     * When the application window is being managed by Illume, it may request
3830     * any of the following layouts for the virtual keyboard.
3831     */
3832    typedef enum _Elm_Win_Keyboard_Mode
3833      {
3834         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3835         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3836         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3837         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3838         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3839         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3840         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3841         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3842         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3843         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3844         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3845         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3846         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3847         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3848         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3849         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3850      } Elm_Win_Keyboard_Mode;
3851
3852    /**
3853     * Available commands that can be sent to the Illume manager.
3854     *
3855     * When running under an Illume session, a window may send commands to the
3856     * Illume manager to perform different actions.
3857     */
3858    typedef enum _Elm_Illume_Command
3859      {
3860         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3861                                          window */
3862         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3863                                             in the list */
3864         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3865                                          screen */
3866         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3867      } Elm_Illume_Command;
3868
3869    /**
3870     * Adds a window object. If this is the first window created, pass NULL as
3871     * @p parent.
3872     *
3873     * @param parent Parent object to add the window to, or NULL
3874     * @param name The name of the window
3875     * @param type The window type, one of #Elm_Win_Type.
3876     *
3877     * The @p parent paramter can be @c NULL for every window @p type except
3878     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3879     * which the image object will be created.
3880     *
3881     * @return The created object, or NULL on failure
3882     */
3883    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3884    /**
3885     * Adds a window object with standard setup
3886     *
3887     * @param name The name of the window
3888     * @param title The title for the window
3889     *
3890     * This creates a window like elm_win_add() but also puts in a standard
3891     * background with elm_bg_add(), as well as setting the window title to
3892     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3893     * as the parent widget.
3894     * 
3895     * @return The created object, or NULL on failure
3896     *
3897     * @see elm_win_add()
3898     */
3899    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3900    /**
3901     * Add @p subobj as a resize object of window @p obj.
3902     *
3903     *
3904     * Setting an object as a resize object of the window means that the
3905     * @p subobj child's size and position will be controlled by the window
3906     * directly. That is, the object will be resized to match the window size
3907     * and should never be moved or resized manually by the developer.
3908     *
3909     * In addition, resize objects of the window control what the minimum size
3910     * of it will be, as well as whether it can or not be resized by the user.
3911     *
3912     * For the end user to be able to resize a window by dragging the handles
3913     * or borders provided by the Window Manager, or using any other similar
3914     * mechanism, all of the resize objects in the window should have their
3915     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3916     *
3917     * @param obj The window object
3918     * @param subobj The resize object to add
3919     */
3920    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3921    /**
3922     * Delete @p subobj as a resize object of window @p obj.
3923     *
3924     * This function removes the object @p subobj from the resize objects of
3925     * the window @p obj. It will not delete the object itself, which will be
3926     * left unmanaged and should be deleted by the developer, manually handled
3927     * or set as child of some other container.
3928     *
3929     * @param obj The window object
3930     * @param subobj The resize object to add
3931     */
3932    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3933    /**
3934     * Set the title of the window
3935     *
3936     * @param obj The window object
3937     * @param title The title to set
3938     */
3939    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3940    /**
3941     * Get the title of the window
3942     *
3943     * The returned string is an internal one and should not be freed or
3944     * modified. It will also be rendered invalid if a new title is set or if
3945     * the window is destroyed.
3946     *
3947     * @param obj The window object
3948     * @return The title
3949     */
3950    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3951    /**
3952     * Set the window's autodel state.
3953     *
3954     * When closing the window in any way outside of the program control, like
3955     * pressing the X button in the titlebar or using a command from the
3956     * Window Manager, a "delete,request" signal is emitted to indicate that
3957     * this event occurred and the developer can take any action, which may
3958     * include, or not, destroying the window object.
3959     *
3960     * When the @p autodel parameter is set, the window will be automatically
3961     * destroyed when this event occurs, after the signal is emitted.
3962     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3963     * and is up to the program to do so when it's required.
3964     *
3965     * @param obj The window object
3966     * @param autodel If true, the window will automatically delete itself when
3967     * closed
3968     */
3969    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3970    /**
3971     * Get the window's autodel state.
3972     *
3973     * @param obj The window object
3974     * @return If the window will automatically delete itself when closed
3975     *
3976     * @see elm_win_autodel_set()
3977     */
3978    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3979    /**
3980     * Activate a window object.
3981     *
3982     * This function sends a request to the Window Manager to activate the
3983     * window pointed by @p obj. If honored by the WM, the window will receive
3984     * the keyboard focus.
3985     *
3986     * @note This is just a request that a Window Manager may ignore, so calling
3987     * this function does not ensure in any way that the window will be the
3988     * active one after it.
3989     *
3990     * @param obj The window object
3991     */
3992    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3993    /**
3994     * Lower a window object.
3995     *
3996     * Places the window pointed by @p obj at the bottom of the stack, so that
3997     * no other window is covered by it.
3998     *
3999     * If elm_win_override_set() is not set, the Window Manager may ignore this
4000     * request.
4001     *
4002     * @param obj The window object
4003     */
4004    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4005    /**
4006     * Raise a window object.
4007     *
4008     * Places the window pointed by @p obj at the top of the stack, so that it's
4009     * not covered by any other window.
4010     *
4011     * If elm_win_override_set() is not set, the Window Manager may ignore this
4012     * request.
4013     *
4014     * @param obj The window object
4015     */
4016    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4017    /**
4018     * Set the borderless state of a window.
4019     *
4020     * This function requests the Window Manager to not draw any decoration
4021     * around the window.
4022     *
4023     * @param obj The window object
4024     * @param borderless If true, the window is borderless
4025     */
4026    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4027    /**
4028     * Get the borderless state of a window.
4029     *
4030     * @param obj The window object
4031     * @return If true, the window is borderless
4032     */
4033    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4034    /**
4035     * Set the shaped state of a window.
4036     *
4037     * Shaped windows, when supported, will render the parts of the window that
4038     * has no content, transparent.
4039     *
4040     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4041     * background object or cover the entire window in any other way, or the
4042     * parts of the canvas that have no data will show framebuffer artifacts.
4043     *
4044     * @param obj The window object
4045     * @param shaped If true, the window is shaped
4046     *
4047     * @see elm_win_alpha_set()
4048     */
4049    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4050    /**
4051     * Get the shaped state of a window.
4052     *
4053     * @param obj The window object
4054     * @return If true, the window is shaped
4055     *
4056     * @see elm_win_shaped_set()
4057     */
4058    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4059    /**
4060     * Set the alpha channel state of a window.
4061     *
4062     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4063     * possibly making parts of the window completely or partially transparent.
4064     * This is also subject to the underlying system supporting it, like for
4065     * example, running under a compositing manager. If no compositing is
4066     * available, enabling this option will instead fallback to using shaped
4067     * windows, with elm_win_shaped_set().
4068     *
4069     * @param obj The window object
4070     * @param alpha If true, the window has an alpha channel
4071     *
4072     * @see elm_win_alpha_set()
4073     */
4074    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4075    /**
4076     * Get the transparency state of a window.
4077     *
4078     * @param obj The window object
4079     * @return If true, the window is transparent
4080     *
4081     * @see elm_win_transparent_set()
4082     */
4083    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4084    /**
4085     * Set the transparency state of a window.
4086     *
4087     * Use elm_win_alpha_set() instead.
4088     *
4089     * @param obj The window object
4090     * @param transparent If true, the window is transparent
4091     *
4092     * @see elm_win_alpha_set()
4093     */
4094    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4095    /**
4096     * Get the alpha channel state of a window.
4097     *
4098     * @param obj The window object
4099     * @return If true, the window has an alpha channel
4100     */
4101    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4102    /**
4103     * Set the override state of a window.
4104     *
4105     * A window with @p override set to EINA_TRUE will not be managed by the
4106     * Window Manager. This means that no decorations of any kind will be shown
4107     * for it, moving and resizing must be handled by the application, as well
4108     * as the window visibility.
4109     *
4110     * This should not be used for normal windows, and even for not so normal
4111     * ones, it should only be used when there's a good reason and with a lot
4112     * of care. Mishandling override windows may result situations that
4113     * disrupt the normal workflow of the end user.
4114     *
4115     * @param obj The window object
4116     * @param override If true, the window is overridden
4117     */
4118    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4119    /**
4120     * Get the override state of a window.
4121     *
4122     * @param obj The window object
4123     * @return If true, the window is overridden
4124     *
4125     * @see elm_win_override_set()
4126     */
4127    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4128    /**
4129     * Set the fullscreen state of a window.
4130     *
4131     * @param obj The window object
4132     * @param fullscreen If true, the window is fullscreen
4133     */
4134    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4135    /**
4136     * Get the fullscreen state of a window.
4137     *
4138     * @param obj The window object
4139     * @return If true, the window is fullscreen
4140     */
4141    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4142    /**
4143     * Set the maximized state of a window.
4144     *
4145     * @param obj The window object
4146     * @param maximized If true, the window is maximized
4147     */
4148    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4149    /**
4150     * Get the maximized state of a window.
4151     *
4152     * @param obj The window object
4153     * @return If true, the window is maximized
4154     */
4155    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4156    /**
4157     * Set the iconified state of a window.
4158     *
4159     * @param obj The window object
4160     * @param iconified If true, the window is iconified
4161     */
4162    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4163    /**
4164     * Get the iconified state of a window.
4165     *
4166     * @param obj The window object
4167     * @return If true, the window is iconified
4168     */
4169    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4170    /**
4171     * Set the layer of the window.
4172     *
4173     * What this means exactly will depend on the underlying engine used.
4174     *
4175     * In the case of X11 backed engines, the value in @p layer has the
4176     * following meanings:
4177     * @li < 3: The window will be placed below all others.
4178     * @li > 5: The window will be placed above all others.
4179     * @li other: The window will be placed in the default layer.
4180     *
4181     * @param obj The window object
4182     * @param layer The layer of the window
4183     */
4184    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4185    /**
4186     * Get the layer of the window.
4187     *
4188     * @param obj The window object
4189     * @return The layer of the window
4190     *
4191     * @see elm_win_layer_set()
4192     */
4193    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4194    /**
4195     * Set the rotation of the window.
4196     *
4197     * Most engines only work with multiples of 90.
4198     *
4199     * This function is used to set the orientation of the window @p obj to
4200     * match that of the screen. The window itself will be resized to adjust
4201     * to the new geometry of its contents. If you want to keep the window size,
4202     * see elm_win_rotation_with_resize_set().
4203     *
4204     * @param obj The window object
4205     * @param rotation The rotation of the window, in degrees (0-360),
4206     * counter-clockwise.
4207     */
4208    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4209    /**
4210     * Rotates the window and resizes it.
4211     *
4212     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4213     * that they fit inside the current window geometry.
4214     *
4215     * @param obj The window object
4216     * @param layer The rotation of the window in degrees (0-360),
4217     * counter-clockwise.
4218     */
4219    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4220    /**
4221     * Get the rotation of the window.
4222     *
4223     * @param obj The window object
4224     * @return The rotation of the window in degrees (0-360)
4225     *
4226     * @see elm_win_rotation_set()
4227     * @see elm_win_rotation_with_resize_set()
4228     */
4229    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4230    /**
4231     * Set the sticky state of the window.
4232     *
4233     * Hints the Window Manager that the window in @p obj should be left fixed
4234     * at its position even when the virtual desktop it's on moves or changes.
4235     *
4236     * @param obj The window object
4237     * @param sticky If true, the window's sticky state is enabled
4238     */
4239    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4240    /**
4241     * Get the sticky state of the window.
4242     *
4243     * @param obj The window object
4244     * @return If true, the window's sticky state is enabled
4245     *
4246     * @see elm_win_sticky_set()
4247     */
4248    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4249    /**
4250     * Set if this window is an illume conformant window
4251     *
4252     * @param obj The window object
4253     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4254     */
4255    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4256    /**
4257     * Get if this window is an illume conformant window
4258     *
4259     * @param obj The window object
4260     * @return A boolean if this window is illume conformant or not
4261     */
4262    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4263    /**
4264     * Set a window to be an illume quickpanel window
4265     *
4266     * By default window objects are not quickpanel windows.
4267     *
4268     * @param obj The window object
4269     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4270     */
4271    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4272    /**
4273     * Get if this window is a quickpanel or not
4274     *
4275     * @param obj The window object
4276     * @return A boolean if this window is a quickpanel or not
4277     */
4278    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4279    /**
4280     * Set the major priority of a quickpanel window
4281     *
4282     * @param obj The window object
4283     * @param priority The major priority for this quickpanel
4284     */
4285    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4286    /**
4287     * Get the major priority of a quickpanel window
4288     *
4289     * @param obj The window object
4290     * @return The major priority of this quickpanel
4291     */
4292    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4293    /**
4294     * Set the minor priority of a quickpanel window
4295     *
4296     * @param obj The window object
4297     * @param priority The minor priority for this quickpanel
4298     */
4299    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4300    /**
4301     * Get the minor priority of a quickpanel window
4302     *
4303     * @param obj The window object
4304     * @return The minor priority of this quickpanel
4305     */
4306    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4307    /**
4308     * Set which zone this quickpanel should appear in
4309     *
4310     * @param obj The window object
4311     * @param zone The requested zone for this quickpanel
4312     */
4313    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4314    /**
4315     * Get which zone this quickpanel should appear in
4316     *
4317     * @param obj The window object
4318     * @return The requested zone for this quickpanel
4319     */
4320    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4321    /**
4322     * Set the window to be skipped by keyboard focus
4323     *
4324     * This sets the window to be skipped by normal keyboard input. This means
4325     * a window manager will be asked to not focus this window as well as omit
4326     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4327     *
4328     * Call this and enable it on a window BEFORE you show it for the first time,
4329     * otherwise it may have no effect.
4330     *
4331     * Use this for windows that have only output information or might only be
4332     * interacted with by the mouse or fingers, and never for typing input.
4333     * Be careful that this may have side-effects like making the window
4334     * non-accessible in some cases unless the window is specially handled. Use
4335     * this with care.
4336     *
4337     * @param obj The window object
4338     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4339     */
4340    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4341    /**
4342     * Send a command to the windowing environment
4343     *
4344     * This is intended to work in touchscreen or small screen device
4345     * environments where there is a more simplistic window management policy in
4346     * place. This uses the window object indicated to select which part of the
4347     * environment to control (the part that this window lives in), and provides
4348     * a command and an optional parameter structure (use NULL for this if not
4349     * needed).
4350     *
4351     * @param obj The window object that lives in the environment to control
4352     * @param command The command to send
4353     * @param params Optional parameters for the command
4354     */
4355    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4356    /**
4357     * Get the inlined image object handle
4358     *
4359     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4360     * then the window is in fact an evas image object inlined in the parent
4361     * canvas. You can get this object (be careful to not manipulate it as it
4362     * is under control of elementary), and use it to do things like get pixel
4363     * data, save the image to a file, etc.
4364     *
4365     * @param obj The window object to get the inlined image from
4366     * @return The inlined image object, or NULL if none exists
4367     */
4368    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4369    /**
4370     * Set the enabled status for the focus highlight in a window
4371     *
4372     * This function will enable or disable the focus highlight only for the
4373     * given window, regardless of the global setting for it
4374     *
4375     * @param obj The window where to enable the highlight
4376     * @param enabled The enabled value for the highlight
4377     */
4378    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4379    /**
4380     * Get the enabled value of the focus highlight for this window
4381     *
4382     * @param obj The window in which to check if the focus highlight is enabled
4383     *
4384     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4385     */
4386    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4387    /**
4388     * Set the style for the focus highlight on this window
4389     *
4390     * Sets the style to use for theming the highlight of focused objects on
4391     * the given window. If @p style is NULL, the default will be used.
4392     *
4393     * @param obj The window where to set the style
4394     * @param style The style to set
4395     */
4396    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4397    /**
4398     * Get the style set for the focus highlight object
4399     *
4400     * Gets the style set for this windows highilght object, or NULL if none
4401     * is set.
4402     *
4403     * @param obj The window to retrieve the highlights style from
4404     *
4405     * @return The style set or NULL if none was. Default is used in that case.
4406     */
4407    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4408    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4409    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
4410    /*...
4411     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4412     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4413     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4414     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4415     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4416     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4417     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4418     *
4419     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4420     * (blank mouse, private mouse obj, defaultmouse)
4421     *
4422     */
4423    /**
4424     * Sets the keyboard mode of the window.
4425     *
4426     * @param obj The window object
4427     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4428     */
4429    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4430    /**
4431     * Gets the keyboard mode of the window.
4432     *
4433     * @param obj The window object
4434     * @return The mode, one of #Elm_Win_Keyboard_Mode
4435     */
4436    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4437    /**
4438     * Sets whether the window is a keyboard.
4439     *
4440     * @param obj The window object
4441     * @param is_keyboard If true, the window is a virtual keyboard
4442     */
4443    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4444    /**
4445     * Gets whether the window is a keyboard.
4446     *
4447     * @param obj The window object
4448     * @return If the window is a virtual keyboard
4449     */
4450    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4451
4452    /**
4453     * Get the screen position of a window.
4454     *
4455     * @param obj The window object
4456     * @param x The int to store the x coordinate to
4457     * @param y The int to store the y coordinate to
4458     */
4459    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4460    /**
4461     * @}
4462     */
4463
4464    /**
4465     * @defgroup Inwin Inwin
4466     *
4467     * @image html img/widget/inwin/preview-00.png
4468     * @image latex img/widget/inwin/preview-00.eps
4469     * @image html img/widget/inwin/preview-01.png
4470     * @image latex img/widget/inwin/preview-01.eps
4471     * @image html img/widget/inwin/preview-02.png
4472     * @image latex img/widget/inwin/preview-02.eps
4473     *
4474     * An inwin is a window inside a window that is useful for a quick popup.
4475     * It does not hover.
4476     *
4477     * It works by creating an object that will occupy the entire window, so it
4478     * must be created using an @ref Win "elm_win" as parent only. The inwin
4479     * object can be hidden or restacked below every other object if it's
4480     * needed to show what's behind it without destroying it. If this is done,
4481     * the elm_win_inwin_activate() function can be used to bring it back to
4482     * full visibility again.
4483     *
4484     * There are three styles available in the default theme. These are:
4485     * @li default: The inwin is sized to take over most of the window it's
4486     * placed in.
4487     * @li minimal: The size of the inwin will be the minimum necessary to show
4488     * its contents.
4489     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4490     * possible, but it's sized vertically the most it needs to fit its\
4491     * contents.
4492     *
4493     * Some examples of Inwin can be found in the following:
4494     * @li @ref inwin_example_01
4495     *
4496     * @{
4497     */
4498    /**
4499     * Adds an inwin to the current window
4500     *
4501     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4502     * Never call this function with anything other than the top-most window
4503     * as its parameter, unless you are fond of undefined behavior.
4504     *
4505     * After creating the object, the widget will set itself as resize object
4506     * for the window with elm_win_resize_object_add(), so when shown it will
4507     * appear to cover almost the entire window (how much of it depends on its
4508     * content and the style used). It must not be added into other container
4509     * objects and it needs not be moved or resized manually.
4510     *
4511     * @param parent The parent object
4512     * @return The new object or NULL if it cannot be created
4513     */
4514    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4515    /**
4516     * Activates an inwin object, ensuring its visibility
4517     *
4518     * This function will make sure that the inwin @p obj is completely visible
4519     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4520     * to the front. It also sets the keyboard focus to it, which will be passed
4521     * onto its content.
4522     *
4523     * The object's theme will also receive the signal "elm,action,show" with
4524     * source "elm".
4525     *
4526     * @param obj The inwin to activate
4527     */
4528    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4529    /**
4530     * Set the content of an inwin object.
4531     *
4532     * Once the content object is set, a previously set one will be deleted.
4533     * If you want to keep that old content object, use the
4534     * elm_win_inwin_content_unset() function.
4535     *
4536     * @param obj The inwin object
4537     * @param content The object to set as content
4538     */
4539    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4540    /**
4541     * Get the content of an inwin object.
4542     *
4543     * Return the content object which is set for this widget.
4544     *
4545     * The returned object is valid as long as the inwin is still alive and no
4546     * other content is set on it. Deleting the object will notify the inwin
4547     * about it and this one will be left empty.
4548     *
4549     * If you need to remove an inwin's content to be reused somewhere else,
4550     * see elm_win_inwin_content_unset().
4551     *
4552     * @param obj The inwin object
4553     * @return The content that is being used
4554     */
4555    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4556    /**
4557     * Unset the content of an inwin object.
4558     *
4559     * Unparent and return the content object which was set for this widget.
4560     *
4561     * @param obj The inwin object
4562     * @return The content that was being used
4563     */
4564    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4565    /**
4566     * @}
4567     */
4568    /* X specific calls - won't work on non-x engines (return 0) */
4569
4570    /**
4571     * Get the Ecore_X_Window of an Evas_Object
4572     *
4573     * @param obj The object
4574     *
4575     * @return The Ecore_X_Window of @p obj
4576     *
4577     * @ingroup Win
4578     */
4579    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4580
4581    /* smart callbacks called:
4582     * "delete,request" - the user requested to delete the window
4583     * "focus,in" - window got focus
4584     * "focus,out" - window lost focus
4585     * "moved" - window that holds the canvas was moved
4586     */
4587
4588    /**
4589     * @defgroup Bg Bg
4590     *
4591     * @image html img/widget/bg/preview-00.png
4592     * @image latex img/widget/bg/preview-00.eps
4593     *
4594     * @brief Background object, used for setting a solid color, image or Edje
4595     * group as background to a window or any container object.
4596     *
4597     * The bg object is used for setting a solid background to a window or
4598     * packing into any container object. It works just like an image, but has
4599     * some properties useful to a background, like setting it to tiled,
4600     * centered, scaled or stretched.
4601     * 
4602     * Default contents parts of the bg widget that you can use for are:
4603     * @li "overlay" - overlay of the bg
4604     *
4605     * Here is some sample code using it:
4606     * @li @ref bg_01_example_page
4607     * @li @ref bg_02_example_page
4608     * @li @ref bg_03_example_page
4609     */
4610
4611    /* bg */
4612    typedef enum _Elm_Bg_Option
4613      {
4614         ELM_BG_OPTION_CENTER,  /**< center the background */
4615         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4616         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4617         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4618      } Elm_Bg_Option;
4619
4620    /**
4621     * Add a new background to the parent
4622     *
4623     * @param parent The parent object
4624     * @return The new object or NULL if it cannot be created
4625     *
4626     * @ingroup Bg
4627     */
4628    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4629
4630    /**
4631     * Set the file (image or edje) used for the background
4632     *
4633     * @param obj The bg object
4634     * @param file The file path
4635     * @param group Optional key (group in Edje) within the file
4636     *
4637     * This sets the image file used in the background object. The image (or edje)
4638     * will be stretched (retaining aspect if its an image file) to completely fill
4639     * the bg object. This may mean some parts are not visible.
4640     *
4641     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4642     * even if @p file is NULL.
4643     *
4644     * @ingroup Bg
4645     */
4646    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4647
4648    /**
4649     * Get the file (image or edje) used for the background
4650     *
4651     * @param obj The bg object
4652     * @param file The file path
4653     * @param group Optional key (group in Edje) within the file
4654     *
4655     * @ingroup Bg
4656     */
4657    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4658
4659    /**
4660     * Set the option used for the background image
4661     *
4662     * @param obj The bg object
4663     * @param option The desired background option (TILE, SCALE)
4664     *
4665     * This sets the option used for manipulating the display of the background
4666     * image. The image can be tiled or scaled.
4667     *
4668     * @ingroup Bg
4669     */
4670    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4671
4672    /**
4673     * Get the option used for the background image
4674     *
4675     * @param obj The bg object
4676     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4677     *
4678     * @ingroup Bg
4679     */
4680    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4681    /**
4682     * Set the option used for the background color
4683     *
4684     * @param obj The bg object
4685     * @param r
4686     * @param g
4687     * @param b
4688     *
4689     * This sets the color used for the background rectangle. Its range goes
4690     * from 0 to 255.
4691     *
4692     * @ingroup Bg
4693     */
4694    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4695    /**
4696     * Get the option used for the background color
4697     *
4698     * @param obj The bg object
4699     * @param r
4700     * @param g
4701     * @param b
4702     *
4703     * @ingroup Bg
4704     */
4705    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4706
4707    /**
4708     * Set the overlay object used for the background object.
4709     *
4710     * @param obj The bg object
4711     * @param overlay The overlay object
4712     *
4713     * This provides a way for elm_bg to have an 'overlay' that will be on top
4714     * of the bg. Once the over object is set, a previously set one will be
4715     * deleted, even if you set the new one to NULL. If you want to keep that
4716     * old content object, use the elm_bg_overlay_unset() function.
4717     *
4718     * @deprecated use elm_object_part_content_set() instead
4719     *
4720     * @ingroup Bg
4721     */
4722
4723    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4724
4725    /**
4726     * Get the overlay object used for the background object.
4727     *
4728     * @param obj The bg object
4729     * @return The content that is being used
4730     *
4731     * Return the content object which is set for this widget
4732     *
4733     * @deprecated use elm_object_part_content_get() instead
4734     *
4735     * @ingroup Bg
4736     */
4737    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4738
4739    /**
4740     * Get the overlay object used for the background object.
4741     *
4742     * @param obj The bg object
4743     * @return The content that was being used
4744     *
4745     * Unparent and return the overlay object which was set for this widget
4746     *
4747     * @deprecated use elm_object_part_content_unset() instead
4748     *
4749     * @ingroup Bg
4750     */
4751    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4752
4753    /**
4754     * Set the size of the pixmap representation of the image.
4755     *
4756     * This option just makes sense if an image is going to be set in the bg.
4757     *
4758     * @param obj The bg object
4759     * @param w The new width of the image pixmap representation.
4760     * @param h The new height of the image pixmap representation.
4761     *
4762     * This function sets a new size for pixmap representation of the given bg
4763     * image. It allows the image to be loaded already in the specified size,
4764     * reducing the memory usage and load time when loading a big image with load
4765     * size set to a smaller size.
4766     *
4767     * NOTE: this is just a hint, the real size of the pixmap may differ
4768     * depending on the type of image being loaded, being bigger than requested.
4769     *
4770     * @ingroup Bg
4771     */
4772    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4773    /* smart callbacks called:
4774     */
4775
4776    /**
4777     * @defgroup Icon Icon
4778     *
4779     * @image html img/widget/icon/preview-00.png
4780     * @image latex img/widget/icon/preview-00.eps
4781     *
4782     * An object that provides standard icon images (delete, edit, arrows, etc.)
4783     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4784     *
4785     * The icon image requested can be in the elementary theme, or in the
4786     * freedesktop.org paths. It's possible to set the order of preference from
4787     * where the image will be used.
4788     *
4789     * This API is very similar to @ref Image, but with ready to use images.
4790     *
4791     * Default images provided by the theme are described below.
4792     *
4793     * The first list contains icons that were first intended to be used in
4794     * toolbars, but can be used in many other places too:
4795     * @li home
4796     * @li close
4797     * @li apps
4798     * @li arrow_up
4799     * @li arrow_down
4800     * @li arrow_left
4801     * @li arrow_right
4802     * @li chat
4803     * @li clock
4804     * @li delete
4805     * @li edit
4806     * @li refresh
4807     * @li folder
4808     * @li file
4809     *
4810     * Now some icons that were designed to be used in menus (but again, you can
4811     * use them anywhere else):
4812     * @li menu/home
4813     * @li menu/close
4814     * @li menu/apps
4815     * @li menu/arrow_up
4816     * @li menu/arrow_down
4817     * @li menu/arrow_left
4818     * @li menu/arrow_right
4819     * @li menu/chat
4820     * @li menu/clock
4821     * @li menu/delete
4822     * @li menu/edit
4823     * @li menu/refresh
4824     * @li menu/folder
4825     * @li menu/file
4826     *
4827     * And here we have some media player specific icons:
4828     * @li media_player/forward
4829     * @li media_player/info
4830     * @li media_player/next
4831     * @li media_player/pause
4832     * @li media_player/play
4833     * @li media_player/prev
4834     * @li media_player/rewind
4835     * @li media_player/stop
4836     *
4837     * Signals that you can add callbacks for are:
4838     *
4839     * "clicked" - This is called when a user has clicked the icon
4840     *
4841     * An example of usage for this API follows:
4842     * @li @ref tutorial_icon
4843     */
4844
4845    /**
4846     * @addtogroup Icon
4847     * @{
4848     */
4849
4850    typedef enum _Elm_Icon_Type
4851      {
4852         ELM_ICON_NONE,
4853         ELM_ICON_FILE,
4854         ELM_ICON_STANDARD
4855      } Elm_Icon_Type;
4856    /**
4857     * @enum _Elm_Icon_Lookup_Order
4858     * @typedef Elm_Icon_Lookup_Order
4859     *
4860     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4861     * theme, FDO paths, or both?
4862     *
4863     * @ingroup Icon
4864     */
4865    typedef enum _Elm_Icon_Lookup_Order
4866      {
4867         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4868         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4869         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4870         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4871      } Elm_Icon_Lookup_Order;
4872
4873    /**
4874     * Add a new icon object to the parent.
4875     *
4876     * @param parent The parent object
4877     * @return The new object or NULL if it cannot be created
4878     *
4879     * @see elm_icon_file_set()
4880     *
4881     * @ingroup Icon
4882     */
4883    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4884    /**
4885     * Set the file that will be used as icon.
4886     *
4887     * @param obj The icon object
4888     * @param file The path to file that will be used as icon image
4889     * @param group The group that the icon belongs to an edje file
4890     *
4891     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4892     *
4893     * @note The icon image set by this function can be changed by
4894     * elm_icon_standard_set().
4895     *
4896     * @see elm_icon_file_get()
4897     *
4898     * @ingroup Icon
4899     */
4900    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4901    /**
4902     * Set a location in memory to be used as an icon
4903     *
4904     * @param obj The icon object
4905     * @param img The binary data that will be used as an image
4906     * @param size The size of binary data @p img
4907     * @param format Optional format of @p img to pass to the image loader
4908     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4909     *
4910     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4911     *
4912     * @note The icon image set by this function can be changed by
4913     * elm_icon_standard_set().
4914     *
4915     * @ingroup Icon
4916     */
4917    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);
4918    /**
4919     * Get the file that will be used as icon.
4920     *
4921     * @param obj The icon object
4922     * @param file The path to file that will be used as the icon image
4923     * @param group The group that the icon belongs to, in edje file
4924     *
4925     * @see elm_icon_file_set()
4926     *
4927     * @ingroup Icon
4928     */
4929    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4930    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4931    /**
4932     * Set the icon by icon standards names.
4933     *
4934     * @param obj The icon object
4935     * @param name The icon name
4936     *
4937     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4938     *
4939     * For example, freedesktop.org defines standard icon names such as "home",
4940     * "network", etc. There can be different icon sets to match those icon
4941     * keys. The @p name given as parameter is one of these "keys", and will be
4942     * used to look in the freedesktop.org paths and elementary theme. One can
4943     * change the lookup order with elm_icon_order_lookup_set().
4944     *
4945     * If name is not found in any of the expected locations and it is the
4946     * absolute path of an image file, this image will be used.
4947     *
4948     * @note The icon image set by this function can be changed by
4949     * elm_icon_file_set().
4950     *
4951     * @see elm_icon_standard_get()
4952     * @see elm_icon_file_set()
4953     *
4954     * @ingroup Icon
4955     */
4956    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4957    /**
4958     * Get the icon name set by icon standard names.
4959     *
4960     * @param obj The icon object
4961     * @return The icon name
4962     *
4963     * If the icon image was set using elm_icon_file_set() instead of
4964     * elm_icon_standard_set(), then this function will return @c NULL.
4965     *
4966     * @see elm_icon_standard_set()
4967     *
4968     * @ingroup Icon
4969     */
4970    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4971    /**
4972     * Set the smooth scaling for an icon object.
4973     *
4974     * @param obj The icon object
4975     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4976     * otherwise. Default is @c EINA_TRUE.
4977     *
4978     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4979     * scaling provides a better resulting image, but is slower.
4980     *
4981     * The smooth scaling should be disabled when making animations that change
4982     * the icon size, since they will be faster. Animations that don't require
4983     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4984     * is already scaled, since the scaled icon image will be cached).
4985     *
4986     * @see elm_icon_smooth_get()
4987     *
4988     * @ingroup Icon
4989     */
4990    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4991    /**
4992     * Get whether smooth scaling is enabled for an icon object.
4993     *
4994     * @param obj The icon object
4995     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4996     *
4997     * @see elm_icon_smooth_set()
4998     *
4999     * @ingroup Icon
5000     */
5001    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5002    /**
5003     * Disable scaling of this object.
5004     *
5005     * @param obj The icon object.
5006     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5007     * otherwise. Default is @c EINA_FALSE.
5008     *
5009     * This function disables scaling of the icon object through the function
5010     * elm_object_scale_set(). However, this does not affect the object
5011     * size/resize in any way. For that effect, take a look at
5012     * elm_icon_scale_set().
5013     *
5014     * @see elm_icon_no_scale_get()
5015     * @see elm_icon_scale_set()
5016     * @see elm_object_scale_set()
5017     *
5018     * @ingroup Icon
5019     */
5020    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5021    /**
5022     * Get whether scaling is disabled on the object.
5023     *
5024     * @param obj The icon object
5025     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5026     *
5027     * @see elm_icon_no_scale_set()
5028     *
5029     * @ingroup Icon
5030     */
5031    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5032    /**
5033     * Set if the object is (up/down) resizable.
5034     *
5035     * @param obj The icon object
5036     * @param scale_up A bool to set if the object is resizable up. Default is
5037     * @c EINA_TRUE.
5038     * @param scale_down A bool to set if the object is resizable down. Default
5039     * is @c EINA_TRUE.
5040     *
5041     * This function limits the icon object resize ability. If @p scale_up is set to
5042     * @c EINA_FALSE, the object can't have its height or width resized to a value
5043     * higher than the original icon size. Same is valid for @p scale_down.
5044     *
5045     * @see elm_icon_scale_get()
5046     *
5047     * @ingroup Icon
5048     */
5049    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5050    /**
5051     * Get if the object is (up/down) resizable.
5052     *
5053     * @param obj The icon object
5054     * @param scale_up A bool to set if the object is resizable up
5055     * @param scale_down A bool to set if the object is resizable down
5056     *
5057     * @see elm_icon_scale_set()
5058     *
5059     * @ingroup Icon
5060     */
5061    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5062    /**
5063     * Get the object's image size
5064     *
5065     * @param obj The icon object
5066     * @param w A pointer to store the width in
5067     * @param h A pointer to store the height in
5068     *
5069     * @ingroup Icon
5070     */
5071    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5072    /**
5073     * Set if the icon fill the entire object area.
5074     *
5075     * @param obj The icon object
5076     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5077     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5078     *
5079     * When the icon object is resized to a different aspect ratio from the
5080     * original icon image, the icon image will still keep its aspect. This flag
5081     * tells how the image should fill the object's area. They are: keep the
5082     * entire icon inside the limits of height and width of the object (@p
5083     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5084     * of the object, and the icon will fill the entire object (@p fill_outside
5085     * is @c EINA_TRUE).
5086     *
5087     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5088     * retain property to false. Thus, the icon image will always keep its
5089     * original aspect ratio.
5090     *
5091     * @see elm_icon_fill_outside_get()
5092     * @see elm_image_fill_outside_set()
5093     *
5094     * @ingroup Icon
5095     */
5096    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5097    /**
5098     * Get if the object is filled outside.
5099     *
5100     * @param obj The icon object
5101     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5102     *
5103     * @see elm_icon_fill_outside_set()
5104     *
5105     * @ingroup Icon
5106     */
5107    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5108    /**
5109     * Set the prescale size for the icon.
5110     *
5111     * @param obj The icon object
5112     * @param size The prescale size. This value is used for both width and
5113     * height.
5114     *
5115     * This function sets a new size for pixmap representation of the given
5116     * icon. It allows the icon to be loaded already in the specified size,
5117     * reducing the memory usage and load time when loading a big icon with load
5118     * size set to a smaller size.
5119     *
5120     * It's equivalent to the elm_bg_load_size_set() function for bg.
5121     *
5122     * @note this is just a hint, the real size of the pixmap may differ
5123     * depending on the type of icon being loaded, being bigger than requested.
5124     *
5125     * @see elm_icon_prescale_get()
5126     * @see elm_bg_load_size_set()
5127     *
5128     * @ingroup Icon
5129     */
5130    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5131    /**
5132     * Get the prescale size for the icon.
5133     *
5134     * @param obj The icon object
5135     * @return The prescale size
5136     *
5137     * @see elm_icon_prescale_set()
5138     *
5139     * @ingroup Icon
5140     */
5141    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142    /**
5143     * Gets the image object of the icon. DO NOT MODIFY THIS.
5144     *
5145     * @param obj The icon object
5146     * @return The internal icon object
5147     *
5148     * @ingroup Icon
5149     */
5150    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5151    /**
5152     * Sets the icon lookup order used by elm_icon_standard_set().
5153     *
5154     * @param obj The icon object
5155     * @param order The icon lookup order (can be one of
5156     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5157     * or ELM_ICON_LOOKUP_THEME)
5158     *
5159     * @see elm_icon_order_lookup_get()
5160     * @see Elm_Icon_Lookup_Order
5161     *
5162     * @ingroup Icon
5163     */
5164    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5165    /**
5166     * Gets the icon lookup order.
5167     *
5168     * @param obj The icon object
5169     * @return The icon lookup order
5170     *
5171     * @see elm_icon_order_lookup_set()
5172     * @see Elm_Icon_Lookup_Order
5173     *
5174     * @ingroup Icon
5175     */
5176    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5177    /**
5178     * Enable or disable preloading of the icon
5179     *
5180     * @param obj The icon object
5181     * @param disable If EINA_TRUE, preloading will be disabled
5182     * @ingroup Icon
5183     */
5184    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5185    /**
5186     * Get if the icon supports animation or not.
5187     *
5188     * @param obj The icon object
5189     * @return @c EINA_TRUE if the icon supports animation,
5190     *         @c EINA_FALSE otherwise.
5191     *
5192     * Return if this elm icon's image can be animated. Currently Evas only
5193     * supports gif animation. If the return value is EINA_FALSE, other
5194     * elm_icon_animated_XXX APIs won't work.
5195     * @ingroup Icon
5196     */
5197    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5198    /**
5199     * Set animation mode of the icon.
5200     *
5201     * @param obj The icon object
5202     * @param anim @c EINA_TRUE if the object do animation job,
5203     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5204     *
5205     * Since the default animation mode is set to EINA_FALSE, 
5206     * the icon is shown without animation.
5207     * This might be desirable when the application developer wants to show
5208     * a snapshot of the animated icon.
5209     * Set it to EINA_TRUE when the icon needs to be animated.
5210     * @ingroup Icon
5211     */
5212    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5213    /**
5214     * Get animation mode of the icon.
5215     *
5216     * @param obj The icon object
5217     * @return The animation mode of the icon object
5218     * @see elm_icon_animated_set
5219     * @ingroup Icon
5220     */
5221    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5222    /**
5223     * Set animation play mode of the icon.
5224     *
5225     * @param obj The icon object
5226     * @param play @c EINA_TRUE the object play animation images,
5227     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5228     *
5229     * To play elm icon's animation, set play to EINA_TURE.
5230     * For example, you make gif player using this set/get API and click event.
5231     *
5232     * 1. Click event occurs
5233     * 2. Check play flag using elm_icon_animaged_play_get
5234     * 3. If elm icon was playing, set play to EINA_FALSE.
5235     *    Then animation will be stopped and vice versa
5236     * @ingroup Icon
5237     */
5238    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5239    /**
5240     * Get animation play mode of the icon.
5241     *
5242     * @param obj The icon object
5243     * @return The play mode of the icon object
5244     *
5245     * @see elm_icon_animated_play_get
5246     * @ingroup Icon
5247     */
5248    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5249
5250    /* compatibility code to avoid API and ABI breaks */
5251    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5252      {
5253         elm_icon_animated_set(obj, animated);
5254      }
5255
5256    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5257      {
5258         return elm_icon_animated_get(obj);
5259      }
5260
5261    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5262      {
5263         elm_icon_animated_play_set(obj, play);
5264      }
5265
5266    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5267      {
5268         return elm_icon_animated_play_get(obj);
5269      }
5270
5271    /**
5272     * @}
5273     */
5274
5275    /**
5276     * @defgroup Image Image
5277     *
5278     * @image html img/widget/image/preview-00.png
5279     * @image latex img/widget/image/preview-00.eps
5280
5281     *
5282     * An object that allows one to load an image file to it. It can be used
5283     * anywhere like any other elementary widget.
5284     *
5285     * This widget provides most of the functionality provided from @ref Bg or @ref
5286     * Icon, but with a slightly different API (use the one that fits better your
5287     * needs).
5288     *
5289     * The features not provided by those two other image widgets are:
5290     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5291     * @li change the object orientation with elm_image_orient_set();
5292     * @li and turning the image editable with elm_image_editable_set().
5293     *
5294     * Signals that you can add callbacks for are:
5295     *
5296     * @li @c "clicked" - This is called when a user has clicked the image
5297     *
5298     * An example of usage for this API follows:
5299     * @li @ref tutorial_image
5300     */
5301
5302    /**
5303     * @addtogroup Image
5304     * @{
5305     */
5306
5307    /**
5308     * @enum _Elm_Image_Orient
5309     * @typedef Elm_Image_Orient
5310     *
5311     * Possible orientation options for elm_image_orient_set().
5312     *
5313     * @image html elm_image_orient_set.png
5314     * @image latex elm_image_orient_set.eps width=\textwidth
5315     *
5316     * @ingroup Image
5317     */
5318    typedef enum _Elm_Image_Orient
5319      {
5320         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5321         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5322         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5323         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5324         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5325         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5326         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5327         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5328      } Elm_Image_Orient;
5329
5330    /**
5331     * Add a new image to the parent.
5332     *
5333     * @param parent The parent object
5334     * @return The new object or NULL if it cannot be created
5335     *
5336     * @see elm_image_file_set()
5337     *
5338     * @ingroup Image
5339     */
5340    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5341    /**
5342     * Set the file that will be used as image.
5343     *
5344     * @param obj The image object
5345     * @param file The path to file that will be used as image
5346     * @param group The group that the image belongs in edje file (if it's an
5347     * edje image)
5348     *
5349     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5350     *
5351     * @see elm_image_file_get()
5352     *
5353     * @ingroup Image
5354     */
5355    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5356    /**
5357     * Get the file that will be used as image.
5358     *
5359     * @param obj The image object
5360     * @param file The path to file
5361     * @param group The group that the image belongs in edje file
5362     *
5363     * @see elm_image_file_set()
5364     *
5365     * @ingroup Image
5366     */
5367    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5368    /**
5369     * Set the smooth effect for an image.
5370     *
5371     * @param obj The image object
5372     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5373     * otherwise. Default is @c EINA_TRUE.
5374     *
5375     * Set the scaling algorithm to be used when scaling the image. Smooth
5376     * scaling provides a better resulting image, but is slower.
5377     *
5378     * The smooth scaling should be disabled when making animations that change
5379     * the image size, since it will be faster. Animations that don't require
5380     * resizing of the image can keep the smooth scaling enabled (even if the
5381     * image is already scaled, since the scaled image will be cached).
5382     *
5383     * @see elm_image_smooth_get()
5384     *
5385     * @ingroup Image
5386     */
5387    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5388    /**
5389     * Get the smooth effect for an image.
5390     *
5391     * @param obj The image object
5392     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5393     *
5394     * @see elm_image_smooth_get()
5395     *
5396     * @ingroup Image
5397     */
5398    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5399
5400    /**
5401     * Gets the current size of the image.
5402     *
5403     * @param obj The image object.
5404     * @param w Pointer to store width, or NULL.
5405     * @param h Pointer to store height, or NULL.
5406     *
5407     * This is the real size of the image, not the size of the object.
5408     *
5409     * On error, neither w or h will be written.
5410     *
5411     * @ingroup Image
5412     */
5413    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5414    /**
5415     * Disable scaling of this object.
5416     *
5417     * @param obj The image object.
5418     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5419     * otherwise. Default is @c EINA_FALSE.
5420     *
5421     * This function disables scaling of the elm_image widget through the
5422     * function elm_object_scale_set(). However, this does not affect the widget
5423     * size/resize in any way. For that effect, take a look at
5424     * elm_image_scale_set().
5425     *
5426     * @see elm_image_no_scale_get()
5427     * @see elm_image_scale_set()
5428     * @see elm_object_scale_set()
5429     *
5430     * @ingroup Image
5431     */
5432    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5433    /**
5434     * Get whether scaling is disabled on the object.
5435     *
5436     * @param obj The image object
5437     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5438     *
5439     * @see elm_image_no_scale_set()
5440     *
5441     * @ingroup Image
5442     */
5443    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5444    /**
5445     * Set if the object is (up/down) resizable.
5446     *
5447     * @param obj The image object
5448     * @param scale_up A bool to set if the object is resizable up. Default is
5449     * @c EINA_TRUE.
5450     * @param scale_down A bool to set if the object is resizable down. Default
5451     * is @c EINA_TRUE.
5452     *
5453     * This function limits the image resize ability. If @p scale_up is set to
5454     * @c EINA_FALSE, the object can't have its height or width resized to a value
5455     * higher than the original image size. Same is valid for @p scale_down.
5456     *
5457     * @see elm_image_scale_get()
5458     *
5459     * @ingroup Image
5460     */
5461    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5462    /**
5463     * Get if the object is (up/down) resizable.
5464     *
5465     * @param obj The image object
5466     * @param scale_up A bool to set if the object is resizable up
5467     * @param scale_down A bool to set if the object is resizable down
5468     *
5469     * @see elm_image_scale_set()
5470     *
5471     * @ingroup Image
5472     */
5473    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5474    /**
5475     * Set if the image fills the entire object area, when keeping the aspect ratio.
5476     *
5477     * @param obj The image object
5478     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5479     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5480     *
5481     * When the image should keep its aspect ratio even if resized to another
5482     * aspect ratio, there are two possibilities to resize it: keep the entire
5483     * image inside the limits of height and width of the object (@p fill_outside
5484     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5485     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5486     *
5487     * @note This option will have no effect if
5488     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5489     *
5490     * @see elm_image_fill_outside_get()
5491     * @see elm_image_aspect_ratio_retained_set()
5492     *
5493     * @ingroup Image
5494     */
5495    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5496    /**
5497     * Get if the object is filled outside
5498     *
5499     * @param obj The image object
5500     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5501     *
5502     * @see elm_image_fill_outside_set()
5503     *
5504     * @ingroup Image
5505     */
5506    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5507    /**
5508     * Set the prescale size for the image
5509     *
5510     * @param obj The image object
5511     * @param size The prescale size. This value is used for both width and
5512     * height.
5513     *
5514     * This function sets a new size for pixmap representation of the given
5515     * image. It allows the image to be loaded already in the specified size,
5516     * reducing the memory usage and load time when loading a big image with load
5517     * size set to a smaller size.
5518     *
5519     * It's equivalent to the elm_bg_load_size_set() function for bg.
5520     *
5521     * @note this is just a hint, the real size of the pixmap may differ
5522     * depending on the type of image being loaded, being bigger than requested.
5523     *
5524     * @see elm_image_prescale_get()
5525     * @see elm_bg_load_size_set()
5526     *
5527     * @ingroup Image
5528     */
5529    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5530    /**
5531     * Get the prescale size for the image
5532     *
5533     * @param obj The image object
5534     * @return The prescale size
5535     *
5536     * @see elm_image_prescale_set()
5537     *
5538     * @ingroup Image
5539     */
5540    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5541    /**
5542     * Set the image orientation.
5543     *
5544     * @param obj The image object
5545     * @param orient The image orientation @ref Elm_Image_Orient
5546     *  Default is #ELM_IMAGE_ORIENT_NONE.
5547     *
5548     * This function allows to rotate or flip the given image.
5549     *
5550     * @see elm_image_orient_get()
5551     * @see @ref Elm_Image_Orient
5552     *
5553     * @ingroup Image
5554     */
5555    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5556    /**
5557     * Get the image orientation.
5558     *
5559     * @param obj The image object
5560     * @return The image orientation @ref Elm_Image_Orient
5561     *
5562     * @see elm_image_orient_set()
5563     * @see @ref Elm_Image_Orient
5564     *
5565     * @ingroup Image
5566     */
5567    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5568    /**
5569     * Make the image 'editable'.
5570     *
5571     * @param obj Image object.
5572     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5573     *
5574     * This means the image is a valid drag target for drag and drop, and can be
5575     * cut or pasted too.
5576     *
5577     * @ingroup Image
5578     */
5579    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5580    /**
5581     * Check if the image 'editable'.
5582     *
5583     * @param obj Image object.
5584     * @return Editability.
5585     *
5586     * A return value of EINA_TRUE means the image is a valid drag target
5587     * for drag and drop, and can be cut or pasted too.
5588     *
5589     * @ingroup Image
5590     */
5591    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5592    /**
5593     * Get the basic Evas_Image object from this object (widget).
5594     *
5595     * @param obj The image object to get the inlined image from
5596     * @return The inlined image object, or NULL if none exists
5597     *
5598     * This function allows one to get the underlying @c Evas_Object of type
5599     * Image from this elementary widget. It can be useful to do things like get
5600     * the pixel data, save the image to a file, etc.
5601     *
5602     * @note Be careful to not manipulate it, as it is under control of
5603     * elementary.
5604     *
5605     * @ingroup Image
5606     */
5607    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5608    /**
5609     * Set whether the original aspect ratio of the image should be kept on resize.
5610     *
5611     * @param obj The image object.
5612     * @param retained @c EINA_TRUE if the image should retain the aspect,
5613     * @c EINA_FALSE otherwise.
5614     *
5615     * The original aspect ratio (width / height) of the image is usually
5616     * distorted to match the object's size. Enabling this option will retain
5617     * this original aspect, and the way that the image is fit into the object's
5618     * area depends on the option set by elm_image_fill_outside_set().
5619     *
5620     * @see elm_image_aspect_ratio_retained_get()
5621     * @see elm_image_fill_outside_set()
5622     *
5623     * @ingroup Image
5624     */
5625    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5626    /**
5627     * Get if the object retains the original aspect ratio.
5628     *
5629     * @param obj The image object.
5630     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5631     * otherwise.
5632     *
5633     * @ingroup Image
5634     */
5635    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5636
5637    /**
5638     * @}
5639     */
5640
5641    /* glview */
5642    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5643
5644    /* old API compatibility */
5645    typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5646
5647    typedef enum _Elm_GLView_Mode
5648      {
5649         ELM_GLVIEW_ALPHA   = 1,
5650         ELM_GLVIEW_DEPTH   = 2,
5651         ELM_GLVIEW_STENCIL = 4
5652      } Elm_GLView_Mode;
5653
5654    /**
5655     * Defines a policy for the glview resizing.
5656     *
5657     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5658     */
5659    typedef enum _Elm_GLView_Resize_Policy
5660      {
5661         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5662         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5663      } Elm_GLView_Resize_Policy;
5664
5665    typedef enum _Elm_GLView_Render_Policy
5666      {
5667         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5668         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5669      } Elm_GLView_Render_Policy;
5670
5671    /**
5672     * @defgroup GLView
5673     *
5674     * A simple GLView widget that allows GL rendering.
5675     *
5676     * Signals that you can add callbacks for are:
5677     *
5678     * @{
5679     */
5680
5681    /**
5682     * Add a new glview to the parent
5683     *
5684     * @param parent The parent object
5685     * @return The new object or NULL if it cannot be created
5686     *
5687     * @ingroup GLView
5688     */
5689    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5690
5691    /**
5692     * Sets the size of the glview
5693     *
5694     * @param obj The glview object
5695     * @param width width of the glview object
5696     * @param height height of the glview object
5697     *
5698     * @ingroup GLView
5699     */
5700    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5701
5702    /**
5703     * Gets the size of the glview.
5704     *
5705     * @param obj The glview object
5706     * @param width width of the glview object
5707     * @param height height of the glview object
5708     *
5709     * Note that this function returns the actual image size of the
5710     * glview.  This means that when the scale policy is set to
5711     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5712     * size.
5713     *
5714     * @ingroup GLView
5715     */
5716    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5717
5718    /**
5719     * Gets the gl api struct for gl rendering
5720     *
5721     * @param obj The glview object
5722     * @return The api object or NULL if it cannot be created
5723     *
5724     * @ingroup GLView
5725     */
5726    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5727
5728    /**
5729     * Set the mode of the GLView. Supports Three simple modes.
5730     *
5731     * @param obj The glview object
5732     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5733     * @return True if set properly.
5734     *
5735     * @ingroup GLView
5736     */
5737    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5738
5739    /**
5740     * Set the resize policy for the glview object.
5741     *
5742     * @param obj The glview object.
5743     * @param policy The scaling policy.
5744     *
5745     * By default, the resize policy is set to
5746     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5747     * destroys the previous surface and recreates the newly specified
5748     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5749     * however, glview only scales the image object and not the underlying
5750     * GL Surface.
5751     *
5752     * @ingroup GLView
5753     */
5754    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5755
5756    /**
5757     * Set the render policy for the glview object.
5758     *
5759     * @param obj The glview object.
5760     * @param policy The render policy.
5761     *
5762     * By default, the render policy is set to
5763     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5764     * that during the render loop, glview is only redrawn if it needs
5765     * to be redrawn. (i.e. When it is visible) If the policy is set to
5766     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5767     * whether it is visible/need redrawing or not.
5768     *
5769     * @ingroup GLView
5770     */
5771    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5772
5773    /**
5774     * Set the init function that runs once in the main loop.
5775     *
5776     * @param obj The glview object.
5777     * @param func The init function to be registered.
5778     *
5779     * The registered init function gets called once during the render loop.
5780     *
5781     * @ingroup GLView
5782     */
5783    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5784
5785    /**
5786     * Set the render function that runs in the main loop.
5787     *
5788     * @param obj The glview object.
5789     * @param func The delete function to be registered.
5790     *
5791     * The registered del function gets called when GLView object is deleted.
5792     *
5793     * @ingroup GLView
5794     */
5795    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5796
5797    /**
5798     * Set the resize function that gets called when resize happens.
5799     *
5800     * @param obj The glview object.
5801     * @param func The resize function to be registered.
5802     *
5803     * @ingroup GLView
5804     */
5805    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5806
5807    /**
5808     * Set the render function that runs in the main loop.
5809     *
5810     * @param obj The glview object.
5811     * @param func The render function to be registered.
5812     *
5813     * @ingroup GLView
5814     */
5815    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5816
5817    /**
5818     * Notifies that there has been changes in the GLView.
5819     *
5820     * @param obj The glview object.
5821     *
5822     * @ingroup GLView
5823     */
5824    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5825
5826    /**
5827     * @}
5828     */
5829
5830    /* box */
5831    /**
5832     * @defgroup Box Box
5833     *
5834     * @image html img/widget/box/preview-00.png
5835     * @image latex img/widget/box/preview-00.eps width=\textwidth
5836     *
5837     * @image html img/box.png
5838     * @image latex img/box.eps width=\textwidth
5839     *
5840     * A box arranges objects in a linear fashion, governed by a layout function
5841     * that defines the details of this arrangement.
5842     *
5843     * By default, the box will use an internal function to set the layout to
5844     * a single row, either vertical or horizontal. This layout is affected
5845     * by a number of parameters, such as the homogeneous flag set by
5846     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5847     * elm_box_align_set() and the hints set to each object in the box.
5848     *
5849     * For this default layout, it's possible to change the orientation with
5850     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5851     * placing its elements ordered from top to bottom. When horizontal is set,
5852     * the order will go from left to right. If the box is set to be
5853     * homogeneous, every object in it will be assigned the same space, that
5854     * of the largest object. Padding can be used to set some spacing between
5855     * the cell given to each object. The alignment of the box, set with
5856     * elm_box_align_set(), determines how the bounding box of all the elements
5857     * will be placed within the space given to the box widget itself.
5858     *
5859     * The size hints of each object also affect how they are placed and sized
5860     * within the box. evas_object_size_hint_min_set() will give the minimum
5861     * size the object can have, and the box will use it as the basis for all
5862     * latter calculations. Elementary widgets set their own minimum size as
5863     * needed, so there's rarely any need to use it manually.
5864     *
5865     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5866     * used to tell whether the object will be allocated the minimum size it
5867     * needs or if the space given to it should be expanded. It's important
5868     * to realize that expanding the size given to the object is not the same
5869     * thing as resizing the object. It could very well end being a small
5870     * widget floating in a much larger empty space. If not set, the weight
5871     * for objects will normally be 0.0 for both axis, meaning the widget will
5872     * not be expanded. To take as much space possible, set the weight to
5873     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5874     *
5875     * Besides how much space each object is allocated, it's possible to control
5876     * how the widget will be placed within that space using
5877     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5878     * for both axis, meaning the object will be centered, but any value from
5879     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5880     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5881     * is -1.0, means the object will be resized to fill the entire space it
5882     * was allocated.
5883     *
5884     * In addition, customized functions to define the layout can be set, which
5885     * allow the application developer to organize the objects within the box
5886     * in any number of ways.
5887     *
5888     * The special elm_box_layout_transition() function can be used
5889     * to switch from one layout to another, animating the motion of the
5890     * children of the box.
5891     *
5892     * @note Objects should not be added to box objects using _add() calls.
5893     *
5894     * Some examples on how to use boxes follow:
5895     * @li @ref box_example_01
5896     * @li @ref box_example_02
5897     *
5898     * @{
5899     */
5900    /**
5901     * @typedef Elm_Box_Transition
5902     *
5903     * Opaque handler containing the parameters to perform an animated
5904     * transition of the layout the box uses.
5905     *
5906     * @see elm_box_transition_new()
5907     * @see elm_box_layout_set()
5908     * @see elm_box_layout_transition()
5909     */
5910    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5911
5912    /**
5913     * Add a new box to the parent
5914     *
5915     * By default, the box will be in vertical mode and non-homogeneous.
5916     *
5917     * @param parent The parent object
5918     * @return The new object or NULL if it cannot be created
5919     */
5920    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5921    /**
5922     * Set the horizontal orientation
5923     *
5924     * By default, box object arranges their contents vertically from top to
5925     * bottom.
5926     * By calling this function with @p horizontal as EINA_TRUE, the box will
5927     * become horizontal, arranging contents from left to right.
5928     *
5929     * @note This flag is ignored if a custom layout function is set.
5930     *
5931     * @param obj The box object
5932     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5933     * EINA_FALSE = vertical)
5934     */
5935    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5936    /**
5937     * Get the horizontal orientation
5938     *
5939     * @param obj The box object
5940     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5941     */
5942    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5943    /**
5944     * Set the box to arrange its children homogeneously
5945     *
5946     * If enabled, homogeneous layout makes all items the same size, according
5947     * to the size of the largest of its children.
5948     *
5949     * @note This flag is ignored if a custom layout function is set.
5950     *
5951     * @param obj The box object
5952     * @param homogeneous The homogeneous flag
5953     */
5954    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5955    /**
5956     * Get whether the box is using homogeneous mode or not
5957     *
5958     * @param obj The box object
5959     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5960     */
5961    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5962    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5963    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5964    /**
5965     * Add an object to the beginning of the pack list
5966     *
5967     * Pack @p subobj into the box @p obj, placing it first in the list of
5968     * children objects. The actual position the object will get on screen
5969     * depends on the layout used. If no custom layout is set, it will be at
5970     * the top or left, depending if the box is vertical or horizontal,
5971     * respectively.
5972     *
5973     * @param obj The box object
5974     * @param subobj The object to add to the box
5975     *
5976     * @see elm_box_pack_end()
5977     * @see elm_box_pack_before()
5978     * @see elm_box_pack_after()
5979     * @see elm_box_unpack()
5980     * @see elm_box_unpack_all()
5981     * @see elm_box_clear()
5982     */
5983    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5984    /**
5985     * Add an object at the end of the pack list
5986     *
5987     * Pack @p subobj into the box @p obj, placing it last in the list of
5988     * children objects. The actual position the object will get on screen
5989     * depends on the layout used. If no custom layout is set, it will be at
5990     * the bottom or right, depending if the box is vertical or horizontal,
5991     * respectively.
5992     *
5993     * @param obj The box object
5994     * @param subobj The object to add to the box
5995     *
5996     * @see elm_box_pack_start()
5997     * @see elm_box_pack_before()
5998     * @see elm_box_pack_after()
5999     * @see elm_box_unpack()
6000     * @see elm_box_unpack_all()
6001     * @see elm_box_clear()
6002     */
6003    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6004    /**
6005     * Adds an object to the box before the indicated object
6006     *
6007     * This will add the @p subobj to the box indicated before the object
6008     * indicated with @p before. If @p before is not already in the box, results
6009     * are undefined. Before means either to the left of the indicated object or
6010     * above it depending on orientation.
6011     *
6012     * @param obj The box object
6013     * @param subobj The object to add to the box
6014     * @param before The object before which to add it
6015     *
6016     * @see elm_box_pack_start()
6017     * @see elm_box_pack_end()
6018     * @see elm_box_pack_after()
6019     * @see elm_box_unpack()
6020     * @see elm_box_unpack_all()
6021     * @see elm_box_clear()
6022     */
6023    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6024    /**
6025     * Adds an object to the box after the indicated object
6026     *
6027     * This will add the @p subobj to the box indicated after the object
6028     * indicated with @p after. If @p after is not already in the box, results
6029     * are undefined. After means either to the right of the indicated object or
6030     * below it depending on orientation.
6031     *
6032     * @param obj The box object
6033     * @param subobj The object to add to the box
6034     * @param after The object after which to add it
6035     *
6036     * @see elm_box_pack_start()
6037     * @see elm_box_pack_end()
6038     * @see elm_box_pack_before()
6039     * @see elm_box_unpack()
6040     * @see elm_box_unpack_all()
6041     * @see elm_box_clear()
6042     */
6043    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6044    /**
6045     * Clear the box of all children
6046     *
6047     * Remove all the elements contained by the box, deleting the respective
6048     * objects.
6049     *
6050     * @param obj The box object
6051     *
6052     * @see elm_box_unpack()
6053     * @see elm_box_unpack_all()
6054     */
6055    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6056    /**
6057     * Unpack a box item
6058     *
6059     * Remove the object given by @p subobj from the box @p obj without
6060     * deleting it.
6061     *
6062     * @param obj The box object
6063     *
6064     * @see elm_box_unpack_all()
6065     * @see elm_box_clear()
6066     */
6067    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6068    /**
6069     * Remove all items from the box, without deleting them
6070     *
6071     * Clear the box from all children, but don't delete the respective objects.
6072     * If no other references of the box children exist, the objects will never
6073     * be deleted, and thus the application will leak the memory. Make sure
6074     * when using this function that you hold a reference to all the objects
6075     * in the box @p obj.
6076     *
6077     * @param obj The box object
6078     *
6079     * @see elm_box_clear()
6080     * @see elm_box_unpack()
6081     */
6082    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6083    /**
6084     * Retrieve a list of the objects packed into the box
6085     *
6086     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6087     * The order of the list corresponds to the packing order the box uses.
6088     *
6089     * You must free this list with eina_list_free() once you are done with it.
6090     *
6091     * @param obj The box object
6092     */
6093    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6094    /**
6095     * Set the space (padding) between the box's elements.
6096     *
6097     * Extra space in pixels that will be added between a box child and its
6098     * neighbors after its containing cell has been calculated. This padding
6099     * is set for all elements in the box, besides any possible padding that
6100     * individual elements may have through their size hints.
6101     *
6102     * @param obj The box object
6103     * @param horizontal The horizontal space between elements
6104     * @param vertical The vertical space between elements
6105     */
6106    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6107    /**
6108     * Get the space (padding) between the box's elements.
6109     *
6110     * @param obj The box object
6111     * @param horizontal The horizontal space between elements
6112     * @param vertical The vertical space between elements
6113     *
6114     * @see elm_box_padding_set()
6115     */
6116    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6117    /**
6118     * Set the alignment of the whole bouding box of contents.
6119     *
6120     * Sets how the bounding box containing all the elements of the box, after
6121     * their sizes and position has been calculated, will be aligned within
6122     * the space given for the whole box widget.
6123     *
6124     * @param obj The box object
6125     * @param horizontal The horizontal alignment of elements
6126     * @param vertical The vertical alignment of elements
6127     */
6128    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6129    /**
6130     * Get the alignment of the whole bouding box of contents.
6131     *
6132     * @param obj The box object
6133     * @param horizontal The horizontal alignment of elements
6134     * @param vertical The vertical alignment of elements
6135     *
6136     * @see elm_box_align_set()
6137     */
6138    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6139
6140    /**
6141     * Force the box to recalculate its children packing.
6142     *
6143     * If any children was added or removed, box will not calculate the
6144     * values immediately rather leaving it to the next main loop
6145     * iteration. While this is great as it would save lots of
6146     * recalculation, whenever you need to get the position of a just
6147     * added item you must force recalculate before doing so.
6148     *
6149     * @param obj The box object.
6150     */
6151    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6152
6153    /**
6154     * Set the layout defining function to be used by the box
6155     *
6156     * Whenever anything changes that requires the box in @p obj to recalculate
6157     * the size and position of its elements, the function @p cb will be called
6158     * to determine what the layout of the children will be.
6159     *
6160     * Once a custom function is set, everything about the children layout
6161     * is defined by it. The flags set by elm_box_horizontal_set() and
6162     * elm_box_homogeneous_set() no longer have any meaning, and the values
6163     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6164     * layout function to decide if they are used and how. These last two
6165     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6166     * passed to @p cb. The @c Evas_Object the function receives is not the
6167     * Elementary widget, but the internal Evas Box it uses, so none of the
6168     * functions described here can be used on it.
6169     *
6170     * Any of the layout functions in @c Evas can be used here, as well as the
6171     * special elm_box_layout_transition().
6172     *
6173     * The final @p data argument received by @p cb is the same @p data passed
6174     * here, and the @p free_data function will be called to free it
6175     * whenever the box is destroyed or another layout function is set.
6176     *
6177     * Setting @p cb to NULL will revert back to the default layout function.
6178     *
6179     * @param obj The box object
6180     * @param cb The callback function used for layout
6181     * @param data Data that will be passed to layout function
6182     * @param free_data Function called to free @p data
6183     *
6184     * @see elm_box_layout_transition()
6185     */
6186    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);
6187    /**
6188     * Special layout function that animates the transition from one layout to another
6189     *
6190     * Normally, when switching the layout function for a box, this will be
6191     * reflected immediately on screen on the next render, but it's also
6192     * possible to do this through an animated transition.
6193     *
6194     * This is done by creating an ::Elm_Box_Transition and setting the box
6195     * layout to this function.
6196     *
6197     * For example:
6198     * @code
6199     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6200     *                            evas_object_box_layout_vertical, // start
6201     *                            NULL, // data for initial layout
6202     *                            NULL, // free function for initial data
6203     *                            evas_object_box_layout_horizontal, // end
6204     *                            NULL, // data for final layout
6205     *                            NULL, // free function for final data
6206     *                            anim_end, // will be called when animation ends
6207     *                            NULL); // data for anim_end function\
6208     * elm_box_layout_set(box, elm_box_layout_transition, t,
6209     *                    elm_box_transition_free);
6210     * @endcode
6211     *
6212     * @note This function can only be used with elm_box_layout_set(). Calling
6213     * it directly will not have the expected results.
6214     *
6215     * @see elm_box_transition_new
6216     * @see elm_box_transition_free
6217     * @see elm_box_layout_set
6218     */
6219    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6220    /**
6221     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6222     *
6223     * If you want to animate the change from one layout to another, you need
6224     * to set the layout function of the box to elm_box_layout_transition(),
6225     * passing as user data to it an instance of ::Elm_Box_Transition with the
6226     * necessary information to perform this animation. The free function to
6227     * set for the layout is elm_box_transition_free().
6228     *
6229     * The parameters to create an ::Elm_Box_Transition sum up to how long
6230     * will it be, in seconds, a layout function to describe the initial point,
6231     * another for the final position of the children and one function to be
6232     * called when the whole animation ends. This last function is useful to
6233     * set the definitive layout for the box, usually the same as the end
6234     * layout for the animation, but could be used to start another transition.
6235     *
6236     * @param start_layout The layout function that will be used to start the animation
6237     * @param start_layout_data The data to be passed the @p start_layout function
6238     * @param start_layout_free_data Function to free @p start_layout_data
6239     * @param end_layout The layout function that will be used to end the animation
6240     * @param end_layout_free_data The data to be passed the @p end_layout function
6241     * @param end_layout_free_data Function to free @p end_layout_data
6242     * @param transition_end_cb Callback function called when animation ends
6243     * @param transition_end_data Data to be passed to @p transition_end_cb
6244     * @return An instance of ::Elm_Box_Transition
6245     *
6246     * @see elm_box_transition_new
6247     * @see elm_box_layout_transition
6248     */
6249    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);
6250    /**
6251     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6252     *
6253     * This function is mostly useful as the @c free_data parameter in
6254     * elm_box_layout_set() when elm_box_layout_transition().
6255     *
6256     * @param data The Elm_Box_Transition instance to be freed.
6257     *
6258     * @see elm_box_transition_new
6259     * @see elm_box_layout_transition
6260     */
6261    EAPI void                elm_box_transition_free(void *data);
6262    /**
6263     * @}
6264     */
6265
6266    /* button */
6267    /**
6268     * @defgroup Button Button
6269     *
6270     * @image html img/widget/button/preview-00.png
6271     * @image latex img/widget/button/preview-00.eps
6272     * @image html img/widget/button/preview-01.png
6273     * @image latex img/widget/button/preview-01.eps
6274     * @image html img/widget/button/preview-02.png
6275     * @image latex img/widget/button/preview-02.eps
6276     *
6277     * This is a push-button. Press it and run some function. It can contain
6278     * a simple label and icon object and it also has an autorepeat feature.
6279     *
6280     * This widgets emits the following signals:
6281     * @li "clicked": the user clicked the button (press/release).
6282     * @li "repeated": the user pressed the button without releasing it.
6283     * @li "pressed": button was pressed.
6284     * @li "unpressed": button was released after being pressed.
6285     * In all three cases, the @c event parameter of the callback will be
6286     * @c NULL.
6287     *
6288     * Also, defined in the default theme, the button has the following styles
6289     * available:
6290     * @li default: a normal button.
6291     * @li anchor: Like default, but the button fades away when the mouse is not
6292     * over it, leaving only the text or icon.
6293     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6294     * continuous look across its options.
6295     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6296     *
6297     * Default contents parts of the button widget that you can use for are:
6298     * @li "icon" - A icon of the button
6299     *
6300     * Default text parts of the button widget that you can use for are:
6301     * @li "default" - Label of the button
6302     *
6303     * Follow through a complete example @ref button_example_01 "here".
6304     * @{
6305     */
6306
6307    typedef enum
6308      {
6309         UIControlStateDefault,
6310         UIControlStateHighlighted,
6311         UIControlStateDisabled,
6312         UIControlStateFocused,
6313         UIControlStateReserved
6314      } UIControlState;
6315
6316    /**
6317     * Add a new button to the parent's canvas
6318     *
6319     * @param parent The parent object
6320     * @return The new object or NULL if it cannot be created
6321     */
6322    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6323    /**
6324     * Set the label used in the button
6325     *
6326     * The passed @p label can be NULL to clean any existing text in it and
6327     * leave the button as an icon only object.
6328     *
6329     * @param obj The button object
6330     * @param label The text will be written on the button
6331     * @deprecated use elm_object_text_set() instead.
6332     */
6333    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6334    /**
6335     * Get the label set for the button
6336     *
6337     * The string returned is an internal pointer and should not be freed or
6338     * altered. It will also become invalid when the button is destroyed.
6339     * The string returned, if not NULL, is a stringshare, so if you need to
6340     * keep it around even after the button is destroyed, you can use
6341     * eina_stringshare_ref().
6342     *
6343     * @param obj The button object
6344     * @return The text set to the label, or NULL if nothing is set
6345     * @deprecated use elm_object_text_set() instead.
6346     */
6347    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6348    /**
6349     * Set the label for each state of button
6350     *
6351     * The passed @p label can be NULL to clean any existing text in it and
6352     * leave the button as an icon only object for the state.
6353     *
6354     * @param obj The button object
6355     * @param label The text will be written on the button
6356     * @param state The state of button
6357     *
6358     * @ingroup Button
6359     */
6360    EINA_DEPRECATED EAPI void         elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6361    /**
6362     * Get the label of button for each state
6363     *
6364     * The string returned is an internal pointer and should not be freed or
6365     * altered. It will also become invalid when the button is destroyed.
6366     * The string returned, if not NULL, is a stringshare, so if you need to
6367     * keep it around even after the button is destroyed, you can use
6368     * eina_stringshare_ref().
6369     *
6370     * @param obj The button object
6371     * @param state The state of button
6372     * @return The title of button for state
6373     *
6374     * @ingroup Button
6375     */
6376    EINA_DEPRECATED EAPI const char  *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6377    /**
6378     * Set the icon used for the button
6379     *
6380     * Setting a new icon will delete any other that was previously set, making
6381     * any reference to them invalid. If you need to maintain the previous
6382     * object alive, unset it first with elm_button_icon_unset().
6383     *
6384     * @param obj The button object
6385     * @param icon The icon object for the button
6386     * @deprecated use elm_object_part_content_set() instead.
6387     */
6388    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6389    /**
6390     * Get the icon used for the button
6391     *
6392     * Return the icon object which is set for this widget. If the button is
6393     * destroyed or another icon is set, the returned object will be deleted
6394     * and any reference to it will be invalid.
6395     *
6396     * @param obj The button object
6397     * @return The icon object that is being used
6398     *
6399     * @deprecated use elm_object_part_content_get() instead
6400     */
6401    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6402    /**
6403     * Remove the icon set without deleting it and return the object
6404     *
6405     * This function drops the reference the button holds of the icon object
6406     * and returns this last object. It is used in case you want to remove any
6407     * icon, or set another one, without deleting the actual object. The button
6408     * will be left without an icon set.
6409     *
6410     * @param obj The button object
6411     * @return The icon object that was being used
6412     * @deprecated use elm_object_part_content_unset() instead.
6413     */
6414    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6415    /**
6416     * Turn on/off the autorepeat event generated when the button is kept pressed
6417     *
6418     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6419     * signal when they are clicked.
6420     *
6421     * When on, keeping a button pressed will continuously emit a @c repeated
6422     * signal until the button is released. The time it takes until it starts
6423     * emitting the signal is given by
6424     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6425     * new emission by elm_button_autorepeat_gap_timeout_set().
6426     *
6427     * @param obj The button object
6428     * @param on  A bool to turn on/off the event
6429     */
6430    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6431    /**
6432     * Get whether the autorepeat feature is enabled
6433     *
6434     * @param obj The button object
6435     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6436     *
6437     * @see elm_button_autorepeat_set()
6438     */
6439    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6440    /**
6441     * Set the initial timeout before the autorepeat event is generated
6442     *
6443     * Sets the timeout, in seconds, since the button is pressed until the
6444     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6445     * won't be any delay and the even will be fired the moment the button is
6446     * pressed.
6447     *
6448     * @param obj The button object
6449     * @param t   Timeout in seconds
6450     *
6451     * @see elm_button_autorepeat_set()
6452     * @see elm_button_autorepeat_gap_timeout_set()
6453     */
6454    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6455    /**
6456     * Get the initial timeout before the autorepeat event is generated
6457     *
6458     * @param obj The button object
6459     * @return Timeout in seconds
6460     *
6461     * @see elm_button_autorepeat_initial_timeout_set()
6462     */
6463    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6464    /**
6465     * Set the interval between each generated autorepeat event
6466     *
6467     * After the first @c repeated event is fired, all subsequent ones will
6468     * follow after a delay of @p t seconds for each.
6469     *
6470     * @param obj The button object
6471     * @param t   Interval in seconds
6472     *
6473     * @see elm_button_autorepeat_initial_timeout_set()
6474     */
6475    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6476    /**
6477     * Get the interval between each generated autorepeat event
6478     *
6479     * @param obj The button object
6480     * @return Interval in seconds
6481     */
6482    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6483    /**
6484     * @}
6485     */
6486
6487    /**
6488     * @defgroup File_Selector_Button File Selector Button
6489     *
6490     * @image html img/widget/fileselector_button/preview-00.png
6491     * @image latex img/widget/fileselector_button/preview-00.eps
6492     * @image html img/widget/fileselector_button/preview-01.png
6493     * @image latex img/widget/fileselector_button/preview-01.eps
6494     * @image html img/widget/fileselector_button/preview-02.png
6495     * @image latex img/widget/fileselector_button/preview-02.eps
6496     *
6497     * This is a button that, when clicked, creates an Elementary
6498     * window (or inner window) <b> with a @ref Fileselector "file
6499     * selector widget" within</b>. When a file is chosen, the (inner)
6500     * window is closed and the button emits a signal having the
6501     * selected file as it's @c event_info.
6502     *
6503     * This widget encapsulates operations on its internal file
6504     * selector on its own API. There is less control over its file
6505     * selector than that one would have instatiating one directly.
6506     *
6507     * The following styles are available for this button:
6508     * @li @c "default"
6509     * @li @c "anchor"
6510     * @li @c "hoversel_vertical"
6511     * @li @c "hoversel_vertical_entry"
6512     *
6513     * Smart callbacks one can register to:
6514     * - @c "file,chosen" - the user has selected a path, whose string
6515     *   pointer comes as the @c event_info data (a stringshared
6516     *   string)
6517     *
6518     * Here is an example on its usage:
6519     * @li @ref fileselector_button_example
6520     *
6521     * @see @ref File_Selector_Entry for a similar widget.
6522     * @{
6523     */
6524
6525    /**
6526     * Add a new file selector button widget to the given parent
6527     * Elementary (container) object
6528     *
6529     * @param parent The parent object
6530     * @return a new file selector button widget handle or @c NULL, on
6531     * errors
6532     */
6533    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6534
6535    /**
6536     * Set the label for a given file selector button widget
6537     *
6538     * @param obj The file selector button widget
6539     * @param label The text label to be displayed on @p obj
6540     *
6541     * @deprecated use elm_object_text_set() instead.
6542     */
6543    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6544
6545    /**
6546     * Get the label set for a given file selector button widget
6547     *
6548     * @param obj The file selector button widget
6549     * @return The button label
6550     *
6551     * @deprecated use elm_object_text_set() instead.
6552     */
6553    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6554
6555    /**
6556     * Set the icon on a given file selector button widget
6557     *
6558     * @param obj The file selector button widget
6559     * @param icon The icon object for the button
6560     *
6561     * Once the icon object is set, a previously set one will be
6562     * deleted. If you want to keep the latter, use the
6563     * elm_fileselector_button_icon_unset() function.
6564     *
6565     * @see elm_fileselector_button_icon_get()
6566     */
6567    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6568
6569    /**
6570     * Get the icon set for a given file selector button widget
6571     *
6572     * @param obj The file selector button widget
6573     * @return The icon object currently set on @p obj or @c NULL, if
6574     * none is
6575     *
6576     * @see elm_fileselector_button_icon_set()
6577     */
6578    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6579
6580    /**
6581     * Unset the icon used in a given file selector button widget
6582     *
6583     * @param obj The file selector button widget
6584     * @return The icon object that was being used on @p obj or @c
6585     * NULL, on errors
6586     *
6587     * Unparent and return the icon object which was set for this
6588     * widget.
6589     *
6590     * @see elm_fileselector_button_icon_set()
6591     */
6592    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6593
6594    /**
6595     * Set the title for a given file selector button widget's window
6596     *
6597     * @param obj The file selector button widget
6598     * @param title The title string
6599     *
6600     * This will change the window's title, when the file selector pops
6601     * out after a click on the button. Those windows have the default
6602     * (unlocalized) value of @c "Select a file" as titles.
6603     *
6604     * @note It will only take any effect if the file selector
6605     * button widget is @b not under "inwin mode".
6606     *
6607     * @see elm_fileselector_button_window_title_get()
6608     */
6609    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6610
6611    /**
6612     * Get the title set for a given file selector button widget's
6613     * window
6614     *
6615     * @param obj The file selector button widget
6616     * @return Title of the file selector button's window
6617     *
6618     * @see elm_fileselector_button_window_title_get() for more details
6619     */
6620    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6621
6622    /**
6623     * Set the size of a given file selector button widget's window,
6624     * holding the file selector itself.
6625     *
6626     * @param obj The file selector button widget
6627     * @param width The window's width
6628     * @param height The window's height
6629     *
6630     * @note it will only take any effect if the file selector button
6631     * widget is @b not under "inwin mode". The default size for the
6632     * window (when applicable) is 400x400 pixels.
6633     *
6634     * @see elm_fileselector_button_window_size_get()
6635     */
6636    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6637
6638    /**
6639     * Get the size of a given file selector button widget's window,
6640     * holding the file selector itself.
6641     *
6642     * @param obj The file selector button widget
6643     * @param width Pointer into which to store the width value
6644     * @param height Pointer into which to store the height value
6645     *
6646     * @note Use @c NULL pointers on the size values you're not
6647     * interested in: they'll be ignored by the function.
6648     *
6649     * @see elm_fileselector_button_window_size_set(), for more details
6650     */
6651    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6652
6653    /**
6654     * Set the initial file system path for a given file selector
6655     * button widget
6656     *
6657     * @param obj The file selector button widget
6658     * @param path The path string
6659     *
6660     * It must be a <b>directory</b> path, which will have the contents
6661     * displayed initially in the file selector's view, when invoked
6662     * from @p obj. The default initial path is the @c "HOME"
6663     * environment variable's value.
6664     *
6665     * @see elm_fileselector_button_path_get()
6666     */
6667    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6668
6669    /**
6670     * Get the initial file system path set for a given file selector
6671     * button widget
6672     *
6673     * @param obj The file selector button widget
6674     * @return path The path string
6675     *
6676     * @see elm_fileselector_button_path_set() for more details
6677     */
6678    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6679
6680    /**
6681     * Enable/disable a tree view in the given file selector button
6682     * widget's internal file selector
6683     *
6684     * @param obj The file selector button widget
6685     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6686     * disable
6687     *
6688     * This has the same effect as elm_fileselector_expandable_set(),
6689     * but now applied to a file selector button's internal file
6690     * selector.
6691     *
6692     * @note There's no way to put a file selector button's internal
6693     * file selector in "grid mode", as one may do with "pure" file
6694     * selectors.
6695     *
6696     * @see elm_fileselector_expandable_get()
6697     */
6698    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6699
6700    /**
6701     * Get whether tree view is enabled for the given file selector
6702     * button widget's internal file selector
6703     *
6704     * @param obj The file selector button widget
6705     * @return @c EINA_TRUE if @p obj widget's internal file selector
6706     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6707     *
6708     * @see elm_fileselector_expandable_set() for more details
6709     */
6710    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6711
6712    /**
6713     * Set whether a given file selector button widget's internal file
6714     * selector is to display folders only or the directory contents,
6715     * as well.
6716     *
6717     * @param obj The file selector button widget
6718     * @param only @c EINA_TRUE to make @p obj widget's internal file
6719     * selector only display directories, @c EINA_FALSE to make files
6720     * to be displayed in it too
6721     *
6722     * This has the same effect as elm_fileselector_folder_only_set(),
6723     * but now applied to a file selector button's internal file
6724     * selector.
6725     *
6726     * @see elm_fileselector_folder_only_get()
6727     */
6728    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6729
6730    /**
6731     * Get whether a given file selector button widget's internal file
6732     * selector is displaying folders only or the directory contents,
6733     * as well.
6734     *
6735     * @param obj The file selector button widget
6736     * @return @c EINA_TRUE if @p obj widget's internal file
6737     * selector is only displaying directories, @c EINA_FALSE if files
6738     * are being displayed in it too (and on errors)
6739     *
6740     * @see elm_fileselector_button_folder_only_set() for more details
6741     */
6742    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6743
6744    /**
6745     * Enable/disable the file name entry box where the user can type
6746     * in a name for a file, in a given file selector button widget's
6747     * internal file selector.
6748     *
6749     * @param obj The file selector button widget
6750     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6751     * file selector a "saving dialog", @c EINA_FALSE otherwise
6752     *
6753     * This has the same effect as elm_fileselector_is_save_set(),
6754     * but now applied to a file selector button's internal file
6755     * selector.
6756     *
6757     * @see elm_fileselector_is_save_get()
6758     */
6759    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6760
6761    /**
6762     * Get whether the given file selector button widget's internal
6763     * file selector is in "saving dialog" mode
6764     *
6765     * @param obj The file selector button widget
6766     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6767     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6768     * errors)
6769     *
6770     * @see elm_fileselector_button_is_save_set() for more details
6771     */
6772    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6773
6774    /**
6775     * Set whether a given file selector button widget's internal file
6776     * selector will raise an Elementary "inner window", instead of a
6777     * dedicated Elementary window. By default, it won't.
6778     *
6779     * @param obj The file selector button widget
6780     * @param value @c EINA_TRUE to make it use an inner window, @c
6781     * EINA_TRUE to make it use a dedicated window
6782     *
6783     * @see elm_win_inwin_add() for more information on inner windows
6784     * @see elm_fileselector_button_inwin_mode_get()
6785     */
6786    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6787
6788    /**
6789     * Get whether a given file selector button widget's internal file
6790     * selector will raise an Elementary "inner window", instead of a
6791     * dedicated Elementary window.
6792     *
6793     * @param obj The file selector button widget
6794     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6795     * if it will use a dedicated window
6796     *
6797     * @see elm_fileselector_button_inwin_mode_set() for more details
6798     */
6799    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6800
6801    /**
6802     * @}
6803     */
6804
6805     /**
6806     * @defgroup File_Selector_Entry File Selector Entry
6807     *
6808     * @image html img/widget/fileselector_entry/preview-00.png
6809     * @image latex img/widget/fileselector_entry/preview-00.eps
6810     *
6811     * This is an entry made to be filled with or display a <b>file
6812     * system path string</b>. Besides the entry itself, the widget has
6813     * a @ref File_Selector_Button "file selector button" on its side,
6814     * which will raise an internal @ref Fileselector "file selector widget",
6815     * when clicked, for path selection aided by file system
6816     * navigation.
6817     *
6818     * This file selector may appear in an Elementary window or in an
6819     * inner window. When a file is chosen from it, the (inner) window
6820     * is closed and the selected file's path string is exposed both as
6821     * an smart event and as the new text on the entry.
6822     *
6823     * This widget encapsulates operations on its internal file
6824     * selector on its own API. There is less control over its file
6825     * selector than that one would have instatiating one directly.
6826     *
6827     * Smart callbacks one can register to:
6828     * - @c "changed" - The text within the entry was changed
6829     * - @c "activated" - The entry has had editing finished and
6830     *   changes are to be "committed"
6831     * - @c "press" - The entry has been clicked
6832     * - @c "longpressed" - The entry has been clicked (and held) for a
6833     *   couple seconds
6834     * - @c "clicked" - The entry has been clicked
6835     * - @c "clicked,double" - The entry has been double clicked
6836     * - @c "focused" - The entry has received focus
6837     * - @c "unfocused" - The entry has lost focus
6838     * - @c "selection,paste" - A paste action has occurred on the
6839     *   entry
6840     * - @c "selection,copy" - A copy action has occurred on the entry
6841     * - @c "selection,cut" - A cut action has occurred on the entry
6842     * - @c "unpressed" - The file selector entry's button was released
6843     *   after being pressed.
6844     * - @c "file,chosen" - The user has selected a path via the file
6845     *   selector entry's internal file selector, whose string pointer
6846     *   comes as the @c event_info data (a stringshared string)
6847     *
6848     * Here is an example on its usage:
6849     * @li @ref fileselector_entry_example
6850     *
6851     * @see @ref File_Selector_Button for a similar widget.
6852     * @{
6853     */
6854
6855    /**
6856     * Add a new file selector entry widget to the given parent
6857     * Elementary (container) object
6858     *
6859     * @param parent The parent object
6860     * @return a new file selector entry widget handle or @c NULL, on
6861     * errors
6862     */
6863    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6864
6865    /**
6866     * Set the label for a given file selector entry widget's button
6867     *
6868     * @param obj The file selector entry widget
6869     * @param label The text label to be displayed on @p obj widget's
6870     * button
6871     *
6872     * @deprecated use elm_object_text_set() instead.
6873     */
6874    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6875
6876    /**
6877     * Get the label set for a given file selector entry widget's button
6878     *
6879     * @param obj The file selector entry widget
6880     * @return The widget button's label
6881     *
6882     * @deprecated use elm_object_text_set() instead.
6883     */
6884    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6885
6886    /**
6887     * Set the icon on a given file selector entry widget's button
6888     *
6889     * @param obj The file selector entry widget
6890     * @param icon The icon object for the entry's button
6891     *
6892     * Once the icon object is set, a previously set one will be
6893     * deleted. If you want to keep the latter, use the
6894     * elm_fileselector_entry_button_icon_unset() function.
6895     *
6896     * @see elm_fileselector_entry_button_icon_get()
6897     */
6898    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6899
6900    /**
6901     * Get the icon set for a given file selector entry widget's button
6902     *
6903     * @param obj The file selector entry widget
6904     * @return The icon object currently set on @p obj widget's button
6905     * or @c NULL, if none is
6906     *
6907     * @see elm_fileselector_entry_button_icon_set()
6908     */
6909    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6910
6911    /**
6912     * Unset the icon used in a given file selector entry widget's
6913     * button
6914     *
6915     * @param obj The file selector entry widget
6916     * @return The icon object that was being used on @p obj widget's
6917     * button or @c NULL, on errors
6918     *
6919     * Unparent and return the icon object which was set for this
6920     * widget's button.
6921     *
6922     * @see elm_fileselector_entry_button_icon_set()
6923     */
6924    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6925
6926    /**
6927     * Set the title for a given file selector entry widget's window
6928     *
6929     * @param obj The file selector entry widget
6930     * @param title The title string
6931     *
6932     * This will change the window's title, when the file selector pops
6933     * out after a click on the entry's button. Those windows have the
6934     * default (unlocalized) value of @c "Select a file" as titles.
6935     *
6936     * @note It will only take any effect if the file selector
6937     * entry widget is @b not under "inwin mode".
6938     *
6939     * @see elm_fileselector_entry_window_title_get()
6940     */
6941    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6942
6943    /**
6944     * Get the title set for a given file selector entry widget's
6945     * window
6946     *
6947     * @param obj The file selector entry widget
6948     * @return Title of the file selector entry's window
6949     *
6950     * @see elm_fileselector_entry_window_title_get() for more details
6951     */
6952    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6953
6954    /**
6955     * Set the size of a given file selector entry widget's window,
6956     * holding the file selector itself.
6957     *
6958     * @param obj The file selector entry widget
6959     * @param width The window's width
6960     * @param height The window's height
6961     *
6962     * @note it will only take any effect if the file selector entry
6963     * widget is @b not under "inwin mode". The default size for the
6964     * window (when applicable) is 400x400 pixels.
6965     *
6966     * @see elm_fileselector_entry_window_size_get()
6967     */
6968    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6969
6970    /**
6971     * Get the size of a given file selector entry widget's window,
6972     * holding the file selector itself.
6973     *
6974     * @param obj The file selector entry widget
6975     * @param width Pointer into which to store the width value
6976     * @param height Pointer into which to store the height value
6977     *
6978     * @note Use @c NULL pointers on the size values you're not
6979     * interested in: they'll be ignored by the function.
6980     *
6981     * @see elm_fileselector_entry_window_size_set(), for more details
6982     */
6983    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6984
6985    /**
6986     * Set the initial file system path and the entry's path string for
6987     * a given file selector entry widget
6988     *
6989     * @param obj The file selector entry widget
6990     * @param path The path string
6991     *
6992     * It must be a <b>directory</b> path, which will have the contents
6993     * displayed initially in the file selector's view, when invoked
6994     * from @p obj. The default initial path is the @c "HOME"
6995     * environment variable's value.
6996     *
6997     * @see elm_fileselector_entry_path_get()
6998     */
6999    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7000
7001    /**
7002     * Get the entry's path string for a given file selector entry
7003     * widget
7004     *
7005     * @param obj The file selector entry widget
7006     * @return path The path string
7007     *
7008     * @see elm_fileselector_entry_path_set() for more details
7009     */
7010    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7011
7012    /**
7013     * Enable/disable a tree view in the given file selector entry
7014     * widget's internal file selector
7015     *
7016     * @param obj The file selector entry widget
7017     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7018     * disable
7019     *
7020     * This has the same effect as elm_fileselector_expandable_set(),
7021     * but now applied to a file selector entry's internal file
7022     * selector.
7023     *
7024     * @note There's no way to put a file selector entry's internal
7025     * file selector in "grid mode", as one may do with "pure" file
7026     * selectors.
7027     *
7028     * @see elm_fileselector_expandable_get()
7029     */
7030    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7031
7032    /**
7033     * Get whether tree view is enabled for the given file selector
7034     * entry widget's internal file selector
7035     *
7036     * @param obj The file selector entry widget
7037     * @return @c EINA_TRUE if @p obj widget's internal file selector
7038     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7039     *
7040     * @see elm_fileselector_expandable_set() for more details
7041     */
7042    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7043
7044    /**
7045     * Set whether a given file selector entry widget's internal file
7046     * selector is to display folders only or the directory contents,
7047     * as well.
7048     *
7049     * @param obj The file selector entry widget
7050     * @param only @c EINA_TRUE to make @p obj widget's internal file
7051     * selector only display directories, @c EINA_FALSE to make files
7052     * to be displayed in it too
7053     *
7054     * This has the same effect as elm_fileselector_folder_only_set(),
7055     * but now applied to a file selector entry's internal file
7056     * selector.
7057     *
7058     * @see elm_fileselector_folder_only_get()
7059     */
7060    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7061
7062    /**
7063     * Get whether a given file selector entry widget's internal file
7064     * selector is displaying folders only or the directory contents,
7065     * as well.
7066     *
7067     * @param obj The file selector entry widget
7068     * @return @c EINA_TRUE if @p obj widget's internal file
7069     * selector is only displaying directories, @c EINA_FALSE if files
7070     * are being displayed in it too (and on errors)
7071     *
7072     * @see elm_fileselector_entry_folder_only_set() for more details
7073     */
7074    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7075
7076    /**
7077     * Enable/disable the file name entry box where the user can type
7078     * in a name for a file, in a given file selector entry widget's
7079     * internal file selector.
7080     *
7081     * @param obj The file selector entry widget
7082     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7083     * file selector a "saving dialog", @c EINA_FALSE otherwise
7084     *
7085     * This has the same effect as elm_fileselector_is_save_set(),
7086     * but now applied to a file selector entry's internal file
7087     * selector.
7088     *
7089     * @see elm_fileselector_is_save_get()
7090     */
7091    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7092
7093    /**
7094     * Get whether the given file selector entry widget's internal
7095     * file selector is in "saving dialog" mode
7096     *
7097     * @param obj The file selector entry widget
7098     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7099     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7100     * errors)
7101     *
7102     * @see elm_fileselector_entry_is_save_set() for more details
7103     */
7104    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7105
7106    /**
7107     * Set whether a given file selector entry widget's internal file
7108     * selector will raise an Elementary "inner window", instead of a
7109     * dedicated Elementary window. By default, it won't.
7110     *
7111     * @param obj The file selector entry widget
7112     * @param value @c EINA_TRUE to make it use an inner window, @c
7113     * EINA_TRUE to make it use a dedicated window
7114     *
7115     * @see elm_win_inwin_add() for more information on inner windows
7116     * @see elm_fileselector_entry_inwin_mode_get()
7117     */
7118    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7119
7120    /**
7121     * Get whether a given file selector entry widget's internal file
7122     * selector will raise an Elementary "inner window", instead of a
7123     * dedicated Elementary window.
7124     *
7125     * @param obj The file selector entry widget
7126     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7127     * if it will use a dedicated window
7128     *
7129     * @see elm_fileselector_entry_inwin_mode_set() for more details
7130     */
7131    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7132
7133    /**
7134     * Set the initial file system path for a given file selector entry
7135     * widget
7136     *
7137     * @param obj The file selector entry widget
7138     * @param path The path string
7139     *
7140     * It must be a <b>directory</b> path, which will have the contents
7141     * displayed initially in the file selector's view, when invoked
7142     * from @p obj. The default initial path is the @c "HOME"
7143     * environment variable's value.
7144     *
7145     * @see elm_fileselector_entry_path_get()
7146     */
7147    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7148
7149    /**
7150     * Get the parent directory's path to the latest file selection on
7151     * a given filer selector entry widget
7152     *
7153     * @param obj The file selector object
7154     * @return The (full) path of the directory of the last selection
7155     * on @p obj widget, a @b stringshared string
7156     *
7157     * @see elm_fileselector_entry_path_set()
7158     */
7159    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7160
7161    /**
7162     * @}
7163     */
7164
7165    /**
7166     * @defgroup Scroller Scroller
7167     *
7168     * A scroller holds a single object and "scrolls it around". This means that
7169     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7170     * region around, allowing to move through a much larger object that is
7171     * contained in the scroller. The scroller will always have a small minimum
7172     * size by default as it won't be limited by the contents of the scroller.
7173     *
7174     * Signals that you can add callbacks for are:
7175     * @li "edge,left" - the left edge of the content has been reached
7176     * @li "edge,right" - the right edge of the content has been reached
7177     * @li "edge,top" - the top edge of the content has been reached
7178     * @li "edge,bottom" - the bottom edge of the content has been reached
7179     * @li "scroll" - the content has been scrolled (moved)
7180     * @li "scroll,anim,start" - scrolling animation has started
7181     * @li "scroll,anim,stop" - scrolling animation has stopped
7182     * @li "scroll,drag,start" - dragging the contents around has started
7183     * @li "scroll,drag,stop" - dragging the contents around has stopped
7184     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7185     * user intervetion.
7186     *
7187     * @note When Elemementary is in embedded mode the scrollbars will not be
7188     * dragable, they appear merely as indicators of how much has been scrolled.
7189     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7190     * fingerscroll) won't work.
7191     *
7192     * Default contents parts of the scroller widget that you can use for are:
7193     * @li "default" - A content of the scroller
7194     *
7195     * In @ref tutorial_scroller you'll find an example of how to use most of
7196     * this API.
7197     * @{
7198     */
7199    /**
7200     * @brief Type that controls when scrollbars should appear.
7201     *
7202     * @see elm_scroller_policy_set()
7203     */
7204    typedef enum _Elm_Scroller_Policy
7205      {
7206         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7207         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7208         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7209         ELM_SCROLLER_POLICY_LAST
7210      } Elm_Scroller_Policy;
7211    /**
7212     * @brief Add a new scroller to the parent
7213     *
7214     * @param parent The parent object
7215     * @return The new object or NULL if it cannot be created
7216     */
7217    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7218    /**
7219     * @brief Set the content of the scroller widget (the object to be scrolled around).
7220     *
7221     * @param obj The scroller object
7222     * @param content The new content object
7223     *
7224     * Once the content object is set, a previously set one will be deleted.
7225     * If you want to keep that old content object, use the
7226     * elm_scroller_content_unset() function.
7227     * @deprecated use elm_object_content_set() instead
7228     */
7229    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7230    /**
7231     * @brief Get the content of the scroller widget
7232     *
7233     * @param obj The slider object
7234     * @return The content that is being used
7235     *
7236     * Return the content object which is set for this widget
7237     *
7238     * @see elm_scroller_content_set()
7239     * @deprecated use elm_object_content_get() instead.
7240     */
7241    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7242    /**
7243     * @brief Unset the content of the scroller widget
7244     *
7245     * @param obj The slider object
7246     * @return The content that was being used
7247     *
7248     * Unparent and return the content object which was set for this widget
7249     *
7250     * @see elm_scroller_content_set()
7251     * @deprecated use elm_object_content_unset() instead.
7252     */
7253    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7254    /**
7255     * @brief Set custom theme elements for the scroller
7256     *
7257     * @param obj The scroller object
7258     * @param widget The widget name to use (default is "scroller")
7259     * @param base The base name to use (default is "base")
7260     */
7261    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7262    /**
7263     * @brief Make the scroller minimum size limited to the minimum size of the content
7264     *
7265     * @param obj The scroller object
7266     * @param w Enable limiting minimum size horizontally
7267     * @param h Enable limiting minimum size vertically
7268     *
7269     * By default the scroller will be as small as its design allows,
7270     * irrespective of its content. This will make the scroller minimum size the
7271     * right size horizontally and/or vertically to perfectly fit its content in
7272     * that direction.
7273     */
7274    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7275    /**
7276     * @brief Show a specific virtual region within the scroller content object
7277     *
7278     * @param obj The scroller object
7279     * @param x X coordinate of the region
7280     * @param y Y coordinate of the region
7281     * @param w Width of the region
7282     * @param h Height of the region
7283     *
7284     * This will ensure all (or part if it does not fit) of the designated
7285     * region in the virtual content object (0, 0 starting at the top-left of the
7286     * virtual content object) is shown within the scroller.
7287     */
7288    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);
7289    /**
7290     * @brief Set the scrollbar visibility policy
7291     *
7292     * @param obj The scroller object
7293     * @param policy_h Horizontal scrollbar policy
7294     * @param policy_v Vertical scrollbar policy
7295     *
7296     * This sets the scrollbar visibility policy for the given scroller.
7297     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7298     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7299     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7300     * respectively for the horizontal and vertical scrollbars.
7301     */
7302    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7303    /**
7304     * @brief Gets scrollbar visibility policy
7305     *
7306     * @param obj The scroller object
7307     * @param policy_h Horizontal scrollbar policy
7308     * @param policy_v Vertical scrollbar policy
7309     *
7310     * @see elm_scroller_policy_set()
7311     */
7312    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7313    /**
7314     * @brief Get the currently visible content region
7315     *
7316     * @param obj The scroller object
7317     * @param x X coordinate of the region
7318     * @param y Y coordinate of the region
7319     * @param w Width of the region
7320     * @param h Height of the region
7321     *
7322     * This gets the current region in the content object that is visible through
7323     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7324     * w, @p h values pointed to.
7325     *
7326     * @note All coordinates are relative to the content.
7327     *
7328     * @see elm_scroller_region_show()
7329     */
7330    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);
7331    /**
7332     * @brief Get the size of the content object
7333     *
7334     * @param obj The scroller object
7335     * @param w Width of the content object.
7336     * @param h Height of the content object.
7337     *
7338     * This gets the size of the content object of the scroller.
7339     */
7340    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7341    /**
7342     * @brief Set bouncing behavior
7343     *
7344     * @param obj The scroller object
7345     * @param h_bounce Allow bounce horizontally
7346     * @param v_bounce Allow bounce vertically
7347     *
7348     * When scrolling, the scroller may "bounce" when reaching an edge of the
7349     * content object. This is a visual way to indicate the end has been reached.
7350     * This is enabled by default for both axis. This API will set if it is enabled
7351     * for the given axis with the boolean parameters for each axis.
7352     */
7353    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7354    /**
7355     * @brief Get the bounce behaviour
7356     *
7357     * @param obj The Scroller object
7358     * @param h_bounce Will the scroller bounce horizontally or not
7359     * @param v_bounce Will the scroller bounce vertically or not
7360     *
7361     * @see elm_scroller_bounce_set()
7362     */
7363    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7364    /**
7365     * @brief Set scroll page size relative to viewport size.
7366     *
7367     * @param obj The scroller object
7368     * @param h_pagerel The horizontal page relative size
7369     * @param v_pagerel The vertical page relative size
7370     *
7371     * The scroller is capable of limiting scrolling by the user to "pages". That
7372     * is to jump by and only show a "whole page" at a time as if the continuous
7373     * area of the scroller content is split into page sized pieces. This sets
7374     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7375     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7376     * axis. This is mutually exclusive with page size
7377     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7378     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7379     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7380     * the other axis.
7381     */
7382    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7383    /**
7384     * @brief Set scroll page size.
7385     *
7386     * @param obj The scroller object
7387     * @param h_pagesize The horizontal page size
7388     * @param v_pagesize The vertical page size
7389     *
7390     * This sets the page size to an absolute fixed value, with 0 turning it off
7391     * for that axis.
7392     *
7393     * @see elm_scroller_page_relative_set()
7394     */
7395    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7396    /**
7397     * @brief Get scroll current page number.
7398     *
7399     * @param obj The scroller object
7400     * @param h_pagenumber The horizontal page number
7401     * @param v_pagenumber The vertical page number
7402     *
7403     * The page number starts from 0. 0 is the first page.
7404     * Current page means the page which meets the top-left of the viewport.
7405     * If there are two or more pages in the viewport, it returns the number of the page
7406     * which meets the top-left of the viewport.
7407     *
7408     * @see elm_scroller_last_page_get()
7409     * @see elm_scroller_page_show()
7410     * @see elm_scroller_page_brint_in()
7411     */
7412    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7413    /**
7414     * @brief Get scroll last page number.
7415     *
7416     * @param obj The scroller object
7417     * @param h_pagenumber The horizontal page number
7418     * @param v_pagenumber The vertical page number
7419     *
7420     * The page number starts from 0. 0 is the first page.
7421     * This returns the last page number among the pages.
7422     *
7423     * @see elm_scroller_current_page_get()
7424     * @see elm_scroller_page_show()
7425     * @see elm_scroller_page_brint_in()
7426     */
7427    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7428    /**
7429     * Show a specific virtual region within the scroller content object by page number.
7430     *
7431     * @param obj The scroller object
7432     * @param h_pagenumber The horizontal page number
7433     * @param v_pagenumber The vertical page number
7434     *
7435     * 0, 0 of the indicated page is located at the top-left of the viewport.
7436     * This will jump to the page directly without animation.
7437     *
7438     * Example of usage:
7439     *
7440     * @code
7441     * sc = elm_scroller_add(win);
7442     * elm_scroller_content_set(sc, content);
7443     * elm_scroller_page_relative_set(sc, 1, 0);
7444     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7445     * elm_scroller_page_show(sc, h_page + 1, v_page);
7446     * @endcode
7447     *
7448     * @see elm_scroller_page_bring_in()
7449     */
7450    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7451    /**
7452     * Show a specific virtual region within the scroller content object by page number.
7453     *
7454     * @param obj The scroller object
7455     * @param h_pagenumber The horizontal page number
7456     * @param v_pagenumber The vertical page number
7457     *
7458     * 0, 0 of the indicated page is located at the top-left of the viewport.
7459     * This will slide to the page with animation.
7460     *
7461     * Example of usage:
7462     *
7463     * @code
7464     * sc = elm_scroller_add(win);
7465     * elm_scroller_content_set(sc, content);
7466     * elm_scroller_page_relative_set(sc, 1, 0);
7467     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7468     * elm_scroller_page_bring_in(sc, h_page, v_page);
7469     * @endcode
7470     *
7471     * @see elm_scroller_page_show()
7472     */
7473    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7474    /**
7475     * @brief Show a specific virtual region within the scroller content object.
7476     *
7477     * @param obj The scroller object
7478     * @param x X coordinate of the region
7479     * @param y Y coordinate of the region
7480     * @param w Width of the region
7481     * @param h Height of the region
7482     *
7483     * This will ensure all (or part if it does not fit) of the designated
7484     * region in the virtual content object (0, 0 starting at the top-left of the
7485     * virtual content object) is shown within the scroller. Unlike
7486     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7487     * to this location (if configuration in general calls for transitions). It
7488     * may not jump immediately to the new location and make take a while and
7489     * show other content along the way.
7490     *
7491     * @see elm_scroller_region_show()
7492     */
7493    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);
7494    /**
7495     * @brief Set event propagation on a scroller
7496     *
7497     * @param obj The scroller object
7498     * @param propagation If propagation is enabled or not
7499     *
7500     * This enables or disabled event propagation from the scroller content to
7501     * the scroller and its parent. By default event propagation is disabled.
7502     */
7503    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7504    /**
7505     * @brief Get event propagation for a scroller
7506     *
7507     * @param obj The scroller object
7508     * @return The propagation state
7509     *
7510     * This gets the event propagation for a scroller.
7511     *
7512     * @see elm_scroller_propagate_events_set()
7513     */
7514    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7515    /**
7516     * @brief Set scrolling gravity on a scroller
7517     *
7518     * @param obj The scroller object
7519     * @param x The scrolling horizontal gravity
7520     * @param y The scrolling vertical gravity
7521     *
7522     * The gravity, defines how the scroller will adjust its view
7523     * when the size of the scroller contents increase.
7524     *
7525     * The scroller will adjust the view to glue itself as follows.
7526     *
7527     *  x=0.0, for showing the left most region of the content.
7528     *  x=1.0, for showing the right most region of the content.
7529     *  y=0.0, for showing the bottom most region of the content.
7530     *  y=1.0, for showing the top most region of the content.
7531     *
7532     * Default values for x and y are 0.0
7533     */
7534    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7535    /**
7536     * @brief Get scrolling gravity values for a scroller
7537     *
7538     * @param obj The scroller object
7539     * @param x The scrolling horizontal gravity
7540     * @param y The scrolling vertical gravity
7541     *
7542     * This gets gravity values for a scroller.
7543     *
7544     * @see elm_scroller_gravity_set()
7545     *
7546     */
7547    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7548    /**
7549     * @}
7550     */
7551
7552    /**
7553     * @defgroup Label Label
7554     *
7555     * @image html img/widget/label/preview-00.png
7556     * @image latex img/widget/label/preview-00.eps
7557     *
7558     * @brief Widget to display text, with simple html-like markup.
7559     *
7560     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7561     * text doesn't fit the geometry of the label it will be ellipsized or be
7562     * cut. Elementary provides several themes for this widget:
7563     * @li default - No animation
7564     * @li marker - Centers the text in the label and make it bold by default
7565     * @li slide_long - The entire text appears from the right of the screen and
7566     * slides until it disappears in the left of the screen(reappering on the
7567     * right again).
7568     * @li slide_short - The text appears in the left of the label and slides to
7569     * the right to show the overflow. When all of the text has been shown the
7570     * position is reset.
7571     * @li slide_bounce - The text appears in the left of the label and slides to
7572     * the right to show the overflow. When all of the text has been shown the
7573     * animation reverses, moving the text to the left.
7574     *
7575     * Custom themes can of course invent new markup tags and style them any way
7576     * they like.
7577     *
7578     * The following signals may be emitted by the label widget:
7579     * @li "language,changed": The program's language changed.
7580     *
7581     * See @ref tutorial_label for a demonstration of how to use a label widget.
7582     * @{
7583     */
7584    /**
7585     * @brief Add a new label to the parent
7586     *
7587     * @param parent The parent object
7588     * @return The new object or NULL if it cannot be created
7589     */
7590    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7591    /**
7592     * @brief Set the label on the label object
7593     *
7594     * @param obj The label object
7595     * @param label The label will be used on the label object
7596     * @deprecated See elm_object_text_set()
7597     */
7598    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 */
7599    /**
7600     * @brief Get the label used on the label object
7601     *
7602     * @param obj The label object
7603     * @return The string inside the label
7604     * @deprecated See elm_object_text_get()
7605     */
7606    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7607    /**
7608     * @brief Set the wrapping behavior of the label
7609     *
7610     * @param obj The label object
7611     * @param wrap To wrap text or not
7612     *
7613     * By default no wrapping is done. Possible values for @p wrap are:
7614     * @li ELM_WRAP_NONE - No wrapping
7615     * @li ELM_WRAP_CHAR - wrap between characters
7616     * @li ELM_WRAP_WORD - wrap between words
7617     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7618     */
7619    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7620    /**
7621     * @brief Get the wrapping behavior of the label
7622     *
7623     * @param obj The label object
7624     * @return Wrap type
7625     *
7626     * @see elm_label_line_wrap_set()
7627     */
7628    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7629    /**
7630     * @brief Set wrap width of the label
7631     *
7632     * @param obj The label object
7633     * @param w The wrap width in pixels at a minimum where words need to wrap
7634     *
7635     * This function sets the maximum width size hint of the label.
7636     *
7637     * @warning This is only relevant if the label is inside a container.
7638     */
7639    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7640    /**
7641     * @brief Get wrap width of the label
7642     *
7643     * @param obj The label object
7644     * @return The wrap width in pixels at a minimum where words need to wrap
7645     *
7646     * @see elm_label_wrap_width_set()
7647     */
7648    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7649    /**
7650     * @brief Set wrap height of the label
7651     *
7652     * @param obj The label object
7653     * @param h The wrap height in pixels at a minimum where words need to wrap
7654     *
7655     * This function sets the maximum height size hint of the label.
7656     *
7657     * @warning This is only relevant if the label is inside a container.
7658     */
7659    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7660    /**
7661     * @brief get wrap width of the label
7662     *
7663     * @param obj The label object
7664     * @return The wrap height in pixels at a minimum where words need to wrap
7665     */
7666    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7667    /**
7668     * @brief Set the font size on the label object.
7669     *
7670     * @param obj The label object
7671     * @param size font size
7672     *
7673     * @warning NEVER use this. It is for hyper-special cases only. use styles
7674     * instead. e.g. "big", "medium", "small" - or better name them by use:
7675     * "title", "footnote", "quote" etc.
7676     */
7677    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7678    /**
7679     * @brief Set the text color on the label object
7680     *
7681     * @param obj The label object
7682     * @param r Red property background color of The label object
7683     * @param g Green property background color of The label object
7684     * @param b Blue property background color of The label object
7685     * @param a Alpha property background color of The label object
7686     *
7687     * @warning NEVER use this. It is for hyper-special cases only. use styles
7688     * instead. e.g. "big", "medium", "small" - or better name them by use:
7689     * "title", "footnote", "quote" etc.
7690     */
7691    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);
7692    /**
7693     * @brief Set the text align on the label object
7694     *
7695     * @param obj The label object
7696     * @param align align mode ("left", "center", "right")
7697     *
7698     * @warning NEVER use this. It is for hyper-special cases only. use styles
7699     * instead. e.g. "big", "medium", "small" - or better name them by use:
7700     * "title", "footnote", "quote" etc.
7701     */
7702    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7703    /**
7704     * @brief Set background color of the label
7705     *
7706     * @param obj The label object
7707     * @param r Red property background color of The label object
7708     * @param g Green property background color of The label object
7709     * @param b Blue property background color of The label object
7710     * @param a Alpha property background alpha of The label object
7711     *
7712     * @warning NEVER use this. It is for hyper-special cases only. use styles
7713     * instead. e.g. "big", "medium", "small" - or better name them by use:
7714     * "title", "footnote", "quote" etc.
7715     */
7716    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);
7717    /**
7718     * @brief Set the ellipsis behavior of the label
7719     *
7720     * @param obj The label object
7721     * @param ellipsis To ellipsis text or not
7722     *
7723     * If set to true and the text doesn't fit in the label an ellipsis("...")
7724     * will be shown at the end of the widget.
7725     *
7726     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7727     * choosen wrap method was ELM_WRAP_WORD.
7728     */
7729    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7730    EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7731    /**
7732     * @brief Set the text slide of the label
7733     *
7734     * @param obj The label object
7735     * @param slide To start slide or stop
7736     *
7737     * If set to true, the text of the label will slide/scroll through the length of
7738     * label.
7739     *
7740     * @warning This only works with the themes "slide_short", "slide_long" and
7741     * "slide_bounce".
7742     */
7743    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7744    /**
7745     * @brief Get the text slide mode of the label
7746     *
7747     * @param obj The label object
7748     * @return slide slide mode value
7749     *
7750     * @see elm_label_slide_set()
7751     */
7752    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7753    /**
7754     * @brief Set the slide duration(speed) of the label
7755     *
7756     * @param obj The label object
7757     * @return The duration in seconds in moving text from slide begin position
7758     * to slide end position
7759     */
7760    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7761    /**
7762     * @brief Get the slide duration(speed) of the label
7763     *
7764     * @param obj The label object
7765     * @return The duration time in moving text from slide begin position to slide end position
7766     *
7767     * @see elm_label_slide_duration_set()
7768     */
7769    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7770    /**
7771     * @}
7772     */
7773
7774    /**
7775     * @defgroup Frame Frame
7776     *
7777     * @image html img/widget/frame/preview-00.png
7778     * @image latex img/widget/frame/preview-00.eps
7779     *
7780     * @brief Frame is a widget that holds some content and has a title.
7781     *
7782     * The default look is a frame with a title, but Frame supports multple
7783     * styles:
7784     * @li default
7785     * @li pad_small
7786     * @li pad_medium
7787     * @li pad_large
7788     * @li pad_huge
7789     * @li outdent_top
7790     * @li outdent_bottom
7791     *
7792     * Of all this styles only default shows the title. Frame emits no signals.
7793     *
7794     * Default contents parts of the frame widget that you can use for are:
7795     * @li "default" - A content of the frame
7796     *
7797     * Default text parts of the frame widget that you can use for are:
7798     * @li "elm.text" - Label of the frame
7799     *
7800     * For a detailed example see the @ref tutorial_frame.
7801     *
7802     * @{
7803     */
7804    /**
7805     * @brief Add a new frame to the parent
7806     *
7807     * @param parent The parent object
7808     * @return The new object or NULL if it cannot be created
7809     */
7810    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7811    /**
7812     * @brief Set the frame label
7813     *
7814     * @param obj The frame object
7815     * @param label The label of this frame object
7816     *
7817     * @deprecated use elm_object_text_set() instead.
7818     */
7819    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7820    /**
7821     * @brief Get the frame label
7822     *
7823     * @param obj The frame object
7824     *
7825     * @return The label of this frame objet or NULL if unable to get frame
7826     *
7827     * @deprecated use elm_object_text_get() instead.
7828     */
7829    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7830    /**
7831     * @brief Set the content of the frame widget
7832     *
7833     * Once the content object is set, a previously set one will be deleted.
7834     * If you want to keep that old content object, use the
7835     * elm_frame_content_unset() function.
7836     *
7837     * @param obj The frame object
7838     * @param content The content will be filled in this frame object
7839     *
7840     * @deprecated use elm_object_content_set() instead.
7841     */
7842    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7843    /**
7844     * @brief Get the content of the frame widget
7845     *
7846     * Return the content object which is set for this widget
7847     *
7848     * @param obj The frame object
7849     * @return The content that is being used
7850     *
7851     * @deprecated use elm_object_content_get() instead.
7852     */
7853    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7854    /**
7855     * @brief Unset the content of the frame widget
7856     *
7857     * Unparent and return the content object which was set for this widget
7858     *
7859     * @param obj The frame object
7860     * @return The content that was being used
7861     *
7862     * @deprecated use elm_object_content_unset() instead.
7863     */
7864    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7865    /**
7866     * @}
7867     */
7868
7869    /**
7870     * @defgroup Table Table
7871     *
7872     * A container widget to arrange other widgets in a table where items can
7873     * also span multiple columns or rows - even overlap (and then be raised or
7874     * lowered accordingly to adjust stacking if they do overlap).
7875     *
7876     * For a Table widget the row/column count is not fixed.
7877     * The table widget adjusts itself when subobjects are added to it dynamically.
7878     *
7879     * The followin are examples of how to use a table:
7880     * @li @ref tutorial_table_01
7881     * @li @ref tutorial_table_02
7882     *
7883     * @{
7884     */
7885    /**
7886     * @brief Add a new table to the parent
7887     *
7888     * @param parent The parent object
7889     * @return The new object or NULL if it cannot be created
7890     */
7891    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7892    /**
7893     * @brief Set the homogeneous layout in the table
7894     *
7895     * @param obj The layout object
7896     * @param homogeneous A boolean to set if the layout is homogeneous in the
7897     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7898     */
7899    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7900    /**
7901     * @brief Get the current table homogeneous mode.
7902     *
7903     * @param obj The table object
7904     * @return A boolean to indicating if the layout is homogeneous in the table
7905     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7906     */
7907    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7908    /**
7909     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7910     */
7911    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7912    /**
7913     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7914     */
7915    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7916    /**
7917     * @brief Set padding between cells.
7918     *
7919     * @param obj The layout object.
7920     * @param horizontal set the horizontal padding.
7921     * @param vertical set the vertical padding.
7922     *
7923     * Default value is 0.
7924     */
7925    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7926    /**
7927     * @brief Get padding between cells.
7928     *
7929     * @param obj The layout object.
7930     * @param horizontal set the horizontal padding.
7931     * @param vertical set the vertical padding.
7932     */
7933    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7934    /**
7935     * @brief Add a subobject on the table with the coordinates passed
7936     *
7937     * @param obj The table object
7938     * @param subobj The subobject to be added to the table
7939     * @param x Row number
7940     * @param y Column number
7941     * @param w rowspan
7942     * @param h colspan
7943     *
7944     * @note All positioning inside the table is relative to rows and columns, so
7945     * a value of 0 for x and y, means the top left cell of the table, and a
7946     * value of 1 for w and h means @p subobj only takes that 1 cell.
7947     */
7948    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7949    /**
7950     * @brief Remove child from table.
7951     *
7952     * @param obj The table object
7953     * @param subobj The subobject
7954     */
7955    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7956    /**
7957     * @brief Faster way to remove all child objects from a table object.
7958     *
7959     * @param obj The table object
7960     * @param clear If true, will delete children, else just remove from table.
7961     */
7962    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7963    /**
7964     * @brief Set the packing location of an existing child of the table
7965     *
7966     * @param subobj The subobject to be modified in the table
7967     * @param x Row number
7968     * @param y Column number
7969     * @param w rowspan
7970     * @param h colspan
7971     *
7972     * Modifies the position of an object already in the table.
7973     *
7974     * @note All positioning inside the table is relative to rows and columns, so
7975     * a value of 0 for x and y, means the top left cell of the table, and a
7976     * value of 1 for w and h means @p subobj only takes that 1 cell.
7977     */
7978    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7979    /**
7980     * @brief Get the packing location of an existing child of the table
7981     *
7982     * @param subobj The subobject to be modified in the table
7983     * @param x Row number
7984     * @param y Column number
7985     * @param w rowspan
7986     * @param h colspan
7987     *
7988     * @see elm_table_pack_set()
7989     */
7990    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7991    /**
7992     * @}
7993     */
7994
7995    /**
7996     * @defgroup Gengrid Gengrid (Generic grid)
7997     *
7998     * This widget aims to position objects in a grid layout while
7999     * actually creating and rendering only the visible ones, using the
8000     * same idea as the @ref Genlist "genlist": the user defines a @b
8001     * class for each item, specifying functions that will be called at
8002     * object creation, deletion, etc. When those items are selected by
8003     * the user, a callback function is issued. Users may interact with
8004     * a gengrid via the mouse (by clicking on items to select them and
8005     * clicking on the grid's viewport and swiping to pan the whole
8006     * view) or via the keyboard, navigating through item with the
8007     * arrow keys.
8008     *
8009     * @section Gengrid_Layouts Gengrid layouts
8010     *
8011     * Gengrid may layout its items in one of two possible layouts:
8012     * - horizontal or
8013     * - vertical.
8014     *
8015     * When in "horizontal mode", items will be placed in @b columns,
8016     * from top to bottom and, when the space for a column is filled,
8017     * another one is started on the right, thus expanding the grid
8018     * horizontally, making for horizontal scrolling. When in "vertical
8019     * mode" , though, items will be placed in @b rows, from left to
8020     * right and, when the space for a row is filled, another one is
8021     * started below, thus expanding the grid vertically (and making
8022     * for vertical scrolling).
8023     *
8024     * @section Gengrid_Items Gengrid items
8025     *
8026     * An item in a gengrid can have 0 or more text labels (they can be
8027     * regular text or textblock Evas objects - that's up to the style
8028     * to determine), 0 or more icons (which are simply objects
8029     * swallowed into the gengrid item's theming Edje object) and 0 or
8030     * more <b>boolean states</b>, which have the behavior left to the
8031     * user to define. The Edje part names for each of these properties
8032     * will be looked up, in the theme file for the gengrid, under the
8033     * Edje (string) data items named @c "labels", @c "icons" and @c
8034     * "states", respectively. For each of those properties, if more
8035     * than one part is provided, they must have names listed separated
8036     * by spaces in the data fields. For the default gengrid item
8037     * theme, we have @b one label part (@c "elm.text"), @b two icon
8038     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8039     * no state parts.
8040     *
8041     * A gengrid item may be at one of several styles. Elementary
8042     * provides one by default - "default", but this can be extended by
8043     * system or application custom themes/overlays/extensions (see
8044     * @ref Theme "themes" for more details).
8045     *
8046     * @section Gengrid_Item_Class Gengrid item classes
8047     *
8048     * In order to have the ability to add and delete items on the fly,
8049     * gengrid implements a class (callback) system where the
8050     * application provides a structure with information about that
8051     * type of item (gengrid may contain multiple different items with
8052     * different classes, states and styles). Gengrid will call the
8053     * functions in this struct (methods) when an item is "realized"
8054     * (i.e., created dynamically, while the user is scrolling the
8055     * grid). All objects will simply be deleted when no longer needed
8056     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8057     * contains the following members:
8058     * - @c item_style - This is a constant string and simply defines
8059     * the name of the item style. It @b must be specified and the
8060     * default should be @c "default".
8061     * - @c func.label_get - This function is called when an item
8062     * object is actually created. The @c data parameter will point to
8063     * the same data passed to elm_gengrid_item_append() and related
8064     * item creation functions. The @c obj parameter is the gengrid
8065     * object itself, while the @c part one is the name string of one
8066     * of the existing text parts in the Edje group implementing the
8067     * item's theme. This function @b must return a strdup'()ed string,
8068     * as the caller will free() it when done. See
8069     * #Elm_Gengrid_Item_Label_Get_Cb.
8070     * - @c func.content_get - This function is called when an item object
8071     * is actually created. The @c data parameter will point to the
8072     * same data passed to elm_gengrid_item_append() and related item
8073     * creation functions. The @c obj parameter is the gengrid object
8074     * itself, while the @c part one is the name string of one of the
8075     * existing (content) swallow parts in the Edje group implementing the
8076     * item's theme. It must return @c NULL, when no content is desired,
8077     * or a valid object handle, otherwise. The object will be deleted
8078     * by the gengrid on its deletion or when the item is "unrealized".
8079     * See #Elm_Gengrid_Item_Content_Get_Cb.
8080     * - @c func.state_get - This function is called when an item
8081     * object is actually created. The @c data parameter will point to
8082     * the same data passed to elm_gengrid_item_append() and related
8083     * item creation functions. The @c obj parameter is the gengrid
8084     * object itself, while the @c part one is the name string of one
8085     * of the state parts in the Edje group implementing the item's
8086     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8087     * true/on. Gengrids will emit a signal to its theming Edje object
8088     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8089     * "source" arguments, respectively, when the state is true (the
8090     * default is false), where @c XXX is the name of the (state) part.
8091     * See #Elm_Gengrid_Item_State_Get_Cb.
8092     * - @c func.del - This is called when elm_gengrid_item_del() is
8093     * called on an item or elm_gengrid_clear() is called on the
8094     * gengrid. This is intended for use when gengrid items are
8095     * deleted, so any data attached to the item (e.g. its data
8096     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8097     *
8098     * @section Gengrid_Usage_Hints Usage hints
8099     *
8100     * If the user wants to have multiple items selected at the same
8101     * time, elm_gengrid_multi_select_set() will permit it. If the
8102     * gengrid is single-selection only (the default), then
8103     * elm_gengrid_select_item_get() will return the selected item or
8104     * @c NULL, if none is selected. If the gengrid is under
8105     * multi-selection, then elm_gengrid_selected_items_get() will
8106     * return a list (that is only valid as long as no items are
8107     * modified (added, deleted, selected or unselected) of child items
8108     * on a gengrid.
8109     *
8110     * If an item changes (internal (boolean) state, label or content 
8111     * changes), then use elm_gengrid_item_update() to have gengrid
8112     * update the item with the new state. A gengrid will re-"realize"
8113     * the item, thus calling the functions in the
8114     * #Elm_Gengrid_Item_Class set for that item.
8115     *
8116     * To programmatically (un)select an item, use
8117     * elm_gengrid_item_selected_set(). To get its selected state use
8118     * elm_gengrid_item_selected_get(). To make an item disabled
8119     * (unable to be selected and appear differently) use
8120     * elm_gengrid_item_disabled_set() to set this and
8121     * elm_gengrid_item_disabled_get() to get the disabled state.
8122     *
8123     * Grid cells will only have their selection smart callbacks called
8124     * when firstly getting selected. Any further clicks will do
8125     * nothing, unless you enable the "always select mode", with
8126     * elm_gengrid_always_select_mode_set(), thus making every click to
8127     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8128     * turn off the ability to select items entirely in the widget and
8129     * they will neither appear selected nor call the selection smart
8130     * callbacks.
8131     *
8132     * Remember that you can create new styles and add your own theme
8133     * augmentation per application with elm_theme_extension_add(). If
8134     * you absolutely must have a specific style that overrides any
8135     * theme the user or system sets up you can use
8136     * elm_theme_overlay_add() to add such a file.
8137     *
8138     * @section Gengrid_Smart_Events Gengrid smart events
8139     *
8140     * Smart events that you can add callbacks for are:
8141     * - @c "activated" - The user has double-clicked or pressed
8142     *   (enter|return|spacebar) on an item. The @c event_info parameter
8143     *   is the gengrid item that was activated.
8144     * - @c "clicked,double" - The user has double-clicked an item.
8145     *   The @c event_info parameter is the gengrid item that was double-clicked.
8146     * - @c "longpressed" - This is called when the item is pressed for a certain
8147     *   amount of time. By default it's 1 second.
8148     * - @c "selected" - The user has made an item selected. The
8149     *   @c event_info parameter is the gengrid item that was selected.
8150     * - @c "unselected" - The user has made an item unselected. The
8151     *   @c event_info parameter is the gengrid item that was unselected.
8152     * - @c "realized" - This is called when the item in the gengrid
8153     *   has its implementing Evas object instantiated, de facto. @c
8154     *   event_info is the gengrid item that was created. The object
8155     *   may be deleted at any time, so it is highly advised to the
8156     *   caller @b not to use the object pointer returned from
8157     *   elm_gengrid_item_object_get(), because it may point to freed
8158     *   objects.
8159     * - @c "unrealized" - This is called when the implementing Evas
8160     *   object for this item is deleted. @c event_info is the gengrid
8161     *   item that was deleted.
8162     * - @c "changed" - Called when an item is added, removed, resized
8163     *   or moved and when the gengrid is resized or gets "horizontal"
8164     *   property changes.
8165     * - @c "scroll,anim,start" - This is called when scrolling animation has
8166     *   started.
8167     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8168     *   stopped.
8169     * - @c "drag,start,up" - Called when the item in the gengrid has
8170     *   been dragged (not scrolled) up.
8171     * - @c "drag,start,down" - Called when the item in the gengrid has
8172     *   been dragged (not scrolled) down.
8173     * - @c "drag,start,left" - Called when the item in the gengrid has
8174     *   been dragged (not scrolled) left.
8175     * - @c "drag,start,right" - Called when the item in the gengrid has
8176     *   been dragged (not scrolled) right.
8177     * - @c "drag,stop" - Called when the item in the gengrid has
8178     *   stopped being dragged.
8179     * - @c "drag" - Called when the item in the gengrid is being
8180     *   dragged.
8181     * - @c "scroll" - called when the content has been scrolled
8182     *   (moved).
8183     * - @c "scroll,drag,start" - called when dragging the content has
8184     *   started.
8185     * - @c "scroll,drag,stop" - called when dragging the content has
8186     *   stopped.
8187     * - @c "edge,top" - This is called when the gengrid is scrolled until
8188     *   the top edge.
8189     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8190     *   until the bottom edge.
8191     * - @c "edge,left" - This is called when the gengrid is scrolled
8192     *   until the left edge.
8193     * - @c "edge,right" - This is called when the gengrid is scrolled
8194     *   until the right edge.
8195     *
8196     * List of gengrid examples:
8197     * @li @ref gengrid_example
8198     */
8199
8200    /**
8201     * @addtogroup Gengrid
8202     * @{
8203     */
8204
8205    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8206    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8207    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8208    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8209    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8210    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
8211    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8212
8213    /* temporary compatibility code */
8214    typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8215    typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8216    typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8217    typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8218
8219    /**
8220     * @struct _Elm_Gengrid_Item_Class
8221     *
8222     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8223     * field details.
8224     */
8225    struct _Elm_Gengrid_Item_Class
8226      {
8227         const char             *item_style;
8228         struct _Elm_Gengrid_Item_Class_Func
8229           {
8230              Elm_Gengrid_Item_Label_Get_Cb label_get;
8231              union { /* temporary compatibility code */
8232                Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8233                Elm_Gengrid_Item_Content_Get_Cb content_get;
8234              };
8235              Elm_Gengrid_Item_State_Get_Cb state_get;
8236              Elm_Gengrid_Item_Del_Cb       del;
8237           } func;
8238      }; /**< #Elm_Gengrid_Item_Class member definitions */
8239    /**
8240     * Add a new gengrid widget to the given parent Elementary
8241     * (container) object
8242     *
8243     * @param parent The parent object
8244     * @return a new gengrid widget handle or @c NULL, on errors
8245     *
8246     * This function inserts a new gengrid widget on the canvas.
8247     *
8248     * @see elm_gengrid_item_size_set()
8249     * @see elm_gengrid_group_item_size_set()
8250     * @see elm_gengrid_horizontal_set()
8251     * @see elm_gengrid_item_append()
8252     * @see elm_gengrid_item_del()
8253     * @see elm_gengrid_clear()
8254     *
8255     * @ingroup Gengrid
8256     */
8257    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8258
8259    /**
8260     * Set the size for the items of a given gengrid widget
8261     *
8262     * @param obj The gengrid object.
8263     * @param w The items' width.
8264     * @param h The items' height;
8265     *
8266     * A gengrid, after creation, has still no information on the size
8267     * to give to each of its cells. So, you most probably will end up
8268     * with squares one @ref Fingers "finger" wide, the default
8269     * size. Use this function to force a custom size for you items,
8270     * making them as big as you wish.
8271     *
8272     * @see elm_gengrid_item_size_get()
8273     *
8274     * @ingroup Gengrid
8275     */
8276    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8277
8278    /**
8279     * Get the size set for the items of a given gengrid widget
8280     *
8281     * @param obj The gengrid object.
8282     * @param w Pointer to a variable where to store the items' width.
8283     * @param h Pointer to a variable where to store the items' height.
8284     *
8285     * @note Use @c NULL pointers on the size values you're not
8286     * interested in: they'll be ignored by the function.
8287     *
8288     * @see elm_gengrid_item_size_get() for more details
8289     *
8290     * @ingroup Gengrid
8291     */
8292    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8293
8294    /**
8295     * Set the items grid's alignment within a given gengrid widget
8296     *
8297     * @param obj The gengrid object.
8298     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8299     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8300     *
8301     * This sets the alignment of the whole grid of items of a gengrid
8302     * within its given viewport. By default, those values are both
8303     * 0.5, meaning that the gengrid will have its items grid placed
8304     * exactly in the middle of its viewport.
8305     *
8306     * @note If given alignment values are out of the cited ranges,
8307     * they'll be changed to the nearest boundary values on the valid
8308     * ranges.
8309     *
8310     * @see elm_gengrid_align_get()
8311     *
8312     * @ingroup Gengrid
8313     */
8314    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8315
8316    /**
8317     * Get the items grid's alignment values within a given gengrid
8318     * widget
8319     *
8320     * @param obj The gengrid object.
8321     * @param align_x Pointer to a variable where to store the
8322     * horizontal alignment.
8323     * @param align_y Pointer to a variable where to store the vertical
8324     * alignment.
8325     *
8326     * @note Use @c NULL pointers on the alignment values you're not
8327     * interested in: they'll be ignored by the function.
8328     *
8329     * @see elm_gengrid_align_set() for more details
8330     *
8331     * @ingroup Gengrid
8332     */
8333    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8334
8335    /**
8336     * Set whether a given gengrid widget is or not able have items
8337     * @b reordered
8338     *
8339     * @param obj The gengrid object
8340     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8341     * @c EINA_FALSE to turn it off
8342     *
8343     * If a gengrid is set to allow reordering, a click held for more
8344     * than 0.5 over a given item will highlight it specially,
8345     * signalling the gengrid has entered the reordering state. From
8346     * that time on, the user will be able to, while still holding the
8347     * mouse button down, move the item freely in the gengrid's
8348     * viewport, replacing to said item to the locations it goes to.
8349     * The replacements will be animated and, whenever the user
8350     * releases the mouse button, the item being replaced gets a new
8351     * definitive place in the grid.
8352     *
8353     * @see elm_gengrid_reorder_mode_get()
8354     *
8355     * @ingroup Gengrid
8356     */
8357    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8358
8359    /**
8360     * Get whether a given gengrid widget is or not able have items
8361     * @b reordered
8362     *
8363     * @param obj The gengrid object
8364     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8365     * off
8366     *
8367     * @see elm_gengrid_reorder_mode_set() for more details
8368     *
8369     * @ingroup Gengrid
8370     */
8371    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8372
8373    /**
8374     * Append a new item in a given gengrid widget.
8375     *
8376     * @param obj The gengrid object.
8377     * @param gic The item class for the item.
8378     * @param data The item data.
8379     * @param func Convenience function called when the item is
8380     * selected.
8381     * @param func_data Data to be passed to @p func.
8382     * @return A handle to the item added or @c NULL, on errors.
8383     *
8384     * This adds an item to the beginning of the gengrid.
8385     *
8386     * @see elm_gengrid_item_prepend()
8387     * @see elm_gengrid_item_insert_before()
8388     * @see elm_gengrid_item_insert_after()
8389     * @see elm_gengrid_item_del()
8390     *
8391     * @ingroup Gengrid
8392     */
8393    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);
8394
8395    /**
8396     * Prepend a new item in a given gengrid widget.
8397     *
8398     * @param obj The gengrid object.
8399     * @param gic The item class for the item.
8400     * @param data The item data.
8401     * @param func Convenience function called when the item is
8402     * selected.
8403     * @param func_data Data to be passed to @p func.
8404     * @return A handle to the item added or @c NULL, on errors.
8405     *
8406     * This adds an item to the end of the gengrid.
8407     *
8408     * @see elm_gengrid_item_append()
8409     * @see elm_gengrid_item_insert_before()
8410     * @see elm_gengrid_item_insert_after()
8411     * @see elm_gengrid_item_del()
8412     *
8413     * @ingroup Gengrid
8414     */
8415    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);
8416
8417    /**
8418     * Insert an item before another in a gengrid widget
8419     *
8420     * @param obj The gengrid object.
8421     * @param gic The item class for the item.
8422     * @param data The item data.
8423     * @param relative The item to place this new one before.
8424     * @param func Convenience function called when the item is
8425     * selected.
8426     * @param func_data Data to be passed to @p func.
8427     * @return A handle to the item added or @c NULL, on errors.
8428     *
8429     * This inserts an item before another in the gengrid.
8430     *
8431     * @see elm_gengrid_item_append()
8432     * @see elm_gengrid_item_prepend()
8433     * @see elm_gengrid_item_insert_after()
8434     * @see elm_gengrid_item_del()
8435     *
8436     * @ingroup Gengrid
8437     */
8438    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);
8439
8440    /**
8441     * Insert an item after another in a gengrid widget
8442     *
8443     * @param obj The gengrid object.
8444     * @param gic The item class for the item.
8445     * @param data The item data.
8446     * @param relative The item to place this new one after.
8447     * @param func Convenience function called when the item is
8448     * selected.
8449     * @param func_data Data to be passed to @p func.
8450     * @return A handle to the item added or @c NULL, on errors.
8451     *
8452     * This inserts an item after another in the gengrid.
8453     *
8454     * @see elm_gengrid_item_append()
8455     * @see elm_gengrid_item_prepend()
8456     * @see elm_gengrid_item_insert_after()
8457     * @see elm_gengrid_item_del()
8458     *
8459     * @ingroup Gengrid
8460     */
8461    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);
8462
8463    /**
8464     * Insert an item in a gengrid widget using a user-defined sort function.
8465     *
8466     * @param obj The gengrid object.
8467     * @param gic The item class for the item.
8468     * @param data The item data.
8469     * @param comp User defined comparison function that defines the sort order based on
8470     * Elm_Gen_Item and its data param.
8471     * @param func Convenience function called when the item is selected.
8472     * @param func_data Data to be passed to @p func.
8473     * @return A handle to the item added or @c NULL, on errors.
8474     *
8475     * This inserts an item in the gengrid based on user defined comparison function.
8476     *
8477     * @see elm_gengrid_item_append()
8478     * @see elm_gengrid_item_prepend()
8479     * @see elm_gengrid_item_insert_after()
8480     * @see elm_gengrid_item_del()
8481     * @see elm_gengrid_item_direct_sorted_insert()
8482     *
8483     * @ingroup Gengrid
8484     */
8485    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);
8486
8487    /**
8488     * Insert an item in a gengrid widget using a user-defined sort function.
8489     *
8490     * @param obj The gengrid object.
8491     * @param gic The item class for the item.
8492     * @param data The item data.
8493     * @param comp User defined comparison function that defines the sort order based on
8494     * Elm_Gen_Item.
8495     * @param func Convenience function called when the item is selected.
8496     * @param func_data Data to be passed to @p func.
8497     * @return A handle to the item added or @c NULL, on errors.
8498     *
8499     * This inserts an item in the gengrid based on user defined comparison function.
8500     *
8501     * @see elm_gengrid_item_append()
8502     * @see elm_gengrid_item_prepend()
8503     * @see elm_gengrid_item_insert_after()
8504     * @see elm_gengrid_item_del()
8505     * @see elm_gengrid_item_sorted_insert()
8506     *
8507     * @ingroup Gengrid
8508     */
8509    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);
8510
8511    /**
8512     * Set whether items on a given gengrid widget are to get their
8513     * selection callbacks issued for @b every subsequent selection
8514     * click on them or just for the first click.
8515     *
8516     * @param obj The gengrid object
8517     * @param always_select @c EINA_TRUE to make items "always
8518     * selected", @c EINA_FALSE, otherwise
8519     *
8520     * By default, grid items will only call their selection callback
8521     * function when firstly getting selected, any subsequent further
8522     * clicks will do nothing. With this call, you make those
8523     * subsequent clicks also to issue the selection callbacks.
8524     *
8525     * @note <b>Double clicks</b> will @b always be reported on items.
8526     *
8527     * @see elm_gengrid_always_select_mode_get()
8528     *
8529     * @ingroup Gengrid
8530     */
8531    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8532
8533    /**
8534     * Get whether items on a given gengrid widget have their selection
8535     * callbacks issued for @b every subsequent selection click on them
8536     * or just for the first click.
8537     *
8538     * @param obj The gengrid object.
8539     * @return @c EINA_TRUE if the gengrid items are "always selected",
8540     * @c EINA_FALSE, otherwise
8541     *
8542     * @see elm_gengrid_always_select_mode_set() for more details
8543     *
8544     * @ingroup Gengrid
8545     */
8546    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8547
8548    /**
8549     * Set whether items on a given gengrid widget can be selected or not.
8550     *
8551     * @param obj The gengrid object
8552     * @param no_select @c EINA_TRUE to make items selectable,
8553     * @c EINA_FALSE otherwise
8554     *
8555     * This will make items in @p obj selectable or not. In the latter
8556     * case, any user interaction on the gengrid items will neither make
8557     * them appear selected nor them call their selection callback
8558     * functions.
8559     *
8560     * @see elm_gengrid_no_select_mode_get()
8561     *
8562     * @ingroup Gengrid
8563     */
8564    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8565
8566    /**
8567     * Get whether items on a given gengrid widget can be selected or
8568     * not.
8569     *
8570     * @param obj The gengrid object
8571     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8572     * otherwise
8573     *
8574     * @see elm_gengrid_no_select_mode_set() for more details
8575     *
8576     * @ingroup Gengrid
8577     */
8578    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8579
8580    /**
8581     * Enable or disable multi-selection in a given gengrid widget
8582     *
8583     * @param obj The gengrid object.
8584     * @param multi @c EINA_TRUE, to enable multi-selection,
8585     * @c EINA_FALSE to disable it.
8586     *
8587     * Multi-selection is the ability to have @b more than one
8588     * item selected, on a given gengrid, simultaneously. When it is
8589     * enabled, a sequence of clicks on different items will make them
8590     * all selected, progressively. A click on an already selected item
8591     * will unselect it. If interacting via the keyboard,
8592     * multi-selection is enabled while holding the "Shift" key.
8593     *
8594     * @note By default, multi-selection is @b disabled on gengrids
8595     *
8596     * @see elm_gengrid_multi_select_get()
8597     *
8598     * @ingroup Gengrid
8599     */
8600    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8601
8602    /**
8603     * Get whether multi-selection is enabled or disabled for a given
8604     * gengrid widget
8605     *
8606     * @param obj The gengrid object.
8607     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8608     * EINA_FALSE otherwise
8609     *
8610     * @see elm_gengrid_multi_select_set() for more details
8611     *
8612     * @ingroup Gengrid
8613     */
8614    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8615
8616    /**
8617     * Enable or disable bouncing effect for a given gengrid widget
8618     *
8619     * @param obj The gengrid object
8620     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8621     * @c EINA_FALSE to disable it
8622     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8623     * @c EINA_FALSE to disable it
8624     *
8625     * The bouncing effect occurs whenever one reaches the gengrid's
8626     * edge's while panning it -- it will scroll past its limits a
8627     * little bit and return to the edge again, in a animated for,
8628     * automatically.
8629     *
8630     * @note By default, gengrids have bouncing enabled on both axis
8631     *
8632     * @see elm_gengrid_bounce_get()
8633     *
8634     * @ingroup Gengrid
8635     */
8636    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8637
8638    /**
8639     * Get whether bouncing effects are enabled or disabled, for a
8640     * given gengrid widget, on each axis
8641     *
8642     * @param obj The gengrid object
8643     * @param h_bounce Pointer to a variable where to store the
8644     * horizontal bouncing flag.
8645     * @param v_bounce Pointer to a variable where to store the
8646     * vertical bouncing flag.
8647     *
8648     * @see elm_gengrid_bounce_set() for more details
8649     *
8650     * @ingroup Gengrid
8651     */
8652    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8653
8654    /**
8655     * Set a given gengrid widget's scrolling page size, relative to
8656     * its viewport size.
8657     *
8658     * @param obj The gengrid object
8659     * @param h_pagerel The horizontal page (relative) size
8660     * @param v_pagerel The vertical page (relative) size
8661     *
8662     * The gengrid's scroller is capable of binding scrolling by the
8663     * user to "pages". It means that, while scrolling and, specially
8664     * after releasing the mouse button, the grid will @b snap to the
8665     * nearest displaying page's area. When page sizes are set, the
8666     * grid's continuous content area is split into (equal) page sized
8667     * pieces.
8668     *
8669     * This function sets the size of a page <b>relatively to the
8670     * viewport dimensions</b> of the gengrid, for each axis. A value
8671     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8672     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8673     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8674     * 1.0. Values beyond those will make it behave behave
8675     * inconsistently. If you only want one axis to snap to pages, use
8676     * the value @c 0.0 for the other one.
8677     *
8678     * There is a function setting page size values in @b absolute
8679     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8680     * is mutually exclusive to this one.
8681     *
8682     * @see elm_gengrid_page_relative_get()
8683     *
8684     * @ingroup Gengrid
8685     */
8686    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8687
8688    /**
8689     * Get a given gengrid widget's scrolling page size, relative to
8690     * its viewport size.
8691     *
8692     * @param obj The gengrid object
8693     * @param h_pagerel Pointer to a variable where to store the
8694     * horizontal page (relative) size
8695     * @param v_pagerel Pointer to a variable where to store the
8696     * vertical page (relative) size
8697     *
8698     * @see elm_gengrid_page_relative_set() for more details
8699     *
8700     * @ingroup Gengrid
8701     */
8702    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8703
8704    /**
8705     * Set a given gengrid widget's scrolling page size
8706     *
8707     * @param obj The gengrid object
8708     * @param h_pagerel The horizontal page size, in pixels
8709     * @param v_pagerel The vertical page size, in pixels
8710     *
8711     * The gengrid's scroller is capable of binding scrolling by the
8712     * user to "pages". It means that, while scrolling and, specially
8713     * after releasing the mouse button, the grid will @b snap to the
8714     * nearest displaying page's area. When page sizes are set, the
8715     * grid's continuous content area is split into (equal) page sized
8716     * pieces.
8717     *
8718     * This function sets the size of a page of the gengrid, in pixels,
8719     * for each axis. Sane usable values are, between @c 0 and the
8720     * dimensions of @p obj, for each axis. Values beyond those will
8721     * make it behave behave inconsistently. If you only want one axis
8722     * to snap to pages, use the value @c 0 for the other one.
8723     *
8724     * There is a function setting page size values in @b relative
8725     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8726     * use is mutually exclusive to this one.
8727     *
8728     * @ingroup Gengrid
8729     */
8730    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8731
8732    /**
8733     * Set the direction in which a given gengrid widget will expand while
8734     * placing its items.
8735     *
8736     * @param obj The gengrid object.
8737     * @param setting @c EINA_TRUE to make the gengrid expand
8738     * horizontally, @c EINA_FALSE to expand vertically.
8739     *
8740     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8741     * in @b columns, from top to bottom and, when the space for a
8742     * column is filled, another one is started on the right, thus
8743     * expanding the grid horizontally. When in "vertical mode"
8744     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8745     * to right and, when the space for a row is filled, another one is
8746     * started below, thus expanding the grid vertically.
8747     *
8748     * @see elm_gengrid_horizontal_get()
8749     *
8750     * @ingroup Gengrid
8751     */
8752    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8753
8754    /**
8755     * Get for what direction a given gengrid widget will expand while
8756     * placing its items.
8757     *
8758     * @param obj The gengrid object.
8759     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8760     * @c EINA_FALSE if it's set to expand vertically.
8761     *
8762     * @see elm_gengrid_horizontal_set() for more detais
8763     *
8764     * @ingroup Gengrid
8765     */
8766    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8767
8768    /**
8769     * Get the first item in a given gengrid widget
8770     *
8771     * @param obj The gengrid object
8772     * @return The first item's handle or @c NULL, if there are no
8773     * items in @p obj (and on errors)
8774     *
8775     * This returns the first item in the @p obj's internal list of
8776     * items.
8777     *
8778     * @see elm_gengrid_last_item_get()
8779     *
8780     * @ingroup Gengrid
8781     */
8782    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8783
8784    /**
8785     * Get the last item in a given gengrid widget
8786     *
8787     * @param obj The gengrid object
8788     * @return The last item's handle or @c NULL, if there are no
8789     * items in @p obj (and on errors)
8790     *
8791     * This returns the last item in the @p obj's internal list of
8792     * items.
8793     *
8794     * @see elm_gengrid_first_item_get()
8795     *
8796     * @ingroup Gengrid
8797     */
8798    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8799
8800    /**
8801     * Get the @b next item in a gengrid widget's internal list of items,
8802     * given a handle to one of those items.
8803     *
8804     * @param item The gengrid item to fetch next from
8805     * @return The item after @p item, or @c NULL if there's none (and
8806     * on errors)
8807     *
8808     * This returns the item placed after the @p item, on the container
8809     * gengrid.
8810     *
8811     * @see elm_gengrid_item_prev_get()
8812     *
8813     * @ingroup Gengrid
8814     */
8815    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8816
8817    /**
8818     * Get the @b previous item in a gengrid widget's internal list of items,
8819     * given a handle to one of those items.
8820     *
8821     * @param item The gengrid item to fetch previous from
8822     * @return The item before @p item, or @c NULL if there's none (and
8823     * on errors)
8824     *
8825     * This returns the item placed before the @p item, on the container
8826     * gengrid.
8827     *
8828     * @see elm_gengrid_item_next_get()
8829     *
8830     * @ingroup Gengrid
8831     */
8832    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8833
8834    /**
8835     * Get the gengrid object's handle which contains a given gengrid
8836     * item
8837     *
8838     * @param item The item to fetch the container from
8839     * @return The gengrid (parent) object
8840     *
8841     * This returns the gengrid object itself that an item belongs to.
8842     *
8843     * @ingroup Gengrid
8844     */
8845    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8846
8847    /**
8848     * Remove a gengrid item from its parent, deleting it.
8849     *
8850     * @param item The item to be removed.
8851     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8852     *
8853     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8854     * once.
8855     *
8856     * @ingroup Gengrid
8857     */
8858    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8859
8860    /**
8861     * Update the contents of a given gengrid item
8862     *
8863     * @param item The gengrid item
8864     *
8865     * This updates an item by calling all the item class functions
8866     * again to get the contents, labels and states. Use this when the
8867     * original item data has changed and you want the changes to be
8868     * reflected.
8869     *
8870     * @ingroup Gengrid
8871     */
8872    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8873
8874    /**
8875     * Get the Gengrid Item class for the given Gengrid Item.
8876     *
8877     * @param item The gengrid item
8878     *
8879     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8880     * the function pointers and item_style.
8881     *
8882     * @ingroup Gengrid
8883     */
8884    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8885
8886    /**
8887     * Get the Gengrid Item class for the given Gengrid Item.
8888     *
8889     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8890     * the function pointers and item_style.
8891     *
8892     * @param item The gengrid item
8893     * @param gic The gengrid item class describing the function pointers and the item style.
8894     *
8895     * @ingroup Gengrid
8896     */
8897    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8898
8899    /**
8900     * Return the data associated to a given gengrid item
8901     *
8902     * @param item The gengrid item.
8903     * @return the data associated with this item.
8904     *
8905     * This returns the @c data value passed on the
8906     * elm_gengrid_item_append() and related item addition calls.
8907     *
8908     * @see elm_gengrid_item_append()
8909     * @see elm_gengrid_item_data_set()
8910     *
8911     * @ingroup Gengrid
8912     */
8913    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8914
8915    /**
8916     * Set the data associated with a given gengrid item
8917     *
8918     * @param item The gengrid item
8919     * @param data The data pointer to set on it
8920     *
8921     * This @b overrides the @c data value passed on the
8922     * elm_gengrid_item_append() and related item addition calls. This
8923     * function @b won't call elm_gengrid_item_update() automatically,
8924     * so you'd issue it afterwards if you want to have the item
8925     * updated to reflect the new data.
8926     *
8927     * @see elm_gengrid_item_data_get()
8928     * @see elm_gengrid_item_update()
8929     *
8930     * @ingroup Gengrid
8931     */
8932    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8933
8934    /**
8935     * Get a given gengrid item's position, relative to the whole
8936     * gengrid's grid area.
8937     *
8938     * @param item The Gengrid item.
8939     * @param x Pointer to variable to store the item's <b>row number</b>.
8940     * @param y Pointer to variable to store the item's <b>column number</b>.
8941     *
8942     * This returns the "logical" position of the item within the
8943     * gengrid. For example, @c (0, 1) would stand for first row,
8944     * second column.
8945     *
8946     * @ingroup Gengrid
8947     */
8948    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8949
8950    /**
8951     * Set whether a given gengrid item is selected or not
8952     *
8953     * @param item The gengrid item
8954     * @param selected Use @c EINA_TRUE, to make it selected, @c
8955     * EINA_FALSE to make it unselected
8956     *
8957     * This sets the selected state of an item. If multi-selection is
8958     * not enabled on the containing gengrid and @p selected is @c
8959     * EINA_TRUE, any other previously selected items will get
8960     * unselected in favor of this new one.
8961     *
8962     * @see elm_gengrid_item_selected_get()
8963     *
8964     * @ingroup Gengrid
8965     */
8966    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8967
8968    /**
8969     * Get whether a given gengrid item is selected or not
8970     *
8971     * @param item The gengrid item
8972     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8973     *
8974     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8975     *
8976     * @see elm_gengrid_item_selected_set() for more details
8977     *
8978     * @ingroup Gengrid
8979     */
8980    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8981
8982    /**
8983     * Get the real Evas object created to implement the view of a
8984     * given gengrid item
8985     *
8986     * @param item The gengrid item.
8987     * @return the Evas object implementing this item's view.
8988     *
8989     * This returns the actual Evas object used to implement the
8990     * specified gengrid item's view. This may be @c NULL, as it may
8991     * not have been created or may have been deleted, at any time, by
8992     * the gengrid. <b>Do not modify this object</b> (move, resize,
8993     * show, hide, etc.), as the gengrid is controlling it. This
8994     * function is for querying, emitting custom signals or hooking
8995     * lower level callbacks for events on that object. Do not delete
8996     * this object under any circumstances.
8997     *
8998     * @see elm_gengrid_item_data_get()
8999     *
9000     * @ingroup Gengrid
9001     */
9002    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9003
9004    /**
9005     * Show the portion of a gengrid's internal grid containing a given
9006     * item, @b immediately.
9007     *
9008     * @param item The item to display
9009     *
9010     * This causes gengrid to @b redraw its viewport's contents to the
9011     * region contining the given @p item item, if it is not fully
9012     * visible.
9013     *
9014     * @see elm_gengrid_item_bring_in()
9015     *
9016     * @ingroup Gengrid
9017     */
9018    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9019
9020    /**
9021     * Animatedly bring in, to the visible area of a gengrid, a given
9022     * item on it.
9023     *
9024     * @param item The gengrid item to display
9025     *
9026     * This causes gengrid to jump to the given @p item and show
9027     * it (by scrolling), if it is not fully visible. This will use
9028     * animation to do so and take a period of time to complete.
9029     *
9030     * @see elm_gengrid_item_show()
9031     *
9032     * @ingroup Gengrid
9033     */
9034    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9035
9036    /**
9037     * Set whether a given gengrid item is disabled or not.
9038     *
9039     * @param item The gengrid item
9040     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9041     * to enable it back.
9042     *
9043     * A disabled item cannot be selected or unselected. It will also
9044     * change its appearance, to signal the user it's disabled.
9045     *
9046     * @see elm_gengrid_item_disabled_get()
9047     *
9048     * @ingroup Gengrid
9049     */
9050    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9051
9052    /**
9053     * Get whether a given gengrid item is disabled or not.
9054     *
9055     * @param item The gengrid item
9056     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9057     * (and on errors).
9058     *
9059     * @see elm_gengrid_item_disabled_set() for more details
9060     *
9061     * @ingroup Gengrid
9062     */
9063    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9064
9065    /**
9066     * Set the text to be shown in a given gengrid item's tooltips.
9067     *
9068     * @param item The gengrid item
9069     * @param text The text to set in the content
9070     *
9071     * This call will setup the text to be used as tooltip to that item
9072     * (analogous to elm_object_tooltip_text_set(), but being item
9073     * tooltips with higher precedence than object tooltips). It can
9074     * have only one tooltip at a time, so any previous tooltip data
9075     * will get removed.
9076     *
9077     * @ingroup Gengrid
9078     */
9079    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9080
9081    /**
9082     * Set the content to be shown in a given gengrid item's tooltip
9083     *
9084     * @param item The gengrid item.
9085     * @param func The function returning the tooltip contents.
9086     * @param data What to provide to @a func as callback data/context.
9087     * @param del_cb Called when data is not needed anymore, either when
9088     *        another callback replaces @p func, the tooltip is unset with
9089     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9090     *        dies. This callback receives as its first parameter the
9091     *        given @p data, being @c event_info the item handle.
9092     *
9093     * This call will setup the tooltip's contents to @p item
9094     * (analogous to elm_object_tooltip_content_cb_set(), but being
9095     * item tooltips with higher precedence than object tooltips). It
9096     * can have only one tooltip at a time, so any previous tooltip
9097     * content will get removed. @p func (with @p data) will be called
9098     * every time Elementary needs to show the tooltip and it should
9099     * return a valid Evas object, which will be fully managed by the
9100     * tooltip system, getting deleted when the tooltip is gone.
9101     *
9102     * @ingroup Gengrid
9103     */
9104    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);
9105
9106    /**
9107     * Unset a tooltip from a given gengrid item
9108     *
9109     * @param item gengrid item to remove a previously set tooltip from.
9110     *
9111     * This call removes any tooltip set on @p item. The callback
9112     * provided as @c del_cb to
9113     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9114     * notify it is not used anymore (and have resources cleaned, if
9115     * need be).
9116     *
9117     * @see elm_gengrid_item_tooltip_content_cb_set()
9118     *
9119     * @ingroup Gengrid
9120     */
9121    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9122
9123    /**
9124     * Set a different @b style for a given gengrid item's tooltip.
9125     *
9126     * @param item gengrid item with tooltip set
9127     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9128     * "default", @c "transparent", etc)
9129     *
9130     * Tooltips can have <b>alternate styles</b> to be displayed on,
9131     * which are defined by the theme set on Elementary. This function
9132     * works analogously as elm_object_tooltip_style_set(), but here
9133     * applied only to gengrid item objects. The default style for
9134     * tooltips is @c "default".
9135     *
9136     * @note before you set a style you should define a tooltip with
9137     *       elm_gengrid_item_tooltip_content_cb_set() or
9138     *       elm_gengrid_item_tooltip_text_set()
9139     *
9140     * @see elm_gengrid_item_tooltip_style_get()
9141     *
9142     * @ingroup Gengrid
9143     */
9144    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9145
9146    /**
9147     * Get the style set a given gengrid item's tooltip.
9148     *
9149     * @param item gengrid item with tooltip already set on.
9150     * @return style the theme style in use, which defaults to
9151     *         "default". If the object does not have a tooltip set,
9152     *         then @c NULL is returned.
9153     *
9154     * @see elm_gengrid_item_tooltip_style_set() for more details
9155     *
9156     * @ingroup Gengrid
9157     */
9158    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9159    /**
9160     * Set the type of mouse pointer/cursor decoration to be shown,
9161     * when the mouse pointer is over the given gengrid widget item
9162     *
9163     * @param item gengrid item to customize cursor on
9164     * @param cursor the cursor type's name
9165     *
9166     * This function works analogously as elm_object_cursor_set(), but
9167     * here the cursor's changing area is restricted to the item's
9168     * area, and not the whole widget's. Note that that item cursors
9169     * have precedence over widget cursors, so that a mouse over @p
9170     * item will always show cursor @p type.
9171     *
9172     * If this function is called twice for an object, a previously set
9173     * cursor will be unset on the second call.
9174     *
9175     * @see elm_object_cursor_set()
9176     * @see elm_gengrid_item_cursor_get()
9177     * @see elm_gengrid_item_cursor_unset()
9178     *
9179     * @ingroup Gengrid
9180     */
9181    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9182
9183    /**
9184     * Get the type of mouse pointer/cursor decoration set to be shown,
9185     * when the mouse pointer is over the given gengrid widget item
9186     *
9187     * @param item gengrid item with custom cursor set
9188     * @return the cursor type's name or @c NULL, if no custom cursors
9189     * were set to @p item (and on errors)
9190     *
9191     * @see elm_object_cursor_get()
9192     * @see elm_gengrid_item_cursor_set() for more details
9193     * @see elm_gengrid_item_cursor_unset()
9194     *
9195     * @ingroup Gengrid
9196     */
9197    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9198
9199    /**
9200     * Unset any custom mouse pointer/cursor decoration set to be
9201     * shown, when the mouse pointer is over the given gengrid widget
9202     * item, thus making it show the @b default cursor again.
9203     *
9204     * @param item a gengrid item
9205     *
9206     * Use this call to undo any custom settings on this item's cursor
9207     * decoration, bringing it back to defaults (no custom style set).
9208     *
9209     * @see elm_object_cursor_unset()
9210     * @see elm_gengrid_item_cursor_set() for more details
9211     *
9212     * @ingroup Gengrid
9213     */
9214    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9215
9216    /**
9217     * Set a different @b style for a given custom cursor set for a
9218     * gengrid item.
9219     *
9220     * @param item gengrid item with custom cursor set
9221     * @param style the <b>theme style</b> to use (e.g. @c "default",
9222     * @c "transparent", etc)
9223     *
9224     * This function only makes sense when one is using custom mouse
9225     * cursor decorations <b>defined in a theme file</b> , which can
9226     * have, given a cursor name/type, <b>alternate styles</b> on
9227     * it. It works analogously as elm_object_cursor_style_set(), but
9228     * here applied only to gengrid item objects.
9229     *
9230     * @warning Before you set a cursor style you should have defined a
9231     *       custom cursor previously on the item, with
9232     *       elm_gengrid_item_cursor_set()
9233     *
9234     * @see elm_gengrid_item_cursor_engine_only_set()
9235     * @see elm_gengrid_item_cursor_style_get()
9236     *
9237     * @ingroup Gengrid
9238     */
9239    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9240
9241    /**
9242     * Get the current @b style set for a given gengrid item's custom
9243     * cursor
9244     *
9245     * @param item gengrid item with custom cursor set.
9246     * @return style the cursor style in use. If the object does not
9247     *         have a cursor set, then @c NULL is returned.
9248     *
9249     * @see elm_gengrid_item_cursor_style_set() for more details
9250     *
9251     * @ingroup Gengrid
9252     */
9253    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9254
9255    /**
9256     * Set if the (custom) cursor for a given gengrid item should be
9257     * searched in its theme, also, or should only rely on the
9258     * rendering engine.
9259     *
9260     * @param item item with custom (custom) cursor already set on
9261     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9262     * only on those provided by the rendering engine, @c EINA_FALSE to
9263     * have them searched on the widget's theme, as well.
9264     *
9265     * @note This call is of use only if you've set a custom cursor
9266     * for gengrid items, with elm_gengrid_item_cursor_set().
9267     *
9268     * @note By default, cursors will only be looked for between those
9269     * provided by the rendering engine.
9270     *
9271     * @ingroup Gengrid
9272     */
9273    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9274
9275    /**
9276     * Get if the (custom) cursor for a given gengrid item is being
9277     * searched in its theme, also, or is only relying on the rendering
9278     * engine.
9279     *
9280     * @param item a gengrid item
9281     * @return @c EINA_TRUE, if cursors are being looked for only on
9282     * those provided by the rendering engine, @c EINA_FALSE if they
9283     * are being searched on the widget's theme, as well.
9284     *
9285     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9286     *
9287     * @ingroup Gengrid
9288     */
9289    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9290
9291    /**
9292     * Remove all items from a given gengrid widget
9293     *
9294     * @param obj The gengrid object.
9295     *
9296     * This removes (and deletes) all items in @p obj, leaving it
9297     * empty.
9298     *
9299     * @see elm_gengrid_item_del(), to remove just one item.
9300     *
9301     * @ingroup Gengrid
9302     */
9303    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9304
9305    /**
9306     * Get the selected item in a given gengrid widget
9307     *
9308     * @param obj The gengrid object.
9309     * @return The selected item's handleor @c NULL, if none is
9310     * selected at the moment (and on errors)
9311     *
9312     * This returns the selected item in @p obj. If multi selection is
9313     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9314     * the first item in the list is selected, which might not be very
9315     * useful. For that case, see elm_gengrid_selected_items_get().
9316     *
9317     * @ingroup Gengrid
9318     */
9319    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9320
9321    /**
9322     * Get <b>a list</b> of selected items in a given gengrid
9323     *
9324     * @param obj The gengrid object.
9325     * @return The list of selected items or @c NULL, if none is
9326     * selected at the moment (and on errors)
9327     *
9328     * This returns a list of the selected items, in the order that
9329     * they appear in the grid. This list is only valid as long as no
9330     * more items are selected or unselected (or unselected implictly
9331     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9332     * data, naturally.
9333     *
9334     * @see elm_gengrid_selected_item_get()
9335     *
9336     * @ingroup Gengrid
9337     */
9338    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9339
9340    /**
9341     * @}
9342     */
9343
9344    /**
9345     * @defgroup Clock Clock
9346     *
9347     * @image html img/widget/clock/preview-00.png
9348     * @image latex img/widget/clock/preview-00.eps
9349     *
9350     * This is a @b digital clock widget. In its default theme, it has a
9351     * vintage "flipping numbers clock" appearance, which will animate
9352     * sheets of individual algarisms individually as time goes by.
9353     *
9354     * A newly created clock will fetch system's time (already
9355     * considering local time adjustments) to start with, and will tick
9356     * accondingly. It may or may not show seconds.
9357     *
9358     * Clocks have an @b edition mode. When in it, the sheets will
9359     * display extra arrow indications on the top and bottom and the
9360     * user may click on them to raise or lower the time values. After
9361     * it's told to exit edition mode, it will keep ticking with that
9362     * new time set (it keeps the difference from local time).
9363     *
9364     * Also, when under edition mode, user clicks on the cited arrows
9365     * which are @b held for some time will make the clock to flip the
9366     * sheet, thus editing the time, continuosly and automatically for
9367     * the user. The interval between sheet flips will keep growing in
9368     * time, so that it helps the user to reach a time which is distant
9369     * from the one set.
9370     *
9371     * The time display is, by default, in military mode (24h), but an
9372     * am/pm indicator may be optionally shown, too, when it will
9373     * switch to 12h.
9374     *
9375     * Smart callbacks one can register to:
9376     * - "changed" - the clock's user changed the time
9377     *
9378     * Here is an example on its usage:
9379     * @li @ref clock_example
9380     */
9381
9382    /**
9383     * @addtogroup Clock
9384     * @{
9385     */
9386
9387    /**
9388     * Identifiers for which clock digits should be editable, when a
9389     * clock widget is in edition mode. Values may be ORed together to
9390     * make a mask, naturally.
9391     *
9392     * @see elm_clock_edit_set()
9393     * @see elm_clock_digit_edit_set()
9394     */
9395    typedef enum _Elm_Clock_Digedit
9396      {
9397         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9398         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9399         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9400         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9401         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9402         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9403         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9404         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9405      } Elm_Clock_Digedit;
9406
9407    /**
9408     * Add a new clock widget to the given parent Elementary
9409     * (container) object
9410     *
9411     * @param parent The parent object
9412     * @return a new clock widget handle or @c NULL, on errors
9413     *
9414     * This function inserts a new clock widget on the canvas.
9415     *
9416     * @ingroup Clock
9417     */
9418    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9419
9420    /**
9421     * Set a clock widget's time, programmatically
9422     *
9423     * @param obj The clock widget object
9424     * @param hrs The hours to set
9425     * @param min The minutes to set
9426     * @param sec The secondes to set
9427     *
9428     * This function updates the time that is showed by the clock
9429     * widget.
9430     *
9431     *  Values @b must be set within the following ranges:
9432     * - 0 - 23, for hours
9433     * - 0 - 59, for minutes
9434     * - 0 - 59, for seconds,
9435     *
9436     * even if the clock is not in "military" mode.
9437     *
9438     * @warning The behavior for values set out of those ranges is @b
9439     * undefined.
9440     *
9441     * @ingroup Clock
9442     */
9443    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9444
9445    /**
9446     * Get a clock widget's time values
9447     *
9448     * @param obj The clock object
9449     * @param[out] hrs Pointer to the variable to get the hours value
9450     * @param[out] min Pointer to the variable to get the minutes value
9451     * @param[out] sec Pointer to the variable to get the seconds value
9452     *
9453     * This function gets the time set for @p obj, returning
9454     * it on the variables passed as the arguments to function
9455     *
9456     * @note Use @c NULL pointers on the time values you're not
9457     * interested in: they'll be ignored by the function.
9458     *
9459     * @ingroup Clock
9460     */
9461    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9462
9463    /**
9464     * Set whether a given clock widget is under <b>edition mode</b> or
9465     * under (default) displaying-only mode.
9466     *
9467     * @param obj The clock object
9468     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9469     * put it back to "displaying only" mode
9470     *
9471     * This function makes a clock's time to be editable or not <b>by
9472     * user interaction</b>. When in edition mode, clocks @b stop
9473     * ticking, until one brings them back to canonical mode. The
9474     * elm_clock_digit_edit_set() function will influence which digits
9475     * of the clock will be editable. By default, all of them will be
9476     * (#ELM_CLOCK_NONE).
9477     *
9478     * @note am/pm sheets, if being shown, will @b always be editable
9479     * under edition mode.
9480     *
9481     * @see elm_clock_edit_get()
9482     *
9483     * @ingroup Clock
9484     */
9485    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9486
9487    /**
9488     * Retrieve whether a given clock widget is under <b>edition
9489     * mode</b> or under (default) displaying-only mode.
9490     *
9491     * @param obj The clock object
9492     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9493     * otherwise
9494     *
9495     * This function retrieves whether the clock's time can be edited
9496     * or not by user interaction.
9497     *
9498     * @see elm_clock_edit_set() for more details
9499     *
9500     * @ingroup Clock
9501     */
9502    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9503
9504    /**
9505     * Set what digits of the given clock widget should be editable
9506     * when in edition mode.
9507     *
9508     * @param obj The clock object
9509     * @param digedit Bit mask indicating the digits to be editable
9510     * (values in #Elm_Clock_Digedit).
9511     *
9512     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9513     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9514     * EINA_FALSE).
9515     *
9516     * @see elm_clock_digit_edit_get()
9517     *
9518     * @ingroup Clock
9519     */
9520    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9521
9522    /**
9523     * Retrieve what digits of the given clock widget should be
9524     * editable when in edition mode.
9525     *
9526     * @param obj The clock object
9527     * @return Bit mask indicating the digits to be editable
9528     * (values in #Elm_Clock_Digedit).
9529     *
9530     * @see elm_clock_digit_edit_set() for more details
9531     *
9532     * @ingroup Clock
9533     */
9534    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9535
9536    /**
9537     * Set if the given clock widget must show hours in military or
9538     * am/pm mode
9539     *
9540     * @param obj The clock object
9541     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9542     * to military mode
9543     *
9544     * This function sets if the clock must show hours in military or
9545     * am/pm mode. In some countries like Brazil the military mode
9546     * (00-24h-format) is used, in opposition to the USA, where the
9547     * am/pm mode is more commonly used.
9548     *
9549     * @see elm_clock_show_am_pm_get()
9550     *
9551     * @ingroup Clock
9552     */
9553    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9554
9555    /**
9556     * Get if the given clock widget shows hours in military or am/pm
9557     * mode
9558     *
9559     * @param obj The clock object
9560     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9561     * military
9562     *
9563     * This function gets if the clock shows hours in military or am/pm
9564     * mode.
9565     *
9566     * @see elm_clock_show_am_pm_set() for more details
9567     *
9568     * @ingroup Clock
9569     */
9570    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9571
9572    /**
9573     * Set if the given clock widget must show time with seconds or not
9574     *
9575     * @param obj The clock object
9576     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9577     *
9578     * This function sets if the given clock must show or not elapsed
9579     * seconds. By default, they are @b not shown.
9580     *
9581     * @see elm_clock_show_seconds_get()
9582     *
9583     * @ingroup Clock
9584     */
9585    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9586
9587    /**
9588     * Get whether the given clock widget is showing time with seconds
9589     * or not
9590     *
9591     * @param obj The clock object
9592     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9593     *
9594     * This function gets whether @p obj is showing or not the elapsed
9595     * seconds.
9596     *
9597     * @see elm_clock_show_seconds_set()
9598     *
9599     * @ingroup Clock
9600     */
9601    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9602
9603    /**
9604     * Set the interval on time updates for an user mouse button hold
9605     * on clock widgets' time edition.
9606     *
9607     * @param obj The clock object
9608     * @param interval The (first) interval value in seconds
9609     *
9610     * This interval value is @b decreased while the user holds the
9611     * mouse pointer either incrementing or decrementing a given the
9612     * clock digit's value.
9613     *
9614     * This helps the user to get to a given time distant from the
9615     * current one easier/faster, as it will start to flip quicker and
9616     * quicker on mouse button holds.
9617     *
9618     * The calculation for the next flip interval value, starting from
9619     * the one set with this call, is the previous interval divided by
9620     * 1.05, so it decreases a little bit.
9621     *
9622     * The default starting interval value for automatic flips is
9623     * @b 0.85 seconds.
9624     *
9625     * @see elm_clock_interval_get()
9626     *
9627     * @ingroup Clock
9628     */
9629    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9630
9631    /**
9632     * Get the interval on time updates for an user mouse button hold
9633     * on clock widgets' time edition.
9634     *
9635     * @param obj The clock object
9636     * @return The (first) interval value, in seconds, set on it
9637     *
9638     * @see elm_clock_interval_set() for more details
9639     *
9640     * @ingroup Clock
9641     */
9642    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9643
9644    /**
9645     * @}
9646     */
9647
9648    /**
9649     * @defgroup Layout Layout
9650     *
9651     * @image html img/widget/layout/preview-00.png
9652     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9653     *
9654     * @image html img/layout-predefined.png
9655     * @image latex img/layout-predefined.eps width=\textwidth
9656     *
9657     * This is a container widget that takes a standard Edje design file and
9658     * wraps it very thinly in a widget.
9659     *
9660     * An Edje design (theme) file has a very wide range of possibilities to
9661     * describe the behavior of elements added to the Layout. Check out the Edje
9662     * documentation and the EDC reference to get more information about what can
9663     * be done with Edje.
9664     *
9665     * Just like @ref List, @ref Box, and other container widgets, any
9666     * object added to the Layout will become its child, meaning that it will be
9667     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9668     *
9669     * The Layout widget can contain as many Contents, Boxes or Tables as
9670     * described in its theme file. For instance, objects can be added to
9671     * different Tables by specifying the respective Table part names. The same
9672     * is valid for Content and Box.
9673     *
9674     * The objects added as child of the Layout will behave as described in the
9675     * part description where they were added. There are 3 possible types of
9676     * parts where a child can be added:
9677     *
9678     * @section secContent Content (SWALLOW part)
9679     *
9680     * Only one object can be added to the @c SWALLOW part (but you still can
9681     * have many @c SWALLOW parts and one object on each of them). Use the @c
9682     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9683     * objects as content of the @c SWALLOW. After being set to this part, the 
9684     * object size, position, visibility, clipping and other description 
9685     * properties will be totally controled by the description of the given part 
9686     * (inside the Edje theme file).
9687     *
9688     * One can use @c evas_object_size_hint_* functions on the child to have some
9689     * kind of control over its behavior, but the resulting behavior will still
9690     * depend heavily on the @c SWALLOW part description.
9691     *
9692     * The Edje theme also can change the part description, based on signals or
9693     * scripts running inside the theme. This change can also be animated. All of
9694     * this will affect the child object set as content accordingly. The object
9695     * size will be changed if the part size is changed, it will animate move if
9696     * the part is moving, and so on.
9697     *
9698     * The following picture demonstrates a Layout widget with a child object
9699     * added to its @c SWALLOW:
9700     *
9701     * @image html layout_swallow.png
9702     * @image latex layout_swallow.eps width=\textwidth
9703     *
9704     * @section secBox Box (BOX part)
9705     *
9706     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9707     * allows one to add objects to the box and have them distributed along its
9708     * area, accordingly to the specified @a layout property (now by @a layout we
9709     * mean the chosen layouting design of the Box, not the Layout widget
9710     * itself).
9711     *
9712     * A similar effect for having a box with its position, size and other things
9713     * controled by the Layout theme would be to create an Elementary @ref Box
9714     * widget and add it as a Content in the @c SWALLOW part.
9715     *
9716     * The main difference of using the Layout Box is that its behavior, the box
9717     * properties like layouting format, padding, align, etc. will be all
9718     * controled by the theme. This means, for example, that a signal could be
9719     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9720     * handled the signal by changing the box padding, or align, or both. Using
9721     * the Elementary @ref Box widget is not necessarily harder or easier, it
9722     * just depends on the circunstances and requirements.
9723     *
9724     * The Layout Box can be used through the @c elm_layout_box_* set of
9725     * functions.
9726     *
9727     * The following picture demonstrates a Layout widget with many child objects
9728     * added to its @c BOX part:
9729     *
9730     * @image html layout_box.png
9731     * @image latex layout_box.eps width=\textwidth
9732     *
9733     * @section secTable Table (TABLE part)
9734     *
9735     * Just like the @ref secBox, the Layout Table is very similar to the
9736     * Elementary @ref Table widget. It allows one to add objects to the Table
9737     * specifying the row and column where the object should be added, and any
9738     * column or row span if necessary.
9739     *
9740     * Again, we could have this design by adding a @ref Table widget to the @c
9741     * SWALLOW part using elm_object_part_content_set(). The same difference happens
9742     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9743     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9744     *
9745     * The Layout Table can be used through the @c elm_layout_table_* set of
9746     * functions.
9747     *
9748     * The following picture demonstrates a Layout widget with many child objects
9749     * added to its @c TABLE part:
9750     *
9751     * @image html layout_table.png
9752     * @image latex layout_table.eps width=\textwidth
9753     *
9754     * @section secPredef Predefined Layouts
9755     *
9756     * Another interesting thing about the Layout widget is that it offers some
9757     * predefined themes that come with the default Elementary theme. These
9758     * themes can be set by the call elm_layout_theme_set(), and provide some
9759     * basic functionality depending on the theme used.
9760     *
9761     * Most of them already send some signals, some already provide a toolbar or
9762     * back and next buttons.
9763     *
9764     * These are available predefined theme layouts. All of them have class = @c
9765     * layout, group = @c application, and style = one of the following options:
9766     *
9767     * @li @c toolbar-content - application with toolbar and main content area
9768     * @li @c toolbar-content-back - application with toolbar and main content
9769     * area with a back button and title area
9770     * @li @c toolbar-content-back-next - application with toolbar and main
9771     * content area with a back and next buttons and title area
9772     * @li @c content-back - application with a main content area with a back
9773     * button and title area
9774     * @li @c content-back-next - application with a main content area with a
9775     * back and next buttons and title area
9776     * @li @c toolbar-vbox - application with toolbar and main content area as a
9777     * vertical box
9778     * @li @c toolbar-table - application with toolbar and main content area as a
9779     * table
9780     *
9781     * @section secExamples Examples
9782     *
9783     * Some examples of the Layout widget can be found here:
9784     * @li @ref layout_example_01
9785     * @li @ref layout_example_02
9786     * @li @ref layout_example_03
9787     * @li @ref layout_example_edc
9788     *
9789     */
9790
9791    /**
9792     * Add a new layout to the parent
9793     *
9794     * @param parent The parent object
9795     * @return The new object or NULL if it cannot be created
9796     *
9797     * @see elm_layout_file_set()
9798     * @see elm_layout_theme_set()
9799     *
9800     * @ingroup Layout
9801     */
9802    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9803    /**
9804     * Set the file that will be used as layout
9805     *
9806     * @param obj The layout object
9807     * @param file The path to file (edj) that will be used as layout
9808     * @param group The group that the layout belongs in edje file
9809     *
9810     * @return (1 = success, 0 = error)
9811     *
9812     * @ingroup Layout
9813     */
9814    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9815    /**
9816     * Set the edje group from the elementary theme that will be used as layout
9817     *
9818     * @param obj The layout object
9819     * @param clas the clas of the group
9820     * @param group the group
9821     * @param style the style to used
9822     *
9823     * @return (1 = success, 0 = error)
9824     *
9825     * @ingroup Layout
9826     */
9827    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9828    /**
9829     * Set the layout content.
9830     *
9831     * @param obj The layout object
9832     * @param swallow The swallow part name in the edje file
9833     * @param content The child that will be added in this layout object
9834     *
9835     * Once the content object is set, a previously set one will be deleted.
9836     * If you want to keep that old content object, use the
9837     * elm_object_part_content_unset() function.
9838     *
9839     * @note In an Edje theme, the part used as a content container is called @c
9840     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9841     * expected to be a part name just like the second parameter of
9842     * elm_layout_box_append().
9843     *
9844     * @see elm_layout_box_append()
9845     * @see elm_object_part_content_get()
9846     * @see elm_object_part_content_unset()
9847     * @see @ref secBox
9848     * @deprecated use elm_object_part_content_set() instead
9849     *
9850     * @ingroup Layout
9851     */
9852    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9853    /**
9854     * Get the child object in the given content part.
9855     *
9856     * @param obj The layout object
9857     * @param swallow The SWALLOW part to get its content
9858     *
9859     * @return The swallowed object or NULL if none or an error occurred
9860     *
9861     * @deprecated use elm_object_part_content_get() instead
9862     *
9863     * @ingroup Layout
9864     */
9865    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9866    /**
9867     * Unset the layout content.
9868     *
9869     * @param obj The layout object
9870     * @param swallow The swallow part name in the edje file
9871     * @return The content that was being used
9872     *
9873     * Unparent and return the content object which was set for this part.
9874     *
9875     * @deprecated use elm_object_part_content_unset() instead
9876     *
9877     * @ingroup Layout
9878     */
9879    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9880    /**
9881     * Set the text of the given part
9882     *
9883     * @param obj The layout object
9884     * @param part The TEXT part where to set the text
9885     * @param text The text to set
9886     *
9887     * @ingroup Layout
9888     * @deprecated use elm_object_part_text_set() instead.
9889     */
9890    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9891    /**
9892     * Get the text set in the given part
9893     *
9894     * @param obj The layout object
9895     * @param part The TEXT part to retrieve the text off
9896     *
9897     * @return The text set in @p part
9898     *
9899     * @ingroup Layout
9900     * @deprecated use elm_object_part_text_get() instead.
9901     */
9902    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9903    /**
9904     * Append child to layout box part.
9905     *
9906     * @param obj the layout object
9907     * @param part the box part to which the object will be appended.
9908     * @param child the child object to append to box.
9909     *
9910     * Once the object is appended, it will become child of the layout. Its
9911     * lifetime will be bound to the layout, whenever the layout dies the child
9912     * will be deleted automatically. One should use elm_layout_box_remove() to
9913     * make this layout forget about the object.
9914     *
9915     * @see elm_layout_box_prepend()
9916     * @see elm_layout_box_insert_before()
9917     * @see elm_layout_box_insert_at()
9918     * @see elm_layout_box_remove()
9919     *
9920     * @ingroup Layout
9921     */
9922    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9923    /**
9924     * Prepend child to layout box part.
9925     *
9926     * @param obj the layout object
9927     * @param part the box part to prepend.
9928     * @param child the child object to prepend to box.
9929     *
9930     * Once the object is prepended, it will become child of the layout. Its
9931     * lifetime will be bound to the layout, whenever the layout dies the child
9932     * will be deleted automatically. One should use elm_layout_box_remove() to
9933     * make this layout forget about the object.
9934     *
9935     * @see elm_layout_box_append()
9936     * @see elm_layout_box_insert_before()
9937     * @see elm_layout_box_insert_at()
9938     * @see elm_layout_box_remove()
9939     *
9940     * @ingroup Layout
9941     */
9942    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9943    /**
9944     * Insert child to layout box part before a reference object.
9945     *
9946     * @param obj the layout object
9947     * @param part the box part to insert.
9948     * @param child the child object to insert into box.
9949     * @param reference another reference object to insert before in box.
9950     *
9951     * Once the object is inserted, it will become child of the layout. Its
9952     * lifetime will be bound to the layout, whenever the layout dies the child
9953     * will be deleted automatically. One should use elm_layout_box_remove() to
9954     * make this layout forget about the object.
9955     *
9956     * @see elm_layout_box_append()
9957     * @see elm_layout_box_prepend()
9958     * @see elm_layout_box_insert_before()
9959     * @see elm_layout_box_remove()
9960     *
9961     * @ingroup Layout
9962     */
9963    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9964    /**
9965     * Insert child to layout box part at a given position.
9966     *
9967     * @param obj the layout object
9968     * @param part the box part to insert.
9969     * @param child the child object to insert into box.
9970     * @param pos the numeric position >=0 to insert the child.
9971     *
9972     * Once the object is inserted, it will become child of the layout. Its
9973     * lifetime will be bound to the layout, whenever the layout dies the child
9974     * will be deleted automatically. One should use elm_layout_box_remove() to
9975     * make this layout forget about the object.
9976     *
9977     * @see elm_layout_box_append()
9978     * @see elm_layout_box_prepend()
9979     * @see elm_layout_box_insert_before()
9980     * @see elm_layout_box_remove()
9981     *
9982     * @ingroup Layout
9983     */
9984    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9985    /**
9986     * Remove a child of the given part box.
9987     *
9988     * @param obj The layout object
9989     * @param part The box part name to remove child.
9990     * @param child The object to remove from box.
9991     * @return The object that was being used, or NULL if not found.
9992     *
9993     * The object will be removed from the box part and its lifetime will
9994     * not be handled by the layout anymore. This is equivalent to
9995     * elm_object_part_content_unset() for box.
9996     *
9997     * @see elm_layout_box_append()
9998     * @see elm_layout_box_remove_all()
9999     *
10000     * @ingroup Layout
10001     */
10002    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10003    /**
10004     * Remove all child of the given part box.
10005     *
10006     * @param obj The layout object
10007     * @param part The box part name to remove child.
10008     * @param clear If EINA_TRUE, then all objects will be deleted as
10009     *        well, otherwise they will just be removed and will be
10010     *        dangling on the canvas.
10011     *
10012     * The objects will be removed from the box part and their lifetime will
10013     * not be handled by the layout anymore. This is equivalent to
10014     * elm_layout_box_remove() for all box children.
10015     *
10016     * @see elm_layout_box_append()
10017     * @see elm_layout_box_remove()
10018     *
10019     * @ingroup Layout
10020     */
10021    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10022    /**
10023     * Insert child to layout table part.
10024     *
10025     * @param obj the layout object
10026     * @param part the box part to pack child.
10027     * @param child_obj the child object to pack into table.
10028     * @param col the column to which the child should be added. (>= 0)
10029     * @param row the row to which the child should be added. (>= 0)
10030     * @param colspan how many columns should be used to store this object. (>=
10031     *        1)
10032     * @param rowspan how many rows should be used to store this object. (>= 1)
10033     *
10034     * Once the object is inserted, it will become child of the table. Its
10035     * lifetime will be bound to the layout, and whenever the layout dies the
10036     * child will be deleted automatically. One should use
10037     * elm_layout_table_remove() to make this layout forget about the object.
10038     *
10039     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10040     * more space than a single cell. For instance, the following code:
10041     * @code
10042     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10043     * @endcode
10044     *
10045     * Would result in an object being added like the following picture:
10046     *
10047     * @image html layout_colspan.png
10048     * @image latex layout_colspan.eps width=\textwidth
10049     *
10050     * @see elm_layout_table_unpack()
10051     * @see elm_layout_table_clear()
10052     *
10053     * @ingroup Layout
10054     */
10055    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);
10056    /**
10057     * Unpack (remove) a child of the given part table.
10058     *
10059     * @param obj The layout object
10060     * @param part The table part name to remove child.
10061     * @param child_obj The object to remove from table.
10062     * @return The object that was being used, or NULL if not found.
10063     *
10064     * The object will be unpacked from the table part and its lifetime
10065     * will not be handled by the layout anymore. This is equivalent to
10066     * elm_object_part_content_unset() for table.
10067     *
10068     * @see elm_layout_table_pack()
10069     * @see elm_layout_table_clear()
10070     *
10071     * @ingroup Layout
10072     */
10073    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10074    /**
10075     * Remove all child of the given part table.
10076     *
10077     * @param obj The layout object
10078     * @param part The table part name to remove child.
10079     * @param clear If EINA_TRUE, then all objects will be deleted as
10080     *        well, otherwise they will just be removed and will be
10081     *        dangling on the canvas.
10082     *
10083     * The objects will be removed from the table part and their lifetime will
10084     * not be handled by the layout anymore. This is equivalent to
10085     * elm_layout_table_unpack() for all table children.
10086     *
10087     * @see elm_layout_table_pack()
10088     * @see elm_layout_table_unpack()
10089     *
10090     * @ingroup Layout
10091     */
10092    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10093    /**
10094     * Get the edje layout
10095     *
10096     * @param obj The layout object
10097     *
10098     * @return A Evas_Object with the edje layout settings loaded
10099     * with function elm_layout_file_set
10100     *
10101     * This returns the edje object. It is not expected to be used to then
10102     * swallow objects via edje_object_part_swallow() for example. Use
10103     * elm_object_part_content_set() instead so child object handling and sizing is
10104     * done properly.
10105     *
10106     * @note This function should only be used if you really need to call some
10107     * low level Edje function on this edje object. All the common stuff (setting
10108     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10109     * with proper elementary functions.
10110     *
10111     * @see elm_object_signal_callback_add()
10112     * @see elm_object_signal_emit()
10113     * @see elm_object_part_text_set()
10114     * @see elm_object_part_content_set()
10115     * @see elm_layout_box_append()
10116     * @see elm_layout_table_pack()
10117     * @see elm_layout_data_get()
10118     *
10119     * @ingroup Layout
10120     */
10121    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10122    /**
10123     * Get the edje data from the given layout
10124     *
10125     * @param obj The layout object
10126     * @param key The data key
10127     *
10128     * @return The edje data string
10129     *
10130     * This function fetches data specified inside the edje theme of this layout.
10131     * This function return NULL if data is not found.
10132     *
10133     * In EDC this comes from a data block within the group block that @p
10134     * obj was loaded from. E.g.
10135     *
10136     * @code
10137     * collections {
10138     *   group {
10139     *     name: "a_group";
10140     *     data {
10141     *       item: "key1" "value1";
10142     *       item: "key2" "value2";
10143     *     }
10144     *   }
10145     * }
10146     * @endcode
10147     *
10148     * @ingroup Layout
10149     */
10150    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10151    /**
10152     * Eval sizing
10153     *
10154     * @param obj The layout object
10155     *
10156     * Manually forces a sizing re-evaluation. This is useful when the minimum
10157     * size required by the edje theme of this layout has changed. The change on
10158     * the minimum size required by the edje theme is not immediately reported to
10159     * the elementary layout, so one needs to call this function in order to tell
10160     * the widget (layout) that it needs to reevaluate its own size.
10161     *
10162     * The minimum size of the theme is calculated based on minimum size of
10163     * parts, the size of elements inside containers like box and table, etc. All
10164     * of this can change due to state changes, and that's when this function
10165     * should be called.
10166     *
10167     * Also note that a standard signal of "size,eval" "elm" emitted from the
10168     * edje object will cause this to happen too.
10169     *
10170     * @ingroup Layout
10171     */
10172    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10173
10174    /**
10175     * Sets a specific cursor for an edje part.
10176     *
10177     * @param obj The layout object.
10178     * @param part_name a part from loaded edje group.
10179     * @param cursor cursor name to use, see Elementary_Cursor.h
10180     *
10181     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10182     *         part not exists or it has "mouse_events: 0".
10183     *
10184     * @ingroup Layout
10185     */
10186    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10187
10188    /**
10189     * Get the cursor to be shown when mouse is over an edje part
10190     *
10191     * @param obj The layout object.
10192     * @param part_name a part from loaded edje group.
10193     * @return the cursor name.
10194     *
10195     * @ingroup Layout
10196     */
10197    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10198
10199    /**
10200     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10201     *
10202     * @param obj The layout object.
10203     * @param part_name a part from loaded edje group, that had a cursor set
10204     *        with elm_layout_part_cursor_set().
10205     *
10206     * @ingroup Layout
10207     */
10208    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10209
10210    /**
10211     * Sets a specific cursor style for an edje part.
10212     *
10213     * @param obj The layout object.
10214     * @param part_name a part from loaded edje group.
10215     * @param style the theme style to use (default, transparent, ...)
10216     *
10217     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10218     *         part not exists or it did not had a cursor set.
10219     *
10220     * @ingroup Layout
10221     */
10222    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10223
10224    /**
10225     * Gets a specific cursor style for an edje part.
10226     *
10227     * @param obj The layout object.
10228     * @param part_name a part from loaded edje group.
10229     *
10230     * @return the theme style in use, defaults to "default". If the
10231     *         object does not have a cursor set, then NULL is returned.
10232     *
10233     * @ingroup Layout
10234     */
10235    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10236
10237    /**
10238     * Sets if the cursor set should be searched on the theme or should use
10239     * the provided by the engine, only.
10240     *
10241     * @note before you set if should look on theme you should define a
10242     * cursor with elm_layout_part_cursor_set(). By default it will only
10243     * look for cursors provided by the engine.
10244     *
10245     * @param obj The layout object.
10246     * @param part_name a part from loaded edje group.
10247     * @param engine_only if cursors should be just provided by the engine
10248     *        or should also search on widget's theme as well
10249     *
10250     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10251     *         part not exists or it did not had a cursor set.
10252     *
10253     * @ingroup Layout
10254     */
10255    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);
10256
10257    /**
10258     * Gets a specific cursor engine_only for an edje part.
10259     *
10260     * @param obj The layout object.
10261     * @param part_name a part from loaded edje group.
10262     *
10263     * @return whenever the cursor is just provided by engine or also from theme.
10264     *
10265     * @ingroup Layout
10266     */
10267    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10268
10269 /**
10270  * @def elm_layout_icon_set
10271  * Convienience macro to set the icon object in a layout that follows the
10272  * Elementary naming convention for its parts.
10273  *
10274  * @ingroup Layout
10275  */
10276 #define elm_layout_icon_set(_ly, _obj) \
10277   do { \
10278     const char *sig; \
10279     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10280     if ((_obj)) sig = "elm,state,icon,visible"; \
10281     else sig = "elm,state,icon,hidden"; \
10282     elm_object_signal_emit((_ly), sig, "elm"); \
10283   } while (0)
10284
10285 /**
10286  * @def elm_layout_icon_get
10287  * Convienience macro to get the icon object from a layout that follows the
10288  * Elementary naming convention for its parts.
10289  *
10290  * @ingroup Layout
10291  */
10292 #define elm_layout_icon_get(_ly) \
10293   elm_object_part_content_get((_ly), "elm.swallow.icon")
10294
10295 /**
10296  * @def elm_layout_end_set
10297  * Convienience macro to set the end object in a layout that follows the
10298  * Elementary naming convention for its parts.
10299  *
10300  * @ingroup Layout
10301  */
10302 #define elm_layout_end_set(_ly, _obj) \
10303   do { \
10304     const char *sig; \
10305     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10306     if ((_obj)) sig = "elm,state,end,visible"; \
10307     else sig = "elm,state,end,hidden"; \
10308     elm_object_signal_emit((_ly), sig, "elm"); \
10309   } while (0)
10310
10311 /**
10312  * @def elm_layout_end_get
10313  * Convienience macro to get the end object in a layout that follows the
10314  * Elementary naming convention for its parts.
10315  *
10316  * @ingroup Layout
10317  */
10318 #define elm_layout_end_get(_ly) \
10319   elm_object_part_content_get((_ly), "elm.swallow.end")
10320
10321 /**
10322  * @def elm_layout_label_set
10323  * Convienience macro to set the label in a layout that follows the
10324  * Elementary naming convention for its parts.
10325  *
10326  * @ingroup Layout
10327  * @deprecated use elm_object_text_set() instead.
10328  */
10329 #define elm_layout_label_set(_ly, _txt) \
10330   elm_layout_text_set((_ly), "elm.text", (_txt))
10331
10332 /**
10333  * @def elm_layout_label_get
10334  * Convenience macro to get the label in a layout that follows the
10335  * Elementary naming convention for its parts.
10336  *
10337  * @ingroup Layout
10338  * @deprecated use elm_object_text_set() instead.
10339  */
10340 #define elm_layout_label_get(_ly) \
10341   elm_layout_text_get((_ly), "elm.text")
10342
10343    /* smart callbacks called:
10344     * "theme,changed" - when elm theme is changed.
10345     */
10346
10347    /**
10348     * @defgroup Notify Notify
10349     *
10350     * @image html img/widget/notify/preview-00.png
10351     * @image latex img/widget/notify/preview-00.eps
10352     *
10353     * Display a container in a particular region of the parent(top, bottom,
10354     * etc).  A timeout can be set to automatically hide the notify. This is so
10355     * that, after an evas_object_show() on a notify object, if a timeout was set
10356     * on it, it will @b automatically get hidden after that time.
10357     *
10358     * Signals that you can add callbacks for are:
10359     * @li "timeout" - when timeout happens on notify and it's hidden
10360     * @li "block,clicked" - when a click outside of the notify happens
10361     *
10362     * Default contents parts of the notify widget that you can use for are:
10363     * @li "default" - A content of the notify
10364     *
10365     * @ref tutorial_notify show usage of the API.
10366     *
10367     * @{
10368     */
10369    /**
10370     * @brief Possible orient values for notify.
10371     *
10372     * This values should be used in conjunction to elm_notify_orient_set() to
10373     * set the position in which the notify should appear(relative to its parent)
10374     * and in conjunction with elm_notify_orient_get() to know where the notify
10375     * is appearing.
10376     */
10377    typedef enum _Elm_Notify_Orient
10378      {
10379         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10380         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10381         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10382         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10383         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10384         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10385         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10386         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10387         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10388         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10389      } Elm_Notify_Orient;
10390    /**
10391     * @brief Add a new notify to the parent
10392     *
10393     * @param parent The parent object
10394     * @return The new object or NULL if it cannot be created
10395     */
10396    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10397    /**
10398     * @brief Set the content of the notify widget
10399     *
10400     * @param obj The notify object
10401     * @param content The content will be filled in this notify object
10402     *
10403     * Once the content object is set, a previously set one will be deleted. If
10404     * you want to keep that old content object, use the
10405     * elm_notify_content_unset() function.
10406     */
10407    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10408    /**
10409     * @brief Unset the content of the notify widget
10410     *
10411     * @param obj The notify object
10412     * @return The content that was being used
10413     *
10414     * Unparent and return the content object which was set for this widget
10415     *
10416     * @see elm_notify_content_set()
10417     */
10418    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10419    /**
10420     * @brief Return the content of the notify widget
10421     *
10422     * @param obj The notify object
10423     * @return The content that is being used
10424     *
10425     * @see elm_notify_content_set()
10426     */
10427    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10428    /**
10429     * @brief Set the notify parent
10430     *
10431     * @param obj The notify object
10432     * @param content The new parent
10433     *
10434     * Once the parent object is set, a previously set one will be disconnected
10435     * and replaced.
10436     */
10437    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10438    /**
10439     * @brief Get the notify parent
10440     *
10441     * @param obj The notify object
10442     * @return The parent
10443     *
10444     * @see elm_notify_parent_set()
10445     */
10446    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10447    /**
10448     * @brief Set the orientation
10449     *
10450     * @param obj The notify object
10451     * @param orient The new orientation
10452     *
10453     * Sets the position in which the notify will appear in its parent.
10454     *
10455     * @see @ref Elm_Notify_Orient for possible values.
10456     */
10457    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10458    /**
10459     * @brief Return the orientation
10460     * @param obj The notify object
10461     * @return The orientation of the notification
10462     *
10463     * @see elm_notify_orient_set()
10464     * @see Elm_Notify_Orient
10465     */
10466    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10467    /**
10468     * @brief Set the time interval after which the notify window is going to be
10469     * hidden.
10470     *
10471     * @param obj The notify object
10472     * @param time The timeout in seconds
10473     *
10474     * This function sets a timeout and starts the timer controlling when the
10475     * notify is hidden. Since calling evas_object_show() on a notify restarts
10476     * the timer controlling when the notify is hidden, setting this before the
10477     * notify is shown will in effect mean starting the timer when the notify is
10478     * shown.
10479     *
10480     * @note Set a value <= 0.0 to disable a running timer.
10481     *
10482     * @note If the value > 0.0 and the notify is previously visible, the
10483     * timer will be started with this value, canceling any running timer.
10484     */
10485    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10486    /**
10487     * @brief Return the timeout value (in seconds)
10488     * @param obj the notify object
10489     *
10490     * @see elm_notify_timeout_set()
10491     */
10492    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10493    /**
10494     * @brief Sets whether events should be passed to by a click outside
10495     * its area.
10496     *
10497     * @param obj The notify object
10498     * @param repeats EINA_TRUE Events are repeats, else no
10499     *
10500     * When true if the user clicks outside the window the events will be caught
10501     * by the others widgets, else the events are blocked.
10502     *
10503     * @note The default value is EINA_TRUE.
10504     */
10505    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10506    /**
10507     * @brief Return true if events are repeat below the notify object
10508     * @param obj the notify object
10509     *
10510     * @see elm_notify_repeat_events_set()
10511     */
10512    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10513    /**
10514     * @}
10515     */
10516
10517    /**
10518     * @defgroup Hover Hover
10519     *
10520     * @image html img/widget/hover/preview-00.png
10521     * @image latex img/widget/hover/preview-00.eps
10522     *
10523     * A Hover object will hover over its @p parent object at the @p target
10524     * location. Anything in the background will be given a darker coloring to
10525     * indicate that the hover object is on top (at the default theme). When the
10526     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10527     * clicked that @b doesn't cause the hover to be dismissed.
10528     *
10529     * A Hover object has two parents. One parent that owns it during creation
10530     * and the other parent being the one over which the hover object spans.
10531     *
10532     *
10533     * @note The hover object will take up the entire space of @p target
10534     * object.
10535     *
10536     * Elementary has the following styles for the hover widget:
10537     * @li default
10538     * @li popout
10539     * @li menu
10540     * @li hoversel_vertical
10541     *
10542     * The following are the available position for content:
10543     * @li left
10544     * @li top-left
10545     * @li top
10546     * @li top-right
10547     * @li right
10548     * @li bottom-right
10549     * @li bottom
10550     * @li bottom-left
10551     * @li middle
10552     * @li smart
10553     *
10554     * Signals that you can add callbacks for are:
10555     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10556     * @li "smart,changed" - a content object placed under the "smart"
10557     *                   policy was replaced to a new slot direction.
10558     *
10559     * See @ref tutorial_hover for more information.
10560     *
10561     * @{
10562     */
10563    typedef enum _Elm_Hover_Axis
10564      {
10565         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10566         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10567         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10568         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10569      } Elm_Hover_Axis;
10570    /**
10571     * @brief Adds a hover object to @p parent
10572     *
10573     * @param parent The parent object
10574     * @return The hover object or NULL if one could not be created
10575     */
10576    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10577    /**
10578     * @brief Sets the target object for the hover.
10579     *
10580     * @param obj The hover object
10581     * @param target The object to center the hover onto. The hover
10582     *
10583     * This function will cause the hover to be centered on the target object.
10584     */
10585    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10586    /**
10587     * @brief Gets the target object for the hover.
10588     *
10589     * @param obj The hover object
10590     * @param parent The object to locate the hover over.
10591     *
10592     * @see elm_hover_target_set()
10593     */
10594    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10595    /**
10596     * @brief Sets the parent object for the hover.
10597     *
10598     * @param obj The hover object
10599     * @param parent The object to locate the hover over.
10600     *
10601     * This function will cause the hover to take up the entire space that the
10602     * parent object fills.
10603     */
10604    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10605    /**
10606     * @brief Gets the parent object for the hover.
10607     *
10608     * @param obj The hover object
10609     * @return The parent object to locate the hover over.
10610     *
10611     * @see elm_hover_parent_set()
10612     */
10613    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10614    /**
10615     * @brief Sets the content of the hover object and the direction in which it
10616     * will pop out.
10617     *
10618     * @param obj The hover object
10619     * @param swallow The direction that the object will be displayed
10620     * at. Accepted values are "left", "top-left", "top", "top-right",
10621     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10622     * "smart".
10623     * @param content The content to place at @p swallow
10624     *
10625     * Once the content object is set for a given direction, a previously
10626     * set one (on the same direction) will be deleted. If you want to
10627     * keep that old content object, use the elm_hover_content_unset()
10628     * function.
10629     *
10630     * All directions may have contents at the same time, except for
10631     * "smart". This is a special placement hint and its use case
10632     * independs of the calculations coming from
10633     * elm_hover_best_content_location_get(). Its use is for cases when
10634     * one desires only one hover content, but with a dinamic special
10635     * placement within the hover area. The content's geometry, whenever
10636     * it changes, will be used to decide on a best location not
10637     * extrapolating the hover's parent object view to show it in (still
10638     * being the hover's target determinant of its medium part -- move and
10639     * resize it to simulate finger sizes, for example). If one of the
10640     * directions other than "smart" are used, a previously content set
10641     * using it will be deleted, and vice-versa.
10642     */
10643    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10644    /**
10645     * @brief Get the content of the hover object, in a given direction.
10646     *
10647     * Return the content object which was set for this widget in the
10648     * @p swallow direction.
10649     *
10650     * @param obj The hover object
10651     * @param swallow The direction that the object was display at.
10652     * @return The content that was being used
10653     *
10654     * @see elm_hover_content_set()
10655     */
10656    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10657    /**
10658     * @brief Unset the content of the hover object, in a given direction.
10659     *
10660     * Unparent and return the content object set at @p swallow direction.
10661     *
10662     * @param obj The hover object
10663     * @param swallow The direction that the object was display at.
10664     * @return The content that was being used.
10665     *
10666     * @see elm_hover_content_set()
10667     */
10668    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10669    /**
10670     * @brief Returns the best swallow location for content in the hover.
10671     *
10672     * @param obj The hover object
10673     * @param pref_axis The preferred orientation axis for the hover object to use
10674     * @return The edje location to place content into the hover or @c
10675     *         NULL, on errors.
10676     *
10677     * Best is defined here as the location at which there is the most available
10678     * space.
10679     *
10680     * @p pref_axis may be one of
10681     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10682     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10683     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10684     * - @c ELM_HOVER_AXIS_BOTH -- both
10685     *
10686     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10687     * nescessarily be along the horizontal axis("left" or "right"). If
10688     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10689     * be along the vertical axis("top" or "bottom"). Chossing
10690     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10691     * returned position may be in either axis.
10692     *
10693     * @see elm_hover_content_set()
10694     */
10695    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10696    /**
10697     * @}
10698     */
10699
10700    /* entry */
10701    /**
10702     * @defgroup Entry Entry
10703     *
10704     * @image html img/widget/entry/preview-00.png
10705     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10706     * @image html img/widget/entry/preview-01.png
10707     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10708     * @image html img/widget/entry/preview-02.png
10709     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10710     * @image html img/widget/entry/preview-03.png
10711     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10712     *
10713     * An entry is a convenience widget which shows a box that the user can
10714     * enter text into. Entries by default don't scroll, so they grow to
10715     * accomodate the entire text, resizing the parent window as needed. This
10716     * can be changed with the elm_entry_scrollable_set() function.
10717     *
10718     * They can also be single line or multi line (the default) and when set
10719     * to multi line mode they support text wrapping in any of the modes
10720     * indicated by #Elm_Wrap_Type.
10721     *
10722     * Other features include password mode, filtering of inserted text with
10723     * elm_entry_text_filter_append() and related functions, inline "items" and
10724     * formatted markup text.
10725     *
10726     * @section entry-markup Formatted text
10727     *
10728     * The markup tags supported by the Entry are defined by the theme, but
10729     * even when writing new themes or extensions it's a good idea to stick to
10730     * a sane default, to maintain coherency and avoid application breakages.
10731     * Currently defined by the default theme are the following tags:
10732     * @li \<br\>: Inserts a line break.
10733     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10734     * breaks.
10735     * @li \<tab\>: Inserts a tab.
10736     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10737     * enclosed text.
10738     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10739     * @li \<link\>...\</link\>: Underlines the enclosed text.
10740     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10741     *
10742     * @section entry-special Special markups
10743     *
10744     * Besides those used to format text, entries support two special markup
10745     * tags used to insert clickable portions of text or items inlined within
10746     * the text.
10747     *
10748     * @subsection entry-anchors Anchors
10749     *
10750     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10751     * \</a\> tags and an event will be generated when this text is clicked,
10752     * like this:
10753     *
10754     * @code
10755     * This text is outside <a href=anc-01>but this one is an anchor</a>
10756     * @endcode
10757     *
10758     * The @c href attribute in the opening tag gives the name that will be
10759     * used to identify the anchor and it can be any valid utf8 string.
10760     *
10761     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10762     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10763     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10764     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10765     * an anchor.
10766     *
10767     * @subsection entry-items Items
10768     *
10769     * Inlined in the text, any other @c Evas_Object can be inserted by using
10770     * \<item\> tags this way:
10771     *
10772     * @code
10773     * <item size=16x16 vsize=full href=emoticon/haha></item>
10774     * @endcode
10775     *
10776     * Just like with anchors, the @c href identifies each item, but these need,
10777     * in addition, to indicate their size, which is done using any one of
10778     * @c size, @c absize or @c relsize attributes. These attributes take their
10779     * value in the WxH format, where W is the width and H the height of the
10780     * item.
10781     *
10782     * @li absize: Absolute pixel size for the item. Whatever value is set will
10783     * be the item's size regardless of any scale value the object may have
10784     * been set to. The final line height will be adjusted to fit larger items.
10785     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10786     * for the object.
10787     * @li relsize: Size is adjusted for the item to fit within the current
10788     * line height.
10789     *
10790     * Besides their size, items are specificed a @c vsize value that affects
10791     * how their final size and position are calculated. The possible values
10792     * are:
10793     * @li ascent: Item will be placed within the line's baseline and its
10794     * ascent. That is, the height between the line where all characters are
10795     * positioned and the highest point in the line. For @c size and @c absize
10796     * items, the descent value will be added to the total line height to make
10797     * them fit. @c relsize items will be adjusted to fit within this space.
10798     * @li full: Items will be placed between the descent and ascent, or the
10799     * lowest point in the line and its highest.
10800     *
10801     * The next image shows different configurations of items and how they
10802     * are the previously mentioned options affect their sizes. In all cases,
10803     * the green line indicates the ascent, blue for the baseline and red for
10804     * the descent.
10805     *
10806     * @image html entry_item.png
10807     * @image latex entry_item.eps width=\textwidth
10808     *
10809     * And another one to show how size differs from absize. In the first one,
10810     * the scale value is set to 1.0, while the second one is using one of 2.0.
10811     *
10812     * @image html entry_item_scale.png
10813     * @image latex entry_item_scale.eps width=\textwidth
10814     *
10815     * After the size for an item is calculated, the entry will request an
10816     * object to place in its space. For this, the functions set with
10817     * elm_entry_item_provider_append() and related functions will be called
10818     * in order until one of them returns a @c non-NULL value. If no providers
10819     * are available, or all of them return @c NULL, then the entry falls back
10820     * to one of the internal defaults, provided the name matches with one of
10821     * them.
10822     *
10823     * All of the following are currently supported:
10824     *
10825     * - emoticon/angry
10826     * - emoticon/angry-shout
10827     * - emoticon/crazy-laugh
10828     * - emoticon/evil-laugh
10829     * - emoticon/evil
10830     * - emoticon/goggle-smile
10831     * - emoticon/grumpy
10832     * - emoticon/grumpy-smile
10833     * - emoticon/guilty
10834     * - emoticon/guilty-smile
10835     * - emoticon/haha
10836     * - emoticon/half-smile
10837     * - emoticon/happy-panting
10838     * - emoticon/happy
10839     * - emoticon/indifferent
10840     * - emoticon/kiss
10841     * - emoticon/knowing-grin
10842     * - emoticon/laugh
10843     * - emoticon/little-bit-sorry
10844     * - emoticon/love-lots
10845     * - emoticon/love
10846     * - emoticon/minimal-smile
10847     * - emoticon/not-happy
10848     * - emoticon/not-impressed
10849     * - emoticon/omg
10850     * - emoticon/opensmile
10851     * - emoticon/smile
10852     * - emoticon/sorry
10853     * - emoticon/squint-laugh
10854     * - emoticon/surprised
10855     * - emoticon/suspicious
10856     * - emoticon/tongue-dangling
10857     * - emoticon/tongue-poke
10858     * - emoticon/uh
10859     * - emoticon/unhappy
10860     * - emoticon/very-sorry
10861     * - emoticon/what
10862     * - emoticon/wink
10863     * - emoticon/worried
10864     * - emoticon/wtf
10865     *
10866     * Alternatively, an item may reference an image by its path, using
10867     * the URI form @c file:///path/to/an/image.png and the entry will then
10868     * use that image for the item.
10869     *
10870     * @section entry-files Loading and saving files
10871     *
10872     * Entries have convinience functions to load text from a file and save
10873     * changes back to it after a short delay. The automatic saving is enabled
10874     * by default, but can be disabled with elm_entry_autosave_set() and files
10875     * can be loaded directly as plain text or have any markup in them
10876     * recognized. See elm_entry_file_set() for more details.
10877     *
10878     * @section entry-signals Emitted signals
10879     *
10880     * This widget emits the following signals:
10881     *
10882     * @li "changed": The text within the entry was changed.
10883     * @li "changed,user": The text within the entry was changed because of user interaction.
10884     * @li "activated": The enter key was pressed on a single line entry.
10885     * @li "press": A mouse button has been pressed on the entry.
10886     * @li "longpressed": A mouse button has been pressed and held for a couple
10887     * seconds.
10888     * @li "clicked": The entry has been clicked (mouse press and release).
10889     * @li "clicked,double": The entry has been double clicked.
10890     * @li "clicked,triple": The entry has been triple clicked.
10891     * @li "focused": The entry has received focus.
10892     * @li "unfocused": The entry has lost focus.
10893     * @li "selection,paste": A paste of the clipboard contents was requested.
10894     * @li "selection,copy": A copy of the selected text into the clipboard was
10895     * requested.
10896     * @li "selection,cut": A cut of the selected text into the clipboard was
10897     * requested.
10898     * @li "selection,start": A selection has begun and no previous selection
10899     * existed.
10900     * @li "selection,changed": The current selection has changed.
10901     * @li "selection,cleared": The current selection has been cleared.
10902     * @li "cursor,changed": The cursor has changed position.
10903     * @li "anchor,clicked": An anchor has been clicked. The event_info
10904     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10905     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10906     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10907     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10908     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10909     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10910     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10911     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10912     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10913     * @li "preedit,changed": The preedit string has changed.
10914     * @li "language,changed": Program language changed.
10915     *
10916     * @section entry-examples
10917     *
10918     * An overview of the Entry API can be seen in @ref entry_example_01
10919     *
10920     * @{
10921     */
10922    /**
10923     * @typedef Elm_Entry_Anchor_Info
10924     *
10925     * The info sent in the callback for the "anchor,clicked" signals emitted
10926     * by entries.
10927     */
10928    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10929    /**
10930     * @struct _Elm_Entry_Anchor_Info
10931     *
10932     * The info sent in the callback for the "anchor,clicked" signals emitted
10933     * by entries.
10934     */
10935    struct _Elm_Entry_Anchor_Info
10936      {
10937         const char *name; /**< The name of the anchor, as stated in its href */
10938         int         button; /**< The mouse button used to click on it */
10939         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10940                     y, /**< Anchor geometry, relative to canvas */
10941                     w, /**< Anchor geometry, relative to canvas */
10942                     h; /**< Anchor geometry, relative to canvas */
10943      };
10944    /**
10945     * @typedef Elm_Entry_Filter_Cb
10946     * This callback type is used by entry filters to modify text.
10947     * @param data The data specified as the last param when adding the filter
10948     * @param entry The entry object
10949     * @param text A pointer to the location of the text being filtered. This data can be modified,
10950     * but any additional allocations must be managed by the user.
10951     * @see elm_entry_text_filter_append
10952     * @see elm_entry_text_filter_prepend
10953     */
10954    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10955
10956    /**
10957     * This adds an entry to @p parent object.
10958     *
10959     * By default, entries are:
10960     * @li not scrolled
10961     * @li multi-line
10962     * @li word wrapped
10963     * @li autosave is enabled
10964     *
10965     * @param parent The parent object
10966     * @return The new object or NULL if it cannot be created
10967     */
10968    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10969    /**
10970     * Sets the entry to single line mode.
10971     *
10972     * In single line mode, entries don't ever wrap when the text reaches the
10973     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10974     * key will generate an @c "activate" event instead of adding a new line.
10975     *
10976     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10977     * and pressing enter will break the text into a different line
10978     * without generating any events.
10979     *
10980     * @param obj The entry object
10981     * @param single_line If true, the text in the entry
10982     * will be on a single line.
10983     */
10984    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10985    /**
10986     * Gets whether the entry is set to be single line.
10987     *
10988     * @param obj The entry object
10989     * @return single_line If true, the text in the entry is set to display
10990     * on a single line.
10991     *
10992     * @see elm_entry_single_line_set()
10993     */
10994    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10995    /**
10996     * Sets the entry to password mode.
10997     *
10998     * In password mode, entries are implicitly single line and the display of
10999     * any text in them is replaced with asterisks (*).
11000     *
11001     * @param obj The entry object
11002     * @param password If true, password mode is enabled.
11003     */
11004    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11005    /**
11006     * Gets whether the entry is set to password mode.
11007     *
11008     * @param obj The entry object
11009     * @return If true, the entry is set to display all characters
11010     * as asterisks (*).
11011     *
11012     * @see elm_entry_password_set()
11013     */
11014    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11015    /**
11016     * This sets the text displayed within the entry to @p entry.
11017     *
11018     * @param obj The entry object
11019     * @param entry The text to be displayed
11020     *
11021     * @deprecated Use elm_object_text_set() instead.
11022     * @note Using this function bypasses text filters
11023     */
11024    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11025    /**
11026     * This returns the text currently shown in object @p entry.
11027     * See also elm_entry_entry_set().
11028     *
11029     * @param obj The entry object
11030     * @return The currently displayed text or NULL on failure
11031     *
11032     * @deprecated Use elm_object_text_get() instead.
11033     */
11034    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11035    /**
11036     * Appends @p entry to the text of the entry.
11037     *
11038     * Adds the text in @p entry to the end of any text already present in the
11039     * widget.
11040     *
11041     * The appended text is subject to any filters set for the widget.
11042     *
11043     * @param obj The entry object
11044     * @param entry The text to be displayed
11045     *
11046     * @see elm_entry_text_filter_append()
11047     */
11048    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11049    /**
11050     * Gets whether the entry is empty.
11051     *
11052     * Empty means no text at all. If there are any markup tags, like an item
11053     * tag for which no provider finds anything, and no text is displayed, this
11054     * function still returns EINA_FALSE.
11055     *
11056     * @param obj The entry object
11057     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11058     */
11059    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11060    /**
11061     * Gets any selected text within the entry.
11062     *
11063     * If there's any selected text in the entry, this function returns it as
11064     * a string in markup format. NULL is returned if no selection exists or
11065     * if an error occurred.
11066     *
11067     * The returned value points to an internal string and should not be freed
11068     * or modified in any way. If the @p entry object is deleted or its
11069     * contents are changed, the returned pointer should be considered invalid.
11070     *
11071     * @param obj The entry object
11072     * @return The selected text within the entry or NULL on failure
11073     */
11074    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11075    /**
11076     * Inserts the given text into the entry at the current cursor position.
11077     *
11078     * This inserts text at the cursor position as if it was typed
11079     * by the user (note that this also allows markup which a user
11080     * can't just "type" as it would be converted to escaped text, so this
11081     * call can be used to insert things like emoticon items or bold push/pop
11082     * tags, other font and color change tags etc.)
11083     *
11084     * If any selection exists, it will be replaced by the inserted text.
11085     *
11086     * The inserted text is subject to any filters set for the widget.
11087     *
11088     * @param obj The entry object
11089     * @param entry The text to insert
11090     *
11091     * @see elm_entry_text_filter_append()
11092     */
11093    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11094    /**
11095     * Set the line wrap type to use on multi-line entries.
11096     *
11097     * Sets the wrap type used by the entry to any of the specified in
11098     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11099     * line (without inserting a line break or paragraph separator) when it
11100     * reaches the far edge of the widget.
11101     *
11102     * Note that this only makes sense for multi-line entries. A widget set
11103     * to be single line will never wrap.
11104     *
11105     * @param obj The entry object
11106     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11107     */
11108    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11109    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11110    /**
11111     * Gets the wrap mode the entry was set to use.
11112     *
11113     * @param obj The entry object
11114     * @return Wrap type
11115     *
11116     * @see also elm_entry_line_wrap_set()
11117     */
11118    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11119    /**
11120     * Sets if the entry is to be editable or not.
11121     *
11122     * By default, entries are editable and when focused, any text input by the
11123     * user will be inserted at the current cursor position. But calling this
11124     * function with @p editable as EINA_FALSE will prevent the user from
11125     * inputting text into the entry.
11126     *
11127     * The only way to change the text of a non-editable entry is to use
11128     * elm_object_text_set(), elm_entry_entry_insert() and other related
11129     * functions.
11130     *
11131     * @param obj The entry object
11132     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11133     * if not, the entry is read-only and no user input is allowed.
11134     */
11135    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11136    /**
11137     * Gets whether the entry is editable or not.
11138     *
11139     * @param obj The entry object
11140     * @return If true, the entry is editable by the user.
11141     * If false, it is not editable by the user
11142     *
11143     * @see elm_entry_editable_set()
11144     */
11145    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11146    /**
11147     * This drops any existing text selection within the entry.
11148     *
11149     * @param obj The entry object
11150     */
11151    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11152    /**
11153     * This selects all text within the entry.
11154     *
11155     * @param obj The entry object
11156     */
11157    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11158    /**
11159     * This moves the cursor one place to the right within the entry.
11160     *
11161     * @param obj The entry object
11162     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11163     */
11164    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11165    /**
11166     * This moves the cursor one place to the left within the entry.
11167     *
11168     * @param obj The entry object
11169     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11170     */
11171    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11172    /**
11173     * This moves the cursor one line up within the entry.
11174     *
11175     * @param obj The entry object
11176     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11177     */
11178    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11179    /**
11180     * This moves the cursor one line down within the entry.
11181     *
11182     * @param obj The entry object
11183     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11184     */
11185    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11186    /**
11187     * This moves the cursor to the beginning of the entry.
11188     *
11189     * @param obj The entry object
11190     */
11191    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11192    /**
11193     * This moves the cursor to the end of the entry.
11194     *
11195     * @param obj The entry object
11196     */
11197    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11198    /**
11199     * This moves the cursor to the beginning of the current line.
11200     *
11201     * @param obj The entry object
11202     */
11203    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11204    /**
11205     * This moves the cursor to the end of the current line.
11206     *
11207     * @param obj The entry object
11208     */
11209    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11210    /**
11211     * This begins a selection within the entry as though
11212     * the user were holding down the mouse button to make a selection.
11213     *
11214     * @param obj The entry object
11215     */
11216    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11217    /**
11218     * This ends a selection within the entry as though
11219     * the user had just released the mouse button while making a selection.
11220     *
11221     * @param obj The entry object
11222     */
11223    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11224    /**
11225     * Gets whether a format node exists at the current cursor position.
11226     *
11227     * A format node is anything that defines how the text is rendered. It can
11228     * be a visible format node, such as a line break or a paragraph separator,
11229     * or an invisible one, such as bold begin or end tag.
11230     * This function returns whether any format node exists at the current
11231     * cursor position.
11232     *
11233     * @param obj The entry object
11234     * @return EINA_TRUE if the current cursor position contains a format node,
11235     * EINA_FALSE otherwise.
11236     *
11237     * @see elm_entry_cursor_is_visible_format_get()
11238     */
11239    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11240    /**
11241     * Gets if the current cursor position holds a visible format node.
11242     *
11243     * @param obj The entry object
11244     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11245     * if it's an invisible one or no format exists.
11246     *
11247     * @see elm_entry_cursor_is_format_get()
11248     */
11249    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11250    /**
11251     * Gets the character pointed by the cursor at its current position.
11252     *
11253     * This function returns a string with the utf8 character stored at the
11254     * current cursor position.
11255     * Only the text is returned, any format that may exist will not be part
11256     * of the return value.
11257     *
11258     * @param obj The entry object
11259     * @return The text pointed by the cursors.
11260     */
11261    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11262    /**
11263     * This function returns the geometry of the cursor.
11264     *
11265     * It's useful if you want to draw something on the cursor (or where it is),
11266     * or for example in the case of scrolled entry where you want to show the
11267     * cursor.
11268     *
11269     * @param obj The entry object
11270     * @param x returned geometry
11271     * @param y returned geometry
11272     * @param w returned geometry
11273     * @param h returned geometry
11274     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11275     */
11276    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);
11277    /**
11278     * Sets the cursor position in the entry to the given value
11279     *
11280     * The value in @p pos is the index of the character position within the
11281     * contents of the string as returned by elm_entry_cursor_pos_get().
11282     *
11283     * @param obj The entry object
11284     * @param pos The position of the cursor
11285     */
11286    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11287    /**
11288     * Retrieves the current position of the cursor in the entry
11289     *
11290     * @param obj The entry object
11291     * @return The cursor position
11292     */
11293    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11294    /**
11295     * This executes a "cut" action on the selected text in the entry.
11296     *
11297     * @param obj The entry object
11298     */
11299    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11300    /**
11301     * This executes a "copy" action on the selected text in the entry.
11302     *
11303     * @param obj The entry object
11304     */
11305    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11306    /**
11307     * This executes a "paste" action in the entry.
11308     *
11309     * @param obj The entry object
11310     */
11311    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11312    /**
11313     * This clears and frees the items in a entry's contextual (longpress)
11314     * menu.
11315     *
11316     * @param obj The entry object
11317     *
11318     * @see elm_entry_context_menu_item_add()
11319     */
11320    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11321    /**
11322     * This adds an item to the entry's contextual menu.
11323     *
11324     * A longpress on an entry will make the contextual menu show up, if this
11325     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11326     * By default, this menu provides a few options like enabling selection mode,
11327     * which is useful on embedded devices that need to be explicit about it,
11328     * and when a selection exists it also shows the copy and cut actions.
11329     *
11330     * With this function, developers can add other options to this menu to
11331     * perform any action they deem necessary.
11332     *
11333     * @param obj The entry object
11334     * @param label The item's text label
11335     * @param icon_file The item's icon file
11336     * @param icon_type The item's icon type
11337     * @param func The callback to execute when the item is clicked
11338     * @param data The data to associate with the item for related functions
11339     */
11340    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);
11341    /**
11342     * This disables the entry's contextual (longpress) menu.
11343     *
11344     * @param obj The entry object
11345     * @param disabled If true, the menu is disabled
11346     */
11347    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11348    /**
11349     * This returns whether the entry's contextual (longpress) menu is
11350     * disabled.
11351     *
11352     * @param obj The entry object
11353     * @return If true, the menu is disabled
11354     */
11355    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11356    /**
11357     * This appends a custom item provider to the list for that entry
11358     *
11359     * This appends the given callback. The list is walked from beginning to end
11360     * with each function called given the item href string in the text. If the
11361     * function returns an object handle other than NULL (it should create an
11362     * object to do this), then this object is used to replace that item. If
11363     * not the next provider is called until one provides an item object, or the
11364     * default provider in entry does.
11365     *
11366     * @param obj The entry object
11367     * @param func The function called to provide the item object
11368     * @param data The data passed to @p func
11369     *
11370     * @see @ref entry-items
11371     */
11372    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);
11373    /**
11374     * This prepends a custom item provider to the list for that entry
11375     *
11376     * This prepends the given callback. See elm_entry_item_provider_append() for
11377     * more information
11378     *
11379     * @param obj The entry object
11380     * @param func The function called to provide the item object
11381     * @param data The data passed to @p func
11382     */
11383    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);
11384    /**
11385     * This removes a custom item provider to the list for that entry
11386     *
11387     * This removes the given callback. See elm_entry_item_provider_append() for
11388     * more information
11389     *
11390     * @param obj The entry object
11391     * @param func The function called to provide the item object
11392     * @param data The data passed to @p func
11393     */
11394    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);
11395    /**
11396     * Append a filter function for text inserted in the entry
11397     *
11398     * Append the given callback to the list. This functions will be called
11399     * whenever any text is inserted into the entry, with the text to be inserted
11400     * as a parameter. The callback function is free to alter the text in any way
11401     * it wants, but it must remember to free the given pointer and update it.
11402     * If the new text is to be discarded, the function can free it and set its
11403     * text parameter to NULL. This will also prevent any following filters from
11404     * being called.
11405     *
11406     * @param obj The entry object
11407     * @param func The function to use as text filter
11408     * @param data User data to pass to @p func
11409     */
11410    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11411    /**
11412     * Prepend a filter function for text insdrted in the entry
11413     *
11414     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11415     * for more information
11416     *
11417     * @param obj The entry object
11418     * @param func The function to use as text filter
11419     * @param data User data to pass to @p func
11420     */
11421    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11422    /**
11423     * Remove a filter from the list
11424     *
11425     * Removes the given callback from the filter list. See
11426     * elm_entry_text_filter_append() for more information.
11427     *
11428     * @param obj The entry object
11429     * @param func The filter function to remove
11430     * @param data The user data passed when adding the function
11431     */
11432    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11433    /**
11434     * This converts a markup (HTML-like) string into UTF-8.
11435     *
11436     * The returned string is a malloc'ed buffer and it should be freed when
11437     * not needed anymore.
11438     *
11439     * @param s The string (in markup) to be converted
11440     * @return The converted string (in UTF-8). It should be freed.
11441     */
11442    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11443    /**
11444     * This converts a UTF-8 string into markup (HTML-like).
11445     *
11446     * The returned string is a malloc'ed buffer and it should be freed when
11447     * not needed anymore.
11448     *
11449     * @param s The string (in UTF-8) to be converted
11450     * @return The converted string (in markup). It should be freed.
11451     */
11452    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11453    /**
11454     * This sets the file (and implicitly loads it) for the text to display and
11455     * then edit. All changes are written back to the file after a short delay if
11456     * the entry object is set to autosave (which is the default).
11457     *
11458     * If the entry had any other file set previously, any changes made to it
11459     * will be saved if the autosave feature is enabled, otherwise, the file
11460     * will be silently discarded and any non-saved changes will be lost.
11461     *
11462     * @param obj The entry object
11463     * @param file The path to the file to load and save
11464     * @param format The file format
11465     */
11466    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11467    /**
11468     * Gets the file being edited by the entry.
11469     *
11470     * This function can be used to retrieve any file set on the entry for
11471     * edition, along with the format used to load and save it.
11472     *
11473     * @param obj The entry object
11474     * @param file The path to the file to load and save
11475     * @param format The file format
11476     */
11477    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11478    /**
11479     * This function writes any changes made to the file set with
11480     * elm_entry_file_set()
11481     *
11482     * @param obj The entry object
11483     */
11484    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11485    /**
11486     * This sets the entry object to 'autosave' the loaded text file or not.
11487     *
11488     * @param obj The entry object
11489     * @param autosave Autosave the loaded file or not
11490     *
11491     * @see elm_entry_file_set()
11492     */
11493    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11494    /**
11495     * This gets the entry object's 'autosave' status.
11496     *
11497     * @param obj The entry object
11498     * @return Autosave the loaded file or not
11499     *
11500     * @see elm_entry_file_set()
11501     */
11502    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11503    /**
11504     * Control pasting of text and images for the widget.
11505     *
11506     * Normally the entry allows both text and images to be pasted.  By setting
11507     * textonly to be true, this prevents images from being pasted.
11508     *
11509     * Note this only changes the behaviour of text.
11510     *
11511     * @param obj The entry object
11512     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11513     * text+image+other.
11514     */
11515    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11516    /**
11517     * Getting elm_entry text paste/drop mode.
11518     *
11519     * In textonly mode, only text may be pasted or dropped into the widget.
11520     *
11521     * @param obj The entry object
11522     * @return If the widget only accepts text from pastes.
11523     */
11524    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11525    /**
11526     * Enable or disable scrolling in entry
11527     *
11528     * Normally the entry is not scrollable unless you enable it with this call.
11529     *
11530     * @param obj The entry object
11531     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11532     */
11533    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11534    /**
11535     * Get the scrollable state of the entry
11536     *
11537     * Normally the entry is not scrollable. This gets the scrollable state
11538     * of the entry. See elm_entry_scrollable_set() for more information.
11539     *
11540     * @param obj The entry object
11541     * @return The scrollable state
11542     */
11543    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11544    /**
11545     * This sets a widget to be displayed to the left of a scrolled entry.
11546     *
11547     * @param obj The scrolled entry object
11548     * @param icon The widget to display on the left side of the scrolled
11549     * entry.
11550     *
11551     * @note A previously set widget will be destroyed.
11552     * @note If the object being set does not have minimum size hints set,
11553     * it won't get properly displayed.
11554     *
11555     * @see elm_entry_end_set()
11556     */
11557    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11558    /**
11559     * Gets the leftmost widget of the scrolled entry. This object is
11560     * owned by the scrolled entry and should not be modified.
11561     *
11562     * @param obj The scrolled entry object
11563     * @return the left widget inside the scroller
11564     */
11565    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11566    /**
11567     * Unset the leftmost widget of the scrolled entry, unparenting and
11568     * returning it.
11569     *
11570     * @param obj The scrolled entry object
11571     * @return the previously set icon sub-object of this entry, on
11572     * success.
11573     *
11574     * @see elm_entry_icon_set()
11575     */
11576    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11577    /**
11578     * Sets the visibility of the left-side widget of the scrolled entry,
11579     * set by elm_entry_icon_set().
11580     *
11581     * @param obj The scrolled entry object
11582     * @param setting EINA_TRUE if the object should be displayed,
11583     * EINA_FALSE if not.
11584     */
11585    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11586    /**
11587     * This sets a widget to be displayed to the end of a scrolled entry.
11588     *
11589     * @param obj The scrolled entry object
11590     * @param end The widget to display on the right side of the scrolled
11591     * entry.
11592     *
11593     * @note A previously set widget will be destroyed.
11594     * @note If the object being set does not have minimum size hints set,
11595     * it won't get properly displayed.
11596     *
11597     * @see elm_entry_icon_set
11598     */
11599    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11600    /**
11601     * Gets the endmost widget of the scrolled entry. This object is owned
11602     * by the scrolled entry and should not be modified.
11603     *
11604     * @param obj The scrolled entry object
11605     * @return the right widget inside the scroller
11606     */
11607    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11608    /**
11609     * Unset the endmost widget of the scrolled entry, unparenting and
11610     * returning it.
11611     *
11612     * @param obj The scrolled entry object
11613     * @return the previously set icon sub-object of this entry, on
11614     * success.
11615     *
11616     * @see elm_entry_icon_set()
11617     */
11618    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11619    /**
11620     * Sets the visibility of the end widget of the scrolled entry, set by
11621     * elm_entry_end_set().
11622     *
11623     * @param obj The scrolled entry object
11624     * @param setting EINA_TRUE if the object should be displayed,
11625     * EINA_FALSE if not.
11626     */
11627    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11628    /**
11629     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11630     * them).
11631     *
11632     * Setting an entry to single-line mode with elm_entry_single_line_set()
11633     * will automatically disable the display of scrollbars when the entry
11634     * moves inside its scroller.
11635     *
11636     * @param obj The scrolled entry object
11637     * @param h The horizontal scrollbar policy to apply
11638     * @param v The vertical scrollbar policy to apply
11639     */
11640    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11641    /**
11642     * This enables/disables bouncing within the entry.
11643     *
11644     * This function sets whether the entry will bounce when scrolling reaches
11645     * the end of the contained entry.
11646     *
11647     * @param obj The scrolled entry object
11648     * @param h The horizontal bounce state
11649     * @param v The vertical bounce state
11650     */
11651    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11652    /**
11653     * Get the bounce mode
11654     *
11655     * @param obj The Entry object
11656     * @param h_bounce Allow bounce horizontally
11657     * @param v_bounce Allow bounce vertically
11658     */
11659    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11660
11661    /* pre-made filters for entries */
11662    /**
11663     * @typedef Elm_Entry_Filter_Limit_Size
11664     *
11665     * Data for the elm_entry_filter_limit_size() entry filter.
11666     */
11667    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11668    /**
11669     * @struct _Elm_Entry_Filter_Limit_Size
11670     *
11671     * Data for the elm_entry_filter_limit_size() entry filter.
11672     */
11673    struct _Elm_Entry_Filter_Limit_Size
11674      {
11675         int max_char_count; /**< The maximum number of characters allowed. */
11676         int max_byte_count; /**< The maximum number of bytes allowed*/
11677      };
11678    /**
11679     * Filter inserted text based on user defined character and byte limits
11680     *
11681     * Add this filter to an entry to limit the characters that it will accept
11682     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11683     * The funtion works on the UTF-8 representation of the string, converting
11684     * it from the set markup, thus not accounting for any format in it.
11685     *
11686     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11687     * it as data when setting the filter. In it, it's possible to set limits
11688     * by character count or bytes (any of them is disabled if 0), and both can
11689     * be set at the same time. In that case, it first checks for characters,
11690     * then bytes.
11691     *
11692     * The function will cut the inserted text in order to allow only the first
11693     * number of characters that are still allowed. The cut is made in
11694     * characters, even when limiting by bytes, in order to always contain
11695     * valid ones and avoid half unicode characters making it in.
11696     *
11697     * This filter, like any others, does not apply when setting the entry text
11698     * directly with elm_object_text_set() (or the deprecated
11699     * elm_entry_entry_set()).
11700     */
11701    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11702    /**
11703     * @typedef Elm_Entry_Filter_Accept_Set
11704     *
11705     * Data for the elm_entry_filter_accept_set() entry filter.
11706     */
11707    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11708    /**
11709     * @struct _Elm_Entry_Filter_Accept_Set
11710     *
11711     * Data for the elm_entry_filter_accept_set() entry filter.
11712     */
11713    struct _Elm_Entry_Filter_Accept_Set
11714      {
11715         const char *accepted; /**< Set of characters accepted in the entry. */
11716         const char *rejected; /**< Set of characters rejected from the entry. */
11717      };
11718    /**
11719     * Filter inserted text based on accepted or rejected sets of characters
11720     *
11721     * Add this filter to an entry to restrict the set of accepted characters
11722     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11723     * This structure contains both accepted and rejected sets, but they are
11724     * mutually exclusive.
11725     *
11726     * The @c accepted set takes preference, so if it is set, the filter will
11727     * only work based on the accepted characters, ignoring anything in the
11728     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11729     *
11730     * In both cases, the function filters by matching utf8 characters to the
11731     * raw markup text, so it can be used to remove formatting tags.
11732     *
11733     * This filter, like any others, does not apply when setting the entry text
11734     * directly with elm_object_text_set() (or the deprecated
11735     * elm_entry_entry_set()).
11736     */
11737    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11738    /**
11739     * Set the input panel layout of the entry
11740     *
11741     * @param obj The entry object
11742     * @param layout layout type
11743     */
11744    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11745    /**
11746     * Get the input panel layout of the entry
11747     *
11748     * @param obj The entry object
11749     * @return layout type
11750     *
11751     * @see elm_entry_input_panel_layout_set
11752     */
11753    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11754    /**
11755     * Set the autocapitalization type on the immodule.
11756     *
11757     * @param obj The entry object
11758     * @param autocapital_type The type of autocapitalization
11759     */
11760    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11761    /**
11762     * Retrieve the autocapitalization type on the immodule.
11763     *
11764     * @param obj The entry object
11765     * @return autocapitalization type
11766     */
11767    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11768    /**
11769     * Sets the attribute to show the input panel automatically.
11770     *
11771     * @param obj The entry object
11772     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11773     */
11774    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11775    /**
11776     * Retrieve the attribute to show the input panel automatically.
11777     *
11778     * @param obj The entry object
11779     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11780     */
11781    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11782
11783    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11784    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11785    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11786    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11787    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11788    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11789    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11790
11791    EINA_DEPRECATED EAPI void         elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11792    EINA_DEPRECATED EAPI Evas_Coord   elm_entry_wrap_width_get(const Evas_Object *obj);
11793    EINA_DEPRECATED EAPI void         elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11794    EINA_DEPRECATED EAPI void         elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11795    EINA_DEPRECATED EAPI void         elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11796
11797    /**
11798     * @}
11799     */
11800
11801    /* composite widgets - these basically put together basic widgets above
11802     * in convenient packages that do more than basic stuff */
11803
11804    /* anchorview */
11805    /**
11806     * @defgroup Anchorview Anchorview
11807     *
11808     * @image html img/widget/anchorview/preview-00.png
11809     * @image latex img/widget/anchorview/preview-00.eps
11810     *
11811     * Anchorview is for displaying text that contains markup with anchors
11812     * like <c>\<a href=1234\>something\</\></c> in it.
11813     *
11814     * Besides being styled differently, the anchorview widget provides the
11815     * necessary functionality so that clicking on these anchors brings up a
11816     * popup with user defined content such as "call", "add to contacts" or
11817     * "open web page". This popup is provided using the @ref Hover widget.
11818     *
11819     * This widget is very similar to @ref Anchorblock, so refer to that
11820     * widget for an example. The only difference Anchorview has is that the
11821     * widget is already provided with scrolling functionality, so if the
11822     * text set to it is too large to fit in the given space, it will scroll,
11823     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11824     * text can be displayed.
11825     *
11826     * This widget emits the following signals:
11827     * @li "anchor,clicked": will be called when an anchor is clicked. The
11828     * @p event_info parameter on the callback will be a pointer of type
11829     * ::Elm_Entry_Anchorview_Info.
11830     *
11831     * See @ref Anchorblock for an example on how to use both of them.
11832     *
11833     * @see Anchorblock
11834     * @see Entry
11835     * @see Hover
11836     *
11837     * @{
11838     */
11839    /**
11840     * @typedef Elm_Entry_Anchorview_Info
11841     *
11842     * The info sent in the callback for "anchor,clicked" signals emitted by
11843     * the Anchorview widget.
11844     */
11845    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11846    /**
11847     * @struct _Elm_Entry_Anchorview_Info
11848     *
11849     * The info sent in the callback for "anchor,clicked" signals emitted by
11850     * the Anchorview widget.
11851     */
11852    struct _Elm_Entry_Anchorview_Info
11853      {
11854         const char     *name; /**< Name of the anchor, as indicated in its href
11855                                    attribute */
11856         int             button; /**< The mouse button used to click on it */
11857         Evas_Object    *hover; /**< The hover object to use for the popup */
11858         struct {
11859              Evas_Coord    x, y, w, h;
11860         } anchor, /**< Geometry selection of text used as anchor */
11861           hover_parent; /**< Geometry of the object used as parent by the
11862                              hover */
11863         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11864                                              for content on the left side of
11865                                              the hover. Before calling the
11866                                              callback, the widget will make the
11867                                              necessary calculations to check
11868                                              which sides are fit to be set with
11869                                              content, based on the position the
11870                                              hover is activated and its distance
11871                                              to the edges of its parent object
11872                                              */
11873         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11874                                               the right side of the hover.
11875                                               See @ref hover_left */
11876         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11877                                             of the hover. See @ref hover_left */
11878         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11879                                                below the hover. See @ref
11880                                                hover_left */
11881      };
11882    /**
11883     * Add a new Anchorview object
11884     *
11885     * @param parent The parent object
11886     * @return The new object or NULL if it cannot be created
11887     */
11888    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11889    /**
11890     * Set the text to show in the anchorview
11891     *
11892     * Sets the text of the anchorview to @p text. This text can include markup
11893     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11894     * text that will be specially styled and react to click events, ended with
11895     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11896     * "anchor,clicked" signal that you can attach a callback to with
11897     * evas_object_smart_callback_add(). The name of the anchor given in the
11898     * event info struct will be the one set in the href attribute, in this
11899     * case, anchorname.
11900     *
11901     * Other markup can be used to style the text in different ways, but it's
11902     * up to the style defined in the theme which tags do what.
11903     * @deprecated use elm_object_text_set() instead.
11904     */
11905    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11906    /**
11907     * Get the markup text set for the anchorview
11908     *
11909     * Retrieves the text set on the anchorview, with markup tags included.
11910     *
11911     * @param obj The anchorview object
11912     * @return The markup text set or @c NULL if nothing was set or an error
11913     * occurred
11914     * @deprecated use elm_object_text_set() instead.
11915     */
11916    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11917    /**
11918     * Set the parent of the hover popup
11919     *
11920     * Sets the parent object to use by the hover created by the anchorview
11921     * when an anchor is clicked. See @ref Hover for more details on this.
11922     * If no parent is set, the same anchorview object will be used.
11923     *
11924     * @param obj The anchorview object
11925     * @param parent The object to use as parent for the hover
11926     */
11927    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11928    /**
11929     * Get the parent of the hover popup
11930     *
11931     * Get the object used as parent for the hover created by the anchorview
11932     * widget. See @ref Hover for more details on this.
11933     *
11934     * @param obj The anchorview object
11935     * @return The object used as parent for the hover, NULL if none is set.
11936     */
11937    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11938    /**
11939     * Set the style that the hover should use
11940     *
11941     * When creating the popup hover, anchorview will request that it's
11942     * themed according to @p style.
11943     *
11944     * @param obj The anchorview object
11945     * @param style The style to use for the underlying hover
11946     *
11947     * @see elm_object_style_set()
11948     */
11949    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11950    /**
11951     * Get the style that the hover should use
11952     *
11953     * Get the style the hover created by anchorview will use.
11954     *
11955     * @param obj The anchorview object
11956     * @return The style to use by the hover. NULL means the default is used.
11957     *
11958     * @see elm_object_style_set()
11959     */
11960    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11961    /**
11962     * Ends the hover popup in the anchorview
11963     *
11964     * When an anchor is clicked, the anchorview widget will create a hover
11965     * object to use as a popup with user provided content. This function
11966     * terminates this popup, returning the anchorview to its normal state.
11967     *
11968     * @param obj The anchorview object
11969     */
11970    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11971    /**
11972     * Set bouncing behaviour when the scrolled content reaches an edge
11973     *
11974     * Tell the internal scroller object whether it should bounce or not
11975     * when it reaches the respective edges for each axis.
11976     *
11977     * @param obj The anchorview object
11978     * @param h_bounce Whether to bounce or not in the horizontal axis
11979     * @param v_bounce Whether to bounce or not in the vertical axis
11980     *
11981     * @see elm_scroller_bounce_set()
11982     */
11983    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11984    /**
11985     * Get the set bouncing behaviour of the internal scroller
11986     *
11987     * Get whether the internal scroller should bounce when the edge of each
11988     * axis is reached scrolling.
11989     *
11990     * @param obj The anchorview object
11991     * @param h_bounce Pointer where to store the bounce state of the horizontal
11992     *                 axis
11993     * @param v_bounce Pointer where to store the bounce state of the vertical
11994     *                 axis
11995     *
11996     * @see elm_scroller_bounce_get()
11997     */
11998    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11999    /**
12000     * Appends a custom item provider to the given anchorview
12001     *
12002     * Appends the given function to the list of items providers. This list is
12003     * called, one function at a time, with the given @p data pointer, the
12004     * anchorview object and, in the @p item parameter, the item name as
12005     * referenced in its href string. Following functions in the list will be
12006     * called in order until one of them returns something different to NULL,
12007     * which should be an Evas_Object which will be used in place of the item
12008     * element.
12009     *
12010     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12011     * href=item/name\>\</item\>
12012     *
12013     * @param obj The anchorview object
12014     * @param func The function to add to the list of providers
12015     * @param data User data that will be passed to the callback function
12016     *
12017     * @see elm_entry_item_provider_append()
12018     */
12019    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);
12020    /**
12021     * Prepend a custom item provider to the given anchorview
12022     *
12023     * Like elm_anchorview_item_provider_append(), but it adds the function
12024     * @p func to the beginning of the list, instead of the end.
12025     *
12026     * @param obj The anchorview object
12027     * @param func The function to add to the list of providers
12028     * @param data User data that will be passed to the callback function
12029     */
12030    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);
12031    /**
12032     * Remove a custom item provider from the list of the given anchorview
12033     *
12034     * Removes the function and data pairing that matches @p func and @p data.
12035     * That is, unless the same function and same user data are given, the
12036     * function will not be removed from the list. This allows us to add the
12037     * same callback several times, with different @p data pointers and be
12038     * able to remove them later without conflicts.
12039     *
12040     * @param obj The anchorview object
12041     * @param func The function to remove from the list
12042     * @param data The data matching the function to remove from the list
12043     */
12044    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);
12045    /**
12046     * @}
12047     */
12048
12049    /* anchorblock */
12050    /**
12051     * @defgroup Anchorblock Anchorblock
12052     *
12053     * @image html img/widget/anchorblock/preview-00.png
12054     * @image latex img/widget/anchorblock/preview-00.eps
12055     *
12056     * Anchorblock is for displaying text that contains markup with anchors
12057     * like <c>\<a href=1234\>something\</\></c> in it.
12058     *
12059     * Besides being styled differently, the anchorblock widget provides the
12060     * necessary functionality so that clicking on these anchors brings up a
12061     * popup with user defined content such as "call", "add to contacts" or
12062     * "open web page". This popup is provided using the @ref Hover widget.
12063     *
12064     * This widget emits the following signals:
12065     * @li "anchor,clicked": will be called when an anchor is clicked. The
12066     * @p event_info parameter on the callback will be a pointer of type
12067     * ::Elm_Entry_Anchorblock_Info.
12068     *
12069     * @see Anchorview
12070     * @see Entry
12071     * @see Hover
12072     *
12073     * Since examples are usually better than plain words, we might as well
12074     * try @ref tutorial_anchorblock_example "one".
12075     */
12076    /**
12077     * @addtogroup Anchorblock
12078     * @{
12079     */
12080    /**
12081     * @typedef Elm_Entry_Anchorblock_Info
12082     *
12083     * The info sent in the callback for "anchor,clicked" signals emitted by
12084     * the Anchorblock widget.
12085     */
12086    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12087    /**
12088     * @struct _Elm_Entry_Anchorblock_Info
12089     *
12090     * The info sent in the callback for "anchor,clicked" signals emitted by
12091     * the Anchorblock widget.
12092     */
12093    struct _Elm_Entry_Anchorblock_Info
12094      {
12095         const char     *name; /**< Name of the anchor, as indicated in its href
12096                                    attribute */
12097         int             button; /**< The mouse button used to click on it */
12098         Evas_Object    *hover; /**< The hover object to use for the popup */
12099         struct {
12100              Evas_Coord    x, y, w, h;
12101         } anchor, /**< Geometry selection of text used as anchor */
12102           hover_parent; /**< Geometry of the object used as parent by the
12103                              hover */
12104         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12105                                              for content on the left side of
12106                                              the hover. Before calling the
12107                                              callback, the widget will make the
12108                                              necessary calculations to check
12109                                              which sides are fit to be set with
12110                                              content, based on the position the
12111                                              hover is activated and its distance
12112                                              to the edges of its parent object
12113                                              */
12114         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12115                                               the right side of the hover.
12116                                               See @ref hover_left */
12117         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12118                                             of the hover. See @ref hover_left */
12119         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12120                                                below the hover. See @ref
12121                                                hover_left */
12122      };
12123    /**
12124     * Add a new Anchorblock object
12125     *
12126     * @param parent The parent object
12127     * @return The new object or NULL if it cannot be created
12128     */
12129    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12130    /**
12131     * Set the text to show in the anchorblock
12132     *
12133     * Sets the text of the anchorblock to @p text. This text can include markup
12134     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12135     * of text that will be specially styled and react to click events, ended
12136     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12137     * "anchor,clicked" signal that you can attach a callback to with
12138     * evas_object_smart_callback_add(). The name of the anchor given in the
12139     * event info struct will be the one set in the href attribute, in this
12140     * case, anchorname.
12141     *
12142     * Other markup can be used to style the text in different ways, but it's
12143     * up to the style defined in the theme which tags do what.
12144     * @deprecated use elm_object_text_set() instead.
12145     */
12146    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12147    /**
12148     * Get the markup text set for the anchorblock
12149     *
12150     * Retrieves the text set on the anchorblock, with markup tags included.
12151     *
12152     * @param obj The anchorblock object
12153     * @return The markup text set or @c NULL if nothing was set or an error
12154     * occurred
12155     * @deprecated use elm_object_text_set() instead.
12156     */
12157    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12158    /**
12159     * Set the parent of the hover popup
12160     *
12161     * Sets the parent object to use by the hover created by the anchorblock
12162     * when an anchor is clicked. See @ref Hover for more details on this.
12163     *
12164     * @param obj The anchorblock object
12165     * @param parent The object to use as parent for the hover
12166     */
12167    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12168    /**
12169     * Get the parent of the hover popup
12170     *
12171     * Get the object used as parent for the hover created by the anchorblock
12172     * widget. See @ref Hover for more details on this.
12173     * If no parent is set, the same anchorblock object will be used.
12174     *
12175     * @param obj The anchorblock object
12176     * @return The object used as parent for the hover, NULL if none is set.
12177     */
12178    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12179    /**
12180     * Set the style that the hover should use
12181     *
12182     * When creating the popup hover, anchorblock will request that it's
12183     * themed according to @p style.
12184     *
12185     * @param obj The anchorblock object
12186     * @param style The style to use for the underlying hover
12187     *
12188     * @see elm_object_style_set()
12189     */
12190    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12191    /**
12192     * Get the style that the hover should use
12193     *
12194     * Get the style, the hover created by anchorblock will use.
12195     *
12196     * @param obj The anchorblock object
12197     * @return The style to use by the hover. NULL means the default is used.
12198     *
12199     * @see elm_object_style_set()
12200     */
12201    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12202    /**
12203     * Ends the hover popup in the anchorblock
12204     *
12205     * When an anchor is clicked, the anchorblock widget will create a hover
12206     * object to use as a popup with user provided content. This function
12207     * terminates this popup, returning the anchorblock to its normal state.
12208     *
12209     * @param obj The anchorblock object
12210     */
12211    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12212    /**
12213     * Appends a custom item provider to the given anchorblock
12214     *
12215     * Appends the given function to the list of items providers. This list is
12216     * called, one function at a time, with the given @p data pointer, the
12217     * anchorblock object and, in the @p item parameter, the item name as
12218     * referenced in its href string. Following functions in the list will be
12219     * called in order until one of them returns something different to NULL,
12220     * which should be an Evas_Object which will be used in place of the item
12221     * element.
12222     *
12223     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12224     * href=item/name\>\</item\>
12225     *
12226     * @param obj The anchorblock object
12227     * @param func The function to add to the list of providers
12228     * @param data User data that will be passed to the callback function
12229     *
12230     * @see elm_entry_item_provider_append()
12231     */
12232    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);
12233    /**
12234     * Prepend a custom item provider to the given anchorblock
12235     *
12236     * Like elm_anchorblock_item_provider_append(), but it adds the function
12237     * @p func to the beginning of the list, instead of the end.
12238     *
12239     * @param obj The anchorblock object
12240     * @param func The function to add to the list of providers
12241     * @param data User data that will be passed to the callback function
12242     */
12243    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);
12244    /**
12245     * Remove a custom item provider from the list of the given anchorblock
12246     *
12247     * Removes the function and data pairing that matches @p func and @p data.
12248     * That is, unless the same function and same user data are given, the
12249     * function will not be removed from the list. This allows us to add the
12250     * same callback several times, with different @p data pointers and be
12251     * able to remove them later without conflicts.
12252     *
12253     * @param obj The anchorblock object
12254     * @param func The function to remove from the list
12255     * @param data The data matching the function to remove from the list
12256     */
12257    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);
12258    /**
12259     * @}
12260     */
12261
12262    /**
12263     * @defgroup Bubble Bubble
12264     *
12265     * @image html img/widget/bubble/preview-00.png
12266     * @image latex img/widget/bubble/preview-00.eps
12267     * @image html img/widget/bubble/preview-01.png
12268     * @image latex img/widget/bubble/preview-01.eps
12269     * @image html img/widget/bubble/preview-02.png
12270     * @image latex img/widget/bubble/preview-02.eps
12271     *
12272     * @brief The Bubble is a widget to show text similar to how speech is
12273     * represented in comics.
12274     *
12275     * The bubble widget contains 5 important visual elements:
12276     * @li The frame is a rectangle with rounded edjes and an "arrow".
12277     * @li The @p icon is an image to which the frame's arrow points to.
12278     * @li The @p label is a text which appears to the right of the icon if the
12279     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12280     * otherwise.
12281     * @li The @p info is a text which appears to the right of the label. Info's
12282     * font is of a ligther color than label.
12283     * @li The @p content is an evas object that is shown inside the frame.
12284     *
12285     * The position of the arrow, icon, label and info depends on which corner is
12286     * selected. The four available corners are:
12287     * @li "top_left" - Default
12288     * @li "top_right"
12289     * @li "bottom_left"
12290     * @li "bottom_right"
12291     *
12292     * Signals that you can add callbacks for are:
12293     * @li "clicked" - This is called when a user has clicked the bubble.
12294     *
12295     * Default contents parts of the bubble that you can use for are:
12296     * @li "default" - A content of the bubble
12297     * @li "icon" - An icon of the bubble
12298     *
12299     * Default text parts of the button widget that you can use for are:
12300     * @li NULL - Label of the bubble
12301     * 
12302          * For an example of using a buble see @ref bubble_01_example_page "this".
12303     *
12304     * @{
12305     */
12306
12307    /**
12308     * Add a new bubble to the parent
12309     *
12310     * @param parent The parent object
12311     * @return The new object or NULL if it cannot be created
12312     *
12313     * This function adds a text bubble to the given parent evas object.
12314     */
12315    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12316    /**
12317     * Set the label of the bubble
12318     *
12319     * @param obj The bubble object
12320     * @param label The string to set in the label
12321     *
12322     * This function sets the title of the bubble. Where this appears depends on
12323     * the selected corner.
12324     * @deprecated use elm_object_text_set() instead.
12325     */
12326    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12327    /**
12328     * Get the label of the bubble
12329     *
12330     * @param obj The bubble object
12331     * @return The string of set in the label
12332     *
12333     * This function gets the title of the bubble.
12334     * @deprecated use elm_object_text_get() instead.
12335     */
12336    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12337    /**
12338     * Set the info of the bubble
12339     *
12340     * @param obj The bubble object
12341     * @param info The given info about the bubble
12342     *
12343     * This function sets the info of the bubble. Where this appears depends on
12344     * the selected corner.
12345     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12346     */
12347    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12348    /**
12349     * Get the info of the bubble
12350     *
12351     * @param obj The bubble object
12352     *
12353     * @return The "info" string of the bubble
12354     *
12355     * This function gets the info text.
12356     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12357     */
12358    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12359    /**
12360     * Set the content to be shown in the bubble
12361     *
12362     * Once the content object is set, a previously set one will be deleted.
12363     * If you want to keep the old content object, use the
12364     * elm_bubble_content_unset() function.
12365     *
12366     * @param obj The bubble object
12367     * @param content The given content of the bubble
12368     *
12369     * This function sets the content shown on the middle of the bubble.
12370     */
12371    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12372    /**
12373     * Get the content shown in the bubble
12374     *
12375     * Return the content object which is set for this widget.
12376     *
12377     * @param obj The bubble object
12378     * @return The content that is being used
12379     */
12380    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12381    /**
12382     * Unset the content shown in the bubble
12383     *
12384     * Unparent and return the content object which was set for this widget.
12385     *
12386     * @param obj The bubble object
12387     * @return The content that was being used
12388     */
12389    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12390    /**
12391     * Set the icon of the bubble
12392     *
12393     * Once the icon object is set, a previously set one will be deleted.
12394     * If you want to keep the old content object, use the
12395     * elm_icon_content_unset() function.
12396     *
12397     * @param obj The bubble object
12398     * @param icon The given icon for the bubble
12399     *
12400     * @deprecated use elm_object_part_content_set() instead
12401     *
12402     */
12403    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12404    /**
12405     * Get the icon of the bubble
12406     *
12407     * @param obj The bubble object
12408     * @return The icon for the bubble
12409     *
12410     * This function gets the icon shown on the top left of bubble.
12411     *
12412     * @deprecated use elm_object_part_content_get() instead
12413     *
12414     */
12415    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12416    /**
12417     * Unset the icon of the bubble
12418     *
12419     * Unparent and return the icon object which was set for this widget.
12420     *
12421     * @param obj The bubble object
12422     * @return The icon that was being used
12423     *
12424     * @deprecated use elm_object_part_content_unset() instead
12425     *
12426     */
12427    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12428    /**
12429     * Set the corner of the bubble
12430     *
12431     * @param obj The bubble object.
12432     * @param corner The given corner for the bubble.
12433     *
12434     * This function sets the corner of the bubble. The corner will be used to
12435     * determine where the arrow in the frame points to and where label, icon and
12436     * info are shown.
12437     *
12438     * Possible values for corner are:
12439     * @li "top_left" - Default
12440     * @li "top_right"
12441     * @li "bottom_left"
12442     * @li "bottom_right"
12443     */
12444    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12445    /**
12446     * Get the corner of the bubble
12447     *
12448     * @param obj The bubble object.
12449     * @return The given corner for the bubble.
12450     *
12451     * This function gets the selected corner of the bubble.
12452     */
12453    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12454
12455    EINA_DEPRECATED EAPI void         elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12456    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12457
12458    /**
12459     * @}
12460     */
12461
12462    /**
12463     * @defgroup Photo Photo
12464     *
12465     * For displaying the photo of a person (contact). Simple, yet
12466     * with a very specific purpose.
12467     *
12468     * Signals that you can add callbacks for are:
12469     *
12470     * "clicked" - This is called when a user has clicked the photo
12471     * "drag,start" - Someone started dragging the image out of the object
12472     * "drag,end" - Dragged item was dropped (somewhere)
12473     *
12474     * @{
12475     */
12476
12477    /**
12478     * Add a new photo to the parent
12479     *
12480     * @param parent The parent object
12481     * @return The new object or NULL if it cannot be created
12482     *
12483     * @ingroup Photo
12484     */
12485    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12486
12487    /**
12488     * Set the file that will be used as photo
12489     *
12490     * @param obj The photo object
12491     * @param file The path to file that will be used as photo
12492     *
12493     * @return (1 = success, 0 = error)
12494     *
12495     * @ingroup Photo
12496     */
12497    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12498
12499     /**
12500     * Set the file that will be used as thumbnail in the photo.
12501     *
12502     * @param obj The photo object.
12503     * @param file The path to file that will be used as thumb.
12504     * @param group The key used in case of an EET file.
12505     *
12506     * @ingroup Photo
12507     */
12508    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12509
12510    /**
12511     * Set the size that will be used on the photo
12512     *
12513     * @param obj The photo object
12514     * @param size The size that the photo will be
12515     *
12516     * @ingroup Photo
12517     */
12518    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12519
12520    /**
12521     * Set if the photo should be completely visible or not.
12522     *
12523     * @param obj The photo object
12524     * @param fill if true the photo will be completely visible
12525     *
12526     * @ingroup Photo
12527     */
12528    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12529
12530    /**
12531     * Set editability of the photo.
12532     *
12533     * An editable photo can be dragged to or from, and can be cut or
12534     * pasted too.  Note that pasting an image or dropping an item on
12535     * the image will delete the existing content.
12536     *
12537     * @param obj The photo object.
12538     * @param set To set of clear editablity.
12539     */
12540    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12541
12542    /**
12543     * @}
12544     */
12545
12546    /* gesture layer */
12547    /**
12548     * @defgroup Elm_Gesture_Layer Gesture Layer
12549     * Gesture Layer Usage:
12550     *
12551     * Use Gesture Layer to detect gestures.
12552     * The advantage is that you don't have to implement
12553     * gesture detection, just set callbacks of gesture state.
12554     * By using gesture layer we make standard interface.
12555     *
12556     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12557     * with a parent object parameter.
12558     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12559     * call. Usually with same object as target (2nd parameter).
12560     *
12561     * Now you need to tell gesture layer what gestures you follow.
12562     * This is done with @ref elm_gesture_layer_cb_set call.
12563     * By setting the callback you actually saying to gesture layer:
12564     * I would like to know when the gesture @ref Elm_Gesture_Types
12565     * switches to state @ref Elm_Gesture_State.
12566     *
12567     * Next, you need to implement the actual action that follows the input
12568     * in your callback.
12569     *
12570     * Note that if you like to stop being reported about a gesture, just set
12571     * all callbacks referring this gesture to NULL.
12572     * (again with @ref elm_gesture_layer_cb_set)
12573     *
12574     * The information reported by gesture layer to your callback is depending
12575     * on @ref Elm_Gesture_Types:
12576     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12577     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12578     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12579     *
12580     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12581     * @ref ELM_GESTURE_MOMENTUM.
12582     *
12583     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12584     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12585     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12586     * Note that we consider a flick as a line-gesture that should be completed
12587     * in flick-time-limit as defined in @ref Config.
12588     *
12589     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12590     *
12591     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12592     *
12593     *
12594     * Gesture Layer Tweaks:
12595     *
12596     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12597     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12598     *
12599     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12600     * so gesture starts when user touches (a *DOWN event) touch-surface
12601     * and ends when no fingers touches surface (a *UP event).
12602     */
12603
12604    /**
12605     * @enum _Elm_Gesture_Types
12606     * Enum of supported gesture types.
12607     * @ingroup Elm_Gesture_Layer
12608     */
12609    enum _Elm_Gesture_Types
12610      {
12611         ELM_GESTURE_FIRST = 0,
12612
12613         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12614         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12615         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12616         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12617
12618         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12619
12620         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12621         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12622
12623         ELM_GESTURE_ZOOM, /**< Zoom */
12624         ELM_GESTURE_ROTATE, /**< Rotate */
12625
12626         ELM_GESTURE_LAST
12627      };
12628
12629    /**
12630     * @typedef Elm_Gesture_Types
12631     * gesture types enum
12632     * @ingroup Elm_Gesture_Layer
12633     */
12634    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12635
12636    /**
12637     * @enum _Elm_Gesture_State
12638     * Enum of gesture states.
12639     * @ingroup Elm_Gesture_Layer
12640     */
12641    enum _Elm_Gesture_State
12642      {
12643         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12644         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12645         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12646         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12647         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12648      };
12649
12650    /**
12651     * @typedef Elm_Gesture_State
12652     * gesture states enum
12653     * @ingroup Elm_Gesture_Layer
12654     */
12655    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12656
12657    /**
12658     * @struct _Elm_Gesture_Taps_Info
12659     * Struct holds taps info for user
12660     * @ingroup Elm_Gesture_Layer
12661     */
12662    struct _Elm_Gesture_Taps_Info
12663      {
12664         Evas_Coord x, y;         /**< Holds center point between fingers */
12665         unsigned int n;          /**< Number of fingers tapped           */
12666         unsigned int timestamp;  /**< event timestamp       */
12667      };
12668
12669    /**
12670     * @typedef Elm_Gesture_Taps_Info
12671     * holds taps info for user
12672     * @ingroup Elm_Gesture_Layer
12673     */
12674    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12675
12676    /**
12677     * @struct _Elm_Gesture_Momentum_Info
12678     * Struct holds momentum info for user
12679     * x1 and y1 are not necessarily in sync
12680     * x1 holds x value of x direction starting point
12681     * and same holds for y1.
12682     * This is noticeable when doing V-shape movement
12683     * @ingroup Elm_Gesture_Layer
12684     */
12685    struct _Elm_Gesture_Momentum_Info
12686      {  /* Report line ends, timestamps, and momentum computed        */
12687         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12688         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12689         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12690         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12691
12692         unsigned int tx; /**< Timestamp of start of final x-swipe */
12693         unsigned int ty; /**< Timestamp of start of final y-swipe */
12694
12695         Evas_Coord mx; /**< Momentum on X */
12696         Evas_Coord my; /**< Momentum on Y */
12697
12698         unsigned int n;  /**< Number of fingers */
12699      };
12700
12701    /**
12702     * @typedef Elm_Gesture_Momentum_Info
12703     * holds momentum info for user
12704     * @ingroup Elm_Gesture_Layer
12705     */
12706     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12707
12708    /**
12709     * @struct _Elm_Gesture_Line_Info
12710     * Struct holds line info for user
12711     * @ingroup Elm_Gesture_Layer
12712     */
12713    struct _Elm_Gesture_Line_Info
12714      {  /* Report line ends, timestamps, and momentum computed      */
12715         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12716         double angle;              /**< Angle (direction) of lines  */
12717      };
12718
12719    /**
12720     * @typedef Elm_Gesture_Line_Info
12721     * Holds line info for user
12722     * @ingroup Elm_Gesture_Layer
12723     */
12724     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12725
12726    /**
12727     * @struct _Elm_Gesture_Zoom_Info
12728     * Struct holds zoom info for user
12729     * @ingroup Elm_Gesture_Layer
12730     */
12731    struct _Elm_Gesture_Zoom_Info
12732      {
12733         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12734         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12735         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12736         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12737      };
12738
12739    /**
12740     * @typedef Elm_Gesture_Zoom_Info
12741     * Holds zoom info for user
12742     * @ingroup Elm_Gesture_Layer
12743     */
12744    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12745
12746    /**
12747     * @struct _Elm_Gesture_Rotate_Info
12748     * Struct holds rotation info for user
12749     * @ingroup Elm_Gesture_Layer
12750     */
12751    struct _Elm_Gesture_Rotate_Info
12752      {
12753         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12754         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12755         double base_angle; /**< Holds start-angle */
12756         double angle;      /**< Rotation value: 0.0 means no rotation         */
12757         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12758      };
12759
12760    /**
12761     * @typedef Elm_Gesture_Rotate_Info
12762     * Holds rotation info for user
12763     * @ingroup Elm_Gesture_Layer
12764     */
12765    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12766
12767    /**
12768     * @typedef Elm_Gesture_Event_Cb
12769     * User callback used to stream gesture info from gesture layer
12770     * @param data user data
12771     * @param event_info gesture report info
12772     * Returns a flag field to be applied on the causing event.
12773     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12774     * upon the event, in an irreversible way.
12775     *
12776     * @ingroup Elm_Gesture_Layer
12777     */
12778    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12779
12780    /**
12781     * Use function to set callbacks to be notified about
12782     * change of state of gesture.
12783     * When a user registers a callback with this function
12784     * this means this gesture has to be tested.
12785     *
12786     * When ALL callbacks for a gesture are set to NULL
12787     * it means user isn't interested in gesture-state
12788     * and it will not be tested.
12789     *
12790     * @param obj Pointer to gesture-layer.
12791     * @param idx The gesture you would like to track its state.
12792     * @param cb callback function pointer.
12793     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12794     * @param data user info to be sent to callback (usually, Smart Data)
12795     *
12796     * @ingroup Elm_Gesture_Layer
12797     */
12798    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);
12799
12800    /**
12801     * Call this function to get repeat-events settings.
12802     *
12803     * @param obj Pointer to gesture-layer.
12804     *
12805     * @return repeat events settings.
12806     * @see elm_gesture_layer_hold_events_set()
12807     * @ingroup Elm_Gesture_Layer
12808     */
12809    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12810
12811    /**
12812     * This function called in order to make gesture-layer repeat events.
12813     * Set this of you like to get the raw events only if gestures were not detected.
12814     * Clear this if you like gesture layer to fwd events as testing gestures.
12815     *
12816     * @param obj Pointer to gesture-layer.
12817     * @param r Repeat: TRUE/FALSE
12818     *
12819     * @ingroup Elm_Gesture_Layer
12820     */
12821    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12822
12823    /**
12824     * This function sets step-value for zoom action.
12825     * Set step to any positive value.
12826     * Cancel step setting by setting to 0.0
12827     *
12828     * @param obj Pointer to gesture-layer.
12829     * @param s new zoom step value.
12830     *
12831     * @ingroup Elm_Gesture_Layer
12832     */
12833    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12834
12835    /**
12836     * This function sets step-value for rotate action.
12837     * Set step to any positive value.
12838     * Cancel step setting by setting to 0.0
12839     *
12840     * @param obj Pointer to gesture-layer.
12841     * @param s new roatate step value.
12842     *
12843     * @ingroup Elm_Gesture_Layer
12844     */
12845    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12846
12847    /**
12848     * This function called to attach gesture-layer to an Evas_Object.
12849     * @param obj Pointer to gesture-layer.
12850     * @param t Pointer to underlying object (AKA Target)
12851     *
12852     * @return TRUE, FALSE on success, failure.
12853     *
12854     * @ingroup Elm_Gesture_Layer
12855     */
12856    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12857
12858    /**
12859     * Call this function to construct a new gesture-layer object.
12860     * This does not activate the gesture layer. You have to
12861     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12862     *
12863     * @param parent the parent object.
12864     *
12865     * @return Pointer to new gesture-layer object.
12866     *
12867     * @ingroup Elm_Gesture_Layer
12868     */
12869    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12870
12871    /**
12872     * @defgroup Thumb Thumb
12873     *
12874     * @image html img/widget/thumb/preview-00.png
12875     * @image latex img/widget/thumb/preview-00.eps
12876     *
12877     * A thumb object is used for displaying the thumbnail of an image or video.
12878     * You must have compiled Elementary with Ethumb_Client support and the DBus
12879     * service must be present and auto-activated in order to have thumbnails to
12880     * be generated.
12881     *
12882     * Once the thumbnail object becomes visible, it will check if there is a
12883     * previously generated thumbnail image for the file set on it. If not, it
12884     * will start generating this thumbnail.
12885     *
12886     * Different config settings will cause different thumbnails to be generated
12887     * even on the same file.
12888     *
12889     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12890     * Ethumb documentation to change this path, and to see other configuration
12891     * options.
12892     *
12893     * Signals that you can add callbacks for are:
12894     *
12895     * - "clicked" - This is called when a user has clicked the thumb without dragging
12896     *             around.
12897     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12898     * - "press" - This is called when a user has pressed down the thumb.
12899     * - "generate,start" - The thumbnail generation started.
12900     * - "generate,stop" - The generation process stopped.
12901     * - "generate,error" - The generation failed.
12902     * - "load,error" - The thumbnail image loading failed.
12903     *
12904     * available styles:
12905     * - default
12906     * - noframe
12907     *
12908     * An example of use of thumbnail:
12909     *
12910     * - @ref thumb_example_01
12911     */
12912
12913    /**
12914     * @addtogroup Thumb
12915     * @{
12916     */
12917
12918    /**
12919     * @enum _Elm_Thumb_Animation_Setting
12920     * @typedef Elm_Thumb_Animation_Setting
12921     *
12922     * Used to set if a video thumbnail is animating or not.
12923     *
12924     * @ingroup Thumb
12925     */
12926    typedef enum _Elm_Thumb_Animation_Setting
12927      {
12928         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12929         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12930         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12931         ELM_THUMB_ANIMATION_LAST
12932      } Elm_Thumb_Animation_Setting;
12933
12934    /**
12935     * Add a new thumb object to the parent.
12936     *
12937     * @param parent The parent object.
12938     * @return The new object or NULL if it cannot be created.
12939     *
12940     * @see elm_thumb_file_set()
12941     * @see elm_thumb_ethumb_client_get()
12942     *
12943     * @ingroup Thumb
12944     */
12945    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12946    /**
12947     * Reload thumbnail if it was generated before.
12948     *
12949     * @param obj The thumb object to reload
12950     *
12951     * This is useful if the ethumb client configuration changed, like its
12952     * size, aspect or any other property one set in the handle returned
12953     * by elm_thumb_ethumb_client_get().
12954     *
12955     * If the options didn't change, the thumbnail won't be generated again, but
12956     * the old one will still be used.
12957     *
12958     * @see elm_thumb_file_set()
12959     *
12960     * @ingroup Thumb
12961     */
12962    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12963    /**
12964     * Set the file that will be used as thumbnail.
12965     *
12966     * @param obj The thumb object.
12967     * @param file The path to file that will be used as thumb.
12968     * @param key The key used in case of an EET file.
12969     *
12970     * The file can be an image or a video (in that case, acceptable extensions are:
12971     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12972     * function elm_thumb_animate().
12973     *
12974     * @see elm_thumb_file_get()
12975     * @see elm_thumb_reload()
12976     * @see elm_thumb_animate()
12977     *
12978     * @ingroup Thumb
12979     */
12980    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12981    /**
12982     * Get the image or video path and key used to generate the thumbnail.
12983     *
12984     * @param obj The thumb object.
12985     * @param file Pointer to filename.
12986     * @param key Pointer to key.
12987     *
12988     * @see elm_thumb_file_set()
12989     * @see elm_thumb_path_get()
12990     *
12991     * @ingroup Thumb
12992     */
12993    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12994    /**
12995     * Get the path and key to the image or video generated by ethumb.
12996     *
12997     * One just need to make sure that the thumbnail was generated before getting
12998     * its path; otherwise, the path will be NULL. One way to do that is by asking
12999     * for the path when/after the "generate,stop" smart callback is called.
13000     *
13001     * @param obj The thumb object.
13002     * @param file Pointer to thumb path.
13003     * @param key Pointer to thumb key.
13004     *
13005     * @see elm_thumb_file_get()
13006     *
13007     * @ingroup Thumb
13008     */
13009    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13010    /**
13011     * Set the animation state for the thumb object. If its content is an animated
13012     * video, you may start/stop the animation or tell it to play continuously and
13013     * looping.
13014     *
13015     * @param obj The thumb object.
13016     * @param setting The animation setting.
13017     *
13018     * @see elm_thumb_file_set()
13019     *
13020     * @ingroup Thumb
13021     */
13022    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13023    /**
13024     * Get the animation state for the thumb object.
13025     *
13026     * @param obj The thumb object.
13027     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13028     * on errors.
13029     *
13030     * @see elm_thumb_animate_set()
13031     *
13032     * @ingroup Thumb
13033     */
13034    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13035    /**
13036     * Get the ethumb_client handle so custom configuration can be made.
13037     *
13038     * @return Ethumb_Client instance or NULL.
13039     *
13040     * This must be called before the objects are created to be sure no object is
13041     * visible and no generation started.
13042     *
13043     * Example of usage:
13044     *
13045     * @code
13046     * #include <Elementary.h>
13047     * #ifndef ELM_LIB_QUICKLAUNCH
13048     * EAPI_MAIN int
13049     * elm_main(int argc, char **argv)
13050     * {
13051     *    Ethumb_Client *client;
13052     *
13053     *    elm_need_ethumb();
13054     *
13055     *    // ... your code
13056     *
13057     *    client = elm_thumb_ethumb_client_get();
13058     *    if (!client)
13059     *      {
13060     *         ERR("could not get ethumb_client");
13061     *         return 1;
13062     *      }
13063     *    ethumb_client_size_set(client, 100, 100);
13064     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13065     *    // ... your code
13066     *
13067     *    // Create elm_thumb objects here
13068     *
13069     *    elm_run();
13070     *    elm_shutdown();
13071     *    return 0;
13072     * }
13073     * #endif
13074     * ELM_MAIN()
13075     * @endcode
13076     *
13077     * @note There's only one client handle for Ethumb, so once a configuration
13078     * change is done to it, any other request for thumbnails (for any thumbnail
13079     * object) will use that configuration. Thus, this configuration is global.
13080     *
13081     * @ingroup Thumb
13082     */
13083    EAPI void                        *elm_thumb_ethumb_client_get(void);
13084    /**
13085     * Get the ethumb_client connection state.
13086     *
13087     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13088     * otherwise.
13089     */
13090    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13091    /**
13092     * Make the thumbnail 'editable'.
13093     *
13094     * @param obj Thumb object.
13095     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13096     *
13097     * This means the thumbnail is a valid drag target for drag and drop, and can be
13098     * cut or pasted too.
13099     *
13100     * @see elm_thumb_editable_get()
13101     *
13102     * @ingroup Thumb
13103     */
13104    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13105    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13106    /**
13107     * Make the thumbnail 'editable'.
13108     *
13109     * @param obj Thumb object.
13110     * @return Editability.
13111     *
13112     * This means the thumbnail is a valid drag target for drag and drop, and can be
13113     * cut or pasted too.
13114     *
13115     * @see elm_thumb_editable_set()
13116     *
13117     * @ingroup Thumb
13118     */
13119    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13120
13121    /**
13122     * @}
13123     */
13124
13125    /**
13126     * @defgroup Web Web
13127     *
13128     * @image html img/widget/web/preview-00.png
13129     * @image latex img/widget/web/preview-00.eps
13130     *
13131     * A web object is used for displaying web pages (HTML/CSS/JS)
13132     * using WebKit-EFL. You must have compiled Elementary with
13133     * ewebkit support.
13134     *
13135     * Signals that you can add callbacks for are:
13136     * @li "download,request": A file download has been requested. Event info is
13137     * a pointer to a Elm_Web_Download
13138     * @li "editorclient,contents,changed": Editor client's contents changed
13139     * @li "editorclient,selection,changed": Editor client's selection changed
13140     * @li "frame,created": A new frame was created. Event info is an
13141     * Evas_Object which can be handled with WebKit's ewk_frame API
13142     * @li "icon,received": An icon was received by the main frame
13143     * @li "inputmethod,changed": Input method changed. Event info is an
13144     * Eina_Bool indicating whether it's enabled or not
13145     * @li "js,windowobject,clear": JS window object has been cleared
13146     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13147     * is a char *link[2], where the first string contains the URL the link
13148     * points to, and the second one the title of the link
13149     * @li "link,hover,out": Mouse cursor left the link
13150     * @li "load,document,finished": Loading of a document finished. Event info
13151     * is the frame that finished loading
13152     * @li "load,error": Load failed. Event info is a pointer to
13153     * Elm_Web_Frame_Load_Error
13154     * @li "load,finished": Load finished. Event info is NULL on success, on
13155     * error it's a pointer to Elm_Web_Frame_Load_Error
13156     * @li "load,newwindow,show": A new window was created and is ready to be
13157     * shown
13158     * @li "load,progress": Overall load progress. Event info is a pointer to
13159     * a double containing a value between 0.0 and 1.0
13160     * @li "load,provisional": Started provisional load
13161     * @li "load,started": Loading of a document started
13162     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13163     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13164     * the menubar is visible, or EINA_FALSE in case it's not
13165     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13166     * an Eina_Bool indicating the visibility
13167     * @li "popup,created": A dropdown widget was activated, requesting its
13168     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13169     * @li "popup,willdelete": The web object is ready to destroy the popup
13170     * object created. Event info is a pointer to Elm_Web_Menu
13171     * @li "ready": Page is fully loaded
13172     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13173     * info is a pointer to Eina_Bool where the visibility state should be set
13174     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13175     * is an Eina_Bool with the visibility state set
13176     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13177     * a string with the new text
13178     * @li "statusbar,visible,get": Queries visibility of the status bar.
13179     * Event info is a pointer to Eina_Bool where the visibility state should be
13180     * set.
13181     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13182     * an Eina_Bool with the visibility value
13183     * @li "title,changed": Title of the main frame changed. Event info is a
13184     * string with the new title
13185     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13186     * is a pointer to Eina_Bool where the visibility state should be set
13187     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13188     * info is an Eina_Bool with the visibility state
13189     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13190     * a string with the text to show
13191     * @li "uri,changed": URI of the main frame changed. Event info is a string
13192     * with the new URI
13193     * @li "view,resized": The web object internal's view changed sized
13194     * @li "windows,close,request": A JavaScript request to close the current
13195     * window was requested
13196     * @li "zoom,animated,end": Animated zoom finished
13197     *
13198     * available styles:
13199     * - default
13200     *
13201     * An example of use of web:
13202     *
13203     * - @ref web_example_01 TBD
13204     */
13205
13206    /**
13207     * @addtogroup Web
13208     * @{
13209     */
13210
13211    /**
13212     * Structure used to report load errors.
13213     *
13214     * Load errors are reported as signal by elm_web. All the strings are
13215     * temporary references and should @b not be used after the signal
13216     * callback returns. If it's required, make copies with strdup() or
13217     * eina_stringshare_add() (they are not even guaranteed to be
13218     * stringshared, so must use eina_stringshare_add() and not
13219     * eina_stringshare_ref()).
13220     */
13221    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13222    /**
13223     * Structure used to report load errors.
13224     *
13225     * Load errors are reported as signal by elm_web. All the strings are
13226     * temporary references and should @b not be used after the signal
13227     * callback returns. If it's required, make copies with strdup() or
13228     * eina_stringshare_add() (they are not even guaranteed to be
13229     * stringshared, so must use eina_stringshare_add() and not
13230     * eina_stringshare_ref()).
13231     */
13232    struct _Elm_Web_Frame_Load_Error
13233      {
13234         int code; /**< Numeric error code */
13235         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13236         const char *domain; /**< Error domain name */
13237         const char *description; /**< Error description (already localized) */
13238         const char *failing_url; /**< The URL that failed to load */
13239         Evas_Object *frame; /**< Frame object that produced the error */
13240      };
13241
13242    /**
13243     * The possibles types that the items in a menu can be
13244     */
13245    typedef enum _Elm_Web_Menu_Item_Type
13246      {
13247         ELM_WEB_MENU_SEPARATOR,
13248         ELM_WEB_MENU_GROUP,
13249         ELM_WEB_MENU_OPTION
13250      } Elm_Web_Menu_Item_Type;
13251
13252    /**
13253     * Structure describing the items in a menu
13254     */
13255    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13256    /**
13257     * Structure describing the items in a menu
13258     */
13259    struct _Elm_Web_Menu_Item
13260      {
13261         const char *text; /**< The text for the item */
13262         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13263      };
13264
13265    /**
13266     * Structure describing the menu of a popup
13267     *
13268     * This structure will be passed as the @c event_info for the "popup,create"
13269     * signal, which is emitted when a dropdown menu is opened. Users wanting
13270     * to handle these popups by themselves should listen to this signal and
13271     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13272     * property as @c EINA_FALSE means that the user will not handle the popup
13273     * and the default implementation will be used.
13274     *
13275     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13276     * will be emitted to notify the user that it can destroy any objects and
13277     * free all data related to it.
13278     *
13279     * @see elm_web_popup_selected_set()
13280     * @see elm_web_popup_destroy()
13281     */
13282    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13283    /**
13284     * Structure describing the menu of a popup
13285     *
13286     * This structure will be passed as the @c event_info for the "popup,create"
13287     * signal, which is emitted when a dropdown menu is opened. Users wanting
13288     * to handle these popups by themselves should listen to this signal and
13289     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13290     * property as @c EINA_FALSE means that the user will not handle the popup
13291     * and the default implementation will be used.
13292     *
13293     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13294     * will be emitted to notify the user that it can destroy any objects and
13295     * free all data related to it.
13296     *
13297     * @see elm_web_popup_selected_set()
13298     * @see elm_web_popup_destroy()
13299     */
13300    struct _Elm_Web_Menu
13301      {
13302         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13303         int x; /**< The X position of the popup, relative to the elm_web object */
13304         int y; /**< The Y position of the popup, relative to the elm_web object */
13305         int width; /**< Width of the popup menu */
13306         int height; /**< Height of the popup menu */
13307
13308         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. */
13309      };
13310
13311    typedef struct _Elm_Web_Download Elm_Web_Download;
13312    struct _Elm_Web_Download
13313      {
13314         const char *url;
13315      };
13316
13317    /**
13318     * Types of zoom available.
13319     */
13320    typedef enum _Elm_Web_Zoom_Mode
13321      {
13322         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13323         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13324         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13325         ELM_WEB_ZOOM_MODE_LAST
13326      } Elm_Web_Zoom_Mode;
13327    /**
13328     * Opaque handler containing the features (such as statusbar, menubar, etc)
13329     * that are to be set on a newly requested window.
13330     */
13331    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13332    /**
13333     * Callback type for the create_window hook.
13334     *
13335     * The function parameters are:
13336     * @li @p data User data pointer set when setting the hook function
13337     * @li @p obj The elm_web object requesting the new window
13338     * @li @p js Set to @c EINA_TRUE if the request was originated from
13339     * JavaScript. @c EINA_FALSE otherwise.
13340     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13341     * the features requested for the new window.
13342     *
13343     * The returned value of the function should be the @c elm_web widget where
13344     * the request will be loaded. That is, if a new window or tab is created,
13345     * the elm_web widget in it should be returned, and @b NOT the window
13346     * object.
13347     * Returning @c NULL should cancel the request.
13348     *
13349     * @see elm_web_window_create_hook_set()
13350     */
13351    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13352    /**
13353     * Callback type for the JS alert hook.
13354     *
13355     * The function parameters are:
13356     * @li @p data User data pointer set when setting the hook function
13357     * @li @p obj The elm_web object requesting the new window
13358     * @li @p message The message to show in the alert dialog
13359     *
13360     * The function should return the object representing the alert dialog.
13361     * Elm_Web will run a second main loop to handle the dialog and normal
13362     * flow of the application will be restored when the object is deleted, so
13363     * the user should handle the popup properly in order to delete the object
13364     * when the action is finished.
13365     * If the function returns @c NULL the popup will be ignored.
13366     *
13367     * @see elm_web_dialog_alert_hook_set()
13368     */
13369    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13370    /**
13371     * Callback type for the JS confirm hook.
13372     *
13373     * The function parameters are:
13374     * @li @p data User data pointer set when setting the hook function
13375     * @li @p obj The elm_web object requesting the new window
13376     * @li @p message The message to show in the confirm dialog
13377     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13378     * the user selected @c Ok, @c EINA_FALSE otherwise.
13379     *
13380     * The function should return the object representing the confirm dialog.
13381     * Elm_Web will run a second main loop to handle the dialog and normal
13382     * flow of the application will be restored when the object is deleted, so
13383     * the user should handle the popup properly in order to delete the object
13384     * when the action is finished.
13385     * If the function returns @c NULL the popup will be ignored.
13386     *
13387     * @see elm_web_dialog_confirm_hook_set()
13388     */
13389    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13390    /**
13391     * Callback type for the JS prompt hook.
13392     *
13393     * The function parameters are:
13394     * @li @p data User data pointer set when setting the hook function
13395     * @li @p obj The elm_web object requesting the new window
13396     * @li @p message The message to show in the prompt dialog
13397     * @li @p def_value The default value to present the user in the entry
13398     * @li @p value Pointer where to store the value given by the user. Must
13399     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13400     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13401     * the user selected @c Ok, @c EINA_FALSE otherwise.
13402     *
13403     * The function should return the object representing the prompt dialog.
13404     * Elm_Web will run a second main loop to handle the dialog and normal
13405     * flow of the application will be restored when the object is deleted, so
13406     * the user should handle the popup properly in order to delete the object
13407     * when the action is finished.
13408     * If the function returns @c NULL the popup will be ignored.
13409     *
13410     * @see elm_web_dialog_prompt_hook_set()
13411     */
13412    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13413    /**
13414     * Callback type for the JS file selector hook.
13415     *
13416     * The function parameters are:
13417     * @li @p data User data pointer set when setting the hook function
13418     * @li @p obj The elm_web object requesting the new window
13419     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13420     * @li @p accept_types Mime types accepted
13421     * @li @p selected Pointer where to store the list of malloc'ed strings
13422     * containing the path to each file selected. Must be @c NULL if the file
13423     * dialog is cancelled
13424     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13425     * the user selected @c Ok, @c EINA_FALSE otherwise.
13426     *
13427     * The function should return the object representing the file selector
13428     * dialog.
13429     * Elm_Web will run a second main loop to handle the dialog and normal
13430     * flow of the application will be restored when the object is deleted, so
13431     * the user should handle the popup properly in order to delete the object
13432     * when the action is finished.
13433     * If the function returns @c NULL the popup will be ignored.
13434     *
13435     * @see elm_web_dialog_file selector_hook_set()
13436     */
13437    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);
13438    /**
13439     * Callback type for the JS console message hook.
13440     *
13441     * When a console message is added from JavaScript, any set function to the
13442     * console message hook will be called for the user to handle. There is no
13443     * default implementation of this hook.
13444     *
13445     * The function parameters are:
13446     * @li @p data User data pointer set when setting the hook function
13447     * @li @p obj The elm_web object that originated the message
13448     * @li @p message The message sent
13449     * @li @p line_number The line number
13450     * @li @p source_id Source id
13451     *
13452     * @see elm_web_console_message_hook_set()
13453     */
13454    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13455    /**
13456     * Add a new web object to the parent.
13457     *
13458     * @param parent The parent object.
13459     * @return The new object or NULL if it cannot be created.
13460     *
13461     * @see elm_web_uri_set()
13462     * @see elm_web_webkit_view_get()
13463     */
13464    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13465
13466    /**
13467     * Get internal ewk_view object from web object.
13468     *
13469     * Elementary may not provide some low level features of EWebKit,
13470     * instead of cluttering the API with proxy methods we opted to
13471     * return the internal reference. Be careful using it as it may
13472     * interfere with elm_web behavior.
13473     *
13474     * @param obj The web object.
13475     * @return The internal ewk_view object or NULL if it does not
13476     *         exist. (Failure to create or Elementary compiled without
13477     *         ewebkit)
13478     *
13479     * @see elm_web_add()
13480     */
13481    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13482
13483    /**
13484     * Sets the function to call when a new window is requested
13485     *
13486     * This hook will be called when a request to create a new window is
13487     * issued from the web page loaded.
13488     * There is no default implementation for this feature, so leaving this
13489     * unset or passing @c NULL in @p func will prevent new windows from
13490     * opening.
13491     *
13492     * @param obj The web object where to set the hook function
13493     * @param func The hook function to be called when a window is requested
13494     * @param data User data
13495     */
13496    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13497    /**
13498     * Sets the function to call when an alert dialog
13499     *
13500     * This hook will be called when a JavaScript alert dialog is requested.
13501     * If no function is set or @c NULL is passed in @p func, the default
13502     * implementation will take place.
13503     *
13504     * @param obj The web object where to set the hook function
13505     * @param func The callback function to be used
13506     * @param data User data
13507     *
13508     * @see elm_web_inwin_mode_set()
13509     */
13510    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13511    /**
13512     * Sets the function to call when an confirm dialog
13513     *
13514     * This hook will be called when a JavaScript confirm dialog is requested.
13515     * If no function is set or @c NULL is passed in @p func, the default
13516     * implementation will take place.
13517     *
13518     * @param obj The web object where to set the hook function
13519     * @param func The callback function to be used
13520     * @param data User data
13521     *
13522     * @see elm_web_inwin_mode_set()
13523     */
13524    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13525    /**
13526     * Sets the function to call when an prompt dialog
13527     *
13528     * This hook will be called when a JavaScript prompt dialog is requested.
13529     * If no function is set or @c NULL is passed in @p func, the default
13530     * implementation will take place.
13531     *
13532     * @param obj The web object where to set the hook function
13533     * @param func The callback function to be used
13534     * @param data User data
13535     *
13536     * @see elm_web_inwin_mode_set()
13537     */
13538    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13539    /**
13540     * Sets the function to call when an file selector dialog
13541     *
13542     * This hook will be called when a JavaScript file selector dialog is
13543     * requested.
13544     * If no function is set or @c NULL is passed in @p func, the default
13545     * implementation will take place.
13546     *
13547     * @param obj The web object where to set the hook function
13548     * @param func The callback function to be used
13549     * @param data User data
13550     *
13551     * @see elm_web_inwin_mode_set()
13552     */
13553    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13554    /**
13555     * Sets the function to call when a console message is emitted from JS
13556     *
13557     * This hook will be called when a console message is emitted from
13558     * JavaScript. There is no default implementation for this feature.
13559     *
13560     * @param obj The web object where to set the hook function
13561     * @param func The callback function to be used
13562     * @param data User data
13563     */
13564    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13565    /**
13566     * Gets the status of the tab propagation
13567     *
13568     * @param obj The web object to query
13569     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13570     *
13571     * @see elm_web_tab_propagate_set()
13572     */
13573    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13574    /**
13575     * Sets whether to use tab propagation
13576     *
13577     * If tab propagation is enabled, whenever the user presses the Tab key,
13578     * Elementary will handle it and switch focus to the next widget.
13579     * The default value is disabled, where WebKit will handle the Tab key to
13580     * cycle focus though its internal objects, jumping to the next widget
13581     * only when that cycle ends.
13582     *
13583     * @param obj The web object
13584     * @param propagate Whether to propagate Tab keys to Elementary or not
13585     */
13586    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13587    /**
13588     * Sets the URI for the web object
13589     *
13590     * It must be a full URI, with resource included, in the form
13591     * http://www.enlightenment.org or file:///tmp/something.html
13592     *
13593     * @param obj The web object
13594     * @param uri The URI to set
13595     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13596     */
13597    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13598    /**
13599     * Gets the current URI for the object
13600     *
13601     * The returned string must not be freed and is guaranteed to be
13602     * stringshared.
13603     *
13604     * @param obj The web object
13605     * @return A stringshared internal string with the current URI, or NULL on
13606     * failure
13607     */
13608    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13609    /**
13610     * Gets the current title
13611     *
13612     * The returned string must not be freed and is guaranteed to be
13613     * stringshared.
13614     *
13615     * @param obj The web object
13616     * @return A stringshared internal string with the current title, or NULL on
13617     * failure
13618     */
13619    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13620    /**
13621     * Sets the background color to be used by the web object
13622     *
13623     * This is the color that will be used by default when the loaded page
13624     * does not set it's own. Color values are pre-multiplied.
13625     *
13626     * @param obj The web object
13627     * @param r Red component
13628     * @param g Green component
13629     * @param b Blue component
13630     * @param a Alpha component
13631     */
13632    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13633    /**
13634     * Gets the background color to be used by the web object
13635     *
13636     * This is the color that will be used by default when the loaded page
13637     * does not set it's own. Color values are pre-multiplied.
13638     *
13639     * @param obj The web object
13640     * @param r Red component
13641     * @param g Green component
13642     * @param b Blue component
13643     * @param a Alpha component
13644     */
13645    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13646    /**
13647     * Gets a copy of the currently selected text
13648     *
13649     * The string returned must be freed by the user when it's done with it.
13650     *
13651     * @param obj The web object
13652     * @return A newly allocated string, or NULL if nothing is selected or an
13653     * error occurred
13654     */
13655    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13656    /**
13657     * Tells the web object which index in the currently open popup was selected
13658     *
13659     * When the user handles the popup creation from the "popup,created" signal,
13660     * it needs to tell the web object which item was selected by calling this
13661     * function with the index corresponding to the item.
13662     *
13663     * @param obj The web object
13664     * @param index The index selected
13665     *
13666     * @see elm_web_popup_destroy()
13667     */
13668    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13669    /**
13670     * Dismisses an open dropdown popup
13671     *
13672     * When the popup from a dropdown widget is to be dismissed, either after
13673     * selecting an option or to cancel it, this function must be called, which
13674     * will later emit an "popup,willdelete" signal to notify the user that
13675     * any memory and objects related to this popup can be freed.
13676     *
13677     * @param obj The web object
13678     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13679     * if there was no menu to destroy
13680     */
13681    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13682    /**
13683     * Searches the given string in a document.
13684     *
13685     * @param obj The web object where to search the text
13686     * @param string String to search
13687     * @param case_sensitive If search should be case sensitive or not
13688     * @param forward If search is from cursor and on or backwards
13689     * @param wrap If search should wrap at the end
13690     *
13691     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13692     * or failure
13693     */
13694    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13695    /**
13696     * Marks matches of the given string in a document.
13697     *
13698     * @param obj The web object where to search text
13699     * @param string String to match
13700     * @param case_sensitive If match should be case sensitive or not
13701     * @param highlight If matches should be highlighted
13702     * @param limit Maximum amount of matches, or zero to unlimited
13703     *
13704     * @return number of matched @a string
13705     */
13706    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13707    /**
13708     * Clears all marked matches in the document
13709     *
13710     * @param obj The web object
13711     *
13712     * @return EINA_TRUE on success, EINA_FALSE otherwise
13713     */
13714    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13715    /**
13716     * Sets whether to highlight the matched marks
13717     *
13718     * If enabled, marks set with elm_web_text_matches_mark() will be
13719     * highlighted.
13720     *
13721     * @param obj The web object
13722     * @param highlight Whether to highlight the marks or not
13723     *
13724     * @return EINA_TRUE on success, EINA_FALSE otherwise
13725     */
13726    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13727    /**
13728     * Gets whether highlighting marks is enabled
13729     *
13730     * @param The web object
13731     *
13732     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13733     * otherwise
13734     */
13735    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13736    /**
13737     * Gets the overall loading progress of the page
13738     *
13739     * Returns the estimated loading progress of the page, with a value between
13740     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13741     * included in the page.
13742     *
13743     * @param The web object
13744     *
13745     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13746     * failure
13747     */
13748    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13749    /**
13750     * Stops loading the current page
13751     *
13752     * Cancels the loading of the current page in the web object. This will
13753     * cause a "load,error" signal to be emitted, with the is_cancellation
13754     * flag set to EINA_TRUE.
13755     *
13756     * @param obj The web object
13757     *
13758     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13759     */
13760    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13761    /**
13762     * Requests a reload of the current document in the object
13763     *
13764     * @param obj The web object
13765     *
13766     * @return EINA_TRUE on success, EINA_FALSE otherwise
13767     */
13768    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13769    /**
13770     * Requests a reload of the current document, avoiding any existing caches
13771     *
13772     * @param obj The web object
13773     *
13774     * @return EINA_TRUE on success, EINA_FALSE otherwise
13775     */
13776    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13777    /**
13778     * Goes back one step in the browsing history
13779     *
13780     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13781     *
13782     * @param obj The web object
13783     *
13784     * @return EINA_TRUE on success, EINA_FALSE otherwise
13785     *
13786     * @see elm_web_history_enable_set()
13787     * @see elm_web_back_possible()
13788     * @see elm_web_forward()
13789     * @see elm_web_navigate()
13790     */
13791    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13792    /**
13793     * Goes forward one step in the browsing history
13794     *
13795     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13796     *
13797     * @param obj The web object
13798     *
13799     * @return EINA_TRUE on success, EINA_FALSE otherwise
13800     *
13801     * @see elm_web_history_enable_set()
13802     * @see elm_web_forward_possible()
13803     * @see elm_web_back()
13804     * @see elm_web_navigate()
13805     */
13806    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13807    /**
13808     * Jumps the given number of steps in the browsing history
13809     *
13810     * The @p steps value can be a negative integer to back in history, or a
13811     * positive to move forward.
13812     *
13813     * @param obj The web object
13814     * @param steps The number of steps to jump
13815     *
13816     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13817     * history exists to jump the given number of steps
13818     *
13819     * @see elm_web_history_enable_set()
13820     * @see elm_web_navigate_possible()
13821     * @see elm_web_back()
13822     * @see elm_web_forward()
13823     */
13824    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13825    /**
13826     * Queries whether it's possible to go back in history
13827     *
13828     * @param obj The web object
13829     *
13830     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13831     * otherwise
13832     */
13833    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13834    /**
13835     * Queries whether it's possible to go forward in history
13836     *
13837     * @param obj The web object
13838     *
13839     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13840     * otherwise
13841     */
13842    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13843    /**
13844     * Queries whether it's possible to jump the given number of steps
13845     *
13846     * The @p steps value can be a negative integer to back in history, or a
13847     * positive to move forward.
13848     *
13849     * @param obj The web object
13850     * @param steps The number of steps to check for
13851     *
13852     * @return EINA_TRUE if enough history exists to perform the given jump,
13853     * EINA_FALSE otherwise
13854     */
13855    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13856    /**
13857     * Gets whether browsing history is enabled for the given object
13858     *
13859     * @param obj The web object
13860     *
13861     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13862     */
13863    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13864    /**
13865     * Enables or disables the browsing history
13866     *
13867     * @param obj The web object
13868     * @param enable Whether to enable or disable the browsing history
13869     */
13870    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13871    /**
13872     * Sets the zoom level of the web object
13873     *
13874     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13875     * values meaning zoom in and lower meaning zoom out. This function will
13876     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13877     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13878     *
13879     * @param obj The web object
13880     * @param zoom The zoom level to set
13881     */
13882    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13883    /**
13884     * Gets the current zoom level set on the web object
13885     *
13886     * Note that this is the zoom level set on the web object and not that
13887     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13888     * the two zoom levels should match, but for the other two modes the
13889     * Webkit zoom is calculated internally to match the chosen mode without
13890     * changing the zoom level set for the web object.
13891     *
13892     * @param obj The web object
13893     *
13894     * @return The zoom level set on the object
13895     */
13896    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
13897    /**
13898     * Sets the zoom mode to use
13899     *
13900     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13901     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13902     *
13903     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13904     * with the elm_web_zoom_set() function.
13905     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13906     * make sure the entirety of the web object's contents are shown.
13907     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13908     * fit the contents in the web object's size, without leaving any space
13909     * unused.
13910     *
13911     * @param obj The web object
13912     * @param mode The mode to set
13913     */
13914    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13915    /**
13916     * Gets the currently set zoom mode
13917     *
13918     * @param obj The web object
13919     *
13920     * @return The current zoom mode set for the object, or
13921     * ::ELM_WEB_ZOOM_MODE_LAST on error
13922     */
13923    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
13924    /**
13925     * Shows the given region in the web object
13926     *
13927     * @param obj The web object
13928     * @param x The x coordinate of the region to show
13929     * @param y The y coordinate of the region to show
13930     * @param w The width of the region to show
13931     * @param h The height of the region to show
13932     */
13933    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13934    /**
13935     * Brings in the region to the visible area
13936     *
13937     * Like elm_web_region_show(), but it animates the scrolling of the object
13938     * to show the area
13939     *
13940     * @param obj The web object
13941     * @param x The x coordinate of the region to show
13942     * @param y The y coordinate of the region to show
13943     * @param w The width of the region to show
13944     * @param h The height of the region to show
13945     */
13946    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13947    /**
13948     * Sets the default dialogs to use an Inwin instead of a normal window
13949     *
13950     * If set, then the default implementation for the JavaScript dialogs and
13951     * file selector will be opened in an Inwin. Otherwise they will use a
13952     * normal separated window.
13953     *
13954     * @param obj The web object
13955     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13956     */
13957    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13958    /**
13959     * Gets whether Inwin mode is set for the current object
13960     *
13961     * @param obj The web object
13962     *
13963     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13964     */
13965    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
13966
13967    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13968    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13969    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);
13970    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13971
13972    /**
13973     * @}
13974     */
13975
13976    /**
13977     * @defgroup Hoversel Hoversel
13978     *
13979     * @image html img/widget/hoversel/preview-00.png
13980     * @image latex img/widget/hoversel/preview-00.eps
13981     *
13982     * A hoversel is a button that pops up a list of items (automatically
13983     * choosing the direction to display) that have a label and, optionally, an
13984     * icon to select from. It is a convenience widget to avoid the need to do
13985     * all the piecing together yourself. It is intended for a small number of
13986     * items in the hoversel menu (no more than 8), though is capable of many
13987     * more.
13988     *
13989     * Signals that you can add callbacks for are:
13990     * "clicked" - the user clicked the hoversel button and popped up the sel
13991     * "selected" - an item in the hoversel list is selected. event_info is the item
13992     * "dismissed" - the hover is dismissed
13993     *
13994     * See @ref tutorial_hoversel for an example.
13995     * @{
13996     */
13997    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13998    /**
13999     * @brief Add a new Hoversel object
14000     *
14001     * @param parent The parent object
14002     * @return The new object or NULL if it cannot be created
14003     */
14004    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14005    /**
14006     * @brief This sets the hoversel to expand horizontally.
14007     *
14008     * @param obj The hoversel object
14009     * @param horizontal If true, the hover will expand horizontally to the
14010     * right.
14011     *
14012     * @note The initial button will display horizontally regardless of this
14013     * setting.
14014     */
14015    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14016    /**
14017     * @brief This returns whether the hoversel is set to expand horizontally.
14018     *
14019     * @param obj The hoversel object
14020     * @return If true, the hover will expand horizontally to the right.
14021     *
14022     * @see elm_hoversel_horizontal_set()
14023     */
14024    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14025    /**
14026     * @brief Set the Hover parent
14027     *
14028     * @param obj The hoversel object
14029     * @param parent The parent to use
14030     *
14031     * Sets the hover parent object, the area that will be darkened when the
14032     * hoversel is clicked. Should probably be the window that the hoversel is
14033     * in. See @ref Hover objects for more information.
14034     */
14035    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14036    /**
14037     * @brief Get the Hover parent
14038     *
14039     * @param obj The hoversel object
14040     * @return The used parent
14041     *
14042     * Gets the hover parent object.
14043     *
14044     * @see elm_hoversel_hover_parent_set()
14045     */
14046    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14047    /**
14048     * @brief Set the hoversel button label
14049     *
14050     * @param obj The hoversel object
14051     * @param label The label text.
14052     *
14053     * This sets the label of the button that is always visible (before it is
14054     * clicked and expanded).
14055     *
14056     * @deprecated elm_object_text_set()
14057     */
14058    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14059    /**
14060     * @brief Get the hoversel button label
14061     *
14062     * @param obj The hoversel object
14063     * @return The label text.
14064     *
14065     * @deprecated elm_object_text_get()
14066     */
14067    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14068    /**
14069     * @brief Set the icon of the hoversel button
14070     *
14071     * @param obj The hoversel object
14072     * @param icon The icon object
14073     *
14074     * Sets the icon of the button that is always visible (before it is clicked
14075     * and expanded).  Once the icon object is set, a previously set one will be
14076     * deleted, if you want to keep that old content object, use the
14077     * elm_hoversel_icon_unset() function.
14078     *
14079     * @see elm_object_content_set() for the button widget
14080     */
14081    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14082    /**
14083     * @brief Get the icon of the hoversel button
14084     *
14085     * @param obj The hoversel object
14086     * @return The icon object
14087     *
14088     * Get the icon of the button that is always visible (before it is clicked
14089     * and expanded). Also see elm_object_content_get() for the button widget.
14090     *
14091     * @see elm_hoversel_icon_set()
14092     */
14093    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14094    /**
14095     * @brief Get and unparent the icon of the hoversel button
14096     *
14097     * @param obj The hoversel object
14098     * @return The icon object that was being used
14099     *
14100     * Unparent and return the icon of the button that is always visible
14101     * (before it is clicked and expanded).
14102     *
14103     * @see elm_hoversel_icon_set()
14104     * @see elm_object_content_unset() for the button widget
14105     */
14106    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14107    /**
14108     * @brief This triggers the hoversel popup from code, the same as if the user
14109     * had clicked the button.
14110     *
14111     * @param obj The hoversel object
14112     */
14113    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14114    /**
14115     * @brief This dismisses the hoversel popup as if the user had clicked
14116     * outside the hover.
14117     *
14118     * @param obj The hoversel object
14119     */
14120    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14121    /**
14122     * @brief Returns whether the hoversel is expanded.
14123     *
14124     * @param obj The hoversel object
14125     * @return  This will return EINA_TRUE if the hoversel is expanded or
14126     * EINA_FALSE if it is not expanded.
14127     */
14128    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14129    /**
14130     * @brief This will remove all the children items from the hoversel.
14131     *
14132     * @param obj The hoversel object
14133     *
14134     * @warning Should @b not be called while the hoversel is active; use
14135     * elm_hoversel_expanded_get() to check first.
14136     *
14137     * @see elm_hoversel_item_del_cb_set()
14138     * @see elm_hoversel_item_del()
14139     */
14140    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14141    /**
14142     * @brief Get the list of items within the given hoversel.
14143     *
14144     * @param obj The hoversel object
14145     * @return Returns a list of Elm_Hoversel_Item*
14146     *
14147     * @see elm_hoversel_item_add()
14148     */
14149    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14150    /**
14151     * @brief Add an item to the hoversel button
14152     *
14153     * @param obj The hoversel object
14154     * @param label The text label to use for the item (NULL if not desired)
14155     * @param icon_file An image file path on disk to use for the icon or standard
14156     * icon name (NULL if not desired)
14157     * @param icon_type The icon type if relevant
14158     * @param func Convenience function to call when this item is selected
14159     * @param data Data to pass to item-related functions
14160     * @return A handle to the item added.
14161     *
14162     * This adds an item to the hoversel to show when it is clicked. Note: if you
14163     * need to use an icon from an edje file then use
14164     * elm_hoversel_item_icon_set() right after the this function, and set
14165     * icon_file to NULL here.
14166     *
14167     * For more information on what @p icon_file and @p icon_type are see the
14168     * @ref Icon "icon documentation".
14169     */
14170    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);
14171    /**
14172     * @brief Delete an item from the hoversel
14173     *
14174     * @param item The item to delete
14175     *
14176     * This deletes the item from the hoversel (should not be called while the
14177     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14178     *
14179     * @see elm_hoversel_item_add()
14180     * @see elm_hoversel_item_del_cb_set()
14181     */
14182    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14183    /**
14184     * @brief Set the function to be called when an item from the hoversel is
14185     * freed.
14186     *
14187     * @param item The item to set the callback on
14188     * @param func The function called
14189     *
14190     * That function will receive these parameters:
14191     * @li void *item_data
14192     * @li Evas_Object *the_item_object
14193     * @li Elm_Hoversel_Item *the_object_struct
14194     *
14195     * @see elm_hoversel_item_add()
14196     */
14197    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14198    /**
14199     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14200     * that will be passed to associated function callbacks.
14201     *
14202     * @param item The item to get the data from
14203     * @return The data pointer set with elm_hoversel_item_add()
14204     *
14205     * @see elm_hoversel_item_add()
14206     */
14207    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14208    /**
14209     * @brief This returns the label text of the given hoversel item.
14210     *
14211     * @param item The item to get the label
14212     * @return The label text of the hoversel item
14213     *
14214     * @see elm_hoversel_item_add()
14215     */
14216    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14217    /**
14218     * @brief This sets the icon for the given hoversel item.
14219     *
14220     * @param item The item to set the icon
14221     * @param icon_file An image file path on disk to use for the icon or standard
14222     * icon name
14223     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14224     * to NULL if the icon is not an edje file
14225     * @param icon_type The icon type
14226     *
14227     * The icon can be loaded from the standard set, from an image file, or from
14228     * an edje file.
14229     *
14230     * @see elm_hoversel_item_add()
14231     */
14232    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);
14233    /**
14234     * @brief Get the icon object of the hoversel item
14235     *
14236     * @param item The item to get the icon from
14237     * @param icon_file The image file path on disk used for the icon or standard
14238     * icon name
14239     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14240     * if the icon is not an edje file
14241     * @param icon_type The icon type
14242     *
14243     * @see elm_hoversel_item_icon_set()
14244     * @see elm_hoversel_item_add()
14245     */
14246    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);
14247    /**
14248     * @}
14249     */
14250
14251    /**
14252     * @defgroup Toolbar Toolbar
14253     * @ingroup Elementary
14254     *
14255     * @image html img/widget/toolbar/preview-00.png
14256     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14257     *
14258     * @image html img/toolbar.png
14259     * @image latex img/toolbar.eps width=\textwidth
14260     *
14261     * A toolbar is a widget that displays a list of items inside
14262     * a box. It can be scrollable, show a menu with items that don't fit
14263     * to toolbar size or even crop them.
14264     *
14265     * Only one item can be selected at a time.
14266     *
14267     * Items can have multiple states, or show menus when selected by the user.
14268     *
14269     * Smart callbacks one can listen to:
14270     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14271     * - "language,changed" - when the program language changes
14272     *
14273     * Available styles for it:
14274     * - @c "default"
14275     * - @c "transparent" - no background or shadow, just show the content
14276     *
14277     * List of examples:
14278     * @li @ref toolbar_example_01
14279     * @li @ref toolbar_example_02
14280     * @li @ref toolbar_example_03
14281     */
14282
14283    /**
14284     * @addtogroup Toolbar
14285     * @{
14286     */
14287
14288    /**
14289     * @enum _Elm_Toolbar_Shrink_Mode
14290     * @typedef Elm_Toolbar_Shrink_Mode
14291     *
14292     * Set toolbar's items display behavior, it can be scrollabel,
14293     * show a menu with exceeding items, or simply hide them.
14294     *
14295     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14296     * from elm config.
14297     *
14298     * Values <b> don't </b> work as bitmask, only one can be choosen.
14299     *
14300     * @see elm_toolbar_mode_shrink_set()
14301     * @see elm_toolbar_mode_shrink_get()
14302     *
14303     * @ingroup Toolbar
14304     */
14305    typedef enum _Elm_Toolbar_Shrink_Mode
14306      {
14307         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14308         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14309         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14310         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14311         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14312      } Elm_Toolbar_Shrink_Mode;
14313
14314    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(). */
14315
14316    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(). */
14317
14318    /**
14319     * Add a new toolbar widget to the given parent Elementary
14320     * (container) object.
14321     *
14322     * @param parent The parent object.
14323     * @return a new toolbar widget handle or @c NULL, on errors.
14324     *
14325     * This function inserts a new toolbar widget on the canvas.
14326     *
14327     * @ingroup Toolbar
14328     */
14329    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14330
14331    /**
14332     * Set the icon size, in pixels, to be used by toolbar items.
14333     *
14334     * @param obj The toolbar object
14335     * @param icon_size The icon size in pixels
14336     *
14337     * @note Default value is @c 32. It reads value from elm config.
14338     *
14339     * @see elm_toolbar_icon_size_get()
14340     *
14341     * @ingroup Toolbar
14342     */
14343    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14344
14345    /**
14346     * Get the icon size, in pixels, to be used by toolbar items.
14347     *
14348     * @param obj The toolbar object.
14349     * @return The icon size in pixels.
14350     *
14351     * @see elm_toolbar_icon_size_set() for details.
14352     *
14353     * @ingroup Toolbar
14354     */
14355    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14356
14357    /**
14358     * Sets icon lookup order, for toolbar items' icons.
14359     *
14360     * @param obj The toolbar object.
14361     * @param order The icon lookup order.
14362     *
14363     * Icons added before calling this function will not be affected.
14364     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14365     *
14366     * @see elm_toolbar_icon_order_lookup_get()
14367     *
14368     * @ingroup Toolbar
14369     */
14370    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14371
14372    /**
14373     * Gets the icon lookup order.
14374     *
14375     * @param obj The toolbar object.
14376     * @return The icon lookup order.
14377     *
14378     * @see elm_toolbar_icon_order_lookup_set() for details.
14379     *
14380     * @ingroup Toolbar
14381     */
14382    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14383
14384    /**
14385     * Set whether the toolbar should always have an item selected.
14386     *
14387     * @param obj The toolbar object.
14388     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14389     * disable it.
14390     *
14391     * This will cause the toolbar to always have an item selected, and clicking
14392     * the selected item will not cause a selected event to be emitted. Enabling this mode
14393     * will immediately select the first toolbar item.
14394     *
14395     * Always-selected is disabled by default.
14396     *
14397     * @see elm_toolbar_always_select_mode_get().
14398     *
14399     * @ingroup Toolbar
14400     */
14401    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14402
14403    /**
14404     * Get whether the toolbar should always have an item selected.
14405     *
14406     * @param obj The toolbar object.
14407     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14408     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14409     *
14410     * @see elm_toolbar_always_select_mode_set() for details.
14411     *
14412     * @ingroup Toolbar
14413     */
14414    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14415
14416    /**
14417     * Set whether the toolbar items' should be selected by the user or not.
14418     *
14419     * @param obj The toolbar object.
14420     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14421     * enable it.
14422     *
14423     * This will turn off the ability to select items entirely and they will
14424     * neither appear selected nor emit selected signals. The clicked
14425     * callback function will still be called.
14426     *
14427     * Selection is enabled by default.
14428     *
14429     * @see elm_toolbar_no_select_mode_get().
14430     *
14431     * @ingroup Toolbar
14432     */
14433    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14434
14435    /**
14436     * Set whether the toolbar items' should be selected by the user or not.
14437     *
14438     * @param obj The toolbar object.
14439     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14440     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14441     *
14442     * @see elm_toolbar_no_select_mode_set() for details.
14443     *
14444     * @ingroup Toolbar
14445     */
14446    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14447
14448    /**
14449     * Append item to the toolbar.
14450     *
14451     * @param obj The toolbar object.
14452     * @param icon A string with icon name or the absolute path of an image file.
14453     * @param label The label of the item.
14454     * @param func The function to call when the item is clicked.
14455     * @param data The data to associate with the item for related callbacks.
14456     * @return The created item or @c NULL upon failure.
14457     *
14458     * A new item will be created and appended to the toolbar, i.e., will
14459     * be set as @b last item.
14460     *
14461     * Items created with this method can be deleted with
14462     * elm_toolbar_item_del().
14463     *
14464     * Associated @p data can be properly freed when item is deleted if a
14465     * callback function is set with elm_toolbar_item_del_cb_set().
14466     *
14467     * If a function is passed as argument, it will be called everytime this item
14468     * is selected, i.e., the user clicks over an unselected item.
14469     * If such function isn't needed, just passing
14470     * @c NULL as @p func is enough. The same should be done for @p data.
14471     *
14472     * Toolbar will load icon image from fdo or current theme.
14473     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14474     * If an absolute path is provided it will load it direct from a file.
14475     *
14476     * @see elm_toolbar_item_icon_set()
14477     * @see elm_toolbar_item_del()
14478     * @see elm_toolbar_item_del_cb_set()
14479     *
14480     * @ingroup Toolbar
14481     */
14482    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);
14483
14484    /**
14485     * Prepend item to the toolbar.
14486     *
14487     * @param obj The toolbar object.
14488     * @param icon A string with icon name or the absolute path of an image file.
14489     * @param label The label of the item.
14490     * @param func The function to call when the item is clicked.
14491     * @param data The data to associate with the item for related callbacks.
14492     * @return The created item or @c NULL upon failure.
14493     *
14494     * A new item will be created and prepended to the toolbar, i.e., will
14495     * be set as @b first item.
14496     *
14497     * Items created with this method can be deleted with
14498     * elm_toolbar_item_del().
14499     *
14500     * Associated @p data can be properly freed when item is deleted if a
14501     * callback function is set with elm_toolbar_item_del_cb_set().
14502     *
14503     * If a function is passed as argument, it will be called everytime this item
14504     * is selected, i.e., the user clicks over an unselected item.
14505     * If such function isn't needed, just passing
14506     * @c NULL as @p func is enough. The same should be done for @p data.
14507     *
14508     * Toolbar will load icon image from fdo or current theme.
14509     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14510     * If an absolute path is provided it will load it direct from a file.
14511     *
14512     * @see elm_toolbar_item_icon_set()
14513     * @see elm_toolbar_item_del()
14514     * @see elm_toolbar_item_del_cb_set()
14515     *
14516     * @ingroup Toolbar
14517     */
14518    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);
14519
14520    /**
14521     * Insert a new item into the toolbar object before item @p before.
14522     *
14523     * @param obj The toolbar object.
14524     * @param before The toolbar item to insert before.
14525     * @param icon A string with icon name or the absolute path of an image file.
14526     * @param label The label of the item.
14527     * @param func The function to call when the item is clicked.
14528     * @param data The data to associate with the item for related callbacks.
14529     * @return The created item or @c NULL upon failure.
14530     *
14531     * A new item will be created and added to the toolbar. Its position in
14532     * this toolbar will be just before item @p before.
14533     *
14534     * Items created with this method can be deleted with
14535     * elm_toolbar_item_del().
14536     *
14537     * Associated @p data can be properly freed when item is deleted if a
14538     * callback function is set with elm_toolbar_item_del_cb_set().
14539     *
14540     * If a function is passed as argument, it will be called everytime this item
14541     * is selected, i.e., the user clicks over an unselected item.
14542     * If such function isn't needed, just passing
14543     * @c NULL as @p func is enough. The same should be done for @p data.
14544     *
14545     * Toolbar will load icon image from fdo or current theme.
14546     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14547     * If an absolute path is provided it will load it direct from a file.
14548     *
14549     * @see elm_toolbar_item_icon_set()
14550     * @see elm_toolbar_item_del()
14551     * @see elm_toolbar_item_del_cb_set()
14552     *
14553     * @ingroup Toolbar
14554     */
14555    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);
14556
14557    /**
14558     * Insert a new item into the toolbar object after item @p after.
14559     *
14560     * @param obj The toolbar object.
14561     * @param after The toolbar item to insert after.
14562     * @param icon A string with icon name or the absolute path of an image file.
14563     * @param label The label of the item.
14564     * @param func The function to call when the item is clicked.
14565     * @param data The data to associate with the item for related callbacks.
14566     * @return The created item or @c NULL upon failure.
14567     *
14568     * A new item will be created and added to the toolbar. Its position in
14569     * this toolbar will be just after item @p after.
14570     *
14571     * Items created with this method can be deleted with
14572     * elm_toolbar_item_del().
14573     *
14574     * Associated @p data can be properly freed when item is deleted if a
14575     * callback function is set with elm_toolbar_item_del_cb_set().
14576     *
14577     * If a function is passed as argument, it will be called everytime this item
14578     * is selected, i.e., the user clicks over an unselected item.
14579     * If such function isn't needed, just passing
14580     * @c NULL as @p func is enough. The same should be done for @p data.
14581     *
14582     * Toolbar will load icon image from fdo or current theme.
14583     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14584     * If an absolute path is provided it will load it direct from a file.
14585     *
14586     * @see elm_toolbar_item_icon_set()
14587     * @see elm_toolbar_item_del()
14588     * @see elm_toolbar_item_del_cb_set()
14589     *
14590     * @ingroup Toolbar
14591     */
14592    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);
14593
14594    /**
14595     * Get the first item in the given toolbar widget's list of
14596     * items.
14597     *
14598     * @param obj The toolbar object
14599     * @return The first item or @c NULL, if it has no items (and on
14600     * errors)
14601     *
14602     * @see elm_toolbar_item_append()
14603     * @see elm_toolbar_last_item_get()
14604     *
14605     * @ingroup Toolbar
14606     */
14607    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14608
14609    /**
14610     * Get the last item in the given toolbar widget's list of
14611     * items.
14612     *
14613     * @param obj The toolbar object
14614     * @return The last item or @c NULL, if it has no items (and on
14615     * errors)
14616     *
14617     * @see elm_toolbar_item_prepend()
14618     * @see elm_toolbar_first_item_get()
14619     *
14620     * @ingroup Toolbar
14621     */
14622    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14623
14624    /**
14625     * Get the item after @p item in toolbar.
14626     *
14627     * @param item The toolbar item.
14628     * @return The item after @p item, or @c NULL if none or on failure.
14629     *
14630     * @note If it is the last item, @c NULL will be returned.
14631     *
14632     * @see elm_toolbar_item_append()
14633     *
14634     * @ingroup Toolbar
14635     */
14636    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14637
14638    /**
14639     * Get the item before @p item in toolbar.
14640     *
14641     * @param item The toolbar item.
14642     * @return The item before @p item, or @c NULL if none or on failure.
14643     *
14644     * @note If it is the first item, @c NULL will be returned.
14645     *
14646     * @see elm_toolbar_item_prepend()
14647     *
14648     * @ingroup Toolbar
14649     */
14650    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14651
14652    /**
14653     * Get the toolbar object from an item.
14654     *
14655     * @param item The item.
14656     * @return The toolbar object.
14657     *
14658     * This returns the toolbar object itself that an item belongs to.
14659     *
14660     * @ingroup Toolbar
14661     */
14662    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14663
14664    /**
14665     * Set the priority of a toolbar item.
14666     *
14667     * @param item The toolbar item.
14668     * @param priority The item priority. The default is zero.
14669     *
14670     * This is used only when the toolbar shrink mode is set to
14671     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14672     * When space is less than required, items with low priority
14673     * will be removed from the toolbar and added to a dynamically-created menu,
14674     * while items with higher priority will remain on the toolbar,
14675     * with the same order they were added.
14676     *
14677     * @see elm_toolbar_item_priority_get()
14678     *
14679     * @ingroup Toolbar
14680     */
14681    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14682
14683    /**
14684     * Get the priority of a toolbar item.
14685     *
14686     * @param item The toolbar item.
14687     * @return The @p item priority, or @c 0 on failure.
14688     *
14689     * @see elm_toolbar_item_priority_set() for details.
14690     *
14691     * @ingroup Toolbar
14692     */
14693    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14694
14695    /**
14696     * Get the label of item.
14697     *
14698     * @param item The item of toolbar.
14699     * @return The label of item.
14700     *
14701     * The return value is a pointer to the label associated to @p item when
14702     * it was created, with function elm_toolbar_item_append() or similar,
14703     * or later,
14704     * with function elm_toolbar_item_label_set. If no label
14705     * was passed as argument, it will return @c NULL.
14706     *
14707     * @see elm_toolbar_item_label_set() for more details.
14708     * @see elm_toolbar_item_append()
14709     *
14710     * @ingroup Toolbar
14711     */
14712    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14713
14714    /**
14715     * Set the label of item.
14716     *
14717     * @param item The item of toolbar.
14718     * @param text The label of item.
14719     *
14720     * The label to be displayed by the item.
14721     * Label will be placed at icons bottom (if set).
14722     *
14723     * If a label was passed as argument on item creation, with function
14724     * elm_toolbar_item_append() or similar, it will be already
14725     * displayed by the item.
14726     *
14727     * @see elm_toolbar_item_label_get()
14728     * @see elm_toolbar_item_append()
14729     *
14730     * @ingroup Toolbar
14731     */
14732    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14733
14734    /**
14735     * Return the data associated with a given toolbar widget item.
14736     *
14737     * @param item The toolbar widget item handle.
14738     * @return The data associated with @p item.
14739     *
14740     * @see elm_toolbar_item_data_set()
14741     *
14742     * @ingroup Toolbar
14743     */
14744    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14745
14746    /**
14747     * Set the data associated with a given toolbar widget item.
14748     *
14749     * @param item The toolbar widget item handle.
14750     * @param data The new data pointer to set to @p item.
14751     *
14752     * This sets new item data on @p item.
14753     *
14754     * @warning The old data pointer won't be touched by this function, so
14755     * the user had better to free that old data himself/herself.
14756     *
14757     * @ingroup Toolbar
14758     */
14759    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14760
14761    /**
14762     * Returns a pointer to a toolbar item by its label.
14763     *
14764     * @param obj The toolbar object.
14765     * @param label The label of the item to find.
14766     *
14767     * @return The pointer to the toolbar item matching @p label or @c NULL
14768     * on failure.
14769     *
14770     * @ingroup Toolbar
14771     */
14772    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14773
14774    /*
14775     * Get whether the @p item is selected or not.
14776     *
14777     * @param item The toolbar item.
14778     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14779     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14780     *
14781     * @see elm_toolbar_selected_item_set() for details.
14782     * @see elm_toolbar_item_selected_get()
14783     *
14784     * @ingroup Toolbar
14785     */
14786    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14787
14788    /**
14789     * Set the selected state of an item.
14790     *
14791     * @param item The toolbar item
14792     * @param selected The selected state
14793     *
14794     * This sets the selected state of the given item @p it.
14795     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14796     *
14797     * If a new item is selected the previosly selected will be unselected.
14798     * Previoulsy selected item can be get with function
14799     * elm_toolbar_selected_item_get().
14800     *
14801     * Selected items will be highlighted.
14802     *
14803     * @see elm_toolbar_item_selected_get()
14804     * @see elm_toolbar_selected_item_get()
14805     *
14806     * @ingroup Toolbar
14807     */
14808    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14809
14810    /**
14811     * Get the selected item.
14812     *
14813     * @param obj The toolbar object.
14814     * @return The selected toolbar item.
14815     *
14816     * The selected item can be unselected with function
14817     * elm_toolbar_item_selected_set().
14818     *
14819     * The selected item always will be highlighted on toolbar.
14820     *
14821     * @see elm_toolbar_selected_items_get()
14822     *
14823     * @ingroup Toolbar
14824     */
14825    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14826
14827    /**
14828     * Set the icon associated with @p item.
14829     *
14830     * @param obj The parent of this item.
14831     * @param item The toolbar item.
14832     * @param icon A string with icon name or the absolute path of an image file.
14833     *
14834     * Toolbar will load icon image from fdo or current theme.
14835     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14836     * If an absolute path is provided it will load it direct from a file.
14837     *
14838     * @see elm_toolbar_icon_order_lookup_set()
14839     * @see elm_toolbar_icon_order_lookup_get()
14840     *
14841     * @ingroup Toolbar
14842     */
14843    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14844
14845    /**
14846     * Get the string used to set the icon of @p item.
14847     *
14848     * @param item The toolbar item.
14849     * @return The string associated with the icon object.
14850     *
14851     * @see elm_toolbar_item_icon_set() for details.
14852     *
14853     * @ingroup Toolbar
14854     */
14855    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14856
14857    /**
14858     * Get the object of @p item.
14859     *
14860     * @param item The toolbar item.
14861     * @return The object
14862     *
14863     * @ingroup Toolbar
14864     */
14865    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14866
14867    /**
14868     * Get the icon object of @p item.
14869     *
14870     * @param item The toolbar item.
14871     * @return The icon object
14872     *
14873     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14874     *
14875     * @ingroup Toolbar
14876     */
14877    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14878
14879    /**
14880     * Set the icon associated with @p item to an image in a binary buffer.
14881     *
14882     * @param item The toolbar item.
14883     * @param img The binary data that will be used as an image
14884     * @param size The size of binary data @p img
14885     * @param format Optional format of @p img to pass to the image loader
14886     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14887     *
14888     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14889     *
14890     * @note The icon image set by this function can be changed by
14891     * elm_toolbar_item_icon_set().
14892     * 
14893     * @ingroup Toolbar
14894     */
14895    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);
14896
14897    /**
14898     * Delete them item from the toolbar.
14899     *
14900     * @param item The item of toolbar to be deleted.
14901     *
14902     * @see elm_toolbar_item_append()
14903     * @see elm_toolbar_item_del_cb_set()
14904     *
14905     * @ingroup Toolbar
14906     */
14907    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14908
14909    /**
14910     * Set the function called when a toolbar item is freed.
14911     *
14912     * @param item The item to set the callback on.
14913     * @param func The function called.
14914     *
14915     * If there is a @p func, then it will be called prior item's memory release.
14916     * That will be called with the following arguments:
14917     * @li item's data;
14918     * @li item's Evas object;
14919     * @li item itself;
14920     *
14921     * This way, a data associated to a toolbar item could be properly freed.
14922     *
14923     * @ingroup Toolbar
14924     */
14925    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14926
14927    /**
14928     * Get a value whether toolbar item is disabled or not.
14929     *
14930     * @param item The item.
14931     * @return The disabled state.
14932     *
14933     * @see elm_toolbar_item_disabled_set() for more details.
14934     *
14935     * @ingroup Toolbar
14936     */
14937    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14938
14939    /**
14940     * Sets the disabled/enabled state of a toolbar item.
14941     *
14942     * @param item The item.
14943     * @param disabled The disabled state.
14944     *
14945     * A disabled item cannot be selected or unselected. It will also
14946     * change its appearance (generally greyed out). This sets the
14947     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14948     * enabled).
14949     *
14950     * @ingroup Toolbar
14951     */
14952    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14953
14954    /**
14955     * Set or unset item as a separator.
14956     *
14957     * @param item The toolbar item.
14958     * @param setting @c EINA_TRUE to set item @p item as separator or
14959     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14960     *
14961     * Items aren't set as separator by default.
14962     *
14963     * If set as separator it will display separator theme, so won't display
14964     * icons or label.
14965     *
14966     * @see elm_toolbar_item_separator_get()
14967     *
14968     * @ingroup Toolbar
14969     */
14970    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14971
14972    /**
14973     * Get a value whether item is a separator or not.
14974     *
14975     * @param item The toolbar item.
14976     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14977     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14978     *
14979     * @see elm_toolbar_item_separator_set() for details.
14980     *
14981     * @ingroup Toolbar
14982     */
14983    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14984
14985    /**
14986     * Set the shrink state of toolbar @p obj.
14987     *
14988     * @param obj The toolbar object.
14989     * @param shrink_mode Toolbar's items display behavior.
14990     *
14991     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14992     * but will enforce a minimun size so all the items will fit, won't scroll
14993     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14994     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14995     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14996     *
14997     * @ingroup Toolbar
14998     */
14999    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15000
15001    /**
15002     * Get the shrink mode of toolbar @p obj.
15003     *
15004     * @param obj The toolbar object.
15005     * @return Toolbar's items display behavior.
15006     *
15007     * @see elm_toolbar_mode_shrink_set() for details.
15008     *
15009     * @ingroup Toolbar
15010     */
15011    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15012
15013    /**
15014     * Enable/disable homogenous mode.
15015     *
15016     * @param obj The toolbar object
15017     * @param homogeneous Assume the items within the toolbar are of the
15018     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15019     *
15020     * This will enable the homogeneous mode where items are of the same size.
15021     * @see elm_toolbar_homogeneous_get()
15022     *
15023     * @ingroup Toolbar
15024     */
15025    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15026
15027    /**
15028     * Get whether the homogenous mode is enabled.
15029     *
15030     * @param obj The toolbar object.
15031     * @return Assume the items within the toolbar are of the same height
15032     * and width (EINA_TRUE = on, EINA_FALSE = off).
15033     *
15034     * @see elm_toolbar_homogeneous_set()
15035     *
15036     * @ingroup Toolbar
15037     */
15038    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15039
15040    /**
15041     * Enable/disable homogenous mode.
15042     *
15043     * @param obj The toolbar object
15044     * @param homogeneous Assume the items within the toolbar are of the
15045     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15046     *
15047     * This will enable the homogeneous mode where items are of the same size.
15048     * @see elm_toolbar_homogeneous_get()
15049     *
15050     * @deprecated use elm_toolbar_homogeneous_set() instead.
15051     *
15052     * @ingroup Toolbar
15053     */
15054    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15055
15056    /**
15057     * Get whether the homogenous mode is enabled.
15058     *
15059     * @param obj The toolbar object.
15060     * @return Assume the items within the toolbar are of the same height
15061     * and width (EINA_TRUE = on, EINA_FALSE = off).
15062     *
15063     * @see elm_toolbar_homogeneous_set()
15064     * @deprecated use elm_toolbar_homogeneous_get() instead.
15065     *
15066     * @ingroup Toolbar
15067     */
15068    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15069
15070    /**
15071     * Set the parent object of the toolbar items' menus.
15072     *
15073     * @param obj The toolbar object.
15074     * @param parent The parent of the menu objects.
15075     *
15076     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15077     *
15078     * For more details about setting the parent for toolbar menus, see
15079     * elm_menu_parent_set().
15080     *
15081     * @see elm_menu_parent_set() for details.
15082     * @see elm_toolbar_item_menu_set() for details.
15083     *
15084     * @ingroup Toolbar
15085     */
15086    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15087
15088    /**
15089     * Get the parent object of the toolbar items' menus.
15090     *
15091     * @param obj The toolbar object.
15092     * @return The parent of the menu objects.
15093     *
15094     * @see elm_toolbar_menu_parent_set() for details.
15095     *
15096     * @ingroup Toolbar
15097     */
15098    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15099
15100    /**
15101     * Set the alignment of the items.
15102     *
15103     * @param obj The toolbar object.
15104     * @param align The new alignment, a float between <tt> 0.0 </tt>
15105     * and <tt> 1.0 </tt>.
15106     *
15107     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15108     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15109     * items.
15110     *
15111     * Centered items by default.
15112     *
15113     * @see elm_toolbar_align_get()
15114     *
15115     * @ingroup Toolbar
15116     */
15117    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15118
15119    /**
15120     * Get the alignment of the items.
15121     *
15122     * @param obj The toolbar object.
15123     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15124     * <tt> 1.0 </tt>.
15125     *
15126     * @see elm_toolbar_align_set() for details.
15127     *
15128     * @ingroup Toolbar
15129     */
15130    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15131
15132    /**
15133     * Set whether the toolbar item opens a menu.
15134     *
15135     * @param item The toolbar item.
15136     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15137     *
15138     * A toolbar item can be set to be a menu, using this function.
15139     *
15140     * Once it is set to be a menu, it can be manipulated through the
15141     * menu-like function elm_toolbar_menu_parent_set() and the other
15142     * elm_menu functions, using the Evas_Object @c menu returned by
15143     * elm_toolbar_item_menu_get().
15144     *
15145     * So, items to be displayed in this item's menu should be added with
15146     * elm_menu_item_add().
15147     *
15148     * The following code exemplifies the most basic usage:
15149     * @code
15150     * tb = elm_toolbar_add(win)
15151     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15152     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15153     * elm_toolbar_menu_parent_set(tb, win);
15154     * menu = elm_toolbar_item_menu_get(item);
15155     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15156     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15157     * NULL);
15158     * @endcode
15159     *
15160     * @see elm_toolbar_item_menu_get()
15161     *
15162     * @ingroup Toolbar
15163     */
15164    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15165
15166    /**
15167     * Get toolbar item's menu.
15168     *
15169     * @param item The toolbar item.
15170     * @return Item's menu object or @c NULL on failure.
15171     *
15172     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15173     * this function will set it.
15174     *
15175     * @see elm_toolbar_item_menu_set() for details.
15176     *
15177     * @ingroup Toolbar
15178     */
15179    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15180
15181    /**
15182     * Add a new state to @p item.
15183     *
15184     * @param item The item.
15185     * @param icon A string with icon name or the absolute path of an image file.
15186     * @param label The label of the new state.
15187     * @param func The function to call when the item is clicked when this
15188     * state is selected.
15189     * @param data The data to associate with the state.
15190     * @return The toolbar item state, or @c NULL upon failure.
15191     *
15192     * Toolbar will load icon image from fdo or current theme.
15193     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15194     * If an absolute path is provided it will load it direct from a file.
15195     *
15196     * States created with this function can be removed with
15197     * elm_toolbar_item_state_del().
15198     *
15199     * @see elm_toolbar_item_state_del()
15200     * @see elm_toolbar_item_state_sel()
15201     * @see elm_toolbar_item_state_get()
15202     *
15203     * @ingroup Toolbar
15204     */
15205    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);
15206
15207    /**
15208     * Delete a previoulsy added state to @p item.
15209     *
15210     * @param item The toolbar item.
15211     * @param state The state to be deleted.
15212     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15213     *
15214     * @see elm_toolbar_item_state_add()
15215     */
15216    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15217
15218    /**
15219     * Set @p state as the current state of @p it.
15220     *
15221     * @param it The item.
15222     * @param state The state to use.
15223     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15224     *
15225     * If @p state is @c NULL, it won't select any state and the default item's
15226     * icon and label will be used. It's the same behaviour than
15227     * elm_toolbar_item_state_unser().
15228     *
15229     * @see elm_toolbar_item_state_unset()
15230     *
15231     * @ingroup Toolbar
15232     */
15233    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15234
15235    /**
15236     * Unset the state of @p it.
15237     *
15238     * @param it The item.
15239     *
15240     * The default icon and label from this item will be displayed.
15241     *
15242     * @see elm_toolbar_item_state_set() for more details.
15243     *
15244     * @ingroup Toolbar
15245     */
15246    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15247
15248    /**
15249     * Get the current state of @p it.
15250     *
15251     * @param item The item.
15252     * @return The selected state or @c NULL if none is selected or on failure.
15253     *
15254     * @see elm_toolbar_item_state_set() for details.
15255     * @see elm_toolbar_item_state_unset()
15256     * @see elm_toolbar_item_state_add()
15257     *
15258     * @ingroup Toolbar
15259     */
15260    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15261
15262    /**
15263     * Get the state after selected state in toolbar's @p item.
15264     *
15265     * @param it The toolbar item to change state.
15266     * @return The state after current state, or @c NULL on failure.
15267     *
15268     * If last state is selected, this function will return first state.
15269     *
15270     * @see elm_toolbar_item_state_set()
15271     * @see elm_toolbar_item_state_add()
15272     *
15273     * @ingroup Toolbar
15274     */
15275    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15276
15277    /**
15278     * Get the state before selected state in toolbar's @p item.
15279     *
15280     * @param it The toolbar item to change state.
15281     * @return The state before current state, or @c NULL on failure.
15282     *
15283     * If first state is selected, this function will return last state.
15284     *
15285     * @see elm_toolbar_item_state_set()
15286     * @see elm_toolbar_item_state_add()
15287     *
15288     * @ingroup Toolbar
15289     */
15290    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15291
15292    /**
15293     * Set the text to be shown in a given toolbar item's tooltips.
15294     *
15295     * @param item Target item.
15296     * @param text The text to set in the content.
15297     *
15298     * Setup the text as tooltip to object. The item can have only one tooltip,
15299     * so any previous tooltip data - set with this function or
15300     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15301     *
15302     * @see elm_object_tooltip_text_set() for more details.
15303     *
15304     * @ingroup Toolbar
15305     */
15306    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15307
15308    /**
15309     * Set the content to be shown in the tooltip item.
15310     *
15311     * Setup the tooltip to item. The item can have only one tooltip,
15312     * so any previous tooltip data is removed. @p func(with @p data) will
15313     * be called every time that need show the tooltip and it should
15314     * return a valid Evas_Object. This object is then managed fully by
15315     * tooltip system and is deleted when the tooltip is gone.
15316     *
15317     * @param item the toolbar item being attached a tooltip.
15318     * @param func the function used to create the tooltip contents.
15319     * @param data what to provide to @a func as callback data/context.
15320     * @param del_cb called when data is not needed anymore, either when
15321     *        another callback replaces @a func, the tooltip is unset with
15322     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15323     *        dies. This callback receives as the first parameter the
15324     *        given @a data, and @c event_info is the item.
15325     *
15326     * @see elm_object_tooltip_content_cb_set() for more details.
15327     *
15328     * @ingroup Toolbar
15329     */
15330    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);
15331
15332    /**
15333     * Unset tooltip from item.
15334     *
15335     * @param item toolbar item to remove previously set tooltip.
15336     *
15337     * Remove tooltip from item. The callback provided as del_cb to
15338     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15339     * it is not used anymore.
15340     *
15341     * @see elm_object_tooltip_unset() for more details.
15342     * @see elm_toolbar_item_tooltip_content_cb_set()
15343     *
15344     * @ingroup Toolbar
15345     */
15346    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15347
15348    /**
15349     * Sets a different style for this item tooltip.
15350     *
15351     * @note before you set a style you should define a tooltip with
15352     *       elm_toolbar_item_tooltip_content_cb_set() or
15353     *       elm_toolbar_item_tooltip_text_set()
15354     *
15355     * @param item toolbar item with tooltip already set.
15356     * @param style the theme style to use (default, transparent, ...)
15357     *
15358     * @see elm_object_tooltip_style_set() for more details.
15359     *
15360     * @ingroup Toolbar
15361     */
15362    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15363
15364    /**
15365     * Get the style for this item tooltip.
15366     *
15367     * @param item toolbar item with tooltip already set.
15368     * @return style the theme style in use, defaults to "default". If the
15369     *         object does not have a tooltip set, then NULL is returned.
15370     *
15371     * @see elm_object_tooltip_style_get() for more details.
15372     * @see elm_toolbar_item_tooltip_style_set()
15373     *
15374     * @ingroup Toolbar
15375     */
15376    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15377
15378    /**
15379     * Set the type of mouse pointer/cursor decoration to be shown,
15380     * when the mouse pointer is over the given toolbar widget item
15381     *
15382     * @param item toolbar item to customize cursor on
15383     * @param cursor the cursor type's name
15384     *
15385     * This function works analogously as elm_object_cursor_set(), but
15386     * here the cursor's changing area is restricted to the item's
15387     * area, and not the whole widget's. Note that that item cursors
15388     * have precedence over widget cursors, so that a mouse over an
15389     * item with custom cursor set will always show @b that cursor.
15390     *
15391     * If this function is called twice for an object, a previously set
15392     * cursor will be unset on the second call.
15393     *
15394     * @see elm_object_cursor_set()
15395     * @see elm_toolbar_item_cursor_get()
15396     * @see elm_toolbar_item_cursor_unset()
15397     *
15398     * @ingroup Toolbar
15399     */
15400    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15401
15402    /*
15403     * Get the type of mouse pointer/cursor decoration set to be shown,
15404     * when the mouse pointer is over the given toolbar widget item
15405     *
15406     * @param item toolbar item with custom cursor set
15407     * @return the cursor type's name or @c NULL, if no custom cursors
15408     * were set to @p item (and on errors)
15409     *
15410     * @see elm_object_cursor_get()
15411     * @see elm_toolbar_item_cursor_set()
15412     * @see elm_toolbar_item_cursor_unset()
15413     *
15414     * @ingroup Toolbar
15415     */
15416    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15417
15418    /**
15419     * Unset any custom mouse pointer/cursor decoration set to be
15420     * shown, when the mouse pointer is over the given toolbar widget
15421     * item, thus making it show the @b default cursor again.
15422     *
15423     * @param item a toolbar item
15424     *
15425     * Use this call to undo any custom settings on this item's cursor
15426     * decoration, bringing it back to defaults (no custom style set).
15427     *
15428     * @see elm_object_cursor_unset()
15429     * @see elm_toolbar_item_cursor_set()
15430     *
15431     * @ingroup Toolbar
15432     */
15433    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15434
15435    /**
15436     * Set a different @b style for a given custom cursor set for a
15437     * toolbar item.
15438     *
15439     * @param item toolbar item with custom cursor set
15440     * @param style the <b>theme style</b> to use (e.g. @c "default",
15441     * @c "transparent", etc)
15442     *
15443     * This function only makes sense when one is using custom mouse
15444     * cursor decorations <b>defined in a theme file</b>, which can have,
15445     * given a cursor name/type, <b>alternate styles</b> on it. It
15446     * works analogously as elm_object_cursor_style_set(), but here
15447     * applyed only to toolbar item objects.
15448     *
15449     * @warning Before you set a cursor style you should have definen a
15450     *       custom cursor previously on the item, with
15451     *       elm_toolbar_item_cursor_set()
15452     *
15453     * @see elm_toolbar_item_cursor_engine_only_set()
15454     * @see elm_toolbar_item_cursor_style_get()
15455     *
15456     * @ingroup Toolbar
15457     */
15458    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15459
15460    /**
15461     * Get the current @b style set for a given toolbar item's custom
15462     * cursor
15463     *
15464     * @param item toolbar item with custom cursor set.
15465     * @return style the cursor style in use. If the object does not
15466     *         have a cursor set, then @c NULL is returned.
15467     *
15468     * @see elm_toolbar_item_cursor_style_set() for more details
15469     *
15470     * @ingroup Toolbar
15471     */
15472    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15473
15474    /**
15475     * Set if the (custom)cursor for a given toolbar item should be
15476     * searched in its theme, also, or should only rely on the
15477     * rendering engine.
15478     *
15479     * @param item item with custom (custom) cursor already set on
15480     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15481     * only on those provided by the rendering engine, @c EINA_FALSE to
15482     * have them searched on the widget's theme, as well.
15483     *
15484     * @note This call is of use only if you've set a custom cursor
15485     * for toolbar items, with elm_toolbar_item_cursor_set().
15486     *
15487     * @note By default, cursors will only be looked for between those
15488     * provided by the rendering engine.
15489     *
15490     * @ingroup Toolbar
15491     */
15492    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15493
15494    /**
15495     * Get if the (custom) cursor for a given toolbar item is being
15496     * searched in its theme, also, or is only relying on the rendering
15497     * engine.
15498     *
15499     * @param item a toolbar item
15500     * @return @c EINA_TRUE, if cursors are being looked for only on
15501     * those provided by the rendering engine, @c EINA_FALSE if they
15502     * are being searched on the widget's theme, as well.
15503     *
15504     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15505     *
15506     * @ingroup Toolbar
15507     */
15508    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15509
15510    /**
15511     * Change a toolbar's orientation
15512     * @param obj The toolbar object
15513     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15514     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15515     * @ingroup Toolbar
15516     * @deprecated use elm_toolbar_horizontal_set() instead.
15517     */
15518    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15519
15520    /**
15521     * Change a toolbar's orientation
15522     * @param obj The toolbar object
15523     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15524     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15525     * @ingroup Toolbar
15526     */
15527    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15528
15529    /**
15530     * Get a toolbar's orientation
15531     * @param obj The toolbar object
15532     * @return If @c EINA_TRUE, the toolbar is vertical
15533     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15534     * @ingroup Toolbar
15535     * @deprecated use elm_toolbar_horizontal_get() instead.
15536     */
15537    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15538
15539    /**
15540     * Get a toolbar's orientation
15541     * @param obj The toolbar object
15542     * @return If @c EINA_TRUE, the toolbar is horizontal
15543     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15544     * @ingroup Toolbar
15545     */
15546    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15547    /**
15548     * @}
15549     */
15550
15551    /**
15552     * @defgroup Tooltips Tooltips
15553     *
15554     * The Tooltip is an (internal, for now) smart object used to show a
15555     * content in a frame on mouse hover of objects(or widgets), with
15556     * tips/information about them.
15557     *
15558     * @{
15559     */
15560
15561    EAPI double       elm_tooltip_delay_get(void);
15562    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15563    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15564    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15565    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15566    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15567 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15568    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);
15569    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15570    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15571    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15572
15573    /**
15574     * @defgroup Cursors Cursors
15575     *
15576     * The Elementary cursor is an internal smart object used to
15577     * customize the mouse cursor displayed over objects (or
15578     * widgets). In the most common scenario, the cursor decoration
15579     * comes from the graphical @b engine Elementary is running
15580     * on. Those engines may provide different decorations for cursors,
15581     * and Elementary provides functions to choose them (think of X11
15582     * cursors, as an example).
15583     *
15584     * There's also the possibility of, besides using engine provided
15585     * cursors, also use ones coming from Edje theming files. Both
15586     * globally and per widget, Elementary makes it possible for one to
15587     * make the cursors lookup to be held on engines only or on
15588     * Elementary's theme file, too. To set cursor's hot spot,
15589     * two data items should be added to cursor's theme: "hot_x" and
15590     * "hot_y", that are the offset from upper-left corner of the cursor
15591     * (coordinates 0,0).
15592     *
15593     * @{
15594     */
15595
15596    /**
15597     * Set the cursor to be shown when mouse is over the object
15598     *
15599     * Set the cursor that will be displayed when mouse is over the
15600     * object. The object can have only one cursor set to it, so if
15601     * this function is called twice for an object, the previous set
15602     * will be unset.
15603     * If using X cursors, a definition of all the valid cursor names
15604     * is listed on Elementary_Cursors.h. If an invalid name is set
15605     * the default cursor will be used.
15606     *
15607     * @param obj the object being set a cursor.
15608     * @param cursor the cursor name to be used.
15609     *
15610     * @ingroup Cursors
15611     */
15612    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15613
15614    /**
15615     * Get the cursor to be shown when mouse is over the object
15616     *
15617     * @param obj an object with cursor already set.
15618     * @return the cursor name.
15619     *
15620     * @ingroup Cursors
15621     */
15622    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15623
15624    /**
15625     * Unset cursor for object
15626     *
15627     * Unset cursor for object, and set the cursor to default if the mouse
15628     * was over this object.
15629     *
15630     * @param obj Target object
15631     * @see elm_object_cursor_set()
15632     *
15633     * @ingroup Cursors
15634     */
15635    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15636
15637    /**
15638     * Sets a different style for this object cursor.
15639     *
15640     * @note before you set a style you should define a cursor with
15641     *       elm_object_cursor_set()
15642     *
15643     * @param obj an object with cursor already set.
15644     * @param style the theme style to use (default, transparent, ...)
15645     *
15646     * @ingroup Cursors
15647     */
15648    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15649
15650    /**
15651     * Get the style for this object cursor.
15652     *
15653     * @param obj an object with cursor already set.
15654     * @return style the theme style in use, defaults to "default". If the
15655     *         object does not have a cursor set, then NULL is returned.
15656     *
15657     * @ingroup Cursors
15658     */
15659    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15660
15661    /**
15662     * Set if the cursor set should be searched on the theme or should use
15663     * the provided by the engine, only.
15664     *
15665     * @note before you set if should look on theme you should define a cursor
15666     * with elm_object_cursor_set(). By default it will only look for cursors
15667     * provided by the engine.
15668     *
15669     * @param obj an object with cursor already set.
15670     * @param engine_only boolean to define it cursors should be looked only
15671     * between the provided by the engine or searched on widget's theme as well.
15672     *
15673     * @ingroup Cursors
15674     */
15675    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15676
15677    /**
15678     * Get the cursor engine only usage for this object cursor.
15679     *
15680     * @param obj an object with cursor already set.
15681     * @return engine_only boolean to define it cursors should be
15682     * looked only between the provided by the engine or searched on
15683     * widget's theme as well. If the object does not have a cursor
15684     * set, then EINA_FALSE is returned.
15685     *
15686     * @ingroup Cursors
15687     */
15688    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15689
15690    /**
15691     * Get the configured cursor engine only usage
15692     *
15693     * This gets the globally configured exclusive usage of engine cursors.
15694     *
15695     * @return 1 if only engine cursors should be used
15696     * @ingroup Cursors
15697     */
15698    EAPI int          elm_cursor_engine_only_get(void);
15699
15700    /**
15701     * Set the configured cursor engine only usage
15702     *
15703     * This sets the globally configured exclusive usage of engine cursors.
15704     * It won't affect cursors set before changing this value.
15705     *
15706     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15707     * look for them on theme before.
15708     * @return EINA_TRUE if value is valid and setted (0 or 1)
15709     * @ingroup Cursors
15710     */
15711    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15712
15713    /**
15714     * @}
15715     */
15716
15717    /**
15718     * @defgroup Menu Menu
15719     *
15720     * @image html img/widget/menu/preview-00.png
15721     * @image latex img/widget/menu/preview-00.eps
15722     *
15723     * A menu is a list of items displayed above its parent. When the menu is
15724     * showing its parent is darkened. Each item can have a sub-menu. The menu
15725     * object can be used to display a menu on a right click event, in a toolbar,
15726     * anywhere.
15727     *
15728     * Signals that you can add callbacks for are:
15729     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15730     *             event_info is NULL.
15731     *
15732     * @see @ref tutorial_menu
15733     * @{
15734     */
15735    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15736    /**
15737     * @brief Add a new menu to the parent
15738     *
15739     * @param parent The parent object.
15740     * @return The new object or NULL if it cannot be created.
15741     */
15742    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15743    /**
15744     * @brief Set the parent for the given menu widget
15745     *
15746     * @param obj The menu object.
15747     * @param parent The new parent.
15748     */
15749    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15750    /**
15751     * @brief Get the parent for the given menu widget
15752     *
15753     * @param obj The menu object.
15754     * @return The parent.
15755     *
15756     * @see elm_menu_parent_set()
15757     */
15758    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15759    /**
15760     * @brief Move the menu to a new position
15761     *
15762     * @param obj The menu object.
15763     * @param x The new position.
15764     * @param y The new position.
15765     *
15766     * Sets the top-left position of the menu to (@p x,@p y).
15767     *
15768     * @note @p x and @p y coordinates are relative to parent.
15769     */
15770    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15771    /**
15772     * @brief Close a opened menu
15773     *
15774     * @param obj the menu object
15775     * @return void
15776     *
15777     * Hides the menu and all it's sub-menus.
15778     */
15779    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15780    /**
15781     * @brief Returns a list of @p item's items.
15782     *
15783     * @param obj The menu object
15784     * @return An Eina_List* of @p item's items
15785     */
15786    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15787    /**
15788     * @brief Get the Evas_Object of an Elm_Menu_Item
15789     *
15790     * @param item The menu item object.
15791     * @return The edje object containing the swallowed content
15792     *
15793     * @warning Don't manipulate this object!
15794     */
15795    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15796    /**
15797     * @brief Add an item at the end of the given menu widget
15798     *
15799     * @param obj The menu object.
15800     * @param parent The parent menu item (optional)
15801     * @param icon A icon display on the item. The icon will be destryed by the menu.
15802     * @param label The label of the item.
15803     * @param func Function called when the user select the item.
15804     * @param data Data sent by the callback.
15805     * @return Returns the new item.
15806     */
15807    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);
15808    /**
15809     * @brief Add an object swallowed in an item at the end of the given menu
15810     * widget
15811     *
15812     * @param obj The menu object.
15813     * @param parent The parent menu item (optional)
15814     * @param subobj The object to swallow
15815     * @param func Function called when the user select the item.
15816     * @param data Data sent by the callback.
15817     * @return Returns the new item.
15818     *
15819     * Add an evas object as an item to the menu.
15820     */
15821    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);
15822    /**
15823     * @brief Set the label of a menu item
15824     *
15825     * @param item The menu item object.
15826     * @param label The label to set for @p item
15827     *
15828     * @warning Don't use this funcion on items created with
15829     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15830     */
15831    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15832    /**
15833     * @brief Get the label of a menu item
15834     *
15835     * @param item The menu item object.
15836     * @return The label of @p item
15837     */
15838    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15839    /**
15840     * @brief Set the icon of a menu item to the standard icon with name @p icon
15841     *
15842     * @param item The menu item object.
15843     * @param icon The icon object to set for the content of @p item
15844     *
15845     * Once this icon is set, any previously set icon will be deleted.
15846     */
15847    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15848    /**
15849     * @brief Get the string representation from the icon of a menu item
15850     *
15851     * @param item The menu item object.
15852     * @return The string representation of @p item's icon or NULL
15853     *
15854     * @see elm_menu_item_object_icon_name_set()
15855     */
15856    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15857    /**
15858     * @brief Set the content object of a menu item
15859     *
15860     * @param item The menu item object
15861     * @param The content object or NULL
15862     * @return EINA_TRUE on success, else EINA_FALSE
15863     *
15864     * Use this function to change the object swallowed by a menu item, deleting
15865     * any previously swallowed object.
15866     */
15867    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15868    /**
15869     * @brief Get the content object of a menu item
15870     *
15871     * @param item The menu item object
15872     * @return The content object or NULL
15873     * @note If @p item was added with elm_menu_item_add_object, this
15874     * function will return the object passed, else it will return the
15875     * icon object.
15876     *
15877     * @see elm_menu_item_object_content_set()
15878     */
15879    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15880
15881    EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
15882      {
15883         elm_menu_item_object_icon_name_set(item, icon);
15884      }
15885
15886    EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15887      {
15888         return elm_menu_item_object_content_get(item);
15889      }
15890
15891    EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15892      {
15893         return elm_menu_item_object_icon_name_get(item);
15894      }
15895
15896    /**
15897     * @brief Set the selected state of @p item.
15898     *
15899     * @param item The menu item object.
15900     * @param selected The selected/unselected state of the item
15901     */
15902    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15903    /**
15904     * @brief Get the selected state of @p item.
15905     *
15906     * @param item The menu item object.
15907     * @return The selected/unselected state of the item
15908     *
15909     * @see elm_menu_item_selected_set()
15910     */
15911    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15912    /**
15913     * @brief Set the disabled state of @p item.
15914     *
15915     * @param item The menu item object.
15916     * @param disabled The enabled/disabled state of the item
15917     */
15918    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15919    /**
15920     * @brief Get the disabled state of @p item.
15921     *
15922     * @param item The menu item object.
15923     * @return The enabled/disabled state of the item
15924     *
15925     * @see elm_menu_item_disabled_set()
15926     */
15927    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15928    /**
15929     * @brief Add a separator item to menu @p obj under @p parent.
15930     *
15931     * @param obj The menu object
15932     * @param parent The item to add the separator under
15933     * @return The created item or NULL on failure
15934     *
15935     * This is item is a @ref Separator.
15936     */
15937    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15938    /**
15939     * @brief Returns whether @p item is a separator.
15940     *
15941     * @param item The item to check
15942     * @return If true, @p item is a separator
15943     *
15944     * @see elm_menu_item_separator_add()
15945     */
15946    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15947    /**
15948     * @brief Deletes an item from the menu.
15949     *
15950     * @param item The item to delete.
15951     *
15952     * @see elm_menu_item_add()
15953     */
15954    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15955    /**
15956     * @brief Set the function called when a menu item is deleted.
15957     *
15958     * @param item The item to set the callback on
15959     * @param func The function called
15960     *
15961     * @see elm_menu_item_add()
15962     * @see elm_menu_item_del()
15963     */
15964    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15965    /**
15966     * @brief Returns the data associated with menu item @p item.
15967     *
15968     * @param item The item
15969     * @return The data associated with @p item or NULL if none was set.
15970     *
15971     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15972     */
15973    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15974    /**
15975     * @brief Sets the data to be associated with menu item @p item.
15976     *
15977     * @param item The item
15978     * @param data The data to be associated with @p item
15979     */
15980    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15981    /**
15982     * @brief Returns a list of @p item's subitems.
15983     *
15984     * @param item The item
15985     * @return An Eina_List* of @p item's subitems
15986     *
15987     * @see elm_menu_add()
15988     */
15989    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15990    /**
15991     * @brief Get the position of a menu item
15992     *
15993     * @param item The menu item
15994     * @return The item's index
15995     *
15996     * This function returns the index position of a menu item in a menu.
15997     * For a sub-menu, this number is relative to the first item in the sub-menu.
15998     *
15999     * @note Index values begin with 0
16000     */
16001    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16002    /**
16003     * @brief @brief Return a menu item's owner menu
16004     *
16005     * @param item The menu item
16006     * @return The menu object owning @p item, or NULL on failure
16007     *
16008     * Use this function to get the menu object owning an item.
16009     */
16010    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16011    /**
16012     * @brief Get the selected item in the menu
16013     *
16014     * @param obj The menu object
16015     * @return The selected item, or NULL if none
16016     *
16017     * @see elm_menu_item_selected_get()
16018     * @see elm_menu_item_selected_set()
16019     */
16020    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16021    /**
16022     * @brief Get the last item in the menu
16023     *
16024     * @param obj The menu object
16025     * @return The last item, or NULL if none
16026     */
16027    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16028    /**
16029     * @brief Get the first item in the menu
16030     *
16031     * @param obj The menu object
16032     * @return The first item, or NULL if none
16033     */
16034    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16035    /**
16036     * @brief Get the next item in the menu.
16037     *
16038     * @param item The menu item object.
16039     * @return The item after it, or NULL if none
16040     */
16041    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16042    /**
16043     * @brief Get the previous item in the menu.
16044     *
16045     * @param item The menu item object.
16046     * @return The item before it, or NULL if none
16047     */
16048    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16049    /**
16050     * @}
16051     */
16052
16053    /**
16054     * @defgroup List List
16055     * @ingroup Elementary
16056     *
16057     * @image html img/widget/list/preview-00.png
16058     * @image latex img/widget/list/preview-00.eps width=\textwidth
16059     *
16060     * @image html img/list.png
16061     * @image latex img/list.eps width=\textwidth
16062     *
16063     * A list widget is a container whose children are displayed vertically or
16064     * horizontally, in order, and can be selected.
16065     * The list can accept only one or multiple items selection. Also has many
16066     * modes of items displaying.
16067     *
16068     * A list is a very simple type of list widget.  For more robust
16069     * lists, @ref Genlist should probably be used.
16070     *
16071     * Smart callbacks one can listen to:
16072     * - @c "activated" - The user has double-clicked or pressed
16073     *   (enter|return|spacebar) on an item. The @c event_info parameter
16074     *   is the item that was activated.
16075     * - @c "clicked,double" - The user has double-clicked an item.
16076     *   The @c event_info parameter is the item that was double-clicked.
16077     * - "selected" - when the user selected an item
16078     * - "unselected" - when the user unselected an item
16079     * - "longpressed" - an item in the list is long-pressed
16080     * - "edge,top" - the list is scrolled until the top edge
16081     * - "edge,bottom" - the list is scrolled until the bottom edge
16082     * - "edge,left" - the list is scrolled until the left edge
16083     * - "edge,right" - the list is scrolled until the right edge
16084     * - "language,changed" - the program's language changed
16085     *
16086     * Available styles for it:
16087     * - @c "default"
16088     *
16089     * List of examples:
16090     * @li @ref list_example_01
16091     * @li @ref list_example_02
16092     * @li @ref list_example_03
16093     */
16094
16095    /**
16096     * @addtogroup List
16097     * @{
16098     */
16099
16100    /**
16101     * @enum _Elm_List_Mode
16102     * @typedef Elm_List_Mode
16103     *
16104     * Set list's resize behavior, transverse axis scroll and
16105     * items cropping. See each mode's description for more details.
16106     *
16107     * @note Default value is #ELM_LIST_SCROLL.
16108     *
16109     * Values <b> don't </b> work as bitmask, only one can be choosen.
16110     *
16111     * @see elm_list_mode_set()
16112     * @see elm_list_mode_get()
16113     *
16114     * @ingroup List
16115     */
16116    typedef enum _Elm_List_Mode
16117      {
16118         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. */
16119         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). */
16120         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. */
16121         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. */
16122         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16123      } Elm_List_Mode;
16124
16125    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().  */
16126
16127    /**
16128     * Add a new list widget to the given parent Elementary
16129     * (container) object.
16130     *
16131     * @param parent The parent object.
16132     * @return a new list widget handle or @c NULL, on errors.
16133     *
16134     * This function inserts a new list widget on the canvas.
16135     *
16136     * @ingroup List
16137     */
16138    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16139
16140    /**
16141     * Starts the list.
16142     *
16143     * @param obj The list object
16144     *
16145     * @note Call before running show() on the list object.
16146     * @warning If not called, it won't display the list properly.
16147     *
16148     * @code
16149     * li = elm_list_add(win);
16150     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16151     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16152     * elm_list_go(li);
16153     * evas_object_show(li);
16154     * @endcode
16155     *
16156     * @ingroup List
16157     */
16158    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16159
16160    /**
16161     * Enable or disable multiple items selection on the list object.
16162     *
16163     * @param obj The list object
16164     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16165     * disable it.
16166     *
16167     * Disabled by default. If disabled, the user can select a single item of
16168     * the list each time. Selected items are highlighted on list.
16169     * If enabled, many items can be selected.
16170     *
16171     * If a selected item is selected again, it will be unselected.
16172     *
16173     * @see elm_list_multi_select_get()
16174     *
16175     * @ingroup List
16176     */
16177    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16178
16179    /**
16180     * Get a value whether multiple items selection is enabled or not.
16181     *
16182     * @see elm_list_multi_select_set() for details.
16183     *
16184     * @param obj The list object.
16185     * @return @c EINA_TRUE means multiple items selection is enabled.
16186     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16187     * @c EINA_FALSE is returned.
16188     *
16189     * @ingroup List
16190     */
16191    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16192
16193    /**
16194     * Set which mode to use for the list object.
16195     *
16196     * @param obj The list object
16197     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16198     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16199     *
16200     * Set list's resize behavior, transverse axis scroll and
16201     * items cropping. See each mode's description for more details.
16202     *
16203     * @note Default value is #ELM_LIST_SCROLL.
16204     *
16205     * Only one can be set, if a previous one was set, it will be changed
16206     * by the new mode set. Bitmask won't work as well.
16207     *
16208     * @see elm_list_mode_get()
16209     *
16210     * @ingroup List
16211     */
16212    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16213
16214    /**
16215     * Get the mode the list is at.
16216     *
16217     * @param obj The list object
16218     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16219     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16220     *
16221     * @note see elm_list_mode_set() for more information.
16222     *
16223     * @ingroup List
16224     */
16225    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16226
16227    /**
16228     * Enable or disable horizontal mode on the list object.
16229     *
16230     * @param obj The list object.
16231     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16232     * disable it, i.e., to enable vertical mode.
16233     *
16234     * @note Vertical mode is set by default.
16235     *
16236     * On horizontal mode items are displayed on list from left to right,
16237     * instead of from top to bottom. Also, the list will scroll horizontally.
16238     * Each item will presents left icon on top and right icon, or end, at
16239     * the bottom.
16240     *
16241     * @see elm_list_horizontal_get()
16242     *
16243     * @ingroup List
16244     */
16245    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16246
16247    /**
16248     * Get a value whether horizontal mode is enabled or not.
16249     *
16250     * @param obj The list object.
16251     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16252     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16253     * @c EINA_FALSE is returned.
16254     *
16255     * @see elm_list_horizontal_set() for details.
16256     *
16257     * @ingroup List
16258     */
16259    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16260
16261    /**
16262     * Enable or disable always select mode on the list object.
16263     *
16264     * @param obj The list object
16265     * @param always_select @c EINA_TRUE to enable always select mode or
16266     * @c EINA_FALSE to disable it.
16267     *
16268     * @note Always select mode is disabled by default.
16269     *
16270     * Default behavior of list items is to only call its callback function
16271     * the first time it's pressed, i.e., when it is selected. If a selected
16272     * item is pressed again, and multi-select is disabled, it won't call
16273     * this function (if multi-select is enabled it will unselect the item).
16274     *
16275     * If always select is enabled, it will call the callback function
16276     * everytime a item is pressed, so it will call when the item is selected,
16277     * and again when a selected item is pressed.
16278     *
16279     * @see elm_list_always_select_mode_get()
16280     * @see elm_list_multi_select_set()
16281     *
16282     * @ingroup List
16283     */
16284    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16285
16286    /**
16287     * Get a value whether always select mode is enabled or not, meaning that
16288     * an item will always call its callback function, even if already selected.
16289     *
16290     * @param obj The list object
16291     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16292     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16293     * @c EINA_FALSE is returned.
16294     *
16295     * @see elm_list_always_select_mode_set() for details.
16296     *
16297     * @ingroup List
16298     */
16299    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16300
16301    /**
16302     * Set bouncing behaviour when the scrolled content reaches an edge.
16303     *
16304     * Tell the internal scroller object whether it should bounce or not
16305     * when it reaches the respective edges for each axis.
16306     *
16307     * @param obj The list object
16308     * @param h_bounce Whether to bounce or not in the horizontal axis.
16309     * @param v_bounce Whether to bounce or not in the vertical axis.
16310     *
16311     * @see elm_scroller_bounce_set()
16312     *
16313     * @ingroup List
16314     */
16315    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16316
16317    /**
16318     * Get the bouncing behaviour of the internal scroller.
16319     *
16320     * Get whether the internal scroller should bounce when the edge of each
16321     * axis is reached scrolling.
16322     *
16323     * @param obj The list object.
16324     * @param h_bounce Pointer where to store the bounce state of the horizontal
16325     * axis.
16326     * @param v_bounce Pointer where to store the bounce state of the vertical
16327     * axis.
16328     *
16329     * @see elm_scroller_bounce_get()
16330     * @see elm_list_bounce_set()
16331     *
16332     * @ingroup List
16333     */
16334    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16335
16336    /**
16337     * Set the scrollbar policy.
16338     *
16339     * @param obj The list object
16340     * @param policy_h Horizontal scrollbar policy.
16341     * @param policy_v Vertical scrollbar policy.
16342     *
16343     * This sets the scrollbar visibility policy for the given scroller.
16344     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16345     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16346     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16347     * This applies respectively for the horizontal and vertical scrollbars.
16348     *
16349     * The both are disabled by default, i.e., are set to
16350     * #ELM_SCROLLER_POLICY_OFF.
16351     *
16352     * @ingroup List
16353     */
16354    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16355
16356    /**
16357     * Get the scrollbar policy.
16358     *
16359     * @see elm_list_scroller_policy_get() for details.
16360     *
16361     * @param obj The list object.
16362     * @param policy_h Pointer where to store horizontal scrollbar policy.
16363     * @param policy_v Pointer where to store vertical scrollbar policy.
16364     *
16365     * @ingroup List
16366     */
16367    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);
16368
16369    /**
16370     * Append a new item to the list object.
16371     *
16372     * @param obj The list object.
16373     * @param label The label of the list item.
16374     * @param icon The icon object to use for the left side of the item. An
16375     * icon can be any Evas object, but usually it is an icon created
16376     * with elm_icon_add().
16377     * @param end The icon object to use for the right side of the item. An
16378     * icon can be any Evas object.
16379     * @param func The function to call when the item is clicked.
16380     * @param data The data to associate with the item for related callbacks.
16381     *
16382     * @return The created item or @c NULL upon failure.
16383     *
16384     * A new item will be created and appended to the list, i.e., will
16385     * be set as @b last item.
16386     *
16387     * Items created with this method can be deleted with
16388     * elm_list_item_del().
16389     *
16390     * Associated @p data can be properly freed when item is deleted if a
16391     * callback function is set with elm_list_item_del_cb_set().
16392     *
16393     * If a function is passed as argument, it will be called everytime this item
16394     * is selected, i.e., the user clicks over an unselected item.
16395     * If always select is enabled it will call this function every time
16396     * user clicks over an item (already selected or not).
16397     * If such function isn't needed, just passing
16398     * @c NULL as @p func is enough. The same should be done for @p data.
16399     *
16400     * Simple example (with no function callback or data associated):
16401     * @code
16402     * li = elm_list_add(win);
16403     * ic = elm_icon_add(win);
16404     * elm_icon_file_set(ic, "path/to/image", NULL);
16405     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16406     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16407     * elm_list_go(li);
16408     * evas_object_show(li);
16409     * @endcode
16410     *
16411     * @see elm_list_always_select_mode_set()
16412     * @see elm_list_item_del()
16413     * @see elm_list_item_del_cb_set()
16414     * @see elm_list_clear()
16415     * @see elm_icon_add()
16416     *
16417     * @ingroup List
16418     */
16419    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);
16420
16421    /**
16422     * Prepend a new item to the list object.
16423     *
16424     * @param obj The list object.
16425     * @param label The label of the list item.
16426     * @param icon The icon object to use for the left side of the item. An
16427     * icon can be any Evas object, but usually it is an icon created
16428     * with elm_icon_add().
16429     * @param end The icon object to use for the right side of the item. An
16430     * icon can be any Evas object.
16431     * @param func The function to call when the item is clicked.
16432     * @param data The data to associate with the item for related callbacks.
16433     *
16434     * @return The created item or @c NULL upon failure.
16435     *
16436     * A new item will be created and prepended to the list, i.e., will
16437     * be set as @b first item.
16438     *
16439     * Items created with this method can be deleted with
16440     * elm_list_item_del().
16441     *
16442     * Associated @p data can be properly freed when item is deleted if a
16443     * callback function is set with elm_list_item_del_cb_set().
16444     *
16445     * If a function is passed as argument, it will be called everytime this item
16446     * is selected, i.e., the user clicks over an unselected item.
16447     * If always select is enabled it will call this function every time
16448     * user clicks over an item (already selected or not).
16449     * If such function isn't needed, just passing
16450     * @c NULL as @p func is enough. The same should be done for @p data.
16451     *
16452     * @see elm_list_item_append() for a simple code example.
16453     * @see elm_list_always_select_mode_set()
16454     * @see elm_list_item_del()
16455     * @see elm_list_item_del_cb_set()
16456     * @see elm_list_clear()
16457     * @see elm_icon_add()
16458     *
16459     * @ingroup List
16460     */
16461    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);
16462
16463    /**
16464     * Insert a new item into the list object before item @p before.
16465     *
16466     * @param obj The list object.
16467     * @param before The list item to insert before.
16468     * @param label The label of the list item.
16469     * @param icon The icon object to use for the left side of the item. An
16470     * icon can be any Evas object, but usually it is an icon created
16471     * with elm_icon_add().
16472     * @param end The icon object to use for the right side of the item. An
16473     * icon can be any Evas object.
16474     * @param func The function to call when the item is clicked.
16475     * @param data The data to associate with the item for related callbacks.
16476     *
16477     * @return The created item or @c NULL upon failure.
16478     *
16479     * A new item will be created and added to the list. Its position in
16480     * this list will be just before item @p before.
16481     *
16482     * Items created with this method can be deleted with
16483     * elm_list_item_del().
16484     *
16485     * Associated @p data can be properly freed when item is deleted if a
16486     * callback function is set with elm_list_item_del_cb_set().
16487     *
16488     * If a function is passed as argument, it will be called everytime this item
16489     * is selected, i.e., the user clicks over an unselected item.
16490     * If always select is enabled it will call this function every time
16491     * user clicks over an item (already selected or not).
16492     * If such function isn't needed, just passing
16493     * @c NULL as @p func is enough. The same should be done for @p data.
16494     *
16495     * @see elm_list_item_append() for a simple code example.
16496     * @see elm_list_always_select_mode_set()
16497     * @see elm_list_item_del()
16498     * @see elm_list_item_del_cb_set()
16499     * @see elm_list_clear()
16500     * @see elm_icon_add()
16501     *
16502     * @ingroup List
16503     */
16504    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);
16505
16506    /**
16507     * Insert a new item into the list object after item @p after.
16508     *
16509     * @param obj The list object.
16510     * @param after The list item to insert after.
16511     * @param label The label of the list item.
16512     * @param icon The icon object to use for the left side of the item. An
16513     * icon can be any Evas object, but usually it is an icon created
16514     * with elm_icon_add().
16515     * @param end The icon object to use for the right side of the item. An
16516     * icon can be any Evas object.
16517     * @param func The function to call when the item is clicked.
16518     * @param data The data to associate with the item for related callbacks.
16519     *
16520     * @return The created item or @c NULL upon failure.
16521     *
16522     * A new item will be created and added to the list. Its position in
16523     * this list will be just after item @p after.
16524     *
16525     * Items created with this method can be deleted with
16526     * elm_list_item_del().
16527     *
16528     * Associated @p data can be properly freed when item is deleted if a
16529     * callback function is set with elm_list_item_del_cb_set().
16530     *
16531     * If a function is passed as argument, it will be called everytime this item
16532     * is selected, i.e., the user clicks over an unselected item.
16533     * If always select is enabled it will call this function every time
16534     * user clicks over an item (already selected or not).
16535     * If such function isn't needed, just passing
16536     * @c NULL as @p func is enough. The same should be done for @p data.
16537     *
16538     * @see elm_list_item_append() for a simple code example.
16539     * @see elm_list_always_select_mode_set()
16540     * @see elm_list_item_del()
16541     * @see elm_list_item_del_cb_set()
16542     * @see elm_list_clear()
16543     * @see elm_icon_add()
16544     *
16545     * @ingroup List
16546     */
16547    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);
16548
16549    /**
16550     * Insert a new item into the sorted list object.
16551     *
16552     * @param obj The list object.
16553     * @param label The label of the list item.
16554     * @param icon The icon object to use for the left side of the item. An
16555     * icon can be any Evas object, but usually it is an icon created
16556     * with elm_icon_add().
16557     * @param end The icon object to use for the right side of the item. An
16558     * icon can be any Evas object.
16559     * @param func The function to call when the item is clicked.
16560     * @param data The data to associate with the item for related callbacks.
16561     * @param cmp_func The comparing function to be used to sort list
16562     * items <b>by #Elm_List_Item item handles</b>. This function will
16563     * receive two items and compare them, returning a non-negative integer
16564     * if the second item should be place after the first, or negative value
16565     * if should be placed before.
16566     *
16567     * @return The created item or @c NULL upon failure.
16568     *
16569     * @note This function inserts values into a list object assuming it was
16570     * sorted and the result will be sorted.
16571     *
16572     * A new item will be created and added to the list. Its position in
16573     * this list will be found comparing the new item with previously inserted
16574     * items using function @p cmp_func.
16575     *
16576     * Items created with this method can be deleted with
16577     * elm_list_item_del().
16578     *
16579     * Associated @p data can be properly freed when item is deleted if a
16580     * callback function is set with elm_list_item_del_cb_set().
16581     *
16582     * If a function is passed as argument, it will be called everytime this item
16583     * is selected, i.e., the user clicks over an unselected item.
16584     * If always select is enabled it will call this function every time
16585     * user clicks over an item (already selected or not).
16586     * If such function isn't needed, just passing
16587     * @c NULL as @p func is enough. The same should be done for @p data.
16588     *
16589     * @see elm_list_item_append() for a simple code example.
16590     * @see elm_list_always_select_mode_set()
16591     * @see elm_list_item_del()
16592     * @see elm_list_item_del_cb_set()
16593     * @see elm_list_clear()
16594     * @see elm_icon_add()
16595     *
16596     * @ingroup List
16597     */
16598    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);
16599
16600    /**
16601     * Remove all list's items.
16602     *
16603     * @param obj The list object
16604     *
16605     * @see elm_list_item_del()
16606     * @see elm_list_item_append()
16607     *
16608     * @ingroup List
16609     */
16610    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16611
16612    /**
16613     * Get a list of all the list items.
16614     *
16615     * @param obj The list object
16616     * @return An @c Eina_List of list items, #Elm_List_Item,
16617     * or @c NULL on failure.
16618     *
16619     * @see elm_list_item_append()
16620     * @see elm_list_item_del()
16621     * @see elm_list_clear()
16622     *
16623     * @ingroup List
16624     */
16625    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16626
16627    /**
16628     * Get the selected item.
16629     *
16630     * @param obj The list object.
16631     * @return The selected list item.
16632     *
16633     * The selected item can be unselected with function
16634     * elm_list_item_selected_set().
16635     *
16636     * The selected item always will be highlighted on list.
16637     *
16638     * @see elm_list_selected_items_get()
16639     *
16640     * @ingroup List
16641     */
16642    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16643
16644    /**
16645     * Return a list of the currently selected list items.
16646     *
16647     * @param obj The list object.
16648     * @return An @c Eina_List of list items, #Elm_List_Item,
16649     * or @c NULL on failure.
16650     *
16651     * Multiple items can be selected if multi select is enabled. It can be
16652     * done with elm_list_multi_select_set().
16653     *
16654     * @see elm_list_selected_item_get()
16655     * @see elm_list_multi_select_set()
16656     *
16657     * @ingroup List
16658     */
16659    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16660
16661    /**
16662     * Set the selected state of an item.
16663     *
16664     * @param item The list item
16665     * @param selected The selected state
16666     *
16667     * This sets the selected state of the given item @p it.
16668     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16669     *
16670     * If a new item is selected the previosly selected will be unselected,
16671     * unless multiple selection is enabled with elm_list_multi_select_set().
16672     * Previoulsy selected item can be get with function
16673     * elm_list_selected_item_get().
16674     *
16675     * Selected items will be highlighted.
16676     *
16677     * @see elm_list_item_selected_get()
16678     * @see elm_list_selected_item_get()
16679     * @see elm_list_multi_select_set()
16680     *
16681     * @ingroup List
16682     */
16683    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16684
16685    /*
16686     * Get whether the @p item is selected or not.
16687     *
16688     * @param item The list item.
16689     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16690     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16691     *
16692     * @see elm_list_selected_item_set() for details.
16693     * @see elm_list_item_selected_get()
16694     *
16695     * @ingroup List
16696     */
16697    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16698
16699    /**
16700     * Set or unset item as a separator.
16701     *
16702     * @param it The list item.
16703     * @param setting @c EINA_TRUE to set item @p it as separator or
16704     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16705     *
16706     * Items aren't set as separator by default.
16707     *
16708     * If set as separator it will display separator theme, so won't display
16709     * icons or label.
16710     *
16711     * @see elm_list_item_separator_get()
16712     *
16713     * @ingroup List
16714     */
16715    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16716
16717    /**
16718     * Get a value whether item is a separator or not.
16719     *
16720     * @see elm_list_item_separator_set() for details.
16721     *
16722     * @param it The list item.
16723     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16724     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16725     *
16726     * @ingroup List
16727     */
16728    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16729
16730    /**
16731     * Show @p item in the list view.
16732     *
16733     * @param item The list item to be shown.
16734     *
16735     * It won't animate list until item is visible. If such behavior is wanted,
16736     * use elm_list_bring_in() intead.
16737     *
16738     * @ingroup List
16739     */
16740    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16741
16742    /**
16743     * Bring in the given item to list view.
16744     *
16745     * @param item The item.
16746     *
16747     * This causes list to jump to the given item @p item and show it
16748     * (by scrolling), if it is not fully visible.
16749     *
16750     * This may use animation to do so and take a period of time.
16751     *
16752     * If animation isn't wanted, elm_list_item_show() can be used.
16753     *
16754     * @ingroup List
16755     */
16756    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16757
16758    /**
16759     * Delete them item from the list.
16760     *
16761     * @param item The item of list to be deleted.
16762     *
16763     * If deleting all list items is required, elm_list_clear()
16764     * should be used instead of getting items list and deleting each one.
16765     *
16766     * @see elm_list_clear()
16767     * @see elm_list_item_append()
16768     * @see elm_list_item_del_cb_set()
16769     *
16770     * @ingroup List
16771     */
16772    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16773
16774    /**
16775     * Set the function called when a list item is freed.
16776     *
16777     * @param item The item to set the callback on
16778     * @param func The function called
16779     *
16780     * If there is a @p func, then it will be called prior item's memory release.
16781     * That will be called with the following arguments:
16782     * @li item's data;
16783     * @li item's Evas object;
16784     * @li item itself;
16785     *
16786     * This way, a data associated to a list item could be properly freed.
16787     *
16788     * @ingroup List
16789     */
16790    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16791
16792    /**
16793     * Get the data associated to the item.
16794     *
16795     * @param item The list item
16796     * @return The data associated to @p item
16797     *
16798     * The return value is a pointer to data associated to @p item when it was
16799     * created, with function elm_list_item_append() or similar. If no data
16800     * was passed as argument, it will return @c NULL.
16801     *
16802     * @see elm_list_item_append()
16803     *
16804     * @ingroup List
16805     */
16806    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16807
16808    /**
16809     * Get the left side icon associated to the item.
16810     *
16811     * @param item The list item
16812     * @return The left side icon associated to @p item
16813     *
16814     * The return value is a pointer to the icon associated to @p item when
16815     * it was
16816     * created, with function elm_list_item_append() or similar, or later
16817     * with function elm_list_item_icon_set(). If no icon
16818     * was passed as argument, it will return @c NULL.
16819     *
16820     * @see elm_list_item_append()
16821     * @see elm_list_item_icon_set()
16822     *
16823     * @ingroup List
16824     */
16825    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16826
16827    /**
16828     * Set the left side icon associated to the item.
16829     *
16830     * @param item The list item
16831     * @param icon The left side icon object to associate with @p item
16832     *
16833     * The icon object to use at left side of the item. An
16834     * icon can be any Evas object, but usually it is an icon created
16835     * with elm_icon_add().
16836     *
16837     * Once the icon object is set, a previously set one will be deleted.
16838     * @warning Setting the same icon for two items will cause the icon to
16839     * dissapear from the first item.
16840     *
16841     * If an icon was passed as argument on item creation, with function
16842     * elm_list_item_append() or similar, it will be already
16843     * associated to the item.
16844     *
16845     * @see elm_list_item_append()
16846     * @see elm_list_item_icon_get()
16847     *
16848     * @ingroup List
16849     */
16850    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16851
16852    /**
16853     * Get the right side icon associated to the item.
16854     *
16855     * @param item The list item
16856     * @return The right side icon associated to @p item
16857     *
16858     * The return value is a pointer to the icon associated to @p item when
16859     * it was
16860     * created, with function elm_list_item_append() or similar, or later
16861     * with function elm_list_item_icon_set(). If no icon
16862     * was passed as argument, it will return @c NULL.
16863     *
16864     * @see elm_list_item_append()
16865     * @see elm_list_item_icon_set()
16866     *
16867     * @ingroup List
16868     */
16869    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16870
16871    /**
16872     * Set the right side icon associated to the item.
16873     *
16874     * @param item The list item
16875     * @param end The right side icon object to associate with @p item
16876     *
16877     * The icon object to use at right side of the item. An
16878     * icon can be any Evas object, but usually it is an icon created
16879     * with elm_icon_add().
16880     *
16881     * Once the icon object is set, a previously set one will be deleted.
16882     * @warning Setting the same icon for two items will cause the icon to
16883     * dissapear from the first item.
16884     *
16885     * If an icon was passed as argument on item creation, with function
16886     * elm_list_item_append() or similar, it will be already
16887     * associated to the item.
16888     *
16889     * @see elm_list_item_append()
16890     * @see elm_list_item_end_get()
16891     *
16892     * @ingroup List
16893     */
16894    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16895    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16896
16897    /**
16898     * Gets the base object of the item.
16899     *
16900     * @param item The list item
16901     * @return The base object associated with @p item
16902     *
16903     * Base object is the @c Evas_Object that represents that item.
16904     *
16905     * @ingroup List
16906     */
16907    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16908
16909    /**
16910     * Get the label of item.
16911     *
16912     * @param item The item of list.
16913     * @return The label of item.
16914     *
16915     * The return value is a pointer to the label associated to @p item when
16916     * it was created, with function elm_list_item_append(), or later
16917     * with function elm_list_item_label_set. If no label
16918     * was passed as argument, it will return @c NULL.
16919     *
16920     * @see elm_list_item_label_set() for more details.
16921     * @see elm_list_item_append()
16922     *
16923     * @ingroup List
16924     */
16925    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16926
16927    /**
16928     * Set the label of item.
16929     *
16930     * @param item The item of list.
16931     * @param text The label of item.
16932     *
16933     * The label to be displayed by the item.
16934     * Label will be placed between left and right side icons (if set).
16935     *
16936     * If a label was passed as argument on item creation, with function
16937     * elm_list_item_append() or similar, it will be already
16938     * displayed by the item.
16939     *
16940     * @see elm_list_item_label_get()
16941     * @see elm_list_item_append()
16942     *
16943     * @ingroup List
16944     */
16945    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16946
16947
16948    /**
16949     * Get the item before @p it in list.
16950     *
16951     * @param it The list item.
16952     * @return The item before @p it, or @c NULL if none or on failure.
16953     *
16954     * @note If it is the first item, @c NULL will be returned.
16955     *
16956     * @see elm_list_item_append()
16957     * @see elm_list_items_get()
16958     *
16959     * @ingroup List
16960     */
16961    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16962
16963    /**
16964     * Get the item after @p it in list.
16965     *
16966     * @param it The list item.
16967     * @return The item after @p it, or @c NULL if none or on failure.
16968     *
16969     * @note If it is the last item, @c NULL will be returned.
16970     *
16971     * @see elm_list_item_append()
16972     * @see elm_list_items_get()
16973     *
16974     * @ingroup List
16975     */
16976    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16977
16978    /**
16979     * Sets the disabled/enabled state of a list item.
16980     *
16981     * @param it The item.
16982     * @param disabled The disabled state.
16983     *
16984     * A disabled item cannot be selected or unselected. It will also
16985     * change its appearance (generally greyed out). This sets the
16986     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16987     * enabled).
16988     *
16989     * @ingroup List
16990     */
16991    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16992
16993    /**
16994     * Get a value whether list item is disabled or not.
16995     *
16996     * @param it The item.
16997     * @return The disabled state.
16998     *
16999     * @see elm_list_item_disabled_set() for more details.
17000     *
17001     * @ingroup List
17002     */
17003    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17004
17005    /**
17006     * Set the text to be shown in a given list item's tooltips.
17007     *
17008     * @param item Target item.
17009     * @param text The text to set in the content.
17010     *
17011     * Setup the text as tooltip to object. The item can have only one tooltip,
17012     * so any previous tooltip data - set with this function or
17013     * elm_list_item_tooltip_content_cb_set() - is removed.
17014     *
17015     * @see elm_object_tooltip_text_set() for more details.
17016     *
17017     * @ingroup List
17018     */
17019    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17020
17021
17022    /**
17023     * @brief Disable size restrictions on an object's tooltip
17024     * @param item The tooltip's anchor object
17025     * @param disable If EINA_TRUE, size restrictions are disabled
17026     * @return EINA_FALSE on failure, EINA_TRUE on success
17027     *
17028     * This function allows a tooltip to expand beyond its parant window's canvas.
17029     * It will instead be limited only by the size of the display.
17030     */
17031    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17032    /**
17033     * @brief Retrieve size restriction state of an object's tooltip
17034     * @param obj The tooltip's anchor object
17035     * @return If EINA_TRUE, size restrictions are disabled
17036     *
17037     * This function returns whether a tooltip is allowed to expand beyond
17038     * its parant window's canvas.
17039     * It will instead be limited only by the size of the display.
17040     */
17041    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17042
17043    /**
17044     * Set the content to be shown in the tooltip item.
17045     *
17046     * Setup the tooltip to item. The item can have only one tooltip,
17047     * so any previous tooltip data is removed. @p func(with @p data) will
17048     * be called every time that need show the tooltip and it should
17049     * return a valid Evas_Object. This object is then managed fully by
17050     * tooltip system and is deleted when the tooltip is gone.
17051     *
17052     * @param item the list item being attached a tooltip.
17053     * @param func the function used to create the tooltip contents.
17054     * @param data what to provide to @a func as callback data/context.
17055     * @param del_cb called when data is not needed anymore, either when
17056     *        another callback replaces @a func, the tooltip is unset with
17057     *        elm_list_item_tooltip_unset() or the owner @a item
17058     *        dies. This callback receives as the first parameter the
17059     *        given @a data, and @c event_info is the item.
17060     *
17061     * @see elm_object_tooltip_content_cb_set() for more details.
17062     *
17063     * @ingroup List
17064     */
17065    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);
17066
17067    /**
17068     * Unset tooltip from item.
17069     *
17070     * @param item list item to remove previously set tooltip.
17071     *
17072     * Remove tooltip from item. The callback provided as del_cb to
17073     * elm_list_item_tooltip_content_cb_set() will be called to notify
17074     * it is not used anymore.
17075     *
17076     * @see elm_object_tooltip_unset() for more details.
17077     * @see elm_list_item_tooltip_content_cb_set()
17078     *
17079     * @ingroup List
17080     */
17081    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17082
17083    /**
17084     * Sets a different style for this item tooltip.
17085     *
17086     * @note before you set a style you should define a tooltip with
17087     *       elm_list_item_tooltip_content_cb_set() or
17088     *       elm_list_item_tooltip_text_set()
17089     *
17090     * @param item list item with tooltip already set.
17091     * @param style the theme style to use (default, transparent, ...)
17092     *
17093     * @see elm_object_tooltip_style_set() for more details.
17094     *
17095     * @ingroup List
17096     */
17097    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17098
17099    /**
17100     * Get the style for this item tooltip.
17101     *
17102     * @param item list item with tooltip already set.
17103     * @return style the theme style in use, defaults to "default". If the
17104     *         object does not have a tooltip set, then NULL is returned.
17105     *
17106     * @see elm_object_tooltip_style_get() for more details.
17107     * @see elm_list_item_tooltip_style_set()
17108     *
17109     * @ingroup List
17110     */
17111    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17112
17113    /**
17114     * Set the type of mouse pointer/cursor decoration to be shown,
17115     * when the mouse pointer is over the given list widget item
17116     *
17117     * @param item list item to customize cursor on
17118     * @param cursor the cursor type's name
17119     *
17120     * This function works analogously as elm_object_cursor_set(), but
17121     * here the cursor's changing area is restricted to the item's
17122     * area, and not the whole widget's. Note that that item cursors
17123     * have precedence over widget cursors, so that a mouse over an
17124     * item with custom cursor set will always show @b that cursor.
17125     *
17126     * If this function is called twice for an object, a previously set
17127     * cursor will be unset on the second call.
17128     *
17129     * @see elm_object_cursor_set()
17130     * @see elm_list_item_cursor_get()
17131     * @see elm_list_item_cursor_unset()
17132     *
17133     * @ingroup List
17134     */
17135    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17136
17137    /*
17138     * Get the type of mouse pointer/cursor decoration set to be shown,
17139     * when the mouse pointer is over the given list widget item
17140     *
17141     * @param item list item with custom cursor set
17142     * @return the cursor type's name or @c NULL, if no custom cursors
17143     * were set to @p item (and on errors)
17144     *
17145     * @see elm_object_cursor_get()
17146     * @see elm_list_item_cursor_set()
17147     * @see elm_list_item_cursor_unset()
17148     *
17149     * @ingroup List
17150     */
17151    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17152
17153    /**
17154     * Unset any custom mouse pointer/cursor decoration set to be
17155     * shown, when the mouse pointer is over the given list widget
17156     * item, thus making it show the @b default cursor again.
17157     *
17158     * @param item a list item
17159     *
17160     * Use this call to undo any custom settings on this item's cursor
17161     * decoration, bringing it back to defaults (no custom style set).
17162     *
17163     * @see elm_object_cursor_unset()
17164     * @see elm_list_item_cursor_set()
17165     *
17166     * @ingroup List
17167     */
17168    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17169
17170    /**
17171     * Set a different @b style for a given custom cursor set for a
17172     * list item.
17173     *
17174     * @param item list item with custom cursor set
17175     * @param style the <b>theme style</b> to use (e.g. @c "default",
17176     * @c "transparent", etc)
17177     *
17178     * This function only makes sense when one is using custom mouse
17179     * cursor decorations <b>defined in a theme file</b>, which can have,
17180     * given a cursor name/type, <b>alternate styles</b> on it. It
17181     * works analogously as elm_object_cursor_style_set(), but here
17182     * applyed only to list item objects.
17183     *
17184     * @warning Before you set a cursor style you should have definen a
17185     *       custom cursor previously on the item, with
17186     *       elm_list_item_cursor_set()
17187     *
17188     * @see elm_list_item_cursor_engine_only_set()
17189     * @see elm_list_item_cursor_style_get()
17190     *
17191     * @ingroup List
17192     */
17193    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17194
17195    /**
17196     * Get the current @b style set for a given list item's custom
17197     * cursor
17198     *
17199     * @param item list item with custom cursor set.
17200     * @return style the cursor style in use. If the object does not
17201     *         have a cursor set, then @c NULL is returned.
17202     *
17203     * @see elm_list_item_cursor_style_set() for more details
17204     *
17205     * @ingroup List
17206     */
17207    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17208
17209    /**
17210     * Set if the (custom)cursor for a given list item should be
17211     * searched in its theme, also, or should only rely on the
17212     * rendering engine.
17213     *
17214     * @param item item with custom (custom) cursor already set on
17215     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17216     * only on those provided by the rendering engine, @c EINA_FALSE to
17217     * have them searched on the widget's theme, as well.
17218     *
17219     * @note This call is of use only if you've set a custom cursor
17220     * for list items, with elm_list_item_cursor_set().
17221     *
17222     * @note By default, cursors will only be looked for between those
17223     * provided by the rendering engine.
17224     *
17225     * @ingroup List
17226     */
17227    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17228
17229    /**
17230     * Get if the (custom) cursor for a given list item is being
17231     * searched in its theme, also, or is only relying on the rendering
17232     * engine.
17233     *
17234     * @param item a list item
17235     * @return @c EINA_TRUE, if cursors are being looked for only on
17236     * those provided by the rendering engine, @c EINA_FALSE if they
17237     * are being searched on the widget's theme, as well.
17238     *
17239     * @see elm_list_item_cursor_engine_only_set(), for more details
17240     *
17241     * @ingroup List
17242     */
17243    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17244
17245    /**
17246     * @}
17247     */
17248
17249    /**
17250     * @defgroup Slider Slider
17251     * @ingroup Elementary
17252     *
17253     * @image html img/widget/slider/preview-00.png
17254     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17255     *
17256     * The slider adds a dragable “slider” widget for selecting the value of
17257     * something within a range.
17258     *
17259     * A slider can be horizontal or vertical. It can contain an Icon and has a
17260     * primary label as well as a units label (that is formatted with floating
17261     * point values and thus accepts a printf-style format string, like
17262     * “%1.2f units”. There is also an indicator string that may be somewhere
17263     * else (like on the slider itself) that also accepts a format string like
17264     * units. Label, Icon Unit and Indicator strings/objects are optional.
17265     *
17266     * A slider may be inverted which means values invert, with high vales being
17267     * on the left or top and low values on the right or bottom (as opposed to
17268     * normally being low on the left or top and high on the bottom and right).
17269     *
17270     * The slider should have its minimum and maximum values set by the
17271     * application with  elm_slider_min_max_set() and value should also be set by
17272     * the application before use with  elm_slider_value_set(). The span of the
17273     * slider is its length (horizontally or vertically). This will be scaled by
17274     * the object or applications scaling factor. At any point code can query the
17275     * slider for its value with elm_slider_value_get().
17276     *
17277     * Smart callbacks one can listen to:
17278     * - "changed" - Whenever the slider value is changed by the user.
17279     * - "slider,drag,start" - dragging the slider indicator around has started.
17280     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17281     * - "delay,changed" - A short time after the value is changed by the user.
17282     * This will be called only when the user stops dragging for
17283     * a very short period or when they release their
17284     * finger/mouse, so it avoids possibly expensive reactions to
17285     * the value change.
17286     *
17287     * Available styles for it:
17288     * - @c "default"
17289     *
17290     * Default contents parts of the slider widget that you can use for are:
17291     * @li "icon" - A icon of the slider
17292     * @li "end" - A end part content of the slider
17293     * 
17294     * Default text parts of the silder widget that you can use for are:
17295     * @li "default" - Label of the silder
17296     * Here is an example on its usage:
17297     * @li @ref slider_example
17298     */
17299
17300    /**
17301     * @addtogroup Slider
17302     * @{
17303     */
17304
17305    /**
17306     * Add a new slider widget to the given parent Elementary
17307     * (container) object.
17308     *
17309     * @param parent The parent object.
17310     * @return a new slider widget handle or @c NULL, on errors.
17311     *
17312     * This function inserts a new slider widget on the canvas.
17313     *
17314     * @ingroup Slider
17315     */
17316    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17317
17318    /**
17319     * Set the label of a given slider widget
17320     *
17321     * @param obj The progress bar object
17322     * @param label The text label string, in UTF-8
17323     *
17324     * @ingroup Slider
17325     * @deprecated use elm_object_text_set() instead.
17326     */
17327    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17328
17329    /**
17330     * Get the label of a given slider widget
17331     *
17332     * @param obj The progressbar object
17333     * @return The text label string, in UTF-8
17334     *
17335     * @ingroup Slider
17336     * @deprecated use elm_object_text_get() instead.
17337     */
17338    EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17339
17340    /**
17341     * Set the icon object of the slider object.
17342     *
17343     * @param obj The slider object.
17344     * @param icon The icon object.
17345     *
17346     * On horizontal mode, icon is placed at left, and on vertical mode,
17347     * placed at top.
17348     *
17349     * @note Once the icon object is set, a previously set one will be deleted.
17350     * If you want to keep that old content object, use the
17351     * elm_slider_icon_unset() function.
17352     *
17353     * @warning If the object being set does not have minimum size hints set,
17354     * it won't get properly displayed.
17355     *
17356     * @ingroup Slider
17357     * @deprecated use elm_object_part_content_set() instead.
17358     */
17359    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17360
17361    /**
17362     * Unset an icon set on a given slider widget.
17363     *
17364     * @param obj The slider object.
17365     * @return The icon object that was being used, if any was set, or
17366     * @c NULL, otherwise (and on errors).
17367     *
17368     * On horizontal mode, icon is placed at left, and on vertical mode,
17369     * placed at top.
17370     *
17371     * This call will unparent and return the icon object which was set
17372     * for this widget, previously, on success.
17373     *
17374     * @see elm_slider_icon_set() for more details
17375     * @see elm_slider_icon_get()
17376     * @deprecated use elm_object_part_content_unset() instead.
17377     *
17378     * @ingroup Slider
17379     */
17380    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17381
17382    /**
17383     * Retrieve the icon object set for a given slider widget.
17384     *
17385     * @param obj The slider object.
17386     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17387     * otherwise (and on errors).
17388     *
17389     * On horizontal mode, icon is placed at left, and on vertical mode,
17390     * placed at top.
17391     *
17392     * @see elm_slider_icon_set() for more details
17393     * @see elm_slider_icon_unset()
17394     *
17395     * @deprecated use elm_object_part_content_get() instead.
17396     *
17397     * @ingroup Slider
17398     */
17399    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17400
17401    /**
17402     * Set the end object of the slider object.
17403     *
17404     * @param obj The slider object.
17405     * @param end The end object.
17406     *
17407     * On horizontal mode, end is placed at left, and on vertical mode,
17408     * placed at bottom.
17409     *
17410     * @note Once the icon object is set, a previously set one will be deleted.
17411     * If you want to keep that old content object, use the
17412     * elm_slider_end_unset() function.
17413     *
17414     * @warning If the object being set does not have minimum size hints set,
17415     * it won't get properly displayed.
17416     *
17417     * @deprecated use elm_object_part_content_set() instead.
17418     *
17419     * @ingroup Slider
17420     */
17421    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17422
17423    /**
17424     * Unset an end object set on a given slider widget.
17425     *
17426     * @param obj The slider object.
17427     * @return The end object that was being used, if any was set, or
17428     * @c NULL, otherwise (and on errors).
17429     *
17430     * On horizontal mode, end is placed at left, and on vertical mode,
17431     * placed at bottom.
17432     *
17433     * This call will unparent and return the icon object which was set
17434     * for this widget, previously, on success.
17435     *
17436     * @see elm_slider_end_set() for more details.
17437     * @see elm_slider_end_get()
17438     *
17439     * @deprecated use elm_object_part_content_unset() instead
17440     * instead.
17441     *
17442     * @ingroup Slider
17443     */
17444    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17445
17446    /**
17447     * Retrieve the end object set for a given slider widget.
17448     *
17449     * @param obj The slider object.
17450     * @return The end object's handle, if @p obj had one set, or @c NULL,
17451     * otherwise (and on errors).
17452     *
17453     * On horizontal mode, icon is placed at right, and on vertical mode,
17454     * placed at bottom.
17455     *
17456     * @see elm_slider_end_set() for more details.
17457     * @see elm_slider_end_unset()
17458     *
17459     *
17460     * @deprecated use elm_object_part_content_get() instead 
17461     * instead.
17462     *
17463     * @ingroup Slider
17464     */
17465    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17466
17467    /**
17468     * Set the (exact) length of the bar region of a given slider widget.
17469     *
17470     * @param obj The slider object.
17471     * @param size The length of the slider's bar region.
17472     *
17473     * This sets the minimum width (when in horizontal mode) or height
17474     * (when in vertical mode) of the actual bar area of the slider
17475     * @p obj. This in turn affects the object's minimum size. Use
17476     * this when you're not setting other size hints expanding on the
17477     * given direction (like weight and alignment hints) and you would
17478     * like it to have a specific size.
17479     *
17480     * @note Icon, end, label, indicator and unit text around @p obj
17481     * will require their
17482     * own space, which will make @p obj to require more the @p size,
17483     * actually.
17484     *
17485     * @see elm_slider_span_size_get()
17486     *
17487     * @ingroup Slider
17488     */
17489    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17490
17491    /**
17492     * Get the length set for the bar region of a given slider widget
17493     *
17494     * @param obj The slider object.
17495     * @return The length of the slider's bar region.
17496     *
17497     * If that size was not set previously, with
17498     * elm_slider_span_size_set(), this call will return @c 0.
17499     *
17500     * @ingroup Slider
17501     */
17502    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17503
17504    /**
17505     * Set the format string for the unit label.
17506     *
17507     * @param obj The slider object.
17508     * @param format The format string for the unit display.
17509     *
17510     * Unit label is displayed all the time, if set, after slider's bar.
17511     * In horizontal mode, at right and in vertical mode, at bottom.
17512     *
17513     * If @c NULL, unit label won't be visible. If not it sets the format
17514     * string for the label text. To the label text is provided a floating point
17515     * value, so the label text can display up to 1 floating point value.
17516     * Note that this is optional.
17517     *
17518     * Use a format string such as "%1.2f meters" for example, and it will
17519     * display values like: "3.14 meters" for a value equal to 3.14159.
17520     *
17521     * Default is unit label disabled.
17522     *
17523     * @see elm_slider_indicator_format_get()
17524     *
17525     * @ingroup Slider
17526     */
17527    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17528
17529    /**
17530     * Get the unit label format of the slider.
17531     *
17532     * @param obj The slider object.
17533     * @return The unit label format string in UTF-8.
17534     *
17535     * Unit label is displayed all the time, if set, after slider's bar.
17536     * In horizontal mode, at right and in vertical mode, at bottom.
17537     *
17538     * @see elm_slider_unit_format_set() for more
17539     * information on how this works.
17540     *
17541     * @ingroup Slider
17542     */
17543    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17544
17545    /**
17546     * Set the format string for the indicator label.
17547     *
17548     * @param obj The slider object.
17549     * @param indicator The format string for the indicator display.
17550     *
17551     * The slider may display its value somewhere else then unit label,
17552     * for example, above the slider knob that is dragged around. This function
17553     * sets the format string used for this.
17554     *
17555     * If @c NULL, indicator label won't be visible. If not it sets the format
17556     * string for the label text. To the label text is provided a floating point
17557     * value, so the label text can display up to 1 floating point value.
17558     * Note that this is optional.
17559     *
17560     * Use a format string such as "%1.2f meters" for example, and it will
17561     * display values like: "3.14 meters" for a value equal to 3.14159.
17562     *
17563     * Default is indicator label disabled.
17564     *
17565     * @see elm_slider_indicator_format_get()
17566     *
17567     * @ingroup Slider
17568     */
17569    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17570
17571    /**
17572     * Get the indicator label format of the slider.
17573     *
17574     * @param obj The slider object.
17575     * @return The indicator label format string in UTF-8.
17576     *
17577     * The slider may display its value somewhere else then unit label,
17578     * for example, above the slider knob that is dragged around. This function
17579     * gets the format string used for this.
17580     *
17581     * @see elm_slider_indicator_format_set() for more
17582     * information on how this works.
17583     *
17584     * @ingroup Slider
17585     */
17586    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17587
17588    /**
17589     * Set the format function pointer for the indicator label
17590     *
17591     * @param obj The slider object.
17592     * @param func The indicator format function.
17593     * @param free_func The freeing function for the format string.
17594     *
17595     * Set the callback function to format the indicator string.
17596     *
17597     * @see elm_slider_indicator_format_set() for more info on how this works.
17598     *
17599     * @ingroup Slider
17600     */
17601   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);
17602
17603   /**
17604    * Set the format function pointer for the units label
17605    *
17606    * @param obj The slider object.
17607    * @param func The units format function.
17608    * @param free_func The freeing function for the format string.
17609    *
17610    * Set the callback function to format the indicator string.
17611    *
17612    * @see elm_slider_units_format_set() for more info on how this works.
17613    *
17614    * @ingroup Slider
17615    */
17616   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);
17617
17618   /**
17619    * Set the orientation of a given slider widget.
17620    *
17621    * @param obj The slider object.
17622    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17623    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17624    *
17625    * Use this function to change how your slider is to be
17626    * disposed: vertically or horizontally.
17627    *
17628    * By default it's displayed horizontally.
17629    *
17630    * @see elm_slider_horizontal_get()
17631    *
17632    * @ingroup Slider
17633    */
17634    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17635
17636    /**
17637     * Retrieve the orientation of a given slider widget
17638     *
17639     * @param obj The slider object.
17640     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17641     * @c EINA_FALSE if it's @b vertical (and on errors).
17642     *
17643     * @see elm_slider_horizontal_set() for more details.
17644     *
17645     * @ingroup Slider
17646     */
17647    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17648
17649    /**
17650     * Set the minimum and maximum values for the slider.
17651     *
17652     * @param obj The slider object.
17653     * @param min The minimum value.
17654     * @param max The maximum value.
17655     *
17656     * Define the allowed range of values to be selected by the user.
17657     *
17658     * If actual value is less than @p min, it will be updated to @p min. If it
17659     * is bigger then @p max, will be updated to @p max. Actual value can be
17660     * get with elm_slider_value_get().
17661     *
17662     * By default, min is equal to 0.0, and max is equal to 1.0.
17663     *
17664     * @warning Maximum must be greater than minimum, otherwise behavior
17665     * is undefined.
17666     *
17667     * @see elm_slider_min_max_get()
17668     *
17669     * @ingroup Slider
17670     */
17671    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17672
17673    /**
17674     * Get the minimum and maximum values of the slider.
17675     *
17676     * @param obj The slider object.
17677     * @param min Pointer where to store the minimum value.
17678     * @param max Pointer where to store the maximum value.
17679     *
17680     * @note If only one value is needed, the other pointer can be passed
17681     * as @c NULL.
17682     *
17683     * @see elm_slider_min_max_set() for details.
17684     *
17685     * @ingroup Slider
17686     */
17687    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17688
17689    /**
17690     * Set the value the slider displays.
17691     *
17692     * @param obj The slider object.
17693     * @param val The value to be displayed.
17694     *
17695     * Value will be presented on the unit label following format specified with
17696     * elm_slider_unit_format_set() and on indicator with
17697     * elm_slider_indicator_format_set().
17698     *
17699     * @warning The value must to be between min and max values. This values
17700     * are set by elm_slider_min_max_set().
17701     *
17702     * @see elm_slider_value_get()
17703     * @see elm_slider_unit_format_set()
17704     * @see elm_slider_indicator_format_set()
17705     * @see elm_slider_min_max_set()
17706     *
17707     * @ingroup Slider
17708     */
17709    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17710
17711    /**
17712     * Get the value displayed by the spinner.
17713     *
17714     * @param obj The spinner object.
17715     * @return The value displayed.
17716     *
17717     * @see elm_spinner_value_set() for details.
17718     *
17719     * @ingroup Slider
17720     */
17721    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17722
17723    /**
17724     * Invert a given slider widget's displaying values order
17725     *
17726     * @param obj The slider object.
17727     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17728     * @c EINA_FALSE to bring it back to default, non-inverted values.
17729     *
17730     * A slider may be @b inverted, in which state it gets its
17731     * values inverted, with high vales being on the left or top and
17732     * low values on the right or bottom, as opposed to normally have
17733     * the low values on the former and high values on the latter,
17734     * respectively, for horizontal and vertical modes.
17735     *
17736     * @see elm_slider_inverted_get()
17737     *
17738     * @ingroup Slider
17739     */
17740    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17741
17742    /**
17743     * Get whether a given slider widget's displaying values are
17744     * inverted or not.
17745     *
17746     * @param obj The slider object.
17747     * @return @c EINA_TRUE, if @p obj has inverted values,
17748     * @c EINA_FALSE otherwise (and on errors).
17749     *
17750     * @see elm_slider_inverted_set() for more details.
17751     *
17752     * @ingroup Slider
17753     */
17754    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17755
17756    /**
17757     * Set whether to enlarge slider indicator (augmented knob) or not.
17758     *
17759     * @param obj The slider object.
17760     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17761     * let the knob always at default size.
17762     *
17763     * By default, indicator will be bigger while dragged by the user.
17764     *
17765     * @warning It won't display values set with
17766     * elm_slider_indicator_format_set() if you disable indicator.
17767     *
17768     * @ingroup Slider
17769     */
17770    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17771
17772    /**
17773     * Get whether a given slider widget's enlarging indicator or not.
17774     *
17775     * @param obj The slider object.
17776     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17777     * @c EINA_FALSE otherwise (and on errors).
17778     *
17779     * @see elm_slider_indicator_show_set() for details.
17780     *
17781     * @ingroup Slider
17782     */
17783    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17784
17785    /**
17786     * @}
17787     */
17788
17789    /**
17790     * @addtogroup Actionslider Actionslider
17791     *
17792     * @image html img/widget/actionslider/preview-00.png
17793     * @image latex img/widget/actionslider/preview-00.eps
17794     *
17795     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17796     * properties. The user drags and releases the indicator, to choose a label.
17797     *
17798     * Labels occupy the following positions.
17799     * a. Left
17800     * b. Right
17801     * c. Center
17802     *
17803     * Positions can be enabled or disabled.
17804     *
17805     * Magnets can be set on the above positions.
17806     *
17807     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17808     *
17809     * @note By default all positions are set as enabled.
17810     *
17811     * Signals that you can add callbacks for are:
17812     *
17813     * "selected" - when user selects an enabled position (the label is passed
17814     *              as event info)".
17815     * @n
17816     * "pos_changed" - when the indicator reaches any of the positions("left",
17817     *                 "right" or "center").
17818     *
17819     * See an example of actionslider usage @ref actionslider_example_page "here"
17820     * @{
17821     */
17822
17823    typedef enum _Elm_Actionslider_Indicator_Pos
17824      {
17825         ELM_ACTIONSLIDER_INDICATOR_NONE,
17826         ELM_ACTIONSLIDER_INDICATOR_LEFT,
17827         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17828         ELM_ACTIONSLIDER_INDICATOR_CENTER
17829      } Elm_Actionslider_Indicator_Pos;
17830
17831    typedef enum _Elm_Actionslider_Magnet_Pos
17832      {
17833         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17834         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17835         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17836         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17837         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17838         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17839      } Elm_Actionslider_Magnet_Pos;
17840
17841    typedef enum _Elm_Actionslider_Label_Pos
17842      {
17843         ELM_ACTIONSLIDER_LABEL_LEFT,
17844         ELM_ACTIONSLIDER_LABEL_RIGHT,
17845         ELM_ACTIONSLIDER_LABEL_CENTER,
17846         ELM_ACTIONSLIDER_LABEL_BUTTON
17847      } Elm_Actionslider_Label_Pos;
17848
17849    /* smart callbacks called:
17850     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17851     */
17852
17853    /**
17854     * Add a new actionslider to the parent.
17855     *
17856     * @param parent The parent object
17857     * @return The new actionslider object or NULL if it cannot be created
17858     */
17859    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17860
17861    /**
17862    * Set actionslider label.
17863    *
17864    * @param[in] obj The actionslider object
17865    * @param[in] pos The position of the label.
17866    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17867    * @param label The label which is going to be set.
17868    */
17869    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17870    /**
17871     * Get actionslider labels.
17872     *
17873     * @param obj The actionslider object
17874     * @param left_label A char** to place the left_label of @p obj into.
17875     * @param center_label A char** to place the center_label of @p obj into.
17876     * @param right_label A char** to place the right_label of @p obj into.
17877     */
17878    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);
17879    /**
17880     * Get actionslider selected label.
17881     *
17882     * @param obj The actionslider object
17883     * @return The selected label
17884     */
17885    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17886    /**
17887     * Set actionslider indicator position.
17888     *
17889     * @param obj The actionslider object.
17890     * @param pos The position of the indicator.
17891     */
17892    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17893    /**
17894     * Get actionslider indicator position.
17895     *
17896     * @param obj The actionslider object.
17897     * @return The position of the indicator.
17898     */
17899    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17900    /**
17901     * Set actionslider magnet position. To make multiple positions magnets @c or
17902     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17903     *
17904     * @param obj The actionslider object.
17905     * @param pos Bit mask indicating the magnet positions.
17906     */
17907    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17908    /**
17909     * Get actionslider magnet position.
17910     *
17911     * @param obj The actionslider object.
17912     * @return The positions with magnet property.
17913     */
17914    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17915    /**
17916     * Set actionslider enabled position. To set multiple positions as enabled @c or
17917     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17918     *
17919     * @note All the positions are enabled by default.
17920     *
17921     * @param obj The actionslider object.
17922     * @param pos Bit mask indicating the enabled positions.
17923     */
17924    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17925    /**
17926     * Get actionslider enabled position.
17927     *
17928     * @param obj The actionslider object.
17929     * @return The enabled positions.
17930     */
17931    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17932    /**
17933     * Set the label used on the indicator.
17934     *
17935     * @param obj The actionslider object
17936     * @param label The label to be set on the indicator.
17937     * @deprecated use elm_object_text_set() instead.
17938     */
17939    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17940    /**
17941     * Get the label used on the indicator object.
17942     *
17943     * @param obj The actionslider object
17944     * @return The indicator label
17945     * @deprecated use elm_object_text_get() instead.
17946     */
17947    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17948    /**
17949     * @}
17950     */
17951
17952    /**
17953     * @defgroup Genlist Genlist
17954     *
17955     * @image html img/widget/genlist/preview-00.png
17956     * @image latex img/widget/genlist/preview-00.eps
17957     * @image html img/genlist.png
17958     * @image latex img/genlist.eps
17959     *
17960     * This widget aims to have more expansive list than the simple list in
17961     * Elementary that could have more flexible items and allow many more entries
17962     * while still being fast and low on memory usage. At the same time it was
17963     * also made to be able to do tree structures. But the price to pay is more
17964     * complexity when it comes to usage. If all you want is a simple list with
17965     * icons and a single label, use the normal @ref List object.
17966     *
17967     * Genlist has a fairly large API, mostly because it's relatively complex,
17968     * trying to be both expansive, powerful and efficient. First we will begin
17969     * an overview on the theory behind genlist.
17970     *
17971     * @section Genlist_Item_Class Genlist item classes - creating items
17972     *
17973     * In order to have the ability to add and delete items on the fly, genlist
17974     * implements a class (callback) system where the application provides a
17975     * structure with information about that type of item (genlist may contain
17976     * multiple different items with different classes, states and styles).
17977     * Genlist will call the functions in this struct (methods) when an item is
17978     * "realized" (i.e., created dynamically, while the user is scrolling the
17979     * grid). All objects will simply be deleted when no longer needed with
17980     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17981     * following members:
17982     * - @c item_style - This is a constant string and simply defines the name
17983     *   of the item style. It @b must be specified and the default should be @c
17984     *   "default".
17985     *
17986     * - @c func - A struct with pointers to functions that will be called when
17987     *   an item is going to be actually created. All of them receive a @c data
17988     *   parameter that will point to the same data passed to
17989     *   elm_genlist_item_append() and related item creation functions, and a @c
17990     *   obj parameter that points to the genlist object itself.
17991     *
17992     * The function pointers inside @c func are @c label_get, @c icon_get, @c
17993     * state_get and @c del. The 3 first functions also receive a @c part
17994     * parameter described below. A brief description of these functions follows:
17995     *
17996     * - @c label_get - The @c part parameter is the name string of one of the
17997     *   existing text parts in the Edje group implementing the item's theme.
17998     *   This function @b must return a strdup'()ed string, as the caller will
17999     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18000     * - @c content_get - The @c part parameter is the name string of one of the
18001     *   existing (content) swallow parts in the Edje group implementing the item's
18002     *   theme. It must return @c NULL, when no content is desired, or a valid
18003     *   object handle, otherwise.  The object will be deleted by the genlist on
18004     *   its deletion or when the item is "unrealized".  See
18005     *   #Elm_Genlist_Item_Icon_Get_Cb.
18006     * - @c func.state_get - The @c part parameter is the name string of one of
18007     *   the state parts in the Edje group implementing the item's theme. Return
18008     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18009     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18010     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18011     *   the state is true (the default is false), where @c XXX is the name of
18012     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18013     * - @c func.del - This is intended for use when genlist items are deleted,
18014     *   so any data attached to the item (e.g. its data parameter on creation)
18015     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18016     *
18017     * available item styles:
18018     * - default
18019     * - default_style - The text part is a textblock
18020     *
18021     * @image html img/widget/genlist/preview-04.png
18022     * @image latex img/widget/genlist/preview-04.eps
18023     *
18024     * - double_label
18025     *
18026     * @image html img/widget/genlist/preview-01.png
18027     * @image latex img/widget/genlist/preview-01.eps
18028     *
18029     * - icon_top_text_bottom
18030     *
18031     * @image html img/widget/genlist/preview-02.png
18032     * @image latex img/widget/genlist/preview-02.eps
18033     *
18034     * - group_index
18035     *
18036     * @image html img/widget/genlist/preview-03.png
18037     * @image latex img/widget/genlist/preview-03.eps
18038     *
18039     * @section Genlist_Items Structure of items
18040     *
18041     * An item in a genlist can have 0 or more text labels (they can be regular
18042     * text or textblock Evas objects - that's up to the style to determine), 0
18043     * or more contents (which are simply objects swallowed into the genlist item's
18044     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18045     * behavior left to the user to define. The Edje part names for each of
18046     * these properties will be looked up, in the theme file for the genlist,
18047     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18048     * "states", respectively. For each of those properties, if more than one
18049     * part is provided, they must have names listed separated by spaces in the
18050     * data fields. For the default genlist item theme, we have @b one label
18051     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18052     * "elm.swallow.end") and @b no state parts.
18053     *
18054     * A genlist item may be at one of several styles. Elementary provides one
18055     * by default - "default", but this can be extended by system or application
18056     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18057     * details).
18058     *
18059     * @section Genlist_Manipulation Editing and Navigating
18060     *
18061     * Items can be added by several calls. All of them return a @ref
18062     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18063     * They all take a data parameter that is meant to be used for a handle to
18064     * the applications internal data (eg the struct with the original item
18065     * data). The parent parameter is the parent genlist item this belongs to if
18066     * it is a tree or an indexed group, and NULL if there is no parent. The
18067     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18068     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18069     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18070     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18071     * is set then this item is group index item that is displayed at the top
18072     * until the next group comes. The func parameter is a convenience callback
18073     * that is called when the item is selected and the data parameter will be
18074     * the func_data parameter, obj be the genlist object and event_info will be
18075     * the genlist item.
18076     *
18077     * elm_genlist_item_append() adds an item to the end of the list, or if
18078     * there is a parent, to the end of all the child items of the parent.
18079     * elm_genlist_item_prepend() is the same but adds to the beginning of
18080     * the list or children list. elm_genlist_item_insert_before() inserts at
18081     * item before another item and elm_genlist_item_insert_after() inserts after
18082     * the indicated item.
18083     *
18084     * The application can clear the list with elm_gen_clear() which deletes
18085     * all the items in the list and elm_genlist_item_del() will delete a specific
18086     * item. elm_genlist_item_subitems_clear() will clear all items that are
18087     * children of the indicated parent item.
18088     *
18089     * To help inspect list items you can jump to the item at the top of the list
18090     * with elm_genlist_first_item_get() which will return the item pointer, and
18091     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18092     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18093     * and previous items respectively relative to the indicated item. Using
18094     * these calls you can walk the entire item list/tree. Note that as a tree
18095     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18096     * let you know which item is the parent (and thus know how to skip them if
18097     * wanted).
18098     *
18099     * @section Genlist_Muti_Selection Multi-selection
18100     *
18101     * If the application wants multiple items to be able to be selected,
18102     * elm_genlist_multi_select_set() can enable this. If the list is
18103     * single-selection only (the default), then elm_genlist_selected_item_get()
18104     * will return the selected item, if any, or NULL I none is selected. If the
18105     * list is multi-select then elm_genlist_selected_items_get() will return a
18106     * list (that is only valid as long as no items are modified (added, deleted,
18107     * selected or unselected)).
18108     *
18109     * @section Genlist_Usage_Hints Usage hints
18110     *
18111     * There are also convenience functions. elm_gen_item_genlist_get() will
18112     * return the genlist object the item belongs to. elm_genlist_item_show()
18113     * will make the scroller scroll to show that specific item so its visible.
18114     * elm_genlist_item_data_get() returns the data pointer set by the item
18115     * creation functions.
18116     *
18117     * If an item changes (state of boolean changes, label or contents change),
18118     * then use elm_genlist_item_update() to have genlist update the item with
18119     * the new state. Genlist will re-realize the item thus call the functions
18120     * in the _Elm_Genlist_Item_Class for that item.
18121     *
18122     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18123     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18124     * to expand/contract an item and get its expanded state, use
18125     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18126     * again to make an item disabled (unable to be selected and appear
18127     * differently) use elm_genlist_item_disabled_set() to set this and
18128     * elm_genlist_item_disabled_get() to get the disabled state.
18129     *
18130     * In general to indicate how the genlist should expand items horizontally to
18131     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18132     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18133     * mode means that if items are too wide to fit, the scroller will scroll
18134     * horizontally. Otherwise items are expanded to fill the width of the
18135     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18136     * to the viewport width and limited to that size. This can be combined with
18137     * a different style that uses edjes' ellipsis feature (cutting text off like
18138     * this: "tex...").
18139     *
18140     * Items will only call their selection func and callback when first becoming
18141     * selected. Any further clicks will do nothing, unless you enable always
18142     * select with elm_gen_always_select_mode_set(). This means even if
18143     * selected, every click will make the selected callbacks be called.
18144     * elm_genlist_no_select_mode_set() will turn off the ability to select
18145     * items entirely and they will neither appear selected nor call selected
18146     * callback functions.
18147     *
18148     * Remember that you can create new styles and add your own theme augmentation
18149     * per application with elm_theme_extension_add(). If you absolutely must
18150     * have a specific style that overrides any theme the user or system sets up
18151     * you can use elm_theme_overlay_add() to add such a file.
18152     *
18153     * @section Genlist_Implementation Implementation
18154     *
18155     * Evas tracks every object you create. Every time it processes an event
18156     * (mouse move, down, up etc.) it needs to walk through objects and find out
18157     * what event that affects. Even worse every time it renders display updates,
18158     * in order to just calculate what to re-draw, it needs to walk through many
18159     * many many objects. Thus, the more objects you keep active, the more
18160     * overhead Evas has in just doing its work. It is advisable to keep your
18161     * active objects to the minimum working set you need. Also remember that
18162     * object creation and deletion carries an overhead, so there is a
18163     * middle-ground, which is not easily determined. But don't keep massive lists
18164     * of objects you can't see or use. Genlist does this with list objects. It
18165     * creates and destroys them dynamically as you scroll around. It groups them
18166     * into blocks so it can determine the visibility etc. of a whole block at
18167     * once as opposed to having to walk the whole list. This 2-level list allows
18168     * for very large numbers of items to be in the list (tests have used up to
18169     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18170     * may be different sizes, every item added needs to be calculated as to its
18171     * size and thus this presents a lot of overhead on populating the list, this
18172     * genlist employs a queue. Any item added is queued and spooled off over
18173     * time, actually appearing some time later, so if your list has many members
18174     * you may find it takes a while for them to all appear, with your process
18175     * consuming a lot of CPU while it is busy spooling.
18176     *
18177     * Genlist also implements a tree structure, but it does so with callbacks to
18178     * the application, with the application filling in tree structures when
18179     * requested (allowing for efficient building of a very deep tree that could
18180     * even be used for file-management). See the above smart signal callbacks for
18181     * details.
18182     *
18183     * @section Genlist_Smart_Events Genlist smart events
18184     *
18185     * Signals that you can add callbacks for are:
18186     * - @c "activated" - The user has double-clicked or pressed
18187     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18188     *   item that was activated.
18189     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18190     *   event_info parameter is the item that was double-clicked.
18191     * - @c "selected" - This is called when a user has made an item selected.
18192     *   The event_info parameter is the genlist item that was selected.
18193     * - @c "unselected" - This is called when a user has made an item
18194     *   unselected. The event_info parameter is the genlist item that was
18195     *   unselected.
18196     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18197     *   called and the item is now meant to be expanded. The event_info
18198     *   parameter is the genlist item that was indicated to expand.  It is the
18199     *   job of this callback to then fill in the child items.
18200     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18201     *   called and the item is now meant to be contracted. The event_info
18202     *   parameter is the genlist item that was indicated to contract. It is the
18203     *   job of this callback to then delete the child items.
18204     * - @c "expand,request" - This is called when a user has indicated they want
18205     *   to expand a tree branch item. The callback should decide if the item can
18206     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18207     *   appropriately to set the state. The event_info parameter is the genlist
18208     *   item that was indicated to expand.
18209     * - @c "contract,request" - This is called when a user has indicated they
18210     *   want to contract a tree branch item. The callback should decide if the
18211     *   item can contract (has any children) and then call
18212     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18213     *   event_info parameter is the genlist item that was indicated to contract.
18214     * - @c "realized" - This is called when the item in the list is created as a
18215     *   real evas object. event_info parameter is the genlist item that was
18216     *   created. The object may be deleted at any time, so it is up to the
18217     *   caller to not use the object pointer from elm_genlist_item_object_get()
18218     *   in a way where it may point to freed objects.
18219     * - @c "unrealized" - This is called just before an item is unrealized.
18220     *   After this call content objects provided will be deleted and the item
18221     *   object itself delete or be put into a floating cache.
18222     * - @c "drag,start,up" - This is called when the item in the list has been
18223     *   dragged (not scrolled) up.
18224     * - @c "drag,start,down" - This is called when the item in the list has been
18225     *   dragged (not scrolled) down.
18226     * - @c "drag,start,left" - This is called when the item in the list has been
18227     *   dragged (not scrolled) left.
18228     * - @c "drag,start,right" - This is called when the item in the list has
18229     *   been dragged (not scrolled) right.
18230     * - @c "drag,stop" - This is called when the item in the list has stopped
18231     *   being dragged.
18232     * - @c "drag" - This is called when the item in the list is being dragged.
18233     * - @c "longpressed" - This is called when the item is pressed for a certain
18234     *   amount of time. By default it's 1 second.
18235     * - @c "scroll,anim,start" - This is called when scrolling animation has
18236     *   started.
18237     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18238     *   stopped.
18239     * - @c "scroll,drag,start" - This is called when dragging the content has
18240     *   started.
18241     * - @c "scroll,drag,stop" - This is called when dragging the content has
18242     *   stopped.
18243     * - @c "edge,top" - This is called when the genlist is scrolled until
18244     *   the top edge.
18245     * - @c "edge,bottom" - This is called when the genlist is scrolled
18246     *   until the bottom edge.
18247     * - @c "edge,left" - This is called when the genlist is scrolled
18248     *   until the left edge.
18249     * - @c "edge,right" - This is called when the genlist is scrolled
18250     *   until the right edge.
18251     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18252     *   swiped left.
18253     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18254     *   swiped right.
18255     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18256     *   swiped up.
18257     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18258     *   swiped down.
18259     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18260     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18261     *   multi-touch pinched in.
18262     * - @c "swipe" - This is called when the genlist is swiped.
18263     * - @c "moved" - This is called when a genlist item is moved.
18264     * - @c "language,changed" - This is called when the program's language is
18265     *   changed.
18266     *
18267     * @section Genlist_Examples Examples
18268     *
18269     * Here is a list of examples that use the genlist, trying to show some of
18270     * its capabilities:
18271     * - @ref genlist_example_01
18272     * - @ref genlist_example_02
18273     * - @ref genlist_example_03
18274     * - @ref genlist_example_04
18275     * - @ref genlist_example_05
18276     */
18277
18278    /**
18279     * @addtogroup Genlist
18280     * @{
18281     */
18282
18283    /**
18284     * @enum _Elm_Genlist_Item_Flags
18285     * @typedef Elm_Genlist_Item_Flags
18286     *
18287     * Defines if the item is of any special type (has subitems or it's the
18288     * index of a group), or is just a simple item.
18289     *
18290     * @ingroup Genlist
18291     */
18292    typedef enum _Elm_Genlist_Item_Flags
18293      {
18294         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18295         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18296         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18297      } Elm_Genlist_Item_Flags;
18298    typedef enum _Elm_Genlist_Item_Field_Flags
18299      {
18300         ELM_GENLIST_ITEM_FIELD_ALL = 0,
18301         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18302         ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18303         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18304      } Elm_Genlist_Item_Field_Flags;
18305    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18306    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18307    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18308    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18309    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
18310    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18311    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
18312    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18313
18314    /**
18315     * @struct _Elm_Genlist_Item_Class
18316     *
18317     * Genlist item class definition structs.
18318     *
18319     * This struct contains the style and fetching functions that will define the
18320     * contents of each item.
18321     *
18322     * @see @ref Genlist_Item_Class
18323     */
18324    struct _Elm_Genlist_Item_Class
18325      {
18326         const char                *item_style;
18327         struct {
18328           GenlistItemLabelGetFunc  label_get;
18329           GenlistItemIconGetFunc   icon_get;
18330           GenlistItemStateGetFunc  state_get;
18331           GenlistItemDelFunc       del;
18332           GenlistItemMovedFunc     moved;
18333         } func;
18334         const char *edit_item_style;
18335         const char                *mode_item_style;
18336      };
18337    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18338    /**
18339     * Add a new genlist widget to the given parent Elementary
18340     * (container) object
18341     *
18342     * @param parent The parent object
18343     * @return a new genlist widget handle or @c NULL, on errors
18344     *
18345     * This function inserts a new genlist widget on the canvas.
18346     *
18347     * @see elm_genlist_item_append()
18348     * @see elm_genlist_item_del()
18349     * @see elm_gen_clear()
18350     *
18351     * @ingroup Genlist
18352     */
18353    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18354    /**
18355     * Remove all items from a given genlist widget.
18356     *
18357     * @param obj The genlist object
18358     *
18359     * This removes (and deletes) all items in @p obj, leaving it empty.
18360     *
18361     * @see elm_genlist_item_del(), to remove just one item.
18362     *
18363     * @ingroup Genlist
18364     */
18365    EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18366    /**
18367     * Enable or disable multi-selection in the genlist
18368     *
18369     * @param obj The genlist object
18370     * @param multi Multi-select enable/disable. Default is disabled.
18371     *
18372     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18373     * the list. This allows more than 1 item to be selected. To retrieve the list
18374     * of selected items, use elm_genlist_selected_items_get().
18375     *
18376     * @see elm_genlist_selected_items_get()
18377     * @see elm_genlist_multi_select_get()
18378     *
18379     * @ingroup Genlist
18380     */
18381    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18382    /**
18383     * Gets if multi-selection in genlist is enabled or disabled.
18384     *
18385     * @param obj The genlist object
18386     * @return Multi-select enabled/disabled
18387     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18388     *
18389     * @see elm_genlist_multi_select_set()
18390     *
18391     * @ingroup Genlist
18392     */
18393    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18394    /**
18395     * This sets the horizontal stretching mode.
18396     *
18397     * @param obj The genlist object
18398     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18399     *
18400     * This sets the mode used for sizing items horizontally. Valid modes
18401     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18402     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18403     * the scroller will scroll horizontally. Otherwise items are expanded
18404     * to fill the width of the viewport of the scroller. If it is
18405     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18406     * limited to that size.
18407     *
18408     * @see elm_genlist_horizontal_get()
18409     *
18410     * @ingroup Genlist
18411     */
18412    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18413    /**
18414     * Gets the horizontal stretching mode.
18415     *
18416     * @param obj The genlist object
18417     * @return The mode to use
18418     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18419     *
18420     * @see elm_genlist_horizontal_set()
18421     *
18422     * @ingroup Genlist
18423     */
18424    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18425    /**
18426     * Set the always select mode.
18427     *
18428     * @param obj The genlist object
18429     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18430     * EINA_FALSE = off). Default is @c EINA_FALSE.
18431     *
18432     * Items will only call their selection func and callback when first
18433     * becoming selected. Any further clicks will do nothing, unless you
18434     * enable always select with elm_genlist_always_select_mode_set().
18435     * This means that, even if selected, every click will make the selected
18436     * callbacks be called.
18437     *
18438     * @see elm_genlist_always_select_mode_get()
18439     *
18440     * @ingroup Genlist
18441     */
18442    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18443    /**
18444     * Get the always select mode.
18445     *
18446     * @param obj The genlist object
18447     * @return The always select mode
18448     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18449     *
18450     * @see elm_genlist_always_select_mode_set()
18451     *
18452     * @ingroup Genlist
18453     */
18454    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18455    /**
18456     * Enable/disable the no select mode.
18457     *
18458     * @param obj The genlist object
18459     * @param no_select The no select mode
18460     * (EINA_TRUE = on, EINA_FALSE = off)
18461     *
18462     * This will turn off the ability to select items entirely and they
18463     * will neither appear selected nor call selected callback functions.
18464     *
18465     * @see elm_genlist_no_select_mode_get()
18466     *
18467     * @ingroup Genlist
18468     */
18469    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18470    /**
18471     * Gets whether the no select mode is enabled.
18472     *
18473     * @param obj The genlist object
18474     * @return The no select mode
18475     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18476     *
18477     * @see elm_genlist_no_select_mode_set()
18478     *
18479     * @ingroup Genlist
18480     */
18481    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18482    /**
18483     * Enable/disable compress mode.
18484     *
18485     * @param obj The genlist object
18486     * @param compress The compress mode
18487     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18488     *
18489     * This will enable the compress mode where items are "compressed"
18490     * horizontally to fit the genlist scrollable viewport width. This is
18491     * special for genlist.  Do not rely on
18492     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18493     * work as genlist needs to handle it specially.
18494     *
18495     * @see elm_genlist_compress_mode_get()
18496     *
18497     * @ingroup Genlist
18498     */
18499    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18500    /**
18501     * Get whether the compress mode is enabled.
18502     *
18503     * @param obj The genlist object
18504     * @return The compress mode
18505     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18506     *
18507     * @see elm_genlist_compress_mode_set()
18508     *
18509     * @ingroup Genlist
18510     */
18511    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18512    /**
18513     * Enable/disable height-for-width mode.
18514     *
18515     * @param obj The genlist object
18516     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18517     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18518     *
18519     * With height-for-width mode the item width will be fixed (restricted
18520     * to a minimum of) to the list width when calculating its size in
18521     * order to allow the height to be calculated based on it. This allows,
18522     * for instance, text block to wrap lines if the Edje part is
18523     * configured with "text.min: 0 1".
18524     *
18525     * @note This mode will make list resize slower as it will have to
18526     *       recalculate every item height again whenever the list width
18527     *       changes!
18528     *
18529     * @note When height-for-width mode is enabled, it also enables
18530     *       compress mode (see elm_genlist_compress_mode_set()) and
18531     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18532     *
18533     * @ingroup Genlist
18534     */
18535    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18536    /**
18537     * Get whether the height-for-width mode is enabled.
18538     *
18539     * @param obj The genlist object
18540     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18541     * off)
18542     *
18543     * @ingroup Genlist
18544     */
18545    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18546    /**
18547     * Enable/disable horizontal and vertical bouncing effect.
18548     *
18549     * @param obj The genlist object
18550     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18551     * EINA_FALSE = off). Default is @c EINA_FALSE.
18552     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18553     * EINA_FALSE = off). Default is @c EINA_TRUE.
18554     *
18555     * This will enable or disable the scroller bouncing effect for the
18556     * genlist. See elm_scroller_bounce_set() for details.
18557     *
18558     * @see elm_scroller_bounce_set()
18559     * @see elm_genlist_bounce_get()
18560     *
18561     * @ingroup Genlist
18562     */
18563    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18564    /**
18565     * Get whether the horizontal and vertical bouncing effect is enabled.
18566     *
18567     * @param obj The genlist object
18568     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18569     * option is set.
18570     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18571     * option is set.
18572     *
18573     * @see elm_genlist_bounce_set()
18574     *
18575     * @ingroup Genlist
18576     */
18577    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18578    /**
18579     * Enable/disable homogenous mode.
18580     *
18581     * @param obj The genlist object
18582     * @param homogeneous Assume the items within the genlist are of the
18583     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18584     * EINA_FALSE.
18585     *
18586     * This will enable the homogeneous mode where items are of the same
18587     * height and width so that genlist may do the lazy-loading at its
18588     * maximum (which increases the performance for scrolling the list). This
18589     * implies 'compressed' mode.
18590     *
18591     * @see elm_genlist_compress_mode_set()
18592     * @see elm_genlist_homogeneous_get()
18593     *
18594     * @ingroup Genlist
18595     */
18596    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18597    /**
18598     * Get whether the homogenous mode is enabled.
18599     *
18600     * @param obj The genlist object
18601     * @return Assume the items within the genlist are of the same height
18602     * and width (EINA_TRUE = on, EINA_FALSE = off)
18603     *
18604     * @see elm_genlist_homogeneous_set()
18605     *
18606     * @ingroup Genlist
18607     */
18608    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18609    /**
18610     * Set the maximum number of items within an item block
18611     *
18612     * @param obj The genlist object
18613     * @param n   Maximum number of items within an item block. Default is 32.
18614     *
18615     * This will configure the block count to tune to the target with
18616     * particular performance matrix.
18617     *
18618     * A block of objects will be used to reduce the number of operations due to
18619     * many objects in the screen. It can determine the visibility, or if the
18620     * object has changed, it theme needs to be updated, etc. doing this kind of
18621     * calculation to the entire block, instead of per object.
18622     *
18623     * The default value for the block count is enough for most lists, so unless
18624     * you know you will have a lot of objects visible in the screen at the same
18625     * time, don't try to change this.
18626     *
18627     * @see elm_genlist_block_count_get()
18628     * @see @ref Genlist_Implementation
18629     *
18630     * @ingroup Genlist
18631     */
18632    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18633    /**
18634     * Get the maximum number of items within an item block
18635     *
18636     * @param obj The genlist object
18637     * @return Maximum number of items within an item block
18638     *
18639     * @see elm_genlist_block_count_set()
18640     *
18641     * @ingroup Genlist
18642     */
18643    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18644    /**
18645     * Set the timeout in seconds for the longpress event.
18646     *
18647     * @param obj The genlist object
18648     * @param timeout timeout in seconds. Default is 1.
18649     *
18650     * This option will change how long it takes to send an event "longpressed"
18651     * after the mouse down signal is sent to the list. If this event occurs, no
18652     * "clicked" event will be sent.
18653     *
18654     * @see elm_genlist_longpress_timeout_set()
18655     *
18656     * @ingroup Genlist
18657     */
18658    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18659    /**
18660     * Get the timeout in seconds for the longpress event.
18661     *
18662     * @param obj The genlist object
18663     * @return timeout in seconds
18664     *
18665     * @see elm_genlist_longpress_timeout_get()
18666     *
18667     * @ingroup Genlist
18668     */
18669    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18670    /**
18671     * Append a new item in a given genlist widget.
18672     *
18673     * @param obj The genlist object
18674     * @param itc The item class for the item
18675     * @param data The item data
18676     * @param parent The parent item, or NULL if none
18677     * @param flags Item flags
18678     * @param func Convenience function called when the item is selected
18679     * @param func_data Data passed to @p func above.
18680     * @return A handle to the item added or @c NULL if not possible
18681     *
18682     * This adds the given item to the end of the list or the end of
18683     * the children list if the @p parent is given.
18684     *
18685     * @see elm_genlist_item_prepend()
18686     * @see elm_genlist_item_insert_before()
18687     * @see elm_genlist_item_insert_after()
18688     * @see elm_genlist_item_del()
18689     *
18690     * @ingroup Genlist
18691     */
18692    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);
18693    /**
18694     * Prepend a new item in a given genlist widget.
18695     *
18696     * @param obj The genlist object
18697     * @param itc The item class for the item
18698     * @param data The item data
18699     * @param parent The parent item, or NULL if none
18700     * @param flags Item flags
18701     * @param func Convenience function called when the item is selected
18702     * @param func_data Data passed to @p func above.
18703     * @return A handle to the item added or NULL if not possible
18704     *
18705     * This adds an item to the beginning of the list or beginning of the
18706     * children of the parent if given.
18707     *
18708     * @see elm_genlist_item_append()
18709     * @see elm_genlist_item_insert_before()
18710     * @see elm_genlist_item_insert_after()
18711     * @see elm_genlist_item_del()
18712     *
18713     * @ingroup Genlist
18714     */
18715    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);
18716    /**
18717     * Insert an item before another in a genlist widget
18718     *
18719     * @param obj The genlist object
18720     * @param itc The item class for the item
18721     * @param data The item data
18722     * @param before The item to place this new one before.
18723     * @param flags Item flags
18724     * @param func Convenience function called when the item is selected
18725     * @param func_data Data passed to @p func above.
18726     * @return A handle to the item added or @c NULL if not possible
18727     *
18728     * This inserts an item before another in the list. It will be in the
18729     * same tree level or group as the item it is inserted before.
18730     *
18731     * @see elm_genlist_item_append()
18732     * @see elm_genlist_item_prepend()
18733     * @see elm_genlist_item_insert_after()
18734     * @see elm_genlist_item_del()
18735     *
18736     * @ingroup Genlist
18737     */
18738    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);
18739    /**
18740     * Insert an item after another in a genlist widget
18741     *
18742     * @param obj The genlist object
18743     * @param itc The item class for the item
18744     * @param data The item data
18745     * @param after The item to place this new one after.
18746     * @param flags Item flags
18747     * @param func Convenience function called when the item is selected
18748     * @param func_data Data passed to @p func above.
18749     * @return A handle to the item added or @c NULL if not possible
18750     *
18751     * This inserts an item after another in the list. It will be in the
18752     * same tree level or group as the item it is inserted after.
18753     *
18754     * @see elm_genlist_item_append()
18755     * @see elm_genlist_item_prepend()
18756     * @see elm_genlist_item_insert_before()
18757     * @see elm_genlist_item_del()
18758     *
18759     * @ingroup Genlist
18760     */
18761    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);
18762    /**
18763     * Insert a new item into the sorted genlist object
18764     *
18765     * @param obj The genlist object
18766     * @param itc The item class for the item
18767     * @param data The item data
18768     * @param parent The parent item, or NULL if none
18769     * @param flags Item flags
18770     * @param comp The function called for the sort
18771     * @param func Convenience function called when item selected
18772     * @param func_data Data passed to @p func above.
18773     * @return A handle to the item added or NULL if not possible
18774     *
18775     * @ingroup Genlist
18776     */
18777    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);
18778    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);
18779    /* operations to retrieve existing items */
18780    /**
18781     * Get the selectd item in the genlist.
18782     *
18783     * @param obj The genlist object
18784     * @return The selected item, or NULL if none is selected.
18785     *
18786     * This gets the selected item in the list (if multi-selection is enabled, only
18787     * the item that was first selected in the list is returned - which is not very
18788     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18789     * used).
18790     *
18791     * If no item is selected, NULL is returned.
18792     *
18793     * @see elm_genlist_selected_items_get()
18794     *
18795     * @ingroup Genlist
18796     */
18797    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18798    /**
18799     * Get a list of selected items in the genlist.
18800     *
18801     * @param obj The genlist object
18802     * @return The list of selected items, or NULL if none are selected.
18803     *
18804     * It returns a list of the selected items. This list pointer is only valid so
18805     * long as the selection doesn't change (no items are selected or unselected, or
18806     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18807     * pointers. The order of the items in this list is the order which they were
18808     * selected, i.e. the first item in this list is the first item that was
18809     * selected, and so on.
18810     *
18811     * @note If not in multi-select mode, consider using function
18812     * elm_genlist_selected_item_get() instead.
18813     *
18814     * @see elm_genlist_multi_select_set()
18815     * @see elm_genlist_selected_item_get()
18816     *
18817     * @ingroup Genlist
18818     */
18819    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18820    /**
18821     * Get the mode item style of items in the genlist
18822     * @param obj The genlist object
18823     * @return The mode item style string, or NULL if none is specified
18824     * 
18825     * This is a constant string and simply defines the name of the
18826     * style that will be used for mode animations. It can be
18827     * @c NULL if you don't plan to use Genlist mode. See
18828     * elm_genlist_item_mode_set() for more info.
18829     * 
18830     * @ingroup Genlist
18831     */
18832    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18833    /**
18834     * Set the mode item style of items in the genlist
18835     * @param obj The genlist object
18836     * @param style The mode item style string, or NULL if none is desired
18837     * 
18838     * This is a constant string and simply defines the name of the
18839     * style that will be used for mode animations. It can be
18840     * @c NULL if you don't plan to use Genlist mode. See
18841     * elm_genlist_item_mode_set() for more info.
18842     * 
18843     * @ingroup Genlist
18844     */
18845    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18846    /**
18847     * Get a list of realized items in genlist
18848     *
18849     * @param obj The genlist object
18850     * @return The list of realized items, nor NULL if none are realized.
18851     *
18852     * This returns a list of the realized items in the genlist. The list
18853     * contains Elm_Genlist_Item pointers. The list must be freed by the
18854     * caller when done with eina_list_free(). The item pointers in the
18855     * list are only valid so long as those items are not deleted or the
18856     * genlist is not deleted.
18857     *
18858     * @see elm_genlist_realized_items_update()
18859     *
18860     * @ingroup Genlist
18861     */
18862    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18863    /**
18864     * Get the item that is at the x, y canvas coords.
18865     *
18866     * @param obj The gelinst object.
18867     * @param x The input x coordinate
18868     * @param y The input y coordinate
18869     * @param posret The position relative to the item returned here
18870     * @return The item at the coordinates or NULL if none
18871     *
18872     * This returns the item at the given coordinates (which are canvas
18873     * relative, not object-relative). If an item is at that coordinate,
18874     * that item handle is returned, and if @p posret is not NULL, the
18875     * integer pointed to is set to a value of -1, 0 or 1, depending if
18876     * the coordinate is on the upper portion of that item (-1), on the
18877     * middle section (0) or on the lower part (1). If NULL is returned as
18878     * an item (no item found there), then posret may indicate -1 or 1
18879     * based if the coordinate is above or below all items respectively in
18880     * the genlist.
18881     *
18882     * @ingroup Genlist
18883     */
18884    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);
18885    /**
18886     * Get the first item in the genlist
18887     *
18888     * This returns the first item in the list.
18889     *
18890     * @param obj The genlist object
18891     * @return The first item, or NULL if none
18892     *
18893     * @ingroup Genlist
18894     */
18895    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18896    /**
18897     * Get the last item in the genlist
18898     *
18899     * This returns the last item in the list.
18900     *
18901     * @return The last item, or NULL if none
18902     *
18903     * @ingroup Genlist
18904     */
18905    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18906    /**
18907     * Set the scrollbar policy
18908     *
18909     * @param obj The genlist object
18910     * @param policy_h Horizontal scrollbar policy.
18911     * @param policy_v Vertical scrollbar policy.
18912     *
18913     * This sets the scrollbar visibility policy for the given genlist
18914     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18915     * made visible if it is needed, and otherwise kept hidden.
18916     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18917     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18918     * respectively for the horizontal and vertical scrollbars. Default is
18919     * #ELM_SMART_SCROLLER_POLICY_AUTO
18920     *
18921     * @see elm_genlist_scroller_policy_get()
18922     *
18923     * @ingroup Genlist
18924     */
18925    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18926    /**
18927     * Get the scrollbar policy
18928     *
18929     * @param obj The genlist object
18930     * @param policy_h Pointer to store the horizontal scrollbar policy.
18931     * @param policy_v Pointer to store the vertical scrollbar policy.
18932     *
18933     * @see elm_genlist_scroller_policy_set()
18934     *
18935     * @ingroup Genlist
18936     */
18937    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);
18938    /**
18939     * Get the @b next item in a genlist widget's internal list of items,
18940     * given a handle to one of those items.
18941     *
18942     * @param item The genlist item to fetch next from
18943     * @return The item after @p item, or @c NULL if there's none (and
18944     * on errors)
18945     *
18946     * This returns the item placed after the @p item, on the container
18947     * genlist.
18948     *
18949     * @see elm_genlist_item_prev_get()
18950     *
18951     * @ingroup Genlist
18952     */
18953    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18954    /**
18955     * Get the @b previous item in a genlist widget's internal list of items,
18956     * given a handle to one of those items.
18957     *
18958     * @param item The genlist item to fetch previous from
18959     * @return The item before @p item, or @c NULL if there's none (and
18960     * on errors)
18961     *
18962     * This returns the item placed before the @p item, on the container
18963     * genlist.
18964     *
18965     * @see elm_genlist_item_next_get()
18966     *
18967     * @ingroup Genlist
18968     */
18969    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18970    /**
18971     * Get the genlist object's handle which contains a given genlist
18972     * item
18973     *
18974     * @param item The item to fetch the container from
18975     * @return The genlist (parent) object
18976     *
18977     * This returns the genlist object itself that an item belongs to.
18978     *
18979     * @ingroup Genlist
18980     */
18981    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18982    /**
18983     * Get the parent item of the given item
18984     *
18985     * @param it The item
18986     * @return The parent of the item or @c NULL if it has no parent.
18987     *
18988     * This returns the item that was specified as parent of the item @p it on
18989     * elm_genlist_item_append() and insertion related functions.
18990     *
18991     * @ingroup Genlist
18992     */
18993    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18994    /**
18995     * Remove all sub-items (children) of the given item
18996     *
18997     * @param it The item
18998     *
18999     * This removes all items that are children (and their descendants) of the
19000     * given item @p it.
19001     *
19002     * @see elm_genlist_clear()
19003     * @see elm_genlist_item_del()
19004     *
19005     * @ingroup Genlist
19006     */
19007    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19008    /**
19009     * Set whether a given genlist item is selected or not
19010     *
19011     * @param it The item
19012     * @param selected Use @c EINA_TRUE, to make it selected, @c
19013     * EINA_FALSE to make it unselected
19014     *
19015     * This sets the selected state of an item. If multi selection is
19016     * not enabled on the containing genlist and @p selected is @c
19017     * EINA_TRUE, any other previously selected items will get
19018     * unselected in favor of this new one.
19019     *
19020     * @see elm_genlist_item_selected_get()
19021     *
19022     * @ingroup Genlist
19023     */
19024    EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19025    /**
19026     * Get whether a given genlist item is selected or not
19027     *
19028     * @param it The item
19029     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19030     *
19031     * @see elm_genlist_item_selected_set() for more details
19032     *
19033     * @ingroup Genlist
19034     */
19035    EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19036    /**
19037     * Sets the expanded state of an item.
19038     *
19039     * @param it The item
19040     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19041     *
19042     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19043     * expanded or not.
19044     *
19045     * The theme will respond to this change visually, and a signal "expanded" or
19046     * "contracted" will be sent from the genlist with a pointer to the item that
19047     * has been expanded/contracted.
19048     *
19049     * Calling this function won't show or hide any child of this item (if it is
19050     * a parent). You must manually delete and create them on the callbacks fo
19051     * the "expanded" or "contracted" signals.
19052     *
19053     * @see elm_genlist_item_expanded_get()
19054     *
19055     * @ingroup Genlist
19056     */
19057    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19058    /**
19059     * Get the expanded state of an item
19060     *
19061     * @param it The item
19062     * @return The expanded state
19063     *
19064     * This gets the expanded state of an item.
19065     *
19066     * @see elm_genlist_item_expanded_set()
19067     *
19068     * @ingroup Genlist
19069     */
19070    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19071    /**
19072     * Get the depth of expanded item
19073     *
19074     * @param it The genlist item object
19075     * @return The depth of expanded item
19076     *
19077     * @ingroup Genlist
19078     */
19079    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19080    /**
19081     * Set whether a given genlist item is disabled or not.
19082     *
19083     * @param it The item
19084     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19085     * to enable it back.
19086     *
19087     * A disabled item cannot be selected or unselected. It will also
19088     * change its appearance, to signal the user it's disabled.
19089     *
19090     * @see elm_genlist_item_disabled_get()
19091     *
19092     * @ingroup Genlist
19093     */
19094    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19095    /**
19096     * Get whether a given genlist item is disabled or not.
19097     *
19098     * @param it The item
19099     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19100     * (and on errors).
19101     *
19102     * @see elm_genlist_item_disabled_set() for more details
19103     *
19104     * @ingroup Genlist
19105     */
19106    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19107    /**
19108     * Sets the display only state of an item.
19109     *
19110     * @param it The item
19111     * @param display_only @c EINA_TRUE if the item is display only, @c
19112     * EINA_FALSE otherwise.
19113     *
19114     * A display only item cannot be selected or unselected. It is for
19115     * display only and not selecting or otherwise clicking, dragging
19116     * etc. by the user, thus finger size rules will not be applied to
19117     * this item.
19118     *
19119     * It's good to set group index items to display only state.
19120     *
19121     * @see elm_genlist_item_display_only_get()
19122     *
19123     * @ingroup Genlist
19124     */
19125    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19126    /**
19127     * Get the display only state of an item
19128     *
19129     * @param it The item
19130     * @return @c EINA_TRUE if the item is display only, @c
19131     * EINA_FALSE otherwise.
19132     *
19133     * @see elm_genlist_item_display_only_set()
19134     *
19135     * @ingroup Genlist
19136     */
19137    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19138    /**
19139     * Show the portion of a genlist's internal list containing a given
19140     * item, immediately.
19141     *
19142     * @param it The item to display
19143     *
19144     * This causes genlist to jump to the given item @p it and show it (by
19145     * immediately scrolling to that position), if it is not fully visible.
19146     *
19147     * @see elm_genlist_item_bring_in()
19148     * @see elm_genlist_item_top_show()
19149     * @see elm_genlist_item_middle_show()
19150     *
19151     * @ingroup Genlist
19152     */
19153    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19154    /**
19155     * Animatedly bring in, to the visible are of a genlist, a given
19156     * item on it.
19157     *
19158     * @param it The item to display
19159     *
19160     * This causes genlist to jump to the given item @p it and show it (by
19161     * animatedly scrolling), if it is not fully visible. This may use animation
19162     * to do so and take a period of time
19163     *
19164     * @see elm_genlist_item_show()
19165     * @see elm_genlist_item_top_bring_in()
19166     * @see elm_genlist_item_middle_bring_in()
19167     *
19168     * @ingroup Genlist
19169     */
19170    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19171    /**
19172     * Show the portion of a genlist's internal list containing a given
19173     * item, immediately.
19174     *
19175     * @param it The item to display
19176     *
19177     * This causes genlist to jump to the given item @p it and show it (by
19178     * immediately scrolling to that position), if it is not fully visible.
19179     *
19180     * The item will be positioned at the top of the genlist viewport.
19181     *
19182     * @see elm_genlist_item_show()
19183     * @see elm_genlist_item_top_bring_in()
19184     *
19185     * @ingroup Genlist
19186     */
19187    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19188    /**
19189     * Animatedly bring in, to the visible are of a genlist, a given
19190     * item on it.
19191     *
19192     * @param it The item
19193     *
19194     * This causes genlist to jump to the given item @p it and show it (by
19195     * animatedly scrolling), if it is not fully visible. This may use animation
19196     * to do so and take a period of time
19197     *
19198     * The item will be positioned at the top of the genlist viewport.
19199     *
19200     * @see elm_genlist_item_bring_in()
19201     * @see elm_genlist_item_top_show()
19202     *
19203     * @ingroup Genlist
19204     */
19205    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19206    /**
19207     * Show the portion of a genlist's internal list containing a given
19208     * item, immediately.
19209     *
19210     * @param it The item to display
19211     *
19212     * This causes genlist to jump to the given item @p it and show it (by
19213     * immediately scrolling to that position), if it is not fully visible.
19214     *
19215     * The item will be positioned at the middle of the genlist viewport.
19216     *
19217     * @see elm_genlist_item_show()
19218     * @see elm_genlist_item_middle_bring_in()
19219     *
19220     * @ingroup Genlist
19221     */
19222    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19223    /**
19224     * Animatedly bring in, to the visible are of a genlist, a given
19225     * item on it.
19226     *
19227     * @param it The item
19228     *
19229     * This causes genlist to jump to the given item @p it and show it (by
19230     * animatedly scrolling), if it is not fully visible. This may use animation
19231     * to do so and take a period of time
19232     *
19233     * The item will be positioned at the middle of the genlist viewport.
19234     *
19235     * @see elm_genlist_item_bring_in()
19236     * @see elm_genlist_item_middle_show()
19237     *
19238     * @ingroup Genlist
19239     */
19240    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19241    /**
19242     * Remove a genlist item from the its parent, deleting it.
19243     *
19244     * @param item The item to be removed.
19245     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19246     *
19247     * @see elm_genlist_clear(), to remove all items in a genlist at
19248     * once.
19249     *
19250     * @ingroup Genlist
19251     */
19252    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19253    /**
19254     * Return the data associated to a given genlist item
19255     *
19256     * @param item The genlist item.
19257     * @return the data associated to this item.
19258     *
19259     * This returns the @c data value passed on the
19260     * elm_genlist_item_append() and related item addition calls.
19261     *
19262     * @see elm_genlist_item_append()
19263     * @see elm_genlist_item_data_set()
19264     *
19265     * @ingroup Genlist
19266     */
19267    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19268    /**
19269     * Set the data associated to a given genlist item
19270     *
19271     * @param item The genlist item
19272     * @param data The new data pointer to set on it
19273     *
19274     * This @b overrides the @c data value passed on the
19275     * elm_genlist_item_append() and related item addition calls. This
19276     * function @b won't call elm_genlist_item_update() automatically,
19277     * so you'd issue it afterwards if you want to hove the item
19278     * updated to reflect the that new data.
19279     *
19280     * @see elm_genlist_item_data_get()
19281     *
19282     * @ingroup Genlist
19283     */
19284    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19285    /**
19286     * Tells genlist to "orphan" icons fetchs by the item class
19287     *
19288     * @param it The item
19289     *
19290     * This instructs genlist to release references to icons in the item,
19291     * meaning that they will no longer be managed by genlist and are
19292     * floating "orphans" that can be re-used elsewhere if the user wants
19293     * to.
19294     *
19295     * @ingroup Genlist
19296     */
19297    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19298    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19299    /**
19300     * Get the real Evas object created to implement the view of a
19301     * given genlist item
19302     *
19303     * @param item The genlist item.
19304     * @return the Evas object implementing this item's view.
19305     *
19306     * This returns the actual Evas object used to implement the
19307     * specified genlist item's view. This may be @c NULL, as it may
19308     * not have been created or may have been deleted, at any time, by
19309     * the genlist. <b>Do not modify this object</b> (move, resize,
19310     * show, hide, etc.), as the genlist is controlling it. This
19311     * function is for querying, emitting custom signals or hooking
19312     * lower level callbacks for events on that object. Do not delete
19313     * this object under any circumstances.
19314     *
19315     * @see elm_genlist_item_data_get()
19316     *
19317     * @ingroup Genlist
19318     */
19319    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19320    /**
19321     * Update the contents of an item
19322     *
19323     * @param it The item
19324     *
19325     * This updates an item by calling all the item class functions again
19326     * to get the icons, labels and states. Use this when the original
19327     * item data has changed and the changes are desired to be reflected.
19328     *
19329     * Use elm_genlist_realized_items_update() to update all already realized
19330     * items.
19331     *
19332     * @see elm_genlist_realized_items_update()
19333     *
19334     * @ingroup Genlist
19335     */
19336    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19337    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19338    /**
19339     * Update the item class of an item
19340     *
19341     * @param it The item
19342     * @param itc The item class for the item
19343     *
19344     * This sets another class fo the item, changing the way that it is
19345     * displayed. After changing the item class, elm_genlist_item_update() is
19346     * called on the item @p it.
19347     *
19348     * @ingroup Genlist
19349     */
19350    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19351    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19352    /**
19353     * Set the text to be shown in a given genlist item's tooltips.
19354     *
19355     * @param item The genlist item
19356     * @param text The text to set in the content
19357     *
19358     * This call will setup the text to be used as tooltip to that item
19359     * (analogous to elm_object_tooltip_text_set(), but being item
19360     * tooltips with higher precedence than object tooltips). It can
19361     * have only one tooltip at a time, so any previous tooltip data
19362     * will get removed.
19363     *
19364     * In order to set an icon or something else as a tooltip, look at
19365     * elm_genlist_item_tooltip_content_cb_set().
19366     *
19367     * @ingroup Genlist
19368     */
19369    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19370    /**
19371     * Set the content to be shown in a given genlist item's tooltips
19372     *
19373     * @param item The genlist item.
19374     * @param func The function returning the tooltip contents.
19375     * @param data What to provide to @a func as callback data/context.
19376     * @param del_cb Called when data is not needed anymore, either when
19377     *        another callback replaces @p func, the tooltip is unset with
19378     *        elm_genlist_item_tooltip_unset() or the owner @p item
19379     *        dies. This callback receives as its first parameter the
19380     *        given @p data, being @c event_info the item handle.
19381     *
19382     * This call will setup the tooltip's contents to @p item
19383     * (analogous to elm_object_tooltip_content_cb_set(), but being
19384     * item tooltips with higher precedence than object tooltips). It
19385     * can have only one tooltip at a time, so any previous tooltip
19386     * content will get removed. @p func (with @p data) will be called
19387     * every time Elementary needs to show the tooltip and it should
19388     * return a valid Evas object, which will be fully managed by the
19389     * tooltip system, getting deleted when the tooltip is gone.
19390     *
19391     * In order to set just a text as a tooltip, look at
19392     * elm_genlist_item_tooltip_text_set().
19393     *
19394     * @ingroup Genlist
19395     */
19396    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);
19397    /**
19398     * Unset a tooltip from a given genlist item
19399     *
19400     * @param item genlist item to remove a previously set tooltip from.
19401     *
19402     * This call removes any tooltip set on @p item. The callback
19403     * provided as @c del_cb to
19404     * elm_genlist_item_tooltip_content_cb_set() will be called to
19405     * notify it is not used anymore (and have resources cleaned, if
19406     * need be).
19407     *
19408     * @see elm_genlist_item_tooltip_content_cb_set()
19409     *
19410     * @ingroup Genlist
19411     */
19412    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19413    /**
19414     * Set a different @b style for a given genlist item's tooltip.
19415     *
19416     * @param item genlist item with tooltip set
19417     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19418     * "default", @c "transparent", etc)
19419     *
19420     * Tooltips can have <b>alternate styles</b> to be displayed on,
19421     * which are defined by the theme set on Elementary. This function
19422     * works analogously as elm_object_tooltip_style_set(), but here
19423     * applied only to genlist item objects. The default style for
19424     * tooltips is @c "default".
19425     *
19426     * @note before you set a style you should define a tooltip with
19427     *       elm_genlist_item_tooltip_content_cb_set() or
19428     *       elm_genlist_item_tooltip_text_set()
19429     *
19430     * @see elm_genlist_item_tooltip_style_get()
19431     *
19432     * @ingroup Genlist
19433     */
19434    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19435    /**
19436     * Get the style set a given genlist item's tooltip.
19437     *
19438     * @param item genlist item with tooltip already set on.
19439     * @return style the theme style in use, which defaults to
19440     *         "default". If the object does not have a tooltip set,
19441     *         then @c NULL is returned.
19442     *
19443     * @see elm_genlist_item_tooltip_style_set() for more details
19444     *
19445     * @ingroup Genlist
19446     */
19447    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19448    /**
19449     * Set the type of mouse pointer/cursor decoration to be shown,
19450     * when the mouse pointer is over the given genlist widget item
19451     *
19452     * @param item genlist item to customize cursor on
19453     * @param cursor the cursor type's name
19454     *
19455     * This function works analogously as elm_object_cursor_set(), but
19456     * here the cursor's changing area is restricted to the item's
19457     * area, and not the whole widget's. Note that that item cursors
19458     * have precedence over widget cursors, so that a mouse over @p
19459     * item will always show cursor @p type.
19460     *
19461     * If this function is called twice for an object, a previously set
19462     * cursor will be unset on the second call.
19463     *
19464     * @see elm_object_cursor_set()
19465     * @see elm_genlist_item_cursor_get()
19466     * @see elm_genlist_item_cursor_unset()
19467     *
19468     * @ingroup Genlist
19469     */
19470    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19471    /**
19472     * Get the type of mouse pointer/cursor decoration set to be shown,
19473     * when the mouse pointer is over the given genlist widget item
19474     *
19475     * @param item genlist item with custom cursor set
19476     * @return the cursor type's name or @c NULL, if no custom cursors
19477     * were set to @p item (and on errors)
19478     *
19479     * @see elm_object_cursor_get()
19480     * @see elm_genlist_item_cursor_set() for more details
19481     * @see elm_genlist_item_cursor_unset()
19482     *
19483     * @ingroup Genlist
19484     */
19485    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19486    /**
19487     * Unset any custom mouse pointer/cursor decoration set to be
19488     * shown, when the mouse pointer is over the given genlist widget
19489     * item, thus making it show the @b default cursor again.
19490     *
19491     * @param item a genlist item
19492     *
19493     * Use this call to undo any custom settings on this item's cursor
19494     * decoration, bringing it back to defaults (no custom style set).
19495     *
19496     * @see elm_object_cursor_unset()
19497     * @see elm_genlist_item_cursor_set() for more details
19498     *
19499     * @ingroup Genlist
19500     */
19501    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19502    /**
19503     * Set a different @b style for a given custom cursor set for a
19504     * genlist item.
19505     *
19506     * @param item genlist item with custom cursor set
19507     * @param style the <b>theme style</b> to use (e.g. @c "default",
19508     * @c "transparent", etc)
19509     *
19510     * This function only makes sense when one is using custom mouse
19511     * cursor decorations <b>defined in a theme file</b> , which can
19512     * have, given a cursor name/type, <b>alternate styles</b> on
19513     * it. It works analogously as elm_object_cursor_style_set(), but
19514     * here applied only to genlist item objects.
19515     *
19516     * @warning Before you set a cursor style you should have defined a
19517     *       custom cursor previously on the item, with
19518     *       elm_genlist_item_cursor_set()
19519     *
19520     * @see elm_genlist_item_cursor_engine_only_set()
19521     * @see elm_genlist_item_cursor_style_get()
19522     *
19523     * @ingroup Genlist
19524     */
19525    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19526    /**
19527     * Get the current @b style set for a given genlist item's custom
19528     * cursor
19529     *
19530     * @param item genlist item with custom cursor set.
19531     * @return style the cursor style in use. If the object does not
19532     *         have a cursor set, then @c NULL is returned.
19533     *
19534     * @see elm_genlist_item_cursor_style_set() for more details
19535     *
19536     * @ingroup Genlist
19537     */
19538    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19539    /**
19540     * Set if the (custom) cursor for a given genlist item should be
19541     * searched in its theme, also, or should only rely on the
19542     * rendering engine.
19543     *
19544     * @param item item with custom (custom) cursor already set on
19545     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19546     * only on those provided by the rendering engine, @c EINA_FALSE to
19547     * have them searched on the widget's theme, as well.
19548     *
19549     * @note This call is of use only if you've set a custom cursor
19550     * for genlist items, with elm_genlist_item_cursor_set().
19551     *
19552     * @note By default, cursors will only be looked for between those
19553     * provided by the rendering engine.
19554     *
19555     * @ingroup Genlist
19556     */
19557    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19558    /**
19559     * Get if the (custom) cursor for a given genlist item is being
19560     * searched in its theme, also, or is only relying on the rendering
19561     * engine.
19562     *
19563     * @param item a genlist item
19564     * @return @c EINA_TRUE, if cursors are being looked for only on
19565     * those provided by the rendering engine, @c EINA_FALSE if they
19566     * are being searched on the widget's theme, as well.
19567     *
19568     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19569     *
19570     * @ingroup Genlist
19571     */
19572    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19573    /**
19574     * Update the contents of all realized items.
19575     *
19576     * @param obj The genlist object.
19577     *
19578     * This updates all realized items by calling all the item class functions again
19579     * to get the icons, labels and states. Use this when the original
19580     * item data has changed and the changes are desired to be reflected.
19581     *
19582     * To update just one item, use elm_genlist_item_update().
19583     *
19584     * @see elm_genlist_realized_items_get()
19585     * @see elm_genlist_item_update()
19586     *
19587     * @ingroup Genlist
19588     */
19589    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19590    /**
19591     * Activate a genlist mode on an item
19592     *
19593     * @param item The genlist item
19594     * @param mode Mode name
19595     * @param mode_set Boolean to define set or unset mode.
19596     *
19597     * A genlist mode is a different way of selecting an item. Once a mode is
19598     * activated on an item, any other selected item is immediately unselected.
19599     * This feature provides an easy way of implementing a new kind of animation
19600     * for selecting an item, without having to entirely rewrite the item style
19601     * theme. However, the elm_genlist_selected_* API can't be used to get what
19602     * item is activate for a mode.
19603     *
19604     * The current item style will still be used, but applying a genlist mode to
19605     * an item will select it using a different kind of animation.
19606     *
19607     * The current active item for a mode can be found by
19608     * elm_genlist_mode_item_get().
19609     *
19610     * The characteristics of genlist mode are:
19611     * - Only one mode can be active at any time, and for only one item.
19612     * - Genlist handles deactivating other items when one item is activated.
19613     * - A mode is defined in the genlist theme (edc), and more modes can easily
19614     *   be added.
19615     * - A mode style and the genlist item style are different things. They
19616     *   can be combined to provide a default style to the item, with some kind
19617     *   of animation for that item when the mode is activated.
19618     *
19619     * When a mode is activated on an item, a new view for that item is created.
19620     * The theme of this mode defines the animation that will be used to transit
19621     * the item from the old view to the new view. This second (new) view will be
19622     * active for that item while the mode is active on the item, and will be
19623     * destroyed after the mode is totally deactivated from that item.
19624     *
19625     * @see elm_genlist_mode_get()
19626     * @see elm_genlist_mode_item_get()
19627     *
19628     * @ingroup Genlist
19629     */
19630    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19631    /**
19632     * Get the last (or current) genlist mode used.
19633     *
19634     * @param obj The genlist object
19635     *
19636     * This function just returns the name of the last used genlist mode. It will
19637     * be the current mode if it's still active.
19638     *
19639     * @see elm_genlist_item_mode_set()
19640     * @see elm_genlist_mode_item_get()
19641     *
19642     * @ingroup Genlist
19643     */
19644    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19645    /**
19646     * Get active genlist mode item
19647     *
19648     * @param obj The genlist object
19649     * @return The active item for that current mode. Or @c NULL if no item is
19650     * activated with any mode.
19651     *
19652     * This function returns the item that was activated with a mode, by the
19653     * function elm_genlist_item_mode_set().
19654     *
19655     * @see elm_genlist_item_mode_set()
19656     * @see elm_genlist_mode_get()
19657     *
19658     * @ingroup Genlist
19659     */
19660    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19661
19662    /**
19663     * Set reorder mode
19664     *
19665     * @param obj The genlist object
19666     * @param reorder_mode The reorder mode
19667     * (EINA_TRUE = on, EINA_FALSE = off)
19668     *
19669     * @ingroup Genlist
19670     */
19671    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19672
19673    /**
19674     * Get the reorder mode
19675     *
19676     * @param obj The genlist object
19677     * @return The reorder mode
19678     * (EINA_TRUE = on, EINA_FALSE = off)
19679     *
19680     * @ingroup Genlist
19681     */
19682    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19683
19684    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19685    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19686    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19687    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19688    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19689    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19690    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19691    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19692    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19693    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19694
19695    /**
19696     * @}
19697     */
19698
19699    /**
19700     * @defgroup Check Check
19701     *
19702     * @image html img/widget/check/preview-00.png
19703     * @image latex img/widget/check/preview-00.eps
19704     * @image html img/widget/check/preview-01.png
19705     * @image latex img/widget/check/preview-01.eps
19706     * @image html img/widget/check/preview-02.png
19707     * @image latex img/widget/check/preview-02.eps
19708     *
19709     * @brief The check widget allows for toggling a value between true and
19710     * false.
19711     *
19712     * Check objects are a lot like radio objects in layout and functionality
19713     * except they do not work as a group, but independently and only toggle the
19714     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19715     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19716     * returns the current state. For convenience, like the radio objects, you
19717     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19718     * for it to modify.
19719     *
19720     * Signals that you can add callbacks for are:
19721     * "changed" - This is called whenever the user changes the state of one of
19722     *             the check object(event_info is NULL).
19723     *
19724     * Default contents parts of the check widget that you can use for are:
19725     * @li "icon" - A icon of the check
19726     *
19727     * Default text parts of the check widget that you can use for are:
19728     * @li "elm.text" - Label of the check
19729     *
19730     * @ref tutorial_check should give you a firm grasp of how to use this widget
19731     * .
19732     * @{
19733     */
19734    /**
19735     * @brief Add a new Check object
19736     *
19737     * @param parent The parent object
19738     * @return The new object or NULL if it cannot be created
19739     */
19740    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19741    /**
19742     * @brief Set the text label of the check object
19743     *
19744     * @param obj The check object
19745     * @param label The text label string in UTF-8
19746     *
19747     * @deprecated use elm_object_text_set() instead.
19748     */
19749    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19750    /**
19751     * @brief Get the text label of the check object
19752     *
19753     * @param obj The check object
19754     * @return The text label string in UTF-8
19755     *
19756     * @deprecated use elm_object_text_get() instead.
19757     */
19758    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19759    /**
19760     * @brief Set the icon object of the check object
19761     *
19762     * @param obj The check object
19763     * @param icon The icon object
19764     *
19765     * Once the icon object is set, a previously set one will be deleted.
19766     * If you want to keep that old content object, use the
19767     * elm_object_content_unset() function.
19768     *
19769     * @deprecated use elm_object_part_content_set() instead.
19770     *
19771     */
19772    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19773    /**
19774     * @brief Get the icon object of the check object
19775     *
19776     * @param obj The check object
19777     * @return The icon object
19778     *
19779     * @deprecated use elm_object_part_content_get() instead.
19780     *  
19781     */
19782    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19783    /**
19784     * @brief Unset the icon used for the check object
19785     *
19786     * @param obj The check object
19787     * @return The icon object that was being used
19788     *
19789     * Unparent and return the icon object which was set for this widget.
19790     *
19791     * @deprecated use elm_object_part_content_unset() instead.
19792     *
19793     */
19794    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19795    /**
19796     * @brief Set the on/off state of the check object
19797     *
19798     * @param obj The check object
19799     * @param state The state to use (1 == on, 0 == off)
19800     *
19801     * This sets the state of the check. If set
19802     * with elm_check_state_pointer_set() the state of that variable is also
19803     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19804     */
19805    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19806    /**
19807     * @brief Get the state of the check object
19808     *
19809     * @param obj The check object
19810     * @return The boolean state
19811     */
19812    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19813    /**
19814     * @brief Set a convenience pointer to a boolean to change
19815     *
19816     * @param obj The check object
19817     * @param statep Pointer to the boolean to modify
19818     *
19819     * This sets a pointer to a boolean, that, in addition to the check objects
19820     * state will also be modified directly. To stop setting the object pointed
19821     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19822     * then when this is called, the check objects state will also be modified to
19823     * reflect the value of the boolean @p statep points to, just like calling
19824     * elm_check_state_set().
19825     */
19826    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19827    /**
19828     * @}
19829     */
19830
19831    /* compatibility code for toggle controls */
19832
19833    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
19834      {
19835         Evas_Object *obj;
19836
19837         obj = elm_check_add(parent);
19838         elm_object_style_set(obj, "toggle");
19839         elm_object_part_text_set(obj, "on", "ON");
19840         elm_object_part_text_set(obj, "off", "OFF");
19841         return obj;
19842      }
19843
19844    EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
19845      {
19846         elm_object_text_set(obj, label);
19847      }
19848
19849    EINA_DEPRECATED EAPI extern inline const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19850      {
19851         return elm_object_text_get(obj);
19852      }
19853
19854    EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
19855      {
19856         elm_object_content_set(obj, icon);
19857      }
19858
19859    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19860      {
19861         return elm_object_content_get(obj);
19862      }
19863
19864    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
19865      {
19866         return elm_object_content_unset(obj);
19867      }
19868
19869    EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
19870      {
19871         elm_object_part_text_set(obj, "on", onlabel);
19872         elm_object_part_text_set(obj, "off", offlabel);
19873      }
19874
19875    EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1)
19876      {
19877         if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
19878         if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
19879      }
19880
19881    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
19882      {
19883         elm_check_state_set(obj, state);
19884      }
19885
19886    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19887      {
19888         return elm_check_state_get(obj);
19889      }
19890
19891    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
19892      {
19893         elm_check_state_pointer_set(obj, statep);
19894      }
19895
19896    /**
19897     * @defgroup Radio Radio
19898     *
19899     * @image html img/widget/radio/preview-00.png
19900     * @image latex img/widget/radio/preview-00.eps
19901     *
19902     * @brief Radio is a widget that allows for 1 or more options to be displayed
19903     * and have the user choose only 1 of them.
19904     *
19905     * A radio object contains an indicator, an optional Label and an optional
19906     * icon object. While it's possible to have a group of only one radio they,
19907     * are normally used in groups of 2 or more. To add a radio to a group use
19908     * elm_radio_group_add(). The radio object(s) will select from one of a set
19909     * of integer values, so any value they are configuring needs to be mapped to
19910     * a set of integers. To configure what value that radio object represents,
19911     * use  elm_radio_state_value_set() to set the integer it represents. To set
19912     * the value the whole group(which one is currently selected) is to indicate
19913     * use elm_radio_value_set() on any group member, and to get the groups value
19914     * use elm_radio_value_get(). For convenience the radio objects are also able
19915     * to directly set an integer(int) to the value that is selected. To specify
19916     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19917     * The radio objects will modify this directly. That implies the pointer must
19918     * point to valid memory for as long as the radio objects exist.
19919     *
19920     * Signals that you can add callbacks for are:
19921     * @li changed - This is called whenever the user changes the state of one of
19922     * the radio objects within the group of radio objects that work together.
19923     *
19924     * Default contents parts of the radio widget that you can use for are:
19925     * @li "icon" - A icon of the radio
19926     *
19927     * @ref tutorial_radio show most of this API in action.
19928     * @{
19929     */
19930    /**
19931     * @brief Add a new radio to the parent
19932     *
19933     * @param parent The parent object
19934     * @return The new object or NULL if it cannot be created
19935     */
19936    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19937    /**
19938     * @brief Set the text label of the radio object
19939     *
19940     * @param obj The radio object
19941     * @param label The text label string in UTF-8
19942     *
19943     * @deprecated use elm_object_text_set() instead.
19944     */
19945    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19946    /**
19947     * @brief Get the text label of the radio object
19948     *
19949     * @param obj The radio object
19950     * @return The text label string in UTF-8
19951     *
19952     * @deprecated use elm_object_text_set() instead.
19953     */
19954    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19955    /**
19956     * @brief Set the icon object of the radio object
19957     *
19958     * @param obj The radio object
19959     * @param icon The icon object
19960     *
19961     * Once the icon object is set, a previously set one will be deleted. If you
19962     * want to keep that old content object, use the elm_radio_icon_unset()
19963     * function.
19964     *
19965     * @deprecated use elm_object_part_content_set() instead.
19966     *
19967     */
19968    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19969    /**
19970     * @brief Get the icon object of the radio object
19971     *
19972     * @param obj The radio object
19973     * @return The icon object
19974     *
19975     * @see elm_radio_icon_set()
19976     *
19977     * @deprecated use elm_object_part_content_get() instead.
19978     *
19979     */
19980    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19981    /**
19982     * @brief Unset the icon used for the radio object
19983     *
19984     * @param obj The radio object
19985     * @return The icon object that was being used
19986     *
19987     * Unparent and return the icon object which was set for this widget.
19988     *
19989     * @see elm_radio_icon_set()
19990     * @deprecated use elm_object_part_content_unset() instead.
19991     *
19992     */
19993    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19994    /**
19995     * @brief Add this radio to a group of other radio objects
19996     *
19997     * @param obj The radio object
19998     * @param group Any object whose group the @p obj is to join.
19999     *
20000     * Radio objects work in groups. Each member should have a different integer
20001     * value assigned. In order to have them work as a group, they need to know
20002     * about each other. This adds the given radio object to the group of which
20003     * the group object indicated is a member.
20004     */
20005    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20006    /**
20007     * @brief Set the integer value that this radio object represents
20008     *
20009     * @param obj The radio object
20010     * @param value The value to use if this radio object is selected
20011     *
20012     * This sets the value of the radio.
20013     */
20014    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20015    /**
20016     * @brief Get the integer value that this radio object represents
20017     *
20018     * @param obj The radio object
20019     * @return The value used if this radio object is selected
20020     *
20021     * This gets the value of the radio.
20022     *
20023     * @see elm_radio_value_set()
20024     */
20025    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20026    /**
20027     * @brief Set the value of the radio.
20028     *
20029     * @param obj The radio object
20030     * @param value The value to use for the group
20031     *
20032     * This sets the value of the radio group and will also set the value if
20033     * pointed to, to the value supplied, but will not call any callbacks.
20034     */
20035    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20036    /**
20037     * @brief Get the state of the radio object
20038     *
20039     * @param obj The radio object
20040     * @return The integer state
20041     */
20042    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20043    /**
20044     * @brief Set a convenience pointer to a integer to change
20045     *
20046     * @param obj The radio object
20047     * @param valuep Pointer to the integer to modify
20048     *
20049     * This sets a pointer to a integer, that, in addition to the radio objects
20050     * state will also be modified directly. To stop setting the object pointed
20051     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20052     * when this is called, the radio objects state will also be modified to
20053     * reflect the value of the integer valuep points to, just like calling
20054     * elm_radio_value_set().
20055     */
20056    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20057    /**
20058     * @}
20059     */
20060
20061    /**
20062     * @defgroup Pager Pager
20063     *
20064     * @image html img/widget/pager/preview-00.png
20065     * @image latex img/widget/pager/preview-00.eps
20066     *
20067     * @brief Widget that allows flipping between 1 or more “pages” of objects.
20068     *
20069     * The flipping between “pages” of objects is animated. All content in pager
20070     * is kept in a stack, the last content to be added will be on the top of the
20071     * stack(be visible).
20072     *
20073     * Objects can be pushed or popped from the stack or deleted as normal.
20074     * Pushes and pops will animate (and a pop will delete the object once the
20075     * animation is finished). Any object already in the pager can be promoted to
20076     * the top(from its current stacking position) through the use of
20077     * elm_pager_content_promote(). Objects are pushed to the top with
20078     * elm_pager_content_push() and when the top item is no longer wanted, simply
20079     * pop it with elm_pager_content_pop() and it will also be deleted. If an
20080     * object is no longer needed and is not the top item, just delete it as
20081     * normal. You can query which objects are the top and bottom with
20082     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20083     *
20084     * Signals that you can add callbacks for are:
20085     * "hide,finished" - when the previous page is hided
20086     *
20087     * This widget has the following styles available:
20088     * @li default
20089     * @li fade
20090     * @li fade_translucide
20091     * @li fade_invisible
20092     * @note This styles affect only the flipping animations, the appearance when
20093     * not animating is unaffected by styles.
20094     *
20095     * @ref tutorial_pager gives a good overview of the usage of the API.
20096     * @{
20097     */
20098    /**
20099     * Add a new pager to the parent
20100     *
20101     * @param parent The parent object
20102     * @return The new object or NULL if it cannot be created
20103     *
20104     * @ingroup Pager
20105     */
20106    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20107    /**
20108     * @brief Push an object to the top of the pager stack (and show it).
20109     *
20110     * @param obj The pager object
20111     * @param content The object to push
20112     *
20113     * The object pushed becomes a child of the pager, it will be controlled and
20114     * deleted when the pager is deleted.
20115     *
20116     * @note If the content is already in the stack use
20117     * elm_pager_content_promote().
20118     * @warning Using this function on @p content already in the stack results in
20119     * undefined behavior.
20120     */
20121    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20122    /**
20123     * @brief Pop the object that is on top of the stack
20124     *
20125     * @param obj The pager object
20126     *
20127     * This pops the object that is on the top(visible) of the pager, makes it
20128     * disappear, then deletes the object. The object that was underneath it on
20129     * the stack will become visible.
20130     */
20131    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20132    /**
20133     * @brief Moves an object already in the pager stack to the top of the stack.
20134     *
20135     * @param obj The pager object
20136     * @param content The object to promote
20137     *
20138     * This will take the @p content and move it to the top of the stack as
20139     * if it had been pushed there.
20140     *
20141     * @note If the content isn't already in the stack use
20142     * elm_pager_content_push().
20143     * @warning Using this function on @p content not already in the stack
20144     * results in undefined behavior.
20145     */
20146    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20147    /**
20148     * @brief Return the object at the bottom of the pager stack
20149     *
20150     * @param obj The pager object
20151     * @return The bottom object or NULL if none
20152     */
20153    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20154    /**
20155     * @brief  Return the object at the top of the pager stack
20156     *
20157     * @param obj The pager object
20158     * @return The top object or NULL if none
20159     */
20160    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20161
20162    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20163    EINA_DEPRECATED    EAPI void         elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20164
20165    /**
20166     * @}
20167     */
20168
20169    /**
20170     * @defgroup Slideshow Slideshow
20171     *
20172     * @image html img/widget/slideshow/preview-00.png
20173     * @image latex img/widget/slideshow/preview-00.eps
20174     *
20175     * This widget, as the name indicates, is a pre-made image
20176     * slideshow panel, with API functions acting on (child) image
20177     * items presentation. Between those actions, are:
20178     * - advance to next/previous image
20179     * - select the style of image transition animation
20180     * - set the exhibition time for each image
20181     * - start/stop the slideshow
20182     *
20183     * The transition animations are defined in the widget's theme,
20184     * consequently new animations can be added without having to
20185     * update the widget's code.
20186     *
20187     * @section Slideshow_Items Slideshow items
20188     *
20189     * For slideshow items, just like for @ref Genlist "genlist" ones,
20190     * the user defines a @b classes, specifying functions that will be
20191     * called on the item's creation and deletion times.
20192     *
20193     * The #Elm_Slideshow_Item_Class structure contains the following
20194     * members:
20195     *
20196     * - @c func.get - When an item is displayed, this function is
20197     *   called, and it's where one should create the item object, de
20198     *   facto. For example, the object can be a pure Evas image object
20199     *   or an Elementary @ref Photocam "photocam" widget. See
20200     *   #SlideshowItemGetFunc.
20201     * - @c func.del - When an item is no more displayed, this function
20202     *   is called, where the user must delete any data associated to
20203     *   the item. See #SlideshowItemDelFunc.
20204     *
20205     * @section Slideshow_Caching Slideshow caching
20206     *
20207     * The slideshow provides facilities to have items adjacent to the
20208     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20209     * you, so that the system does not have to decode image data
20210     * anymore at the time it has to actually switch images on its
20211     * viewport. The user is able to set the numbers of items to be
20212     * cached @b before and @b after the current item, in the widget's
20213     * item list.
20214     *
20215     * Smart events one can add callbacks for are:
20216     *
20217     * - @c "changed" - when the slideshow switches its view to a new
20218     *   item
20219     *
20220     * List of examples for the slideshow widget:
20221     * @li @ref slideshow_example
20222     */
20223
20224    /**
20225     * @addtogroup Slideshow
20226     * @{
20227     */
20228
20229    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20230    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20231    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20232    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20233    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20234
20235    /**
20236     * @struct _Elm_Slideshow_Item_Class
20237     *
20238     * Slideshow item class definition. See @ref Slideshow_Items for
20239     * field details.
20240     */
20241    struct _Elm_Slideshow_Item_Class
20242      {
20243         struct _Elm_Slideshow_Item_Class_Func
20244           {
20245              SlideshowItemGetFunc get;
20246              SlideshowItemDelFunc del;
20247           } func;
20248      }; /**< #Elm_Slideshow_Item_Class member definitions */
20249
20250    /**
20251     * Add a new slideshow widget to the given parent Elementary
20252     * (container) object
20253     *
20254     * @param parent The parent object
20255     * @return A new slideshow widget handle or @c NULL, on errors
20256     *
20257     * This function inserts a new slideshow widget on the canvas.
20258     *
20259     * @ingroup Slideshow
20260     */
20261    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20262
20263    /**
20264     * Add (append) a new item in a given slideshow widget.
20265     *
20266     * @param obj The slideshow object
20267     * @param itc The item class for the item
20268     * @param data The item's data
20269     * @return A handle to the item added or @c NULL, on errors
20270     *
20271     * Add a new item to @p obj's internal list of items, appending it.
20272     * The item's class must contain the function really fetching the
20273     * image object to show for this item, which could be an Evas image
20274     * object or an Elementary photo, for example. The @p data
20275     * parameter is going to be passed to both class functions of the
20276     * item.
20277     *
20278     * @see #Elm_Slideshow_Item_Class
20279     * @see elm_slideshow_item_sorted_insert()
20280     *
20281     * @ingroup Slideshow
20282     */
20283    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20284
20285    /**
20286     * Insert a new item into the given slideshow widget, using the @p func
20287     * function to sort items (by item handles).
20288     *
20289     * @param obj The slideshow object
20290     * @param itc The item class for the item
20291     * @param data The item's data
20292     * @param func The comparing function to be used to sort slideshow
20293     * items <b>by #Elm_Slideshow_Item item handles</b>
20294     * @return Returns The slideshow item handle, on success, or
20295     * @c NULL, on errors
20296     *
20297     * Add a new item to @p obj's internal list of items, in a position
20298     * determined by the @p func comparing function. The item's class
20299     * must contain the function really fetching the image object to
20300     * show for this item, which could be an Evas image object or an
20301     * Elementary photo, for example. The @p data parameter is going to
20302     * be passed to both class functions of the item.
20303     *
20304     * @see #Elm_Slideshow_Item_Class
20305     * @see elm_slideshow_item_add()
20306     *
20307     * @ingroup Slideshow
20308     */
20309    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);
20310
20311    /**
20312     * Display a given slideshow widget's item, programmatically.
20313     *
20314     * @param obj The slideshow object
20315     * @param item The item to display on @p obj's viewport
20316     *
20317     * The change between the current item and @p item will use the
20318     * transition @p obj is set to use (@see
20319     * elm_slideshow_transition_set()).
20320     *
20321     * @ingroup Slideshow
20322     */
20323    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20324
20325    /**
20326     * Slide to the @b next item, in a given slideshow widget
20327     *
20328     * @param obj The slideshow object
20329     *
20330     * The sliding animation @p obj is set to use will be the
20331     * transition effect used, after this call is issued.
20332     *
20333     * @note If the end of the slideshow's internal list of items is
20334     * reached, it'll wrap around to the list's beginning, again.
20335     *
20336     * @ingroup Slideshow
20337     */
20338    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20339
20340    /**
20341     * Slide to the @b previous item, in a given slideshow widget
20342     *
20343     * @param obj The slideshow object
20344     *
20345     * The sliding animation @p obj is set to use will be the
20346     * transition effect used, after this call is issued.
20347     *
20348     * @note If the beginning of the slideshow's internal list of items
20349     * is reached, it'll wrap around to the list's end, again.
20350     *
20351     * @ingroup Slideshow
20352     */
20353    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20354
20355    /**
20356     * Returns the list of sliding transition/effect names available, for a
20357     * given slideshow widget.
20358     *
20359     * @param obj The slideshow object
20360     * @return The list of transitions (list of @b stringshared strings
20361     * as data)
20362     *
20363     * The transitions, which come from @p obj's theme, must be an EDC
20364     * data item named @c "transitions" on the theme file, with (prefix)
20365     * names of EDC programs actually implementing them.
20366     *
20367     * The available transitions for slideshows on the default theme are:
20368     * - @c "fade" - the current item fades out, while the new one
20369     *   fades in to the slideshow's viewport.
20370     * - @c "black_fade" - the current item fades to black, and just
20371     *   then, the new item will fade in.
20372     * - @c "horizontal" - the current item slides horizontally, until
20373     *   it gets out of the slideshow's viewport, while the new item
20374     *   comes from the left to take its place.
20375     * - @c "vertical" - the current item slides vertically, until it
20376     *   gets out of the slideshow's viewport, while the new item comes
20377     *   from the bottom to take its place.
20378     * - @c "square" - the new item starts to appear from the middle of
20379     *   the current one, but with a tiny size, growing until its
20380     *   target (full) size and covering the old one.
20381     *
20382     * @warning The stringshared strings get no new references
20383     * exclusive to the user grabbing the list, here, so if you'd like
20384     * to use them out of this call's context, you'd better @c
20385     * eina_stringshare_ref() them.
20386     *
20387     * @see elm_slideshow_transition_set()
20388     *
20389     * @ingroup Slideshow
20390     */
20391    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20392
20393    /**
20394     * Set the current slide transition/effect in use for a given
20395     * slideshow widget
20396     *
20397     * @param obj The slideshow object
20398     * @param transition The new transition's name string
20399     *
20400     * If @p transition is implemented in @p obj's theme (i.e., is
20401     * contained in the list returned by
20402     * elm_slideshow_transitions_get()), this new sliding effect will
20403     * be used on the widget.
20404     *
20405     * @see elm_slideshow_transitions_get() for more details
20406     *
20407     * @ingroup Slideshow
20408     */
20409    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20410
20411    /**
20412     * Get the current slide transition/effect in use for a given
20413     * slideshow widget
20414     *
20415     * @param obj The slideshow object
20416     * @return The current transition's name
20417     *
20418     * @see elm_slideshow_transition_set() for more details
20419     *
20420     * @ingroup Slideshow
20421     */
20422    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20423
20424    /**
20425     * Set the interval between each image transition on a given
20426     * slideshow widget, <b>and start the slideshow, itself</b>
20427     *
20428     * @param obj The slideshow object
20429     * @param timeout The new displaying timeout for images
20430     *
20431     * After this call, the slideshow widget will start cycling its
20432     * view, sequentially and automatically, with the images of the
20433     * items it has. The time between each new image displayed is going
20434     * to be @p timeout, in @b seconds. If a different timeout was set
20435     * previously and an slideshow was in progress, it will continue
20436     * with the new time between transitions, after this call.
20437     *
20438     * @note A value less than or equal to 0 on @p timeout will disable
20439     * the widget's internal timer, thus halting any slideshow which
20440     * could be happening on @p obj.
20441     *
20442     * @see elm_slideshow_timeout_get()
20443     *
20444     * @ingroup Slideshow
20445     */
20446    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20447
20448    /**
20449     * Get the interval set for image transitions on a given slideshow
20450     * widget.
20451     *
20452     * @param obj The slideshow object
20453     * @return Returns the timeout set on it
20454     *
20455     * @see elm_slideshow_timeout_set() for more details
20456     *
20457     * @ingroup Slideshow
20458     */
20459    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20460
20461    /**
20462     * Set if, after a slideshow is started, for a given slideshow
20463     * widget, its items should be displayed cyclically or not.
20464     *
20465     * @param obj The slideshow object
20466     * @param loop Use @c EINA_TRUE to make it cycle through items or
20467     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20468     * list of items
20469     *
20470     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20471     * ignore what is set by this functions, i.e., they'll @b always
20472     * cycle through items. This affects only the "automatic"
20473     * slideshow, as set by elm_slideshow_timeout_set().
20474     *
20475     * @see elm_slideshow_loop_get()
20476     *
20477     * @ingroup Slideshow
20478     */
20479    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20480
20481    /**
20482     * Get if, after a slideshow is started, for a given slideshow
20483     * widget, its items are to be displayed cyclically or not.
20484     *
20485     * @param obj The slideshow object
20486     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20487     * through or @c EINA_FALSE, otherwise
20488     *
20489     * @see elm_slideshow_loop_set() for more details
20490     *
20491     * @ingroup Slideshow
20492     */
20493    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20494
20495    /**
20496     * Remove all items from a given slideshow widget
20497     *
20498     * @param obj The slideshow object
20499     *
20500     * This removes (and deletes) all items in @p obj, leaving it
20501     * empty.
20502     *
20503     * @see elm_slideshow_item_del(), to remove just one item.
20504     *
20505     * @ingroup Slideshow
20506     */
20507    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20508
20509    /**
20510     * Get the internal list of items in a given slideshow widget.
20511     *
20512     * @param obj The slideshow object
20513     * @return The list of items (#Elm_Slideshow_Item as data) or
20514     * @c NULL on errors.
20515     *
20516     * This list is @b not to be modified in any way and must not be
20517     * freed. Use the list members with functions like
20518     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20519     *
20520     * @warning This list is only valid until @p obj object's internal
20521     * items list is changed. It should be fetched again with another
20522     * call to this function when changes happen.
20523     *
20524     * @ingroup Slideshow
20525     */
20526    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20527
20528    /**
20529     * Delete a given item from a slideshow widget.
20530     *
20531     * @param item The slideshow item
20532     *
20533     * @ingroup Slideshow
20534     */
20535    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20536
20537    /**
20538     * Return the data associated with a given slideshow item
20539     *
20540     * @param item The slideshow item
20541     * @return Returns the data associated to this item
20542     *
20543     * @ingroup Slideshow
20544     */
20545    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20546
20547    /**
20548     * Returns the currently displayed item, in a given slideshow widget
20549     *
20550     * @param obj The slideshow object
20551     * @return A handle to the item being displayed in @p obj or
20552     * @c NULL, if none is (and on errors)
20553     *
20554     * @ingroup Slideshow
20555     */
20556    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20557
20558    /**
20559     * Get the real Evas object created to implement the view of a
20560     * given slideshow item
20561     *
20562     * @param item The slideshow item.
20563     * @return the Evas object implementing this item's view.
20564     *
20565     * This returns the actual Evas object used to implement the
20566     * specified slideshow item's view. This may be @c NULL, as it may
20567     * not have been created or may have been deleted, at any time, by
20568     * the slideshow. <b>Do not modify this object</b> (move, resize,
20569     * show, hide, etc.), as the slideshow is controlling it. This
20570     * function is for querying, emitting custom signals or hooking
20571     * lower level callbacks for events on that object. Do not delete
20572     * this object under any circumstances.
20573     *
20574     * @see elm_slideshow_item_data_get()
20575     *
20576     * @ingroup Slideshow
20577     */
20578    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20579
20580    /**
20581     * Get the the item, in a given slideshow widget, placed at
20582     * position @p nth, in its internal items list
20583     *
20584     * @param obj The slideshow object
20585     * @param nth The number of the item to grab a handle to (0 being
20586     * the first)
20587     * @return The item stored in @p obj at position @p nth or @c NULL,
20588     * if there's no item with that index (and on errors)
20589     *
20590     * @ingroup Slideshow
20591     */
20592    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20593
20594    /**
20595     * Set the current slide layout in use for a given slideshow widget
20596     *
20597     * @param obj The slideshow object
20598     * @param layout The new layout's name string
20599     *
20600     * If @p layout is implemented in @p obj's theme (i.e., is contained
20601     * in the list returned by elm_slideshow_layouts_get()), this new
20602     * images layout will be used on the widget.
20603     *
20604     * @see elm_slideshow_layouts_get() for more details
20605     *
20606     * @ingroup Slideshow
20607     */
20608    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20609
20610    /**
20611     * Get the current slide layout in use for a given slideshow widget
20612     *
20613     * @param obj The slideshow object
20614     * @return The current layout's name
20615     *
20616     * @see elm_slideshow_layout_set() for more details
20617     *
20618     * @ingroup Slideshow
20619     */
20620    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20621
20622    /**
20623     * Returns the list of @b layout names available, for a given
20624     * slideshow widget.
20625     *
20626     * @param obj The slideshow object
20627     * @return The list of layouts (list of @b stringshared strings
20628     * as data)
20629     *
20630     * Slideshow layouts will change how the widget is to dispose each
20631     * image item in its viewport, with regard to cropping, scaling,
20632     * etc.
20633     *
20634     * The layouts, which come from @p obj's theme, must be an EDC
20635     * data item name @c "layouts" on the theme file, with (prefix)
20636     * names of EDC programs actually implementing them.
20637     *
20638     * The available layouts for slideshows on the default theme are:
20639     * - @c "fullscreen" - item images with original aspect, scaled to
20640     *   touch top and down slideshow borders or, if the image's heigh
20641     *   is not enough, left and right slideshow borders.
20642     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20643     *   one, but always leaving 10% of the slideshow's dimensions of
20644     *   distance between the item image's borders and the slideshow
20645     *   borders, for each axis.
20646     *
20647     * @warning The stringshared strings get no new references
20648     * exclusive to the user grabbing the list, here, so if you'd like
20649     * to use them out of this call's context, you'd better @c
20650     * eina_stringshare_ref() them.
20651     *
20652     * @see elm_slideshow_layout_set()
20653     *
20654     * @ingroup Slideshow
20655     */
20656    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20657
20658    /**
20659     * Set the number of items to cache, on a given slideshow widget,
20660     * <b>before the current item</b>
20661     *
20662     * @param obj The slideshow object
20663     * @param count Number of items to cache before the current one
20664     *
20665     * The default value for this property is @c 2. See
20666     * @ref Slideshow_Caching "slideshow caching" for more details.
20667     *
20668     * @see elm_slideshow_cache_before_get()
20669     *
20670     * @ingroup Slideshow
20671     */
20672    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20673
20674    /**
20675     * Retrieve the number of items to cache, on a given slideshow widget,
20676     * <b>before the current item</b>
20677     *
20678     * @param obj The slideshow object
20679     * @return The number of items set to be cached before the current one
20680     *
20681     * @see elm_slideshow_cache_before_set() for more details
20682     *
20683     * @ingroup Slideshow
20684     */
20685    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20686
20687    /**
20688     * Set the number of items to cache, on a given slideshow widget,
20689     * <b>after the current item</b>
20690     *
20691     * @param obj The slideshow object
20692     * @param count Number of items to cache after the current one
20693     *
20694     * The default value for this property is @c 2. See
20695     * @ref Slideshow_Caching "slideshow caching" for more details.
20696     *
20697     * @see elm_slideshow_cache_after_get()
20698     *
20699     * @ingroup Slideshow
20700     */
20701    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20702
20703    /**
20704     * Retrieve the number of items to cache, on a given slideshow widget,
20705     * <b>after the current item</b>
20706     *
20707     * @param obj The slideshow object
20708     * @return The number of items set to be cached after the current one
20709     *
20710     * @see elm_slideshow_cache_after_set() for more details
20711     *
20712     * @ingroup Slideshow
20713     */
20714    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20715
20716    /**
20717     * Get the number of items stored in a given slideshow widget
20718     *
20719     * @param obj The slideshow object
20720     * @return The number of items on @p obj, at the moment of this call
20721     *
20722     * @ingroup Slideshow
20723     */
20724    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20725
20726    /**
20727     * @}
20728     */
20729
20730    /**
20731     * @defgroup Fileselector File Selector
20732     *
20733     * @image html img/widget/fileselector/preview-00.png
20734     * @image latex img/widget/fileselector/preview-00.eps
20735     *
20736     * A file selector is a widget that allows a user to navigate
20737     * through a file system, reporting file selections back via its
20738     * API.
20739     *
20740     * It contains shortcut buttons for home directory (@c ~) and to
20741     * jump one directory upwards (..), as well as cancel/ok buttons to
20742     * confirm/cancel a given selection. After either one of those two
20743     * former actions, the file selector will issue its @c "done" smart
20744     * callback.
20745     *
20746     * There's a text entry on it, too, showing the name of the current
20747     * selection. There's the possibility of making it editable, so it
20748     * is useful on file saving dialogs on applications, where one
20749     * gives a file name to save contents to, in a given directory in
20750     * the system. This custom file name will be reported on the @c
20751     * "done" smart callback (explained in sequence).
20752     *
20753     * Finally, it has a view to display file system items into in two
20754     * possible forms:
20755     * - list
20756     * - grid
20757     *
20758     * If Elementary is built with support of the Ethumb thumbnailing
20759     * library, the second form of view will display preview thumbnails
20760     * of files which it supports.
20761     *
20762     * Smart callbacks one can register to:
20763     *
20764     * - @c "selected" - the user has clicked on a file (when not in
20765     *      folders-only mode) or directory (when in folders-only mode)
20766     * - @c "directory,open" - the list has been populated with new
20767     *      content (@c event_info is a pointer to the directory's
20768     *      path, a @b stringshared string)
20769     * - @c "done" - the user has clicked on the "ok" or "cancel"
20770     *      buttons (@c event_info is a pointer to the selection's
20771     *      path, a @b stringshared string)
20772     *
20773     * Here is an example on its usage:
20774     * @li @ref fileselector_example
20775     */
20776
20777    /**
20778     * @addtogroup Fileselector
20779     * @{
20780     */
20781
20782    /**
20783     * Defines how a file selector widget is to layout its contents
20784     * (file system entries).
20785     */
20786    typedef enum _Elm_Fileselector_Mode
20787      {
20788         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20789         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20790         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20791      } Elm_Fileselector_Mode;
20792
20793    /**
20794     * Add a new file selector widget to the given parent Elementary
20795     * (container) object
20796     *
20797     * @param parent The parent object
20798     * @return a new file selector widget handle or @c NULL, on errors
20799     *
20800     * This function inserts a new file selector widget on the canvas.
20801     *
20802     * @ingroup Fileselector
20803     */
20804    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20805
20806    /**
20807     * Enable/disable the file name entry box where the user can type
20808     * in a name for a file, in a given file selector widget
20809     *
20810     * @param obj The file selector object
20811     * @param is_save @c EINA_TRUE to make the file selector a "saving
20812     * dialog", @c EINA_FALSE otherwise
20813     *
20814     * Having the entry editable is useful on file saving dialogs on
20815     * applications, where one gives a file name to save contents to,
20816     * in a given directory in the system. This custom file name will
20817     * be reported on the @c "done" smart callback.
20818     *
20819     * @see elm_fileselector_is_save_get()
20820     *
20821     * @ingroup Fileselector
20822     */
20823    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20824
20825    /**
20826     * Get whether the given file selector is in "saving dialog" mode
20827     *
20828     * @param obj The file selector object
20829     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20830     * mode, @c EINA_FALSE otherwise (and on errors)
20831     *
20832     * @see elm_fileselector_is_save_set() for more details
20833     *
20834     * @ingroup Fileselector
20835     */
20836    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20837
20838    /**
20839     * Enable/disable folder-only view for a given file selector widget
20840     *
20841     * @param obj The file selector object
20842     * @param only @c EINA_TRUE to make @p obj only display
20843     * directories, @c EINA_FALSE to make files to be displayed in it
20844     * too
20845     *
20846     * If enabled, the widget's view will only display folder items,
20847     * naturally.
20848     *
20849     * @see elm_fileselector_folder_only_get()
20850     *
20851     * @ingroup Fileselector
20852     */
20853    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20854
20855    /**
20856     * Get whether folder-only view is set for a given file selector
20857     * widget
20858     *
20859     * @param obj The file selector object
20860     * @return only @c EINA_TRUE if @p obj is only displaying
20861     * directories, @c EINA_FALSE if files are being displayed in it
20862     * too (and on errors)
20863     *
20864     * @see elm_fileselector_folder_only_get()
20865     *
20866     * @ingroup Fileselector
20867     */
20868    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20869
20870    /**
20871     * Enable/disable the "ok" and "cancel" buttons on a given file
20872     * selector widget
20873     *
20874     * @param obj The file selector object
20875     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20876     *
20877     * @note A file selector without those buttons will never emit the
20878     * @c "done" smart event, and is only usable if one is just hooking
20879     * to the other two events.
20880     *
20881     * @see elm_fileselector_buttons_ok_cancel_get()
20882     *
20883     * @ingroup Fileselector
20884     */
20885    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20886
20887    /**
20888     * Get whether the "ok" and "cancel" buttons on a given file
20889     * selector widget are being shown.
20890     *
20891     * @param obj The file selector object
20892     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20893     * otherwise (and on errors)
20894     *
20895     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20896     *
20897     * @ingroup Fileselector
20898     */
20899    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20900
20901    /**
20902     * Enable/disable a tree view in the given file selector widget,
20903     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20904     *
20905     * @param obj The file selector object
20906     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20907     * disable
20908     *
20909     * In a tree view, arrows are created on the sides of directories,
20910     * allowing them to expand in place.
20911     *
20912     * @note If it's in other mode, the changes made by this function
20913     * will only be visible when one switches back to "list" mode.
20914     *
20915     * @see elm_fileselector_expandable_get()
20916     *
20917     * @ingroup Fileselector
20918     */
20919    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20920
20921    /**
20922     * Get whether tree view is enabled for the given file selector
20923     * widget
20924     *
20925     * @param obj The file selector object
20926     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20927     * otherwise (and or errors)
20928     *
20929     * @see elm_fileselector_expandable_set() for more details
20930     *
20931     * @ingroup Fileselector
20932     */
20933    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20934
20935    /**
20936     * Set, programmatically, the @b directory that a given file
20937     * selector widget will display contents from
20938     *
20939     * @param obj The file selector object
20940     * @param path The path to display in @p obj
20941     *
20942     * This will change the @b directory that @p obj is displaying. It
20943     * will also clear the text entry area on the @p obj object, which
20944     * displays select files' names.
20945     *
20946     * @see elm_fileselector_path_get()
20947     *
20948     * @ingroup Fileselector
20949     */
20950    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20951
20952    /**
20953     * Get the parent directory's path that a given file selector
20954     * widget is displaying
20955     *
20956     * @param obj The file selector object
20957     * @return The (full) path of the directory the file selector is
20958     * displaying, a @b stringshared string
20959     *
20960     * @see elm_fileselector_path_set()
20961     *
20962     * @ingroup Fileselector
20963     */
20964    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20965
20966    /**
20967     * Set, programmatically, the currently selected file/directory in
20968     * the given file selector widget
20969     *
20970     * @param obj The file selector object
20971     * @param path The (full) path to a file or directory
20972     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20973     * latter case occurs if the directory or file pointed to do not
20974     * exist.
20975     *
20976     * @see elm_fileselector_selected_get()
20977     *
20978     * @ingroup Fileselector
20979     */
20980    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20981
20982    /**
20983     * Get the currently selected item's (full) path, in the given file
20984     * selector widget
20985     *
20986     * @param obj The file selector object
20987     * @return The absolute path of the selected item, a @b
20988     * stringshared string
20989     *
20990     * @note Custom editions on @p obj object's text entry, if made,
20991     * will appear on the return string of this function, naturally.
20992     *
20993     * @see elm_fileselector_selected_set() for more details
20994     *
20995     * @ingroup Fileselector
20996     */
20997    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20998
20999    /**
21000     * Set the mode in which a given file selector widget will display
21001     * (layout) file system entries in its view
21002     *
21003     * @param obj The file selector object
21004     * @param mode The mode of the fileselector, being it one of
21005     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21006     * first one, naturally, will display the files in a list. The
21007     * latter will make the widget to display its entries in a grid
21008     * form.
21009     *
21010     * @note By using elm_fileselector_expandable_set(), the user may
21011     * trigger a tree view for that list.
21012     *
21013     * @note If Elementary is built with support of the Ethumb
21014     * thumbnailing library, the second form of view will display
21015     * preview thumbnails of files which it supports. You must have
21016     * elm_need_ethumb() called in your Elementary for thumbnailing to
21017     * work, though.
21018     *
21019     * @see elm_fileselector_expandable_set().
21020     * @see elm_fileselector_mode_get().
21021     *
21022     * @ingroup Fileselector
21023     */
21024    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21025
21026    /**
21027     * Get the mode in which a given file selector widget is displaying
21028     * (layouting) file system entries in its view
21029     *
21030     * @param obj The fileselector object
21031     * @return The mode in which the fileselector is at
21032     *
21033     * @see elm_fileselector_mode_set() for more details
21034     *
21035     * @ingroup Fileselector
21036     */
21037    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21038
21039    /**
21040     * @}
21041     */
21042
21043    /**
21044     * @defgroup Progressbar Progress bar
21045     *
21046     * The progress bar is a widget for visually representing the
21047     * progress status of a given job/task.
21048     *
21049     * A progress bar may be horizontal or vertical. It may display an
21050     * icon besides it, as well as primary and @b units labels. The
21051     * former is meant to label the widget as a whole, while the
21052     * latter, which is formatted with floating point values (and thus
21053     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21054     * units"</c>), is meant to label the widget's <b>progress
21055     * value</b>. Label, icon and unit strings/objects are @b optional
21056     * for progress bars.
21057     *
21058     * A progress bar may be @b inverted, in which state it gets its
21059     * values inverted, with high values being on the left or top and
21060     * low values on the right or bottom, as opposed to normally have
21061     * the low values on the former and high values on the latter,
21062     * respectively, for horizontal and vertical modes.
21063     *
21064     * The @b span of the progress, as set by
21065     * elm_progressbar_span_size_set(), is its length (horizontally or
21066     * vertically), unless one puts size hints on the widget to expand
21067     * on desired directions, by any container. That length will be
21068     * scaled by the object or applications scaling factor. At any
21069     * point code can query the progress bar for its value with
21070     * elm_progressbar_value_get().
21071     *
21072     * Available widget styles for progress bars:
21073     * - @c "default"
21074     * - @c "wheel" (simple style, no text, no progression, only
21075     *      "pulse" effect is available)
21076     *
21077     * Default contents parts of the progressbar widget that you can use for are:
21078     * @li "icon" - A icon of the progressbar
21079     * 
21080     * Here is an example on its usage:
21081     * @li @ref progressbar_example
21082     */
21083
21084    /**
21085     * Add a new progress bar widget to the given parent Elementary
21086     * (container) object
21087     *
21088     * @param parent The parent object
21089     * @return a new progress bar widget handle or @c NULL, on errors
21090     *
21091     * This function inserts a new progress bar widget on the canvas.
21092     *
21093     * @ingroup Progressbar
21094     */
21095    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21096
21097    /**
21098     * Set whether a given progress bar widget is at "pulsing mode" or
21099     * not.
21100     *
21101     * @param obj The progress bar object
21102     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21103     * @c EINA_FALSE to put it back to its default one
21104     *
21105     * By default, progress bars will display values from the low to
21106     * high value boundaries. There are, though, contexts in which the
21107     * state of progression of a given task is @b unknown.  For those,
21108     * one can set a progress bar widget to a "pulsing state", to give
21109     * the user an idea that some computation is being held, but
21110     * without exact progress values. In the default theme it will
21111     * animate its bar with the contents filling in constantly and back
21112     * to non-filled, in a loop. To start and stop this pulsing
21113     * animation, one has to explicitly call elm_progressbar_pulse().
21114     *
21115     * @see elm_progressbar_pulse_get()
21116     * @see elm_progressbar_pulse()
21117     *
21118     * @ingroup Progressbar
21119     */
21120    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21121
21122    /**
21123     * Get whether a given progress bar widget is at "pulsing mode" or
21124     * not.
21125     *
21126     * @param obj The progress bar object
21127     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21128     * if it's in the default one (and on errors)
21129     *
21130     * @ingroup Progressbar
21131     */
21132    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21133
21134    /**
21135     * Start/stop a given progress bar "pulsing" animation, if its
21136     * under that mode
21137     *
21138     * @param obj The progress bar object
21139     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21140     * @c EINA_FALSE to @b stop it
21141     *
21142     * @note This call won't do anything if @p obj is not under "pulsing mode".
21143     *
21144     * @see elm_progressbar_pulse_set() for more details.
21145     *
21146     * @ingroup Progressbar
21147     */
21148    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21149
21150    /**
21151     * Set the progress value (in percentage) on a given progress bar
21152     * widget
21153     *
21154     * @param obj The progress bar object
21155     * @param val The progress value (@b must be between @c 0.0 and @c
21156     * 1.0)
21157     *
21158     * Use this call to set progress bar levels.
21159     *
21160     * @note If you passes a value out of the specified range for @p
21161     * val, it will be interpreted as the @b closest of the @b boundary
21162     * values in the range.
21163     *
21164     * @ingroup Progressbar
21165     */
21166    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21167
21168    /**
21169     * Get the progress value (in percentage) on a given progress bar
21170     * widget
21171     *
21172     * @param obj The progress bar object
21173     * @return The value of the progressbar
21174     *
21175     * @see elm_progressbar_value_set() for more details
21176     *
21177     * @ingroup Progressbar
21178     */
21179    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21180
21181    /**
21182     * Set the label of a given progress bar widget
21183     *
21184     * @param obj The progress bar object
21185     * @param label The text label string, in UTF-8
21186     *
21187     * @ingroup Progressbar
21188     * @deprecated use elm_object_text_set() instead.
21189     */
21190    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21191
21192    /**
21193     * Get the label of a given progress bar widget
21194     *
21195     * @param obj The progressbar object
21196     * @return The text label string, in UTF-8
21197     *
21198     * @ingroup Progressbar
21199     * @deprecated use elm_object_text_set() instead.
21200     */
21201    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21202
21203    /**
21204     * Set the icon object of a given progress bar widget
21205     *
21206     * @param obj The progress bar object
21207     * @param icon The icon object
21208     *
21209     * Use this call to decorate @p obj with an icon next to it.
21210     *
21211     * @note Once the icon object is set, a previously set one will be
21212     * deleted. If you want to keep that old content object, use the
21213     * elm_progressbar_icon_unset() function.
21214     *
21215     * @see elm_progressbar_icon_get()
21216     * @deprecated use elm_object_part_content_set() instead.
21217     *
21218     * @ingroup Progressbar
21219     */
21220    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21221
21222    /**
21223     * Retrieve the icon object set for a given progress bar widget
21224     *
21225     * @param obj The progress bar object
21226     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21227     * otherwise (and on errors)
21228     *
21229     * @see elm_progressbar_icon_set() for more details
21230     * @deprecated use elm_object_part_content_get() instead.
21231     *
21232     * @ingroup Progressbar
21233     */
21234    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21235
21236    /**
21237     * Unset an icon set on a given progress bar widget
21238     *
21239     * @param obj The progress bar object
21240     * @return The icon object that was being used, if any was set, or
21241     * @c NULL, otherwise (and on errors)
21242     *
21243     * This call will unparent and return the icon object which was set
21244     * for this widget, previously, on success.
21245     *
21246     * @see elm_progressbar_icon_set() for more details
21247     * @deprecated use elm_object_part_content_unset() instead.
21248     *
21249     * @ingroup Progressbar
21250     */
21251    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21252
21253    /**
21254     * Set the (exact) length of the bar region of a given progress bar
21255     * widget
21256     *
21257     * @param obj The progress bar object
21258     * @param size The length of the progress bar's bar region
21259     *
21260     * This sets the minimum width (when in horizontal mode) or height
21261     * (when in vertical mode) of the actual bar area of the progress
21262     * bar @p obj. This in turn affects the object's minimum size. Use
21263     * this when you're not setting other size hints expanding on the
21264     * given direction (like weight and alignment hints) and you would
21265     * like it to have a specific size.
21266     *
21267     * @note Icon, label and unit text around @p obj will require their
21268     * own space, which will make @p obj to require more the @p size,
21269     * actually.
21270     *
21271     * @see elm_progressbar_span_size_get()
21272     *
21273     * @ingroup Progressbar
21274     */
21275    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21276
21277    /**
21278     * Get the length set for the bar region of a given progress bar
21279     * widget
21280     *
21281     * @param obj The progress bar object
21282     * @return The length of the progress bar's bar region
21283     *
21284     * If that size was not set previously, with
21285     * elm_progressbar_span_size_set(), this call will return @c 0.
21286     *
21287     * @ingroup Progressbar
21288     */
21289    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21290
21291    /**
21292     * Set the format string for a given progress bar widget's units
21293     * label
21294     *
21295     * @param obj The progress bar object
21296     * @param format The format string for @p obj's units label
21297     *
21298     * If @c NULL is passed on @p format, it will make @p obj's units
21299     * area to be hidden completely. If not, it'll set the <b>format
21300     * string</b> for the units label's @b text. The units label is
21301     * provided a floating point value, so the units text is up display
21302     * at most one floating point falue. Note that the units label is
21303     * optional. Use a format string such as "%1.2f meters" for
21304     * example.
21305     *
21306     * @note The default format string for a progress bar is an integer
21307     * percentage, as in @c "%.0f %%".
21308     *
21309     * @see elm_progressbar_unit_format_get()
21310     *
21311     * @ingroup Progressbar
21312     */
21313    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21314
21315    /**
21316     * Retrieve the format string set for a given progress bar widget's
21317     * units label
21318     *
21319     * @param obj The progress bar object
21320     * @return The format set string for @p obj's units label or
21321     * @c NULL, if none was set (and on errors)
21322     *
21323     * @see elm_progressbar_unit_format_set() for more details
21324     *
21325     * @ingroup Progressbar
21326     */
21327    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21328
21329    /**
21330     * Set the orientation of a given progress bar widget
21331     *
21332     * @param obj The progress bar object
21333     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21334     * @b horizontal, @c EINA_FALSE to make it @b vertical
21335     *
21336     * Use this function to change how your progress bar is to be
21337     * disposed: vertically or horizontally.
21338     *
21339     * @see elm_progressbar_horizontal_get()
21340     *
21341     * @ingroup Progressbar
21342     */
21343    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21344
21345    /**
21346     * Retrieve the orientation of a given progress bar widget
21347     *
21348     * @param obj The progress bar object
21349     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21350     * @c EINA_FALSE if it's @b vertical (and on errors)
21351     *
21352     * @see elm_progressbar_horizontal_set() for more details
21353     *
21354     * @ingroup Progressbar
21355     */
21356    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21357
21358    /**
21359     * Invert a given progress bar widget's displaying values order
21360     *
21361     * @param obj The progress bar object
21362     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21363     * @c EINA_FALSE to bring it back to default, non-inverted values.
21364     *
21365     * A progress bar may be @b inverted, in which state it gets its
21366     * values inverted, with high values being on the left or top and
21367     * low values on the right or bottom, as opposed to normally have
21368     * the low values on the former and high values on the latter,
21369     * respectively, for horizontal and vertical modes.
21370     *
21371     * @see elm_progressbar_inverted_get()
21372     *
21373     * @ingroup Progressbar
21374     */
21375    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21376
21377    /**
21378     * Get whether a given progress bar widget's displaying values are
21379     * inverted or not
21380     *
21381     * @param obj The progress bar object
21382     * @return @c EINA_TRUE, if @p obj has inverted values,
21383     * @c EINA_FALSE otherwise (and on errors)
21384     *
21385     * @see elm_progressbar_inverted_set() for more details
21386     *
21387     * @ingroup Progressbar
21388     */
21389    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21390
21391    /**
21392     * @defgroup Separator Separator
21393     *
21394     * @brief Separator is a very thin object used to separate other objects.
21395     *
21396     * A separator can be vertical or horizontal.
21397     *
21398     * @ref tutorial_separator is a good example of how to use a separator.
21399     * @{
21400     */
21401    /**
21402     * @brief Add a separator object to @p parent
21403     *
21404     * @param parent The parent object
21405     *
21406     * @return The separator object, or NULL upon failure
21407     */
21408    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21409    /**
21410     * @brief Set the horizontal mode of a separator object
21411     *
21412     * @param obj The separator object
21413     * @param horizontal If true, the separator is horizontal
21414     */
21415    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21416    /**
21417     * @brief Get the horizontal mode of a separator object
21418     *
21419     * @param obj The separator object
21420     * @return If true, the separator is horizontal
21421     *
21422     * @see elm_separator_horizontal_set()
21423     */
21424    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21425    /**
21426     * @}
21427     */
21428
21429    /**
21430     * @defgroup Spinner Spinner
21431     * @ingroup Elementary
21432     *
21433     * @image html img/widget/spinner/preview-00.png
21434     * @image latex img/widget/spinner/preview-00.eps
21435     *
21436     * A spinner is a widget which allows the user to increase or decrease
21437     * numeric values using arrow buttons, or edit values directly, clicking
21438     * over it and typing the new value.
21439     *
21440     * By default the spinner will not wrap and has a label
21441     * of "%.0f" (just showing the integer value of the double).
21442     *
21443     * A spinner has a label that is formatted with floating
21444     * point values and thus accepts a printf-style format string, like
21445     * “%1.2f units”.
21446     *
21447     * It also allows specific values to be replaced by pre-defined labels.
21448     *
21449     * Smart callbacks one can register to:
21450     *
21451     * - "changed" - Whenever the spinner value is changed.
21452     * - "delay,changed" - A short time after the value is changed by the user.
21453     *    This will be called only when the user stops dragging for a very short
21454     *    period or when they release their finger/mouse, so it avoids possibly
21455     *    expensive reactions to the value change.
21456     *
21457     * Available styles for it:
21458     * - @c "default";
21459     * - @c "vertical": up/down buttons at the right side and text left aligned.
21460     *
21461     * Here is an example on its usage:
21462     * @ref spinner_example
21463     */
21464
21465    /**
21466     * @addtogroup Spinner
21467     * @{
21468     */
21469
21470    /**
21471     * Add a new spinner widget to the given parent Elementary
21472     * (container) object.
21473     *
21474     * @param parent The parent object.
21475     * @return a new spinner widget handle or @c NULL, on errors.
21476     *
21477     * This function inserts a new spinner widget on the canvas.
21478     *
21479     * @ingroup Spinner
21480     *
21481     */
21482    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21483
21484    /**
21485     * Set the format string of the displayed label.
21486     *
21487     * @param obj The spinner object.
21488     * @param fmt The format string for the label display.
21489     *
21490     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21491     * string for the label text. The label text is provided a floating point
21492     * value, so the label text can display up to 1 floating point value.
21493     * Note that this is optional.
21494     *
21495     * Use a format string such as "%1.2f meters" for example, and it will
21496     * display values like: "3.14 meters" for a value equal to 3.14159.
21497     *
21498     * Default is "%0.f".
21499     *
21500     * @see elm_spinner_label_format_get()
21501     *
21502     * @ingroup Spinner
21503     */
21504    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21505
21506    /**
21507     * Get the label format of the spinner.
21508     *
21509     * @param obj The spinner object.
21510     * @return The text label format string in UTF-8.
21511     *
21512     * @see elm_spinner_label_format_set() for details.
21513     *
21514     * @ingroup Spinner
21515     */
21516    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21517
21518    /**
21519     * Set the minimum and maximum values for the spinner.
21520     *
21521     * @param obj The spinner object.
21522     * @param min The minimum value.
21523     * @param max The maximum value.
21524     *
21525     * Define the allowed range of values to be selected by the user.
21526     *
21527     * If actual value is less than @p min, it will be updated to @p min. If it
21528     * is bigger then @p max, will be updated to @p max. Actual value can be
21529     * get with elm_spinner_value_get().
21530     *
21531     * By default, min is equal to 0, and max is equal to 100.
21532     *
21533     * @warning Maximum must be greater than minimum.
21534     *
21535     * @see elm_spinner_min_max_get()
21536     *
21537     * @ingroup Spinner
21538     */
21539    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21540
21541    /**
21542     * Get the minimum and maximum values of the spinner.
21543     *
21544     * @param obj The spinner object.
21545     * @param min Pointer where to store the minimum value.
21546     * @param max Pointer where to store the maximum value.
21547     *
21548     * @note If only one value is needed, the other pointer can be passed
21549     * as @c NULL.
21550     *
21551     * @see elm_spinner_min_max_set() for details.
21552     *
21553     * @ingroup Spinner
21554     */
21555    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21556
21557    /**
21558     * Set the step used to increment or decrement the spinner value.
21559     *
21560     * @param obj The spinner object.
21561     * @param step The step value.
21562     *
21563     * This value will be incremented or decremented to the displayed value.
21564     * It will be incremented while the user keep right or top arrow pressed,
21565     * and will be decremented while the user keep left or bottom arrow pressed.
21566     *
21567     * The interval to increment / decrement can be set with
21568     * elm_spinner_interval_set().
21569     *
21570     * By default step value is equal to 1.
21571     *
21572     * @see elm_spinner_step_get()
21573     *
21574     * @ingroup Spinner
21575     */
21576    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21577
21578    /**
21579     * Get the step used to increment or decrement the spinner value.
21580     *
21581     * @param obj The spinner object.
21582     * @return The step value.
21583     *
21584     * @see elm_spinner_step_get() for more details.
21585     *
21586     * @ingroup Spinner
21587     */
21588    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21589
21590    /**
21591     * Set the value the spinner displays.
21592     *
21593     * @param obj The spinner object.
21594     * @param val The value to be displayed.
21595     *
21596     * Value will be presented on the label following format specified with
21597     * elm_spinner_format_set().
21598     *
21599     * @warning The value must to be between min and max values. This values
21600     * are set by elm_spinner_min_max_set().
21601     *
21602     * @see elm_spinner_value_get().
21603     * @see elm_spinner_format_set().
21604     * @see elm_spinner_min_max_set().
21605     *
21606     * @ingroup Spinner
21607     */
21608    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21609
21610    /**
21611     * Get the value displayed by the spinner.
21612     *
21613     * @param obj The spinner object.
21614     * @return The value displayed.
21615     *
21616     * @see elm_spinner_value_set() for details.
21617     *
21618     * @ingroup Spinner
21619     */
21620    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21621
21622    /**
21623     * Set whether the spinner should wrap when it reaches its
21624     * minimum or maximum value.
21625     *
21626     * @param obj The spinner object.
21627     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21628     * disable it.
21629     *
21630     * Disabled by default. If disabled, when the user tries to increment the
21631     * value,
21632     * but displayed value plus step value is bigger than maximum value,
21633     * the spinner
21634     * won't allow it. The same happens when the user tries to decrement it,
21635     * but the value less step is less than minimum value.
21636     *
21637     * When wrap is enabled, in such situations it will allow these changes,
21638     * but will get the value that would be less than minimum and subtracts
21639     * from maximum. Or add the value that would be more than maximum to
21640     * the minimum.
21641     *
21642     * E.g.:
21643     * @li min value = 10
21644     * @li max value = 50
21645     * @li step value = 20
21646     * @li displayed value = 20
21647     *
21648     * When the user decrement value (using left or bottom arrow), it will
21649     * displays @c 40, because max - (min - (displayed - step)) is
21650     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21651     *
21652     * @see elm_spinner_wrap_get().
21653     *
21654     * @ingroup Spinner
21655     */
21656    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21657
21658    /**
21659     * Get whether the spinner should wrap when it reaches its
21660     * minimum or maximum value.
21661     *
21662     * @param obj The spinner object
21663     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21664     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21665     *
21666     * @see elm_spinner_wrap_set() for details.
21667     *
21668     * @ingroup Spinner
21669     */
21670    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21671
21672    /**
21673     * Set whether the spinner can be directly edited by the user or not.
21674     *
21675     * @param obj The spinner object.
21676     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21677     * don't allow users to edit it directly.
21678     *
21679     * Spinner objects can have edition @b disabled, in which state they will
21680     * be changed only by arrows.
21681     * Useful for contexts
21682     * where you don't want your users to interact with it writting the value.
21683     * Specially
21684     * when using special values, the user can see real value instead
21685     * of special label on edition.
21686     *
21687     * It's enabled by default.
21688     *
21689     * @see elm_spinner_editable_get()
21690     *
21691     * @ingroup Spinner
21692     */
21693    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21694
21695    /**
21696     * Get whether the spinner can be directly edited by the user or not.
21697     *
21698     * @param obj The spinner object.
21699     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21700     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21701     *
21702     * @see elm_spinner_editable_set() for details.
21703     *
21704     * @ingroup Spinner
21705     */
21706    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21707
21708    /**
21709     * Set a special string to display in the place of the numerical value.
21710     *
21711     * @param obj The spinner object.
21712     * @param value The value to be replaced.
21713     * @param label The label to be used.
21714     *
21715     * It's useful for cases when a user should select an item that is
21716     * better indicated by a label than a value. For example, weekdays or months.
21717     *
21718     * E.g.:
21719     * @code
21720     * sp = elm_spinner_add(win);
21721     * elm_spinner_min_max_set(sp, 1, 3);
21722     * elm_spinner_special_value_add(sp, 1, "January");
21723     * elm_spinner_special_value_add(sp, 2, "February");
21724     * elm_spinner_special_value_add(sp, 3, "March");
21725     * evas_object_show(sp);
21726     * @endcode
21727     *
21728     * @ingroup Spinner
21729     */
21730    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21731
21732    /**
21733     * Set the interval on time updates for an user mouse button hold
21734     * on spinner widgets' arrows.
21735     *
21736     * @param obj The spinner object.
21737     * @param interval The (first) interval value in seconds.
21738     *
21739     * This interval value is @b decreased while the user holds the
21740     * mouse pointer either incrementing or decrementing spinner's value.
21741     *
21742     * This helps the user to get to a given value distant from the
21743     * current one easier/faster, as it will start to change quicker and
21744     * quicker on mouse button holds.
21745     *
21746     * The calculation for the next change interval value, starting from
21747     * the one set with this call, is the previous interval divided by
21748     * @c 1.05, so it decreases a little bit.
21749     *
21750     * The default starting interval value for automatic changes is
21751     * @c 0.85 seconds.
21752     *
21753     * @see elm_spinner_interval_get()
21754     *
21755     * @ingroup Spinner
21756     */
21757    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21758
21759    /**
21760     * Get the interval on time updates for an user mouse button hold
21761     * on spinner widgets' arrows.
21762     *
21763     * @param obj The spinner object.
21764     * @return The (first) interval value, in seconds, set on it.
21765     *
21766     * @see elm_spinner_interval_set() for more details.
21767     *
21768     * @ingroup Spinner
21769     */
21770    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21771
21772    /**
21773     * @}
21774     */
21775
21776    /**
21777     * @defgroup Index Index
21778     *
21779     * @image html img/widget/index/preview-00.png
21780     * @image latex img/widget/index/preview-00.eps
21781     *
21782     * An index widget gives you an index for fast access to whichever
21783     * group of other UI items one might have. It's a list of text
21784     * items (usually letters, for alphabetically ordered access).
21785     *
21786     * Index widgets are by default hidden and just appear when the
21787     * user clicks over it's reserved area in the canvas. In its
21788     * default theme, it's an area one @ref Fingers "finger" wide on
21789     * the right side of the index widget's container.
21790     *
21791     * When items on the index are selected, smart callbacks get
21792     * called, so that its user can make other container objects to
21793     * show a given area or child object depending on the index item
21794     * selected. You'd probably be using an index together with @ref
21795     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21796     * "general grids".
21797     *
21798     * Smart events one  can add callbacks for are:
21799     * - @c "changed" - When the selected index item changes. @c
21800     *      event_info is the selected item's data pointer.
21801     * - @c "delay,changed" - When the selected index item changes, but
21802     *      after a small idling period. @c event_info is the selected
21803     *      item's data pointer.
21804     * - @c "selected" - When the user releases a mouse button and
21805     *      selects an item. @c event_info is the selected item's data
21806     *      pointer.
21807     * - @c "level,up" - when the user moves a finger from the first
21808     *      level to the second level
21809     * - @c "level,down" - when the user moves a finger from the second
21810     *      level to the first level
21811     *
21812     * The @c "delay,changed" event is so that it'll wait a small time
21813     * before actually reporting those events and, moreover, just the
21814     * last event happening on those time frames will actually be
21815     * reported.
21816     *
21817     * Here are some examples on its usage:
21818     * @li @ref index_example_01
21819     * @li @ref index_example_02
21820     */
21821
21822    /**
21823     * @addtogroup Index
21824     * @{
21825     */
21826
21827    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21828
21829    /**
21830     * Add a new index widget to the given parent Elementary
21831     * (container) object
21832     *
21833     * @param parent The parent object
21834     * @return a new index widget handle or @c NULL, on errors
21835     *
21836     * This function inserts a new index widget on the canvas.
21837     *
21838     * @ingroup Index
21839     */
21840    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21841
21842    /**
21843     * Set whether a given index widget is or not visible,
21844     * programatically.
21845     *
21846     * @param obj The index object
21847     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21848     *
21849     * Not to be confused with visible as in @c evas_object_show() --
21850     * visible with regard to the widget's auto hiding feature.
21851     *
21852     * @see elm_index_active_get()
21853     *
21854     * @ingroup Index
21855     */
21856    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21857
21858    /**
21859     * Get whether a given index widget is currently visible or not.
21860     *
21861     * @param obj The index object
21862     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21863     *
21864     * @see elm_index_active_set() for more details
21865     *
21866     * @ingroup Index
21867     */
21868    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21869
21870    /**
21871     * Set the items level for a given index widget.
21872     *
21873     * @param obj The index object.
21874     * @param level @c 0 or @c 1, the currently implemented levels.
21875     *
21876     * @see elm_index_item_level_get()
21877     *
21878     * @ingroup Index
21879     */
21880    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21881
21882    /**
21883     * Get the items level set for a given index widget.
21884     *
21885     * @param obj The index object.
21886     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21887     *
21888     * @see elm_index_item_level_set() for more information
21889     *
21890     * @ingroup Index
21891     */
21892    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21893
21894    /**
21895     * Returns the last selected item's data, for a given index widget.
21896     *
21897     * @param obj The index object.
21898     * @return The item @b data associated to the last selected item on
21899     * @p obj (or @c NULL, on errors).
21900     *
21901     * @warning The returned value is @b not an #Elm_Index_Item item
21902     * handle, but the data associated to it (see the @c item parameter
21903     * in elm_index_item_append(), as an example).
21904     *
21905     * @ingroup Index
21906     */
21907    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21908
21909    /**
21910     * Append a new item on a given index widget.
21911     *
21912     * @param obj The index object.
21913     * @param letter Letter under which the item should be indexed
21914     * @param item The item data to set for the index's item
21915     *
21916     * Despite the most common usage of the @p letter argument is for
21917     * single char strings, one could use arbitrary strings as index
21918     * entries.
21919     *
21920     * @c item will be the pointer returned back on @c "changed", @c
21921     * "delay,changed" and @c "selected" smart events.
21922     *
21923     * @ingroup Index
21924     */
21925    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21926
21927    /**
21928     * Prepend a new item on a given index widget.
21929     *
21930     * @param obj The index object.
21931     * @param letter Letter under which the item should be indexed
21932     * @param item The item data to set for the index's item
21933     *
21934     * Despite the most common usage of the @p letter argument is for
21935     * single char strings, one could use arbitrary strings as index
21936     * entries.
21937     *
21938     * @c item will be the pointer returned back on @c "changed", @c
21939     * "delay,changed" and @c "selected" smart events.
21940     *
21941     * @ingroup Index
21942     */
21943    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21944
21945    /**
21946     * Append a new item, on a given index widget, <b>after the item
21947     * having @p relative as data</b>.
21948     *
21949     * @param obj The index object.
21950     * @param letter Letter under which the item should be indexed
21951     * @param item The item data to set for the index's item
21952     * @param relative The item data of the index item to be the
21953     * predecessor of this new one
21954     *
21955     * Despite the most common usage of the @p letter argument is for
21956     * single char strings, one could use arbitrary strings as index
21957     * entries.
21958     *
21959     * @c item will be the pointer returned back on @c "changed", @c
21960     * "delay,changed" and @c "selected" smart events.
21961     *
21962     * @note If @p relative is @c NULL or if it's not found to be data
21963     * set on any previous item on @p obj, this function will behave as
21964     * elm_index_item_append().
21965     *
21966     * @ingroup Index
21967     */
21968    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21969
21970    /**
21971     * Prepend a new item, on a given index widget, <b>after the item
21972     * having @p relative as data</b>.
21973     *
21974     * @param obj The index object.
21975     * @param letter Letter under which the item should be indexed
21976     * @param item The item data to set for the index's item
21977     * @param relative The item data of the index item to be the
21978     * successor of this new one
21979     *
21980     * Despite the most common usage of the @p letter argument is for
21981     * single char strings, one could use arbitrary strings as index
21982     * entries.
21983     *
21984     * @c item will be the pointer returned back on @c "changed", @c
21985     * "delay,changed" and @c "selected" smart events.
21986     *
21987     * @note If @p relative is @c NULL or if it's not found to be data
21988     * set on any previous item on @p obj, this function will behave as
21989     * elm_index_item_prepend().
21990     *
21991     * @ingroup Index
21992     */
21993    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21994
21995    /**
21996     * Insert a new item into the given index widget, using @p cmp_func
21997     * function to sort items (by item handles).
21998     *
21999     * @param obj The index object.
22000     * @param letter Letter under which the item should be indexed
22001     * @param item The item data to set for the index's item
22002     * @param cmp_func The comparing function to be used to sort index
22003     * items <b>by #Elm_Index_Item item handles</b>
22004     * @param cmp_data_func A @b fallback function to be called for the
22005     * sorting of index items <b>by item data</b>). It will be used
22006     * when @p cmp_func returns @c 0 (equality), which means an index
22007     * item with provided item data already exists. To decide which
22008     * data item should be pointed to by the index item in question, @p
22009     * cmp_data_func will be used. If @p cmp_data_func returns a
22010     * non-negative value, the previous index item data will be
22011     * replaced by the given @p item pointer. If the previous data need
22012     * to be freed, it should be done by the @p cmp_data_func function,
22013     * because all references to it will be lost. If this function is
22014     * not provided (@c NULL is given), index items will be @b
22015     * duplicated, if @p cmp_func returns @c 0.
22016     *
22017     * Despite the most common usage of the @p letter argument is for
22018     * single char strings, one could use arbitrary strings as index
22019     * entries.
22020     *
22021     * @c item will be the pointer returned back on @c "changed", @c
22022     * "delay,changed" and @c "selected" smart events.
22023     *
22024     * @ingroup Index
22025     */
22026    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);
22027
22028    /**
22029     * Remove an item from a given index widget, <b>to be referenced by
22030     * it's data value</b>.
22031     *
22032     * @param obj The index object
22033     * @param item The item's data pointer for the item to be removed
22034     * from @p obj
22035     *
22036     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22037     * that callback function will be called by this one.
22038     *
22039     * @warning The item to be removed from @p obj will be found via
22040     * its item data pointer, and not by an #Elm_Index_Item handle.
22041     *
22042     * @ingroup Index
22043     */
22044    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22045
22046    /**
22047     * Find a given index widget's item, <b>using item data</b>.
22048     *
22049     * @param obj The index object
22050     * @param item The item data pointed to by the desired index item
22051     * @return The index item handle, if found, or @c NULL otherwise
22052     *
22053     * @ingroup Index
22054     */
22055    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22056
22057    /**
22058     * Removes @b all items from a given index widget.
22059     *
22060     * @param obj The index object.
22061     *
22062     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22063     * that callback function will be called for each item in @p obj.
22064     *
22065     * @ingroup Index
22066     */
22067    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22068
22069    /**
22070     * Go to a given items level on a index widget
22071     *
22072     * @param obj The index object
22073     * @param level The index level (one of @c 0 or @c 1)
22074     *
22075     * @ingroup Index
22076     */
22077    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22078
22079    /**
22080     * Return the data associated with a given index widget item
22081     *
22082     * @param it The index widget item handle
22083     * @return The data associated with @p it
22084     *
22085     * @see elm_index_item_data_set()
22086     *
22087     * @ingroup Index
22088     */
22089    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22090
22091    /**
22092     * Set the data associated with a given index widget item
22093     *
22094     * @param it The index widget item handle
22095     * @param data The new data pointer to set to @p it
22096     *
22097     * This sets new item data on @p it.
22098     *
22099     * @warning The old data pointer won't be touched by this function, so
22100     * the user had better to free that old data himself/herself.
22101     *
22102     * @ingroup Index
22103     */
22104    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22105
22106    /**
22107     * Set the function to be called when a given index widget item is freed.
22108     *
22109     * @param it The item to set the callback on
22110     * @param func The function to call on the item's deletion
22111     *
22112     * When called, @p func will have both @c data and @c event_info
22113     * arguments with the @p it item's data value and, naturally, the
22114     * @c obj argument with a handle to the parent index widget.
22115     *
22116     * @ingroup Index
22117     */
22118    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22119
22120    /**
22121     * Get the letter (string) set on a given index widget item.
22122     *
22123     * @param it The index item handle
22124     * @return The letter string set on @p it
22125     *
22126     * @ingroup Index
22127     */
22128    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22129
22130    /**
22131     */
22132    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22133
22134    /**
22135     * @}
22136     */
22137
22138    /**
22139     * @defgroup Photocam Photocam
22140     *
22141     * @image html img/widget/photocam/preview-00.png
22142     * @image latex img/widget/photocam/preview-00.eps
22143     *
22144     * This is a widget specifically for displaying high-resolution digital
22145     * camera photos giving speedy feedback (fast load), low memory footprint
22146     * and zooming and panning as well as fitting logic. It is entirely focused
22147     * on jpeg images, and takes advantage of properties of the jpeg format (via
22148     * evas loader features in the jpeg loader).
22149     *
22150     * Signals that you can add callbacks for are:
22151     * @li "clicked" - This is called when a user has clicked the photo without
22152     *                 dragging around.
22153     * @li "press" - This is called when a user has pressed down on the photo.
22154     * @li "longpressed" - This is called when a user has pressed down on the
22155     *                     photo for a long time without dragging around.
22156     * @li "clicked,double" - This is called when a user has double-clicked the
22157     *                        photo.
22158     * @li "load" - Photo load begins.
22159     * @li "loaded" - This is called when the image file load is complete for the
22160     *                first view (low resolution blurry version).
22161     * @li "load,detail" - Photo detailed data load begins.
22162     * @li "loaded,detail" - This is called when the image file load is complete
22163     *                      for the detailed image data (full resolution needed).
22164     * @li "zoom,start" - Zoom animation started.
22165     * @li "zoom,stop" - Zoom animation stopped.
22166     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22167     * @li "scroll" - the content has been scrolled (moved)
22168     * @li "scroll,anim,start" - scrolling animation has started
22169     * @li "scroll,anim,stop" - scrolling animation has stopped
22170     * @li "scroll,drag,start" - dragging the contents around has started
22171     * @li "scroll,drag,stop" - dragging the contents around has stopped
22172     *
22173     * @ref tutorial_photocam shows the API in action.
22174     * @{
22175     */
22176    /**
22177     * @brief Types of zoom available.
22178     */
22179    typedef enum _Elm_Photocam_Zoom_Mode
22180      {
22181         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22182         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22183         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22184         ELM_PHOTOCAM_ZOOM_MODE_LAST
22185      } Elm_Photocam_Zoom_Mode;
22186    /**
22187     * @brief Add a new Photocam object
22188     *
22189     * @param parent The parent object
22190     * @return The new object or NULL if it cannot be created
22191     */
22192    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22193    /**
22194     * @brief Set the photo file to be shown
22195     *
22196     * @param obj The photocam object
22197     * @param file The photo file
22198     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22199     *
22200     * This sets (and shows) the specified file (with a relative or absolute
22201     * path) and will return a load error (same error that
22202     * evas_object_image_load_error_get() will return). The image will change and
22203     * adjust its size at this point and begin a background load process for this
22204     * photo that at some time in the future will be displayed at the full
22205     * quality needed.
22206     */
22207    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22208    /**
22209     * @brief Returns the path of the current image file
22210     *
22211     * @param obj The photocam object
22212     * @return Returns the path
22213     *
22214     * @see elm_photocam_file_set()
22215     */
22216    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22217    /**
22218     * @brief Set the zoom level of the photo
22219     *
22220     * @param obj The photocam object
22221     * @param zoom The zoom level to set
22222     *
22223     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22224     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22225     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22226     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22227     * 16, 32, etc.).
22228     */
22229    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22230    /**
22231     * @brief Get the zoom level of the photo
22232     *
22233     * @param obj The photocam object
22234     * @return The current zoom level
22235     *
22236     * This returns the current zoom level of the photocam object. Note that if
22237     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22238     * (which is the default), the zoom level may be changed at any time by the
22239     * photocam object itself to account for photo size and photocam viewpoer
22240     * size.
22241     *
22242     * @see elm_photocam_zoom_set()
22243     * @see elm_photocam_zoom_mode_set()
22244     */
22245    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22246    /**
22247     * @brief Set the zoom mode
22248     *
22249     * @param obj The photocam object
22250     * @param mode The desired mode
22251     *
22252     * This sets the zoom mode to manual or one of several automatic levels.
22253     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22254     * elm_photocam_zoom_set() and will stay at that level until changed by code
22255     * or until zoom mode is changed. This is the default mode. The Automatic
22256     * modes will allow the photocam object to automatically adjust zoom mode
22257     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22258     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22259     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22260     * pixels within the frame are left unfilled.
22261     */
22262    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22263    /**
22264     * @brief Get the zoom mode
22265     *
22266     * @param obj The photocam object
22267     * @return The current zoom mode
22268     *
22269     * This gets the current zoom mode of the photocam object.
22270     *
22271     * @see elm_photocam_zoom_mode_set()
22272     */
22273    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22274    /**
22275     * @brief Get the current image pixel width and height
22276     *
22277     * @param obj The photocam object
22278     * @param w A pointer to the width return
22279     * @param h A pointer to the height return
22280     *
22281     * This gets the current photo pixel width and height (for the original).
22282     * The size will be returned in the integers @p w and @p h that are pointed
22283     * to.
22284     */
22285    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22286    /**
22287     * @brief Get the area of the image that is currently shown
22288     *
22289     * @param obj
22290     * @param x A pointer to the X-coordinate of region
22291     * @param y A pointer to the Y-coordinate of region
22292     * @param w A pointer to the width
22293     * @param h A pointer to the height
22294     *
22295     * @see elm_photocam_image_region_show()
22296     * @see elm_photocam_image_region_bring_in()
22297     */
22298    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22299    /**
22300     * @brief Set the viewed portion of the image
22301     *
22302     * @param obj The photocam object
22303     * @param x X-coordinate of region in image original pixels
22304     * @param y Y-coordinate of region in image original pixels
22305     * @param w Width of region in image original pixels
22306     * @param h Height of region in image original pixels
22307     *
22308     * This shows the region of the image without using animation.
22309     */
22310    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22311    /**
22312     * @brief Bring in the viewed portion of the image
22313     *
22314     * @param obj The photocam object
22315     * @param x X-coordinate of region in image original pixels
22316     * @param y Y-coordinate of region in image original pixels
22317     * @param w Width of region in image original pixels
22318     * @param h Height of region in image original pixels
22319     *
22320     * This shows the region of the image using animation.
22321     */
22322    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22323    /**
22324     * @brief Set the paused state for photocam
22325     *
22326     * @param obj The photocam object
22327     * @param paused The pause state to set
22328     *
22329     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22330     * photocam. The default is off. This will stop zooming using animation on
22331     * zoom levels changes and change instantly. This will stop any existing
22332     * animations that are running.
22333     */
22334    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22335    /**
22336     * @brief Get the paused state for photocam
22337     *
22338     * @param obj The photocam object
22339     * @return The current paused state
22340     *
22341     * This gets the current paused state for the photocam object.
22342     *
22343     * @see elm_photocam_paused_set()
22344     */
22345    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22346    /**
22347     * @brief Get the internal low-res image used for photocam
22348     *
22349     * @param obj The photocam object
22350     * @return The internal image object handle, or NULL if none exists
22351     *
22352     * This gets the internal image object inside photocam. Do not modify it. It
22353     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22354     * deleted at any time as well.
22355     */
22356    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22357    /**
22358     * @brief Set the photocam scrolling bouncing.
22359     *
22360     * @param obj The photocam object
22361     * @param h_bounce bouncing for horizontal
22362     * @param v_bounce bouncing for vertical
22363     */
22364    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22365    /**
22366     * @brief Get the photocam scrolling bouncing.
22367     *
22368     * @param obj The photocam object
22369     * @param h_bounce bouncing for horizontal
22370     * @param v_bounce bouncing for vertical
22371     *
22372     * @see elm_photocam_bounce_set()
22373     */
22374    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22375    /**
22376     * @}
22377     */
22378
22379    /**
22380     * @defgroup Map Map
22381     * @ingroup Elementary
22382     *
22383     * @image html img/widget/map/preview-00.png
22384     * @image latex img/widget/map/preview-00.eps
22385     *
22386     * This is a widget specifically for displaying a map. It uses basically
22387     * OpenStreetMap provider http://www.openstreetmap.org/,
22388     * but custom providers can be added.
22389     *
22390     * It supports some basic but yet nice features:
22391     * @li zoom and scroll
22392     * @li markers with content to be displayed when user clicks over it
22393     * @li group of markers
22394     * @li routes
22395     *
22396     * Smart callbacks one can listen to:
22397     *
22398     * - "clicked" - This is called when a user has clicked the map without
22399     *   dragging around.
22400     * - "press" - This is called when a user has pressed down on the map.
22401     * - "longpressed" - This is called when a user has pressed down on the map
22402     *   for a long time without dragging around.
22403     * - "clicked,double" - This is called when a user has double-clicked
22404     *   the map.
22405     * - "load,detail" - Map detailed data load begins.
22406     * - "loaded,detail" - This is called when all currently visible parts of
22407     *   the map are loaded.
22408     * - "zoom,start" - Zoom animation started.
22409     * - "zoom,stop" - Zoom animation stopped.
22410     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22411     * - "scroll" - the content has been scrolled (moved).
22412     * - "scroll,anim,start" - scrolling animation has started.
22413     * - "scroll,anim,stop" - scrolling animation has stopped.
22414     * - "scroll,drag,start" - dragging the contents around has started.
22415     * - "scroll,drag,stop" - dragging the contents around has stopped.
22416     * - "downloaded" - This is called when all currently required map images
22417     *   are downloaded.
22418     * - "route,load" - This is called when route request begins.
22419     * - "route,loaded" - This is called when route request ends.
22420     * - "name,load" - This is called when name request begins.
22421     * - "name,loaded- This is called when name request ends.
22422     *
22423     * Available style for map widget:
22424     * - @c "default"
22425     *
22426     * Available style for markers:
22427     * - @c "radio"
22428     * - @c "radio2"
22429     * - @c "empty"
22430     *
22431     * Available style for marker bubble:
22432     * - @c "default"
22433     *
22434     * List of examples:
22435     * @li @ref map_example_01
22436     * @li @ref map_example_02
22437     * @li @ref map_example_03
22438     */
22439
22440    /**
22441     * @addtogroup Map
22442     * @{
22443     */
22444
22445    /**
22446     * @enum _Elm_Map_Zoom_Mode
22447     * @typedef Elm_Map_Zoom_Mode
22448     *
22449     * Set map's zoom behavior. It can be set to manual or automatic.
22450     *
22451     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22452     *
22453     * Values <b> don't </b> work as bitmask, only one can be choosen.
22454     *
22455     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22456     * than the scroller view.
22457     *
22458     * @see elm_map_zoom_mode_set()
22459     * @see elm_map_zoom_mode_get()
22460     *
22461     * @ingroup Map
22462     */
22463    typedef enum _Elm_Map_Zoom_Mode
22464      {
22465         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22466         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22467         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22468         ELM_MAP_ZOOM_MODE_LAST
22469      } Elm_Map_Zoom_Mode;
22470
22471    /**
22472     * @enum _Elm_Map_Route_Sources
22473     * @typedef Elm_Map_Route_Sources
22474     *
22475     * Set route service to be used. By default used source is
22476     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22477     *
22478     * @see elm_map_route_source_set()
22479     * @see elm_map_route_source_get()
22480     *
22481     * @ingroup Map
22482     */
22483    typedef enum _Elm_Map_Route_Sources
22484      {
22485         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22486         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. */
22487         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22488         ELM_MAP_ROUTE_SOURCE_LAST
22489      } Elm_Map_Route_Sources;
22490
22491    typedef enum _Elm_Map_Name_Sources
22492      {
22493         ELM_MAP_NAME_SOURCE_NOMINATIM,
22494         ELM_MAP_NAME_SOURCE_LAST
22495      } Elm_Map_Name_Sources;
22496
22497    /**
22498     * @enum _Elm_Map_Route_Type
22499     * @typedef Elm_Map_Route_Type
22500     *
22501     * Set type of transport used on route.
22502     *
22503     * @see elm_map_route_add()
22504     *
22505     * @ingroup Map
22506     */
22507    typedef enum _Elm_Map_Route_Type
22508      {
22509         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22510         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22511         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22512         ELM_MAP_ROUTE_TYPE_LAST
22513      } Elm_Map_Route_Type;
22514
22515    /**
22516     * @enum _Elm_Map_Route_Method
22517     * @typedef Elm_Map_Route_Method
22518     *
22519     * Set the routing method, what should be priorized, time or distance.
22520     *
22521     * @see elm_map_route_add()
22522     *
22523     * @ingroup Map
22524     */
22525    typedef enum _Elm_Map_Route_Method
22526      {
22527         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22528         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22529         ELM_MAP_ROUTE_METHOD_LAST
22530      } Elm_Map_Route_Method;
22531
22532    typedef enum _Elm_Map_Name_Method
22533      {
22534         ELM_MAP_NAME_METHOD_SEARCH,
22535         ELM_MAP_NAME_METHOD_REVERSE,
22536         ELM_MAP_NAME_METHOD_LAST
22537      } Elm_Map_Name_Method;
22538
22539    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(). */
22540    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(). */
22541    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(). */
22542    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(). */
22543    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22544    typedef struct _Elm_Map_Track           Elm_Map_Track;
22545
22546    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. */
22547    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22548    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22549    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22550
22551    typedef char        *(*ElmMapModuleSourceFunc) (void);
22552    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22553    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22554    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22555    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22556    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22557    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22558    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22559    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22560
22561    /**
22562     * Add a new map widget to the given parent Elementary (container) object.
22563     *
22564     * @param parent The parent object.
22565     * @return a new map widget handle or @c NULL, on errors.
22566     *
22567     * This function inserts a new map widget on the canvas.
22568     *
22569     * @ingroup Map
22570     */
22571    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22572
22573    /**
22574     * Set the zoom level of the map.
22575     *
22576     * @param obj The map object.
22577     * @param zoom The zoom level to set.
22578     *
22579     * This sets the zoom level.
22580     *
22581     * It will respect limits defined by elm_map_source_zoom_min_set() and
22582     * elm_map_source_zoom_max_set().
22583     *
22584     * By default these values are 0 (world map) and 18 (maximum zoom).
22585     *
22586     * This function should be used when zoom mode is set to
22587     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22588     * with elm_map_zoom_mode_set().
22589     *
22590     * @see elm_map_zoom_mode_set().
22591     * @see elm_map_zoom_get().
22592     *
22593     * @ingroup Map
22594     */
22595    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22596
22597    /**
22598     * Get the zoom level of the map.
22599     *
22600     * @param obj The map object.
22601     * @return The current zoom level.
22602     *
22603     * This returns the current zoom level of the map object.
22604     *
22605     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22606     * (which is the default), the zoom level may be changed at any time by the
22607     * map object itself to account for map size and map viewport size.
22608     *
22609     * @see elm_map_zoom_set() for details.
22610     *
22611     * @ingroup Map
22612     */
22613    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22614
22615    /**
22616     * Set the zoom mode used by the map object.
22617     *
22618     * @param obj The map object.
22619     * @param mode The zoom mode of the map, being it one of
22620     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22621     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22622     *
22623     * This sets the zoom mode to manual or one of the automatic levels.
22624     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22625     * elm_map_zoom_set() and will stay at that level until changed by code
22626     * or until zoom mode is changed. This is the default mode.
22627     *
22628     * The Automatic modes will allow the map object to automatically
22629     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22630     * adjust zoom so the map fits inside the scroll frame with no pixels
22631     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22632     * ensure no pixels within the frame are left unfilled. Do not forget that
22633     * the valid sizes are 2^zoom, consequently the map may be smaller than
22634     * the scroller view.
22635     *
22636     * @see elm_map_zoom_set()
22637     *
22638     * @ingroup Map
22639     */
22640    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22641
22642    /**
22643     * Get the zoom mode used by the map object.
22644     *
22645     * @param obj The map object.
22646     * @return The zoom mode of the map, being it one of
22647     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22648     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22649     *
22650     * This function returns the current zoom mode used by the map object.
22651     *
22652     * @see elm_map_zoom_mode_set() for more details.
22653     *
22654     * @ingroup Map
22655     */
22656    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22657
22658    /**
22659     * Get the current coordinates of the map.
22660     *
22661     * @param obj The map object.
22662     * @param lon Pointer where to store longitude.
22663     * @param lat Pointer where to store latitude.
22664     *
22665     * This gets the current center coordinates of the map object. It can be
22666     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22667     *
22668     * @see elm_map_geo_region_bring_in()
22669     * @see elm_map_geo_region_show()
22670     *
22671     * @ingroup Map
22672     */
22673    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22674
22675    /**
22676     * Animatedly bring in given coordinates to the center of the map.
22677     *
22678     * @param obj The map object.
22679     * @param lon Longitude to center at.
22680     * @param lat Latitude to center at.
22681     *
22682     * This causes map to jump to the given @p lat and @p lon coordinates
22683     * and show it (by scrolling) in the center of the viewport, if it is not
22684     * already centered. This will use animation to do so and take a period
22685     * of time to complete.
22686     *
22687     * @see elm_map_geo_region_show() for a function to avoid animation.
22688     * @see elm_map_geo_region_get()
22689     *
22690     * @ingroup Map
22691     */
22692    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22693
22694    /**
22695     * Show the given coordinates at the center of the map, @b immediately.
22696     *
22697     * @param obj The map object.
22698     * @param lon Longitude to center at.
22699     * @param lat Latitude to center at.
22700     *
22701     * This causes map to @b redraw its viewport's contents to the
22702     * region contining the given @p lat and @p lon, that will be moved to the
22703     * center of the map.
22704     *
22705     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22706     * @see elm_map_geo_region_get()
22707     *
22708     * @ingroup Map
22709     */
22710    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22711
22712    /**
22713     * Pause or unpause the map.
22714     *
22715     * @param obj The map object.
22716     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22717     * to unpause it.
22718     *
22719     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22720     * for map.
22721     *
22722     * The default is off.
22723     *
22724     * This will stop zooming using animation, changing zoom levels will
22725     * change instantly. This will stop any existing animations that are running.
22726     *
22727     * @see elm_map_paused_get()
22728     *
22729     * @ingroup Map
22730     */
22731    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22732
22733    /**
22734     * Get a value whether map is paused or not.
22735     *
22736     * @param obj The map object.
22737     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22738     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22739     *
22740     * This gets the current paused state for the map object.
22741     *
22742     * @see elm_map_paused_set() for details.
22743     *
22744     * @ingroup Map
22745     */
22746    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22747
22748    /**
22749     * Set to show markers during zoom level changes or not.
22750     *
22751     * @param obj The map object.
22752     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22753     * to show them.
22754     *
22755     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22756     * for map.
22757     *
22758     * The default is off.
22759     *
22760     * This will stop zooming using animation, changing zoom levels will
22761     * change instantly. This will stop any existing animations that are running.
22762     *
22763     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22764     * for the markers.
22765     *
22766     * The default  is off.
22767     *
22768     * Enabling it will force the map to stop displaying the markers during
22769     * zoom level changes. Set to on if you have a large number of markers.
22770     *
22771     * @see elm_map_paused_markers_get()
22772     *
22773     * @ingroup Map
22774     */
22775    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22776
22777    /**
22778     * Get a value whether markers will be displayed on zoom level changes or not
22779     *
22780     * @param obj The map object.
22781     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22782     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22783     *
22784     * This gets the current markers paused state for the map object.
22785     *
22786     * @see elm_map_paused_markers_set() for details.
22787     *
22788     * @ingroup Map
22789     */
22790    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22791
22792    /**
22793     * Get the information of downloading status.
22794     *
22795     * @param obj The map object.
22796     * @param try_num Pointer where to store number of tiles being downloaded.
22797     * @param finish_num Pointer where to store number of tiles successfully
22798     * downloaded.
22799     *
22800     * This gets the current downloading status for the map object, the number
22801     * of tiles being downloaded and the number of tiles already downloaded.
22802     *
22803     * @ingroup Map
22804     */
22805    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22806
22807    /**
22808     * Convert a pixel coordinate (x,y) into a geographic coordinate
22809     * (longitude, latitude).
22810     *
22811     * @param obj The map object.
22812     * @param x the coordinate.
22813     * @param y the coordinate.
22814     * @param size the size in pixels of the map.
22815     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22816     * @param lon Pointer where to store the longitude that correspond to x.
22817     * @param lat Pointer where to store the latitude that correspond to y.
22818     *
22819     * @note Origin pixel point is the top left corner of the viewport.
22820     * Map zoom and size are taken on account.
22821     *
22822     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22823     *
22824     * @ingroup Map
22825     */
22826    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);
22827
22828    /**
22829     * Convert a geographic coordinate (longitude, latitude) into a pixel
22830     * coordinate (x, y).
22831     *
22832     * @param obj The map object.
22833     * @param lon the longitude.
22834     * @param lat the latitude.
22835     * @param size the size in pixels of the map. The map is a square
22836     * and generally his size is : pow(2.0, zoom)*256.
22837     * @param x Pointer where to store the horizontal pixel coordinate that
22838     * correspond to the longitude.
22839     * @param y Pointer where to store the vertical pixel coordinate that
22840     * correspond to the latitude.
22841     *
22842     * @note Origin pixel point is the top left corner of the viewport.
22843     * Map zoom and size are taken on account.
22844     *
22845     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22846     *
22847     * @ingroup Map
22848     */
22849    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);
22850
22851    /**
22852     * Convert a geographic coordinate (longitude, latitude) into a name
22853     * (address).
22854     *
22855     * @param obj The map object.
22856     * @param lon the longitude.
22857     * @param lat the latitude.
22858     * @return name A #Elm_Map_Name handle for this coordinate.
22859     *
22860     * To get the string for this address, elm_map_name_address_get()
22861     * should be used.
22862     *
22863     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22864     *
22865     * @ingroup Map
22866     */
22867    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22868
22869    /**
22870     * Convert a name (address) into a geographic coordinate
22871     * (longitude, latitude).
22872     *
22873     * @param obj The map object.
22874     * @param name The address.
22875     * @return name A #Elm_Map_Name handle for this address.
22876     *
22877     * To get the longitude and latitude, elm_map_name_region_get()
22878     * should be used.
22879     *
22880     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22881     *
22882     * @ingroup Map
22883     */
22884    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22885
22886    /**
22887     * Convert a pixel coordinate into a rotated pixel coordinate.
22888     *
22889     * @param obj The map object.
22890     * @param x horizontal coordinate of the point to rotate.
22891     * @param y vertical coordinate of the point to rotate.
22892     * @param cx rotation's center horizontal position.
22893     * @param cy rotation's center vertical position.
22894     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22895     * @param xx Pointer where to store rotated x.
22896     * @param yy Pointer where to store rotated y.
22897     *
22898     * @ingroup Map
22899     */
22900    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);
22901
22902    /**
22903     * Add a new marker to the map object.
22904     *
22905     * @param obj The map object.
22906     * @param lon The longitude of the marker.
22907     * @param lat The latitude of the marker.
22908     * @param clas The class, to use when marker @b isn't grouped to others.
22909     * @param clas_group The class group, to use when marker is grouped to others
22910     * @param data The data passed to the callbacks.
22911     *
22912     * @return The created marker or @c NULL upon failure.
22913     *
22914     * A marker will be created and shown in a specific point of the map, defined
22915     * by @p lon and @p lat.
22916     *
22917     * It will be displayed using style defined by @p class when this marker
22918     * is displayed alone (not grouped). A new class can be created with
22919     * elm_map_marker_class_new().
22920     *
22921     * If the marker is grouped to other markers, it will be displayed with
22922     * style defined by @p class_group. Markers with the same group are grouped
22923     * if they are close. A new group class can be created with
22924     * elm_map_marker_group_class_new().
22925     *
22926     * Markers created with this method can be deleted with
22927     * elm_map_marker_remove().
22928     *
22929     * A marker can have associated content to be displayed by a bubble,
22930     * when a user click over it, as well as an icon. These objects will
22931     * be fetch using class' callback functions.
22932     *
22933     * @see elm_map_marker_class_new()
22934     * @see elm_map_marker_group_class_new()
22935     * @see elm_map_marker_remove()
22936     *
22937     * @ingroup Map
22938     */
22939    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);
22940
22941    /**
22942     * Set the maximum numbers of markers' content to be displayed in a group.
22943     *
22944     * @param obj The map object.
22945     * @param max The maximum numbers of items displayed in a bubble.
22946     *
22947     * A bubble will be displayed when the user clicks over the group,
22948     * and will place the content of markers that belong to this group
22949     * inside it.
22950     *
22951     * A group can have a long list of markers, consequently the creation
22952     * of the content of the bubble can be very slow.
22953     *
22954     * In order to avoid this, a maximum number of items is displayed
22955     * in a bubble.
22956     *
22957     * By default this number is 30.
22958     *
22959     * Marker with the same group class are grouped if they are close.
22960     *
22961     * @see elm_map_marker_add()
22962     *
22963     * @ingroup Map
22964     */
22965    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22966
22967    /**
22968     * Remove a marker from the map.
22969     *
22970     * @param marker The marker to remove.
22971     *
22972     * @see elm_map_marker_add()
22973     *
22974     * @ingroup Map
22975     */
22976    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22977
22978    /**
22979     * Get the current coordinates of the marker.
22980     *
22981     * @param marker marker.
22982     * @param lat Pointer where to store the marker's latitude.
22983     * @param lon Pointer where to store the marker's longitude.
22984     *
22985     * These values are set when adding markers, with function
22986     * elm_map_marker_add().
22987     *
22988     * @see elm_map_marker_add()
22989     *
22990     * @ingroup Map
22991     */
22992    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22993
22994    /**
22995     * Animatedly bring in given marker to the center of the map.
22996     *
22997     * @param marker The marker to center at.
22998     *
22999     * This causes map to jump to the given @p marker's coordinates
23000     * and show it (by scrolling) in the center of the viewport, if it is not
23001     * already centered. This will use animation to do so and take a period
23002     * of time to complete.
23003     *
23004     * @see elm_map_marker_show() for a function to avoid animation.
23005     * @see elm_map_marker_region_get()
23006     *
23007     * @ingroup Map
23008     */
23009    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23010
23011    /**
23012     * Show the given marker at the center of the map, @b immediately.
23013     *
23014     * @param marker The marker to center at.
23015     *
23016     * This causes map to @b redraw its viewport's contents to the
23017     * region contining the given @p marker's coordinates, that will be
23018     * moved to the center of the map.
23019     *
23020     * @see elm_map_marker_bring_in() for a function to move with animation.
23021     * @see elm_map_markers_list_show() if more than one marker need to be
23022     * displayed.
23023     * @see elm_map_marker_region_get()
23024     *
23025     * @ingroup Map
23026     */
23027    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23028
23029    /**
23030     * Move and zoom the map to display a list of markers.
23031     *
23032     * @param markers A list of #Elm_Map_Marker handles.
23033     *
23034     * The map will be centered on the center point of the markers in the list.
23035     * Then the map will be zoomed in order to fit the markers using the maximum
23036     * zoom which allows display of all the markers.
23037     *
23038     * @warning All the markers should belong to the same map object.
23039     *
23040     * @see elm_map_marker_show() to show a single marker.
23041     * @see elm_map_marker_bring_in()
23042     *
23043     * @ingroup Map
23044     */
23045    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23046
23047    /**
23048     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23049     *
23050     * @param marker The marker wich content should be returned.
23051     * @return Return the evas object if it exists, else @c NULL.
23052     *
23053     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23054     * elm_map_marker_class_get_cb_set() should be used.
23055     *
23056     * This content is what will be inside the bubble that will be displayed
23057     * when an user clicks over the marker.
23058     *
23059     * This returns the actual Evas object used to be placed inside
23060     * the bubble. This may be @c NULL, as it may
23061     * not have been created or may have been deleted, at any time, by
23062     * the map. <b>Do not modify this object</b> (move, resize,
23063     * show, hide, etc.), as the map is controlling it. This
23064     * function is for querying, emitting custom signals or hooking
23065     * lower level callbacks for events on that object. Do not delete
23066     * this object under any circumstances.
23067     *
23068     * @ingroup Map
23069     */
23070    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23071
23072    /**
23073     * Update the marker
23074     *
23075     * @param marker The marker to be updated.
23076     *
23077     * If a content is set to this marker, it will call function to delete it,
23078     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23079     * #ElmMapMarkerGetFunc.
23080     *
23081     * These functions are set for the marker class with
23082     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23083     *
23084     * @ingroup Map
23085     */
23086    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23087
23088    /**
23089     * Close all the bubbles opened by the user.
23090     *
23091     * @param obj The map object.
23092     *
23093     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23094     * when the user clicks on a marker.
23095     *
23096     * This functions is set for the marker class with
23097     * elm_map_marker_class_get_cb_set().
23098     *
23099     * @ingroup Map
23100     */
23101    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23102
23103    /**
23104     * Create a new group class.
23105     *
23106     * @param obj The map object.
23107     * @return Returns the new group class.
23108     *
23109     * Each marker must be associated to a group class. Markers in the same
23110     * group are grouped if they are close.
23111     *
23112     * The group class defines the style of the marker when a marker is grouped
23113     * to others markers. When it is alone, another class will be used.
23114     *
23115     * A group class will need to be provided when creating a marker with
23116     * elm_map_marker_add().
23117     *
23118     * Some properties and functions can be set by class, as:
23119     * - style, with elm_map_group_class_style_set()
23120     * - data - to be associated to the group class. It can be set using
23121     *   elm_map_group_class_data_set().
23122     * - min zoom to display markers, set with
23123     *   elm_map_group_class_zoom_displayed_set().
23124     * - max zoom to group markers, set using
23125     *   elm_map_group_class_zoom_grouped_set().
23126     * - visibility - set if markers will be visible or not, set with
23127     *   elm_map_group_class_hide_set().
23128     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23129     *   It can be set using elm_map_group_class_icon_cb_set().
23130     *
23131     * @see elm_map_marker_add()
23132     * @see elm_map_group_class_style_set()
23133     * @see elm_map_group_class_data_set()
23134     * @see elm_map_group_class_zoom_displayed_set()
23135     * @see elm_map_group_class_zoom_grouped_set()
23136     * @see elm_map_group_class_hide_set()
23137     * @see elm_map_group_class_icon_cb_set()
23138     *
23139     * @ingroup Map
23140     */
23141    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23142
23143    /**
23144     * Set the marker's style of a group class.
23145     *
23146     * @param clas The group class.
23147     * @param style The style to be used by markers.
23148     *
23149     * Each marker must be associated to a group class, and will use the style
23150     * defined by such class when grouped to other markers.
23151     *
23152     * The following styles are provided by default theme:
23153     * @li @c radio - blue circle
23154     * @li @c radio2 - green circle
23155     * @li @c empty
23156     *
23157     * @see elm_map_group_class_new() for more details.
23158     * @see elm_map_marker_add()
23159     *
23160     * @ingroup Map
23161     */
23162    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23163
23164    /**
23165     * Set the icon callback function of a group class.
23166     *
23167     * @param clas The group class.
23168     * @param icon_get The callback function that will return the icon.
23169     *
23170     * Each marker must be associated to a group class, and it can display a
23171     * custom icon. The function @p icon_get must return this icon.
23172     *
23173     * @see elm_map_group_class_new() for more details.
23174     * @see elm_map_marker_add()
23175     *
23176     * @ingroup Map
23177     */
23178    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23179
23180    /**
23181     * Set the data associated to the group class.
23182     *
23183     * @param clas The group class.
23184     * @param data The new user data.
23185     *
23186     * This data will be passed for callback functions, like icon get callback,
23187     * that can be set with elm_map_group_class_icon_cb_set().
23188     *
23189     * If a data was previously set, the object will lose the pointer for it,
23190     * so if needs to be freed, you must do it yourself.
23191     *
23192     * @see elm_map_group_class_new() for more details.
23193     * @see elm_map_group_class_icon_cb_set()
23194     * @see elm_map_marker_add()
23195     *
23196     * @ingroup Map
23197     */
23198    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23199
23200    /**
23201     * Set the minimum zoom from where the markers are displayed.
23202     *
23203     * @param clas The group class.
23204     * @param zoom The minimum zoom.
23205     *
23206     * Markers only will be displayed when the map is displayed at @p zoom
23207     * or bigger.
23208     *
23209     * @see elm_map_group_class_new() for more details.
23210     * @see elm_map_marker_add()
23211     *
23212     * @ingroup Map
23213     */
23214    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23215
23216    /**
23217     * Set the zoom from where the markers are no more grouped.
23218     *
23219     * @param clas The group class.
23220     * @param zoom The maximum zoom.
23221     *
23222     * Markers only will be grouped when the map is displayed at
23223     * less than @p zoom.
23224     *
23225     * @see elm_map_group_class_new() for more details.
23226     * @see elm_map_marker_add()
23227     *
23228     * @ingroup Map
23229     */
23230    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23231
23232    /**
23233     * Set if the markers associated to the group class @clas are hidden or not.
23234     *
23235     * @param clas The group class.
23236     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23237     * to show them.
23238     *
23239     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23240     * is to show them.
23241     *
23242     * @ingroup Map
23243     */
23244    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23245
23246    /**
23247     * Create a new marker class.
23248     *
23249     * @param obj The map object.
23250     * @return Returns the new group class.
23251     *
23252     * Each marker must be associated to a class.
23253     *
23254     * The marker class defines the style of the marker when a marker is
23255     * displayed alone, i.e., not grouped to to others markers. When grouped
23256     * it will use group class style.
23257     *
23258     * A marker class will need to be provided when creating a marker with
23259     * elm_map_marker_add().
23260     *
23261     * Some properties and functions can be set by class, as:
23262     * - style, with elm_map_marker_class_style_set()
23263     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23264     *   It can be set using elm_map_marker_class_icon_cb_set().
23265     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23266     *   Set using elm_map_marker_class_get_cb_set().
23267     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23268     *   Set using elm_map_marker_class_del_cb_set().
23269     *
23270     * @see elm_map_marker_add()
23271     * @see elm_map_marker_class_style_set()
23272     * @see elm_map_marker_class_icon_cb_set()
23273     * @see elm_map_marker_class_get_cb_set()
23274     * @see elm_map_marker_class_del_cb_set()
23275     *
23276     * @ingroup Map
23277     */
23278    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23279
23280    /**
23281     * Set the marker's style of a marker class.
23282     *
23283     * @param clas The marker class.
23284     * @param style The style to be used by markers.
23285     *
23286     * Each marker must be associated to a marker class, and will use the style
23287     * defined by such class when alone, i.e., @b not grouped to other markers.
23288     *
23289     * The following styles are provided by default theme:
23290     * @li @c radio
23291     * @li @c radio2
23292     * @li @c empty
23293     *
23294     * @see elm_map_marker_class_new() for more details.
23295     * @see elm_map_marker_add()
23296     *
23297     * @ingroup Map
23298     */
23299    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23300
23301    /**
23302     * Set the icon callback function of a marker class.
23303     *
23304     * @param clas The marker class.
23305     * @param icon_get The callback function that will return the icon.
23306     *
23307     * Each marker must be associated to a marker class, and it can display a
23308     * custom icon. The function @p icon_get must return this icon.
23309     *
23310     * @see elm_map_marker_class_new() for more details.
23311     * @see elm_map_marker_add()
23312     *
23313     * @ingroup Map
23314     */
23315    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23316
23317    /**
23318     * Set the bubble content callback function of a marker class.
23319     *
23320     * @param clas The marker class.
23321     * @param get The callback function that will return the content.
23322     *
23323     * Each marker must be associated to a marker class, and it can display a
23324     * a content on a bubble that opens when the user click over the marker.
23325     * The function @p get must return this content object.
23326     *
23327     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23328     * can be used.
23329     *
23330     * @see elm_map_marker_class_new() for more details.
23331     * @see elm_map_marker_class_del_cb_set()
23332     * @see elm_map_marker_add()
23333     *
23334     * @ingroup Map
23335     */
23336    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23337
23338    /**
23339     * Set the callback function used to delete bubble content of a marker class.
23340     *
23341     * @param clas The marker class.
23342     * @param del The callback function that will delete the content.
23343     *
23344     * Each marker must be associated to a marker class, and it can display a
23345     * a content on a bubble that opens when the user click over the marker.
23346     * The function to return such content can be set with
23347     * elm_map_marker_class_get_cb_set().
23348     *
23349     * If this content must be freed, a callback function need to be
23350     * set for that task with this function.
23351     *
23352     * If this callback is defined it will have to delete (or not) the
23353     * object inside, but if the callback is not defined the object will be
23354     * destroyed with evas_object_del().
23355     *
23356     * @see elm_map_marker_class_new() for more details.
23357     * @see elm_map_marker_class_get_cb_set()
23358     * @see elm_map_marker_add()
23359     *
23360     * @ingroup Map
23361     */
23362    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23363
23364    /**
23365     * Get the list of available sources.
23366     *
23367     * @param obj The map object.
23368     * @return The source names list.
23369     *
23370     * It will provide a list with all available sources, that can be set as
23371     * current source with elm_map_source_name_set(), or get with
23372     * elm_map_source_name_get().
23373     *
23374     * Available sources:
23375     * @li "Mapnik"
23376     * @li "Osmarender"
23377     * @li "CycleMap"
23378     * @li "Maplint"
23379     *
23380     * @see elm_map_source_name_set() for more details.
23381     * @see elm_map_source_name_get()
23382     *
23383     * @ingroup Map
23384     */
23385    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23386
23387    /**
23388     * Set the source of the map.
23389     *
23390     * @param obj The map object.
23391     * @param source The source to be used.
23392     *
23393     * Map widget retrieves images that composes the map from a web service.
23394     * This web service can be set with this method.
23395     *
23396     * A different service can return a different maps with different
23397     * information and it can use different zoom values.
23398     *
23399     * The @p source_name need to match one of the names provided by
23400     * elm_map_source_names_get().
23401     *
23402     * The current source can be get using elm_map_source_name_get().
23403     *
23404     * @see elm_map_source_names_get()
23405     * @see elm_map_source_name_get()
23406     *
23407     *
23408     * @ingroup Map
23409     */
23410    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23411
23412    /**
23413     * Get the name of currently used source.
23414     *
23415     * @param obj The map object.
23416     * @return Returns the name of the source in use.
23417     *
23418     * @see elm_map_source_name_set() for more details.
23419     *
23420     * @ingroup Map
23421     */
23422    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23423
23424    /**
23425     * Set the source of the route service to be used by the map.
23426     *
23427     * @param obj The map object.
23428     * @param source The route service to be used, being it one of
23429     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23430     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23431     *
23432     * Each one has its own algorithm, so the route retrieved may
23433     * differ depending on the source route. Now, only the default is working.
23434     *
23435     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23436     * http://www.yournavigation.org/.
23437     *
23438     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23439     * assumptions. Its routing core is based on Contraction Hierarchies.
23440     *
23441     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23442     *
23443     * @see elm_map_route_source_get().
23444     *
23445     * @ingroup Map
23446     */
23447    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23448
23449    /**
23450     * Get the current route source.
23451     *
23452     * @param obj The map object.
23453     * @return The source of the route service used by the map.
23454     *
23455     * @see elm_map_route_source_set() for details.
23456     *
23457     * @ingroup Map
23458     */
23459    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23460
23461    /**
23462     * Set the minimum zoom of the source.
23463     *
23464     * @param obj The map object.
23465     * @param zoom New minimum zoom value to be used.
23466     *
23467     * By default, it's 0.
23468     *
23469     * @ingroup Map
23470     */
23471    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23472
23473    /**
23474     * Get the minimum zoom of the source.
23475     *
23476     * @param obj The map object.
23477     * @return Returns the minimum zoom of the source.
23478     *
23479     * @see elm_map_source_zoom_min_set() for details.
23480     *
23481     * @ingroup Map
23482     */
23483    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23484
23485    /**
23486     * Set the maximum zoom of the source.
23487     *
23488     * @param obj The map object.
23489     * @param zoom New maximum zoom value to be used.
23490     *
23491     * By default, it's 18.
23492     *
23493     * @ingroup Map
23494     */
23495    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23496
23497    /**
23498     * Get the maximum zoom of the source.
23499     *
23500     * @param obj The map object.
23501     * @return Returns the maximum zoom of the source.
23502     *
23503     * @see elm_map_source_zoom_min_set() for details.
23504     *
23505     * @ingroup Map
23506     */
23507    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23508
23509    /**
23510     * Set the user agent used by the map object to access routing services.
23511     *
23512     * @param obj The map object.
23513     * @param user_agent The user agent to be used by the map.
23514     *
23515     * User agent is a client application implementing a network protocol used
23516     * in communications within a client–server distributed computing system
23517     *
23518     * The @p user_agent identification string will transmitted in a header
23519     * field @c User-Agent.
23520     *
23521     * @see elm_map_user_agent_get()
23522     *
23523     * @ingroup Map
23524     */
23525    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23526
23527    /**
23528     * Get the user agent used by the map object.
23529     *
23530     * @param obj The map object.
23531     * @return The user agent identification string used by the map.
23532     *
23533     * @see elm_map_user_agent_set() for details.
23534     *
23535     * @ingroup Map
23536     */
23537    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23538
23539    /**
23540     * Add a new route to the map object.
23541     *
23542     * @param obj The map object.
23543     * @param type The type of transport to be considered when tracing a route.
23544     * @param method The routing method, what should be priorized.
23545     * @param flon The start longitude.
23546     * @param flat The start latitude.
23547     * @param tlon The destination longitude.
23548     * @param tlat The destination latitude.
23549     *
23550     * @return The created route or @c NULL upon failure.
23551     *
23552     * A route will be traced by point on coordinates (@p flat, @p flon)
23553     * to point on coordinates (@p tlat, @p tlon), using the route service
23554     * set with elm_map_route_source_set().
23555     *
23556     * It will take @p type on consideration to define the route,
23557     * depending if the user will be walking or driving, the route may vary.
23558     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23559     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23560     *
23561     * Another parameter is what the route should priorize, the minor distance
23562     * or the less time to be spend on the route. So @p method should be one
23563     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23564     *
23565     * Routes created with this method can be deleted with
23566     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23567     * and distance can be get with elm_map_route_distance_get().
23568     *
23569     * @see elm_map_route_remove()
23570     * @see elm_map_route_color_set()
23571     * @see elm_map_route_distance_get()
23572     * @see elm_map_route_source_set()
23573     *
23574     * @ingroup Map
23575     */
23576    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);
23577
23578    /**
23579     * Remove a route from the map.
23580     *
23581     * @param route The route to remove.
23582     *
23583     * @see elm_map_route_add()
23584     *
23585     * @ingroup Map
23586     */
23587    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23588
23589    /**
23590     * Set the route color.
23591     *
23592     * @param route The route object.
23593     * @param r Red channel value, from 0 to 255.
23594     * @param g Green channel value, from 0 to 255.
23595     * @param b Blue channel value, from 0 to 255.
23596     * @param a Alpha channel value, from 0 to 255.
23597     *
23598     * It uses an additive color model, so each color channel represents
23599     * how much of each primary colors must to be used. 0 represents
23600     * ausence of this color, so if all of the three are set to 0,
23601     * the color will be black.
23602     *
23603     * These component values should be integers in the range 0 to 255,
23604     * (single 8-bit byte).
23605     *
23606     * This sets the color used for the route. By default, it is set to
23607     * solid red (r = 255, g = 0, b = 0, a = 255).
23608     *
23609     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23610     *
23611     * @see elm_map_route_color_get()
23612     *
23613     * @ingroup Map
23614     */
23615    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23616
23617    /**
23618     * Get the route color.
23619     *
23620     * @param route The route object.
23621     * @param r Pointer where to store the red channel value.
23622     * @param g Pointer where to store the green channel value.
23623     * @param b Pointer where to store the blue channel value.
23624     * @param a Pointer where to store the alpha channel value.
23625     *
23626     * @see elm_map_route_color_set() for details.
23627     *
23628     * @ingroup Map
23629     */
23630    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23631
23632    /**
23633     * Get the route distance in kilometers.
23634     *
23635     * @param route The route object.
23636     * @return The distance of route (unit : km).
23637     *
23638     * @ingroup Map
23639     */
23640    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23641
23642    /**
23643     * Get the information of route nodes.
23644     *
23645     * @param route The route object.
23646     * @return Returns a string with the nodes of route.
23647     *
23648     * @ingroup Map
23649     */
23650    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23651
23652    /**
23653     * Get the information of route waypoint.
23654     *
23655     * @param route the route object.
23656     * @return Returns a string with information about waypoint of route.
23657     *
23658     * @ingroup Map
23659     */
23660    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23661
23662    /**
23663     * Get the address of the name.
23664     *
23665     * @param name The name handle.
23666     * @return Returns the address string of @p name.
23667     *
23668     * This gets the coordinates of the @p name, created with one of the
23669     * conversion functions.
23670     *
23671     * @see elm_map_utils_convert_name_into_coord()
23672     * @see elm_map_utils_convert_coord_into_name()
23673     *
23674     * @ingroup Map
23675     */
23676    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23677
23678    /**
23679     * Get the current coordinates of the name.
23680     *
23681     * @param name The name handle.
23682     * @param lat Pointer where to store the latitude.
23683     * @param lon Pointer where to store The longitude.
23684     *
23685     * This gets the coordinates of the @p name, created with one of the
23686     * conversion functions.
23687     *
23688     * @see elm_map_utils_convert_name_into_coord()
23689     * @see elm_map_utils_convert_coord_into_name()
23690     *
23691     * @ingroup Map
23692     */
23693    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23694
23695    /**
23696     * Remove a name from the map.
23697     *
23698     * @param name The name to remove.
23699     *
23700     * Basically the struct handled by @p name will be freed, so convertions
23701     * between address and coordinates will be lost.
23702     *
23703     * @see elm_map_utils_convert_name_into_coord()
23704     * @see elm_map_utils_convert_coord_into_name()
23705     *
23706     * @ingroup Map
23707     */
23708    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23709
23710    /**
23711     * Rotate the map.
23712     *
23713     * @param obj The map object.
23714     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23715     * @param cx Rotation's center horizontal position.
23716     * @param cy Rotation's center vertical position.
23717     *
23718     * @see elm_map_rotate_get()
23719     *
23720     * @ingroup Map
23721     */
23722    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23723
23724    /**
23725     * Get the rotate degree of the map
23726     *
23727     * @param obj The map object
23728     * @param degree Pointer where to store degrees from 0.0 to 360.0
23729     * to rotate arount Z axis.
23730     * @param cx Pointer where to store rotation's center horizontal position.
23731     * @param cy Pointer where to store rotation's center vertical position.
23732     *
23733     * @see elm_map_rotate_set() to set map rotation.
23734     *
23735     * @ingroup Map
23736     */
23737    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);
23738
23739    /**
23740     * Enable or disable mouse wheel to be used to zoom in / out the map.
23741     *
23742     * @param obj The map object.
23743     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23744     * to enable it.
23745     *
23746     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23747     *
23748     * It's disabled by default.
23749     *
23750     * @see elm_map_wheel_disabled_get()
23751     *
23752     * @ingroup Map
23753     */
23754    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23755
23756    /**
23757     * Get a value whether mouse wheel is enabled or not.
23758     *
23759     * @param obj The map object.
23760     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23761     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23762     *
23763     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23764     *
23765     * @see elm_map_wheel_disabled_set() for details.
23766     *
23767     * @ingroup Map
23768     */
23769    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23770
23771 #ifdef ELM_EMAP
23772    /**
23773     * Add a track on the map
23774     *
23775     * @param obj The map object.
23776     * @param emap The emap route object.
23777     * @return The route object. This is an elm object of type Route.
23778     *
23779     * @see elm_route_add() for details.
23780     *
23781     * @ingroup Map
23782     */
23783    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23784 #endif
23785
23786    /**
23787     * Remove a track from the map
23788     *
23789     * @param obj The map object.
23790     * @param route The track to remove.
23791     *
23792     * @ingroup Map
23793     */
23794    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23795
23796    /**
23797     * @}
23798     */
23799
23800    /* Route */
23801    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23802 #ifdef ELM_EMAP
23803    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23804 #endif
23805    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23806    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23807    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23808    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23809
23810
23811    /**
23812     * @defgroup Panel Panel
23813     *
23814     * @image html img/widget/panel/preview-00.png
23815     * @image latex img/widget/panel/preview-00.eps
23816     *
23817     * @brief A panel is a type of animated container that contains subobjects.
23818     * It can be expanded or contracted by clicking the button on it's edge.
23819     *
23820     * Orientations are as follows:
23821     * @li ELM_PANEL_ORIENT_TOP
23822     * @li ELM_PANEL_ORIENT_LEFT
23823     * @li ELM_PANEL_ORIENT_RIGHT
23824     *
23825     * Default contents parts of the panel widget that you can use for are:
23826     * @li "default" - A content of the panel
23827     *
23828     * @ref tutorial_panel shows one way to use this widget.
23829     * @{
23830     */
23831    typedef enum _Elm_Panel_Orient
23832      {
23833         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23834         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23835         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23836         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23837      } Elm_Panel_Orient;
23838    /**
23839     * @brief Adds a panel object
23840     *
23841     * @param parent The parent object
23842     *
23843     * @return The panel object, or NULL on failure
23844     */
23845    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23846    /**
23847     * @brief Sets the orientation of the panel
23848     *
23849     * @param parent The parent object
23850     * @param orient The panel orientation. Can be one of the following:
23851     * @li ELM_PANEL_ORIENT_TOP
23852     * @li ELM_PANEL_ORIENT_LEFT
23853     * @li ELM_PANEL_ORIENT_RIGHT
23854     *
23855     * Sets from where the panel will (dis)appear.
23856     */
23857    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23858    /**
23859     * @brief Get the orientation of the panel.
23860     *
23861     * @param obj The panel object
23862     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23863     */
23864    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23865    /**
23866     * @brief Set the content of the panel.
23867     *
23868     * @param obj The panel object
23869     * @param content The panel content
23870     *
23871     * Once the content object is set, a previously set one will be deleted.
23872     * If you want to keep that old content object, use the
23873     * elm_panel_content_unset() function.
23874     */
23875    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23876    /**
23877     * @brief Get the content of the panel.
23878     *
23879     * @param obj The panel object
23880     * @return The content that is being used
23881     *
23882     * Return the content object which is set for this widget.
23883     *
23884     * @see elm_panel_content_set()
23885     */
23886    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23887    /**
23888     * @brief Unset the content of the panel.
23889     *
23890     * @param obj The panel object
23891     * @return The content that was being used
23892     *
23893     * Unparent and return the content object which was set for this widget.
23894     *
23895     * @see elm_panel_content_set()
23896     */
23897    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23898    /**
23899     * @brief Set the state of the panel.
23900     *
23901     * @param obj The panel object
23902     * @param hidden If true, the panel will run the animation to contract
23903     */
23904    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23905    /**
23906     * @brief Get the state of the panel.
23907     *
23908     * @param obj The panel object
23909     * @param hidden If true, the panel is in the "hide" state
23910     */
23911    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23912    /**
23913     * @brief Toggle the hidden state of the panel from code
23914     *
23915     * @param obj The panel object
23916     */
23917    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23918    /**
23919     * @}
23920     */
23921
23922    /**
23923     * @defgroup Panes Panes
23924     * @ingroup Elementary
23925     *
23926     * @image html img/widget/panes/preview-00.png
23927     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23928     *
23929     * @image html img/panes.png
23930     * @image latex img/panes.eps width=\textwidth
23931     *
23932     * The panes adds a dragable bar between two contents. When dragged
23933     * this bar will resize contents size.
23934     *
23935     * Panes can be displayed vertically or horizontally, and contents
23936     * size proportion can be customized (homogeneous by default).
23937     *
23938     * Smart callbacks one can listen to:
23939     * - "press" - The panes has been pressed (button wasn't released yet).
23940     * - "unpressed" - The panes was released after being pressed.
23941     * - "clicked" - The panes has been clicked>
23942     * - "clicked,double" - The panes has been double clicked
23943     *
23944     * Available styles for it:
23945     * - @c "default"
23946     *
23947     * Default contents parts of the panes widget that you can use for are:
23948     * @li "left" - A leftside content of the panes
23949     * @li "right" - A rightside content of the panes
23950     *
23951     * If panes is displayed vertically, left content will be displayed at
23952     * top.
23953     * 
23954     * Here is an example on its usage:
23955     * @li @ref panes_example
23956     */
23957
23958    /**
23959     * @addtogroup Panes
23960     * @{
23961     */
23962
23963    /**
23964     * Add a new panes widget to the given parent Elementary
23965     * (container) object.
23966     *
23967     * @param parent The parent object.
23968     * @return a new panes widget handle or @c NULL, on errors.
23969     *
23970     * This function inserts a new panes widget on the canvas.
23971     *
23972     * @ingroup Panes
23973     */
23974    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23975
23976    /**
23977     * Set the left content of the panes widget.
23978     *
23979     * @param obj The panes object.
23980     * @param content The new left content object.
23981     *
23982     * Once the content object is set, a previously set one will be deleted.
23983     * If you want to keep that old content object, use the
23984     * elm_panes_content_left_unset() function.
23985     *
23986     * If panes is displayed vertically, left content will be displayed at
23987     * top.
23988     *
23989     * @see elm_panes_content_left_get()
23990     * @see elm_panes_content_right_set() to set content on the other side.
23991     *
23992     * @deprecated use elm_object_part_content_set() instead
23993     *
23994     * @ingroup Panes
23995     */
23996    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23997
23998    /**
23999     * Set the right content of the panes widget.
24000     *
24001     * @param obj The panes object.
24002     * @param content The new right content object.
24003     *
24004     * Once the content object is set, a previously set one will be deleted.
24005     * If you want to keep that old content object, use the
24006     * elm_panes_content_right_unset() function.
24007     *
24008     * If panes is displayed vertically, left content will be displayed at
24009     * bottom.
24010     *
24011     * @see elm_panes_content_right_get()
24012     * @see elm_panes_content_left_set() to set content on the other side.
24013     *
24014     * @deprecated use elm_object_part_content_set() instead
24015     *
24016     * @ingroup Panes
24017     */
24018    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24019
24020    /**
24021     * Get the left content of the panes.
24022     *
24023     * @param obj The panes object.
24024     * @return The left content object that is being used.
24025     *
24026     * Return the left content object which is set for this widget.
24027     *
24028     * @see elm_panes_content_left_set() for details.
24029     *
24030     * @deprecated use elm_object_part_content_get() instead
24031     *
24032     * @ingroup Panes
24033     */
24034    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24035
24036    /**
24037     * Get the right content of the panes.
24038     *
24039     * @param obj The panes object
24040     * @return The right content object that is being used
24041     *
24042     * Return the right content object which is set for this widget.
24043     *
24044     * @see elm_panes_content_right_set() for details.
24045     *
24046     * @deprecated use elm_object_part_content_get() instead
24047     *
24048     * @ingroup Panes
24049     */
24050    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24051
24052    /**
24053     * Unset the left content used for the panes.
24054     *
24055     * @param obj The panes object.
24056     * @return The left content object that was being used.
24057     *
24058     * Unparent and return the left content object which was set for this widget.
24059     *
24060     * @see elm_panes_content_left_set() for details.
24061     * @see elm_panes_content_left_get().
24062     *
24063     * @deprecated use elm_object_part_content_unset() instead
24064     *
24065     * @ingroup Panes
24066     */
24067    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24068
24069    /**
24070     * Unset the right content used for the panes.
24071     *
24072     * @param obj The panes object.
24073     * @return The right content object that was being used.
24074     *
24075     * Unparent and return the right content object which was set for this
24076     * widget.
24077     *
24078     * @see elm_panes_content_right_set() for details.
24079     * @see elm_panes_content_right_get().
24080     *
24081     * @deprecated use elm_object_part_content_unset() instead
24082     *
24083     * @ingroup Panes
24084     */
24085    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24086
24087    /**
24088     * Get the size proportion of panes widget's left side.
24089     *
24090     * @param obj The panes object.
24091     * @return float value between 0.0 and 1.0 representing size proportion
24092     * of left side.
24093     *
24094     * @see elm_panes_content_left_size_set() for more details.
24095     *
24096     * @ingroup Panes
24097     */
24098    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24099
24100    /**
24101     * Set the size proportion of panes widget's left side.
24102     *
24103     * @param obj The panes object.
24104     * @param size Value between 0.0 and 1.0 representing size proportion
24105     * of left side.
24106     *
24107     * By default it's homogeneous, i.e., both sides have the same size.
24108     *
24109     * If something different is required, it can be set with this function.
24110     * For example, if the left content should be displayed over
24111     * 75% of the panes size, @p size should be passed as @c 0.75.
24112     * This way, right content will be resized to 25% of panes size.
24113     *
24114     * If displayed vertically, left content is displayed at top, and
24115     * right content at bottom.
24116     *
24117     * @note This proportion will change when user drags the panes bar.
24118     *
24119     * @see elm_panes_content_left_size_get()
24120     *
24121     * @ingroup Panes
24122     */
24123    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24124
24125   /**
24126    * Set the orientation of a given panes widget.
24127    *
24128    * @param obj The panes object.
24129    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24130    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24131    *
24132    * Use this function to change how your panes is to be
24133    * disposed: vertically or horizontally.
24134    *
24135    * By default it's displayed horizontally.
24136    *
24137    * @see elm_panes_horizontal_get()
24138    *
24139    * @ingroup Panes
24140    */
24141    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24142
24143    /**
24144     * Retrieve the orientation of a given panes widget.
24145     *
24146     * @param obj The panes object.
24147     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24148     * @c EINA_FALSE if it's @b vertical (and on errors).
24149     *
24150     * @see elm_panes_horizontal_set() for more details.
24151     *
24152     * @ingroup Panes
24153     */
24154    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24155    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24156    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24157
24158    /**
24159     * @}
24160     */
24161
24162    /**
24163     * @defgroup Flip Flip
24164     *
24165     * @image html img/widget/flip/preview-00.png
24166     * @image latex img/widget/flip/preview-00.eps
24167     *
24168     * This widget holds 2 content objects(Evas_Object): one on the front and one
24169     * on the back. It allows you to flip from front to back and vice-versa using
24170     * various animations.
24171     *
24172     * If either the front or back contents are not set the flip will treat that
24173     * as transparent. So if you wore to set the front content but not the back,
24174     * and then call elm_flip_go() you would see whatever is below the flip.
24175     *
24176     * For a list of supported animations see elm_flip_go().
24177     *
24178     * Signals that you can add callbacks for are:
24179     * "animate,begin" - when a flip animation was started
24180     * "animate,done" - when a flip animation is finished
24181     *
24182     * @ref tutorial_flip show how to use most of the API.
24183     *
24184     * @{
24185     */
24186    typedef enum _Elm_Flip_Mode
24187      {
24188         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24189         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24190         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24191         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24192         ELM_FLIP_CUBE_LEFT,
24193         ELM_FLIP_CUBE_RIGHT,
24194         ELM_FLIP_CUBE_UP,
24195         ELM_FLIP_CUBE_DOWN,
24196         ELM_FLIP_PAGE_LEFT,
24197         ELM_FLIP_PAGE_RIGHT,
24198         ELM_FLIP_PAGE_UP,
24199         ELM_FLIP_PAGE_DOWN
24200      } Elm_Flip_Mode;
24201    typedef enum _Elm_Flip_Interaction
24202      {
24203         ELM_FLIP_INTERACTION_NONE,
24204         ELM_FLIP_INTERACTION_ROTATE,
24205         ELM_FLIP_INTERACTION_CUBE,
24206         ELM_FLIP_INTERACTION_PAGE
24207      } Elm_Flip_Interaction;
24208    typedef enum _Elm_Flip_Direction
24209      {
24210         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24211         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24212         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24213         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24214      } Elm_Flip_Direction;
24215    /**
24216     * @brief Add a new flip to the parent
24217     *
24218     * @param parent The parent object
24219     * @return The new object or NULL if it cannot be created
24220     */
24221    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24222    /**
24223     * @brief Set the front content of the flip widget.
24224     *
24225     * @param obj The flip object
24226     * @param content The new front content object
24227     *
24228     * Once the content object is set, a previously set one will be deleted.
24229     * If you want to keep that old content object, use the
24230     * elm_flip_content_front_unset() function.
24231     */
24232    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24233    /**
24234     * @brief Set the back content of the flip widget.
24235     *
24236     * @param obj The flip object
24237     * @param content The new back content object
24238     *
24239     * Once the content object is set, a previously set one will be deleted.
24240     * If you want to keep that old content object, use the
24241     * elm_flip_content_back_unset() function.
24242     */
24243    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24244    /**
24245     * @brief Get the front content used for the flip
24246     *
24247     * @param obj The flip object
24248     * @return The front content object that is being used
24249     *
24250     * Return the front content object which is set for this widget.
24251     */
24252    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24253    /**
24254     * @brief Get the back content used for the flip
24255     *
24256     * @param obj The flip object
24257     * @return The back content object that is being used
24258     *
24259     * Return the back content object which is set for this widget.
24260     */
24261    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24262    /**
24263     * @brief Unset the front content used for the flip
24264     *
24265     * @param obj The flip object
24266     * @return The front content object that was being used
24267     *
24268     * Unparent and return the front content object which was set for this widget.
24269     */
24270    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24271    /**
24272     * @brief Unset the back content used for the flip
24273     *
24274     * @param obj The flip object
24275     * @return The back content object that was being used
24276     *
24277     * Unparent and return the back content object which was set for this widget.
24278     */
24279    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24280    /**
24281     * @brief Get flip front visibility state
24282     *
24283     * @param obj The flip objct
24284     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24285     * showing.
24286     */
24287    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24288    /**
24289     * @brief Set flip perspective
24290     *
24291     * @param obj The flip object
24292     * @param foc The coordinate to set the focus on
24293     * @param x The X coordinate
24294     * @param y The Y coordinate
24295     *
24296     * @warning This function currently does nothing.
24297     */
24298    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24299    /**
24300     * @brief Runs the flip animation
24301     *
24302     * @param obj The flip object
24303     * @param mode The mode type
24304     *
24305     * Flips the front and back contents using the @p mode animation. This
24306     * efectively hides the currently visible content and shows the hidden one.
24307     *
24308     * There a number of possible animations to use for the flipping:
24309     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24310     * around a horizontal axis in the middle of its height, the other content
24311     * is shown as the other side of the flip.
24312     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24313     * around a vertical axis in the middle of its width, the other content is
24314     * shown as the other side of the flip.
24315     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24316     * around a diagonal axis in the middle of its width, the other content is
24317     * shown as the other side of the flip.
24318     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24319     * around a diagonal axis in the middle of its height, the other content is
24320     * shown as the other side of the flip.
24321     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24322     * as if the flip was a cube, the other content is show as the right face of
24323     * the cube.
24324     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24325     * right as if the flip was a cube, the other content is show as the left
24326     * face of the cube.
24327     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24328     * flip was a cube, the other content is show as the bottom face of the cube.
24329     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24330     * the flip was a cube, the other content is show as the upper face of the
24331     * cube.
24332     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24333     * if the flip was a book, the other content is shown as the page below that.
24334     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24335     * as if the flip was a book, the other content is shown as the page below
24336     * that.
24337     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24338     * flip was a book, the other content is shown as the page below that.
24339     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24340     * flip was a book, the other content is shown as the page below that.
24341     *
24342     * @image html elm_flip.png
24343     * @image latex elm_flip.eps width=\textwidth
24344     */
24345    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24346    /**
24347     * @brief Set the interactive flip mode
24348     *
24349     * @param obj The flip object
24350     * @param mode The interactive flip mode to use
24351     *
24352     * This sets if the flip should be interactive (allow user to click and
24353     * drag a side of the flip to reveal the back page and cause it to flip).
24354     * By default a flip is not interactive. You may also need to set which
24355     * sides of the flip are "active" for flipping and how much space they use
24356     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24357     * and elm_flip_interacton_direction_hitsize_set()
24358     *
24359     * The four avilable mode of interaction are:
24360     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24361     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24362     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24363     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24364     *
24365     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24366     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24367     * happen, those can only be acheived with elm_flip_go();
24368     */
24369    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24370    /**
24371     * @brief Get the interactive flip mode
24372     *
24373     * @param obj The flip object
24374     * @return The interactive flip mode
24375     *
24376     * Returns the interactive flip mode set by elm_flip_interaction_set()
24377     */
24378    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24379    /**
24380     * @brief Set which directions of the flip respond to interactive flip
24381     *
24382     * @param obj The flip object
24383     * @param dir The direction to change
24384     * @param enabled If that direction is enabled or not
24385     *
24386     * By default all directions are disabled, so you may want to enable the
24387     * desired directions for flipping if you need interactive flipping. You must
24388     * call this function once for each direction that should be enabled.
24389     *
24390     * @see elm_flip_interaction_set()
24391     */
24392    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24393    /**
24394     * @brief Get the enabled state of that flip direction
24395     *
24396     * @param obj The flip object
24397     * @param dir The direction to check
24398     * @return If that direction is enabled or not
24399     *
24400     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24401     *
24402     * @see elm_flip_interaction_set()
24403     */
24404    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24405    /**
24406     * @brief Set the amount of the flip that is sensitive to interactive flip
24407     *
24408     * @param obj The flip object
24409     * @param dir The direction to modify
24410     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24411     *
24412     * Set the amount of the flip that is sensitive to interactive flip, with 0
24413     * representing no area in the flip and 1 representing the entire flip. There
24414     * is however a consideration to be made in that the area will never be
24415     * smaller than the finger size set(as set in your Elementary configuration).
24416     *
24417     * @see elm_flip_interaction_set()
24418     */
24419    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24420    /**
24421     * @brief Get the amount of the flip that is sensitive to interactive flip
24422     *
24423     * @param obj The flip object
24424     * @param dir The direction to check
24425     * @return The size set for that direction
24426     *
24427     * Returns the amount os sensitive area set by
24428     * elm_flip_interacton_direction_hitsize_set().
24429     */
24430    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24431    /**
24432     * @}
24433     */
24434
24435    /* scrolledentry */
24436    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24437    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24438    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24439    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24440    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24441    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24442    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24443    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24444    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24445    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24446    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24447    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24448    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24449    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24450    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24451    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24452    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24453    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24454    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24455    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24456    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24457    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24458    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24459    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24460    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24461    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24462    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24463    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24464    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24465    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24466    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24467    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24468    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24469    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24470    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24471    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);
24472    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24473    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24474    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);
24475    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24476    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);
24477    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24478    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24479    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24480    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24481    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24482    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24483    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24484    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24485    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);
24486    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);
24487    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);
24488    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);
24489    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);
24490    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);
24491    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24492    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24493    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24494    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24495    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24496    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24497    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24498    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24499    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24500    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24501    EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24502    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24503    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24504
24505    /**
24506     * @defgroup Conformant Conformant
24507     * @ingroup Elementary
24508     *
24509     * @image html img/widget/conformant/preview-00.png
24510     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24511     *
24512     * @image html img/conformant.png
24513     * @image latex img/conformant.eps width=\textwidth
24514     *
24515     * The aim is to provide a widget that can be used in elementary apps to
24516     * account for space taken up by the indicator, virtual keypad & softkey
24517     * windows when running the illume2 module of E17.
24518     *
24519     * So conformant content will be sized and positioned considering the
24520     * space required for such stuff, and when they popup, as a keyboard
24521     * shows when an entry is selected, conformant content won't change.
24522     *
24523     * Available styles for it:
24524     * - @c "default"
24525     *
24526     * Default contents parts of the conformant widget that you can use for are:
24527     * @li "default" - A content of the conformant
24528     *
24529     * See how to use this widget in this example:
24530     * @ref conformant_example
24531     */
24532
24533    /**
24534     * @addtogroup Conformant
24535     * @{
24536     */
24537
24538    /**
24539     * Add a new conformant widget to the given parent Elementary
24540     * (container) object.
24541     *
24542     * @param parent The parent object.
24543     * @return A new conformant widget handle or @c NULL, on errors.
24544     *
24545     * This function inserts a new conformant widget on the canvas.
24546     *
24547     * @ingroup Conformant
24548     */
24549    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24550
24551    /**
24552     * Set the content of the conformant widget.
24553     *
24554     * @param obj The conformant object.
24555     * @param content The content to be displayed by the conformant.
24556     *
24557     * Content will be sized and positioned considering the space required
24558     * to display a virtual keyboard. So it won't fill all the conformant
24559     * size. This way is possible to be sure that content won't resize
24560     * or be re-positioned after the keyboard is displayed.
24561     *
24562     * Once the content object is set, a previously set one will be deleted.
24563     * If you want to keep that old content object, use the
24564     * elm_object_content_unset() function.
24565     *
24566     * @see elm_object_content_unset()
24567     * @see elm_object_content_get()
24568     *
24569     * @ingroup Conformant
24570     */
24571    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24572
24573    /**
24574     * Get the content of the conformant widget.
24575     *
24576     * @param obj The conformant object.
24577     * @return The content that is being used.
24578     *
24579     * Return the content object which is set for this widget.
24580     * It won't be unparent from conformant. For that, use
24581     * elm_object_content_unset().
24582     *
24583     * @see elm_object_content_set().
24584     * @see elm_object_content_unset()
24585     *
24586     * @ingroup Conformant
24587     */
24588    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24589
24590    /**
24591     * Unset the content of the conformant widget.
24592     *
24593     * @param obj The conformant object.
24594     * @return The content that was being used.
24595     *
24596     * Unparent and return the content object which was set for this widget.
24597     *
24598     * @see elm_object_content_set().
24599     *
24600     * @ingroup Conformant
24601     */
24602    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24603
24604    /**
24605     * Returns the Evas_Object that represents the content area.
24606     *
24607     * @param obj The conformant object.
24608     * @return The content area of the widget.
24609     *
24610     * @ingroup Conformant
24611     */
24612    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24613
24614    /**
24615     * @}
24616     */
24617
24618    /**
24619     * @defgroup Mapbuf Mapbuf
24620     * @ingroup Elementary
24621     *
24622     * @image html img/widget/mapbuf/preview-00.png
24623     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24624     *
24625     * This holds one content object and uses an Evas Map of transformation
24626     * points to be later used with this content. So the content will be
24627     * moved, resized, etc as a single image. So it will improve performance
24628     * when you have a complex interafce, with a lot of elements, and will
24629     * need to resize or move it frequently (the content object and its
24630     * children).
24631     *
24632     * Default contents parts of the mapbuf widget that you can use for are:
24633     * @li "default" - A content of the mapbuf
24634     *
24635     * To enable map, elm_mapbuf_enabled_set() should be used.
24636     * 
24637     * See how to use this widget in this example:
24638     * @ref mapbuf_example
24639     */
24640
24641    /**
24642     * @addtogroup Mapbuf
24643     * @{
24644     */
24645
24646    /**
24647     * Add a new mapbuf widget to the given parent Elementary
24648     * (container) object.
24649     *
24650     * @param parent The parent object.
24651     * @return A new mapbuf widget handle or @c NULL, on errors.
24652     *
24653     * This function inserts a new mapbuf widget on the canvas.
24654     *
24655     * @ingroup Mapbuf
24656     */
24657    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24658
24659    /**
24660     * Set the content of the mapbuf.
24661     *
24662     * @param obj The mapbuf object.
24663     * @param content The content that will be filled in this mapbuf object.
24664     *
24665     * Once the content object is set, a previously set one will be deleted.
24666     * If you want to keep that old content object, use the
24667     * elm_mapbuf_content_unset() function.
24668     *
24669     * To enable map, elm_mapbuf_enabled_set() should be used.
24670     *
24671     * @ingroup Mapbuf
24672     */
24673    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24674
24675    /**
24676     * Get the content of the mapbuf.
24677     *
24678     * @param obj The mapbuf object.
24679     * @return The content that is being used.
24680     *
24681     * Return the content object which is set for this widget.
24682     *
24683     * @see elm_mapbuf_content_set() for details.
24684     *
24685     * @ingroup Mapbuf
24686     */
24687    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24688
24689    /**
24690     * Unset the content of the mapbuf.
24691     *
24692     * @param obj The mapbuf object.
24693     * @return The content that was being used.
24694     *
24695     * Unparent and return the content object which was set for this widget.
24696     *
24697     * @see elm_mapbuf_content_set() for details.
24698     *
24699     * @ingroup Mapbuf
24700     */
24701    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24702
24703    /**
24704     * Enable or disable the map.
24705     *
24706     * @param obj The mapbuf object.
24707     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24708     *
24709     * This enables the map that is set or disables it. On enable, the object
24710     * geometry will be saved, and the new geometry will change (position and
24711     * size) to reflect the map geometry set.
24712     *
24713     * Also, when enabled, alpha and smooth states will be used, so if the
24714     * content isn't solid, alpha should be enabled, for example, otherwise
24715     * a black retangle will fill the content.
24716     *
24717     * When disabled, the stored map will be freed and geometry prior to
24718     * enabling the map will be restored.
24719     *
24720     * It's disabled by default.
24721     *
24722     * @see elm_mapbuf_alpha_set()
24723     * @see elm_mapbuf_smooth_set()
24724     *
24725     * @ingroup Mapbuf
24726     */
24727    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24728
24729    /**
24730     * Get a value whether map is enabled or not.
24731     *
24732     * @param obj The mapbuf object.
24733     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24734     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24735     *
24736     * @see elm_mapbuf_enabled_set() for details.
24737     *
24738     * @ingroup Mapbuf
24739     */
24740    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24741
24742    /**
24743     * Enable or disable smooth map rendering.
24744     *
24745     * @param obj The mapbuf object.
24746     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24747     * to disable it.
24748     *
24749     * This sets smoothing for map rendering. If the object is a type that has
24750     * its own smoothing settings, then both the smooth settings for this object
24751     * and the map must be turned off.
24752     *
24753     * By default smooth maps are enabled.
24754     *
24755     * @ingroup Mapbuf
24756     */
24757    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24758
24759    /**
24760     * Get a value whether smooth map rendering is enabled or not.
24761     *
24762     * @param obj The mapbuf object.
24763     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24764     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24765     *
24766     * @see elm_mapbuf_smooth_set() for details.
24767     *
24768     * @ingroup Mapbuf
24769     */
24770    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24771
24772    /**
24773     * Set or unset alpha flag for map rendering.
24774     *
24775     * @param obj The mapbuf object.
24776     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24777     * to disable it.
24778     *
24779     * This sets alpha flag for map rendering. If the object is a type that has
24780     * its own alpha settings, then this will take precedence. Only image objects
24781     * have this currently. It stops alpha blending of the map area, and is
24782     * useful if you know the object and/or all sub-objects is 100% solid.
24783     *
24784     * Alpha is enabled by default.
24785     *
24786     * @ingroup Mapbuf
24787     */
24788    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24789
24790    /**
24791     * Get a value whether alpha blending is enabled or not.
24792     *
24793     * @param obj The mapbuf object.
24794     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24795     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24796     *
24797     * @see elm_mapbuf_alpha_set() for details.
24798     *
24799     * @ingroup Mapbuf
24800     */
24801    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24802
24803    /**
24804     * @}
24805     */
24806
24807    /**
24808     * @defgroup Flipselector Flip Selector
24809     *
24810     * @image html img/widget/flipselector/preview-00.png
24811     * @image latex img/widget/flipselector/preview-00.eps
24812     *
24813     * A flip selector is a widget to show a set of @b text items, one
24814     * at a time, with the same sheet switching style as the @ref Clock
24815     * "clock" widget, when one changes the current displaying sheet
24816     * (thus, the "flip" in the name).
24817     *
24818     * User clicks to flip sheets which are @b held for some time will
24819     * make the flip selector to flip continuosly and automatically for
24820     * the user. The interval between flips will keep growing in time,
24821     * so that it helps the user to reach an item which is distant from
24822     * the current selection.
24823     *
24824     * Smart callbacks one can register to:
24825     * - @c "selected" - when the widget's selected text item is changed
24826     * - @c "overflowed" - when the widget's current selection is changed
24827     *   from the first item in its list to the last
24828     * - @c "underflowed" - when the widget's current selection is changed
24829     *   from the last item in its list to the first
24830     *
24831     * Available styles for it:
24832     * - @c "default"
24833     *
24834          * To set/get the label of the flipselector item, you can use
24835          * elm_object_item_text_set/get APIs.
24836          * Once the text is set, a previously set one will be deleted.
24837          * 
24838     * Here is an example on its usage:
24839     * @li @ref flipselector_example
24840     */
24841
24842    /**
24843     * @addtogroup Flipselector
24844     * @{
24845     */
24846
24847    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24848
24849    /**
24850     * Add a new flip selector widget to the given parent Elementary
24851     * (container) widget
24852     *
24853     * @param parent The parent object
24854     * @return a new flip selector widget handle or @c NULL, on errors
24855     *
24856     * This function inserts a new flip selector widget on the canvas.
24857     *
24858     * @ingroup Flipselector
24859     */
24860    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24861
24862    /**
24863     * Programmatically select the next item of a flip selector widget
24864     *
24865     * @param obj The flipselector object
24866     *
24867     * @note The selection will be animated. Also, if it reaches the
24868     * end of its list of member items, it will continue with the first
24869     * one onwards.
24870     *
24871     * @ingroup Flipselector
24872     */
24873    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24874
24875    /**
24876     * Programmatically select the previous item of a flip selector
24877     * widget
24878     *
24879     * @param obj The flipselector object
24880     *
24881     * @note The selection will be animated.  Also, if it reaches the
24882     * beginning of its list of member items, it will continue with the
24883     * last one backwards.
24884     *
24885     * @ingroup Flipselector
24886     */
24887    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24888
24889    /**
24890     * Append a (text) item to a flip selector widget
24891     *
24892     * @param obj The flipselector object
24893     * @param label The (text) label of the new item
24894     * @param func Convenience callback function to take place when
24895     * item is selected
24896     * @param data Data passed to @p func, above
24897     * @return A handle to the item added or @c NULL, on errors
24898     *
24899     * The widget's list of labels to show will be appended with the
24900     * given value. If the user wishes so, a callback function pointer
24901     * can be passed, which will get called when this same item is
24902     * selected.
24903     *
24904     * @note The current selection @b won't be modified by appending an
24905     * element to the list.
24906     *
24907     * @note The maximum length of the text label is going to be
24908     * determined <b>by the widget's theme</b>. Strings larger than
24909     * that value are going to be @b truncated.
24910     *
24911     * @ingroup Flipselector
24912     */
24913    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24914
24915    /**
24916     * Prepend a (text) item to a flip selector widget
24917     *
24918     * @param obj The flipselector object
24919     * @param label The (text) label of the new item
24920     * @param func Convenience callback function to take place when
24921     * item is selected
24922     * @param data Data passed to @p func, above
24923     * @return A handle to the item added or @c NULL, on errors
24924     *
24925     * The widget's list of labels to show will be prepended with the
24926     * given value. If the user wishes so, a callback function pointer
24927     * can be passed, which will get called when this same item is
24928     * selected.
24929     *
24930     * @note The current selection @b won't be modified by prepending
24931     * an element to the list.
24932     *
24933     * @note The maximum length of the text label is going to be
24934     * determined <b>by the widget's theme</b>. Strings larger than
24935     * that value are going to be @b truncated.
24936     *
24937     * @ingroup Flipselector
24938     */
24939    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24940
24941    /**
24942     * Get the internal list of items in a given flip selector widget.
24943     *
24944     * @param obj The flipselector object
24945     * @return The list of items (#Elm_Flipselector_Item as data) or
24946     * @c NULL on errors.
24947     *
24948     * This list is @b not to be modified in any way and must not be
24949     * freed. Use the list members with functions like
24950     * elm_flipselector_item_label_set(),
24951     * elm_flipselector_item_label_get(),
24952     * elm_flipselector_item_del(),
24953     * elm_flipselector_item_selected_get(),
24954     * elm_flipselector_item_selected_set().
24955     *
24956     * @warning This list is only valid until @p obj object's internal
24957     * items list is changed. It should be fetched again with another
24958     * call to this function when changes happen.
24959     *
24960     * @ingroup Flipselector
24961     */
24962    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24963
24964    /**
24965     * Get the first item in the given flip selector widget's list of
24966     * items.
24967     *
24968     * @param obj The flipselector object
24969     * @return The first item or @c NULL, if it has no items (and on
24970     * errors)
24971     *
24972     * @see elm_flipselector_item_append()
24973     * @see elm_flipselector_last_item_get()
24974     *
24975     * @ingroup Flipselector
24976     */
24977    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24978
24979    /**
24980     * Get the last item in the given flip selector widget's list of
24981     * items.
24982     *
24983     * @param obj The flipselector object
24984     * @return The last item or @c NULL, if it has no items (and on
24985     * errors)
24986     *
24987     * @see elm_flipselector_item_prepend()
24988     * @see elm_flipselector_first_item_get()
24989     *
24990     * @ingroup Flipselector
24991     */
24992    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24993
24994    /**
24995     * Get the currently selected item in a flip selector widget.
24996     *
24997     * @param obj The flipselector object
24998     * @return The selected item or @c NULL, if the widget has no items
24999     * (and on erros)
25000     *
25001     * @ingroup Flipselector
25002     */
25003    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25004
25005    /**
25006     * Set whether a given flip selector widget's item should be the
25007     * currently selected one.
25008     *
25009     * @param item The flip selector item
25010     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25011     *
25012     * This sets whether @p item is or not the selected (thus, under
25013     * display) one. If @p item is different than one under display,
25014     * the latter will be unselected. If the @p item is set to be
25015     * unselected, on the other hand, the @b first item in the widget's
25016     * internal members list will be the new selected one.
25017     *
25018     * @see elm_flipselector_item_selected_get()
25019     *
25020     * @ingroup Flipselector
25021     */
25022    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25023
25024    /**
25025     * Get whether a given flip selector widget's item is the currently
25026     * selected one.
25027     *
25028     * @param item The flip selector item
25029     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25030     * (or on errors).
25031     *
25032     * @see elm_flipselector_item_selected_set()
25033     *
25034     * @ingroup Flipselector
25035     */
25036    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25037
25038    /**
25039     * Delete a given item from a flip selector widget.
25040     *
25041     * @param item The item to delete
25042     *
25043     * @ingroup Flipselector
25044     */
25045    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25046
25047    /**
25048     * Get the label of a given flip selector widget's item.
25049     *
25050     * @param item The item to get label from
25051     * @return The text label of @p item or @c NULL, on errors
25052     *
25053     * @see elm_flipselector_item_label_set()
25054     *
25055     * @ingroup Flipselector
25056     */
25057    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25058
25059    /**
25060     * Set the label of a given flip selector widget's item.
25061     *
25062     * @param item The item to set label on
25063     * @param label The text label string, in UTF-8 encoding
25064     *
25065     * @see elm_flipselector_item_label_get()
25066     *
25067     * @ingroup Flipselector
25068     */
25069    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25070
25071    /**
25072     * Gets the item before @p item in a flip selector widget's
25073     * internal list of items.
25074     *
25075     * @param item The item to fetch previous from
25076     * @return The item before the @p item, in its parent's list. If
25077     *         there is no previous item for @p item or there's an
25078     *         error, @c NULL is returned.
25079     *
25080     * @see elm_flipselector_item_next_get()
25081     *
25082     * @ingroup Flipselector
25083     */
25084    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25085
25086    /**
25087     * Gets the item after @p item in a flip selector widget's
25088     * internal list of items.
25089     *
25090     * @param item The item to fetch next from
25091     * @return The item after the @p item, in its parent's list. If
25092     *         there is no next item for @p item or there's an
25093     *         error, @c NULL is returned.
25094     *
25095     * @see elm_flipselector_item_next_get()
25096     *
25097     * @ingroup Flipselector
25098     */
25099    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25100
25101    /**
25102     * Set the interval on time updates for an user mouse button hold
25103     * on a flip selector widget.
25104     *
25105     * @param obj The flip selector object
25106     * @param interval The (first) interval value in seconds
25107     *
25108     * This interval value is @b decreased while the user holds the
25109     * mouse pointer either flipping up or flipping doww a given flip
25110     * selector.
25111     *
25112     * This helps the user to get to a given item distant from the
25113     * current one easier/faster, as it will start to flip quicker and
25114     * quicker on mouse button holds.
25115     *
25116     * The calculation for the next flip interval value, starting from
25117     * the one set with this call, is the previous interval divided by
25118     * 1.05, so it decreases a little bit.
25119     *
25120     * The default starting interval value for automatic flips is
25121     * @b 0.85 seconds.
25122     *
25123     * @see elm_flipselector_interval_get()
25124     *
25125     * @ingroup Flipselector
25126     */
25127    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25128
25129    /**
25130     * Get the interval on time updates for an user mouse button hold
25131     * on a flip selector widget.
25132     *
25133     * @param obj The flip selector object
25134     * @return The (first) interval value, in seconds, set on it
25135     *
25136     * @see elm_flipselector_interval_set() for more details
25137     *
25138     * @ingroup Flipselector
25139     */
25140    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25141    /**
25142     * @}
25143     */
25144
25145    /**
25146     * @addtogroup Calendar
25147     * @{
25148     */
25149
25150    /**
25151     * @enum _Elm_Calendar_Mark_Repeat
25152     * @typedef Elm_Calendar_Mark_Repeat
25153     *
25154     * Event periodicity, used to define if a mark should be repeated
25155     * @b beyond event's day. It's set when a mark is added.
25156     *
25157     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25158     * there will be marks every week after this date. Marks will be displayed
25159     * at 13th, 20th, 27th, 3rd June ...
25160     *
25161     * Values don't work as bitmask, only one can be choosen.
25162     *
25163     * @see elm_calendar_mark_add()
25164     *
25165     * @ingroup Calendar
25166     */
25167    typedef enum _Elm_Calendar_Mark_Repeat
25168      {
25169         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25170         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25171         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25172         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*/
25173         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. */
25174      } Elm_Calendar_Mark_Repeat;
25175
25176    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(). */
25177
25178    /**
25179     * Add a new calendar widget to the given parent Elementary
25180     * (container) object.
25181     *
25182     * @param parent The parent object.
25183     * @return a new calendar widget handle or @c NULL, on errors.
25184     *
25185     * This function inserts a new calendar widget on the canvas.
25186     *
25187     * @ref calendar_example_01
25188     *
25189     * @ingroup Calendar
25190     */
25191    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25192
25193    /**
25194     * Get weekdays names displayed by the calendar.
25195     *
25196     * @param obj The calendar object.
25197     * @return Array of seven strings to be used as weekday names.
25198     *
25199     * By default, weekdays abbreviations get from system are displayed:
25200     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25201     * The first string is related to Sunday, the second to Monday...
25202     *
25203     * @see elm_calendar_weekdays_name_set()
25204     *
25205     * @ref calendar_example_05
25206     *
25207     * @ingroup Calendar
25208     */
25209    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25210
25211    /**
25212     * Set weekdays names to be displayed by the calendar.
25213     *
25214     * @param obj The calendar object.
25215     * @param weekdays Array of seven strings to be used as weekday names.
25216     * @warning It must have 7 elements, or it will access invalid memory.
25217     * @warning The strings must be NULL terminated ('@\0').
25218     *
25219     * By default, weekdays abbreviations get from system are displayed:
25220     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25221     *
25222     * The first string should be related to Sunday, the second to Monday...
25223     *
25224     * The usage should be like this:
25225     * @code
25226     *   const char *weekdays[] =
25227     *   {
25228     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25229     *      "Thursday", "Friday", "Saturday"
25230     *   };
25231     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25232     * @endcode
25233     *
25234     * @see elm_calendar_weekdays_name_get()
25235     *
25236     * @ref calendar_example_02
25237     *
25238     * @ingroup Calendar
25239     */
25240    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25241
25242    /**
25243     * Set the minimum and maximum values for the year
25244     *
25245     * @param obj The calendar object
25246     * @param min The minimum year, greater than 1901;
25247     * @param max The maximum year;
25248     *
25249     * Maximum must be greater than minimum, except if you don't wan't to set
25250     * maximum year.
25251     * Default values are 1902 and -1.
25252     *
25253     * If the maximum year is a negative value, it will be limited depending
25254     * on the platform architecture (year 2037 for 32 bits);
25255     *
25256     * @see elm_calendar_min_max_year_get()
25257     *
25258     * @ref calendar_example_03
25259     *
25260     * @ingroup Calendar
25261     */
25262    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25263
25264    /**
25265     * Get the minimum and maximum values for the year
25266     *
25267     * @param obj The calendar object.
25268     * @param min The minimum year.
25269     * @param max The maximum year.
25270     *
25271     * Default values are 1902 and -1.
25272     *
25273     * @see elm_calendar_min_max_year_get() for more details.
25274     *
25275     * @ref calendar_example_05
25276     *
25277     * @ingroup Calendar
25278     */
25279    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25280
25281    /**
25282     * Enable or disable day selection
25283     *
25284     * @param obj The calendar object.
25285     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25286     * disable it.
25287     *
25288     * Enabled by default. If disabled, the user still can select months,
25289     * but not days. Selected days are highlighted on calendar.
25290     * It should be used if you won't need such selection for the widget usage.
25291     *
25292     * When a day is selected, or month is changed, smart callbacks for
25293     * signal "changed" will be called.
25294     *
25295     * @see elm_calendar_day_selection_enable_get()
25296     *
25297     * @ref calendar_example_04
25298     *
25299     * @ingroup Calendar
25300     */
25301    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25302
25303    /**
25304     * Get a value whether day selection is enabled or not.
25305     *
25306     * @see elm_calendar_day_selection_enable_set() for details.
25307     *
25308     * @param obj The calendar object.
25309     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25310     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25311     *
25312     * @ref calendar_example_05
25313     *
25314     * @ingroup Calendar
25315     */
25316    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25317
25318
25319    /**
25320     * Set selected date to be highlighted on calendar.
25321     *
25322     * @param obj The calendar object.
25323     * @param selected_time A @b tm struct to represent the selected date.
25324     *
25325     * Set the selected date, changing the displayed month if needed.
25326     * Selected date changes when the user goes to next/previous month or
25327     * select a day pressing over it on calendar.
25328     *
25329     * @see elm_calendar_selected_time_get()
25330     *
25331     * @ref calendar_example_04
25332     *
25333     * @ingroup Calendar
25334     */
25335    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25336
25337    /**
25338     * Get selected date.
25339     *
25340     * @param obj The calendar object
25341     * @param selected_time A @b tm struct to point to selected date
25342     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25343     * be considered.
25344     *
25345     * Get date selected by the user or set by function
25346     * elm_calendar_selected_time_set().
25347     * Selected date changes when the user goes to next/previous month or
25348     * select a day pressing over it on calendar.
25349     *
25350     * @see elm_calendar_selected_time_get()
25351     *
25352     * @ref calendar_example_05
25353     *
25354     * @ingroup Calendar
25355     */
25356    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25357
25358    /**
25359     * Set a function to format the string that will be used to display
25360     * month and year;
25361     *
25362     * @param obj The calendar object
25363     * @param format_function Function to set the month-year string given
25364     * the selected date
25365     *
25366     * By default it uses strftime with "%B %Y" format string.
25367     * It should allocate the memory that will be used by the string,
25368     * that will be freed by the widget after usage.
25369     * A pointer to the string and a pointer to the time struct will be provided.
25370     *
25371     * Example:
25372     * @code
25373     * static char *
25374     * _format_month_year(struct tm *selected_time)
25375     * {
25376     *    char buf[32];
25377     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25378     *    return strdup(buf);
25379     * }
25380     *
25381     * elm_calendar_format_function_set(calendar, _format_month_year);
25382     * @endcode
25383     *
25384     * @ref calendar_example_02
25385     *
25386     * @ingroup Calendar
25387     */
25388    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25389
25390    /**
25391     * Add a new mark to the calendar
25392     *
25393     * @param obj The calendar object
25394     * @param mark_type A string used to define the type of mark. It will be
25395     * emitted to the theme, that should display a related modification on these
25396     * days representation.
25397     * @param mark_time A time struct to represent the date of inclusion of the
25398     * mark. For marks that repeats it will just be displayed after the inclusion
25399     * date in the calendar.
25400     * @param repeat Repeat the event following this periodicity. Can be a unique
25401     * mark (that don't repeat), daily, weekly, monthly or annually.
25402     * @return The created mark or @p NULL upon failure.
25403     *
25404     * Add a mark that will be drawn in the calendar respecting the insertion
25405     * time and periodicity. It will emit the type as signal to the widget theme.
25406     * Default theme supports "holiday" and "checked", but it can be extended.
25407     *
25408     * It won't immediately update the calendar, drawing the marks.
25409     * For this, call elm_calendar_marks_draw(). However, when user selects
25410     * next or previous month calendar forces marks drawn.
25411     *
25412     * Marks created with this method can be deleted with
25413     * elm_calendar_mark_del().
25414     *
25415     * Example
25416     * @code
25417     * struct tm selected_time;
25418     * time_t current_time;
25419     *
25420     * current_time = time(NULL) + 5 * 84600;
25421     * localtime_r(&current_time, &selected_time);
25422     * elm_calendar_mark_add(cal, "holiday", selected_time,
25423     *     ELM_CALENDAR_ANNUALLY);
25424     *
25425     * current_time = time(NULL) + 1 * 84600;
25426     * localtime_r(&current_time, &selected_time);
25427     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25428     *
25429     * elm_calendar_marks_draw(cal);
25430     * @endcode
25431     *
25432     * @see elm_calendar_marks_draw()
25433     * @see elm_calendar_mark_del()
25434     *
25435     * @ref calendar_example_06
25436     *
25437     * @ingroup Calendar
25438     */
25439    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);
25440
25441    /**
25442     * Delete mark from the calendar.
25443     *
25444     * @param mark The mark to be deleted.
25445     *
25446     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25447     * should be used instead of getting marks list and deleting each one.
25448     *
25449     * @see elm_calendar_mark_add()
25450     *
25451     * @ref calendar_example_06
25452     *
25453     * @ingroup Calendar
25454     */
25455    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25456
25457    /**
25458     * Remove all calendar's marks
25459     *
25460     * @param obj The calendar object.
25461     *
25462     * @see elm_calendar_mark_add()
25463     * @see elm_calendar_mark_del()
25464     *
25465     * @ingroup Calendar
25466     */
25467    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25468
25469
25470    /**
25471     * Get a list of all the calendar marks.
25472     *
25473     * @param obj The calendar object.
25474     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25475     *
25476     * @see elm_calendar_mark_add()
25477     * @see elm_calendar_mark_del()
25478     * @see elm_calendar_marks_clear()
25479     *
25480     * @ingroup Calendar
25481     */
25482    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25483
25484    /**
25485     * Draw calendar marks.
25486     *
25487     * @param obj The calendar object.
25488     *
25489     * Should be used after adding, removing or clearing marks.
25490     * It will go through the entire marks list updating the calendar.
25491     * If lots of marks will be added, add all the marks and then call
25492     * this function.
25493     *
25494     * When the month is changed, i.e. user selects next or previous month,
25495     * marks will be drawed.
25496     *
25497     * @see elm_calendar_mark_add()
25498     * @see elm_calendar_mark_del()
25499     * @see elm_calendar_marks_clear()
25500     *
25501     * @ref calendar_example_06
25502     *
25503     * @ingroup Calendar
25504     */
25505    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25506
25507    /**
25508     * Set a day text color to the same that represents Saturdays.
25509     *
25510     * @param obj The calendar object.
25511     * @param pos The text position. Position is the cell counter, from left
25512     * to right, up to down. It starts on 0 and ends on 41.
25513     *
25514     * @deprecated use elm_calendar_mark_add() instead like:
25515     *
25516     * @code
25517     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25518     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25519     * @endcode
25520     *
25521     * @see elm_calendar_mark_add()
25522     *
25523     * @ingroup Calendar
25524     */
25525    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25526
25527    /**
25528     * Set a day text color to the same that represents Sundays.
25529     *
25530     * @param obj The calendar object.
25531     * @param pos The text position. Position is the cell counter, from left
25532     * to right, up to down. It starts on 0 and ends on 41.
25533
25534     * @deprecated use elm_calendar_mark_add() instead like:
25535     *
25536     * @code
25537     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25538     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25539     * @endcode
25540     *
25541     * @see elm_calendar_mark_add()
25542     *
25543     * @ingroup Calendar
25544     */
25545    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25546
25547    /**
25548     * Set a day text color to the same that represents Weekdays.
25549     *
25550     * @param obj The calendar object
25551     * @param pos The text position. Position is the cell counter, from left
25552     * to right, up to down. It starts on 0 and ends on 41.
25553     *
25554     * @deprecated use elm_calendar_mark_add() instead like:
25555     *
25556     * @code
25557     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25558     *
25559     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25560     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25561     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25562     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25563     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25564     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25565     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25566     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25567     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25568     * @endcode
25569     *
25570     * @see elm_calendar_mark_add()
25571     *
25572     * @ingroup Calendar
25573     */
25574    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25575
25576    /**
25577     * Set the interval on time updates for an user mouse button hold
25578     * on calendar widgets' month selection.
25579     *
25580     * @param obj The calendar object
25581     * @param interval The (first) interval value in seconds
25582     *
25583     * This interval value is @b decreased while the user holds the
25584     * mouse pointer either selecting next or previous month.
25585     *
25586     * This helps the user to get to a given month distant from the
25587     * current one easier/faster, as it will start to change quicker and
25588     * quicker on mouse button holds.
25589     *
25590     * The calculation for the next change interval value, starting from
25591     * the one set with this call, is the previous interval divided by
25592     * 1.05, so it decreases a little bit.
25593     *
25594     * The default starting interval value for automatic changes is
25595     * @b 0.85 seconds.
25596     *
25597     * @see elm_calendar_interval_get()
25598     *
25599     * @ingroup Calendar
25600     */
25601    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25602
25603    /**
25604     * Get the interval on time updates for an user mouse button hold
25605     * on calendar widgets' month selection.
25606     *
25607     * @param obj The calendar object
25608     * @return The (first) interval value, in seconds, set on it
25609     *
25610     * @see elm_calendar_interval_set() for more details
25611     *
25612     * @ingroup Calendar
25613     */
25614    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25615
25616    /**
25617     * @}
25618     */
25619
25620    /**
25621     * @defgroup Diskselector Diskselector
25622     * @ingroup Elementary
25623     *
25624     * @image html img/widget/diskselector/preview-00.png
25625     * @image latex img/widget/diskselector/preview-00.eps
25626     *
25627     * A diskselector is a kind of list widget. It scrolls horizontally,
25628     * and can contain label and icon objects. Three items are displayed
25629     * with the selected one in the middle.
25630     *
25631     * It can act like a circular list with round mode and labels can be
25632     * reduced for a defined length for side items.
25633     *
25634     * Smart callbacks one can listen to:
25635     * - "selected" - when item is selected, i.e. scroller stops.
25636     *
25637     * Available styles for it:
25638     * - @c "default"
25639     *
25640     * List of examples:
25641     * @li @ref diskselector_example_01
25642     * @li @ref diskselector_example_02
25643     */
25644
25645    /**
25646     * @addtogroup Diskselector
25647     * @{
25648     */
25649
25650    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(). */
25651
25652    /**
25653     * Add a new diskselector widget to the given parent Elementary
25654     * (container) object.
25655     *
25656     * @param parent The parent object.
25657     * @return a new diskselector widget handle or @c NULL, on errors.
25658     *
25659     * This function inserts a new diskselector widget on the canvas.
25660     *
25661     * @ingroup Diskselector
25662     */
25663    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25664
25665    /**
25666     * Enable or disable round mode.
25667     *
25668     * @param obj The diskselector object.
25669     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25670     * disable it.
25671     *
25672     * Disabled by default. If round mode is enabled the items list will
25673     * work like a circle list, so when the user reaches the last item,
25674     * the first one will popup.
25675     *
25676     * @see elm_diskselector_round_get()
25677     *
25678     * @ingroup Diskselector
25679     */
25680    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25681
25682    /**
25683     * Get a value whether round mode is enabled or not.
25684     *
25685     * @see elm_diskselector_round_set() for details.
25686     *
25687     * @param obj The diskselector object.
25688     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25689     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25690     *
25691     * @ingroup Diskselector
25692     */
25693    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25694
25695    /**
25696     * Get the side labels max length.
25697     *
25698     * @deprecated use elm_diskselector_side_label_length_get() instead:
25699     *
25700     * @param obj The diskselector object.
25701     * @return The max length defined for side labels, or 0 if not a valid
25702     * diskselector.
25703     *
25704     * @ingroup Diskselector
25705     */
25706    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25707
25708    /**
25709     * Set the side labels max length.
25710     *
25711     * @deprecated use elm_diskselector_side_label_length_set() instead:
25712     *
25713     * @param obj The diskselector object.
25714     * @param len The max length defined for side labels.
25715     *
25716     * @ingroup Diskselector
25717     */
25718    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25719
25720    /**
25721     * Get the side labels max length.
25722     *
25723     * @see elm_diskselector_side_label_length_set() for details.
25724     *
25725     * @param obj The diskselector object.
25726     * @return The max length defined for side labels, or 0 if not a valid
25727     * diskselector.
25728     *
25729     * @ingroup Diskselector
25730     */
25731    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25732
25733    /**
25734     * Set the side labels max length.
25735     *
25736     * @param obj The diskselector object.
25737     * @param len The max length defined for side labels.
25738     *
25739     * Length is the number of characters of items' label that will be
25740     * visible when it's set on side positions. It will just crop
25741     * the string after defined size. E.g.:
25742     *
25743     * An item with label "January" would be displayed on side position as
25744     * "Jan" if max length is set to 3, or "Janu", if this property
25745     * is set to 4.
25746     *
25747     * When it's selected, the entire label will be displayed, except for
25748     * width restrictions. In this case label will be cropped and "..."
25749     * will be concatenated.
25750     *
25751     * Default side label max length is 3.
25752     *
25753     * This property will be applyed over all items, included before or
25754     * later this function call.
25755     *
25756     * @ingroup Diskselector
25757     */
25758    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25759
25760    /**
25761     * Set the number of items to be displayed.
25762     *
25763     * @param obj The diskselector object.
25764     * @param num The number of items the diskselector will display.
25765     *
25766     * Default value is 3, and also it's the minimun. If @p num is less
25767     * than 3, it will be set to 3.
25768     *
25769     * Also, it can be set on theme, using data item @c display_item_num
25770     * on group "elm/diskselector/item/X", where X is style set.
25771     * E.g.:
25772     *
25773     * group { name: "elm/diskselector/item/X";
25774     * data {
25775     *     item: "display_item_num" "5";
25776     *     }
25777     *
25778     * @ingroup Diskselector
25779     */
25780    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25781
25782    /**
25783     * Get the number of items in the diskselector object.
25784     *
25785     * @param obj The diskselector object.
25786     *
25787     * @ingroup Diskselector
25788     */
25789    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25790
25791    /**
25792     * Set bouncing behaviour when the scrolled content reaches an edge.
25793     *
25794     * Tell the internal scroller object whether it should bounce or not
25795     * when it reaches the respective edges for each axis.
25796     *
25797     * @param obj The diskselector object.
25798     * @param h_bounce Whether to bounce or not in the horizontal axis.
25799     * @param v_bounce Whether to bounce or not in the vertical axis.
25800     *
25801     * @see elm_scroller_bounce_set()
25802     *
25803     * @ingroup Diskselector
25804     */
25805    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25806
25807    /**
25808     * Get the bouncing behaviour of the internal scroller.
25809     *
25810     * Get whether the internal scroller should bounce when the edge of each
25811     * axis is reached scrolling.
25812     *
25813     * @param obj The diskselector object.
25814     * @param h_bounce Pointer where to store the bounce state of the horizontal
25815     * axis.
25816     * @param v_bounce Pointer where to store the bounce state of the vertical
25817     * axis.
25818     *
25819     * @see elm_scroller_bounce_get()
25820     * @see elm_diskselector_bounce_set()
25821     *
25822     * @ingroup Diskselector
25823     */
25824    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25825
25826    /**
25827     * Get the scrollbar policy.
25828     *
25829     * @see elm_diskselector_scroller_policy_get() for details.
25830     *
25831     * @param obj The diskselector object.
25832     * @param policy_h Pointer where to store horizontal scrollbar policy.
25833     * @param policy_v Pointer where to store vertical scrollbar policy.
25834     *
25835     * @ingroup Diskselector
25836     */
25837    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);
25838
25839    /**
25840     * Set the scrollbar policy.
25841     *
25842     * @param obj The diskselector object.
25843     * @param policy_h Horizontal scrollbar policy.
25844     * @param policy_v Vertical scrollbar policy.
25845     *
25846     * This sets the scrollbar visibility policy for the given scroller.
25847     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25848     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25849     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25850     * This applies respectively for the horizontal and vertical scrollbars.
25851     *
25852     * The both are disabled by default, i.e., are set to
25853     * #ELM_SCROLLER_POLICY_OFF.
25854     *
25855     * @ingroup Diskselector
25856     */
25857    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25858
25859    /**
25860     * Remove all diskselector's items.
25861     *
25862     * @param obj The diskselector object.
25863     *
25864     * @see elm_diskselector_item_del()
25865     * @see elm_diskselector_item_append()
25866     *
25867     * @ingroup Diskselector
25868     */
25869    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25870
25871    /**
25872     * Get a list of all the diskselector items.
25873     *
25874     * @param obj The diskselector object.
25875     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25876     * or @c NULL on failure.
25877     *
25878     * @see elm_diskselector_item_append()
25879     * @see elm_diskselector_item_del()
25880     * @see elm_diskselector_clear()
25881     *
25882     * @ingroup Diskselector
25883     */
25884    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25885
25886    /**
25887     * Appends a new item to the diskselector object.
25888     *
25889     * @param obj The diskselector object.
25890     * @param label The label of the diskselector item.
25891     * @param icon The icon object to use at left side of the item. An
25892     * icon can be any Evas object, but usually it is an icon created
25893     * with elm_icon_add().
25894     * @param func The function to call when the item is selected.
25895     * @param data The data to associate with the item for related callbacks.
25896     *
25897     * @return The created item or @c NULL upon failure.
25898     *
25899     * A new item will be created and appended to the diskselector, i.e., will
25900     * be set as last item. Also, if there is no selected item, it will
25901     * be selected. This will always happens for the first appended item.
25902     *
25903     * If no icon is set, label will be centered on item position, otherwise
25904     * the icon will be placed at left of the label, that will be shifted
25905     * to the right.
25906     *
25907     * Items created with this method can be deleted with
25908     * elm_diskselector_item_del().
25909     *
25910     * Associated @p data can be properly freed when item is deleted if a
25911     * callback function is set with elm_diskselector_item_del_cb_set().
25912     *
25913     * If a function is passed as argument, it will be called everytime this item
25914     * is selected, i.e., the user stops the diskselector with this
25915     * item on center position. If such function isn't needed, just passing
25916     * @c NULL as @p func is enough. The same should be done for @p data.
25917     *
25918     * Simple example (with no function callback or data associated):
25919     * @code
25920     * disk = elm_diskselector_add(win);
25921     * ic = elm_icon_add(win);
25922     * elm_icon_file_set(ic, "path/to/image", NULL);
25923     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25924     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25925     * @endcode
25926     *
25927     * @see elm_diskselector_item_del()
25928     * @see elm_diskselector_item_del_cb_set()
25929     * @see elm_diskselector_clear()
25930     * @see elm_icon_add()
25931     *
25932     * @ingroup Diskselector
25933     */
25934    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);
25935
25936
25937    /**
25938     * Delete them item from the diskselector.
25939     *
25940     * @param it The item of diskselector to be deleted.
25941     *
25942     * If deleting all diskselector items is required, elm_diskselector_clear()
25943     * should be used instead of getting items list and deleting each one.
25944     *
25945     * @see elm_diskselector_clear()
25946     * @see elm_diskselector_item_append()
25947     * @see elm_diskselector_item_del_cb_set()
25948     *
25949     * @ingroup Diskselector
25950     */
25951    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25952
25953    /**
25954     * Set the function called when a diskselector item is freed.
25955     *
25956     * @param it The item to set the callback on
25957     * @param func The function called
25958     *
25959     * If there is a @p func, then it will be called prior item's memory release.
25960     * That will be called with the following arguments:
25961     * @li item's data;
25962     * @li item's Evas object;
25963     * @li item itself;
25964     *
25965     * This way, a data associated to a diskselector item could be properly
25966     * freed.
25967     *
25968     * @ingroup Diskselector
25969     */
25970    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25971
25972    /**
25973     * Get the data associated to the item.
25974     *
25975     * @param it The diskselector item
25976     * @return The data associated to @p it
25977     *
25978     * The return value is a pointer to data associated to @p item when it was
25979     * created, with function elm_diskselector_item_append(). If no data
25980     * was passed as argument, it will return @c NULL.
25981     *
25982     * @see elm_diskselector_item_append()
25983     *
25984     * @ingroup Diskselector
25985     */
25986    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25987
25988    /**
25989     * Set the icon associated to the item.
25990     *
25991     * @param it The diskselector item
25992     * @param icon The icon object to associate with @p it
25993     *
25994     * The icon object to use at left side of the item. An
25995     * icon can be any Evas object, but usually it is an icon created
25996     * with elm_icon_add().
25997     *
25998     * Once the icon object is set, a previously set one will be deleted.
25999     * @warning Setting the same icon for two items will cause the icon to
26000     * dissapear from the first item.
26001     *
26002     * If an icon was passed as argument on item creation, with function
26003     * elm_diskselector_item_append(), it will be already
26004     * associated to the item.
26005     *
26006     * @see elm_diskselector_item_append()
26007     * @see elm_diskselector_item_icon_get()
26008     *
26009     * @ingroup Diskselector
26010     */
26011    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26012
26013    /**
26014     * Get the icon associated to the item.
26015     *
26016     * @param it The diskselector item
26017     * @return The icon associated to @p it
26018     *
26019     * The return value is a pointer to the icon associated to @p item when it was
26020     * created, with function elm_diskselector_item_append(), or later
26021     * with function elm_diskselector_item_icon_set. If no icon
26022     * was passed as argument, it will return @c NULL.
26023     *
26024     * @see elm_diskselector_item_append()
26025     * @see elm_diskselector_item_icon_set()
26026     *
26027     * @ingroup Diskselector
26028     */
26029    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26030
26031    /**
26032     * Set the label of item.
26033     *
26034     * @param it The item of diskselector.
26035     * @param label The label of item.
26036     *
26037     * The label to be displayed by the item.
26038     *
26039     * If no icon is set, label will be centered on item position, otherwise
26040     * the icon will be placed at left of the label, that will be shifted
26041     * to the right.
26042     *
26043     * An item with label "January" would be displayed on side position as
26044     * "Jan" if max length is set to 3 with function
26045     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26046     * is set to 4.
26047     *
26048     * When this @p item is selected, the entire label will be displayed,
26049     * except for width restrictions.
26050     * In this case label will be cropped and "..." will be concatenated,
26051     * but only for display purposes. It will keep the entire string, so
26052     * if diskselector is resized the remaining characters will be displayed.
26053     *
26054     * If a label was passed as argument on item creation, with function
26055     * elm_diskselector_item_append(), it will be already
26056     * displayed by the item.
26057     *
26058     * @see elm_diskselector_side_label_lenght_set()
26059     * @see elm_diskselector_item_label_get()
26060     * @see elm_diskselector_item_append()
26061     *
26062     * @ingroup Diskselector
26063     */
26064    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26065
26066    /**
26067     * Get the label of item.
26068     *
26069     * @param it The item of diskselector.
26070     * @return The label of item.
26071     *
26072     * The return value is a pointer to the label associated to @p item when it was
26073     * created, with function elm_diskselector_item_append(), or later
26074     * with function elm_diskselector_item_label_set. If no label
26075     * was passed as argument, it will return @c NULL.
26076     *
26077     * @see elm_diskselector_item_label_set() for more details.
26078     * @see elm_diskselector_item_append()
26079     *
26080     * @ingroup Diskselector
26081     */
26082    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26083
26084    /**
26085     * Get the selected item.
26086     *
26087     * @param obj The diskselector object.
26088     * @return The selected diskselector item.
26089     *
26090     * The selected item can be unselected with function
26091     * elm_diskselector_item_selected_set(), and the first item of
26092     * diskselector will be selected.
26093     *
26094     * The selected item always will be centered on diskselector, with
26095     * full label displayed, i.e., max lenght set to side labels won't
26096     * apply on the selected item. More details on
26097     * elm_diskselector_side_label_length_set().
26098     *
26099     * @ingroup Diskselector
26100     */
26101    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26102
26103    /**
26104     * Set the selected state of an item.
26105     *
26106     * @param it The diskselector item
26107     * @param selected The selected state
26108     *
26109     * This sets the selected state of the given item @p it.
26110     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26111     *
26112     * If a new item is selected the previosly selected will be unselected.
26113     * Previoulsy selected item can be get with function
26114     * elm_diskselector_selected_item_get().
26115     *
26116     * If the item @p it is unselected, the first item of diskselector will
26117     * be selected.
26118     *
26119     * Selected items will be visible on center position of diskselector.
26120     * So if it was on another position before selected, or was invisible,
26121     * diskselector will animate items until the selected item reaches center
26122     * position.
26123     *
26124     * @see elm_diskselector_item_selected_get()
26125     * @see elm_diskselector_selected_item_get()
26126     *
26127     * @ingroup Diskselector
26128     */
26129    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26130
26131    /*
26132     * Get whether the @p item is selected or not.
26133     *
26134     * @param it The diskselector item.
26135     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26136     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26137     *
26138     * @see elm_diskselector_selected_item_set() for details.
26139     * @see elm_diskselector_item_selected_get()
26140     *
26141     * @ingroup Diskselector
26142     */
26143    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26144
26145    /**
26146     * Get the first item of the diskselector.
26147     *
26148     * @param obj The diskselector object.
26149     * @return The first item, or @c NULL if none.
26150     *
26151     * The list of items follows append order. So it will return the first
26152     * item appended to the widget that wasn't deleted.
26153     *
26154     * @see elm_diskselector_item_append()
26155     * @see elm_diskselector_items_get()
26156     *
26157     * @ingroup Diskselector
26158     */
26159    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26160
26161    /**
26162     * Get the last item of the diskselector.
26163     *
26164     * @param obj The diskselector object.
26165     * @return The last item, or @c NULL if none.
26166     *
26167     * The list of items follows append order. So it will return last first
26168     * item appended to the widget that wasn't deleted.
26169     *
26170     * @see elm_diskselector_item_append()
26171     * @see elm_diskselector_items_get()
26172     *
26173     * @ingroup Diskselector
26174     */
26175    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26176
26177    /**
26178     * Get the item before @p item in diskselector.
26179     *
26180     * @param it The diskselector item.
26181     * @return The item before @p item, or @c NULL if none or on failure.
26182     *
26183     * The list of items follows append order. So it will return item appended
26184     * just before @p item and that wasn't deleted.
26185     *
26186     * If it is the first item, @c NULL will be returned.
26187     * First item can be get by elm_diskselector_first_item_get().
26188     *
26189     * @see elm_diskselector_item_append()
26190     * @see elm_diskselector_items_get()
26191     *
26192     * @ingroup Diskselector
26193     */
26194    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26195
26196    /**
26197     * Get the item after @p item in diskselector.
26198     *
26199     * @param it The diskselector item.
26200     * @return The item after @p item, or @c NULL if none or on failure.
26201     *
26202     * The list of items follows append order. So it will return item appended
26203     * just after @p item and that wasn't deleted.
26204     *
26205     * If it is the last item, @c NULL will be returned.
26206     * Last item can be get by elm_diskselector_last_item_get().
26207     *
26208     * @see elm_diskselector_item_append()
26209     * @see elm_diskselector_items_get()
26210     *
26211     * @ingroup Diskselector
26212     */
26213    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26214
26215    /**
26216     * Set the text to be shown in the diskselector item.
26217     *
26218     * @param item Target item
26219     * @param text The text to set in the content
26220     *
26221     * Setup the text as tooltip to object. The item can have only one tooltip,
26222     * so any previous tooltip data is removed.
26223     *
26224     * @see elm_object_tooltip_text_set() for more details.
26225     *
26226     * @ingroup Diskselector
26227     */
26228    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26229
26230    /**
26231     * Set the content to be shown in the tooltip item.
26232     *
26233     * Setup the tooltip to item. The item can have only one tooltip,
26234     * so any previous tooltip data is removed. @p func(with @p data) will
26235     * be called every time that need show the tooltip and it should
26236     * return a valid Evas_Object. This object is then managed fully by
26237     * tooltip system and is deleted when the tooltip is gone.
26238     *
26239     * @param item the diskselector item being attached a tooltip.
26240     * @param func the function used to create the tooltip contents.
26241     * @param data what to provide to @a func as callback data/context.
26242     * @param del_cb called when data is not needed anymore, either when
26243     *        another callback replaces @p func, the tooltip is unset with
26244     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26245     *        dies. This callback receives as the first parameter the
26246     *        given @a data, and @c event_info is the item.
26247     *
26248     * @see elm_object_tooltip_content_cb_set() for more details.
26249     *
26250     * @ingroup Diskselector
26251     */
26252    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);
26253
26254    /**
26255     * Unset tooltip from item.
26256     *
26257     * @param item diskselector item to remove previously set tooltip.
26258     *
26259     * Remove tooltip from item. The callback provided as del_cb to
26260     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26261     * it is not used anymore.
26262     *
26263     * @see elm_object_tooltip_unset() for more details.
26264     * @see elm_diskselector_item_tooltip_content_cb_set()
26265     *
26266     * @ingroup Diskselector
26267     */
26268    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26269
26270
26271    /**
26272     * Sets a different style for this item tooltip.
26273     *
26274     * @note before you set a style you should define a tooltip with
26275     *       elm_diskselector_item_tooltip_content_cb_set() or
26276     *       elm_diskselector_item_tooltip_text_set()
26277     *
26278     * @param item diskselector item with tooltip already set.
26279     * @param style the theme style to use (default, transparent, ...)
26280     *
26281     * @see elm_object_tooltip_style_set() for more details.
26282     *
26283     * @ingroup Diskselector
26284     */
26285    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26286
26287    /**
26288     * Get the style for this item tooltip.
26289     *
26290     * @param item diskselector item with tooltip already set.
26291     * @return style the theme style in use, defaults to "default". If the
26292     *         object does not have a tooltip set, then NULL is returned.
26293     *
26294     * @see elm_object_tooltip_style_get() for more details.
26295     * @see elm_diskselector_item_tooltip_style_set()
26296     *
26297     * @ingroup Diskselector
26298     */
26299    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26300
26301    /**
26302     * Set the cursor to be shown when mouse is over the diskselector item
26303     *
26304     * @param item Target item
26305     * @param cursor the cursor name to be used.
26306     *
26307     * @see elm_object_cursor_set() for more details.
26308     *
26309     * @ingroup Diskselector
26310     */
26311    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26312
26313    /**
26314     * Get the cursor to be shown when mouse is over the diskselector item
26315     *
26316     * @param item diskselector item with cursor already set.
26317     * @return the cursor name.
26318     *
26319     * @see elm_object_cursor_get() for more details.
26320     * @see elm_diskselector_cursor_set()
26321     *
26322     * @ingroup Diskselector
26323     */
26324    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26325
26326
26327    /**
26328     * Unset the cursor to be shown when mouse is over the diskselector item
26329     *
26330     * @param item Target item
26331     *
26332     * @see elm_object_cursor_unset() for more details.
26333     * @see elm_diskselector_cursor_set()
26334     *
26335     * @ingroup Diskselector
26336     */
26337    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26338
26339    /**
26340     * Sets a different style for this item cursor.
26341     *
26342     * @note before you set a style you should define a cursor with
26343     *       elm_diskselector_item_cursor_set()
26344     *
26345     * @param item diskselector item with cursor already set.
26346     * @param style the theme style to use (default, transparent, ...)
26347     *
26348     * @see elm_object_cursor_style_set() for more details.
26349     *
26350     * @ingroup Diskselector
26351     */
26352    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26353
26354
26355    /**
26356     * Get the style for this item cursor.
26357     *
26358     * @param item diskselector item with cursor already set.
26359     * @return style the theme style in use, defaults to "default". If the
26360     *         object does not have a cursor set, then @c NULL is returned.
26361     *
26362     * @see elm_object_cursor_style_get() for more details.
26363     * @see elm_diskselector_item_cursor_style_set()
26364     *
26365     * @ingroup Diskselector
26366     */
26367    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26368
26369
26370    /**
26371     * Set if the cursor set should be searched on the theme or should use
26372     * the provided by the engine, only.
26373     *
26374     * @note before you set if should look on theme you should define a cursor
26375     * with elm_diskselector_item_cursor_set().
26376     * By default it will only look for cursors provided by the engine.
26377     *
26378     * @param item widget item with cursor already set.
26379     * @param engine_only boolean to define if cursors set with
26380     * elm_diskselector_item_cursor_set() should be searched only
26381     * between cursors provided by the engine or searched on widget's
26382     * theme as well.
26383     *
26384     * @see elm_object_cursor_engine_only_set() for more details.
26385     *
26386     * @ingroup Diskselector
26387     */
26388    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26389
26390    /**
26391     * Get the cursor engine only usage for this item cursor.
26392     *
26393     * @param item widget item with cursor already set.
26394     * @return engine_only boolean to define it cursors should be looked only
26395     * between the provided by the engine or searched on widget's theme as well.
26396     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26397     *
26398     * @see elm_object_cursor_engine_only_get() for more details.
26399     * @see elm_diskselector_item_cursor_engine_only_set()
26400     *
26401     * @ingroup Diskselector
26402     */
26403    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26404
26405    /**
26406     * @}
26407     */
26408
26409    /**
26410     * @defgroup Colorselector Colorselector
26411     *
26412     * @{
26413     *
26414     * @image html img/widget/colorselector/preview-00.png
26415     * @image latex img/widget/colorselector/preview-00.eps
26416     *
26417     * @brief Widget for user to select a color.
26418     *
26419     * Signals that you can add callbacks for are:
26420     * "changed" - When the color value changes(event_info is NULL).
26421     *
26422     * See @ref tutorial_colorselector.
26423     */
26424    /**
26425     * @brief Add a new colorselector to the parent
26426     *
26427     * @param parent The parent object
26428     * @return The new object or NULL if it cannot be created
26429     *
26430     * @ingroup Colorselector
26431     */
26432    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26433    /**
26434     * Set a color for the colorselector
26435     *
26436     * @param obj   Colorselector object
26437     * @param r     r-value of color
26438     * @param g     g-value of color
26439     * @param b     b-value of color
26440     * @param a     a-value of color
26441     *
26442     * @ingroup Colorselector
26443     */
26444    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26445    /**
26446     * Get a color from the colorselector
26447     *
26448     * @param obj   Colorselector object
26449     * @param r     integer pointer for r-value of color
26450     * @param g     integer pointer for g-value of color
26451     * @param b     integer pointer for b-value of color
26452     * @param a     integer pointer for a-value of color
26453     *
26454     * @ingroup Colorselector
26455     */
26456    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26457    /**
26458     * @}
26459     */
26460
26461    /**
26462     * @defgroup Ctxpopup Ctxpopup
26463     *
26464     * @image html img/widget/ctxpopup/preview-00.png
26465     * @image latex img/widget/ctxpopup/preview-00.eps
26466     *
26467     * @brief Context popup widet.
26468     *
26469     * A ctxpopup is a widget that, when shown, pops up a list of items.
26470     * It automatically chooses an area inside its parent object's view
26471     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26472     * optimally fit into it. In the default theme, it will also point an
26473     * arrow to it's top left position at the time one shows it. Ctxpopup
26474     * items have a label and/or an icon. It is intended for a small
26475     * number of items (hence the use of list, not genlist).
26476     *
26477     * @note Ctxpopup is a especialization of @ref Hover.
26478     *
26479     * Signals that you can add callbacks for are:
26480     * "dismissed" - the ctxpopup was dismissed
26481     *
26482     * Default contents parts of the ctxpopup widget that you can use for are:
26483     * @li "default" - A content of the ctxpopup
26484     *
26485     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26486     * @{
26487     */
26488    typedef enum _Elm_Ctxpopup_Direction
26489      {
26490         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26491                                           area */
26492         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26493                                            the clicked area */
26494         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26495                                           the clicked area */
26496         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26497                                         area */
26498         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26499      } Elm_Ctxpopup_Direction;
26500 #define Elm_Ctxpopup_Item Elm_Object_Item
26501
26502    /**
26503     * @brief Add a new Ctxpopup object to the parent.
26504     *
26505     * @param parent Parent object
26506     * @return New object or @c NULL, if it cannot be created
26507     */
26508    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26509    /**
26510     * @brief Set the Ctxpopup's parent
26511     *
26512     * @param obj The ctxpopup object
26513     * @param area The parent to use
26514     *
26515     * Set the parent object.
26516     *
26517     * @note elm_ctxpopup_add() will automatically call this function
26518     * with its @c parent argument.
26519     *
26520     * @see elm_ctxpopup_add()
26521     * @see elm_hover_parent_set()
26522     */
26523    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26524    /**
26525     * @brief Get the Ctxpopup's parent
26526     *
26527     * @param obj The ctxpopup object
26528     *
26529     * @see elm_ctxpopup_hover_parent_set() for more information
26530     */
26531    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26532    /**
26533     * @brief Clear all items in the given ctxpopup object.
26534     *
26535     * @param obj Ctxpopup object
26536     */
26537    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26538    /**
26539     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26540     *
26541     * @param obj Ctxpopup object
26542     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26543     */
26544    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26545    /**
26546     * @brief Get the value of current ctxpopup object's orientation.
26547     *
26548     * @param obj Ctxpopup object
26549     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26550     *
26551     * @see elm_ctxpopup_horizontal_set()
26552     */
26553    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26554    /**
26555     * @brief Add a new item to a ctxpopup object.
26556     *
26557     * @param obj Ctxpopup object
26558     * @param icon Icon to be set on new item
26559     * @param label The Label of the new item
26560     * @param func Convenience function called when item selected
26561     * @param data Data passed to @p func
26562     * @return A handle to the item added or @c NULL, on errors
26563     *
26564     * @warning Ctxpopup can't hold both an item list and a content at the same
26565     * time. When an item is added, any previous content will be removed.
26566     *
26567     * @see elm_ctxpopup_content_set()
26568     */
26569    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);
26570    /**
26571     * @brief Delete the given item in a ctxpopup object.
26572     *
26573     * @param it Ctxpopup item to be deleted
26574     *
26575     * @see elm_ctxpopup_item_append()
26576     */
26577    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26578    /**
26579     * @brief Set the ctxpopup item's state as disabled or enabled.
26580     *
26581     * @param it Ctxpopup item to be enabled/disabled
26582     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26583     *
26584     * When disabled the item is greyed out to indicate it's state.
26585     */
26586    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26587    /**
26588     * @brief Get the ctxpopup item's disabled/enabled state.
26589     *
26590     * @param it Ctxpopup item to be enabled/disabled
26591     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26592     *
26593     * @see elm_ctxpopup_item_disabled_set()
26594     * @deprecated use elm_object_item_disabled_get() instead
26595     */
26596    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26597    /**
26598     * @brief Get the icon object for the given ctxpopup item.
26599     *
26600     * @param it Ctxpopup item
26601     * @return icon object or @c NULL, if the item does not have icon or an error
26602     * occurred
26603     *
26604     * @see elm_ctxpopup_item_append()
26605     * @see elm_ctxpopup_item_icon_set()
26606     */
26607    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26608    /**
26609     * @brief Sets the side icon associated with the ctxpopup item
26610     *
26611     * @param it Ctxpopup item
26612     * @param icon Icon object to be set
26613     *
26614     * Once the icon object is set, a previously set one will be deleted.
26615     * @warning Setting the same icon for two items will cause the icon to
26616     * dissapear from the first item.
26617     *
26618     * @see elm_ctxpopup_item_append()
26619     */
26620    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26621    /**
26622     * @brief Get the label for the given ctxpopup item.
26623     *
26624     * @param it Ctxpopup item
26625     * @return label string or @c NULL, if the item does not have label or an
26626     * error occured
26627     *
26628     * @see elm_ctxpopup_item_append()
26629     * @see elm_ctxpopup_item_label_set()
26630     */
26631    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26632    /**
26633     * @brief (Re)set the label on the given ctxpopup item.
26634     *
26635     * @param it Ctxpopup item
26636     * @param label String to set as label
26637     */
26638    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26639    /**
26640     * @brief Set an elm widget as the content of the ctxpopup.
26641     *
26642     * @param obj Ctxpopup object
26643     * @param content Content to be swallowed
26644     *
26645     * If the content object is already set, a previous one will bedeleted. If
26646     * you want to keep that old content object, use the
26647     * elm_ctxpopup_content_unset() function.
26648     *
26649     * @deprecated use elm_object_content_set()
26650     *
26651     * @warning Ctxpopup can't hold both a item list and a content at the same
26652     * time. When a content is set, any previous items will be removed.
26653     */
26654    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26655    /**
26656     * @brief Unset the ctxpopup content
26657     *
26658     * @param obj Ctxpopup object
26659     * @return The content that was being used
26660     *
26661     * Unparent and return the content object which was set for this widget.
26662     *
26663     * @deprecated use elm_object_content_unset()
26664     *
26665     * @see elm_ctxpopup_content_set()
26666     */
26667    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26668    /**
26669     * @brief Set the direction priority of a ctxpopup.
26670     *
26671     * @param obj Ctxpopup object
26672     * @param first 1st priority of direction
26673     * @param second 2nd priority of direction
26674     * @param third 3th priority of direction
26675     * @param fourth 4th priority of direction
26676     *
26677     * This functions gives a chance to user to set the priority of ctxpopup
26678     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26679     * requested direction.
26680     *
26681     * @see Elm_Ctxpopup_Direction
26682     */
26683    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);
26684    /**
26685     * @brief Get the direction priority of a ctxpopup.
26686     *
26687     * @param obj Ctxpopup object
26688     * @param first 1st priority of direction to be returned
26689     * @param second 2nd priority of direction to be returned
26690     * @param third 3th priority of direction to be returned
26691     * @param fourth 4th priority of direction to be returned
26692     *
26693     * @see elm_ctxpopup_direction_priority_set() for more information.
26694     */
26695    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);
26696
26697    /**
26698     * @brief Get the current direction of a ctxpopup.
26699     *
26700     * @param obj Ctxpopup object
26701     * @return current direction of a ctxpopup
26702     *
26703     * @warning Once the ctxpopup showed up, the direction would be determined
26704     */
26705    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26706
26707    /**
26708     * @}
26709     */
26710
26711    /* transit */
26712    /**
26713     *
26714     * @defgroup Transit Transit
26715     * @ingroup Elementary
26716     *
26717     * Transit is designed to apply various animated transition effects to @c
26718     * Evas_Object, such like translation, rotation, etc. For using these
26719     * effects, create an @ref Elm_Transit and add the desired transition effects.
26720     *
26721     * Once the effects are added into transit, they will be automatically
26722     * managed (their callback will be called until the duration is ended, and
26723     * they will be deleted on completion).
26724     *
26725     * Example:
26726     * @code
26727     * Elm_Transit *trans = elm_transit_add();
26728     * elm_transit_object_add(trans, obj);
26729     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26730     * elm_transit_duration_set(transit, 1);
26731     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26732     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26733     * elm_transit_repeat_times_set(transit, 3);
26734     * @endcode
26735     *
26736     * Some transition effects are used to change the properties of objects. They
26737     * are:
26738     * @li @ref elm_transit_effect_translation_add
26739     * @li @ref elm_transit_effect_color_add
26740     * @li @ref elm_transit_effect_rotation_add
26741     * @li @ref elm_transit_effect_wipe_add
26742     * @li @ref elm_transit_effect_zoom_add
26743     * @li @ref elm_transit_effect_resizing_add
26744     *
26745     * Other transition effects are used to make one object disappear and another
26746     * object appear on its old place. These effects are:
26747     *
26748     * @li @ref elm_transit_effect_flip_add
26749     * @li @ref elm_transit_effect_resizable_flip_add
26750     * @li @ref elm_transit_effect_fade_add
26751     * @li @ref elm_transit_effect_blend_add
26752     *
26753     * It's also possible to make a transition chain with @ref
26754     * elm_transit_chain_transit_add.
26755     *
26756     * @warning We strongly recommend to use elm_transit just when edje can not do
26757     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26758     * animations can be manipulated inside the theme.
26759     *
26760     * List of examples:
26761     * @li @ref transit_example_01_explained
26762     * @li @ref transit_example_02_explained
26763     * @li @ref transit_example_03_c
26764     * @li @ref transit_example_04_c
26765     *
26766     * @{
26767     */
26768
26769    /**
26770     * @enum Elm_Transit_Tween_Mode
26771     *
26772     * The type of acceleration used in the transition.
26773     */
26774    typedef enum
26775      {
26776         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26777         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26778                                              over time, then decrease again
26779                                              and stop slowly */
26780         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26781                                              speed over time */
26782         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26783                                             over time */
26784      } Elm_Transit_Tween_Mode;
26785
26786    /**
26787     * @enum Elm_Transit_Effect_Flip_Axis
26788     *
26789     * The axis where flip effect should be applied.
26790     */
26791    typedef enum
26792      {
26793         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26794         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26795      } Elm_Transit_Effect_Flip_Axis;
26796    /**
26797     * @enum Elm_Transit_Effect_Wipe_Dir
26798     *
26799     * The direction where the wipe effect should occur.
26800     */
26801    typedef enum
26802      {
26803         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26804         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26805         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26806         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26807      } Elm_Transit_Effect_Wipe_Dir;
26808    /** @enum Elm_Transit_Effect_Wipe_Type
26809     *
26810     * Whether the wipe effect should show or hide the object.
26811     */
26812    typedef enum
26813      {
26814         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26815                                              animation */
26816         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26817                                             animation */
26818      } Elm_Transit_Effect_Wipe_Type;
26819
26820    /**
26821     * @typedef Elm_Transit
26822     *
26823     * The Transit created with elm_transit_add(). This type has the information
26824     * about the objects which the transition will be applied, and the
26825     * transition effects that will be used. It also contains info about
26826     * duration, number of repetitions, auto-reverse, etc.
26827     */
26828    typedef struct _Elm_Transit Elm_Transit;
26829    typedef void Elm_Transit_Effect;
26830    /**
26831     * @typedef Elm_Transit_Effect_Transition_Cb
26832     *
26833     * Transition callback called for this effect on each transition iteration.
26834     */
26835    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26836    /**
26837     * Elm_Transit_Effect_End_Cb
26838     *
26839     * Transition callback called for this effect when the transition is over.
26840     */
26841    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26842
26843    /**
26844     * Elm_Transit_Del_Cb
26845     *
26846     * A callback called when the transit is deleted.
26847     */
26848    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26849
26850    /**
26851     * Add new transit.
26852     *
26853     * @note Is not necessary to delete the transit object, it will be deleted at
26854     * the end of its operation.
26855     * @note The transit will start playing when the program enter in the main loop, is not
26856     * necessary to give a start to the transit.
26857     *
26858     * @return The transit object.
26859     *
26860     * @ingroup Transit
26861     */
26862    EAPI Elm_Transit                *elm_transit_add(void);
26863
26864    /**
26865     * Stops the animation and delete the @p transit object.
26866     *
26867     * Call this function if you wants to stop the animation before the duration
26868     * time. Make sure the @p transit object is still alive with
26869     * elm_transit_del_cb_set() function.
26870     * All added effects will be deleted, calling its repective data_free_cb
26871     * functions. The function setted by elm_transit_del_cb_set() will be called.
26872     *
26873     * @see elm_transit_del_cb_set()
26874     *
26875     * @param transit The transit object to be deleted.
26876     *
26877     * @ingroup Transit
26878     * @warning Just call this function if you are sure the transit is alive.
26879     */
26880    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26881
26882    /**
26883     * Add a new effect to the transit.
26884     *
26885     * @note The cb function and the data are the key to the effect. If you try to
26886     * add an already added effect, nothing is done.
26887     * @note After the first addition of an effect in @p transit, if its
26888     * effect list become empty again, the @p transit will be killed by
26889     * elm_transit_del(transit) function.
26890     *
26891     * Exemple:
26892     * @code
26893     * Elm_Transit *transit = elm_transit_add();
26894     * elm_transit_effect_add(transit,
26895     *                        elm_transit_effect_blend_op,
26896     *                        elm_transit_effect_blend_context_new(),
26897     *                        elm_transit_effect_blend_context_free);
26898     * @endcode
26899     *
26900     * @param transit The transit object.
26901     * @param transition_cb The operation function. It is called when the
26902     * animation begins, it is the function that actually performs the animation.
26903     * It is called with the @p data, @p transit and the time progression of the
26904     * animation (a double value between 0.0 and 1.0).
26905     * @param effect The context data of the effect.
26906     * @param end_cb The function to free the context data, it will be called
26907     * at the end of the effect, it must finalize the animation and free the
26908     * @p data.
26909     *
26910     * @ingroup Transit
26911     * @warning The transit free the context data at the and of the transition with
26912     * the data_free_cb function, do not use the context data in another transit.
26913     */
26914    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);
26915
26916    /**
26917     * Delete an added effect.
26918     *
26919     * This function will remove the effect from the @p transit, calling the
26920     * data_free_cb to free the @p data.
26921     *
26922     * @see elm_transit_effect_add()
26923     *
26924     * @note If the effect is not found, nothing is done.
26925     * @note If the effect list become empty, this function will call
26926     * elm_transit_del(transit), that is, it will kill the @p transit.
26927     *
26928     * @param transit The transit object.
26929     * @param transition_cb The operation function.
26930     * @param effect The context data of the effect.
26931     *
26932     * @ingroup Transit
26933     */
26934    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);
26935
26936    /**
26937     * Add new object to apply the effects.
26938     *
26939     * @note After the first addition of an object in @p transit, if its
26940     * object list become empty again, the @p transit will be killed by
26941     * elm_transit_del(transit) function.
26942     * @note If the @p obj belongs to another transit, the @p obj will be
26943     * removed from it and it will only belong to the @p transit. If the old
26944     * transit stays without objects, it will die.
26945     * @note When you add an object into the @p transit, its state from
26946     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26947     * transit ends, if you change this state whith evas_object_pass_events_set()
26948     * after add the object, this state will change again when @p transit stops to
26949     * run.
26950     *
26951     * @param transit The transit object.
26952     * @param obj Object to be animated.
26953     *
26954     * @ingroup Transit
26955     * @warning It is not allowed to add a new object after transit begins to go.
26956     */
26957    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26958
26959    /**
26960     * Removes an added object from the transit.
26961     *
26962     * @note If the @p obj is not in the @p transit, nothing is done.
26963     * @note If the list become empty, this function will call
26964     * elm_transit_del(transit), that is, it will kill the @p transit.
26965     *
26966     * @param transit The transit object.
26967     * @param obj Object to be removed from @p transit.
26968     *
26969     * @ingroup Transit
26970     * @warning It is not allowed to remove objects after transit begins to go.
26971     */
26972    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26973
26974    /**
26975     * Get the objects of the transit.
26976     *
26977     * @param transit The transit object.
26978     * @return a Eina_List with the objects from the transit.
26979     *
26980     * @ingroup Transit
26981     */
26982    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26983
26984    /**
26985     * Enable/disable keeping up the objects states.
26986     * If it is not kept, the objects states will be reset when transition ends.
26987     *
26988     * @note @p transit can not be NULL.
26989     * @note One state includes geometry, color, map data.
26990     *
26991     * @param transit The transit object.
26992     * @param state_keep Keeping or Non Keeping.
26993     *
26994     * @ingroup Transit
26995     */
26996    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26997
26998    /**
26999     * Get a value whether the objects states will be reset or not.
27000     *
27001     * @note @p transit can not be NULL
27002     *
27003     * @see elm_transit_objects_final_state_keep_set()
27004     *
27005     * @param transit The transit object.
27006     * @return EINA_TRUE means the states of the objects will be reset.
27007     * If @p transit is NULL, EINA_FALSE is returned
27008     *
27009     * @ingroup Transit
27010     */
27011    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27012
27013    /**
27014     * Set the event enabled when transit is operating.
27015     *
27016     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27017     * events from mouse and keyboard during the animation.
27018     * @note When you add an object with elm_transit_object_add(), its state from
27019     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27020     * transit ends, if you change this state with evas_object_pass_events_set()
27021     * after adding the object, this state will change again when @p transit stops
27022     * to run.
27023     *
27024     * @param transit The transit object.
27025     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27026     * ignored otherwise.
27027     *
27028     * @ingroup Transit
27029     */
27030    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27031
27032    /**
27033     * Get the value of event enabled status.
27034     *
27035     * @see elm_transit_event_enabled_set()
27036     *
27037     * @param transit The Transit object
27038     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27039     * EINA_FALSE is returned
27040     *
27041     * @ingroup Transit
27042     */
27043    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27044
27045    /**
27046     * Set the user-callback function when the transit is deleted.
27047     *
27048     * @note Using this function twice will overwrite the first function setted.
27049     * @note the @p transit object will be deleted after call @p cb function.
27050     *
27051     * @param transit The transit object.
27052     * @param cb Callback function pointer. This function will be called before
27053     * the deletion of the transit.
27054     * @param data Callback funtion user data. It is the @p op parameter.
27055     *
27056     * @ingroup Transit
27057     */
27058    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27059
27060    /**
27061     * Set reverse effect automatically.
27062     *
27063     * If auto reverse is setted, after running the effects with the progress
27064     * parameter from 0 to 1, it will call the effecs again with the progress
27065     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27066     * where the duration was setted with the function elm_transit_add and
27067     * the repeat with the function elm_transit_repeat_times_set().
27068     *
27069     * @param transit The transit object.
27070     * @param reverse EINA_TRUE means the auto_reverse is on.
27071     *
27072     * @ingroup Transit
27073     */
27074    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27075
27076    /**
27077     * Get if the auto reverse is on.
27078     *
27079     * @see elm_transit_auto_reverse_set()
27080     *
27081     * @param transit The transit object.
27082     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27083     * EINA_FALSE is returned
27084     *
27085     * @ingroup Transit
27086     */
27087    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27088
27089    /**
27090     * Set the transit repeat count. Effect will be repeated by repeat count.
27091     *
27092     * This function sets the number of repetition the transit will run after
27093     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27094     * If the @p repeat is a negative number, it will repeat infinite times.
27095     *
27096     * @note If this function is called during the transit execution, the transit
27097     * will run @p repeat times, ignoring the times it already performed.
27098     *
27099     * @param transit The transit object
27100     * @param repeat Repeat count
27101     *
27102     * @ingroup Transit
27103     */
27104    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27105
27106    /**
27107     * Get the transit repeat count.
27108     *
27109     * @see elm_transit_repeat_times_set()
27110     *
27111     * @param transit The Transit object.
27112     * @return The repeat count. If @p transit is NULL
27113     * 0 is returned
27114     *
27115     * @ingroup Transit
27116     */
27117    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27118
27119    /**
27120     * Set the transit animation acceleration type.
27121     *
27122     * This function sets the tween mode of the transit that can be:
27123     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27124     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27125     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27126     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27127     *
27128     * @param transit The transit object.
27129     * @param tween_mode The tween type.
27130     *
27131     * @ingroup Transit
27132     */
27133    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27134
27135    /**
27136     * Get the transit animation acceleration type.
27137     *
27138     * @note @p transit can not be NULL
27139     *
27140     * @param transit The transit object.
27141     * @return The tween type. If @p transit is NULL
27142     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27143     *
27144     * @ingroup Transit
27145     */
27146    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27147
27148    /**
27149     * Set the transit animation time
27150     *
27151     * @note @p transit can not be NULL
27152     *
27153     * @param transit The transit object.
27154     * @param duration The animation time.
27155     *
27156     * @ingroup Transit
27157     */
27158    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27159
27160    /**
27161     * Get the transit animation time
27162     *
27163     * @note @p transit can not be NULL
27164     *
27165     * @param transit The transit object.
27166     *
27167     * @return The transit animation time.
27168     *
27169     * @ingroup Transit
27170     */
27171    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27172
27173    /**
27174     * Starts the transition.
27175     * Once this API is called, the transit begins to measure the time.
27176     *
27177     * @note @p transit can not be NULL
27178     *
27179     * @param transit The transit object.
27180     *
27181     * @ingroup Transit
27182     */
27183    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27184
27185    /**
27186     * Pause/Resume the transition.
27187     *
27188     * If you call elm_transit_go again, the transit will be started from the
27189     * beginning, and will be unpaused.
27190     *
27191     * @note @p transit can not be NULL
27192     *
27193     * @param transit The transit object.
27194     * @param paused Whether the transition should be paused or not.
27195     *
27196     * @ingroup Transit
27197     */
27198    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27199
27200    /**
27201     * Get the value of paused status.
27202     *
27203     * @see elm_transit_paused_set()
27204     *
27205     * @note @p transit can not be NULL
27206     *
27207     * @param transit The transit object.
27208     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27209     * EINA_FALSE is returned
27210     *
27211     * @ingroup Transit
27212     */
27213    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27214
27215    /**
27216     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27217     *
27218     * The value returned is a fraction (current time / total time). It
27219     * represents the progression position relative to the total.
27220     *
27221     * @note @p transit can not be NULL
27222     *
27223     * @param transit The transit object.
27224     *
27225     * @return The time progression value. If @p transit is NULL
27226     * 0 is returned
27227     *
27228     * @ingroup Transit
27229     */
27230    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27231
27232    /**
27233     * Makes the chain relationship between two transits.
27234     *
27235     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27236     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27237     *
27238     * @param transit The transit object.
27239     * @param chain_transit The chain transit object. This transit will be operated
27240     *        after transit is done.
27241     *
27242     * This function adds @p chain_transit transition to a chain after the @p
27243     * transit, and will be started as soon as @p transit ends. See @ref
27244     * transit_example_02_explained for a full example.
27245     *
27246     * @ingroup Transit
27247     */
27248    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27249
27250    /**
27251     * Cut off the chain relationship between two transits.
27252     *
27253     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27254     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27255     *
27256     * @param transit The transit object.
27257     * @param chain_transit The chain transit object.
27258     *
27259     * This function remove the @p chain_transit transition from the @p transit.
27260     *
27261     * @ingroup Transit
27262     */
27263    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27264
27265    /**
27266     * Get the current chain transit list.
27267     *
27268     * @note @p transit can not be NULL.
27269     *
27270     * @param transit The transit object.
27271     * @return chain transit list.
27272     *
27273     * @ingroup Transit
27274     */
27275    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27276
27277    /**
27278     * Add the Resizing Effect to Elm_Transit.
27279     *
27280     * @note This API is one of the facades. It creates resizing effect context
27281     * and add it's required APIs to elm_transit_effect_add.
27282     *
27283     * @see elm_transit_effect_add()
27284     *
27285     * @param transit Transit object.
27286     * @param from_w Object width size when effect begins.
27287     * @param from_h Object height size when effect begins.
27288     * @param to_w Object width size when effect ends.
27289     * @param to_h Object height size when effect ends.
27290     * @return Resizing effect context data.
27291     *
27292     * @ingroup Transit
27293     */
27294    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);
27295
27296    /**
27297     * Add the Translation Effect to Elm_Transit.
27298     *
27299     * @note This API is one of the facades. It creates translation effect context
27300     * and add it's required APIs to elm_transit_effect_add.
27301     *
27302     * @see elm_transit_effect_add()
27303     *
27304     * @param transit Transit object.
27305     * @param from_dx X Position variation when effect begins.
27306     * @param from_dy Y Position variation when effect begins.
27307     * @param to_dx X Position variation when effect ends.
27308     * @param to_dy Y Position variation when effect ends.
27309     * @return Translation effect context data.
27310     *
27311     * @ingroup Transit
27312     * @warning It is highly recommended just create a transit with this effect when
27313     * the window that the objects of the transit belongs has already been created.
27314     * This is because this effect needs the geometry information about the objects,
27315     * and if the window was not created yet, it can get a wrong information.
27316     */
27317    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);
27318
27319    /**
27320     * Add the Zoom Effect to Elm_Transit.
27321     *
27322     * @note This API is one of the facades. It creates zoom effect context
27323     * and add it's required APIs to elm_transit_effect_add.
27324     *
27325     * @see elm_transit_effect_add()
27326     *
27327     * @param transit Transit object.
27328     * @param from_rate Scale rate when effect begins (1 is current rate).
27329     * @param to_rate Scale rate when effect ends.
27330     * @return Zoom effect context data.
27331     *
27332     * @ingroup Transit
27333     * @warning It is highly recommended just create a transit with this effect when
27334     * the window that the objects of the transit belongs has already been created.
27335     * This is because this effect needs the geometry information about the objects,
27336     * and if the window was not created yet, it can get a wrong information.
27337     */
27338    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27339
27340    /**
27341     * Add the Flip Effect to Elm_Transit.
27342     *
27343     * @note This API is one of the facades. It creates flip effect context
27344     * and add it's required APIs to elm_transit_effect_add.
27345     * @note This effect is applied to each pair of objects in the order they are listed
27346     * in the transit list of objects. The first object in the pair will be the
27347     * "front" object and the second will be the "back" object.
27348     *
27349     * @see elm_transit_effect_add()
27350     *
27351     * @param transit Transit object.
27352     * @param axis Flipping Axis(X or Y).
27353     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27354     * @return Flip effect context data.
27355     *
27356     * @ingroup Transit
27357     * @warning It is highly recommended just create a transit with this effect when
27358     * the window that the objects of the transit belongs has already been created.
27359     * This is because this effect needs the geometry information about the objects,
27360     * and if the window was not created yet, it can get a wrong information.
27361     */
27362    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27363
27364    /**
27365     * Add the Resizable Flip Effect to Elm_Transit.
27366     *
27367     * @note This API is one of the facades. It creates resizable flip effect context
27368     * and add it's required APIs to elm_transit_effect_add.
27369     * @note This effect is applied to each pair of objects in the order they are listed
27370     * in the transit list of objects. The first object in the pair will be the
27371     * "front" object and the second will be the "back" object.
27372     *
27373     * @see elm_transit_effect_add()
27374     *
27375     * @param transit Transit object.
27376     * @param axis Flipping Axis(X or Y).
27377     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27378     * @return Resizable flip effect context data.
27379     *
27380     * @ingroup Transit
27381     * @warning It is highly recommended just create a transit with this effect when
27382     * the window that the objects of the transit belongs has already been created.
27383     * This is because this effect needs the geometry information about the objects,
27384     * and if the window was not created yet, it can get a wrong information.
27385     */
27386    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27387
27388    /**
27389     * Add the Wipe Effect to Elm_Transit.
27390     *
27391     * @note This API is one of the facades. It creates wipe effect context
27392     * and add it's required APIs to elm_transit_effect_add.
27393     *
27394     * @see elm_transit_effect_add()
27395     *
27396     * @param transit Transit object.
27397     * @param type Wipe type. Hide or show.
27398     * @param dir Wipe Direction.
27399     * @return Wipe effect context data.
27400     *
27401     * @ingroup Transit
27402     * @warning It is highly recommended just create a transit with this effect when
27403     * the window that the objects of the transit belongs has already been created.
27404     * This is because this effect needs the geometry information about the objects,
27405     * and if the window was not created yet, it can get a wrong information.
27406     */
27407    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27408
27409    /**
27410     * Add the Color Effect to Elm_Transit.
27411     *
27412     * @note This API is one of the facades. It creates color effect context
27413     * and add it's required APIs to elm_transit_effect_add.
27414     *
27415     * @see elm_transit_effect_add()
27416     *
27417     * @param transit        Transit object.
27418     * @param  from_r        RGB R when effect begins.
27419     * @param  from_g        RGB G when effect begins.
27420     * @param  from_b        RGB B when effect begins.
27421     * @param  from_a        RGB A when effect begins.
27422     * @param  to_r          RGB R when effect ends.
27423     * @param  to_g          RGB G when effect ends.
27424     * @param  to_b          RGB B when effect ends.
27425     * @param  to_a          RGB A when effect ends.
27426     * @return               Color effect context data.
27427     *
27428     * @ingroup Transit
27429     */
27430    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);
27431
27432    /**
27433     * Add the Fade Effect to Elm_Transit.
27434     *
27435     * @note This API is one of the facades. It creates fade effect context
27436     * and add it's required APIs to elm_transit_effect_add.
27437     * @note This effect is applied to each pair of objects in the order they are listed
27438     * in the transit list of objects. The first object in the pair will be the
27439     * "before" object and the second will be the "after" object.
27440     *
27441     * @see elm_transit_effect_add()
27442     *
27443     * @param transit Transit object.
27444     * @return Fade effect context data.
27445     *
27446     * @ingroup Transit
27447     * @warning It is highly recommended just create a transit with this effect when
27448     * the window that the objects of the transit belongs has already been created.
27449     * This is because this effect needs the color information about the objects,
27450     * and if the window was not created yet, it can get a wrong information.
27451     */
27452    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27453
27454    /**
27455     * Add the Blend Effect to Elm_Transit.
27456     *
27457     * @note This API is one of the facades. It creates blend effect context
27458     * and add it's required APIs to elm_transit_effect_add.
27459     * @note This effect is applied to each pair of objects in the order they are listed
27460     * in the transit list of objects. The first object in the pair will be the
27461     * "before" object and the second will be the "after" object.
27462     *
27463     * @see elm_transit_effect_add()
27464     *
27465     * @param transit Transit object.
27466     * @return Blend effect context data.
27467     *
27468     * @ingroup Transit
27469     * @warning It is highly recommended just create a transit with this effect when
27470     * the window that the objects of the transit belongs has already been created.
27471     * This is because this effect needs the color information about the objects,
27472     * and if the window was not created yet, it can get a wrong information.
27473     */
27474    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27475
27476    /**
27477     * Add the Rotation Effect to Elm_Transit.
27478     *
27479     * @note This API is one of the facades. It creates rotation effect context
27480     * and add it's required APIs to elm_transit_effect_add.
27481     *
27482     * @see elm_transit_effect_add()
27483     *
27484     * @param transit Transit object.
27485     * @param from_degree Degree when effect begins.
27486     * @param to_degree Degree when effect is ends.
27487     * @return Rotation effect context data.
27488     *
27489     * @ingroup Transit
27490     * @warning It is highly recommended just create a transit with this effect when
27491     * the window that the objects of the transit belongs has already been created.
27492     * This is because this effect needs the geometry information about the objects,
27493     * and if the window was not created yet, it can get a wrong information.
27494     */
27495    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27496
27497    /**
27498     * Add the ImageAnimation Effect to Elm_Transit.
27499     *
27500     * @note This API is one of the facades. It creates image animation effect context
27501     * and add it's required APIs to elm_transit_effect_add.
27502     * The @p images parameter is a list images paths. This list and
27503     * its contents will be deleted at the end of the effect by
27504     * elm_transit_effect_image_animation_context_free() function.
27505     *
27506     * Example:
27507     * @code
27508     * char buf[PATH_MAX];
27509     * Eina_List *images = NULL;
27510     * Elm_Transit *transi = elm_transit_add();
27511     *
27512     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27513     * images = eina_list_append(images, eina_stringshare_add(buf));
27514     *
27515     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27516     * images = eina_list_append(images, eina_stringshare_add(buf));
27517     * elm_transit_effect_image_animation_add(transi, images);
27518     *
27519     * @endcode
27520     *
27521     * @see elm_transit_effect_add()
27522     *
27523     * @param transit Transit object.
27524     * @param images Eina_List of images file paths. This list and
27525     * its contents will be deleted at the end of the effect by
27526     * elm_transit_effect_image_animation_context_free() function.
27527     * @return Image Animation effect context data.
27528     *
27529     * @ingroup Transit
27530     */
27531    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27532    /**
27533     * @}
27534     */
27535
27536    /* Store */
27537    typedef struct _Elm_Store                      Elm_Store;
27538    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
27539    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27540    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27541    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
27542    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27543    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27544    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27545    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27546    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27547    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27548    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27549    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27550
27551    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27552    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27553    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27554    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27555    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27556    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27557    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27558
27559    typedef enum
27560      {
27561         ELM_STORE_ITEM_MAPPING_NONE = 0,
27562         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27563         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27564         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27565         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27566         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27567         // can add more here as needed by common apps
27568         ELM_STORE_ITEM_MAPPING_LAST
27569      } Elm_Store_Item_Mapping_Type;
27570
27571    struct _Elm_Store_Item_Mapping_Icon
27572      {
27573         // FIXME: allow edje file icons
27574         int                   w, h;
27575         Elm_Icon_Lookup_Order lookup_order;
27576         Eina_Bool             standard_name : 1;
27577         Eina_Bool             no_scale : 1;
27578         Eina_Bool             smooth : 1;
27579         Eina_Bool             scale_up : 1;
27580         Eina_Bool             scale_down : 1;
27581      };
27582
27583    struct _Elm_Store_Item_Mapping_Empty
27584      {
27585         Eina_Bool             dummy;
27586      };
27587
27588    struct _Elm_Store_Item_Mapping_Photo
27589      {
27590         int                   size;
27591      };
27592
27593    struct _Elm_Store_Item_Mapping_Custom
27594      {
27595         Elm_Store_Item_Mapping_Cb func;
27596      };
27597
27598    struct _Elm_Store_Item_Mapping
27599      {
27600         Elm_Store_Item_Mapping_Type     type;
27601         const char                     *part;
27602         int                             offset;
27603         union
27604           {
27605              Elm_Store_Item_Mapping_Empty  empty;
27606              Elm_Store_Item_Mapping_Icon   icon;
27607              Elm_Store_Item_Mapping_Photo  photo;
27608              Elm_Store_Item_Mapping_Custom custom;
27609              // add more types here
27610           } details;
27611      };
27612
27613    struct _Elm_Store_Item_Info
27614      {
27615         int                           index;
27616         int                           item_type;
27617         int                           group_index;
27618         Eina_Bool                     rec_item;
27619         int                           pre_group_index;
27620
27621         Elm_Genlist_Item_Class       *item_class;
27622         const Elm_Store_Item_Mapping *mapping;
27623         void                         *data;
27624         char                         *sort_id;
27625      };
27626
27627    struct _Elm_Store_Item_Info_Filesystem
27628      {
27629         Elm_Store_Item_Info  base;
27630         char                *path;
27631      };
27632
27633 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27634 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27635
27636    EAPI Elm_Store              *elm_store_dbsystem_new(void);
27637    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27638    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27639    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27640    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27641    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27642    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27643    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27644    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27645    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27646    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27647    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27648    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27649    EAPI void                    elm_store_free(Elm_Store *st);
27650    EAPI Elm_Store              *elm_store_filesystem_new(void);
27651    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27652    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27653    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27654
27655    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27656
27657    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27658    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27659    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27660    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27661    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27662    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27663
27664    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27665    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27666    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27667    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27668    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27669    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27670    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27671
27672    /**
27673     * @defgroup SegmentControl SegmentControl
27674     * @ingroup Elementary
27675     *
27676     * @image html img/widget/segment_control/preview-00.png
27677     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27678     *
27679     * @image html img/segment_control.png
27680     * @image latex img/segment_control.eps width=\textwidth
27681     *
27682     * Segment control widget is a horizontal control made of multiple segment
27683     * items, each segment item functioning similar to discrete two state button.
27684     * A segment control groups the items together and provides compact
27685     * single button with multiple equal size segments.
27686     *
27687     * Segment item size is determined by base widget
27688     * size and the number of items added.
27689     * Only one segment item can be at selected state. A segment item can display
27690     * combination of Text and any Evas_Object like Images or other widget.
27691     *
27692     * Smart callbacks one can listen to:
27693     * - "changed" - When the user clicks on a segment item which is not
27694     *   previously selected and get selected. The event_info parameter is the
27695     *   segment item pointer.
27696     *
27697     * Available styles for it:
27698     * - @c "default"
27699     *
27700     * Here is an example on its usage:
27701     * @li @ref segment_control_example
27702     */
27703
27704    /**
27705     * @addtogroup SegmentControl
27706     * @{
27707     */
27708
27709    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27710
27711    /**
27712     * Add a new segment control widget to the given parent Elementary
27713     * (container) object.
27714     *
27715     * @param parent The parent object.
27716     * @return a new segment control widget handle or @c NULL, on errors.
27717     *
27718     * This function inserts a new segment control widget on the canvas.
27719     *
27720     * @ingroup SegmentControl
27721     */
27722    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27723
27724    /**
27725     * Append a new item to the segment control object.
27726     *
27727     * @param obj The segment control object.
27728     * @param icon The icon object to use for the left side of the item. An
27729     * icon can be any Evas object, but usually it is an icon created
27730     * with elm_icon_add().
27731     * @param label The label of the item.
27732     *        Note that, NULL is different from empty string "".
27733     * @return The created item or @c NULL upon failure.
27734     *
27735     * A new item will be created and appended to the segment control, i.e., will
27736     * be set as @b last item.
27737     *
27738     * If it should be inserted at another position,
27739     * elm_segment_control_item_insert_at() should be used instead.
27740     *
27741     * Items created with this function can be deleted with function
27742     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27743     *
27744     * @note @p label set to @c NULL is different from empty string "".
27745     * If an item
27746     * only has icon, it will be displayed bigger and centered. If it has
27747     * icon and label, even that an empty string, icon will be smaller and
27748     * positioned at left.
27749     *
27750     * Simple example:
27751     * @code
27752     * sc = elm_segment_control_add(win);
27753     * ic = elm_icon_add(win);
27754     * elm_icon_file_set(ic, "path/to/image", NULL);
27755     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27756     * elm_segment_control_item_add(sc, ic, "label");
27757     * evas_object_show(sc);
27758     * @endcode
27759     *
27760     * @see elm_segment_control_item_insert_at()
27761     * @see elm_segment_control_item_del()
27762     *
27763     * @ingroup SegmentControl
27764     */
27765    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27766
27767    /**
27768     * Insert a new item to the segment control object at specified position.
27769     *
27770     * @param obj The segment control object.
27771     * @param icon The icon object to use for the left side of the item. An
27772     * icon can be any Evas object, but usually it is an icon created
27773     * with elm_icon_add().
27774     * @param label The label of the item.
27775     * @param index Item position. Value should be between 0 and items count.
27776     * @return The created item or @c NULL upon failure.
27777
27778     * Index values must be between @c 0, when item will be prepended to
27779     * segment control, and items count, that can be get with
27780     * elm_segment_control_item_count_get(), case when item will be appended
27781     * to segment control, just like elm_segment_control_item_add().
27782     *
27783     * Items created with this function can be deleted with function
27784     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27785     *
27786     * @note @p label set to @c NULL is different from empty string "".
27787     * If an item
27788     * only has icon, it will be displayed bigger and centered. If it has
27789     * icon and label, even that an empty string, icon will be smaller and
27790     * positioned at left.
27791     *
27792     * @see elm_segment_control_item_add()
27793     * @see elm_segment_control_item_count_get()
27794     * @see elm_segment_control_item_del()
27795     *
27796     * @ingroup SegmentControl
27797     */
27798    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);
27799
27800    /**
27801     * Remove a segment control item from its parent, deleting it.
27802     *
27803     * @param it The item to be removed.
27804     *
27805     * Items can be added with elm_segment_control_item_add() or
27806     * elm_segment_control_item_insert_at().
27807     *
27808     * @ingroup SegmentControl
27809     */
27810    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27811
27812    /**
27813     * Remove a segment control item at given index from its parent,
27814     * deleting it.
27815     *
27816     * @param obj The segment control object.
27817     * @param index The position of the segment control item to be deleted.
27818     *
27819     * Items can be added with elm_segment_control_item_add() or
27820     * elm_segment_control_item_insert_at().
27821     *
27822     * @ingroup SegmentControl
27823     */
27824    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27825
27826    /**
27827     * Get the Segment items count from segment control.
27828     *
27829     * @param obj The segment control object.
27830     * @return Segment items count.
27831     *
27832     * It will just return the number of items added to segment control @p obj.
27833     *
27834     * @ingroup SegmentControl
27835     */
27836    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27837
27838    /**
27839     * Get the item placed at specified index.
27840     *
27841     * @param obj The segment control object.
27842     * @param index The index of the segment item.
27843     * @return The segment control item or @c NULL on failure.
27844     *
27845     * Index is the position of an item in segment control widget. Its
27846     * range is from @c 0 to <tt> count - 1 </tt>.
27847     * Count is the number of items, that can be get with
27848     * elm_segment_control_item_count_get().
27849     *
27850     * @ingroup SegmentControl
27851     */
27852    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27853
27854    /**
27855     * Get the label of item.
27856     *
27857     * @param obj The segment control object.
27858     * @param index The index of the segment item.
27859     * @return The label of the item at @p index.
27860     *
27861     * The return value is a pointer to the label associated to the item when
27862     * it was created, with function elm_segment_control_item_add(), or later
27863     * with function elm_segment_control_item_label_set. If no label
27864     * was passed as argument, it will return @c NULL.
27865     *
27866     * @see elm_segment_control_item_label_set() for more details.
27867     * @see elm_segment_control_item_add()
27868     *
27869     * @ingroup SegmentControl
27870     */
27871    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27872
27873    /**
27874     * Set the label of item.
27875     *
27876     * @param it The item of segment control.
27877     * @param text The label of item.
27878     *
27879     * The label to be displayed by the item.
27880     * Label will be at right of the icon (if set).
27881     *
27882     * If a label was passed as argument on item creation, with function
27883     * elm_control_segment_item_add(), it will be already
27884     * displayed by the item.
27885     *
27886     * @see elm_segment_control_item_label_get()
27887     * @see elm_segment_control_item_add()
27888     *
27889     * @ingroup SegmentControl
27890     */
27891    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27892
27893    /**
27894     * Get the icon associated to the item.
27895     *
27896     * @param obj The segment control object.
27897     * @param index The index of the segment item.
27898     * @return The left side icon associated to the item at @p index.
27899     *
27900     * The return value is a pointer to the icon associated to the item when
27901     * it was created, with function elm_segment_control_item_add(), or later
27902     * with function elm_segment_control_item_icon_set(). If no icon
27903     * was passed as argument, it will return @c NULL.
27904     *
27905     * @see elm_segment_control_item_add()
27906     * @see elm_segment_control_item_icon_set()
27907     *
27908     * @ingroup SegmentControl
27909     */
27910    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27911
27912    /**
27913     * Set the icon associated to the item.
27914     *
27915     * @param it The segment control item.
27916     * @param icon The icon object to associate with @p it.
27917     *
27918     * The icon object to use at left side of the item. An
27919     * icon can be any Evas object, but usually it is an icon created
27920     * with elm_icon_add().
27921     *
27922     * Once the icon object is set, a previously set one will be deleted.
27923     * @warning Setting the same icon for two items will cause the icon to
27924     * dissapear from the first item.
27925     *
27926     * If an icon was passed as argument on item creation, with function
27927     * elm_segment_control_item_add(), it will be already
27928     * associated to the item.
27929     *
27930     * @see elm_segment_control_item_add()
27931     * @see elm_segment_control_item_icon_get()
27932     *
27933     * @ingroup SegmentControl
27934     */
27935    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27936
27937    /**
27938     * Get the index of an item.
27939     *
27940     * @param it The segment control item.
27941     * @return The position of item in segment control widget.
27942     *
27943     * Index is the position of an item in segment control widget. Its
27944     * range is from @c 0 to <tt> count - 1 </tt>.
27945     * Count is the number of items, that can be get with
27946     * elm_segment_control_item_count_get().
27947     *
27948     * @ingroup SegmentControl
27949     */
27950    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27951
27952    /**
27953     * Get the base object of the item.
27954     *
27955     * @param it The segment control item.
27956     * @return The base object associated with @p it.
27957     *
27958     * Base object is the @c Evas_Object that represents that item.
27959     *
27960     * @ingroup SegmentControl
27961     */
27962    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27963
27964    /**
27965     * Get the selected item.
27966     *
27967     * @param obj The segment control object.
27968     * @return The selected item or @c NULL if none of segment items is
27969     * selected.
27970     *
27971     * The selected item can be unselected with function
27972     * elm_segment_control_item_selected_set().
27973     *
27974     * The selected item always will be highlighted on segment control.
27975     *
27976     * @ingroup SegmentControl
27977     */
27978    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27979
27980    /**
27981     * Set the selected state of an item.
27982     *
27983     * @param it The segment control item
27984     * @param select The selected state
27985     *
27986     * This sets the selected state of the given item @p it.
27987     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27988     *
27989     * If a new item is selected the previosly selected will be unselected.
27990     * Previoulsy selected item can be get with function
27991     * elm_segment_control_item_selected_get().
27992     *
27993     * The selected item always will be highlighted on segment control.
27994     *
27995     * @see elm_segment_control_item_selected_get()
27996     *
27997     * @ingroup SegmentControl
27998     */
27999    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28000
28001    /**
28002     * @}
28003     */
28004
28005    /**
28006     * @defgroup Grid Grid
28007     *
28008     * The grid is a grid layout widget that lays out a series of children as a
28009     * fixed "grid" of widgets using a given percentage of the grid width and
28010     * height each using the child object.
28011     *
28012     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28013     * widgets size itself. The default is 100 x 100, so that means the
28014     * position and sizes of children will effectively be percentages (0 to 100)
28015     * of the width or height of the grid widget
28016     *
28017     * @{
28018     */
28019
28020    /**
28021     * Add a new grid to the parent
28022     *
28023     * @param parent The parent object
28024     * @return The new object or NULL if it cannot be created
28025     *
28026     * @ingroup Grid
28027     */
28028    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28029
28030    /**
28031     * Set the virtual size of the grid
28032     *
28033     * @param obj The grid object
28034     * @param w The virtual width of the grid
28035     * @param h The virtual height of the grid
28036     *
28037     * @ingroup Grid
28038     */
28039    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28040
28041    /**
28042     * Get the virtual size of the grid
28043     *
28044     * @param obj The grid object
28045     * @param w Pointer to integer to store the virtual width of the grid
28046     * @param h Pointer to integer to store the virtual height of the grid
28047     *
28048     * @ingroup Grid
28049     */
28050    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28051
28052    /**
28053     * Pack child at given position and size
28054     *
28055     * @param obj The grid object
28056     * @param subobj The child to pack
28057     * @param x The virtual x coord at which to pack it
28058     * @param y The virtual y coord at which to pack it
28059     * @param w The virtual width at which to pack it
28060     * @param h The virtual height at which to pack it
28061     *
28062     * @ingroup Grid
28063     */
28064    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28065
28066    /**
28067     * Unpack a child from a grid object
28068     *
28069     * @param obj The grid object
28070     * @param subobj The child to unpack
28071     *
28072     * @ingroup Grid
28073     */
28074    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28075
28076    /**
28077     * Faster way to remove all child objects from a grid object.
28078     *
28079     * @param obj The grid object
28080     * @param clear If true, it will delete just removed children
28081     *
28082     * @ingroup Grid
28083     */
28084    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28085
28086    /**
28087     * Set packing of an existing child at to position and size
28088     *
28089     * @param subobj The child to set packing of
28090     * @param x The virtual x coord at which to pack it
28091     * @param y The virtual y coord at which to pack it
28092     * @param w The virtual width at which to pack it
28093     * @param h The virtual height at which to pack it
28094     *
28095     * @ingroup Grid
28096     */
28097    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28098
28099    /**
28100     * get packing of a child
28101     *
28102     * @param subobj The child to query
28103     * @param x Pointer to integer to store the virtual x coord
28104     * @param y Pointer to integer to store the virtual y coord
28105     * @param w Pointer to integer to store the virtual width
28106     * @param h Pointer to integer to store the virtual height
28107     *
28108     * @ingroup Grid
28109     */
28110    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28111
28112    /**
28113     * @}
28114     */
28115
28116    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28117    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28118    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28119    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28120    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28121    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28122
28123    /**
28124     * @defgroup Video Video
28125     *
28126     * @addtogroup Video
28127     * @{
28128     *
28129     * Elementary comes with two object that help design application that need
28130     * to display video. The main one, Elm_Video, display a video by using Emotion.
28131     * It does embedded the video inside an Edje object, so you can do some
28132     * animation depending on the video state change. It does also implement a
28133     * ressource management policy to remove this burden from the application writer.
28134     *
28135     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28136     * It take care of updating its content according to Emotion event and provide a
28137     * way to theme itself. It also does automatically raise the priority of the
28138     * linked Elm_Video so it will use the video decoder if available. It also does
28139     * activate the remember function on the linked Elm_Video object.
28140     *
28141     * Signals that you can add callback for are :
28142     *
28143     * "forward,clicked" - the user clicked the forward button.
28144     * "info,clicked" - the user clicked the info button.
28145     * "next,clicked" - the user clicked the next button.
28146     * "pause,clicked" - the user clicked the pause button.
28147     * "play,clicked" - the user clicked the play button.
28148     * "prev,clicked" - the user clicked the prev button.
28149     * "rewind,clicked" - the user clicked the rewind button.
28150     * "stop,clicked" - the user clicked the stop button.
28151     * 
28152     * Default contents parts of the player widget that you can use for are:
28153     * @li "video" - A video of the player
28154     * 
28155     */
28156
28157    /**
28158     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28159     *
28160     * @param parent The parent object
28161     * @return a new player widget handle or @c NULL, on errors.
28162     *
28163     * This function inserts a new player widget on the canvas.
28164     *
28165     * @see elm_object_part_content_set()
28166     *
28167     * @ingroup Video
28168     */
28169    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28170
28171    /**
28172     * @brief Link a Elm_Payer with an Elm_Video object.
28173     *
28174     * @param player the Elm_Player object.
28175     * @param video The Elm_Video object.
28176     *
28177     * This mean that action on the player widget will affect the
28178     * video object and the state of the video will be reflected in
28179     * the player itself.
28180     *
28181     * @see elm_player_add()
28182     * @see elm_video_add()
28183     * @deprecated use elm_object_part_content_set() instead
28184     *
28185     * @ingroup Video
28186     */
28187    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28188
28189    /**
28190     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28191     *
28192     * @param parent The parent object
28193     * @return a new video widget handle or @c NULL, on errors.
28194     *
28195     * This function inserts a new video widget on the canvas.
28196     *
28197     * @seeelm_video_file_set()
28198     * @see elm_video_uri_set()
28199     *
28200     * @ingroup Video
28201     */
28202    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28203
28204    /**
28205     * @brief Define the file that will be the video source.
28206     *
28207     * @param video The video object to define the file for.
28208     * @param filename The file to target.
28209     *
28210     * This function will explicitly define a filename as a source
28211     * for the video of the Elm_Video object.
28212     *
28213     * @see elm_video_uri_set()
28214     * @see elm_video_add()
28215     * @see elm_player_add()
28216     *
28217     * @ingroup Video
28218     */
28219    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28220
28221    /**
28222     * @brief Define the uri that will be the video source.
28223     *
28224     * @param video The video object to define the file for.
28225     * @param uri The uri to target.
28226     *
28227     * This function will define an uri as a source for the video of the
28228     * Elm_Video object. URI could be remote source of video, like http:// or local source
28229     * like for example WebCam who are most of the time v4l2:// (but that depend and
28230     * you should use Emotion API to request and list the available Webcam on your system).
28231     *
28232     * @see elm_video_file_set()
28233     * @see elm_video_add()
28234     * @see elm_player_add()
28235     *
28236     * @ingroup Video
28237     */
28238    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28239
28240    /**
28241     * @brief Get the underlying Emotion object.
28242     *
28243     * @param video The video object to proceed the request on.
28244     * @return the underlying Emotion object.
28245     *
28246     * @ingroup Video
28247     */
28248    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28249
28250    /**
28251     * @brief Start to play the video
28252     *
28253     * @param video The video object to proceed the request on.
28254     *
28255     * Start to play the video and cancel all suspend state.
28256     *
28257     * @ingroup Video
28258     */
28259    EAPI void elm_video_play(Evas_Object *video);
28260
28261    /**
28262     * @brief Pause the video
28263     *
28264     * @param video The video object to proceed the request on.
28265     *
28266     * Pause the video and start a timer to trigger suspend mode.
28267     *
28268     * @ingroup Video
28269     */
28270    EAPI void elm_video_pause(Evas_Object *video);
28271
28272    /**
28273     * @brief Stop the video
28274     *
28275     * @param video The video object to proceed the request on.
28276     *
28277     * Stop the video and put the emotion in deep sleep mode.
28278     *
28279     * @ingroup Video
28280     */
28281    EAPI void elm_video_stop(Evas_Object *video);
28282
28283    /**
28284     * @brief Is the video actually playing.
28285     *
28286     * @param video The video object to proceed the request on.
28287     * @return EINA_TRUE if the video is actually playing.
28288     *
28289     * You should consider watching event on the object instead of polling
28290     * the object state.
28291     *
28292     * @ingroup Video
28293     */
28294    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28295
28296    /**
28297     * @brief Is it possible to seek inside the video.
28298     *
28299     * @param video The video object to proceed the request on.
28300     * @return EINA_TRUE if is possible to seek inside the video.
28301     *
28302     * @ingroup Video
28303     */
28304    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28305
28306    /**
28307     * @brief Is the audio muted.
28308     *
28309     * @param video The video object to proceed the request on.
28310     * @return EINA_TRUE if the audio is muted.
28311     *
28312     * @ingroup Video
28313     */
28314    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28315
28316    /**
28317     * @brief Change the mute state of the Elm_Video object.
28318     *
28319     * @param video The video object to proceed the request on.
28320     * @param mute The new mute state.
28321     *
28322     * @ingroup Video
28323     */
28324    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28325
28326    /**
28327     * @brief Get the audio level of the current video.
28328     *
28329     * @param video The video object to proceed the request on.
28330     * @return the current audio level.
28331     *
28332     * @ingroup Video
28333     */
28334    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28335
28336    /**
28337     * @brief Set the audio level of anElm_Video object.
28338     *
28339     * @param video The video object to proceed the request on.
28340     * @param volume The new audio volume.
28341     *
28342     * @ingroup Video
28343     */
28344    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28345
28346    EAPI double elm_video_play_position_get(const Evas_Object *video);
28347    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28348    EAPI double elm_video_play_length_get(const Evas_Object *video);
28349    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28350    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28351    EAPI const char *elm_video_title_get(const Evas_Object *video);
28352    /**
28353     * @}
28354     */
28355
28356    // FIXME: incomplete - carousel. don't use this until this comment is removed
28357    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28358    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
28359    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28360    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
28361    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
28362    /* smart callbacks called:
28363     * "clicked" - when the user clicks on a carousel item and becomes selected
28364     */
28365
28366    /* datefield */
28367
28368    typedef enum _Elm_Datefield_ItemType
28369      {
28370         ELM_DATEFIELD_YEAR = 0,
28371         ELM_DATEFIELD_MONTH,
28372         ELM_DATEFIELD_DATE,
28373         ELM_DATEFIELD_HOUR,
28374         ELM_DATEFIELD_MINUTE,
28375         ELM_DATEFIELD_AMPM
28376      } Elm_Datefield_ItemType;
28377
28378    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28379    EAPI void         elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28380    EAPI char        *elm_datefield_format_get(const Evas_Object *obj);
28381    EAPI void         elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28382    EAPI Eina_Bool    elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28383    EAPI void         elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28384    EAPI int          elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28385    EAPI void         elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28386    EAPI int          elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28387    EAPI Eina_Bool    elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28388    EAPI void         elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28389    EAPI int          elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28390    EAPI Eina_Bool    elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28391  
28392    /* smart callbacks called:
28393    * "changed" - when datefield value is changed, this signal is sent.
28394    */
28395
28396 ////////////////////// DEPRECATED ///////////////////////////////////
28397
28398    typedef enum _Elm_Datefield_Layout
28399      {
28400         ELM_DATEFIELD_LAYOUT_TIME,
28401         ELM_DATEFIELD_LAYOUT_DATE,
28402         ELM_DATEFIELD_LAYOUT_DATEANDTIME
28403      } Elm_Datefield_Layout;
28404
28405    EINA_DEPRECATED EAPI void         elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28406    EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28407    EINA_DEPRECATED EAPI void         elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28408    EINA_DEPRECATED EAPI const char  *elm_datefield_date_format_get(const Evas_Object *obj);
28409    EINA_DEPRECATED EAPI void         elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28410    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_time_mode_get(const Evas_Object *obj);
28411    EINA_DEPRECATED EAPI void         elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28412    EINA_DEPRECATED EAPI void         elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28413    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28414    EINA_DEPRECATED EAPI void         elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28415    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28416    EINA_DEPRECATED EAPI void         elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28417    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
28418    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28419 /////////////////////////////////////////////////////////////////////
28420
28421    /* popup */
28422    typedef enum _Elm_Popup_Response
28423      {
28424         ELM_POPUP_RESPONSE_NONE = -1,
28425         ELM_POPUP_RESPONSE_TIMEOUT = -2,
28426         ELM_POPUP_RESPONSE_OK = -3,
28427         ELM_POPUP_RESPONSE_CANCEL = -4,
28428         ELM_POPUP_RESPONSE_CLOSE = -5
28429      } Elm_Popup_Response;
28430
28431    typedef enum _Elm_Popup_Mode
28432      {
28433         ELM_POPUP_TYPE_NONE = 0,
28434         ELM_POPUP_TYPE_ALERT = (1 << 0)
28435      } Elm_Popup_Mode;
28436
28437    typedef enum _Elm_Popup_Orient
28438      {
28439         ELM_POPUP_ORIENT_TOP,
28440         ELM_POPUP_ORIENT_CENTER,
28441         ELM_POPUP_ORIENT_BOTTOM,
28442         ELM_POPUP_ORIENT_LEFT,
28443         ELM_POPUP_ORIENT_RIGHT,
28444         ELM_POPUP_ORIENT_TOP_LEFT,
28445         ELM_POPUP_ORIENT_TOP_RIGHT,
28446         ELM_POPUP_ORIENT_BOTTOM_LEFT,
28447         ELM_POPUP_ORIENT_BOTTOM_RIGHT
28448      } Elm_Popup_Orient;
28449
28450    /* smart callbacks called:
28451     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28452     */
28453
28454    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28455    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
28456    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
28457    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
28458    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
28459    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28460    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28461    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28462    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28463    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
28464    EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
28465    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
28466    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28467    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
28468    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28469    EAPI int          elm_popup_run(Evas_Object *obj);
28470
28471    /* NavigationBar */
28472    #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28473    #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28474
28475    typedef enum
28476      {
28477         ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28478         ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28479         ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28480         ELM_NAVIGATIONBAR_BACK_BUTTON
28481      } Elm_Navi_Button_Type;
28482
28483    EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28484    EINA_DEPRECATED    EAPI void         elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
28485    EINA_DEPRECATED    EAPI void         elm_navigationbar_pop(Evas_Object *obj);
28486    EINA_DEPRECATED    EAPI void         elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28487    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28488    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28489    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28490    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28491    EINA_DEPRECATED    EAPI Eina_List   *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28492    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28493    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28494    EINA_DEPRECATED    EAPI void         elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28495    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28496    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28497    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28498    EINA_DEPRECATED    EAPI void         elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28499    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28500    EINA_DEPRECATED    EAPI void         elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28501    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28502    EINA_DEPRECATED    Eina_Bool         elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28503    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28504    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28505
28506    /* NavigationBar */
28507    #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28508    #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28509
28510    typedef enum
28511      {
28512         ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28513         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28514         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28515         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28516         ELM_NAVIGATIONBAR_EX_MAX
28517      } Elm_Navi_ex_Button_Type;
28518    typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28519
28520    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28521    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28522    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_pop(Evas_Object *obj);
28523    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28524    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28525    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28526    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28527    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28528    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28529    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
28530    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28531    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28532    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28533    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28534    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28535    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28536    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28537    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28538    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28539    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28540    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28541    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28542    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28543    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28544    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28545    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28546    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28547    EINA_DEPRECATED    Eina_Bool         elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28548
28549    /**
28550     * @defgroup Naviframe Naviframe
28551     * @ingroup Elementary
28552     *
28553     * @brief Naviframe is a kind of view manager for the applications.
28554     *
28555     * Naviframe provides functions to switch different pages with stack
28556     * mechanism. It means if one page(item) needs to be changed to the new one,
28557     * then naviframe would push the new page to it's internal stack. Of course,
28558     * it can be back to the previous page by popping the top page. Naviframe
28559     * provides some transition effect while the pages are switching (same as
28560     * pager).
28561     *
28562     * Since each item could keep the different styles, users could keep the
28563     * same look & feel for the pages or different styles for the items in it's
28564     * application.
28565     *
28566     * Signals that you can add callback for are:
28567     * @li "transition,finished" - When the transition is finished in changing
28568     *     the item
28569     * @li "title,clicked" - User clicked title area
28570     *
28571     * Default contents parts of the naviframe items that you can use for are:
28572     * @li "default" - A main content of the page
28573     * @li "icon" - A icon in the title area
28574     * @li "prev_btn" - A button to go to the previous page
28575     * @li "next_btn" - A button to go to the next page
28576     *
28577     * Default text parts of the naviframe items that you can use for are:
28578     * @li "default" - Title label in the title area
28579     * @li "subtitle" - Sub-title label in the title area
28580     *
28581     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28582     */
28583
28584   //Available commonly
28585   #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28586   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28587   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28588   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28589   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28590   #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28591   #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28592   #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28593   #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28594   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28595   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28596   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28597   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28598   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28599   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28600   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28601   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28602
28603    //Available only in a style - "2line"
28604   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28605
28606   //Available only in a style - "segment"
28607   #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28608   #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28609
28610    /**
28611     * @addtogroup Naviframe
28612     * @{
28613     */
28614
28615    /**
28616     * @brief Add a new Naviframe object to the parent.
28617     *
28618     * @param parent Parent object
28619     * @return New object or @c NULL, if it cannot be created
28620     *
28621     * @ingroup Naviframe
28622     */
28623    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28624    /**
28625     * @brief Push a new item to the top of the naviframe stack (and show it).
28626     *
28627     * @param obj The naviframe object
28628     * @param title_label The label in the title area. The name of the title
28629     *        label part is "elm.text.title"
28630     * @param prev_btn The button to go to the previous item. If it is NULL,
28631     *        then naviframe will create a back button automatically. The name of
28632     *        the prev_btn part is "elm.swallow.prev_btn"
28633     * @param next_btn The button to go to the next item. Or It could be just an
28634     *        extra function button. The name of the next_btn part is
28635     *        "elm.swallow.next_btn"
28636     * @param content The main content object. The name of content part is
28637     *        "elm.swallow.content"
28638     * @param item_style The current item style name. @c NULL would be default.
28639     * @return The created item or @c NULL upon failure.
28640     *
28641     * The item pushed becomes one page of the naviframe, this item will be
28642     * deleted when it is popped.
28643     *
28644     * @see also elm_naviframe_item_style_set()
28645     * @see also elm_naviframe_item_insert_before()
28646     * @see also elm_naviframe_item_insert_after()
28647     *
28648     * The following styles are available for this item:
28649     * @li @c "default"
28650     *
28651     * @ingroup Naviframe
28652     */
28653    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);
28654     /**
28655     * @brief Insert a new item into the naviframe before item @p before.
28656     *
28657     * @param before The naviframe item to insert before.
28658     * @param title_label The label in the title area. The name of the title
28659     *        label part is "elm.text.title"
28660     * @param prev_btn The button to go to the previous item. If it is NULL,
28661     *        then naviframe will create a back button automatically. The name of
28662     *        the prev_btn part is "elm.swallow.prev_btn"
28663     * @param next_btn The button to go to the next item. Or It could be just an
28664     *        extra function button. The name of the next_btn part is
28665     *        "elm.swallow.next_btn"
28666     * @param content The main content object. The name of content part is
28667     *        "elm.swallow.content"
28668     * @param item_style The current item style name. @c NULL would be default.
28669     * @return The created item or @c NULL upon failure.
28670     *
28671     * The item is inserted into the naviframe straight away without any
28672     * transition operations. This item will be deleted when it is popped.
28673     *
28674     * @see also elm_naviframe_item_style_set()
28675     * @see also elm_naviframe_item_push()
28676     * @see also elm_naviframe_item_insert_after()
28677     *
28678     * The following styles are available for this item:
28679     * @li @c "default"
28680     *
28681     * @ingroup Naviframe
28682     */
28683    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);
28684    /**
28685     * @brief Insert a new item into the naviframe after item @p after.
28686     *
28687     * @param after The naviframe item to insert after.
28688     * @param title_label The label in the title area. The name of the title
28689     *        label part is "elm.text.title"
28690     * @param prev_btn The button to go to the previous item. If it is NULL,
28691     *        then naviframe will create a back button automatically. The name of
28692     *        the prev_btn part is "elm.swallow.prev_btn"
28693     * @param next_btn The button to go to the next item. Or It could be just an
28694     *        extra function button. The name of the next_btn part is
28695     *        "elm.swallow.next_btn"
28696     * @param content The main content object. The name of content part is
28697     *        "elm.swallow.content"
28698     * @param item_style The current item style name. @c NULL would be default.
28699     * @return The created item or @c NULL upon failure.
28700     *
28701     * The item is inserted into the naviframe straight away without any
28702     * transition operations. This item will be deleted when it is popped.
28703     *
28704     * @see also elm_naviframe_item_style_set()
28705     * @see also elm_naviframe_item_push()
28706     * @see also elm_naviframe_item_insert_before()
28707     *
28708     * The following styles are available for this item:
28709     * @li @c "default"
28710     *
28711     * @ingroup Naviframe
28712     */
28713    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);
28714    /**
28715     * @brief Pop an item that is on top of the stack
28716     *
28717     * @param obj The naviframe object
28718     * @return @c NULL or the content object(if the
28719     *         elm_naviframe_content_preserve_on_pop_get is true).
28720     *
28721     * This pops an item that is on the top(visible) of the naviframe, makes it
28722     * disappear, then deletes the item. The item that was underneath it on the
28723     * stack will become visible.
28724     *
28725     * @see also elm_naviframe_content_preserve_on_pop_get()
28726     *
28727     * @ingroup Naviframe
28728     */
28729    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28730    /**
28731     * @brief Pop the items between the top and the above one on the given item.
28732     *
28733     * @param it The naviframe item
28734     *
28735     * @ingroup Naviframe
28736     */
28737    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28738    /**
28739    * Promote an item already in the naviframe stack to the top of the stack
28740    *
28741    * @param it The naviframe item
28742    *
28743    * This will take the indicated item and promote it to the top of the stack
28744    * as if it had been pushed there. The item must already be inside the
28745    * naviframe stack to work.
28746    *
28747    */
28748    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28749    /**
28750     * @brief Delete the given item instantly.
28751     *
28752     * @param it The naviframe item
28753     *
28754     * This just deletes the given item from the naviframe item list instantly.
28755     * So this would not emit any signals for view transitions but just change
28756     * the current view if the given item is a top one.
28757     *
28758     * @ingroup Naviframe
28759     */
28760    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28761    /**
28762     * @brief preserve the content objects when items are popped.
28763     *
28764     * @param obj The naviframe object
28765     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28766     *
28767     * @see also elm_naviframe_content_preserve_on_pop_get()
28768     *
28769     * @ingroup Naviframe
28770     */
28771    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28772    /**
28773     * @brief Get a value whether preserve mode is enabled or not.
28774     *
28775     * @param obj The naviframe object
28776     * @return If @c EINA_TRUE, preserve mode is enabled
28777     *
28778     * @see also elm_naviframe_content_preserve_on_pop_set()
28779     *
28780     * @ingroup Naviframe
28781     */
28782    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28783    /**
28784     * @brief Get a top item on the naviframe stack
28785     *
28786     * @param obj The naviframe object
28787     * @return The top item on the naviframe stack or @c NULL, if the stack is
28788     *         empty
28789     *
28790     * @ingroup Naviframe
28791     */
28792    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28793    /**
28794     * @brief Get a bottom item on the naviframe stack
28795     *
28796     * @param obj The naviframe object
28797     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28798     *         empty
28799     *
28800     * @ingroup Naviframe
28801     */
28802    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28803    /**
28804     * @brief Set an item style
28805     *
28806     * @param obj The naviframe item
28807     * @param item_style The current item style name. @c NULL would be default
28808     *
28809     * The following styles are available for this item:
28810     * @li @c "default"
28811     *
28812     * @see also elm_naviframe_item_style_get()
28813     *
28814     * @ingroup Naviframe
28815     */
28816    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28817    /**
28818     * @brief Get an item style
28819     *
28820     * @param obj The naviframe item
28821     * @return The current item style name
28822     *
28823     * @see also elm_naviframe_item_style_set()
28824     *
28825     * @ingroup Naviframe
28826     */
28827    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28828    /**
28829     * @brief Show/Hide the title area
28830     *
28831     * @param it The naviframe item
28832     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28833     *        otherwise
28834     *
28835     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28836     *
28837     * @see also elm_naviframe_item_title_visible_get()
28838     *
28839     * @ingroup Naviframe
28840     */
28841    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28842    /**
28843     * @brief Get a value whether title area is visible or not.
28844     *
28845     * @param it The naviframe item
28846     * @return If @c EINA_TRUE, title area is visible
28847     *
28848     * @see also elm_naviframe_item_title_visible_set()
28849     *
28850     * @ingroup Naviframe
28851     */
28852    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28853
28854    /**
28855     * @brief Set creating prev button automatically or not
28856     *
28857     * @param obj The naviframe object
28858     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28859     *        be created internally when you pass the @c NULL to the prev_btn
28860     *        parameter in elm_naviframe_item_push
28861     *
28862     * @see also elm_naviframe_item_push()
28863     */
28864    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28865    /**
28866     * @brief Get a value whether prev button(back button) will be auto pushed or
28867     *        not.
28868     *
28869     * @param obj The naviframe object
28870     * @return If @c EINA_TRUE, prev button will be auto pushed.
28871     *
28872     * @see also elm_naviframe_item_push()
28873     *           elm_naviframe_prev_btn_auto_pushed_set()
28874     */
28875    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28876    /**
28877     * @brief Get a list of all the naviframe items.
28878     *
28879     * @param obj The naviframe object
28880     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28881     * or @c NULL on failure.
28882     */
28883    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28884
28885    /**
28886     * @}
28887     */
28888
28889    /* Control Bar */
28890    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28891    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28892    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28893    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28894    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28895    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28896    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28897    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28898    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28899
28900    typedef enum _Elm_Controlbar_Mode_Type
28901      {
28902         ELM_CONTROLBAR_MODE_DEFAULT = 0,
28903         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28904         ELM_CONTROLBAR_MODE_TRANSPARENCY,
28905         ELM_CONTROLBAR_MODE_LARGE,
28906         ELM_CONTROLBAR_MODE_SMALL,
28907         ELM_CONTROLBAR_MODE_LEFT,
28908         ELM_CONTROLBAR_MODE_RIGHT
28909      } Elm_Controlbar_Mode_Type;
28910
28911    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28912    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28913    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28914    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28915    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
28916    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
28917    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28918    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28919    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28920    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28921    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28922    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28923    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28924    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28925    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28926    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
28927    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
28928    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28929    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28930    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28931    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28932    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28933    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28934    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28935    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28936    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28937    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28938    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28939    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
28940    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28941    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28942    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28943    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28944    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28945    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28946    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
28947    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28948    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28949    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28950
28951    /* SearchBar */
28952    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28953    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28954    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
28955    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28956    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28957    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28958    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28959    EAPI void         elm_searchbar_clear(Evas_Object *obj);
28960    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28961
28962    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28963    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28964    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28965    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28966
28967    /* NoContents */
28968    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28969    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
28970    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
28971    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28972    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28973
28974    /* TickerNoti */
28975    typedef enum
28976      {
28977         ELM_TICKERNOTI_ORIENT_TOP = 0,
28978         ELM_TICKERNOTI_ORIENT_BOTTOM,
28979         ELM_TICKERNOTI_ORIENT_LAST
28980      }  Elm_Tickernoti_Orient;
28981
28982    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
28983    EAPI void                      elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28984    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28985    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28986    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28987    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28988    /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28989    typedef enum
28990     {
28991        ELM_TICKERNOTI_DEFAULT,
28992        ELM_TICKERNOTI_DETAILVIEW
28993     } Elm_Tickernoti_Mode;
28994    EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28995    EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28996    EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28997    EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28998    EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28999    EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29000    EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29001    EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29002    EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29003    EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29004    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29005    EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29006    EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29007    EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29008    EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29009    EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29010    EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29011    /* ############################################################################### */
29012    /*
29013     * Parts which can be used with elm_object_text_part_set() and
29014     * elm_object_text_part_get():
29015     *
29016     * @li NULL/"default" - Operates on tickernoti content-text
29017     *
29018     * Parts which can be used with elm_object_content_part_set(),
29019     * elm_object_content_part_get() and elm_object_content_part_unset():
29020     *
29021     * @li "icon" - Operates on tickernoti's icon
29022     * @li "button" - Operates on tickernoti's button
29023     *
29024     * smart callbacks called:
29025     * @li "clicked" - emitted when tickernoti is clicked, except at the
29026     * swallow/button region, if any.
29027     * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29028     * any hide animation, this signal is emitted after the animation.
29029     */
29030
29031    /* colorpalette */
29032    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29033
29034    struct _Colorpalette_Color
29035      {
29036         unsigned int r, g, b;
29037      };
29038
29039    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29040    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29041    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29042    /* smart callbacks called:
29043     * "clicked" - when image clicked
29044     */
29045
29046    /* editfield */
29047    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29048    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
29049    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
29050    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29051    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
29052    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29053 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29054    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29055    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29056    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29057    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29058    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29059    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
29060    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29061    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
29062    /* smart callbacks called:
29063     * "clicked" - when an editfield is clicked
29064     * "unfocused" - when an editfield is unfocused
29065     */
29066
29067
29068    /* Sliding Drawer */
29069    typedef enum _Elm_SlidingDrawer_Pos
29070      {
29071         ELM_SLIDINGDRAWER_BOTTOM,
29072         ELM_SLIDINGDRAWER_LEFT,
29073         ELM_SLIDINGDRAWER_RIGHT,
29074         ELM_SLIDINGDRAWER_TOP
29075      } Elm_SlidingDrawer_Pos;
29076
29077    typedef struct _Elm_SlidingDrawer_Drag_Value
29078      {
29079         double x, y;
29080      } Elm_SlidingDrawer_Drag_Value;
29081
29082    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29083    EINA_DEPRECATED EAPI void         elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29084    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29085    EINA_DEPRECATED EAPI void         elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29086    EINA_DEPRECATED EAPI void         elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw,  double dh);
29087    EINA_DEPRECATED EAPI void         elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29088
29089    /* multibuttonentry */
29090    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29091    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29092    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
29093    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj);
29094    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29095    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29096    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29097    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29098    EAPI int                        elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29099    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29100    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29101    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29102    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29103    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29104    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj);
29105    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29106    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29107    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29108    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29109    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29110    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29111    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
29112    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29113    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29114    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29115    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29116    EAPI void                      *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29117    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29118    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29119    /* smart callback called:
29120     * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29121     * "added" - This signal is emitted when a new multibuttonentry item is added.
29122     * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29123     * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29124     * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29125     * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29126     * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29127     * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29128     * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29129     * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29130     * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29131     * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29132     */
29133    /* available styles:
29134     * default
29135     */
29136
29137    /* stackedicon */
29138    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29139    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
29140    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29141    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29142    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29143    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
29144    /* smart callback called:
29145     * "expanded" - This signal is emitted when a stackedicon is expanded.
29146     * "clicked" - This signal is emitted when a stackedicon is clicked.
29147     */
29148    /* available styles:
29149     * default
29150     */
29151
29152    /* dialoguegroup */
29153    typedef struct _Dialogue_Item Dialogue_Item;
29154
29155    typedef enum _Elm_Dialoguegourp_Item_Style
29156      {
29157         ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29158         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29159         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29160         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29161         ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29162         ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29163         ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29164         ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29165         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29166         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29167         ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29168      } Elm_Dialoguegroup_Item_Style;
29169
29170    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_add(Evas_Object *parent);
29171    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29172    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29173    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29174    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29175    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove(Dialogue_Item *item);
29176    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove_all(Evas_Object *obj);
29177    EINA_DEPRECATED EAPI void           elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29178    EINA_DEPRECATED EAPI const char    *elm_dialoguegroup_title_get(Evas_Object *obj);
29179    EINA_DEPRECATED EAPI void           elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29180    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29181    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29182    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29183    EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style    elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29184    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29185    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29186
29187    /* Dayselector */
29188    typedef enum
29189      {
29190         ELM_DAYSELECTOR_SUN,
29191         ELM_DAYSELECTOR_MON,
29192         ELM_DAYSELECTOR_TUE,
29193         ELM_DAYSELECTOR_WED,
29194         ELM_DAYSELECTOR_THU,
29195         ELM_DAYSELECTOR_FRI,
29196         ELM_DAYSELECTOR_SAT
29197      } Elm_DaySelector_Day;
29198
29199    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29200    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29201    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29202
29203    /* Image Slider */
29204    typedef struct _Imageslider_Item Elm_Imageslider_Item;
29205    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29206    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29207    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
29208    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
29209    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
29210    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29211    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29212    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29213    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29214    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29215    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29216    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29217    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29218    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29219    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29220    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29221 #ifdef __cplusplus
29222 }
29223 #endif
29224
29225 #endif