[elementary] Beefing up elm_object_event_callback_add().
[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.7.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 in which the widgets will be
33                           layouted.
34
35 @section license License
36
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
39
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
45 */
46
47
48 /**
49  * @defgroup Start Getting Started
50  *
51  * To write an Elementary app, you can get started with the following:
52  *
53 @code
54 #include <Elementary.h>
55 EAPI int
56 elm_main(int argc, char **argv)
57 {
58    // create window(s) here and do any application init
59    elm_run(); // run main loop
60    elm_shutdown(); // after mainloop finishes running, shutdown
61    return 0; // exit 0 for exit code
62 }
63 ELM_MAIN()
64 @endcode
65  *
66  * To use autotools (which helps in many ways in the long run, like being able
67  * to immediately create releases of your software directly from your tree
68  * and ensure everything needed to buiuld it is there) you will need a
69  * configure.ac, Makefile.am and autogen.sh file.
70  *
71  * configure.ac:
72  *
73 @verbatim
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_PREREQ(2.52)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
78 AC_PROG_CC
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
81 AC_OUTPUT(Makefile)
82 @endverbatim
83  *
84  * Makefile.am:
85  *
86 @verbatim
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89
90 INCLUDES = -I$(top_srcdir)
91
92 bin_PROGRAMS = myapp
93
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
97 @endverbatim
98  *
99  * autogen.sh:
100  *
101 @verbatim
102 #!/bin/sh
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
107 ./configure "$@"
108 @endverbatim
109  *
110  * To generate all the things needed to bootstrap just run:
111  *
112 @verbatim
113 ./autogen.sh
114 @endverbatim
115  *
116  * This will generate Makefile.in's, the confgure script and everything else.
117  * After this it works like all normal autotools projects:
118 @verbatim
119 ./configure
120 make
121 sudo make install
122 @endverbatim
123  *
124  * Note sudo was assumed to get root permissions, as this would install in
125  * /usr/local which is system-owned. Use any way you like to gain root, or
126  * specify a different prefix with configure:
127  *
128 @verbatim
129 ./confiugre --prefix=$HOME/mysoftware
130 @endverbatim
131  *
132  * Also remember that autotools buys you some useful commands like:
133 @verbatim
134 make uninstall
135 @endverbatim
136  *
137  * This uninstalls the software after it was installed with "make install".
138  * It is very useful to clear up what you built if you wish to clean the
139  * system.
140  *
141 @verbatim
142 make distcheck
143 @endverbatim
144  *
145  * This firstly checks if your build tree is "clean" and ready for
146  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147  * ready to upload and distribute to the world, that contains the generated
148  * Makefile.in's and configure script. The users do not need to run
149  * autogen.sh - just configure and on. They don't need autotools installed.
150  * This tarball also builds cleanly, has all the sources it needs to build
151  * included (that is sources for your application, not libraries it depends
152  * on like Elementary). It builds cleanly in a buildroot and does not
153  * contain any files that are temporarily generated like binaries and other
154  * build-generated files, so the tarball is clean, and no need to worry
155  * about cleaning up your tree before packaging.
156  *
157 @verbatim
158 make clean
159 @endverbatim
160  *
161  * This cleans up all build files (binaries, objects etc.) from the tree.
162  *
163 @verbatim
164 make distclean
165 @endverbatim
166  *
167  * This cleans out all files from the build and from configure's output too.
168  *
169 @verbatim
170 make maintainer-clean
171 @endverbatim
172  *
173  * This deletes all the files autogen.sh will produce so the tree is clean
174  * to be put into a revision-control system (like CVS, SVN or GIT for example).
175  *
176  * There is a more advanced way of making use of the quicklaunch infrastructure
177  * in Elementary (which will not be covered here due to its more advanced
178  * nature).
179  *
180  * Now let's actually create an interactive "Hello World" gui that you can
181  * click the ok button to exit. It's more code because this now does something
182  * much more significant, but it's still very simple:
183  *
184 @code
185 #include <Elementary.h>
186
187 static void
188 on_done(void *data, Evas_Object *obj, void *event_info)
189 {
190    // quit the mainloop (elm_run function will return)
191    elm_exit();
192 }
193
194 EAPI int
195 elm_main(int argc, char **argv)
196 {
197    Evas_Object *win, *bg, *box, *lab, *btn;
198
199    // new window - do the usual and give it a name, title and delete handler
200    win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201    elm_win_title_set(win, "Hello");
202    // when the user clicks "close" on a window there is a request to delete
203    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
204
205    // add a standard bg
206    bg = elm_bg_add(win);
207    // add object as a resize object for the window (controls window minimum
208    // size as well as gets resized if window is resized)
209    elm_win_resize_object_add(win, bg);
210    evas_object_show(bg);
211
212    // add a box object - default is vertical. a box holds children in a row,
213    // either horizontally or vertically. nothing more.
214    box = elm_box_add(win);
215    // make the box hotizontal
216    elm_box_horizontal_set(box, EINA_TRUE);
217    // add object as a resize object for the window (controls window minimum
218    // size as well as gets resized if window is resized)
219    elm_win_resize_object_add(win, box);
220    evas_object_show(box);
221
222    // add a label widget, set the text and put it in the pad frame
223    lab = elm_label_add(win);
224    // set default text of the label
225    elm_object_text_set(lab, "Hello out there world!");
226    // pack the label at the end of the box
227    elm_box_pack_end(box, lab);
228    evas_object_show(lab);
229
230    // add an ok button
231    btn = elm_button_add(win);
232    // set default text of button to "OK"
233    elm_object_text_set(btn, "OK");
234    // pack the button at the end of the box
235    elm_box_pack_end(box, btn);
236    evas_object_show(btn);
237    // call on_done when button is clicked
238    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
239
240    // now we are done, show the window
241    evas_object_show(win);
242
243    // run the mainloop and process events and callbacks
244    elm_run();
245    return 0;
246 }
247 ELM_MAIN()
248 @endcode
249    *
250    */
251
252 /**
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296
297 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
298 contact with the developers and maintainers.
299  */
300
301 #ifndef ELEMENTARY_H
302 #define ELEMENTARY_H
303
304 /**
305  * @file Elementary.h
306  * @brief Elementary's API
307  *
308  * Elementary API.
309  */
310
311 @ELM_UNIX_DEF@ ELM_UNIX
312 @ELM_WIN32_DEF@ ELM_WIN32
313 @ELM_WINCE_DEF@ ELM_WINCE
314 @ELM_EDBUS_DEF@ ELM_EDBUS
315 @ELM_EFREET_DEF@ ELM_EFREET
316 @ELM_ETHUMB_DEF@ ELM_ETHUMB
317 @ELM_EMAP_DEF@ ELM_EMAP
318 @ELM_DEBUG_DEF@ ELM_DEBUG
319 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
320 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321
322 /* Standard headers for standard system calls etc. */
323 #include <stdio.h>
324 #include <stdlib.h>
325 #include <unistd.h>
326 #include <string.h>
327 #include <sys/types.h>
328 #include <sys/stat.h>
329 #include <sys/time.h>
330 #include <sys/param.h>
331 #include <dlfcn.h>
332 #include <math.h>
333 #include <fnmatch.h>
334 #include <limits.h>
335 #include <ctype.h>
336 #include <time.h>
337 #include <dirent.h>
338 #include <pwd.h>
339 #include <errno.h>
340
341 #ifdef ELM_UNIX
342 # include <locale.h>
343 # ifdef ELM_LIBINTL_H
344 #  include <libintl.h>
345 # endif
346 # include <signal.h>
347 # include <grp.h>
348 # include <glob.h>
349 #endif
350
351 #ifdef ELM_ALLOCA_H
352 # include <alloca.h>
353 #endif
354
355 #if defined (ELM_WIN32) || defined (ELM_WINCE)
356 # include <malloc.h>
357 # ifndef alloca
358 #  define alloca _alloca
359 # endif
360 #endif
361
362
363 /* EFL headers */
364 #include <Eina.h>
365 #include <Eet.h>
366 #include <Evas.h>
367 #include <Evas_GL.h>
368 #include <Ecore.h>
369 #include <Ecore_Evas.h>
370 #include <Ecore_File.h>
371 #include <Ecore_IMF.h>
372 #include <Ecore_Con.h>
373 #include <Edje.h>
374
375 #ifdef ELM_EDBUS
376 # include <E_DBus.h>
377 #endif
378
379 #ifdef ELM_EFREET
380 # include <Efreet.h>
381 # include <Efreet_Mime.h>
382 # include <Efreet_Trash.h>
383 #endif
384
385 #ifdef ELM_ETHUMB
386 # include <Ethumb_Client.h>
387 #endif
388
389 #ifdef ELM_EMAP
390 # include <EMap.h>
391 #endif
392
393 #ifdef EAPI
394 # undef EAPI
395 #endif
396
397 #ifdef _WIN32
398 # ifdef ELEMENTARY_BUILD
399 #  ifdef DLL_EXPORT
400 #   define EAPI __declspec(dllexport)
401 #  else
402 #   define EAPI
403 #  endif /* ! DLL_EXPORT */
404 # else
405 #  define EAPI __declspec(dllimport)
406 # endif /* ! EFL_EVAS_BUILD */
407 #else
408 # ifdef __GNUC__
409 #  if __GNUC__ >= 4
410 #   define EAPI __attribute__ ((visibility("default")))
411 #  else
412 #   define EAPI
413 #  endif
414 # else
415 #  define EAPI
416 # endif
417 #endif /* ! _WIN32 */
418
419
420 /* allow usage from c++ */
421 #ifdef __cplusplus
422 extern "C" {
423 #endif
424
425 #define ELM_VERSION_MAJOR @VMAJ@
426 #define ELM_VERSION_MINOR @VMIN@
427
428    typedef struct _Elm_Version
429      {
430         int major;
431         int minor;
432         int micro;
433         int revision;
434      } Elm_Version;
435
436    EAPI extern Elm_Version *elm_version;
437
438 /* handy macros */
439 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
440 #define ELM_PI 3.14159265358979323846
441
442    /**
443     * @defgroup General General
444     *
445     * @brief General Elementary API. Functions that don't relate to
446     * Elementary objects specifically.
447     *
448     * Here are documented functions which init/shutdown the library,
449     * that apply to generic Elementary objects, that deal with
450     * configuration, et cetera.
451     *
452     * @ref general_functions_example_page "This" example contemplates
453     * some of these functions.
454     */
455
456    /**
457     * @addtogroup General
458     * @{
459     */
460
461   /**
462    * Defines couple of standard Evas_Object layers to be used
463    * with evas_object_layer_set().
464    *
465    * @note whenever extending with new values, try to keep some padding
466    *       to siblings so there is room for further extensions.
467    */
468   typedef enum _Elm_Object_Layer
469     {
470        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
471        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
472        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
473        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
474        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
475        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
476     } Elm_Object_Layer;
477
478 /**************************************************************************/
479    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
480
481    /**
482     * Emitted when any Elementary's policy value is changed.
483     */
484    EAPI extern int ELM_EVENT_POLICY_CHANGED;
485
486    /**
487     * @typedef Elm_Event_Policy_Changed
488     *
489     * Data on the event when an Elementary policy has changed
490     */
491     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
492
493    /**
494     * @struct _Elm_Event_Policy_Changed
495     *
496     * Data on the event when an Elementary policy has changed
497     */
498     struct _Elm_Event_Policy_Changed
499      {
500         unsigned int policy; /**< the policy identifier */
501         int          new_value; /**< value the policy had before the change */
502         int          old_value; /**< new value the policy got */
503     };
504
505    /**
506     * Policy identifiers.
507     */
508     typedef enum _Elm_Policy
509     {
510         ELM_POLICY_QUIT, /**< under which circunstances the application
511                           * should quit automatically. @see
512                           * Elm_Policy_Quit.
513                           */
514         ELM_POLICY_LAST
515     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
516  */
517
518    typedef enum _Elm_Policy_Quit
519      {
520         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
521                                    * automatically */
522         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
523                                             * application's last
524                                             * window is closed */
525      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
526
527    typedef enum _Elm_Focus_Direction
528      {
529         ELM_FOCUS_PREVIOUS,
530         ELM_FOCUS_NEXT
531      } Elm_Focus_Direction;
532
533    typedef enum _Elm_Text_Format
534      {
535         ELM_TEXT_FORMAT_PLAIN_UTF8,
536         ELM_TEXT_FORMAT_MARKUP_UTF8
537      } Elm_Text_Format;
538
539    /**
540     * Line wrapping types.
541     */
542    typedef enum _Elm_Wrap_Type
543      {
544         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
545         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
546         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
547         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
548         ELM_WRAP_LAST
549      } Elm_Wrap_Type;
550
551    /**
552     * @typedef Elm_Object_Item
553     * An Elementary Object item handle.
554     * @ingroup General
555     */
556    typedef struct _Elm_Object_Item Elm_Object_Item;
557
558
559    /**
560     * Called back when a widget's tooltip is activated and needs content.
561     * @param data user-data given to elm_object_tooltip_content_cb_set()
562     * @param obj owner widget.
563     * @param tooltip The tooltip object (affix content to this!)
564     */
565    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
566
567    /**
568     * Called back when a widget's item tooltip is activated and needs content.
569     * @param data user-data given to elm_object_tooltip_content_cb_set()
570     * @param obj owner widget.
571     * @param tooltip The tooltip object (affix content to this!)
572     * @param item context dependent item. As an example, if tooltip was
573     *        set on Elm_List_Item, then it is of this type.
574     */
575    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
576
577    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
578
579 #ifndef ELM_LIB_QUICKLAUNCH
580 #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 */
581 #else
582 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
583 #endif
584
585 /**************************************************************************/
586    /* General calls */
587
588    /**
589     * Initialize Elementary
590     *
591     * @param[in] argc System's argument count value
592     * @param[in] argv System's pointer to array of argument strings
593     * @return The init counter value.
594     *
595     * This function initializes Elementary and increments a counter of
596     * the number of calls to it. It returs the new counter's value.
597     *
598     * @warning This call is exported only for use by the @c ELM_MAIN()
599     * macro. There is no need to use this if you use this macro (which
600     * is highly advisable). An elm_main() should contain the entry
601     * point code for your application, having the same prototype as
602     * elm_init(), and @b not being static (putting the @c EAPI symbol
603     * in front of its type declaration is advisable). The @c
604     * ELM_MAIN() call should be placed just after it.
605     *
606     * Example:
607     * @dontinclude bg_example_01.c
608     * @skip static void
609     * @until ELM_MAIN
610     *
611     * See the full @ref bg_example_01_c "example".
612     *
613     * @see elm_shutdown().
614     * @ingroup General
615     */
616    EAPI int          elm_init(int argc, char **argv);
617
618    /**
619     * Shut down Elementary
620     *
621     * @return The init counter value.
622     *
623     * This should be called at the end of your application, just
624     * before it ceases to do any more processing. This will clean up
625     * any permanent resources your application may have allocated via
626     * Elementary that would otherwise persist.
627     *
628     * @see elm_init() for an example
629     *
630     * @ingroup General
631     */
632    EAPI int          elm_shutdown(void);
633
634    /**
635     * Run Elementary's main loop
636     *
637     * This call should be issued just after all initialization is
638     * completed. This function will not return until elm_exit() is
639     * called. It will keep looping, running the main
640     * (event/processing) loop for Elementary.
641     *
642     * @see elm_init() for an example
643     *
644     * @ingroup General
645     */
646    EAPI void         elm_run(void);
647
648    /**
649     * Exit Elementary's main loop
650     *
651     * If this call is issued, it will flag the main loop to cease
652     * processing and return back to its parent function (usually your
653     * elm_main() function).
654     *
655     * @see elm_init() for an example. There, just after a request to
656     * close the window comes, the main loop will be left.
657     *
658     * @note By using the #ELM_POLICY_QUIT on your Elementary
659     * applications, you'll this function called automatically for you.
660     *
661     * @ingroup General
662     */
663    EAPI void         elm_exit(void);
664
665    /**
666     * Provide information in order to make Elementary determine the @b
667     * run time location of the software in question, so other data files
668     * such as images, sound files, executable utilities, libraries,
669     * modules and locale files can be found.
670     *
671     * @param mainfunc This is your application's main function name,
672     *        whose binary's location is to be found. Providing @c NULL
673     *        will make Elementary not to use it
674     * @param dom This will be used as the application's "domain", in the
675     *        form of a prefix to any environment variables that may
676     *        override prefix detection and the directory name, inside the
677     *        standard share or data directories, where the software's
678     *        data files will be looked for.
679     * @param checkfile This is an (optional) magic file's path to check
680     *        for existence (and it must be located in the data directory,
681     *        under the share directory provided above). Its presence will
682     *        help determine the prefix found was correct. Pass @c NULL if
683     *        the check is not to be done.
684     *
685     * This function allows one to re-locate the application somewhere
686     * else after compilation, if the developer wishes for easier
687     * distribution of pre-compiled binaries.
688     *
689     * The prefix system is designed to locate where the given software is
690     * installed (under a common path prefix) at run time and then report
691     * specific locations of this prefix and common directories inside
692     * this prefix like the binary, library, data and locale directories,
693     * through the @c elm_app_*_get() family of functions.
694     *
695     * Call elm_app_info_set() early on before you change working
696     * directory or anything about @c argv[0], so it gets accurate
697     * information.
698     *
699     * It will then try and trace back which file @p mainfunc comes from,
700     * if provided, to determine the application's prefix directory.
701     *
702     * The @p dom parameter provides a string prefix to prepend before
703     * environment variables, allowing a fallback to @b specific
704     * environment variables to locate the software. You would most
705     * probably provide a lowercase string there, because it will also
706     * serve as directory domain, explained next. For environment
707     * variables purposes, this string is made uppercase. For example if
708     * @c "myapp" is provided as the prefix, then the program would expect
709     * @c "MYAPP_PREFIX" as a master environment variable to specify the
710     * exact install prefix for the software, or more specific environment
711     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
712     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
713     * the user or scripts before launching. If not provided (@c NULL),
714     * environment variables will not be used to override compiled-in
715     * defaults or auto detections.
716     *
717     * The @p dom string also provides a subdirectory inside the system
718     * shared data directory for data files. For example, if the system
719     * directory is @c /usr/local/share, then this directory name is
720     * appended, creating @c /usr/local/share/myapp, if it @p was @c
721     * "myapp". It is expected the application installs data files in
722     * this directory.
723     *
724     * The @p checkfile is a file name or path of something inside the
725     * share or data directory to be used to test that the prefix
726     * detection worked. For example, your app will install a wallpaper
727     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
728     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
729     * checkfile string.
730     *
731     * @see elm_app_compile_bin_dir_set()
732     * @see elm_app_compile_lib_dir_set()
733     * @see elm_app_compile_data_dir_set()
734     * @see elm_app_compile_locale_set()
735     * @see elm_app_prefix_dir_get()
736     * @see elm_app_bin_dir_get()
737     * @see elm_app_lib_dir_get()
738     * @see elm_app_data_dir_get()
739     * @see elm_app_locale_dir_get()
740     */
741    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
742
743    /**
744     * Provide information on the @b fallback application's binaries
745     * directory, on scenarios where they get overriden by
746     * elm_app_info_set().
747     *
748     * @param dir The path to the default binaries directory (compile time
749     * one)
750     *
751     * @note Elementary will as well use this path to determine actual
752     * names of binaries' directory paths, maybe changing it to be @c
753     * something/local/bin instead of @c something/bin, only, for
754     * example.
755     *
756     * @warning You should call this function @b before
757     * elm_app_info_set().
758     */
759    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
760
761    /**
762     * Provide information on the @b fallback application's libraries
763     * directory, on scenarios where they get overriden by
764     * elm_app_info_set().
765     *
766     * @param dir The path to the default libraries directory (compile
767     * time one)
768     *
769     * @note Elementary will as well use this path to determine actual
770     * names of libraries' directory paths, maybe changing it to be @c
771     * something/lib32 or @c something/lib64 instead of @c something/lib,
772     * only, for example.
773     *
774     * @warning You should call this function @b before
775     * elm_app_info_set().
776     */
777    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
778
779    /**
780     * Provide information on the @b fallback application's data
781     * directory, on scenarios where they get overriden by
782     * elm_app_info_set().
783     *
784     * @param dir The path to the default data directory (compile time
785     * one)
786     *
787     * @note Elementary will as well use this path to determine actual
788     * names of data directory paths, maybe changing it to be @c
789     * something/local/share instead of @c something/share, only, for
790     * example.
791     *
792     * @warning You should call this function @b before
793     * elm_app_info_set().
794     */
795    EAPI void         elm_app_compile_data_dir_set(const char *dir);
796
797    /**
798     * Provide information on the @b fallback application's locale
799     * directory, on scenarios where they get overriden by
800     * elm_app_info_set().
801     *
802     * @param dir The path to the default locale directory (compile time
803     * one)
804     *
805     * @warning You should call this function @b before
806     * elm_app_info_set().
807     */
808    EAPI void         elm_app_compile_locale_set(const char *dir);
809
810    /**
811     * Retrieve the application's run time prefix directory, as set by
812     * elm_app_info_set() and the way (environment) the application was
813     * run from.
814     *
815     * @return The directory prefix the application is actually using
816     */
817    EAPI const char  *elm_app_prefix_dir_get(void);
818
819    /**
820     * Retrieve the application's run time binaries prefix directory, as
821     * set by elm_app_info_set() and the way (environment) the application
822     * was run from.
823     *
824     * @return The binaries directory prefix the application is actually
825     * using
826     */
827    EAPI const char  *elm_app_bin_dir_get(void);
828
829    /**
830     * Retrieve the application's run time libraries prefix directory, as
831     * set by elm_app_info_set() and the way (environment) the application
832     * was run from.
833     *
834     * @return The libraries directory prefix the application is actually
835     * using
836     */
837    EAPI const char  *elm_app_lib_dir_get(void);
838
839    /**
840     * Retrieve the application's run time data prefix directory, as
841     * set by elm_app_info_set() and the way (environment) the application
842     * was run from.
843     *
844     * @return The data directory prefix the application is actually
845     * using
846     */
847    EAPI const char  *elm_app_data_dir_get(void);
848
849    /**
850     * Retrieve the application's run time locale prefix directory, as
851     * set by elm_app_info_set() and the way (environment) the application
852     * was run from.
853     *
854     * @return The locale directory prefix the application is actually
855     * using
856     */
857    EAPI const char  *elm_app_locale_dir_get(void);
858
859    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
860    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
861    EAPI int          elm_quicklaunch_init(int argc, char **argv);
862    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
863    EAPI int          elm_quicklaunch_sub_shutdown(void);
864    EAPI int          elm_quicklaunch_shutdown(void);
865    EAPI void         elm_quicklaunch_seed(void);
866    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
867    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
868    EAPI void         elm_quicklaunch_cleanup(void);
869    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
870    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
871
872    EAPI Eina_Bool    elm_need_efreet(void);
873    EAPI Eina_Bool    elm_need_e_dbus(void);
874
875    /**
876     * This must be called before any other function that handle with
877     * elm_thumb objects or ethumb_client instances.
878     *
879     * @ingroup Thumb
880     */
881    EAPI Eina_Bool    elm_need_ethumb(void);
882
883    /**
884     * Set a new policy's value (for a given policy group/identifier).
885     *
886     * @param policy policy identifier, as in @ref Elm_Policy.
887     * @param value policy value, which depends on the identifier
888     *
889     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
890     *
891     * Elementary policies define applications' behavior,
892     * somehow. These behaviors are divided in policy groups (see
893     * #Elm_Policy enumeration). This call will emit the Ecore event
894     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
895     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
896     * then.
897     *
898     * @note Currently, we have only one policy identifier/group
899     * (#ELM_POLICY_QUIT), which has two possible values.
900     *
901     * @ingroup General
902     */
903    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
904
905    /**
906     * Gets the policy value set for given policy identifier.
907     *
908     * @param policy policy identifier, as in #Elm_Policy.
909     * @return The currently set policy value, for that
910     * identifier. Will be @c 0 if @p policy passed is invalid.
911     *
912     * @ingroup General
913     */
914    EAPI int          elm_policy_get(unsigned int policy);
915
916    /**
917     * Set a label of an object
918     *
919     * @param obj The Elementary object
920     * @param part The text part name to set (NULL for the default label)
921     * @param label The new text of the label
922     *
923     * @note Elementary objects may have many labels (e.g. Action Slider)
924     *
925     * @ingroup General
926     */
927    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
928
929 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
930
931    /**
932     * Get a label of an object
933     *
934     * @param obj The Elementary object
935     * @param part The text part name to get (NULL for the default label)
936     * @return text of the label or NULL for any error
937     *
938     * @note Elementary objects may have many labels (e.g. Action Slider)
939     *
940     * @ingroup General
941     */
942    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
943
944 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
945
946    /**
947     * Set a content of an object
948     *
949     * @param obj The Elementary object
950     * @param part The content part name to set (NULL for the default content)
951     * @param content The new content of the object
952     *
953     * @note Elementary objects may have many contents
954     *
955     * @ingroup General
956     */
957    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
958
959 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
960
961    /**
962     * Get a content of an object
963     *
964     * @param obj The Elementary object
965     * @param item The content part name to get (NULL for the default content)
966     * @return content of the object or NULL for any error
967     *
968     * @note Elementary objects may have many contents
969     *
970     * @ingroup General
971     */
972    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
973
974 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
975
976    /**
977     * Unset a content of an object
978     *
979     * @param obj The Elementary object
980     * @param item The content part name to unset (NULL for the default content)
981     *
982     * @note Elementary objects may have many contents
983     *
984     * @ingroup General
985     */
986    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
987
988 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
989
990    /**
991     * Set a content of an object item
992     *
993     * @param it The Elementary object item
994     * @param part The content part name to unset (NULL for the default content)
995     * @param content The new content of the object item
996     *
997     * @note Elementary object items may have many contents
998     *
999     * @ingroup General
1000     */
1001    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1002
1003 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1004
1005    /**
1006     * Get a content of an object item
1007     *
1008     * @param it The Elementary object item
1009     * @param part The content part name to unset (NULL for the default content)
1010     * @return content of the object item or NULL for any error
1011     *
1012     * @note Elementary object items may have many contents
1013     *
1014     * @ingroup General
1015     */
1016    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1017
1018 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1019
1020    /**
1021     * Unset a content of an object item
1022     *
1023     * @param it The Elementary object item
1024     * @param part The content part name to unset (NULL for the default content)
1025     *
1026     * @note Elementary object items may have many contents
1027     *
1028     * @ingroup General
1029     */
1030    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1031
1032 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1033
1034    /**
1035     * Set a label of an objec itemt
1036     *
1037     * @param it The Elementary object item
1038     * @param part The text part name to set (NULL for the default label)
1039     * @param label The new text of the label
1040     *
1041     * @note Elementary object items may have many labels
1042     *
1043     * @ingroup General
1044     */
1045    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1046
1047 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1048
1049    /**
1050     * Get a label of an object
1051     *
1052     * @param it The Elementary object item
1053     * @param part The text part name to get (NULL for the default label)
1054     * @return text of the label or NULL for any error
1055     *
1056     * @note Elementary object items may have many labels
1057     *
1058     * @ingroup General
1059     */
1060    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1061
1062 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1063
1064    /**
1065     * @}
1066     */
1067
1068    /**
1069     * @defgroup Caches Caches
1070     *
1071     * These are functions which let one fine-tune some cache values for
1072     * Elementary applications, thus allowing for performance adjustments.
1073     *
1074     * @{
1075     */
1076
1077    /**
1078     * @brief Flush all caches.
1079     *
1080     * Frees all data that was in cache and is not currently being used to reduce
1081     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1082     * to calling all of the following functions:
1083     * @li edje_file_cache_flush()
1084     * @li edje_collection_cache_flush()
1085     * @li eet_clearcache()
1086     * @li evas_image_cache_flush()
1087     * @li evas_font_cache_flush()
1088     * @li evas_render_dump()
1089     * @note Evas caches are flushed for every canvas associated with a window.
1090     *
1091     * @ingroup Caches
1092     */
1093    EAPI void         elm_all_flush(void);
1094
1095    /**
1096     * Get the configured cache flush interval time
1097     *
1098     * This gets the globally configured cache flush interval time, in
1099     * ticks
1100     *
1101     * @return The cache flush interval time
1102     * @ingroup Caches
1103     *
1104     * @see elm_all_flush()
1105     */
1106    EAPI int          elm_cache_flush_interval_get(void);
1107
1108    /**
1109     * Set the configured cache flush interval time
1110     *
1111     * This sets the globally configured cache flush interval time, in ticks
1112     *
1113     * @param size The cache flush interval time
1114     * @ingroup Caches
1115     *
1116     * @see elm_all_flush()
1117     */
1118    EAPI void         elm_cache_flush_interval_set(int size);
1119
1120    /**
1121     * Set the configured cache flush interval time for all applications on the
1122     * display
1123     *
1124     * This sets the globally configured cache flush interval time -- in ticks
1125     * -- for all applications on the display.
1126     *
1127     * @param size The cache flush interval time
1128     * @ingroup Caches
1129     */
1130    EAPI void         elm_cache_flush_interval_all_set(int size);
1131
1132    /**
1133     * Get the configured cache flush enabled state
1134     *
1135     * This gets the globally configured cache flush state - if it is enabled
1136     * or not. When cache flushing is enabled, elementary will regularly
1137     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1138     * memory and allow usage to re-seed caches and data in memory where it
1139     * can do so. An idle application will thus minimise its memory usage as
1140     * data will be freed from memory and not be re-loaded as it is idle and
1141     * not rendering or doing anything graphically right now.
1142     *
1143     * @return The cache flush state
1144     * @ingroup Caches
1145     *
1146     * @see elm_all_flush()
1147     */
1148    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1149
1150    /**
1151     * Set the configured cache flush enabled state
1152     *
1153     * This sets the globally configured cache flush enabled state
1154     *
1155     * @param size The cache flush enabled state
1156     * @ingroup Caches
1157     *
1158     * @see elm_all_flush()
1159     */
1160    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1161
1162    /**
1163     * Set the configured cache flush enabled state for all applications on the
1164     * display
1165     *
1166     * This sets the globally configured cache flush enabled state for all
1167     * applications on the display.
1168     *
1169     * @param size The cache flush enabled state
1170     * @ingroup Caches
1171     */
1172    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1173
1174    /**
1175     * Get the configured font cache size
1176     *
1177     * This gets the globally configured font cache size, in bytes
1178     *
1179     * @return The font cache size
1180     * @ingroup Caches
1181     */
1182    EAPI int          elm_font_cache_get(void);
1183
1184    /**
1185     * Set the configured font cache size
1186     *
1187     * This sets the globally configured font cache size, in bytes
1188     *
1189     * @param size The font cache size
1190     * @ingroup Caches
1191     */
1192    EAPI void         elm_font_cache_set(int size);
1193
1194    /**
1195     * Set the configured font cache size for all applications on the
1196     * display
1197     *
1198     * This sets the globally configured font cache size -- in bytes
1199     * -- for all applications on the display.
1200     *
1201     * @param size The font cache size
1202     * @ingroup Caches
1203     */
1204    EAPI void         elm_font_cache_all_set(int size);
1205
1206    /**
1207     * Get the configured image cache size
1208     *
1209     * This gets the globally configured image cache size, in bytes
1210     *
1211     * @return The image cache size
1212     * @ingroup Caches
1213     */
1214    EAPI int          elm_image_cache_get(void);
1215
1216    /**
1217     * Set the configured image cache size
1218     *
1219     * This sets the globally configured image cache size, in bytes
1220     *
1221     * @param size The image cache size
1222     * @ingroup Caches
1223     */
1224    EAPI void         elm_image_cache_set(int size);
1225
1226    /**
1227     * Set the configured image cache size for all applications on the
1228     * display
1229     *
1230     * This sets the globally configured image cache size -- in bytes
1231     * -- for all applications on the display.
1232     *
1233     * @param size The image cache size
1234     * @ingroup Caches
1235     */
1236    EAPI void         elm_image_cache_all_set(int size);
1237
1238    /**
1239     * Get the configured edje file cache size.
1240     *
1241     * This gets the globally configured edje file cache size, in number
1242     * of files.
1243     *
1244     * @return The edje file cache size
1245     * @ingroup Caches
1246     */
1247    EAPI int          elm_edje_file_cache_get(void);
1248
1249    /**
1250     * Set the configured edje file cache size
1251     *
1252     * This sets the globally configured edje file cache size, in number
1253     * of files.
1254     *
1255     * @param size The edje file cache size
1256     * @ingroup Caches
1257     */
1258    EAPI void         elm_edje_file_cache_set(int size);
1259
1260    /**
1261     * Set the configured edje file cache size for all applications on the
1262     * display
1263     *
1264     * This sets the globally configured edje file cache size -- in number
1265     * of files -- for all applications on the display.
1266     *
1267     * @param size The edje file cache size
1268     * @ingroup Caches
1269     */
1270    EAPI void         elm_edje_file_cache_all_set(int size);
1271
1272    /**
1273     * Get the configured edje collections (groups) cache size.
1274     *
1275     * This gets the globally configured edje collections cache size, in
1276     * number of collections.
1277     *
1278     * @return The edje collections cache size
1279     * @ingroup Caches
1280     */
1281    EAPI int          elm_edje_collection_cache_get(void);
1282
1283    /**
1284     * Set the configured edje collections (groups) cache size
1285     *
1286     * This sets the globally configured edje collections cache size, in
1287     * number of collections.
1288     *
1289     * @param size The edje collections cache size
1290     * @ingroup Caches
1291     */
1292    EAPI void         elm_edje_collection_cache_set(int size);
1293
1294    /**
1295     * Set the configured edje collections (groups) cache size for all
1296     * applications on the display
1297     *
1298     * This sets the globally configured edje collections cache size -- in
1299     * number of collections -- for all applications on the display.
1300     *
1301     * @param size The edje collections cache size
1302     * @ingroup Caches
1303     */
1304    EAPI void         elm_edje_collection_cache_all_set(int size);
1305
1306    /**
1307     * @}
1308     */
1309
1310    /**
1311     * @defgroup Scaling Widget Scaling
1312     *
1313     * Different widgets can be scaled independently. These functions
1314     * allow you to manipulate this scaling on a per-widget basis. The
1315     * object and all its children get their scaling factors multiplied
1316     * by the scale factor set. This is multiplicative, in that if a
1317     * child also has a scale size set it is in turn multiplied by its
1318     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1319     * double size, @c 0.5 is half, etc.
1320     *
1321     * @ref general_functions_example_page "This" example contemplates
1322     * some of these functions.
1323     */
1324
1325    /**
1326     * Get the global scaling factor
1327     *
1328     * This gets the globally configured scaling factor that is applied to all
1329     * objects.
1330     *
1331     * @return The scaling factor
1332     * @ingroup Scaling
1333     */
1334    EAPI double       elm_scale_get(void);
1335
1336    /**
1337     * Set the global scaling factor
1338     *
1339     * This sets the globally configured scaling factor that is applied to all
1340     * objects.
1341     *
1342     * @param scale The scaling factor to set
1343     * @ingroup Scaling
1344     */
1345    EAPI void         elm_scale_set(double scale);
1346
1347    /**
1348     * Set the global scaling factor for all applications on the display
1349     *
1350     * This sets the globally configured scaling factor that is applied to all
1351     * objects for all applications.
1352     * @param scale The scaling factor to set
1353     * @ingroup Scaling
1354     */
1355    EAPI void         elm_scale_all_set(double scale);
1356
1357    /**
1358     * Set the scaling factor for a given Elementary object
1359     *
1360     * @param obj The Elementary to operate on
1361     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1362     * no scaling)
1363     *
1364     * @ingroup Scaling
1365     */
1366    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1367
1368    /**
1369     * Get the scaling factor for a given Elementary object
1370     *
1371     * @param obj The object
1372     * @return The scaling factor set by elm_object_scale_set()
1373     *
1374     * @ingroup Scaling
1375     */
1376    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1377
1378    /**
1379     * @defgroup UI-Mirroring Selective Widget mirroring
1380     *
1381     * These functions allow you to set ui-mirroring on specific
1382     * widgets or the whole interface. Widgets can be in one of two
1383     * modes, automatic and manual.  Automatic means they'll be changed
1384     * according to the system mirroring mode and manual means only
1385     * explicit changes will matter. You are not supposed to change
1386     * mirroring state of a widget set to automatic, will mostly work,
1387     * but the behavior is not really defined.
1388     *
1389     * @{
1390     */
1391
1392    EAPI Eina_Bool    elm_mirrored_get(void);
1393    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1394
1395    /**
1396     * Get the system mirrored mode. This determines the default mirrored mode
1397     * of widgets.
1398     *
1399     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1400     */
1401    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1402
1403    /**
1404     * Set the system mirrored mode. This determines the default mirrored mode
1405     * of widgets.
1406     *
1407     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1408     */
1409    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1410
1411    /**
1412     * Returns the widget's mirrored mode setting.
1413     *
1414     * @param obj The widget.
1415     * @return mirrored mode setting of the object.
1416     *
1417     **/
1418    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1419
1420    /**
1421     * Sets the widget's mirrored mode setting.
1422     * When widget in automatic mode, it follows the system mirrored mode set by
1423     * elm_mirrored_set().
1424     * @param obj The widget.
1425     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1426     */
1427    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1428
1429    /**
1430     * @}
1431     */
1432
1433    /**
1434     * Set the style to use by a widget
1435     *
1436     * Sets the style name that will define the appearance of a widget. Styles
1437     * vary from widget to widget and may also be defined by other themes
1438     * by means of extensions and overlays.
1439     *
1440     * @param obj The Elementary widget to style
1441     * @param style The style name to use
1442     *
1443     * @see elm_theme_extension_add()
1444     * @see elm_theme_extension_del()
1445     * @see elm_theme_overlay_add()
1446     * @see elm_theme_overlay_del()
1447     *
1448     * @ingroup Styles
1449     */
1450    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1451    /**
1452     * Get the style used by the widget
1453     *
1454     * This gets the style being used for that widget. Note that the string
1455     * pointer is only valid as longas the object is valid and the style doesn't
1456     * change.
1457     *
1458     * @param obj The Elementary widget to query for its style
1459     * @return The style name used
1460     *
1461     * @see elm_object_style_set()
1462     *
1463     * @ingroup Styles
1464     */
1465    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1466
1467    /**
1468     * @defgroup Styles Styles
1469     *
1470     * Widgets can have different styles of look. These generic API's
1471     * set styles of widgets, if they support them (and if the theme(s)
1472     * do).
1473     *
1474     * @ref general_functions_example_page "This" example contemplates
1475     * some of these functions.
1476     */
1477
1478    /**
1479     * Set the disabled state of an Elementary object.
1480     *
1481     * @param obj The Elementary object to operate on
1482     * @param disabled The state to put in in: @c EINA_TRUE for
1483     *        disabled, @c EINA_FALSE for enabled
1484     *
1485     * Elementary objects can be @b disabled, in which state they won't
1486     * receive input and, in general, will be themed differently from
1487     * their normal state, usually greyed out. Useful for contexts
1488     * where you don't want your users to interact with some of the
1489     * parts of you interface.
1490     *
1491     * This sets the state for the widget, either disabling it or
1492     * enabling it back.
1493     *
1494     * @ingroup Styles
1495     */
1496    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1497
1498    /**
1499     * Get the disabled state of an Elementary object.
1500     *
1501     * @param obj The Elementary object to operate on
1502     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1503     *            if it's enabled (or on errors)
1504     *
1505     * This gets the state of the widget, which might be enabled or disabled.
1506     *
1507     * @ingroup Styles
1508     */
1509    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1510
1511    /**
1512     * @defgroup WidgetNavigation Widget Tree Navigation.
1513     *
1514     * How to check if an Evas Object is an Elementary widget? How to
1515     * get the first elementary widget that is parent of the given
1516     * object?  These are all covered in widget tree navigation.
1517     *
1518     * @ref general_functions_example_page "This" example contemplates
1519     * some of these functions.
1520     */
1521
1522    /**
1523     * Check if the given Evas Object is an Elementary widget.
1524     *
1525     * @param obj the object to query.
1526     * @return @c EINA_TRUE if it is an elementary widget variant,
1527     *         @c EINA_FALSE otherwise
1528     * @ingroup WidgetNavigation
1529     */
1530    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1531
1532    /**
1533     * Get the first parent of the given object that is an Elementary
1534     * widget.
1535     *
1536     * @param obj the Elementary object to query parent from.
1537     * @return the parent object that is an Elementary widget, or @c
1538     *         NULL, if it was not found.
1539     *
1540     * Use this to query for an object's parent widget.
1541     *
1542     * @note Most of Elementary users wouldn't be mixing non-Elementary
1543     * smart objects in the objects tree of an application, as this is
1544     * an advanced usage of Elementary with Evas. So, except for the
1545     * application's window, which is the root of that tree, all other
1546     * objects would have valid Elementary widget parents.
1547     *
1548     * @ingroup WidgetNavigation
1549     */
1550    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1551
1552    /**
1553     * Get the top level parent of an Elementary widget.
1554     *
1555     * @param obj The object to query.
1556     * @return The top level Elementary widget, or @c NULL if parent cannot be
1557     * found.
1558     * @ingroup WidgetNavigation
1559     */
1560    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1561
1562    /**
1563     * Get the string that represents this Elementary widget.
1564     *
1565     * @note Elementary is weird and exposes itself as a single
1566     *       Evas_Object_Smart_Class of type "elm_widget", so
1567     *       evas_object_type_get() always return that, making debug and
1568     *       language bindings hard. This function tries to mitigate this
1569     *       problem, but the solution is to change Elementary to use
1570     *       proper inheritance.
1571     *
1572     * @param obj the object to query.
1573     * @return Elementary widget name, or @c NULL if not a valid widget.
1574     * @ingroup WidgetNavigation
1575     */
1576    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1577
1578    /**
1579     * @defgroup Config Elementary Config
1580     *
1581     * Elementary configuration is formed by a set options bounded to a
1582     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1583     * "finger size", etc. These are functions with which one syncronizes
1584     * changes made to those values to the configuration storing files, de
1585     * facto. You most probably don't want to use the functions in this
1586     * group unlees you're writing an elementary configuration manager.
1587     *
1588     * @{
1589     */
1590
1591    /**
1592     * Save back Elementary's configuration, so that it will persist on
1593     * future sessions.
1594     *
1595     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1596     * @ingroup Config
1597     *
1598     * This function will take effect -- thus, do I/O -- immediately. Use
1599     * it when you want to apply all configuration changes at once. The
1600     * current configuration set will get saved onto the current profile
1601     * configuration file.
1602     *
1603     */
1604    EAPI Eina_Bool    elm_config_save(void);
1605
1606    /**
1607     * Reload Elementary's configuration, bounded to current selected
1608     * profile.
1609     *
1610     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1611     * @ingroup Config
1612     *
1613     * Useful when you want to force reloading of configuration values for
1614     * a profile. If one removes user custom configuration directories,
1615     * for example, it will force a reload with system values insted.
1616     *
1617     */
1618    EAPI void         elm_config_reload(void);
1619
1620    /**
1621     * @}
1622     */
1623
1624    /**
1625     * @defgroup Profile Elementary Profile
1626     *
1627     * Profiles are pre-set options that affect the whole look-and-feel of
1628     * Elementary-based applications. There are, for example, profiles
1629     * aimed at desktop computer applications and others aimed at mobile,
1630     * touchscreen-based ones. You most probably don't want to use the
1631     * functions in this group unlees you're writing an elementary
1632     * configuration manager.
1633     *
1634     * @{
1635     */
1636
1637    /**
1638     * Get Elementary's profile in use.
1639     *
1640     * This gets the global profile that is applied to all Elementary
1641     * applications.
1642     *
1643     * @return The profile's name
1644     * @ingroup Profile
1645     */
1646    EAPI const char  *elm_profile_current_get(void);
1647
1648    /**
1649     * Get an Elementary's profile directory path in the filesystem. One
1650     * may want to fetch a system profile's dir or an user one (fetched
1651     * inside $HOME).
1652     *
1653     * @param profile The profile's name
1654     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1655     *                or a system one (@c EINA_FALSE)
1656     * @return The profile's directory path.
1657     * @ingroup Profile
1658     *
1659     * @note You must free it with elm_profile_dir_free().
1660     */
1661    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1662
1663    /**
1664     * Free an Elementary's profile directory path, as returned by
1665     * elm_profile_dir_get().
1666     *
1667     * @param p_dir The profile's path
1668     * @ingroup Profile
1669     *
1670     */
1671    EAPI void         elm_profile_dir_free(const char *p_dir);
1672
1673    /**
1674     * Get Elementary's list of available profiles.
1675     *
1676     * @return The profiles list. List node data are the profile name
1677     *         strings.
1678     * @ingroup Profile
1679     *
1680     * @note One must free this list, after usage, with the function
1681     *       elm_profile_list_free().
1682     */
1683    EAPI Eina_List   *elm_profile_list_get(void);
1684
1685    /**
1686     * Free Elementary's list of available profiles.
1687     *
1688     * @param l The profiles list, as returned by elm_profile_list_get().
1689     * @ingroup Profile
1690     *
1691     */
1692    EAPI void         elm_profile_list_free(Eina_List *l);
1693
1694    /**
1695     * Set Elementary's profile.
1696     *
1697     * This sets the global profile that is applied to Elementary
1698     * applications. Just the process the call comes from will be
1699     * affected.
1700     *
1701     * @param profile The profile's name
1702     * @ingroup Profile
1703     *
1704     */
1705    EAPI void         elm_profile_set(const char *profile);
1706
1707    /**
1708     * Set Elementary's profile.
1709     *
1710     * This sets the global profile that is applied to all Elementary
1711     * applications. All running Elementary windows will be affected.
1712     *
1713     * @param profile The profile's name
1714     * @ingroup Profile
1715     *
1716     */
1717    EAPI void         elm_profile_all_set(const char *profile);
1718
1719    /**
1720     * @}
1721     */
1722
1723    /**
1724     * @defgroup Engine Elementary Engine
1725     *
1726     * These are functions setting and querying which rendering engine
1727     * Elementary will use for drawing its windows' pixels.
1728     *
1729     * The following are the available engines:
1730     * @li "software_x11"
1731     * @li "fb"
1732     * @li "directfb"
1733     * @li "software_16_x11"
1734     * @li "software_8_x11"
1735     * @li "xrender_x11"
1736     * @li "opengl_x11"
1737     * @li "software_gdi"
1738     * @li "software_16_wince_gdi"
1739     * @li "sdl"
1740     * @li "software_16_sdl"
1741     * @li "opengl_sdl"
1742     * @li "buffer"
1743     *
1744     * @{
1745     */
1746
1747    /**
1748     * @brief Get Elementary's rendering engine in use.
1749     *
1750     * @return The rendering engine's name
1751     * @note there's no need to free the returned string, here.
1752     *
1753     * This gets the global rendering engine that is applied to all Elementary
1754     * applications.
1755     *
1756     * @see elm_engine_set()
1757     */
1758    EAPI const char  *elm_engine_current_get(void);
1759
1760    /**
1761     * @brief Set Elementary's rendering engine for use.
1762     *
1763     * @param engine The rendering engine's name
1764     *
1765     * This sets global rendering engine that is applied to all Elementary
1766     * applications. Note that it will take effect only to Elementary windows
1767     * created after this is called.
1768     *
1769     * @see elm_win_add()
1770     */
1771    EAPI void         elm_engine_set(const char *engine);
1772
1773    /**
1774     * @}
1775     */
1776
1777    /**
1778     * @defgroup Fonts Elementary Fonts
1779     *
1780     * These are functions dealing with font rendering, selection and the
1781     * like for Elementary applications. One might fetch which system
1782     * fonts are there to use and set custom fonts for individual classes
1783     * of UI items containing text (text classes).
1784     *
1785     * @{
1786     */
1787
1788   typedef struct _Elm_Text_Class
1789     {
1790        const char *name;
1791        const char *desc;
1792     } Elm_Text_Class;
1793
1794   typedef struct _Elm_Font_Overlay
1795     {
1796        const char     *text_class;
1797        const char     *font;
1798        Evas_Font_Size  size;
1799     } Elm_Font_Overlay;
1800
1801   typedef struct _Elm_Font_Properties
1802     {
1803        const char *name;
1804        Eina_List  *styles;
1805     } Elm_Font_Properties;
1806
1807    /**
1808     * Get Elementary's list of supported text classes.
1809     *
1810     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1811     * @ingroup Fonts
1812     *
1813     * Release the list with elm_text_classes_list_free().
1814     */
1815    EAPI const Eina_List     *elm_text_classes_list_get(void);
1816
1817    /**
1818     * Free Elementary's list of supported text classes.
1819     *
1820     * @ingroup Fonts
1821     *
1822     * @see elm_text_classes_list_get().
1823     */
1824    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1825
1826    /**
1827     * Get Elementary's list of font overlays, set with
1828     * elm_font_overlay_set().
1829     *
1830     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1831     * data.
1832     *
1833     * @ingroup Fonts
1834     *
1835     * For each text class, one can set a <b>font overlay</b> for it,
1836     * overriding the default font properties for that class coming from
1837     * the theme in use. There is no need to free this list.
1838     *
1839     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1840     */
1841    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1842
1843    /**
1844     * Set a font overlay for a given Elementary text class.
1845     *
1846     * @param text_class Text class name
1847     * @param font Font name and style string
1848     * @param size Font size
1849     *
1850     * @ingroup Fonts
1851     *
1852     * @p font has to be in the format returned by
1853     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1854     * and elm_font_overlay_unset().
1855     */
1856    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1857
1858    /**
1859     * Unset a font overlay for a given Elementary text class.
1860     *
1861     * @param text_class Text class name
1862     *
1863     * @ingroup Fonts
1864     *
1865     * This will bring back text elements belonging to text class
1866     * @p text_class back to their default font settings.
1867     */
1868    EAPI void                 elm_font_overlay_unset(const char *text_class);
1869
1870    /**
1871     * Apply the changes made with elm_font_overlay_set() and
1872     * elm_font_overlay_unset() on the current Elementary window.
1873     *
1874     * @ingroup Fonts
1875     *
1876     * This applies all font overlays set to all objects in the UI.
1877     */
1878    EAPI void                 elm_font_overlay_apply(void);
1879
1880    /**
1881     * Apply the changes made with elm_font_overlay_set() and
1882     * elm_font_overlay_unset() on all Elementary application windows.
1883     *
1884     * @ingroup Fonts
1885     *
1886     * This applies all font overlays set to all objects in the UI.
1887     */
1888    EAPI void                 elm_font_overlay_all_apply(void);
1889
1890    /**
1891     * Translate a font (family) name string in fontconfig's font names
1892     * syntax into an @c Elm_Font_Properties struct.
1893     *
1894     * @param font The font name and styles string
1895     * @return the font properties struct
1896     *
1897     * @ingroup Fonts
1898     *
1899     * @note The reverse translation can be achived with
1900     * elm_font_fontconfig_name_get(), for one style only (single font
1901     * instance, not family).
1902     */
1903    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1904
1905    /**
1906     * Free font properties return by elm_font_properties_get().
1907     *
1908     * @param efp the font properties struct
1909     *
1910     * @ingroup Fonts
1911     */
1912    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1913
1914    /**
1915     * Translate a font name, bound to a style, into fontconfig's font names
1916     * syntax.
1917     *
1918     * @param name The font (family) name
1919     * @param style The given style (may be @c NULL)
1920     *
1921     * @return the font name and style string
1922     *
1923     * @ingroup Fonts
1924     *
1925     * @note The reverse translation can be achived with
1926     * elm_font_properties_get(), for one style only (single font
1927     * instance, not family).
1928     */
1929    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1930
1931    /**
1932     * Free the font string return by elm_font_fontconfig_name_get().
1933     *
1934     * @param efp the font properties struct
1935     *
1936     * @ingroup Fonts
1937     */
1938    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1939
1940    /**
1941     * Create a font hash table of available system fonts.
1942     *
1943     * One must call it with @p list being the return value of
1944     * evas_font_available_list(). The hash will be indexed by font
1945     * (family) names, being its values @c Elm_Font_Properties blobs.
1946     *
1947     * @param list The list of available system fonts, as returned by
1948     * evas_font_available_list().
1949     * @return the font hash.
1950     *
1951     * @ingroup Fonts
1952     *
1953     * @note The user is supposed to get it populated at least with 3
1954     * default font families (Sans, Serif, Monospace), which should be
1955     * present on most systems.
1956     */
1957    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
1958
1959    /**
1960     * Free the hash return by elm_font_available_hash_add().
1961     *
1962     * @param hash the hash to be freed.
1963     *
1964     * @ingroup Fonts
1965     */
1966    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
1967
1968    /**
1969     * @}
1970     */
1971
1972    /**
1973     * @defgroup Fingers Fingers
1974     *
1975     * Elementary is designed to be finger-friendly for touchscreens,
1976     * and so in addition to scaling for display resolution, it can
1977     * also scale based on finger "resolution" (or size). You can then
1978     * customize the granularity of the areas meant to receive clicks
1979     * on touchscreens.
1980     *
1981     * Different profiles may have pre-set values for finger sizes.
1982     *
1983     * @ref general_functions_example_page "This" example contemplates
1984     * some of these functions.
1985     *
1986     * @{
1987     */
1988
1989    /**
1990     * Get the configured "finger size"
1991     *
1992     * @return The finger size
1993     *
1994     * This gets the globally configured finger size, <b>in pixels</b>
1995     *
1996     * @ingroup Fingers
1997     */
1998    EAPI Evas_Coord       elm_finger_size_get(void);
1999
2000    /**
2001     * Set the configured finger size
2002     *
2003     * This sets the globally configured finger size in pixels
2004     *
2005     * @param size The finger size
2006     * @ingroup Fingers
2007     */
2008    EAPI void             elm_finger_size_set(Evas_Coord size);
2009
2010    /**
2011     * Set the configured finger size for all applications on the display
2012     *
2013     * This sets the globally configured finger size in pixels for all
2014     * applications on the display
2015     *
2016     * @param size The finger size
2017     * @ingroup Fingers
2018     */
2019    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2020
2021    /**
2022     * @}
2023     */
2024
2025    /**
2026     * @defgroup Focus Focus
2027     *
2028     * An Elementary application has, at all times, one (and only one)
2029     * @b focused object. This is what determines where the input
2030     * events go to within the application's window. Also, focused
2031     * objects can be decorated differently, in order to signal to the
2032     * user where the input is, at a given moment.
2033     *
2034     * Elementary applications also have the concept of <b>focus
2035     * chain</b>: one can cycle through all the windows' focusable
2036     * objects by input (tab key) or programmatically. The default
2037     * focus chain for an application is the one define by the order in
2038     * which the widgets where added in code. One will cycle through
2039     * top level widgets, and, for each one containg sub-objects, cycle
2040     * through them all, before returning to the level
2041     * above. Elementary also allows one to set @b custom focus chains
2042     * for their applications.
2043     *
2044     * Besides the focused decoration a widget may exhibit, when it
2045     * gets focus, Elementary has a @b global focus highlight object
2046     * that can be enabled for a window. If one chooses to do so, this
2047     * extra highlight effect will surround the current focused object,
2048     * too.
2049     *
2050     * @note Some Elementary widgets are @b unfocusable, after
2051     * creation, by their very nature: they are not meant to be
2052     * interacted with input events, but are there just for visual
2053     * purposes.
2054     *
2055     * @ref general_functions_example_page "This" example contemplates
2056     * some of these functions.
2057     */
2058
2059    /**
2060     * Get the enable status of the focus highlight
2061     *
2062     * This gets whether the highlight on focused objects is enabled or not
2063     * @ingroup Focus
2064     */
2065    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2066
2067    /**
2068     * Set the enable status of the focus highlight
2069     *
2070     * Set whether to show or not the highlight on focused objects
2071     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2072     * @ingroup Focus
2073     */
2074    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2075
2076    /**
2077     * Get the enable status of the highlight animation
2078     *
2079     * Get whether the focus highlight, if enabled, will animate its switch from
2080     * one object to the next
2081     * @ingroup Focus
2082     */
2083    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2084
2085    /**
2086     * Set the enable status of the highlight animation
2087     *
2088     * Set whether the focus highlight, if enabled, will animate its switch from
2089     * one object to the next
2090     * @param animate Enable animation if EINA_TRUE, disable otherwise
2091     * @ingroup Focus
2092     */
2093    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2094
2095    /**
2096     * Get the whether an Elementary object has the focus or not.
2097     *
2098     * @param obj The Elementary object to get the information from
2099     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2100     *            not (and on errors).
2101     *
2102     * @see elm_object_focus_set()
2103     *
2104     * @ingroup Focus
2105     */
2106    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2107
2108    /**
2109     * Set/unset focus to a given Elementary object.
2110     *
2111     * @param obj The Elementary object to operate on.
2112     * @param enable @c EINA_TRUE Set focus to a given object,
2113     *               @c EINA_FALSE Unset focus to a given object.
2114     *
2115     * @note When you set focus to this object, if it can handle focus, will
2116     * take the focus away from the one who had it previously and will, for
2117     * now on, be the one receiving input events. Unsetting focus will remove
2118     * the focus from @p obj, passing it back to the previous element in the
2119     * focus chain list.
2120     *
2121     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2122     *
2123     * @ingroup Focus
2124     */
2125    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2126
2127    /**
2128     * Make a given Elementary object the focused one.
2129     *
2130     * @param obj The Elementary object to make focused.
2131     *
2132     * @note This object, if it can handle focus, will take the focus
2133     * away from the one who had it previously and will, for now on, be
2134     * the one receiving input events.
2135     *
2136     * @see elm_object_focus_get()
2137     * @deprecated use elm_object_focus_set() instead.
2138     *
2139     * @ingroup Focus
2140     */
2141    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2142
2143    /**
2144     * Remove the focus from an Elementary object
2145     *
2146     * @param obj The Elementary to take focus from
2147     *
2148     * This removes the focus from @p obj, passing it back to the
2149     * previous element in the focus chain list.
2150     *
2151     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2152     * @deprecated use elm_object_focus_set() instead.
2153     *
2154     * @ingroup Focus
2155     */
2156    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2157
2158    /**
2159     * Set the ability for an Element object to be focused
2160     *
2161     * @param obj The Elementary object to operate on
2162     * @param enable @c EINA_TRUE if the object can be focused, @c
2163     *        EINA_FALSE if not (and on errors)
2164     *
2165     * This sets whether the object @p obj is able to take focus or
2166     * not. Unfocusable objects do nothing when programmatically
2167     * focused, being the nearest focusable parent object the one
2168     * really getting focus. Also, when they receive mouse input, they
2169     * will get the event, but not take away the focus from where it
2170     * was previously.
2171     *
2172     * @ingroup Focus
2173     */
2174    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2175
2176    /**
2177     * Get whether an Elementary object is focusable or not
2178     *
2179     * @param obj The Elementary object to operate on
2180     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2181     *             EINA_FALSE if not (and on errors)
2182     *
2183     * @note Objects which are meant to be interacted with by input
2184     * events are created able to be focused, by default. All the
2185     * others are not.
2186     *
2187     * @ingroup Focus
2188     */
2189    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2190
2191    /**
2192     * Set custom focus chain.
2193     *
2194     * This function overwrites any previous custom focus chain within
2195     * the list of objects. The previous list will be deleted and this list
2196     * will be managed by elementary. After it is set, don't modify it.
2197     *
2198     * @note On focus cycle, only will be evaluated children of this container.
2199     *
2200     * @param obj The container object
2201     * @param objs Chain of objects to pass focus
2202     * @ingroup Focus
2203     */
2204    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2205
2206    /**
2207     * Unset a custom focus chain on a given Elementary widget
2208     *
2209     * @param obj The container object to remove focus chain from
2210     *
2211     * Any focus chain previously set on @p obj (for its child objects)
2212     * is removed entirely after this call.
2213     *
2214     * @ingroup Focus
2215     */
2216    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2217
2218    /**
2219     * Get custom focus chain
2220     *
2221     * @param obj The container object
2222     * @ingroup Focus
2223     */
2224    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2225
2226    /**
2227     * Append object to custom focus chain.
2228     *
2229     * @note If relative_child equal to NULL or not in custom chain, the object
2230     * will be added in end.
2231     *
2232     * @note On focus cycle, only will be evaluated children of this container.
2233     *
2234     * @param obj The container object
2235     * @param child The child to be added in custom chain
2236     * @param relative_child The relative object to position the child
2237     * @ingroup Focus
2238     */
2239    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2240
2241    /**
2242     * Prepend object to custom focus chain.
2243     *
2244     * @note If relative_child equal to NULL or not in custom chain, the object
2245     * will be added in begin.
2246     *
2247     * @note On focus cycle, only will be evaluated children of this container.
2248     *
2249     * @param obj The container object
2250     * @param child The child to be added in custom chain
2251     * @param relative_child The relative object to position the child
2252     * @ingroup Focus
2253     */
2254    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2255
2256    /**
2257     * Give focus to next object in object tree.
2258     *
2259     * Give focus to next object in focus chain of one object sub-tree.
2260     * If the last object of chain already have focus, the focus will go to the
2261     * first object of chain.
2262     *
2263     * @param obj The object root of sub-tree
2264     * @param dir Direction to cycle the focus
2265     *
2266     * @ingroup Focus
2267     */
2268    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2269
2270    /**
2271     * Give focus to near object in one direction.
2272     *
2273     * Give focus to near object in direction of one object.
2274     * If none focusable object in given direction, the focus will not change.
2275     *
2276     * @param obj The reference object
2277     * @param x Horizontal component of direction to focus
2278     * @param y Vertical component of direction to focus
2279     *
2280     * @ingroup Focus
2281     */
2282    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2283
2284    /**
2285     * Make the elementary object and its children to be unfocusable
2286     * (or focusable).
2287     *
2288     * @param obj The Elementary object to operate on
2289     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2290     *        @c EINA_FALSE for focusable.
2291     *
2292     * This sets whether the object @p obj and its children objects
2293     * are able to take focus or not. If the tree is set as unfocusable,
2294     * newest focused object which is not in this tree will get focus.
2295     * This API can be helpful for an object to be deleted.
2296     * When an object will be deleted soon, it and its children may not
2297     * want to get focus (by focus reverting or by other focus controls).
2298     * Then, just use this API before deleting.
2299     *
2300     * @see elm_object_tree_unfocusable_get()
2301     *
2302     * @ingroup Focus
2303     */
2304    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2305
2306    /**
2307     * Get whether an Elementary object and its children are unfocusable or not.
2308     *
2309     * @param obj The Elementary object to get the information from
2310     * @return @c EINA_TRUE, if the tree is unfocussable,
2311     *         @c EINA_FALSE if not (and on errors).
2312     *
2313     * @see elm_object_tree_unfocusable_set()
2314     *
2315     * @ingroup Focus
2316     */
2317    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2318
2319    /**
2320     * @defgroup Scrolling Scrolling
2321     *
2322     * These are functions setting how scrollable views in Elementary
2323     * widgets should behave on user interaction.
2324     *
2325     * @{
2326     */
2327
2328    /**
2329     * Get whether scrollers should bounce when they reach their
2330     * viewport's edge during a scroll.
2331     *
2332     * @return the thumb scroll bouncing state
2333     *
2334     * This is the default behavior for touch screens, in general.
2335     * @ingroup Scrolling
2336     */
2337    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2338
2339    /**
2340     * Set whether scrollers should bounce when they reach their
2341     * viewport's edge during a scroll.
2342     *
2343     * @param enabled the thumb scroll bouncing state
2344     *
2345     * @see elm_thumbscroll_bounce_enabled_get()
2346     * @ingroup Scrolling
2347     */
2348    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2349
2350    /**
2351     * Set whether scrollers should bounce when they reach their
2352     * viewport's edge during a scroll, for all Elementary application
2353     * windows.
2354     *
2355     * @param enabled the thumb scroll bouncing state
2356     *
2357     * @see elm_thumbscroll_bounce_enabled_get()
2358     * @ingroup Scrolling
2359     */
2360    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2361
2362    /**
2363     * Get the amount of inertia a scroller will impose at bounce
2364     * animations.
2365     *
2366     * @return the thumb scroll bounce friction
2367     *
2368     * @ingroup Scrolling
2369     */
2370    EAPI double           elm_scroll_bounce_friction_get(void);
2371
2372    /**
2373     * Set the amount of inertia a scroller will impose at bounce
2374     * animations.
2375     *
2376     * @param friction the thumb scroll bounce friction
2377     *
2378     * @see elm_thumbscroll_bounce_friction_get()
2379     * @ingroup Scrolling
2380     */
2381    EAPI void             elm_scroll_bounce_friction_set(double friction);
2382
2383    /**
2384     * Set the amount of inertia a scroller will impose at bounce
2385     * animations, for all Elementary application windows.
2386     *
2387     * @param friction the thumb scroll bounce friction
2388     *
2389     * @see elm_thumbscroll_bounce_friction_get()
2390     * @ingroup Scrolling
2391     */
2392    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2393
2394    /**
2395     * Get the amount of inertia a <b>paged</b> scroller will impose at
2396     * page fitting animations.
2397     *
2398     * @return the page scroll friction
2399     *
2400     * @ingroup Scrolling
2401     */
2402    EAPI double           elm_scroll_page_scroll_friction_get(void);
2403
2404    /**
2405     * Set the amount of inertia a <b>paged</b> scroller will impose at
2406     * page fitting animations.
2407     *
2408     * @param friction the page scroll friction
2409     *
2410     * @see elm_thumbscroll_page_scroll_friction_get()
2411     * @ingroup Scrolling
2412     */
2413    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2414
2415    /**
2416     * Set the amount of inertia a <b>paged</b> scroller will impose at
2417     * page fitting animations, for all Elementary application windows.
2418     *
2419     * @param friction the page scroll friction
2420     *
2421     * @see elm_thumbscroll_page_scroll_friction_get()
2422     * @ingroup Scrolling
2423     */
2424    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2425
2426    /**
2427     * Get the amount of inertia a scroller will impose at region bring
2428     * animations.
2429     *
2430     * @return the bring in scroll friction
2431     *
2432     * @ingroup Scrolling
2433     */
2434    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2435
2436    /**
2437     * Set the amount of inertia a scroller will impose at region bring
2438     * animations.
2439     *
2440     * @param friction the bring in scroll friction
2441     *
2442     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2443     * @ingroup Scrolling
2444     */
2445    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2446
2447    /**
2448     * Set the amount of inertia a scroller will impose at region bring
2449     * animations, for all Elementary application windows.
2450     *
2451     * @param friction the bring in scroll friction
2452     *
2453     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2454     * @ingroup Scrolling
2455     */
2456    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2457
2458    /**
2459     * Get the amount of inertia scrollers will impose at animations
2460     * triggered by Elementary widgets' zooming API.
2461     *
2462     * @return the zoom friction
2463     *
2464     * @ingroup Scrolling
2465     */
2466    EAPI double           elm_scroll_zoom_friction_get(void);
2467
2468    /**
2469     * Set the amount of inertia scrollers will impose at animations
2470     * triggered by Elementary widgets' zooming API.
2471     *
2472     * @param friction the zoom friction
2473     *
2474     * @see elm_thumbscroll_zoom_friction_get()
2475     * @ingroup Scrolling
2476     */
2477    EAPI void             elm_scroll_zoom_friction_set(double friction);
2478
2479    /**
2480     * Set the amount of inertia scrollers will impose at animations
2481     * triggered by Elementary widgets' zooming API, for all Elementary
2482     * application windows.
2483     *
2484     * @param friction the zoom friction
2485     *
2486     * @see elm_thumbscroll_zoom_friction_get()
2487     * @ingroup Scrolling
2488     */
2489    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2490
2491    /**
2492     * Get whether scrollers should be draggable from any point in their
2493     * views.
2494     *
2495     * @return the thumb scroll state
2496     *
2497     * @note This is the default behavior for touch screens, in general.
2498     * @note All other functions namespaced with "thumbscroll" will only
2499     *       have effect if this mode is enabled.
2500     *
2501     * @ingroup Scrolling
2502     */
2503    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2504
2505    /**
2506     * Set whether scrollers should be draggable from any point in their
2507     * views.
2508     *
2509     * @param enabled the thumb scroll state
2510     *
2511     * @see elm_thumbscroll_enabled_get()
2512     * @ingroup Scrolling
2513     */
2514    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2515
2516    /**
2517     * Set whether scrollers should be draggable from any point in their
2518     * views, for all Elementary application windows.
2519     *
2520     * @param enabled the thumb scroll state
2521     *
2522     * @see elm_thumbscroll_enabled_get()
2523     * @ingroup Scrolling
2524     */
2525    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2526
2527    /**
2528     * Get the number of pixels one should travel while dragging a
2529     * scroller's view to actually trigger scrolling.
2530     *
2531     * @return the thumb scroll threshould
2532     *
2533     * One would use higher values for touch screens, in general, because
2534     * of their inherent imprecision.
2535     * @ingroup Scrolling
2536     */
2537    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2538
2539    /**
2540     * Set the number of pixels one should travel while dragging a
2541     * scroller's view to actually trigger scrolling.
2542     *
2543     * @param threshold the thumb scroll threshould
2544     *
2545     * @see elm_thumbscroll_threshould_get()
2546     * @ingroup Scrolling
2547     */
2548    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2549
2550    /**
2551     * Set the number of pixels one should travel while dragging a
2552     * scroller's view to actually trigger scrolling, for all Elementary
2553     * application windows.
2554     *
2555     * @param threshold the thumb scroll threshould
2556     *
2557     * @see elm_thumbscroll_threshould_get()
2558     * @ingroup Scrolling
2559     */
2560    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2561
2562    /**
2563     * Get the minimum speed of mouse cursor movement which will trigger
2564     * list self scrolling animation after a mouse up event
2565     * (pixels/second).
2566     *
2567     * @return the thumb scroll momentum threshould
2568     *
2569     * @ingroup Scrolling
2570     */
2571    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2572
2573    /**
2574     * Set the minimum speed of mouse cursor movement which will trigger
2575     * list self scrolling animation after a mouse up event
2576     * (pixels/second).
2577     *
2578     * @param threshold the thumb scroll momentum threshould
2579     *
2580     * @see elm_thumbscroll_momentum_threshould_get()
2581     * @ingroup Scrolling
2582     */
2583    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2584
2585    /**
2586     * Set the minimum speed of mouse cursor movement which will trigger
2587     * list self scrolling animation after a mouse up event
2588     * (pixels/second), for all Elementary application windows.
2589     *
2590     * @param threshold the thumb scroll momentum threshould
2591     *
2592     * @see elm_thumbscroll_momentum_threshould_get()
2593     * @ingroup Scrolling
2594     */
2595    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2596
2597    /**
2598     * Get the amount of inertia a scroller will impose at self scrolling
2599     * animations.
2600     *
2601     * @return the thumb scroll friction
2602     *
2603     * @ingroup Scrolling
2604     */
2605    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2606
2607    /**
2608     * Set the amount of inertia a scroller will impose at self scrolling
2609     * animations.
2610     *
2611     * @param friction the thumb scroll friction
2612     *
2613     * @see elm_thumbscroll_friction_get()
2614     * @ingroup Scrolling
2615     */
2616    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2617
2618    /**
2619     * Set the amount of inertia a scroller will impose at self scrolling
2620     * animations, for all Elementary application windows.
2621     *
2622     * @param friction the thumb scroll friction
2623     *
2624     * @see elm_thumbscroll_friction_get()
2625     * @ingroup Scrolling
2626     */
2627    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2628
2629    /**
2630     * Get the amount of lag between your actual mouse cursor dragging
2631     * movement and a scroller's view movement itself, while pushing it
2632     * into bounce state manually.
2633     *
2634     * @return the thumb scroll border friction
2635     *
2636     * @ingroup Scrolling
2637     */
2638    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2639
2640    /**
2641     * Set the amount of lag between your actual mouse cursor dragging
2642     * movement and a scroller's view movement itself, while pushing it
2643     * into bounce state manually.
2644     *
2645     * @param friction the thumb scroll border friction. @c 0.0 for
2646     *        perfect synchrony between two movements, @c 1.0 for maximum
2647     *        lag.
2648     *
2649     * @see elm_thumbscroll_border_friction_get()
2650     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2651     *
2652     * @ingroup Scrolling
2653     */
2654    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2655
2656    /**
2657     * Set the amount of lag between your actual mouse cursor dragging
2658     * movement and a scroller's view movement itself, while pushing it
2659     * into bounce state manually, for all Elementary application windows.
2660     *
2661     * @param friction the thumb scroll border friction. @c 0.0 for
2662     *        perfect synchrony between two movements, @c 1.0 for maximum
2663     *        lag.
2664     *
2665     * @see elm_thumbscroll_border_friction_get()
2666     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2667     *
2668     * @ingroup Scrolling
2669     */
2670    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2671
2672    /**
2673     * @}
2674     */
2675
2676    /**
2677     * @defgroup Scrollhints Scrollhints
2678     *
2679     * Objects when inside a scroller can scroll, but this may not always be
2680     * desirable in certain situations. This allows an object to hint to itself
2681     * and parents to "not scroll" in one of 2 ways. If any child object of a
2682     * scroller has pushed a scroll freeze or hold then it affects all parent
2683     * scrollers until all children have released them.
2684     *
2685     * 1. To hold on scrolling. This means just flicking and dragging may no
2686     * longer scroll, but pressing/dragging near an edge of the scroller will
2687     * still scroll. This is automatically used by the entry object when
2688     * selecting text.
2689     *
2690     * 2. To totally freeze scrolling. This means it stops. until
2691     * popped/released.
2692     *
2693     * @{
2694     */
2695
2696    /**
2697     * Push the scroll hold by 1
2698     *
2699     * This increments the scroll hold count by one. If it is more than 0 it will
2700     * take effect on the parents of the indicated object.
2701     *
2702     * @param obj The object
2703     * @ingroup Scrollhints
2704     */
2705    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2706
2707    /**
2708     * Pop the scroll hold by 1
2709     *
2710     * This decrements the scroll hold count by one. If it is more than 0 it will
2711     * take effect on the parents of the indicated object.
2712     *
2713     * @param obj The object
2714     * @ingroup Scrollhints
2715     */
2716    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2717
2718    /**
2719     * Push the scroll freeze by 1
2720     *
2721     * This increments the scroll freeze count by one. If it is more
2722     * than 0 it will take effect on the parents of the indicated
2723     * object.
2724     *
2725     * @param obj The object
2726     * @ingroup Scrollhints
2727     */
2728    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2729
2730    /**
2731     * Pop the scroll freeze by 1
2732     *
2733     * This decrements the scroll freeze count by one. If it is more
2734     * than 0 it will take effect on the parents of the indicated
2735     * object.
2736     *
2737     * @param obj The object
2738     * @ingroup Scrollhints
2739     */
2740    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2741
2742    /**
2743     * Lock the scrolling of the given widget (and thus all parents)
2744     *
2745     * This locks the given object from scrolling in the X axis (and implicitly
2746     * also locks all parent scrollers too from doing the same).
2747     *
2748     * @param obj The object
2749     * @param lock The lock state (1 == locked, 0 == unlocked)
2750     * @ingroup Scrollhints
2751     */
2752    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2753
2754    /**
2755     * Lock the scrolling of the given widget (and thus all parents)
2756     *
2757     * This locks the given object from scrolling in the Y axis (and implicitly
2758     * also locks all parent scrollers too from doing the same).
2759     *
2760     * @param obj The object
2761     * @param lock The lock state (1 == locked, 0 == unlocked)
2762     * @ingroup Scrollhints
2763     */
2764    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2765
2766    /**
2767     * Get the scrolling lock of the given widget
2768     *
2769     * This gets the lock for X axis scrolling.
2770     *
2771     * @param obj The object
2772     * @ingroup Scrollhints
2773     */
2774    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2775
2776    /**
2777     * Get the scrolling lock of the given widget
2778     *
2779     * This gets the lock for X axis scrolling.
2780     *
2781     * @param obj The object
2782     * @ingroup Scrollhints
2783     */
2784    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2785
2786    /**
2787     * @}
2788     */
2789
2790    /**
2791     * Send a signal to the widget edje object.
2792     *
2793     * This function sends a signal to the edje object of the obj. An
2794     * edje program can respond to a signal by specifying matching
2795     * 'signal' and 'source' fields.
2796     *
2797     * @param obj The object
2798     * @param emission The signal's name.
2799     * @param source The signal's source.
2800     * @ingroup General
2801     */
2802    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2803
2804    /**
2805     * Add a callback for a signal emitted by widget edje object.
2806     *
2807     * This function connects a callback function to a signal emitted by the
2808     * edje object of the obj.
2809     * Globs can occur in either the emission or source name.
2810     *
2811     * @param obj The object
2812     * @param emission The signal's name.
2813     * @param source The signal's source.
2814     * @param func The callback function to be executed when the signal is
2815     * emitted.
2816     * @param data A pointer to data to pass in to the callback function.
2817     * @ingroup General
2818     */
2819    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);
2820
2821    /**
2822     * Remove a signal-triggered callback from an widget edje object.
2823     *
2824     * This function removes a callback, previoulsy attached to a
2825     * signal emitted by the edje object of the obj.  The parameters
2826     * emission, source and func must match exactly those passed to a
2827     * previous call to elm_object_signal_callback_add(). The data
2828     * pointer that was passed to this call will be returned.
2829     *
2830     * @param obj The object
2831     * @param emission The signal's name.
2832     * @param source The signal's source.
2833     * @param func The callback function to be executed when the signal is
2834     * emitted.
2835     * @return The data pointer
2836     * @ingroup General
2837     */
2838    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);
2839
2840    /**
2841     * Add a callback for input events (key up, key down, mouse wheel)
2842     * on a given Elementary widget
2843     *
2844     * @param obj The widget to add an event callback on
2845     * @param func The callback function to be executed when the event
2846     * happens
2847     * @param data Data to pass in to @p func
2848     *
2849     * Every widget in an Elementary interface set to receive focus,
2850     * with elm_object_focus_allow_set(), will propagate @b all of its
2851     * key up, key down and mouse wheel input events up to its parent
2852     * object, and so on. All of the focusable ones in this chain which
2853     * had an event callback set, with this call, will be able to treat
2854     * those events. There are two ways of making the propagation of
2855     * these event upwards in the tree of widgets to @b cease:
2856     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2857     *   the event was @b not processed, so the propagation will go on.
2858     * - The @c event_info pointer passed to @p func will contain the
2859     *   event's structure and, if you OR its @c event_flags inner
2860     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2861     *   one has already handled it, thus killing the event's
2862     *   propagation, too.
2863     *
2864     * @note Your event callback will be issued on those events taking
2865     * place only if no other child widget of @obj has consumed the
2866     * event already.
2867     *
2868     * @note Not to be confused with @c
2869     * evas_object_event_callback_add(), which will add event callbacks
2870     * per type on general Evas objects (no event propagation
2871     * infrastructure taken in account).
2872     *
2873     * @note Not to be confused with @c
2874     * elm_object_signal_callback_add(), which will add callbacks to @b
2875     * signals coming from a widget's theme, not input events.
2876     *
2877     * @note Not to be confused with @c
2878     * edje_object_signal_callback_add(), which does the same as
2879     * elm_object_signal_callback_add(), but directly on an Edje
2880     * object.
2881     *
2882     * @note Not to be confused with @c
2883     * evas_object_smart_callback_add(), which adds callbacks to smart
2884     * objects' <b>smart events</b>, and not input events.
2885     *
2886     * @see elm_object_event_callback_del()
2887     *
2888     * @ingroup General
2889     */
2890    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2891
2892    /**
2893
2894
2895    /**
2896     * Remove a event callback from an widget.
2897     *
2898     * This function removes a callback, previoulsy attached to event emission
2899     * by the @p obj.
2900     * The parameters func and data must match exactly those passed to
2901     * a previous call to elm_object_event_callback_add(). The data pointer that
2902     * was passed to this call will be returned.
2903     *
2904     * @param obj The object
2905     * @param func The callback function to be executed when the event is
2906     * emitted.
2907     * @param data Data to pass in to the callback function.
2908     * @return The data pointer
2909     * @ingroup General
2910     */
2911    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2912
2913    /**
2914     * Adjust size of an element for finger usage.
2915     *
2916     * @param times_w How many fingers should fit horizontally
2917     * @param w Pointer to the width size to adjust
2918     * @param times_h How many fingers should fit vertically
2919     * @param h Pointer to the height size to adjust
2920     *
2921     * This takes width and height sizes (in pixels) as input and a
2922     * size multiple (which is how many fingers you want to place
2923     * within the area, being "finger" the size set by
2924     * elm_finger_size_set()), and adjusts the size to be large enough
2925     * to accommodate the resulting size -- if it doesn't already
2926     * accommodate it. On return the @p w and @p h sizes pointed to by
2927     * these parameters will be modified, on those conditions.
2928     *
2929     * @note This is kind of a low level Elementary call, most useful
2930     * on size evaluation times for widgets. An external user wouldn't
2931     * be calling, most of the time.
2932     *
2933     * @ingroup Fingers
2934     */
2935    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2936
2937    /**
2938     * Get the duration for occuring long press event.
2939     *
2940     * @return Timeout for long press event
2941     * @ingroup Longpress
2942     */
2943    EAPI double           elm_longpress_timeout_get(void);
2944
2945    /**
2946     * Set the duration for occuring long press event.
2947     *
2948     * @param lonpress_timeout Timeout for long press event
2949     * @ingroup Longpress
2950     */
2951    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
2952
2953    /**
2954     * @defgroup Debug Debug
2955     * don't use it unless you are sure
2956     *
2957     * @{
2958     */
2959
2960    /**
2961     * Print Tree object hierarchy in stdout
2962     *
2963     * @param obj The root object
2964     * @ingroup Debug
2965     */
2966    EAPI void             elm_object_tree_dump(const Evas_Object *top);
2967
2968    /**
2969     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2970     *
2971     * @param obj The root object
2972     * @param file The path of output file
2973     * @ingroup Debug
2974     */
2975    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2976
2977    /**
2978     * @}
2979     */
2980
2981    /**
2982     * @defgroup Theme Theme
2983     *
2984     * Elementary uses Edje to theme its widgets, naturally. But for the most
2985     * part this is hidden behind a simpler interface that lets the user set
2986     * extensions and choose the style of widgets in a much easier way.
2987     *
2988     * Instead of thinking in terms of paths to Edje files and their groups
2989     * each time you want to change the appearance of a widget, Elementary
2990     * works so you can add any theme file with extensions or replace the
2991     * main theme at one point in the application, and then just set the style
2992     * of widgets with elm_object_style_set() and related functions. Elementary
2993     * will then look in its list of themes for a matching group and apply it,
2994     * and when the theme changes midway through the application, all widgets
2995     * will be updated accordingly.
2996     *
2997     * There are three concepts you need to know to understand how Elementary
2998     * theming works: default theme, extensions and overlays.
2999     *
3000     * Default theme, obviously enough, is the one that provides the default
3001     * look of all widgets. End users can change the theme used by Elementary
3002     * by setting the @c ELM_THEME environment variable before running an
3003     * application, or globally for all programs using the @c elementary_config
3004     * utility. Applications can change the default theme using elm_theme_set(),
3005     * but this can go against the user wishes, so it's not an adviced practice.
3006     *
3007     * Ideally, applications should find everything they need in the already
3008     * provided theme, but there may be occasions when that's not enough and
3009     * custom styles are required to correctly express the idea. For this
3010     * cases, Elementary has extensions.
3011     *
3012     * Extensions allow the application developer to write styles of its own
3013     * to apply to some widgets. This requires knowledge of how each widget
3014     * is themed, as extensions will always replace the entire group used by
3015     * the widget, so important signals and parts need to be there for the
3016     * object to behave properly (see documentation of Edje for details).
3017     * Once the theme for the extension is done, the application needs to add
3018     * it to the list of themes Elementary will look into, using
3019     * elm_theme_extension_add(), and set the style of the desired widgets as
3020     * he would normally with elm_object_style_set().
3021     *
3022     * Overlays, on the other hand, can replace the look of all widgets by
3023     * overriding the default style. Like extensions, it's up to the application
3024     * developer to write the theme for the widgets it wants, the difference
3025     * being that when looking for the theme, Elementary will check first the
3026     * list of overlays, then the set theme and lastly the list of extensions,
3027     * so with overlays it's possible to replace the default view and every
3028     * widget will be affected. This is very much alike to setting the whole
3029     * theme for the application and will probably clash with the end user
3030     * options, not to mention the risk of ending up with not matching styles
3031     * across the program. Unless there's a very special reason to use them,
3032     * overlays should be avoided for the resons exposed before.
3033     *
3034     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3035     * keeps one default internally and every function that receives one of
3036     * these can be called with NULL to refer to this default (except for
3037     * elm_theme_free()). It's possible to create a new instance of a
3038     * ::Elm_Theme to set other theme for a specific widget (and all of its
3039     * children), but this is as discouraged, if not even more so, than using
3040     * overlays. Don't use this unless you really know what you are doing.
3041     *
3042     * But to be less negative about things, you can look at the following
3043     * examples:
3044     * @li @ref theme_example_01 "Using extensions"
3045     * @li @ref theme_example_02 "Using overlays"
3046     *
3047     * @{
3048     */
3049    /**
3050     * @typedef Elm_Theme
3051     *
3052     * Opaque handler for the list of themes Elementary looks for when
3053     * rendering widgets.
3054     *
3055     * Stay out of this unless you really know what you are doing. For most
3056     * cases, sticking to the default is all a developer needs.
3057     */
3058    typedef struct _Elm_Theme Elm_Theme;
3059
3060    /**
3061     * Create a new specific theme
3062     *
3063     * This creates an empty specific theme that only uses the default theme. A
3064     * specific theme has its own private set of extensions and overlays too
3065     * (which are empty by default). Specific themes do not fall back to themes
3066     * of parent objects. They are not intended for this use. Use styles, overlays
3067     * and extensions when needed, but avoid specific themes unless there is no
3068     * other way (example: you want to have a preview of a new theme you are
3069     * selecting in a "theme selector" window. The preview is inside a scroller
3070     * and should display what the theme you selected will look like, but not
3071     * actually apply it yet. The child of the scroller will have a specific
3072     * theme set to show this preview before the user decides to apply it to all
3073     * applications).
3074     */
3075    EAPI Elm_Theme       *elm_theme_new(void);
3076    /**
3077     * Free a specific theme
3078     *
3079     * @param th The theme to free
3080     *
3081     * This frees a theme created with elm_theme_new().
3082     */
3083    EAPI void             elm_theme_free(Elm_Theme *th);
3084    /**
3085     * Copy the theme fom the source to the destination theme
3086     *
3087     * @param th The source theme to copy from
3088     * @param thdst The destination theme to copy data to
3089     *
3090     * This makes a one-time static copy of all the theme config, extensions
3091     * and overlays from @p th to @p thdst. If @p th references a theme, then
3092     * @p thdst is also set to reference it, with all the theme settings,
3093     * overlays and extensions that @p th had.
3094     */
3095    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3096    /**
3097     * Tell the source theme to reference the ref theme
3098     *
3099     * @param th The theme that will do the referencing
3100     * @param thref The theme that is the reference source
3101     *
3102     * This clears @p th to be empty and then sets it to refer to @p thref
3103     * so @p th acts as an override to @p thref, but where its overrides
3104     * don't apply, it will fall through to @p thref for configuration.
3105     */
3106    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3107    /**
3108     * Return the theme referred to
3109     *
3110     * @param th The theme to get the reference from
3111     * @return The referenced theme handle
3112     *
3113     * This gets the theme set as the reference theme by elm_theme_ref_set().
3114     * If no theme is set as a reference, NULL is returned.
3115     */
3116    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3117    /**
3118     * Return the default theme
3119     *
3120     * @return The default theme handle
3121     *
3122     * This returns the internal default theme setup handle that all widgets
3123     * use implicitly unless a specific theme is set. This is also often use
3124     * as a shorthand of NULL.
3125     */
3126    EAPI Elm_Theme       *elm_theme_default_get(void);
3127    /**
3128     * Prepends a theme overlay to the list of overlays
3129     *
3130     * @param th The theme to add to, or if NULL, the default theme
3131     * @param item The Edje file path to be used
3132     *
3133     * Use this if your application needs to provide some custom overlay theme
3134     * (An Edje file that replaces some default styles of widgets) where adding
3135     * new styles, or changing system theme configuration is not possible. Do
3136     * NOT use this instead of a proper system theme configuration. Use proper
3137     * configuration files, profiles, environment variables etc. to set a theme
3138     * so that the theme can be altered by simple confiugration by a user. Using
3139     * this call to achieve that effect is abusing the API and will create lots
3140     * of trouble.
3141     *
3142     * @see elm_theme_extension_add()
3143     */
3144    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3145    /**
3146     * Delete a theme overlay from the list of overlays
3147     *
3148     * @param th The theme to delete from, or if NULL, the default theme
3149     * @param item The name of the theme overlay
3150     *
3151     * @see elm_theme_overlay_add()
3152     */
3153    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3154    /**
3155     * Appends a theme extension to the list of extensions.
3156     *
3157     * @param th The theme to add to, or if NULL, the default theme
3158     * @param item The Edje file path to be used
3159     *
3160     * This is intended when an application needs more styles of widgets or new
3161     * widget themes that the default does not provide (or may not provide). The
3162     * application has "extended" usage by coming up with new custom style names
3163     * for widgets for specific uses, but as these are not "standard", they are
3164     * not guaranteed to be provided by a default theme. This means the
3165     * application is required to provide these extra elements itself in specific
3166     * Edje files. This call adds one of those Edje files to the theme search
3167     * path to be search after the default theme. The use of this call is
3168     * encouraged when default styles do not meet the needs of the application.
3169     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3170     *
3171     * @see elm_object_style_set()
3172     */
3173    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3174    /**
3175     * Deletes a theme extension from the list of extensions.
3176     *
3177     * @param th The theme to delete from, or if NULL, the default theme
3178     * @param item The name of the theme extension
3179     *
3180     * @see elm_theme_extension_add()
3181     */
3182    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3183    /**
3184     * Set the theme search order for the given theme
3185     *
3186     * @param th The theme to set the search order, or if NULL, the default theme
3187     * @param theme Theme search string
3188     *
3189     * This sets the search string for the theme in path-notation from first
3190     * theme to search, to last, delimited by the : character. Example:
3191     *
3192     * "shiny:/path/to/file.edj:default"
3193     *
3194     * See the ELM_THEME environment variable for more information.
3195     *
3196     * @see elm_theme_get()
3197     * @see elm_theme_list_get()
3198     */
3199    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3200    /**
3201     * Return the theme search order
3202     *
3203     * @param th The theme to get the search order, or if NULL, the default theme
3204     * @return The internal search order path
3205     *
3206     * This function returns a colon separated string of theme elements as
3207     * returned by elm_theme_list_get().
3208     *
3209     * @see elm_theme_set()
3210     * @see elm_theme_list_get()
3211     */
3212    EAPI const char      *elm_theme_get(Elm_Theme *th);
3213    /**
3214     * Return a list of theme elements to be used in a theme.
3215     *
3216     * @param th Theme to get the list of theme elements from.
3217     * @return The internal list of theme elements
3218     *
3219     * This returns the internal list of theme elements (will only be valid as
3220     * long as the theme is not modified by elm_theme_set() or theme is not
3221     * freed by elm_theme_free(). This is a list of strings which must not be
3222     * altered as they are also internal. If @p th is NULL, then the default
3223     * theme element list is returned.
3224     *
3225     * A theme element can consist of a full or relative path to a .edj file,
3226     * or a name, without extension, for a theme to be searched in the known
3227     * theme paths for Elemementary.
3228     *
3229     * @see elm_theme_set()
3230     * @see elm_theme_get()
3231     */
3232    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3233    /**
3234     * Return the full patrh for a theme element
3235     *
3236     * @param f The theme element name
3237     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3238     * @return The full path to the file found.
3239     *
3240     * This returns a string you should free with free() on success, NULL on
3241     * failure. This will search for the given theme element, and if it is a
3242     * full or relative path element or a simple searchable name. The returned
3243     * path is the full path to the file, if searched, and the file exists, or it
3244     * is simply the full path given in the element or a resolved path if
3245     * relative to home. The @p in_search_path boolean pointed to is set to
3246     * EINA_TRUE if the file was a searchable file andis in the search path,
3247     * and EINA_FALSE otherwise.
3248     */
3249    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3250    /**
3251     * Flush the current theme.
3252     *
3253     * @param th Theme to flush
3254     *
3255     * This flushes caches that let elementary know where to find theme elements
3256     * in the given theme. If @p th is NULL, then the default theme is flushed.
3257     * Call this function if source theme data has changed in such a way as to
3258     * make any caches Elementary kept invalid.
3259     */
3260    EAPI void             elm_theme_flush(Elm_Theme *th);
3261    /**
3262     * This flushes all themes (default and specific ones).
3263     *
3264     * This will flush all themes in the current application context, by calling
3265     * elm_theme_flush() on each of them.
3266     */
3267    EAPI void             elm_theme_full_flush(void);
3268    /**
3269     * Set the theme for all elementary using applications on the current display
3270     *
3271     * @param theme The name of the theme to use. Format same as the ELM_THEME
3272     * environment variable.
3273     */
3274    EAPI void             elm_theme_all_set(const char *theme);
3275    /**
3276     * Return a list of theme elements in the theme search path
3277     *
3278     * @return A list of strings that are the theme element names.
3279     *
3280     * This lists all available theme files in the standard Elementary search path
3281     * for theme elements, and returns them in alphabetical order as theme
3282     * element names in a list of strings. Free this with
3283     * elm_theme_name_available_list_free() when you are done with the list.
3284     */
3285    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3286    /**
3287     * Free the list returned by elm_theme_name_available_list_new()
3288     *
3289     * This frees the list of themes returned by
3290     * elm_theme_name_available_list_new(). Once freed the list should no longer
3291     * be used. a new list mys be created.
3292     */
3293    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3294    /**
3295     * Set a specific theme to be used for this object and its children
3296     *
3297     * @param obj The object to set the theme on
3298     * @param th The theme to set
3299     *
3300     * This sets a specific theme that will be used for the given object and any
3301     * child objects it has. If @p th is NULL then the theme to be used is
3302     * cleared and the object will inherit its theme from its parent (which
3303     * ultimately will use the default theme if no specific themes are set).
3304     *
3305     * Use special themes with great care as this will annoy users and make
3306     * configuration difficult. Avoid any custom themes at all if it can be
3307     * helped.
3308     */
3309    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3310    /**
3311     * Get the specific theme to be used
3312     *
3313     * @param obj The object to get the specific theme from
3314     * @return The specifc theme set.
3315     *
3316     * This will return a specific theme set, or NULL if no specific theme is
3317     * set on that object. It will not return inherited themes from parents, only
3318     * the specific theme set for that specific object. See elm_object_theme_set()
3319     * for more information.
3320     */
3321    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3322    /**
3323     * @}
3324     */
3325
3326    /* win */
3327    /** @defgroup Win Win
3328     *
3329     * @image html img/widget/win/preview-00.png
3330     * @image latex img/widget/win/preview-00.eps
3331     *
3332     * The window class of Elementary.  Contains functions to manipulate
3333     * windows. The Evas engine used to render the window contents is specified
3334     * in the system or user elementary config files (whichever is found last),
3335     * and can be overridden with the ELM_ENGINE environment variable for
3336     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3337     * compilation setup and modules actually installed at runtime) are (listed
3338     * in order of best supported and most likely to be complete and work to
3339     * lowest quality).
3340     *
3341     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3342     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3343     * rendering in X11)
3344     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3345     * exits)
3346     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3347     * rendering)
3348     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3349     * buffer)
3350     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3351     * rendering using SDL as the buffer)
3352     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3353     * GDI with software)
3354     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3355     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3356     * grayscale using dedicated 8bit software engine in X11)
3357     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3358     * X11 using 16bit software engine)
3359     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3360     * (Windows CE rendering via GDI with 16bit software renderer)
3361     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3362     * buffer with 16bit software renderer)
3363     *
3364     * All engines use a simple string to select the engine to render, EXCEPT
3365     * the "shot" engine. This actually encodes the output of the virtual
3366     * screenshot and how long to delay in the engine string. The engine string
3367     * is encoded in the following way:
3368     *
3369     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3370     *
3371     * Where options are separated by a ":" char if more than one option is
3372     * given, with delay, if provided being the first option and file the last
3373     * (order is important). The delay specifies how long to wait after the
3374     * window is shown before doing the virtual "in memory" rendering and then
3375     * save the output to the file specified by the file option (and then exit).
3376     * If no delay is given, the default is 0.5 seconds. If no file is given the
3377     * default output file is "out.png". Repeat option is for continous
3378     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3379     * fixed to "out001.png" Some examples of using the shot engine:
3380     *
3381     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3382     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3383     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3384     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3385     *   ELM_ENGINE="shot:" elementary_test
3386     *
3387     * Signals that you can add callbacks for are:
3388     *
3389     * @li "delete,request": the user requested to close the window. See
3390     * elm_win_autodel_set().
3391     * @li "focus,in": window got focus
3392     * @li "focus,out": window lost focus
3393     * @li "moved": window that holds the canvas was moved
3394     *
3395     * Examples:
3396     * @li @ref win_example_01
3397     *
3398     * @{
3399     */
3400    /**
3401     * Defines the types of window that can be created
3402     *
3403     * These are hints set on the window so that a running Window Manager knows
3404     * how the window should be handled and/or what kind of decorations it
3405     * should have.
3406     *
3407     * Currently, only the X11 backed engines use them.
3408     */
3409    typedef enum _Elm_Win_Type
3410      {
3411         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3412                          window. Almost every window will be created with this
3413                          type. */
3414         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3415         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3416                            window holding desktop icons. */
3417         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3418                         be kept on top of any other window by the Window
3419                         Manager. */
3420         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3421                            similar. */
3422         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3423         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3424                            pallete. */
3425         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3426         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3427                                  entry in a menubar is clicked. Typically used
3428                                  with elm_win_override_set(). This hint exists
3429                                  for completion only, as the EFL way of
3430                                  implementing a menu would not normally use a
3431                                  separate window for its contents. */
3432         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3433                               triggered by right-clicking an object. */
3434         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3435                            explanatory text that typically appear after the
3436                            mouse cursor hovers over an object for a while.
3437                            Typically used with elm_win_override_set() and also
3438                            not very commonly used in the EFL. */
3439         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3440                                 battery life or a new E-Mail received. */
3441         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3442                          usually used in the EFL. */
3443         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3444                        object being dragged across different windows, or even
3445                        applications. Typically used with
3446                        elm_win_override_set(). */
3447         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3448                                  buffer. No actual window is created for this
3449                                  type, instead the window and all of its
3450                                  contents will be rendered to an image buffer.
3451                                  This allows to have children window inside a
3452                                  parent one just like any other object would
3453                                  be, and do other things like applying @c
3454                                  Evas_Map effects to it. This is the only type
3455                                  of window that requires the @c parent
3456                                  parameter of elm_win_add() to be a valid @c
3457                                  Evas_Object. */
3458      } Elm_Win_Type;
3459
3460    /**
3461     * The differents layouts that can be requested for the virtual keyboard.
3462     *
3463     * When the application window is being managed by Illume, it may request
3464     * any of the following layouts for the virtual keyboard.
3465     */
3466    typedef enum _Elm_Win_Keyboard_Mode
3467      {
3468         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3469         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3470         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3471         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3472         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3473         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3474         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3475         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3476         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3477         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3478         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3479         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3480         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3481         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3482         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3483         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3484      } Elm_Win_Keyboard_Mode;
3485
3486    /**
3487     * Available commands that can be sent to the Illume manager.
3488     *
3489     * When running under an Illume session, a window may send commands to the
3490     * Illume manager to perform different actions.
3491     */
3492    typedef enum _Elm_Illume_Command
3493      {
3494         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3495                                          window */
3496         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3497                                             in the list */
3498         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3499                                          screen */
3500         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3501      } Elm_Illume_Command;
3502
3503    /**
3504     * Adds a window object. If this is the first window created, pass NULL as
3505     * @p parent.
3506     *
3507     * @param parent Parent object to add the window to, or NULL
3508     * @param name The name of the window
3509     * @param type The window type, one of #Elm_Win_Type.
3510     *
3511     * The @p parent paramter can be @c NULL for every window @p type except
3512     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3513     * which the image object will be created.
3514     *
3515     * @return The created object, or NULL on failure
3516     */
3517    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3518    /**
3519     * Add @p subobj as a resize object of window @p obj.
3520     *
3521     *
3522     * Setting an object as a resize object of the window means that the
3523     * @p subobj child's size and position will be controlled by the window
3524     * directly. That is, the object will be resized to match the window size
3525     * and should never be moved or resized manually by the developer.
3526     *
3527     * In addition, resize objects of the window control what the minimum size
3528     * of it will be, as well as whether it can or not be resized by the user.
3529     *
3530     * For the end user to be able to resize a window by dragging the handles
3531     * or borders provided by the Window Manager, or using any other similar
3532     * mechanism, all of the resize objects in the window should have their
3533     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3534     *
3535     * @param obj The window object
3536     * @param subobj The resize object to add
3537     */
3538    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3539    /**
3540     * Delete @p subobj as a resize object of window @p obj.
3541     *
3542     * This function removes the object @p subobj from the resize objects of
3543     * the window @p obj. It will not delete the object itself, which will be
3544     * left unmanaged and should be deleted by the developer, manually handled
3545     * or set as child of some other container.
3546     *
3547     * @param obj The window object
3548     * @param subobj The resize object to add
3549     */
3550    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3551    /**
3552     * Set the title of the window
3553     *
3554     * @param obj The window object
3555     * @param title The title to set
3556     */
3557    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3558    /**
3559     * Get the title of the window
3560     *
3561     * The returned string is an internal one and should not be freed or
3562     * modified. It will also be rendered invalid if a new title is set or if
3563     * the window is destroyed.
3564     *
3565     * @param obj The window object
3566     * @return The title
3567     */
3568    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3569    /**
3570     * Set the window's autodel state.
3571     *
3572     * When closing the window in any way outside of the program control, like
3573     * pressing the X button in the titlebar or using a command from the
3574     * Window Manager, a "delete,request" signal is emitted to indicate that
3575     * this event occurred and the developer can take any action, which may
3576     * include, or not, destroying the window object.
3577     *
3578     * When the @p autodel parameter is set, the window will be automatically
3579     * destroyed when this event occurs, after the signal is emitted.
3580     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3581     * and is up to the program to do so when it's required.
3582     *
3583     * @param obj The window object
3584     * @param autodel If true, the window will automatically delete itself when
3585     * closed
3586     */
3587    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3588    /**
3589     * Get the window's autodel state.
3590     *
3591     * @param obj The window object
3592     * @return If the window will automatically delete itself when closed
3593     *
3594     * @see elm_win_autodel_set()
3595     */
3596    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3597    /**
3598     * Activate a window object.
3599     *
3600     * This function sends a request to the Window Manager to activate the
3601     * window pointed by @p obj. If honored by the WM, the window will receive
3602     * the keyboard focus.
3603     *
3604     * @note This is just a request that a Window Manager may ignore, so calling
3605     * this function does not ensure in any way that the window will be the
3606     * active one after it.
3607     *
3608     * @param obj The window object
3609     */
3610    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3611    /**
3612     * Lower a window object.
3613     *
3614     * Places the window pointed by @p obj at the bottom of the stack, so that
3615     * no other window is covered by it.
3616     *
3617     * If elm_win_override_set() is not set, the Window Manager may ignore this
3618     * request.
3619     *
3620     * @param obj The window object
3621     */
3622    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3623    /**
3624     * Raise a window object.
3625     *
3626     * Places the window pointed by @p obj at the top of the stack, so that it's
3627     * not covered by any other window.
3628     *
3629     * If elm_win_override_set() is not set, the Window Manager may ignore this
3630     * request.
3631     *
3632     * @param obj The window object
3633     */
3634    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3635    /**
3636     * Set the borderless state of a window.
3637     *
3638     * This function requests the Window Manager to not draw any decoration
3639     * around the window.
3640     *
3641     * @param obj The window object
3642     * @param borderless If true, the window is borderless
3643     */
3644    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3645    /**
3646     * Get the borderless state of a window.
3647     *
3648     * @param obj The window object
3649     * @return If true, the window is borderless
3650     */
3651    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3652    /**
3653     * Set the shaped state of a window.
3654     *
3655     * Shaped windows, when supported, will render the parts of the window that
3656     * has no content, transparent.
3657     *
3658     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3659     * background object or cover the entire window in any other way, or the
3660     * parts of the canvas that have no data will show framebuffer artifacts.
3661     *
3662     * @param obj The window object
3663     * @param shaped If true, the window is shaped
3664     *
3665     * @see elm_win_alpha_set()
3666     */
3667    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3668    /**
3669     * Get the shaped state of a window.
3670     *
3671     * @param obj The window object
3672     * @return If true, the window is shaped
3673     *
3674     * @see elm_win_shaped_set()
3675     */
3676    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3677    /**
3678     * Set the alpha channel state of a window.
3679     *
3680     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3681     * possibly making parts of the window completely or partially transparent.
3682     * This is also subject to the underlying system supporting it, like for
3683     * example, running under a compositing manager. If no compositing is
3684     * available, enabling this option will instead fallback to using shaped
3685     * windows, with elm_win_shaped_set().
3686     *
3687     * @param obj The window object
3688     * @param alpha If true, the window has an alpha channel
3689     *
3690     * @see elm_win_alpha_set()
3691     */
3692    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3693    /**
3694     * Get the transparency state of a window.
3695     *
3696     * @param obj The window object
3697     * @return If true, the window is transparent
3698     *
3699     * @see elm_win_transparent_set()
3700     */
3701    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3702    /**
3703     * Set the transparency state of a window.
3704     *
3705     * Use elm_win_alpha_set() instead.
3706     *
3707     * @param obj The window object
3708     * @param transparent If true, the window is transparent
3709     *
3710     * @see elm_win_alpha_set()
3711     */
3712    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3713    /**
3714     * Get the alpha channel state of a window.
3715     *
3716     * @param obj The window object
3717     * @return If true, the window has an alpha channel
3718     */
3719    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3720    /**
3721     * Set the override state of a window.
3722     *
3723     * A window with @p override set to EINA_TRUE will not be managed by the
3724     * Window Manager. This means that no decorations of any kind will be shown
3725     * for it, moving and resizing must be handled by the application, as well
3726     * as the window visibility.
3727     *
3728     * This should not be used for normal windows, and even for not so normal
3729     * ones, it should only be used when there's a good reason and with a lot
3730     * of care. Mishandling override windows may result situations that
3731     * disrupt the normal workflow of the end user.
3732     *
3733     * @param obj The window object
3734     * @param override If true, the window is overridden
3735     */
3736    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3737    /**
3738     * Get the override state of a window.
3739     *
3740     * @param obj The window object
3741     * @return If true, the window is overridden
3742     *
3743     * @see elm_win_override_set()
3744     */
3745    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3746    /**
3747     * Set the fullscreen state of a window.
3748     *
3749     * @param obj The window object
3750     * @param fullscreen If true, the window is fullscreen
3751     */
3752    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3753    /**
3754     * Get the fullscreen state of a window.
3755     *
3756     * @param obj The window object
3757     * @return If true, the window is fullscreen
3758     */
3759    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3760    /**
3761     * Set the maximized state of a window.
3762     *
3763     * @param obj The window object
3764     * @param maximized If true, the window is maximized
3765     */
3766    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3767    /**
3768     * Get the maximized state of a window.
3769     *
3770     * @param obj The window object
3771     * @return If true, the window is maximized
3772     */
3773    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3774    /**
3775     * Set the iconified state of a window.
3776     *
3777     * @param obj The window object
3778     * @param iconified If true, the window is iconified
3779     */
3780    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3781    /**
3782     * Get the iconified state of a window.
3783     *
3784     * @param obj The window object
3785     * @return If true, the window is iconified
3786     */
3787    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3788    /**
3789     * Set the layer of the window.
3790     *
3791     * What this means exactly will depend on the underlying engine used.
3792     *
3793     * In the case of X11 backed engines, the value in @p layer has the
3794     * following meanings:
3795     * @li < 3: The window will be placed below all others.
3796     * @li > 5: The window will be placed above all others.
3797     * @li other: The window will be placed in the default layer.
3798     *
3799     * @param obj The window object
3800     * @param layer The layer of the window
3801     */
3802    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3803    /**
3804     * Get the layer of the window.
3805     *
3806     * @param obj The window object
3807     * @return The layer of the window
3808     *
3809     * @see elm_win_layer_set()
3810     */
3811    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3812    /**
3813     * Set the rotation of the window.
3814     *
3815     * Most engines only work with multiples of 90.
3816     *
3817     * This function is used to set the orientation of the window @p obj to
3818     * match that of the screen. The window itself will be resized to adjust
3819     * to the new geometry of its contents. If you want to keep the window size,
3820     * see elm_win_rotation_with_resize_set().
3821     *
3822     * @param obj The window object
3823     * @param rotation The rotation of the window, in degrees (0-360),
3824     * counter-clockwise.
3825     */
3826    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3827    /**
3828     * Rotates the window and resizes it.
3829     *
3830     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3831     * that they fit inside the current window geometry.
3832     *
3833     * @param obj The window object
3834     * @param layer The rotation of the window in degrees (0-360),
3835     * counter-clockwise.
3836     */
3837    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3838    /**
3839     * Get the rotation of the window.
3840     *
3841     * @param obj The window object
3842     * @return The rotation of the window in degrees (0-360)
3843     *
3844     * @see elm_win_rotation_set()
3845     * @see elm_win_rotation_with_resize_set()
3846     */
3847    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3848    /**
3849     * Set the sticky state of the window.
3850     *
3851     * Hints the Window Manager that the window in @p obj should be left fixed
3852     * at its position even when the virtual desktop it's on moves or changes.
3853     *
3854     * @param obj The window object
3855     * @param sticky If true, the window's sticky state is enabled
3856     */
3857    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3858    /**
3859     * Get the sticky state of the window.
3860     *
3861     * @param obj The window object
3862     * @return If true, the window's sticky state is enabled
3863     *
3864     * @see elm_win_sticky_set()
3865     */
3866    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3867    /**
3868     * Set if this window is an illume conformant window
3869     *
3870     * @param obj The window object
3871     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3872     */
3873    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3874    /**
3875     * Get if this window is an illume conformant window
3876     *
3877     * @param obj The window object
3878     * @return A boolean if this window is illume conformant or not
3879     */
3880    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3881    /**
3882     * Set a window to be an illume quickpanel window
3883     *
3884     * By default window objects are not quickpanel windows.
3885     *
3886     * @param obj The window object
3887     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3888     */
3889    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3890    /**
3891     * Get if this window is a quickpanel or not
3892     *
3893     * @param obj The window object
3894     * @return A boolean if this window is a quickpanel or not
3895     */
3896    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3897    /**
3898     * Set the major priority of a quickpanel window
3899     *
3900     * @param obj The window object
3901     * @param priority The major priority for this quickpanel
3902     */
3903    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3904    /**
3905     * Get the major priority of a quickpanel window
3906     *
3907     * @param obj The window object
3908     * @return The major priority of this quickpanel
3909     */
3910    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3911    /**
3912     * Set the minor priority of a quickpanel window
3913     *
3914     * @param obj The window object
3915     * @param priority The minor priority for this quickpanel
3916     */
3917    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3918    /**
3919     * Get the minor priority of a quickpanel window
3920     *
3921     * @param obj The window object
3922     * @return The minor priority of this quickpanel
3923     */
3924    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3925    /**
3926     * Set which zone this quickpanel should appear in
3927     *
3928     * @param obj The window object
3929     * @param zone The requested zone for this quickpanel
3930     */
3931    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3932    /**
3933     * Get which zone this quickpanel should appear in
3934     *
3935     * @param obj The window object
3936     * @return The requested zone for this quickpanel
3937     */
3938    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3939    /**
3940     * Set the window to be skipped by keyboard focus
3941     *
3942     * This sets the window to be skipped by normal keyboard input. This means
3943     * a window manager will be asked to not focus this window as well as omit
3944     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3945     *
3946     * Call this and enable it on a window BEFORE you show it for the first time,
3947     * otherwise it may have no effect.
3948     *
3949     * Use this for windows that have only output information or might only be
3950     * interacted with by the mouse or fingers, and never for typing input.
3951     * Be careful that this may have side-effects like making the window
3952     * non-accessible in some cases unless the window is specially handled. Use
3953     * this with care.
3954     *
3955     * @param obj The window object
3956     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3957     */
3958    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3959    /**
3960     * Send a command to the windowing environment
3961     *
3962     * This is intended to work in touchscreen or small screen device
3963     * environments where there is a more simplistic window management policy in
3964     * place. This uses the window object indicated to select which part of the
3965     * environment to control (the part that this window lives in), and provides
3966     * a command and an optional parameter structure (use NULL for this if not
3967     * needed).
3968     *
3969     * @param obj The window object that lives in the environment to control
3970     * @param command The command to send
3971     * @param params Optional parameters for the command
3972     */
3973    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3974    /**
3975     * Get the inlined image object handle
3976     *
3977     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3978     * then the window is in fact an evas image object inlined in the parent
3979     * canvas. You can get this object (be careful to not manipulate it as it
3980     * is under control of elementary), and use it to do things like get pixel
3981     * data, save the image to a file, etc.
3982     *
3983     * @param obj The window object to get the inlined image from
3984     * @return The inlined image object, or NULL if none exists
3985     */
3986    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3987    /**
3988     * Set the enabled status for the focus highlight in a window
3989     *
3990     * This function will enable or disable the focus highlight only for the
3991     * given window, regardless of the global setting for it
3992     *
3993     * @param obj The window where to enable the highlight
3994     * @param enabled The enabled value for the highlight
3995     */
3996    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3997    /**
3998     * Get the enabled value of the focus highlight for this window
3999     *
4000     * @param obj The window in which to check if the focus highlight is enabled
4001     *
4002     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4003     */
4004    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4005    /**
4006     * Set the style for the focus highlight on this window
4007     *
4008     * Sets the style to use for theming the highlight of focused objects on
4009     * the given window. If @p style is NULL, the default will be used.
4010     *
4011     * @param obj The window where to set the style
4012     * @param style The style to set
4013     */
4014    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4015    /**
4016     * Get the style set for the focus highlight object
4017     *
4018     * Gets the style set for this windows highilght object, or NULL if none
4019     * is set.
4020     *
4021     * @param obj The window to retrieve the highlights style from
4022     *
4023     * @return The style set or NULL if none was. Default is used in that case.
4024     */
4025    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4026    /*...
4027     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4028     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4029     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4030     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4031     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4032     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4033     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4034     *
4035     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4036     * (blank mouse, private mouse obj, defaultmouse)
4037     *
4038     */
4039    /**
4040     * Sets the keyboard mode of the window.
4041     *
4042     * @param obj The window object
4043     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4044     */
4045    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4046    /**
4047     * Gets the keyboard mode of the window.
4048     *
4049     * @param obj The window object
4050     * @return The mode, one of #Elm_Win_Keyboard_Mode
4051     */
4052    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4053    /**
4054     * Sets whether the window is a keyboard.
4055     *
4056     * @param obj The window object
4057     * @param is_keyboard If true, the window is a virtual keyboard
4058     */
4059    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4060    /**
4061     * Gets whether the window is a keyboard.
4062     *
4063     * @param obj The window object
4064     * @return If the window is a virtual keyboard
4065     */
4066    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4067
4068    /**
4069     * Get the screen position of a window.
4070     *
4071     * @param obj The window object
4072     * @param x The int to store the x coordinate to
4073     * @param y The int to store the y coordinate to
4074     */
4075    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4076    /**
4077     * @}
4078     */
4079
4080    /**
4081     * @defgroup Inwin Inwin
4082     *
4083     * @image html img/widget/inwin/preview-00.png
4084     * @image latex img/widget/inwin/preview-00.eps
4085     * @image html img/widget/inwin/preview-01.png
4086     * @image latex img/widget/inwin/preview-01.eps
4087     * @image html img/widget/inwin/preview-02.png
4088     * @image latex img/widget/inwin/preview-02.eps
4089     *
4090     * An inwin is a window inside a window that is useful for a quick popup.
4091     * It does not hover.
4092     *
4093     * It works by creating an object that will occupy the entire window, so it
4094     * must be created using an @ref Win "elm_win" as parent only. The inwin
4095     * object can be hidden or restacked below every other object if it's
4096     * needed to show what's behind it without destroying it. If this is done,
4097     * the elm_win_inwin_activate() function can be used to bring it back to
4098     * full visibility again.
4099     *
4100     * There are three styles available in the default theme. These are:
4101     * @li default: The inwin is sized to take over most of the window it's
4102     * placed in.
4103     * @li minimal: The size of the inwin will be the minimum necessary to show
4104     * its contents.
4105     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4106     * possible, but it's sized vertically the most it needs to fit its\
4107     * contents.
4108     *
4109     * Some examples of Inwin can be found in the following:
4110     * @li @ref inwin_example_01
4111     *
4112     * @{
4113     */
4114    /**
4115     * Adds an inwin to the current window
4116     *
4117     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4118     * Never call this function with anything other than the top-most window
4119     * as its parameter, unless you are fond of undefined behavior.
4120     *
4121     * After creating the object, the widget will set itself as resize object
4122     * for the window with elm_win_resize_object_add(), so when shown it will
4123     * appear to cover almost the entire window (how much of it depends on its
4124     * content and the style used). It must not be added into other container
4125     * objects and it needs not be moved or resized manually.
4126     *
4127     * @param parent The parent object
4128     * @return The new object or NULL if it cannot be created
4129     */
4130    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4131    /**
4132     * Activates an inwin object, ensuring its visibility
4133     *
4134     * This function will make sure that the inwin @p obj is completely visible
4135     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4136     * to the front. It also sets the keyboard focus to it, which will be passed
4137     * onto its content.
4138     *
4139     * The object's theme will also receive the signal "elm,action,show" with
4140     * source "elm".
4141     *
4142     * @param obj The inwin to activate
4143     */
4144    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4145    /**
4146     * Set the content of an inwin object.
4147     *
4148     * Once the content object is set, a previously set one will be deleted.
4149     * If you want to keep that old content object, use the
4150     * elm_win_inwin_content_unset() function.
4151     *
4152     * @param obj The inwin object
4153     * @param content The object to set as content
4154     */
4155    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4156    /**
4157     * Get the content of an inwin object.
4158     *
4159     * Return the content object which is set for this widget.
4160     *
4161     * The returned object is valid as long as the inwin is still alive and no
4162     * other content is set on it. Deleting the object will notify the inwin
4163     * about it and this one will be left empty.
4164     *
4165     * If you need to remove an inwin's content to be reused somewhere else,
4166     * see elm_win_inwin_content_unset().
4167     *
4168     * @param obj The inwin object
4169     * @return The content that is being used
4170     */
4171    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4172    /**
4173     * Unset the content of an inwin object.
4174     *
4175     * Unparent and return the content object which was set for this widget.
4176     *
4177     * @param obj The inwin object
4178     * @return The content that was being used
4179     */
4180    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4181    /**
4182     * @}
4183     */
4184    /* X specific calls - won't work on non-x engines (return 0) */
4185
4186    /**
4187     * Get the Ecore_X_Window of an Evas_Object
4188     *
4189     * @param obj The object
4190     *
4191     * @return The Ecore_X_Window of @p obj
4192     *
4193     * @ingroup Win
4194     */
4195    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4196
4197    /* smart callbacks called:
4198     * "delete,request" - the user requested to delete the window
4199     * "focus,in" - window got focus
4200     * "focus,out" - window lost focus
4201     * "moved" - window that holds the canvas was moved
4202     */
4203
4204    /**
4205     * @defgroup Bg Bg
4206     *
4207     * @image html img/widget/bg/preview-00.png
4208     * @image latex img/widget/bg/preview-00.eps
4209     *
4210     * @brief Background object, used for setting a solid color, image or Edje
4211     * group as background to a window or any container object.
4212     *
4213     * The bg object is used for setting a solid background to a window or
4214     * packing into any container object. It works just like an image, but has
4215     * some properties useful to a background, like setting it to tiled,
4216     * centered, scaled or stretched.
4217     *
4218     * Here is some sample code using it:
4219     * @li @ref bg_01_example_page
4220     * @li @ref bg_02_example_page
4221     * @li @ref bg_03_example_page
4222     */
4223
4224    /* bg */
4225    typedef enum _Elm_Bg_Option
4226      {
4227         ELM_BG_OPTION_CENTER,  /**< center the background */
4228         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4229         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4230         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4231      } Elm_Bg_Option;
4232
4233    /**
4234     * Add a new background to the parent
4235     *
4236     * @param parent The parent object
4237     * @return The new object or NULL if it cannot be created
4238     *
4239     * @ingroup Bg
4240     */
4241    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4242
4243    /**
4244     * Set the file (image or edje) used for the background
4245     *
4246     * @param obj The bg object
4247     * @param file The file path
4248     * @param group Optional key (group in Edje) within the file
4249     *
4250     * This sets the image file used in the background object. The image (or edje)
4251     * will be stretched (retaining aspect if its an image file) to completely fill
4252     * the bg object. This may mean some parts are not visible.
4253     *
4254     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4255     * even if @p file is NULL.
4256     *
4257     * @ingroup Bg
4258     */
4259    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4260
4261    /**
4262     * Get the file (image or edje) used for the background
4263     *
4264     * @param obj The bg object
4265     * @param file The file path
4266     * @param group Optional key (group in Edje) within the file
4267     *
4268     * @ingroup Bg
4269     */
4270    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4271
4272    /**
4273     * Set the option used for the background image
4274     *
4275     * @param obj The bg object
4276     * @param option The desired background option (TILE, SCALE)
4277     *
4278     * This sets the option used for manipulating the display of the background
4279     * image. The image can be tiled or scaled.
4280     *
4281     * @ingroup Bg
4282     */
4283    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4284
4285    /**
4286     * Get the option used for the background image
4287     *
4288     * @param obj The bg object
4289     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4290     *
4291     * @ingroup Bg
4292     */
4293    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4294    /**
4295     * Set the option used for the background color
4296     *
4297     * @param obj The bg object
4298     * @param r
4299     * @param g
4300     * @param b
4301     *
4302     * This sets the color used for the background rectangle. Its range goes
4303     * from 0 to 255.
4304     *
4305     * @ingroup Bg
4306     */
4307    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4308    /**
4309     * Get the option used for the background color
4310     *
4311     * @param obj The bg object
4312     * @param r
4313     * @param g
4314     * @param b
4315     *
4316     * @ingroup Bg
4317     */
4318    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4319
4320    /**
4321     * Set the overlay object used for the background object.
4322     *
4323     * @param obj The bg object
4324     * @param overlay The overlay object
4325     *
4326     * This provides a way for elm_bg to have an 'overlay' that will be on top
4327     * of the bg. Once the over object is set, a previously set one will be
4328     * deleted, even if you set the new one to NULL. If you want to keep that
4329     * old content object, use the elm_bg_overlay_unset() function.
4330     *
4331     * @ingroup Bg
4332     */
4333
4334    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4335
4336    /**
4337     * Get the overlay object used for the background object.
4338     *
4339     * @param obj The bg object
4340     * @return The content that is being used
4341     *
4342     * Return the content object which is set for this widget
4343     *
4344     * @ingroup Bg
4345     */
4346    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4347
4348    /**
4349     * Get the overlay object used for the background object.
4350     *
4351     * @param obj The bg object
4352     * @return The content that was being used
4353     *
4354     * Unparent and return the overlay object which was set for this widget
4355     *
4356     * @ingroup Bg
4357     */
4358    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4359
4360    /**
4361     * Set the size of the pixmap representation of the image.
4362     *
4363     * This option just makes sense if an image is going to be set in the bg.
4364     *
4365     * @param obj The bg object
4366     * @param w The new width of the image pixmap representation.
4367     * @param h The new height of the image pixmap representation.
4368     *
4369     * This function sets a new size for pixmap representation of the given bg
4370     * image. It allows the image to be loaded already in the specified size,
4371     * reducing the memory usage and load time when loading a big image with load
4372     * size set to a smaller size.
4373     *
4374     * NOTE: this is just a hint, the real size of the pixmap may differ
4375     * depending on the type of image being loaded, being bigger than requested.
4376     *
4377     * @ingroup Bg
4378     */
4379    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4380    /* smart callbacks called:
4381     */
4382
4383    /**
4384     * @defgroup Icon Icon
4385     *
4386     * @image html img/widget/icon/preview-00.png
4387     * @image latex img/widget/icon/preview-00.eps
4388     *
4389     * An object that provides standard icon images (delete, edit, arrows, etc.)
4390     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4391     *
4392     * The icon image requested can be in the elementary theme, or in the
4393     * freedesktop.org paths. It's possible to set the order of preference from
4394     * where the image will be used.
4395     *
4396     * This API is very similar to @ref Image, but with ready to use images.
4397     *
4398     * Default images provided by the theme are described below.
4399     *
4400     * The first list contains icons that were first intended to be used in
4401     * toolbars, but can be used in many other places too:
4402     * @li home
4403     * @li close
4404     * @li apps
4405     * @li arrow_up
4406     * @li arrow_down
4407     * @li arrow_left
4408     * @li arrow_right
4409     * @li chat
4410     * @li clock
4411     * @li delete
4412     * @li edit
4413     * @li refresh
4414     * @li folder
4415     * @li file
4416     *
4417     * Now some icons that were designed to be used in menus (but again, you can
4418     * use them anywhere else):
4419     * @li menu/home
4420     * @li menu/close
4421     * @li menu/apps
4422     * @li menu/arrow_up
4423     * @li menu/arrow_down
4424     * @li menu/arrow_left
4425     * @li menu/arrow_right
4426     * @li menu/chat
4427     * @li menu/clock
4428     * @li menu/delete
4429     * @li menu/edit
4430     * @li menu/refresh
4431     * @li menu/folder
4432     * @li menu/file
4433     *
4434     * And here we have some media player specific icons:
4435     * @li media_player/forward
4436     * @li media_player/info
4437     * @li media_player/next
4438     * @li media_player/pause
4439     * @li media_player/play
4440     * @li media_player/prev
4441     * @li media_player/rewind
4442     * @li media_player/stop
4443     *
4444     * Signals that you can add callbacks for are:
4445     *
4446     * "clicked" - This is called when a user has clicked the icon
4447     *
4448     * An example of usage for this API follows:
4449     * @li @ref tutorial_icon
4450     */
4451
4452    /**
4453     * @addtogroup Icon
4454     * @{
4455     */
4456
4457    typedef enum _Elm_Icon_Type
4458      {
4459         ELM_ICON_NONE,
4460         ELM_ICON_FILE,
4461         ELM_ICON_STANDARD
4462      } Elm_Icon_Type;
4463    /**
4464     * @enum _Elm_Icon_Lookup_Order
4465     * @typedef Elm_Icon_Lookup_Order
4466     *
4467     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4468     * theme, FDO paths, or both?
4469     *
4470     * @ingroup Icon
4471     */
4472    typedef enum _Elm_Icon_Lookup_Order
4473      {
4474         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4475         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4476         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4477         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4478      } Elm_Icon_Lookup_Order;
4479
4480    /**
4481     * Add a new icon object to the parent.
4482     *
4483     * @param parent The parent object
4484     * @return The new object or NULL if it cannot be created
4485     *
4486     * @see elm_icon_file_set()
4487     *
4488     * @ingroup Icon
4489     */
4490    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4491    /**
4492     * Set the file that will be used as icon.
4493     *
4494     * @param obj The icon object
4495     * @param file The path to file that will be used as icon image
4496     * @param group The group that the icon belongs to in edje file
4497     *
4498     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4499     *
4500     * @note The icon image set by this function can be changed by
4501     * elm_icon_standard_set().
4502     *
4503     * @see elm_icon_file_get()
4504     *
4505     * @ingroup Icon
4506     */
4507    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4508    /**
4509     * Set a location in memory to be used as an icon
4510     *
4511     * @param obj The icon object
4512     * @param img The binary data that will be used as an image
4513     * @param size The size of binary data @p img
4514     * @param format Optional format of @p img to pass to the image loader
4515     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4516     *
4517     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4518     *
4519     * @note The icon image set by this function can be changed by
4520     * elm_icon_standard_set().
4521     *
4522     * @ingroup Icon
4523     */
4524    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);
4525    /**
4526     * Get the file that will be used as icon.
4527     *
4528     * @param obj The icon object
4529     * @param file The path to file that will be used as icon icon image
4530     * @param group The group that the icon belongs to in edje file
4531     *
4532     * @see elm_icon_file_set()
4533     *
4534     * @ingroup Icon
4535     */
4536    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4537    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4538    /**
4539     * Set the icon by icon standards names.
4540     *
4541     * @param obj The icon object
4542     * @param name The icon name
4543     *
4544     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4545     *
4546     * For example, freedesktop.org defines standard icon names such as "home",
4547     * "network", etc. There can be different icon sets to match those icon
4548     * keys. The @p name given as parameter is one of these "keys", and will be
4549     * used to look in the freedesktop.org paths and elementary theme. One can
4550     * change the lookup order with elm_icon_order_lookup_set().
4551     *
4552     * If name is not found in any of the expected locations and it is the
4553     * absolute path of an image file, this image will be used.
4554     *
4555     * @note The icon image set by this function can be changed by
4556     * elm_icon_file_set().
4557     *
4558     * @see elm_icon_standard_get()
4559     * @see elm_icon_file_set()
4560     *
4561     * @ingroup Icon
4562     */
4563    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4564    /**
4565     * Get the icon name set by icon standard names.
4566     *
4567     * @param obj The icon object
4568     * @return The icon name
4569     *
4570     * If the icon image was set using elm_icon_file_set() instead of
4571     * elm_icon_standard_set(), then this function will return @c NULL.
4572     *
4573     * @see elm_icon_standard_set()
4574     *
4575     * @ingroup Icon
4576     */
4577    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4578    /**
4579     * Set the smooth effect for an icon object.
4580     *
4581     * @param obj The icon object
4582     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4583     * otherwise. Default is @c EINA_TRUE.
4584     *
4585     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4586     * scaling provides a better resulting image, but is slower.
4587     *
4588     * The smooth scaling should be disabled when making animations that change
4589     * the icon size, since they will be faster. Animations that don't require
4590     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4591     * is already scaled, since the scaled icon image will be cached).
4592     *
4593     * @see elm_icon_smooth_get()
4594     *
4595     * @ingroup Icon
4596     */
4597    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4598    /**
4599     * Get the smooth effect for an icon object.
4600     *
4601     * @param obj The icon object
4602     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4603     *
4604     * @see elm_icon_smooth_set()
4605     *
4606     * @ingroup Icon
4607     */
4608    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4609    /**
4610     * Disable scaling of this object.
4611     *
4612     * @param obj The icon object.
4613     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4614     * otherwise. Default is @c EINA_FALSE.
4615     *
4616     * This function disables scaling of the icon object through the function
4617     * elm_object_scale_set(). However, this does not affect the object
4618     * size/resize in any way. For that effect, take a look at
4619     * elm_icon_scale_set().
4620     *
4621     * @see elm_icon_no_scale_get()
4622     * @see elm_icon_scale_set()
4623     * @see elm_object_scale_set()
4624     *
4625     * @ingroup Icon
4626     */
4627    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4628    /**
4629     * Get whether scaling is disabled on the object.
4630     *
4631     * @param obj The icon object
4632     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4633     *
4634     * @see elm_icon_no_scale_set()
4635     *
4636     * @ingroup Icon
4637     */
4638    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4639    /**
4640     * Set if the object is (up/down) resizeable.
4641     *
4642     * @param obj The icon object
4643     * @param scale_up A bool to set if the object is resizeable up. Default is
4644     * @c EINA_TRUE.
4645     * @param scale_down A bool to set if the object is resizeable down. Default
4646     * is @c EINA_TRUE.
4647     *
4648     * This function limits the icon object resize ability. If @p scale_up is set to
4649     * @c EINA_FALSE, the object can't have its height or width resized to a value
4650     * higher than the original icon size. Same is valid for @p scale_down.
4651     *
4652     * @see elm_icon_scale_get()
4653     *
4654     * @ingroup Icon
4655     */
4656    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4657    /**
4658     * Get if the object is (up/down) resizeable.
4659     *
4660     * @param obj The icon object
4661     * @param scale_up A bool to set if the object is resizeable up
4662     * @param scale_down A bool to set if the object is resizeable down
4663     *
4664     * @see elm_icon_scale_set()
4665     *
4666     * @ingroup Icon
4667     */
4668    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4669    /**
4670     * Get the object's image size
4671     *
4672     * @param obj The icon object
4673     * @param w A pointer to store the width in
4674     * @param h A pointer to store the height in
4675     *
4676     * @ingroup Icon
4677     */
4678    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4679    /**
4680     * Set if the icon fill the entire object area.
4681     *
4682     * @param obj The icon object
4683     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4684     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4685     *
4686     * When the icon object is resized to a different aspect ratio from the
4687     * original icon image, the icon image will still keep its aspect. This flag
4688     * tells how the image should fill the object's area. They are: keep the
4689     * entire icon inside the limits of height and width of the object (@p
4690     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4691     * of the object, and the icon will fill the entire object (@p fill_outside
4692     * is @c EINA_TRUE).
4693     *
4694     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4695     * retain property to false. Thus, the icon image will always keep its
4696     * original aspect ratio.
4697     *
4698     * @see elm_icon_fill_outside_get()
4699     * @see elm_image_fill_outside_set()
4700     *
4701     * @ingroup Icon
4702     */
4703    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4704    /**
4705     * Get if the object is filled outside.
4706     *
4707     * @param obj The icon object
4708     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4709     *
4710     * @see elm_icon_fill_outside_set()
4711     *
4712     * @ingroup Icon
4713     */
4714    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4715    /**
4716     * Set the prescale size for the icon.
4717     *
4718     * @param obj The icon object
4719     * @param size The prescale size. This value is used for both width and
4720     * height.
4721     *
4722     * This function sets a new size for pixmap representation of the given
4723     * icon. It allows the icon to be loaded already in the specified size,
4724     * reducing the memory usage and load time when loading a big icon with load
4725     * size set to a smaller size.
4726     *
4727     * It's equivalent to the elm_bg_load_size_set() function for bg.
4728     *
4729     * @note this is just a hint, the real size of the pixmap may differ
4730     * depending on the type of icon being loaded, being bigger than requested.
4731     *
4732     * @see elm_icon_prescale_get()
4733     * @see elm_bg_load_size_set()
4734     *
4735     * @ingroup Icon
4736     */
4737    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4738    /**
4739     * Get the prescale size for the icon.
4740     *
4741     * @param obj The icon object
4742     * @return The prescale size
4743     *
4744     * @see elm_icon_prescale_set()
4745     *
4746     * @ingroup Icon
4747     */
4748    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4749    /**
4750     * Sets the icon lookup order used by elm_icon_standard_set().
4751     *
4752     * @param obj The icon object
4753     * @param order The icon lookup order (can be one of
4754     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4755     * or ELM_ICON_LOOKUP_THEME)
4756     *
4757     * @see elm_icon_order_lookup_get()
4758     * @see Elm_Icon_Lookup_Order
4759     *
4760     * @ingroup Icon
4761     */
4762    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4763    /**
4764     * Gets the icon lookup order.
4765     *
4766     * @param obj The icon object
4767     * @return The icon lookup order
4768     *
4769     * @see elm_icon_order_lookup_set()
4770     * @see Elm_Icon_Lookup_Order
4771     *
4772     * @ingroup Icon
4773     */
4774    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4775    /**
4776     * Get the flag related with elm icon can support animation
4777     *
4778     * @param obj The icon object
4779     * @return The flag of animation available
4780     *
4781     * Return this elm icon's image can be animated
4782     * Currently Evas only support gif's animation
4783     * If the return value of this function is EINA_FALSE,
4784     * other elm_icon_animated_XXX functions don't work
4785     * @ingroup Icon
4786     */
4787    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4788    /**
4789     * Set animation mode of the icon.
4790     *
4791     * @param obj The icon object
4792     * @param anim @c EINA_TRUE if the object do animation job,
4793     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4794     *
4795     * Even though elm icon's file can be animated, 
4796     * sometimes appication developer want to just first page of image.
4797     * In that time, don't call this function, because default value is EINA_FALSE
4798     * Only when you want icon support anition, 
4799     * use this function and set animated to EINA_TURE
4800     * @ingroup Icon
4801     */
4802    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4803    /**
4804     * Get animation mode of the icon.
4805     *
4806     * @param obj The icon object
4807     * @return The animation mode of the icon object
4808     * @see elm_icon_animated_set
4809     * @ingroup Icon
4810     */
4811    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4812    /**
4813     * Set animation play mode of the icon.
4814     *
4815     * @param obj The icon object
4816     * @param play @c EINA_TRUE the object play animation images,
4817     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4818     * 
4819     * If you want to play elm icon's animation, you set play to EINA_TURE.
4820     * For example, you make gif player using this set/get API and click event.
4821     *
4822     * 1. Click event occurs
4823     * 2. Check play flag using elm_icon_animaged_play_get
4824     * 3. If elm icon was playing, set play to EINA_FALSE. 
4825     *    Then animation will be stopped and vice versa
4826     * @ingroup Icon
4827     */
4828    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4829    /**
4830     * Get animation play mode of the icon.
4831     *
4832     * @param obj The icon object
4833     * @return The play mode of the icon object
4834     *
4835     * @see elm_icon_animated_lay_get
4836     * @ingroup Icon
4837     */
4838    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4839
4840    /**
4841     * @}
4842     */
4843
4844    /**
4845     * @defgroup Image Image
4846     *
4847     * @image html img/widget/image/preview-00.png
4848     * @image latex img/widget/image/preview-00.eps
4849
4850     *
4851     * An object that allows one to load an image file to it. It can be used
4852     * anywhere like any other elementary widget.
4853     *
4854     * This widget provides most of the functionality provided from @ref Bg or @ref
4855     * Icon, but with a slightly different API (use the one that fits better your
4856     * needs).
4857     *
4858     * The features not provided by those two other image widgets are:
4859     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4860     * @li change the object orientation with elm_image_orient_set();
4861     * @li and turning the image editable with elm_image_editable_set().
4862     *
4863     * Signals that you can add callbacks for are:
4864     *
4865     * @li @c "clicked" - This is called when a user has clicked the image
4866     *
4867     * An example of usage for this API follows:
4868     * @li @ref tutorial_image
4869     */
4870
4871    /**
4872     * @addtogroup Image
4873     * @{
4874     */
4875
4876    /**
4877     * @enum _Elm_Image_Orient
4878     * @typedef Elm_Image_Orient
4879     *
4880     * Possible orientation options for elm_image_orient_set().
4881     *
4882     * @image html elm_image_orient_set.png
4883     * @image latex elm_image_orient_set.eps width=\textwidth
4884     *
4885     * @ingroup Image
4886     */
4887    typedef enum _Elm_Image_Orient
4888      {
4889         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4890         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4891         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4892         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4893         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4894         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4895         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4896         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4897      } Elm_Image_Orient;
4898
4899    /**
4900     * Add a new image to the parent.
4901     *
4902     * @param parent The parent object
4903     * @return The new object or NULL if it cannot be created
4904     *
4905     * @see elm_image_file_set()
4906     *
4907     * @ingroup Image
4908     */
4909    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4910    /**
4911     * Set the file that will be used as image.
4912     *
4913     * @param obj The image object
4914     * @param file The path to file that will be used as image
4915     * @param group The group that the image belongs in edje file (if it's an
4916     * edje image)
4917     *
4918     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4919     *
4920     * @see elm_image_file_get()
4921     *
4922     * @ingroup Image
4923     */
4924    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4925    /**
4926     * Get the file that will be used as image.
4927     *
4928     * @param obj The image object
4929     * @param file The path to file
4930     * @param group The group that the image belongs in edje file
4931     *
4932     * @see elm_image_file_set()
4933     *
4934     * @ingroup Image
4935     */
4936    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4937    /**
4938     * Set the smooth effect for an image.
4939     *
4940     * @param obj The image object
4941     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4942     * otherwise. Default is @c EINA_TRUE.
4943     *
4944     * Set the scaling algorithm to be used when scaling the image. Smooth
4945     * scaling provides a better resulting image, but is slower.
4946     *
4947     * The smooth scaling should be disabled when making animations that change
4948     * the image size, since it will be faster. Animations that don't require
4949     * resizing of the image can keep the smooth scaling enabled (even if the
4950     * image is already scaled, since the scaled image will be cached).
4951     *
4952     * @see elm_image_smooth_get()
4953     *
4954     * @ingroup Image
4955     */
4956    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4957    /**
4958     * Get the smooth effect for an image.
4959     *
4960     * @param obj The image object
4961     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4962     *
4963     * @see elm_image_smooth_get()
4964     *
4965     * @ingroup Image
4966     */
4967    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4968    /**
4969     * Gets the current size of the image.
4970     *
4971     * @param obj The image object.
4972     * @param w Pointer to store width, or NULL.
4973     * @param h Pointer to store height, or NULL.
4974     *
4975     * This is the real size of the image, not the size of the object.
4976     *
4977     * On error, neither w or h will be written.
4978     *
4979     * @ingroup Image
4980     */
4981    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4982    /**
4983     * Disable scaling of this object.
4984     *
4985     * @param obj The image object.
4986     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4987     * otherwise. Default is @c EINA_FALSE.
4988     *
4989     * This function disables scaling of the elm_image widget through the
4990     * function elm_object_scale_set(). However, this does not affect the widget
4991     * size/resize in any way. For that effect, take a look at
4992     * elm_image_scale_set().
4993     *
4994     * @see elm_image_no_scale_get()
4995     * @see elm_image_scale_set()
4996     * @see elm_object_scale_set()
4997     *
4998     * @ingroup Image
4999     */
5000    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5001    /**
5002     * Get whether scaling is disabled on the object.
5003     *
5004     * @param obj The image object
5005     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5006     *
5007     * @see elm_image_no_scale_set()
5008     *
5009     * @ingroup Image
5010     */
5011    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5012    /**
5013     * Set if the object is (up/down) resizeable.
5014     *
5015     * @param obj The image object
5016     * @param scale_up A bool to set if the object is resizeable up. Default is
5017     * @c EINA_TRUE.
5018     * @param scale_down A bool to set if the object is resizeable down. Default
5019     * is @c EINA_TRUE.
5020     *
5021     * This function limits the image resize ability. If @p scale_up is set to
5022     * @c EINA_FALSE, the object can't have its height or width resized to a value
5023     * higher than the original image size. Same is valid for @p scale_down.
5024     *
5025     * @see elm_image_scale_get()
5026     *
5027     * @ingroup Image
5028     */
5029    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5030    /**
5031     * Get if the object is (up/down) resizeable.
5032     *
5033     * @param obj The image object
5034     * @param scale_up A bool to set if the object is resizeable up
5035     * @param scale_down A bool to set if the object is resizeable down
5036     *
5037     * @see elm_image_scale_set()
5038     *
5039     * @ingroup Image
5040     */
5041    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5042    /**
5043     * Set if the image fill the entire object area when keeping the aspect ratio.
5044     *
5045     * @param obj The image object
5046     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5047     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5048     *
5049     * When the image should keep its aspect ratio even if resized to another
5050     * aspect ratio, there are two possibilities to resize it: keep the entire
5051     * image inside the limits of height and width of the object (@p fill_outside
5052     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5053     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5054     *
5055     * @note This option will have no effect if
5056     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5057     *
5058     * @see elm_image_fill_outside_get()
5059     * @see elm_image_aspect_ratio_retained_set()
5060     *
5061     * @ingroup Image
5062     */
5063    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5064    /**
5065     * Get if the object is filled outside
5066     *
5067     * @param obj The image object
5068     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5069     *
5070     * @see elm_image_fill_outside_set()
5071     *
5072     * @ingroup Image
5073     */
5074    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5075    /**
5076     * Set the prescale size for the image
5077     *
5078     * @param obj The image object
5079     * @param size The prescale size. This value is used for both width and
5080     * height.
5081     *
5082     * This function sets a new size for pixmap representation of the given
5083     * image. It allows the image to be loaded already in the specified size,
5084     * reducing the memory usage and load time when loading a big image with load
5085     * size set to a smaller size.
5086     *
5087     * It's equivalent to the elm_bg_load_size_set() function for bg.
5088     *
5089     * @note this is just a hint, the real size of the pixmap may differ
5090     * depending on the type of image being loaded, being bigger than requested.
5091     *
5092     * @see elm_image_prescale_get()
5093     * @see elm_bg_load_size_set()
5094     *
5095     * @ingroup Image
5096     */
5097    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5098    /**
5099     * Get the prescale size for the image
5100     *
5101     * @param obj The image object
5102     * @return The prescale size
5103     *
5104     * @see elm_image_prescale_set()
5105     *
5106     * @ingroup Image
5107     */
5108    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5109    /**
5110     * Set the image orientation.
5111     *
5112     * @param obj The image object
5113     * @param orient The image orientation
5114     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5115     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5116     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5117     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5118     *  Default is #ELM_IMAGE_ORIENT_NONE.
5119     *
5120     * This function allows to rotate or flip the given image.
5121     *
5122     * @see elm_image_orient_get()
5123     * @see @ref Elm_Image_Orient
5124     *
5125     * @ingroup Image
5126     */
5127    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5128    /**
5129     * Get the image orientation.
5130     *
5131     * @param obj The image object
5132     * @return The image orientation
5133     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5134     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5135     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5136     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5137     *
5138     * @see elm_image_orient_set()
5139     * @see @ref Elm_Image_Orient
5140     *
5141     * @ingroup Image
5142     */
5143    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5144    /**
5145     * Make the image 'editable'.
5146     *
5147     * @param obj Image object.
5148     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5149     *
5150     * This means the image is a valid drag target for drag and drop, and can be
5151     * cut or pasted too.
5152     *
5153     * @ingroup Image
5154     */
5155    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5156    /**
5157     * Make the image 'editable'.
5158     *
5159     * @param obj Image object.
5160     * @return Editability.
5161     *
5162     * This means the image is a valid drag target for drag and drop, and can be
5163     * cut or pasted too.
5164     *
5165     * @ingroup Image
5166     */
5167    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5168    /**
5169     * Get the basic Evas_Image object from this object (widget).
5170     *
5171     * @param obj The image object to get the inlined image from
5172     * @return The inlined image object, or NULL if none exists
5173     *
5174     * This function allows one to get the underlying @c Evas_Object of type
5175     * Image from this elementary widget. It can be useful to do things like get
5176     * the pixel data, save the image to a file, etc.
5177     *
5178     * @note Be careful to not manipulate it, as it is under control of
5179     * elementary.
5180     *
5181     * @ingroup Image
5182     */
5183    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5184    /**
5185     * Set whether the original aspect ratio of the image should be kept on resize.
5186     *
5187     * @param obj The image object.
5188     * @param retained @c EINA_TRUE if the image should retain the aspect,
5189     * @c EINA_FALSE otherwise.
5190     *
5191     * The original aspect ratio (width / height) of the image is usually
5192     * distorted to match the object's size. Enabling this option will retain
5193     * this original aspect, and the way that the image is fit into the object's
5194     * area depends on the option set by elm_image_fill_outside_set().
5195     *
5196     * @see elm_image_aspect_ratio_retained_get()
5197     * @see elm_image_fill_outside_set()
5198     *
5199     * @ingroup Image
5200     */
5201    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5202    /**
5203     * Get if the object retains the original aspect ratio.
5204     *
5205     * @param obj The image object.
5206     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5207     * otherwise.
5208     *
5209     * @ingroup Image
5210     */
5211    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5212
5213    /* smart callbacks called:
5214     * "clicked" - the user clicked the image
5215     */
5216
5217    /**
5218     * @}
5219     */
5220
5221    /* glview */
5222    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5223
5224    typedef enum _Elm_GLView_Mode
5225      {
5226         ELM_GLVIEW_ALPHA   = 1,
5227         ELM_GLVIEW_DEPTH   = 2,
5228         ELM_GLVIEW_STENCIL = 4
5229      } Elm_GLView_Mode;
5230
5231    /**
5232     * Defines a policy for the glview resizing.
5233     *
5234     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5235     */
5236    typedef enum _Elm_GLView_Resize_Policy
5237      {
5238         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5239         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5240      } Elm_GLView_Resize_Policy;
5241
5242    typedef enum _Elm_GLView_Render_Policy
5243      {
5244         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5245         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5246      } Elm_GLView_Render_Policy;
5247
5248    /**
5249     * @defgroup GLView
5250     *
5251     * A simple GLView widget that allows GL rendering.
5252     *
5253     * Signals that you can add callbacks for are:
5254     *
5255     * @{
5256     */
5257
5258    /**
5259     * Add a new glview to the parent
5260     *
5261     * @param parent The parent object
5262     * @return The new object or NULL if it cannot be created
5263     *
5264     * @ingroup GLView
5265     */
5266    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5267
5268    /**
5269     * Sets the size of the glview
5270     *
5271     * @param obj The glview object
5272     * @param width width of the glview object
5273     * @param height height of the glview object
5274     *
5275     * @ingroup GLView
5276     */
5277    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5278
5279    /**
5280     * Gets the size of the glview.
5281     *
5282     * @param obj The glview object
5283     * @param width width of the glview object
5284     * @param height height of the glview object
5285     *
5286     * Note that this function returns the actual image size of the
5287     * glview.  This means that when the scale policy is set to
5288     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5289     * size.
5290     *
5291     * @ingroup GLView
5292     */
5293    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5294
5295    /**
5296     * Gets the gl api struct for gl rendering
5297     *
5298     * @param obj The glview object
5299     * @return The api object or NULL if it cannot be created
5300     *
5301     * @ingroup GLView
5302     */
5303    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5304
5305    /**
5306     * Set the mode of the GLView. Supports Three simple modes.
5307     *
5308     * @param obj The glview object
5309     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5310     * @return True if set properly.
5311     *
5312     * @ingroup GLView
5313     */
5314    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5315
5316    /**
5317     * Set the resize policy for the glview object.
5318     *
5319     * @param obj The glview object.
5320     * @param policy The scaling policy.
5321     *
5322     * By default, the resize policy is set to
5323     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5324     * destroys the previous surface and recreates the newly specified
5325     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5326     * however, glview only scales the image object and not the underlying
5327     * GL Surface.
5328     *
5329     * @ingroup GLView
5330     */
5331    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5332
5333    /**
5334     * Set the render policy for the glview object.
5335     *
5336     * @param obj The glview object.
5337     * @param policy The render policy.
5338     *
5339     * By default, the render policy is set to
5340     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5341     * that during the render loop, glview is only redrawn if it needs
5342     * to be redrawn. (i.e. When it is visible) If the policy is set to
5343     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5344     * whether it is visible/need redrawing or not.
5345     *
5346     * @ingroup GLView
5347     */
5348    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5349
5350    /**
5351     * Set the init function that runs once in the main loop.
5352     *
5353     * @param obj The glview object.
5354     * @param func The init function to be registered.
5355     *
5356     * The registered init function gets called once during the render loop.
5357     *
5358     * @ingroup GLView
5359     */
5360    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5361
5362    /**
5363     * Set the render function that runs in the main loop.
5364     *
5365     * @param obj The glview object.
5366     * @param func The delete function to be registered.
5367     *
5368     * The registered del function gets called when GLView object is deleted.
5369     *
5370     * @ingroup GLView
5371     */
5372    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5373
5374    /**
5375     * Set the resize function that gets called when resize happens.
5376     *
5377     * @param obj The glview object.
5378     * @param func The resize function to be registered.
5379     *
5380     * @ingroup GLView
5381     */
5382    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5383
5384    /**
5385     * Set the render function that runs in the main loop.
5386     *
5387     * @param obj The glview object.
5388     * @param func The render function to be registered.
5389     *
5390     * @ingroup GLView
5391     */
5392    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5393
5394    /**
5395     * Notifies that there has been changes in the GLView.
5396     *
5397     * @param obj The glview object.
5398     *
5399     * @ingroup GLView
5400     */
5401    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5402
5403    /**
5404     * @}
5405     */
5406
5407    /* box */
5408    /**
5409     * @defgroup Box Box
5410     *
5411     * @image html img/widget/box/preview-00.png
5412     * @image latex img/widget/box/preview-00.eps width=\textwidth
5413     *
5414     * @image html img/box.png
5415     * @image latex img/box.eps width=\textwidth
5416     *
5417     * A box arranges objects in a linear fashion, governed by a layout function
5418     * that defines the details of this arrangement.
5419     *
5420     * By default, the box will use an internal function to set the layout to
5421     * a single row, either vertical or horizontal. This layout is affected
5422     * by a number of parameters, such as the homogeneous flag set by
5423     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5424     * elm_box_align_set() and the hints set to each object in the box.
5425     *
5426     * For this default layout, it's possible to change the orientation with
5427     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5428     * placing its elements ordered from top to bottom. When horizontal is set,
5429     * the order will go from left to right. If the box is set to be
5430     * homogeneous, every object in it will be assigned the same space, that
5431     * of the largest object. Padding can be used to set some spacing between
5432     * the cell given to each object. The alignment of the box, set with
5433     * elm_box_align_set(), determines how the bounding box of all the elements
5434     * will be placed within the space given to the box widget itself.
5435     *
5436     * The size hints of each object also affect how they are placed and sized
5437     * within the box. evas_object_size_hint_min_set() will give the minimum
5438     * size the object can have, and the box will use it as the basis for all
5439     * latter calculations. Elementary widgets set their own minimum size as
5440     * needed, so there's rarely any need to use it manually.
5441     *
5442     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5443     * used to tell whether the object will be allocated the minimum size it
5444     * needs or if the space given to it should be expanded. It's important
5445     * to realize that expanding the size given to the object is not the same
5446     * thing as resizing the object. It could very well end being a small
5447     * widget floating in a much larger empty space. If not set, the weight
5448     * for objects will normally be 0.0 for both axis, meaning the widget will
5449     * not be expanded. To take as much space possible, set the weight to
5450     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5451     *
5452     * Besides how much space each object is allocated, it's possible to control
5453     * how the widget will be placed within that space using
5454     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5455     * for both axis, meaning the object will be centered, but any value from
5456     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5457     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5458     * is -1.0, means the object will be resized to fill the entire space it
5459     * was allocated.
5460     *
5461     * In addition, customized functions to define the layout can be set, which
5462     * allow the application developer to organize the objects within the box
5463     * in any number of ways.
5464     *
5465     * The special elm_box_layout_transition() function can be used
5466     * to switch from one layout to another, animating the motion of the
5467     * children of the box.
5468     *
5469     * @note Objects should not be added to box objects using _add() calls.
5470     *
5471     * Some examples on how to use boxes follow:
5472     * @li @ref box_example_01
5473     * @li @ref box_example_02
5474     *
5475     * @{
5476     */
5477    /**
5478     * @typedef Elm_Box_Transition
5479     *
5480     * Opaque handler containing the parameters to perform an animated
5481     * transition of the layout the box uses.
5482     *
5483     * @see elm_box_transition_new()
5484     * @see elm_box_layout_set()
5485     * @see elm_box_layout_transition()
5486     */
5487    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5488
5489    /**
5490     * Add a new box to the parent
5491     *
5492     * By default, the box will be in vertical mode and non-homogeneous.
5493     *
5494     * @param parent The parent object
5495     * @return The new object or NULL if it cannot be created
5496     */
5497    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5498    /**
5499     * Set the horizontal orientation
5500     *
5501     * By default, box object arranges their contents vertically from top to
5502     * bottom.
5503     * By calling this function with @p horizontal as EINA_TRUE, the box will
5504     * become horizontal, arranging contents from left to right.
5505     *
5506     * @note This flag is ignored if a custom layout function is set.
5507     *
5508     * @param obj The box object
5509     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5510     * EINA_FALSE = vertical)
5511     */
5512    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5513    /**
5514     * Get the horizontal orientation
5515     *
5516     * @param obj The box object
5517     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5518     */
5519    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5520    /**
5521     * Set the box to arrange its children homogeneously
5522     *
5523     * If enabled, homogeneous layout makes all items the same size, according
5524     * to the size of the largest of its children.
5525     *
5526     * @note This flag is ignored if a custom layout function is set.
5527     *
5528     * @param obj The box object
5529     * @param homogeneous The homogeneous flag
5530     */
5531    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5532    /**
5533     * Get whether the box is using homogeneous mode or not
5534     *
5535     * @param obj The box object
5536     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5537     */
5538    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5539    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5540    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5541    /**
5542     * Add an object to the beginning of the pack list
5543     *
5544     * Pack @p subobj into the box @p obj, placing it first in the list of
5545     * children objects. The actual position the object will get on screen
5546     * depends on the layout used. If no custom layout is set, it will be at
5547     * the top or left, depending if the box is vertical or horizontal,
5548     * respectively.
5549     *
5550     * @param obj The box object
5551     * @param subobj The object to add to the box
5552     *
5553     * @see elm_box_pack_end()
5554     * @see elm_box_pack_before()
5555     * @see elm_box_pack_after()
5556     * @see elm_box_unpack()
5557     * @see elm_box_unpack_all()
5558     * @see elm_box_clear()
5559     */
5560    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5561    /**
5562     * Add an object at the end of the pack list
5563     *
5564     * Pack @p subobj into the box @p obj, placing it last in the list of
5565     * children objects. The actual position the object will get on screen
5566     * depends on the layout used. If no custom layout is set, it will be at
5567     * the bottom or right, depending if the box is vertical or horizontal,
5568     * respectively.
5569     *
5570     * @param obj The box object
5571     * @param subobj The object to add to the box
5572     *
5573     * @see elm_box_pack_start()
5574     * @see elm_box_pack_before()
5575     * @see elm_box_pack_after()
5576     * @see elm_box_unpack()
5577     * @see elm_box_unpack_all()
5578     * @see elm_box_clear()
5579     */
5580    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5581    /**
5582     * Adds an object to the box before the indicated object
5583     *
5584     * This will add the @p subobj to the box indicated before the object
5585     * indicated with @p before. If @p before is not already in the box, results
5586     * are undefined. Before means either to the left of the indicated object or
5587     * above it depending on orientation.
5588     *
5589     * @param obj The box object
5590     * @param subobj The object to add to the box
5591     * @param before The object before which to add it
5592     *
5593     * @see elm_box_pack_start()
5594     * @see elm_box_pack_end()
5595     * @see elm_box_pack_after()
5596     * @see elm_box_unpack()
5597     * @see elm_box_unpack_all()
5598     * @see elm_box_clear()
5599     */
5600    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5601    /**
5602     * Adds an object to the box after the indicated object
5603     *
5604     * This will add the @p subobj to the box indicated after the object
5605     * indicated with @p after. If @p after is not already in the box, results
5606     * are undefined. After means either to the right of the indicated object or
5607     * below it depending on orientation.
5608     *
5609     * @param obj The box object
5610     * @param subobj The object to add to the box
5611     * @param after The object after which to add it
5612     *
5613     * @see elm_box_pack_start()
5614     * @see elm_box_pack_end()
5615     * @see elm_box_pack_before()
5616     * @see elm_box_unpack()
5617     * @see elm_box_unpack_all()
5618     * @see elm_box_clear()
5619     */
5620    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5621    /**
5622     * Clear the box of all children
5623     *
5624     * Remove all the elements contained by the box, deleting the respective
5625     * objects.
5626     *
5627     * @param obj The box object
5628     *
5629     * @see elm_box_unpack()
5630     * @see elm_box_unpack_all()
5631     */
5632    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5633    /**
5634     * Unpack a box item
5635     *
5636     * Remove the object given by @p subobj from the box @p obj without
5637     * deleting it.
5638     *
5639     * @param obj The box object
5640     *
5641     * @see elm_box_unpack_all()
5642     * @see elm_box_clear()
5643     */
5644    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5645    /**
5646     * Remove all items from the box, without deleting them
5647     *
5648     * Clear the box from all children, but don't delete the respective objects.
5649     * If no other references of the box children exist, the objects will never
5650     * be deleted, and thus the application will leak the memory. Make sure
5651     * when using this function that you hold a reference to all the objects
5652     * in the box @p obj.
5653     *
5654     * @param obj The box object
5655     *
5656     * @see elm_box_clear()
5657     * @see elm_box_unpack()
5658     */
5659    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5660    /**
5661     * Retrieve a list of the objects packed into the box
5662     *
5663     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5664     * The order of the list corresponds to the packing order the box uses.
5665     *
5666     * You must free this list with eina_list_free() once you are done with it.
5667     *
5668     * @param obj The box object
5669     */
5670    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5671    /**
5672     * Set the space (padding) between the box's elements.
5673     *
5674     * Extra space in pixels that will be added between a box child and its
5675     * neighbors after its containing cell has been calculated. This padding
5676     * is set for all elements in the box, besides any possible padding that
5677     * individual elements may have through their size hints.
5678     *
5679     * @param obj The box object
5680     * @param horizontal The horizontal space between elements
5681     * @param vertical The vertical space between elements
5682     */
5683    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5684    /**
5685     * Get the space (padding) between the box's elements.
5686     *
5687     * @param obj The box object
5688     * @param horizontal The horizontal space between elements
5689     * @param vertical The vertical space between elements
5690     *
5691     * @see elm_box_padding_set()
5692     */
5693    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5694    /**
5695     * Set the alignment of the whole bouding box of contents.
5696     *
5697     * Sets how the bounding box containing all the elements of the box, after
5698     * their sizes and position has been calculated, will be aligned within
5699     * the space given for the whole box widget.
5700     *
5701     * @param obj The box object
5702     * @param horizontal The horizontal alignment of elements
5703     * @param vertical The vertical alignment of elements
5704     */
5705    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5706    /**
5707     * Get the alignment of the whole bouding box of contents.
5708     *
5709     * @param obj The box object
5710     * @param horizontal The horizontal alignment of elements
5711     * @param vertical The vertical alignment of elements
5712     *
5713     * @see elm_box_align_set()
5714     */
5715    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5716
5717    /**
5718     * Set the layout defining function to be used by the box
5719     *
5720     * Whenever anything changes that requires the box in @p obj to recalculate
5721     * the size and position of its elements, the function @p cb will be called
5722     * to determine what the layout of the children will be.
5723     *
5724     * Once a custom function is set, everything about the children layout
5725     * is defined by it. The flags set by elm_box_horizontal_set() and
5726     * elm_box_homogeneous_set() no longer have any meaning, and the values
5727     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5728     * layout function to decide if they are used and how. These last two
5729     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5730     * passed to @p cb. The @c Evas_Object the function receives is not the
5731     * Elementary widget, but the internal Evas Box it uses, so none of the
5732     * functions described here can be used on it.
5733     *
5734     * Any of the layout functions in @c Evas can be used here, as well as the
5735     * special elm_box_layout_transition().
5736     *
5737     * The final @p data argument received by @p cb is the same @p data passed
5738     * here, and the @p free_data function will be called to free it
5739     * whenever the box is destroyed or another layout function is set.
5740     *
5741     * Setting @p cb to NULL will revert back to the default layout function.
5742     *
5743     * @param obj The box object
5744     * @param cb The callback function used for layout
5745     * @param data Data that will be passed to layout function
5746     * @param free_data Function called to free @p data
5747     *
5748     * @see elm_box_layout_transition()
5749     */
5750    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);
5751    /**
5752     * Special layout function that animates the transition from one layout to another
5753     *
5754     * Normally, when switching the layout function for a box, this will be
5755     * reflected immediately on screen on the next render, but it's also
5756     * possible to do this through an animated transition.
5757     *
5758     * This is done by creating an ::Elm_Box_Transition and setting the box
5759     * layout to this function.
5760     *
5761     * For example:
5762     * @code
5763     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5764     *                            evas_object_box_layout_vertical, // start
5765     *                            NULL, // data for initial layout
5766     *                            NULL, // free function for initial data
5767     *                            evas_object_box_layout_horizontal, // end
5768     *                            NULL, // data for final layout
5769     *                            NULL, // free function for final data
5770     *                            anim_end, // will be called when animation ends
5771     *                            NULL); // data for anim_end function\
5772     * elm_box_layout_set(box, elm_box_layout_transition, t,
5773     *                    elm_box_transition_free);
5774     * @endcode
5775     *
5776     * @note This function can only be used with elm_box_layout_set(). Calling
5777     * it directly will not have the expected results.
5778     *
5779     * @see elm_box_transition_new
5780     * @see elm_box_transition_free
5781     * @see elm_box_layout_set
5782     */
5783    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5784    /**
5785     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5786     *
5787     * If you want to animate the change from one layout to another, you need
5788     * to set the layout function of the box to elm_box_layout_transition(),
5789     * passing as user data to it an instance of ::Elm_Box_Transition with the
5790     * necessary information to perform this animation. The free function to
5791     * set for the layout is elm_box_transition_free().
5792     *
5793     * The parameters to create an ::Elm_Box_Transition sum up to how long
5794     * will it be, in seconds, a layout function to describe the initial point,
5795     * another for the final position of the children and one function to be
5796     * called when the whole animation ends. This last function is useful to
5797     * set the definitive layout for the box, usually the same as the end
5798     * layout for the animation, but could be used to start another transition.
5799     *
5800     * @param start_layout The layout function that will be used to start the animation
5801     * @param start_layout_data The data to be passed the @p start_layout function
5802     * @param start_layout_free_data Function to free @p start_layout_data
5803     * @param end_layout The layout function that will be used to end the animation
5804     * @param end_layout_free_data The data to be passed the @p end_layout function
5805     * @param end_layout_free_data Function to free @p end_layout_data
5806     * @param transition_end_cb Callback function called when animation ends
5807     * @param transition_end_data Data to be passed to @p transition_end_cb
5808     * @return An instance of ::Elm_Box_Transition
5809     *
5810     * @see elm_box_transition_new
5811     * @see elm_box_layout_transition
5812     */
5813    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);
5814    /**
5815     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5816     *
5817     * This function is mostly useful as the @c free_data parameter in
5818     * elm_box_layout_set() when elm_box_layout_transition().
5819     *
5820     * @param data The Elm_Box_Transition instance to be freed.
5821     *
5822     * @see elm_box_transition_new
5823     * @see elm_box_layout_transition
5824     */
5825    EAPI void                elm_box_transition_free(void *data);
5826    /**
5827     * @}
5828     */
5829
5830    /* button */
5831    /**
5832     * @defgroup Button Button
5833     *
5834     * @image html img/widget/button/preview-00.png
5835     * @image latex img/widget/button/preview-00.eps
5836     * @image html img/widget/button/preview-01.png
5837     * @image latex img/widget/button/preview-01.eps
5838     * @image html img/widget/button/preview-02.png
5839     * @image latex img/widget/button/preview-02.eps
5840     *
5841     * This is a push-button. Press it and run some function. It can contain
5842     * a simple label and icon object and it also has an autorepeat feature.
5843     *
5844     * This widgets emits the following signals:
5845     * @li "clicked": the user clicked the button (press/release).
5846     * @li "repeated": the user pressed the button without releasing it.
5847     * @li "pressed": button was pressed.
5848     * @li "unpressed": button was released after being pressed.
5849     * In all three cases, the @c event parameter of the callback will be
5850     * @c NULL.
5851     *
5852     * Also, defined in the default theme, the button has the following styles
5853     * available:
5854     * @li default: a normal button.
5855     * @li anchor: Like default, but the button fades away when the mouse is not
5856     * over it, leaving only the text or icon.
5857     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5858     * continuous look across its options.
5859     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5860     *
5861     * Follow through a complete example @ref button_example_01 "here".
5862     * @{
5863     */
5864    /**
5865     * Add a new button to the parent's canvas
5866     *
5867     * @param parent The parent object
5868     * @return The new object or NULL if it cannot be created
5869     */
5870    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5871    /**
5872     * Set the label used in the button
5873     *
5874     * The passed @p label can be NULL to clean any existing text in it and
5875     * leave the button as an icon only object.
5876     *
5877     * @param obj The button object
5878     * @param label The text will be written on the button
5879     * @deprecated use elm_object_text_set() instead.
5880     */
5881    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5882    /**
5883     * Get the label set for the button
5884     *
5885     * The string returned is an internal pointer and should not be freed or
5886     * altered. It will also become invalid when the button is destroyed.
5887     * The string returned, if not NULL, is a stringshare, so if you need to
5888     * keep it around even after the button is destroyed, you can use
5889     * eina_stringshare_ref().
5890     *
5891     * @param obj The button object
5892     * @return The text set to the label, or NULL if nothing is set
5893     * @deprecated use elm_object_text_set() instead.
5894     */
5895    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5896    /**
5897     * Set the icon used for the button
5898     *
5899     * Setting a new icon will delete any other that was previously set, making
5900     * any reference to them invalid. If you need to maintain the previous
5901     * object alive, unset it first with elm_button_icon_unset().
5902     *
5903     * @param obj The button object
5904     * @param icon The icon object for the button
5905     */
5906    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5907    /**
5908     * Get the icon used for the button
5909     *
5910     * Return the icon object which is set for this widget. If the button is
5911     * destroyed or another icon is set, the returned object will be deleted
5912     * and any reference to it will be invalid.
5913     *
5914     * @param obj The button object
5915     * @return The icon object that is being used
5916     *
5917     * @see elm_button_icon_unset()
5918     */
5919    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5920    /**
5921     * Remove the icon set without deleting it and return the object
5922     *
5923     * This function drops the reference the button holds of the icon object
5924     * and returns this last object. It is used in case you want to remove any
5925     * icon, or set another one, without deleting the actual object. The button
5926     * will be left without an icon set.
5927     *
5928     * @param obj The button object
5929     * @return The icon object that was being used
5930     */
5931    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5932    /**
5933     * Turn on/off the autorepeat event generated when the button is kept pressed
5934     *
5935     * When off, no autorepeat is performed and buttons emit a normal @c clicked
5936     * signal when they are clicked.
5937     *
5938     * When on, keeping a button pressed will continuously emit a @c repeated
5939     * signal until the button is released. The time it takes until it starts
5940     * emitting the signal is given by
5941     * elm_button_autorepeat_initial_timeout_set(), and the time between each
5942     * new emission by elm_button_autorepeat_gap_timeout_set().
5943     *
5944     * @param obj The button object
5945     * @param on  A bool to turn on/off the event
5946     */
5947    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5948    /**
5949     * Get whether the autorepeat feature is enabled
5950     *
5951     * @param obj The button object
5952     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5953     *
5954     * @see elm_button_autorepeat_set()
5955     */
5956    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5957    /**
5958     * Set the initial timeout before the autorepeat event is generated
5959     *
5960     * Sets the timeout, in seconds, since the button is pressed until the
5961     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5962     * won't be any delay and the even will be fired the moment the button is
5963     * pressed.
5964     *
5965     * @param obj The button object
5966     * @param t   Timeout in seconds
5967     *
5968     * @see elm_button_autorepeat_set()
5969     * @see elm_button_autorepeat_gap_timeout_set()
5970     */
5971    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5972    /**
5973     * Get the initial timeout before the autorepeat event is generated
5974     *
5975     * @param obj The button object
5976     * @return Timeout in seconds
5977     *
5978     * @see elm_button_autorepeat_initial_timeout_set()
5979     */
5980    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5981    /**
5982     * Set the interval between each generated autorepeat event
5983     *
5984     * After the first @c repeated event is fired, all subsequent ones will
5985     * follow after a delay of @p t seconds for each.
5986     *
5987     * @param obj The button object
5988     * @param t   Interval in seconds
5989     *
5990     * @see elm_button_autorepeat_initial_timeout_set()
5991     */
5992    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5993    /**
5994     * Get the interval between each generated autorepeat event
5995     *
5996     * @param obj The button object
5997     * @return Interval in seconds
5998     */
5999    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6000    /**
6001     * @}
6002     */
6003
6004    /**
6005     * @defgroup File_Selector_Button File Selector Button
6006     *
6007     * @image html img/widget/fileselector_button/preview-00.png
6008     * @image latex img/widget/fileselector_button/preview-00.eps
6009     * @image html img/widget/fileselector_button/preview-01.png
6010     * @image latex img/widget/fileselector_button/preview-01.eps
6011     * @image html img/widget/fileselector_button/preview-02.png
6012     * @image latex img/widget/fileselector_button/preview-02.eps
6013     *
6014     * This is a button that, when clicked, creates an Elementary
6015     * window (or inner window) <b> with a @ref Fileselector "file
6016     * selector widget" within</b>. When a file is chosen, the (inner)
6017     * window is closed and the button emits a signal having the
6018     * selected file as it's @c event_info.
6019     *
6020     * This widget encapsulates operations on its internal file
6021     * selector on its own API. There is less control over its file
6022     * selector than that one would have instatiating one directly.
6023     *
6024     * The following styles are available for this button:
6025     * @li @c "default"
6026     * @li @c "anchor"
6027     * @li @c "hoversel_vertical"
6028     * @li @c "hoversel_vertical_entry"
6029     *
6030     * Smart callbacks one can register to:
6031     * - @c "file,chosen" - the user has selected a path, whose string
6032     *   pointer comes as the @c event_info data (a stringshared
6033     *   string)
6034     *
6035     * Here is an example on its usage:
6036     * @li @ref fileselector_button_example
6037     *
6038     * @see @ref File_Selector_Entry for a similar widget.
6039     * @{
6040     */
6041
6042    /**
6043     * Add a new file selector button widget to the given parent
6044     * Elementary (container) object
6045     *
6046     * @param parent The parent object
6047     * @return a new file selector button widget handle or @c NULL, on
6048     * errors
6049     */
6050    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6051
6052    /**
6053     * Set the label for a given file selector button widget
6054     *
6055     * @param obj The file selector button widget
6056     * @param label The text label to be displayed on @p obj
6057     *
6058     * @deprecated use elm_object_text_set() instead.
6059     */
6060    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6061
6062    /**
6063     * Get the label set for a given file selector button widget
6064     *
6065     * @param obj The file selector button widget
6066     * @return The button label
6067     *
6068     * @deprecated use elm_object_text_set() instead.
6069     */
6070    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6071
6072    /**
6073     * Set the icon on a given file selector button widget
6074     *
6075     * @param obj The file selector button widget
6076     * @param icon The icon object for the button
6077     *
6078     * Once the icon object is set, a previously set one will be
6079     * deleted. If you want to keep the latter, use the
6080     * elm_fileselector_button_icon_unset() function.
6081     *
6082     * @see elm_fileselector_button_icon_get()
6083     */
6084    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6085
6086    /**
6087     * Get the icon set for a given file selector button widget
6088     *
6089     * @param obj The file selector button widget
6090     * @return The icon object currently set on @p obj or @c NULL, if
6091     * none is
6092     *
6093     * @see elm_fileselector_button_icon_set()
6094     */
6095    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6096
6097    /**
6098     * Unset the icon used in a given file selector button widget
6099     *
6100     * @param obj The file selector button widget
6101     * @return The icon object that was being used on @p obj or @c
6102     * NULL, on errors
6103     *
6104     * Unparent and return the icon object which was set for this
6105     * widget.
6106     *
6107     * @see elm_fileselector_button_icon_set()
6108     */
6109    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6110
6111    /**
6112     * Set the title for a given file selector button widget's window
6113     *
6114     * @param obj The file selector button widget
6115     * @param title The title string
6116     *
6117     * This will change the window's title, when the file selector pops
6118     * out after a click on the button. Those windows have the default
6119     * (unlocalized) value of @c "Select a file" as titles.
6120     *
6121     * @note It will only take any effect if the file selector
6122     * button widget is @b not under "inwin mode".
6123     *
6124     * @see elm_fileselector_button_window_title_get()
6125     */
6126    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6127
6128    /**
6129     * Get the title set for a given file selector button widget's
6130     * window
6131     *
6132     * @param obj The file selector button widget
6133     * @return Title of the file selector button's window
6134     *
6135     * @see elm_fileselector_button_window_title_get() for more details
6136     */
6137    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6138
6139    /**
6140     * Set the size of a given file selector button widget's window,
6141     * holding the file selector itself.
6142     *
6143     * @param obj The file selector button widget
6144     * @param width The window's width
6145     * @param height The window's height
6146     *
6147     * @note it will only take any effect if the file selector button
6148     * widget is @b not under "inwin mode". The default size for the
6149     * window (when applicable) is 400x400 pixels.
6150     *
6151     * @see elm_fileselector_button_window_size_get()
6152     */
6153    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6154
6155    /**
6156     * Get the size of a given file selector button widget's window,
6157     * holding the file selector itself.
6158     *
6159     * @param obj The file selector button widget
6160     * @param width Pointer into which to store the width value
6161     * @param height Pointer into which to store the height value
6162     *
6163     * @note Use @c NULL pointers on the size values you're not
6164     * interested in: they'll be ignored by the function.
6165     *
6166     * @see elm_fileselector_button_window_size_set(), for more details
6167     */
6168    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6169
6170    /**
6171     * Set the initial file system path for a given file selector
6172     * button widget
6173     *
6174     * @param obj The file selector button widget
6175     * @param path The path string
6176     *
6177     * It must be a <b>directory</b> path, which will have the contents
6178     * displayed initially in the file selector's view, when invoked
6179     * from @p obj. The default initial path is the @c "HOME"
6180     * environment variable's value.
6181     *
6182     * @see elm_fileselector_button_path_get()
6183     */
6184    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6185
6186    /**
6187     * Get the initial file system path set for a given file selector
6188     * button widget
6189     *
6190     * @param obj The file selector button widget
6191     * @return path The path string
6192     *
6193     * @see elm_fileselector_button_path_set() for more details
6194     */
6195    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6196
6197    /**
6198     * Enable/disable a tree view in the given file selector button
6199     * widget's internal file selector
6200     *
6201     * @param obj The file selector button widget
6202     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6203     * disable
6204     *
6205     * This has the same effect as elm_fileselector_expandable_set(),
6206     * but now applied to a file selector button's internal file
6207     * selector.
6208     *
6209     * @note There's no way to put a file selector button's internal
6210     * file selector in "grid mode", as one may do with "pure" file
6211     * selectors.
6212     *
6213     * @see elm_fileselector_expandable_get()
6214     */
6215    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6216
6217    /**
6218     * Get whether tree view is enabled for the given file selector
6219     * button widget's internal file selector
6220     *
6221     * @param obj The file selector button widget
6222     * @return @c EINA_TRUE if @p obj widget's internal file selector
6223     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6224     *
6225     * @see elm_fileselector_expandable_set() for more details
6226     */
6227    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6228
6229    /**
6230     * Set whether a given file selector button widget's internal file
6231     * selector is to display folders only or the directory contents,
6232     * as well.
6233     *
6234     * @param obj The file selector button widget
6235     * @param only @c EINA_TRUE to make @p obj widget's internal file
6236     * selector only display directories, @c EINA_FALSE to make files
6237     * to be displayed in it too
6238     *
6239     * This has the same effect as elm_fileselector_folder_only_set(),
6240     * but now applied to a file selector button's internal file
6241     * selector.
6242     *
6243     * @see elm_fileselector_folder_only_get()
6244     */
6245    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6246
6247    /**
6248     * Get whether a given file selector button widget's internal file
6249     * selector is displaying folders only or the directory contents,
6250     * as well.
6251     *
6252     * @param obj The file selector button widget
6253     * @return @c EINA_TRUE if @p obj widget's internal file
6254     * selector is only displaying directories, @c EINA_FALSE if files
6255     * are being displayed in it too (and on errors)
6256     *
6257     * @see elm_fileselector_button_folder_only_set() for more details
6258     */
6259    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6260
6261    /**
6262     * Enable/disable the file name entry box where the user can type
6263     * in a name for a file, in a given file selector button widget's
6264     * internal file selector.
6265     *
6266     * @param obj The file selector button widget
6267     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6268     * file selector a "saving dialog", @c EINA_FALSE otherwise
6269     *
6270     * This has the same effect as elm_fileselector_is_save_set(),
6271     * but now applied to a file selector button's internal file
6272     * selector.
6273     *
6274     * @see elm_fileselector_is_save_get()
6275     */
6276    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6277
6278    /**
6279     * Get whether the given file selector button widget's internal
6280     * file selector is in "saving dialog" mode
6281     *
6282     * @param obj The file selector button widget
6283     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6284     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6285     * errors)
6286     *
6287     * @see elm_fileselector_button_is_save_set() for more details
6288     */
6289    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6290
6291    /**
6292     * Set whether a given file selector button widget's internal file
6293     * selector will raise an Elementary "inner window", instead of a
6294     * dedicated Elementary window. By default, it won't.
6295     *
6296     * @param obj The file selector button widget
6297     * @param value @c EINA_TRUE to make it use an inner window, @c
6298     * EINA_TRUE to make it use a dedicated window
6299     *
6300     * @see elm_win_inwin_add() for more information on inner windows
6301     * @see elm_fileselector_button_inwin_mode_get()
6302     */
6303    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6304
6305    /**
6306     * Get whether a given file selector button widget's internal file
6307     * selector will raise an Elementary "inner window", instead of a
6308     * dedicated Elementary window.
6309     *
6310     * @param obj The file selector button widget
6311     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6312     * if it will use a dedicated window
6313     *
6314     * @see elm_fileselector_button_inwin_mode_set() for more details
6315     */
6316    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6317
6318    /**
6319     * @}
6320     */
6321
6322     /**
6323     * @defgroup File_Selector_Entry File Selector Entry
6324     *
6325     * @image html img/widget/fileselector_entry/preview-00.png
6326     * @image latex img/widget/fileselector_entry/preview-00.eps
6327     *
6328     * This is an entry made to be filled with or display a <b>file
6329     * system path string</b>. Besides the entry itself, the widget has
6330     * a @ref File_Selector_Button "file selector button" on its side,
6331     * which will raise an internal @ref Fileselector "file selector widget",
6332     * when clicked, for path selection aided by file system
6333     * navigation.
6334     *
6335     * This file selector may appear in an Elementary window or in an
6336     * inner window. When a file is chosen from it, the (inner) window
6337     * is closed and the selected file's path string is exposed both as
6338     * an smart event and as the new text on the entry.
6339     *
6340     * This widget encapsulates operations on its internal file
6341     * selector on its own API. There is less control over its file
6342     * selector than that one would have instatiating one directly.
6343     *
6344     * Smart callbacks one can register to:
6345     * - @c "changed" - The text within the entry was changed
6346     * - @c "activated" - The entry has had editing finished and
6347     *   changes are to be "committed"
6348     * - @c "press" - The entry has been clicked
6349     * - @c "longpressed" - The entry has been clicked (and held) for a
6350     *   couple seconds
6351     * - @c "clicked" - The entry has been clicked
6352     * - @c "clicked,double" - The entry has been double clicked
6353     * - @c "focused" - The entry has received focus
6354     * - @c "unfocused" - The entry has lost focus
6355     * - @c "selection,paste" - A paste action has occurred on the
6356     *   entry
6357     * - @c "selection,copy" - A copy action has occurred on the entry
6358     * - @c "selection,cut" - A cut action has occurred on the entry
6359     * - @c "unpressed" - The file selector entry's button was released
6360     *   after being pressed.
6361     * - @c "file,chosen" - The user has selected a path via the file
6362     *   selector entry's internal file selector, whose string pointer
6363     *   comes as the @c event_info data (a stringshared string)
6364     *
6365     * Here is an example on its usage:
6366     * @li @ref fileselector_entry_example
6367     *
6368     * @see @ref File_Selector_Button for a similar widget.
6369     * @{
6370     */
6371
6372    /**
6373     * Add a new file selector entry widget to the given parent
6374     * Elementary (container) object
6375     *
6376     * @param parent The parent object
6377     * @return a new file selector entry widget handle or @c NULL, on
6378     * errors
6379     */
6380    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6381
6382    /**
6383     * Set the label for a given file selector entry widget's button
6384     *
6385     * @param obj The file selector entry widget
6386     * @param label The text label to be displayed on @p obj widget's
6387     * button
6388     *
6389     * @deprecated use elm_object_text_set() instead.
6390     */
6391    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6392
6393    /**
6394     * Get the label set for a given file selector entry widget's button
6395     *
6396     * @param obj The file selector entry widget
6397     * @return The widget button's label
6398     *
6399     * @deprecated use elm_object_text_set() instead.
6400     */
6401    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6402
6403    /**
6404     * Set the icon on a given file selector entry widget's button
6405     *
6406     * @param obj The file selector entry widget
6407     * @param icon The icon object for the entry's button
6408     *
6409     * Once the icon object is set, a previously set one will be
6410     * deleted. If you want to keep the latter, use the
6411     * elm_fileselector_entry_button_icon_unset() function.
6412     *
6413     * @see elm_fileselector_entry_button_icon_get()
6414     */
6415    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6416
6417    /**
6418     * Get the icon set for a given file selector entry widget's button
6419     *
6420     * @param obj The file selector entry widget
6421     * @return The icon object currently set on @p obj widget's button
6422     * or @c NULL, if none is
6423     *
6424     * @see elm_fileselector_entry_button_icon_set()
6425     */
6426    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6427
6428    /**
6429     * Unset the icon used in a given file selector entry widget's
6430     * button
6431     *
6432     * @param obj The file selector entry widget
6433     * @return The icon object that was being used on @p obj widget's
6434     * button or @c NULL, on errors
6435     *
6436     * Unparent and return the icon object which was set for this
6437     * widget's button.
6438     *
6439     * @see elm_fileselector_entry_button_icon_set()
6440     */
6441    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6442
6443    /**
6444     * Set the title for a given file selector entry widget's window
6445     *
6446     * @param obj The file selector entry widget
6447     * @param title The title string
6448     *
6449     * This will change the window's title, when the file selector pops
6450     * out after a click on the entry's button. Those windows have the
6451     * default (unlocalized) value of @c "Select a file" as titles.
6452     *
6453     * @note It will only take any effect if the file selector
6454     * entry widget is @b not under "inwin mode".
6455     *
6456     * @see elm_fileselector_entry_window_title_get()
6457     */
6458    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6459
6460    /**
6461     * Get the title set for a given file selector entry widget's
6462     * window
6463     *
6464     * @param obj The file selector entry widget
6465     * @return Title of the file selector entry's window
6466     *
6467     * @see elm_fileselector_entry_window_title_get() for more details
6468     */
6469    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6470
6471    /**
6472     * Set the size of a given file selector entry widget's window,
6473     * holding the file selector itself.
6474     *
6475     * @param obj The file selector entry widget
6476     * @param width The window's width
6477     * @param height The window's height
6478     *
6479     * @note it will only take any effect if the file selector entry
6480     * widget is @b not under "inwin mode". The default size for the
6481     * window (when applicable) is 400x400 pixels.
6482     *
6483     * @see elm_fileselector_entry_window_size_get()
6484     */
6485    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6486
6487    /**
6488     * Get the size of a given file selector entry widget's window,
6489     * holding the file selector itself.
6490     *
6491     * @param obj The file selector entry widget
6492     * @param width Pointer into which to store the width value
6493     * @param height Pointer into which to store the height value
6494     *
6495     * @note Use @c NULL pointers on the size values you're not
6496     * interested in: they'll be ignored by the function.
6497     *
6498     * @see elm_fileselector_entry_window_size_set(), for more details
6499     */
6500    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6501
6502    /**
6503     * Set the initial file system path and the entry's path string for
6504     * a given file selector entry widget
6505     *
6506     * @param obj The file selector entry widget
6507     * @param path The path string
6508     *
6509     * It must be a <b>directory</b> path, which will have the contents
6510     * displayed initially in the file selector's view, when invoked
6511     * from @p obj. The default initial path is the @c "HOME"
6512     * environment variable's value.
6513     *
6514     * @see elm_fileselector_entry_path_get()
6515     */
6516    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6517
6518    /**
6519     * Get the entry's path string for a given file selector entry
6520     * widget
6521     *
6522     * @param obj The file selector entry widget
6523     * @return path The path string
6524     *
6525     * @see elm_fileselector_entry_path_set() for more details
6526     */
6527    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6528
6529    /**
6530     * Enable/disable a tree view in the given file selector entry
6531     * widget's internal file selector
6532     *
6533     * @param obj The file selector entry widget
6534     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6535     * disable
6536     *
6537     * This has the same effect as elm_fileselector_expandable_set(),
6538     * but now applied to a file selector entry's internal file
6539     * selector.
6540     *
6541     * @note There's no way to put a file selector entry's internal
6542     * file selector in "grid mode", as one may do with "pure" file
6543     * selectors.
6544     *
6545     * @see elm_fileselector_expandable_get()
6546     */
6547    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6548
6549    /**
6550     * Get whether tree view is enabled for the given file selector
6551     * entry widget's internal file selector
6552     *
6553     * @param obj The file selector entry widget
6554     * @return @c EINA_TRUE if @p obj widget's internal file selector
6555     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6556     *
6557     * @see elm_fileselector_expandable_set() for more details
6558     */
6559    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6560
6561    /**
6562     * Set whether a given file selector entry widget's internal file
6563     * selector is to display folders only or the directory contents,
6564     * as well.
6565     *
6566     * @param obj The file selector entry widget
6567     * @param only @c EINA_TRUE to make @p obj widget's internal file
6568     * selector only display directories, @c EINA_FALSE to make files
6569     * to be displayed in it too
6570     *
6571     * This has the same effect as elm_fileselector_folder_only_set(),
6572     * but now applied to a file selector entry's internal file
6573     * selector.
6574     *
6575     * @see elm_fileselector_folder_only_get()
6576     */
6577    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6578
6579    /**
6580     * Get whether a given file selector entry widget's internal file
6581     * selector is displaying folders only or the directory contents,
6582     * as well.
6583     *
6584     * @param obj The file selector entry widget
6585     * @return @c EINA_TRUE if @p obj widget's internal file
6586     * selector is only displaying directories, @c EINA_FALSE if files
6587     * are being displayed in it too (and on errors)
6588     *
6589     * @see elm_fileselector_entry_folder_only_set() for more details
6590     */
6591    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6592
6593    /**
6594     * Enable/disable the file name entry box where the user can type
6595     * in a name for a file, in a given file selector entry widget's
6596     * internal file selector.
6597     *
6598     * @param obj The file selector entry widget
6599     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6600     * file selector a "saving dialog", @c EINA_FALSE otherwise
6601     *
6602     * This has the same effect as elm_fileselector_is_save_set(),
6603     * but now applied to a file selector entry's internal file
6604     * selector.
6605     *
6606     * @see elm_fileselector_is_save_get()
6607     */
6608    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6609
6610    /**
6611     * Get whether the given file selector entry widget's internal
6612     * file selector is in "saving dialog" mode
6613     *
6614     * @param obj The file selector entry widget
6615     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6616     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6617     * errors)
6618     *
6619     * @see elm_fileselector_entry_is_save_set() for more details
6620     */
6621    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6622
6623    /**
6624     * Set whether a given file selector entry widget's internal file
6625     * selector will raise an Elementary "inner window", instead of a
6626     * dedicated Elementary window. By default, it won't.
6627     *
6628     * @param obj The file selector entry widget
6629     * @param value @c EINA_TRUE to make it use an inner window, @c
6630     * EINA_TRUE to make it use a dedicated window
6631     *
6632     * @see elm_win_inwin_add() for more information on inner windows
6633     * @see elm_fileselector_entry_inwin_mode_get()
6634     */
6635    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6636
6637    /**
6638     * Get whether a given file selector entry widget's internal file
6639     * selector will raise an Elementary "inner window", instead of a
6640     * dedicated Elementary window.
6641     *
6642     * @param obj The file selector entry widget
6643     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6644     * if it will use a dedicated window
6645     *
6646     * @see elm_fileselector_entry_inwin_mode_set() for more details
6647     */
6648    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6649
6650    /**
6651     * Set the initial file system path for a given file selector entry
6652     * widget
6653     *
6654     * @param obj The file selector entry widget
6655     * @param path The path string
6656     *
6657     * It must be a <b>directory</b> path, which will have the contents
6658     * displayed initially in the file selector's view, when invoked
6659     * from @p obj. The default initial path is the @c "HOME"
6660     * environment variable's value.
6661     *
6662     * @see elm_fileselector_entry_path_get()
6663     */
6664    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6665
6666    /**
6667     * Get the parent directory's path to the latest file selection on
6668     * a given filer selector entry widget
6669     *
6670     * @param obj The file selector object
6671     * @return The (full) path of the directory of the last selection
6672     * on @p obj widget, a @b stringshared string
6673     *
6674     * @see elm_fileselector_entry_path_set()
6675     */
6676    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6677
6678    /**
6679     * @}
6680     */
6681
6682    /**
6683     * @defgroup Scroller Scroller
6684     *
6685     * A scroller holds a single object and "scrolls it around". This means that
6686     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6687     * region around, allowing to move through a much larger object that is
6688     * contained in the scroller. The scroiller will always have a small minimum
6689     * size by default as it won't be limited by the contents of the scroller.
6690     *
6691     * Signals that you can add callbacks for are:
6692     * @li "edge,left" - the left edge of the content has been reached
6693     * @li "edge,right" - the right edge of the content has been reached
6694     * @li "edge,top" - the top edge of the content has been reached
6695     * @li "edge,bottom" - the bottom edge of the content has been reached
6696     * @li "scroll" - the content has been scrolled (moved)
6697     * @li "scroll,anim,start" - scrolling animation has started
6698     * @li "scroll,anim,stop" - scrolling animation has stopped
6699     * @li "scroll,drag,start" - dragging the contents around has started
6700     * @li "scroll,drag,stop" - dragging the contents around has stopped
6701     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6702     * user intervetion.
6703     *
6704     * @note When Elemementary is in embedded mode the scrollbars will not be
6705     * dragable, they appear merely as indicators of how much has been scrolled.
6706     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6707     * fingerscroll) won't work.
6708     *
6709     * In @ref tutorial_scroller you'll find an example of how to use most of
6710     * this API.
6711     * @{
6712     */
6713    /**
6714     * @brief Type that controls when scrollbars should appear.
6715     *
6716     * @see elm_scroller_policy_set()
6717     */
6718    typedef enum _Elm_Scroller_Policy
6719      {
6720         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6721         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6722         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6723         ELM_SCROLLER_POLICY_LAST
6724      } Elm_Scroller_Policy;
6725    /**
6726     * @brief Add a new scroller to the parent
6727     *
6728     * @param parent The parent object
6729     * @return The new object or NULL if it cannot be created
6730     */
6731    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6732    /**
6733     * @brief Set the content of the scroller widget (the object to be scrolled around).
6734     *
6735     * @param obj The scroller object
6736     * @param content The new content object
6737     *
6738     * Once the content object is set, a previously set one will be deleted.
6739     * If you want to keep that old content object, use the
6740     * elm_scroller_content_unset() function.
6741     */
6742    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6743    /**
6744     * @brief Get the content of the scroller widget
6745     *
6746     * @param obj The slider object
6747     * @return The content that is being used
6748     *
6749     * Return the content object which is set for this widget
6750     *
6751     * @see elm_scroller_content_set()
6752     */
6753    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6754    /**
6755     * @brief Unset the content of the scroller widget
6756     *
6757     * @param obj The slider object
6758     * @return The content that was being used
6759     *
6760     * Unparent and return the content object which was set for this widget
6761     *
6762     * @see elm_scroller_content_set()
6763     */
6764    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6765    /**
6766     * @brief Set custom theme elements for the scroller
6767     *
6768     * @param obj The scroller object
6769     * @param widget The widget name to use (default is "scroller")
6770     * @param base The base name to use (default is "base")
6771     */
6772    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6773    /**
6774     * @brief Make the scroller minimum size limited to the minimum size of the content
6775     *
6776     * @param obj The scroller object
6777     * @param w Enable limiting minimum size horizontally
6778     * @param h Enable limiting minimum size vertically
6779     *
6780     * By default the scroller will be as small as its design allows,
6781     * irrespective of its content. This will make the scroller minimum size the
6782     * right size horizontally and/or vertically to perfectly fit its content in
6783     * that direction.
6784     */
6785    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6786    /**
6787     * @brief Show a specific virtual region within the scroller content object
6788     *
6789     * @param obj The scroller object
6790     * @param x X coordinate of the region
6791     * @param y Y coordinate of the region
6792     * @param w Width of the region
6793     * @param h Height of the region
6794     *
6795     * This will ensure all (or part if it does not fit) of the designated
6796     * region in the virtual content object (0, 0 starting at the top-left of the
6797     * virtual content object) is shown within the scroller.
6798     */
6799    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);
6800    /**
6801     * @brief Set the scrollbar visibility policy
6802     *
6803     * @param obj The scroller object
6804     * @param policy_h Horizontal scrollbar policy
6805     * @param policy_v Vertical scrollbar policy
6806     *
6807     * This sets the scrollbar visibility policy for the given scroller.
6808     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6809     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6810     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6811     * respectively for the horizontal and vertical scrollbars.
6812     */
6813    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6814    /**
6815     * @brief Gets scrollbar visibility policy
6816     *
6817     * @param obj The scroller object
6818     * @param policy_h Horizontal scrollbar policy
6819     * @param policy_v Vertical scrollbar policy
6820     *
6821     * @see elm_scroller_policy_set()
6822     */
6823    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6824    /**
6825     * @brief Get the currently visible content region
6826     *
6827     * @param obj The scroller object
6828     * @param x X coordinate of the region
6829     * @param y Y coordinate of the region
6830     * @param w Width of the region
6831     * @param h Height of the region
6832     *
6833     * This gets the current region in the content object that is visible through
6834     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6835     * w, @p h values pointed to.
6836     *
6837     * @note All coordinates are relative to the content.
6838     *
6839     * @see elm_scroller_region_show()
6840     */
6841    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);
6842    /**
6843     * @brief Get the size of the content object
6844     *
6845     * @param obj The scroller object
6846     * @param w Width return
6847     * @param h Height return
6848     *
6849     * This gets the size of the content object of the scroller.
6850     */
6851    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6852    /**
6853     * @brief Set bouncing behavior
6854     *
6855     * @param obj The scroller object
6856     * @param h_bounce Will the scroller bounce horizontally or not
6857     * @param v_bounce Will the scroller bounce vertically or not
6858     *
6859     * When scrolling, the scroller may "bounce" when reaching an edge of the
6860     * content object. This is a visual way to indicate the end has been reached.
6861     * This is enabled by default for both axis. This will set if it is enabled
6862     * for that axis with the boolean parameters for each axis.
6863     */
6864    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6865    /**
6866     * @brief Get the bounce mode
6867     *
6868     * @param obj The Scroller object
6869     * @param h_bounce Allow bounce horizontally
6870     * @param v_bounce Allow bounce vertically
6871     *
6872     * @see elm_scroller_bounce_set()
6873     */
6874    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6875    /**
6876     * @brief Set scroll page size relative to viewport size.
6877     *
6878     * @param obj The scroller object
6879     * @param h_pagerel The horizontal page relative size
6880     * @param v_pagerel The vertical page relative size
6881     *
6882     * The scroller is capable of limiting scrolling by the user to "pages". That
6883     * is to jump by and only show a "whole page" at a time as if the continuous
6884     * area of the scroller content is split into page sized pieces. This sets
6885     * the size of a page relative to the viewport of the scroller. 1.0 is "1
6886     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6887     * axis. This is mutually exclusive with page size
6888     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
6889     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6890     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6891     * the other axis.
6892     */
6893    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6894    /**
6895     * @brief Set scroll page size.
6896     *
6897     * @param obj The scroller object
6898     * @param h_pagesize The horizontal page size
6899     * @param v_pagesize The vertical page size
6900     *
6901     * This sets the page size to an absolute fixed value, with 0 turning it off
6902     * for that axis.
6903     *
6904     * @see elm_scroller_page_relative_set()
6905     */
6906    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6907    /**
6908     * @brief Show a specific virtual region within the scroller content object.
6909     *
6910     * @param obj The scroller object
6911     * @param x X coordinate of the region
6912     * @param y Y coordinate of the region
6913     * @param w Width of the region
6914     * @param h Height of the region
6915     *
6916     * This will ensure all (or part if it does not fit) of the designated
6917     * region in the virtual content object (0, 0 starting at the top-left of the
6918     * virtual content object) is shown within the scroller. Unlike
6919     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
6920     * to this location (if configuration in general calls for transitions). It
6921     * may not jump immediately to the new location and make take a while and
6922     * show other content along the way.
6923     *
6924     * @see elm_scroller_region_show()
6925     */
6926    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);
6927    /**
6928     * @brief Set event propagation on a scroller
6929     *
6930     * @param obj The scroller object
6931     * @param propagation If propagation is enabled or not
6932     *
6933     * This enables or disabled event propagation from the scroller content to
6934     * the scroller and its parent. By default event propagation is disabled.
6935     */
6936    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
6937    /**
6938     * @brief Get event propagation for a scroller
6939     *
6940     * @param obj The scroller object
6941     * @return The propagation state
6942     *
6943     * This gets the event propagation for a scroller.
6944     *
6945     * @see elm_scroller_propagate_events_set()
6946     */
6947    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
6948    /**
6949     * @}
6950     */
6951
6952    /**
6953     * @defgroup Label Label
6954     *
6955     * @image html img/widget/label/preview-00.png
6956     * @image latex img/widget/label/preview-00.eps
6957     *
6958     * @brief Widget to display text, with simple html-like markup.
6959     *
6960     * The Label widget @b doesn't allow text to overflow its boundaries, if the
6961     * text doesn't fit the geometry of the label it will be ellipsized or be
6962     * cut. Elementary provides several themes for this widget:
6963     * @li default - No animation
6964     * @li marker - Centers the text in the label and make it bold by default
6965     * @li slide_long - The entire text appears from the right of the screen and
6966     * slides until it disappears in the left of the screen(reappering on the
6967     * right again).
6968     * @li slide_short - The text appears in the left of the label and slides to
6969     * the right to show the overflow. When all of the text has been shown the
6970     * position is reset.
6971     * @li slide_bounce - The text appears in the left of the label and slides to
6972     * the right to show the overflow. When all of the text has been shown the
6973     * animation reverses, moving the text to the left.
6974     *
6975     * Custom themes can of course invent new markup tags and style them any way
6976     * they like.
6977     *
6978     * See @ref tutorial_label for a demonstration of how to use a label widget.
6979     * @{
6980     */
6981    /**
6982     * @brief Add a new label to the parent
6983     *
6984     * @param parent The parent object
6985     * @return The new object or NULL if it cannot be created
6986     */
6987    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6988    /**
6989     * @brief Set the label on the label object
6990     *
6991     * @param obj The label object
6992     * @param label The label will be used on the label object
6993     * @deprecated See elm_object_text_set()
6994     */
6995    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 */
6996    /**
6997     * @brief Get the label used on the label object
6998     *
6999     * @param obj The label object
7000     * @return The string inside the label
7001     * @deprecated See elm_object_text_get()
7002     */
7003    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7004    /**
7005     * @brief Set the wrapping behavior of the label
7006     *
7007     * @param obj The label object
7008     * @param wrap To wrap text or not
7009     *
7010     * By default no wrapping is done. Possible values for @p wrap are:
7011     * @li ELM_WRAP_NONE - No wrapping
7012     * @li ELM_WRAP_CHAR - wrap between characters
7013     * @li ELM_WRAP_WORD - wrap between words
7014     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7015     */
7016    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7017    /**
7018     * @brief Get the wrapping behavior of the label
7019     *
7020     * @param obj The label object
7021     * @return Wrap type
7022     *
7023     * @see elm_label_line_wrap_set()
7024     */
7025    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7026    /**
7027     * @brief Set wrap width of the label
7028     *
7029     * @param obj The label object
7030     * @param w The wrap width in pixels at a minimum where words need to wrap
7031     *
7032     * This function sets the maximum width size hint of the label.
7033     *
7034     * @warning This is only relevant if the label is inside a container.
7035     */
7036    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7037    /**
7038     * @brief Get wrap width of the label
7039     *
7040     * @param obj The label object
7041     * @return The wrap width in pixels at a minimum where words need to wrap
7042     *
7043     * @see elm_label_wrap_width_set()
7044     */
7045    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7046    /**
7047     * @brief Set wrap height of the label
7048     *
7049     * @param obj The label object
7050     * @param h The wrap height in pixels at a minimum where words need to wrap
7051     *
7052     * This function sets the maximum height size hint of the label.
7053     *
7054     * @warning This is only relevant if the label is inside a container.
7055     */
7056    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7057    /**
7058     * @brief get wrap width of the label
7059     *
7060     * @param obj The label object
7061     * @return The wrap height in pixels at a minimum where words need to wrap
7062     */
7063    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7064    /**
7065     * @brief Set the font size on the label object.
7066     *
7067     * @param obj The label object
7068     * @param size font size
7069     *
7070     * @warning NEVER use this. It is for hyper-special cases only. use styles
7071     * instead. e.g. "big", "medium", "small" - or better name them by use:
7072     * "title", "footnote", "quote" etc.
7073     */
7074    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7075    /**
7076     * @brief Set the text color on the label object
7077     *
7078     * @param obj The label object
7079     * @param r Red property background color of The label object
7080     * @param g Green property background color of The label object
7081     * @param b Blue property background color of The label object
7082     * @param a Alpha property background color of The label object
7083     *
7084     * @warning NEVER use this. It is for hyper-special cases only. use styles
7085     * instead. e.g. "big", "medium", "small" - or better name them by use:
7086     * "title", "footnote", "quote" etc.
7087     */
7088    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);
7089    /**
7090     * @brief Set the text align on the label object
7091     *
7092     * @param obj The label object
7093     * @param align align mode ("left", "center", "right")
7094     *
7095     * @warning NEVER use this. It is for hyper-special cases only. use styles
7096     * instead. e.g. "big", "medium", "small" - or better name them by use:
7097     * "title", "footnote", "quote" etc.
7098     */
7099    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7100    /**
7101     * @brief Set background color of the label
7102     *
7103     * @param obj The label object
7104     * @param r Red property background color of The label object
7105     * @param g Green property background color of The label object
7106     * @param b Blue property background color of The label object
7107     * @param a Alpha property background alpha of The label object
7108     *
7109     * @warning NEVER use this. It is for hyper-special cases only. use styles
7110     * instead. e.g. "big", "medium", "small" - or better name them by use:
7111     * "title", "footnote", "quote" etc.
7112     */
7113    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);
7114    /**
7115     * @brief Set the ellipsis behavior of the label
7116     *
7117     * @param obj The label object
7118     * @param ellipsis To ellipsis text or not
7119     *
7120     * If set to true and the text doesn't fit in the label an ellipsis("...")
7121     * will be shown at the end of the widget.
7122     *
7123     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7124     * choosen wrap method was ELM_WRAP_WORD.
7125     */
7126    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7127    /**
7128     * @brief Set the text slide of the label
7129     *
7130     * @param obj The label object
7131     * @param slide To start slide or stop
7132     *
7133     * If set to true the text of the label will slide throught the length of
7134     * label.
7135     *
7136     * @warning This only work with the themes "slide_short", "slide_long" and
7137     * "slide_bounce".
7138     */
7139    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7140    /**
7141     * @brief Get the text slide mode of the label
7142     *
7143     * @param obj The label object
7144     * @return slide slide mode value
7145     *
7146     * @see elm_label_slide_set()
7147     */
7148    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7149    /**
7150     * @brief Set the slide duration(speed) of the label
7151     *
7152     * @param obj The label object
7153     * @return The duration in seconds in moving text from slide begin position
7154     * to slide end position
7155     */
7156    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7157    /**
7158     * @brief Get the slide duration(speed) of the label
7159     *
7160     * @param obj The label object
7161     * @return The duration time in moving text from slide begin position to slide end position
7162     *
7163     * @see elm_label_slide_duration_set()
7164     */
7165    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7166    /**
7167     * @}
7168     */
7169
7170    /**
7171     * @defgroup Toggle Toggle
7172     *
7173     * @image html img/widget/toggle/preview-00.png
7174     * @image latex img/widget/toggle/preview-00.eps
7175     *
7176     * @brief A toggle is a slider which can be used to toggle between
7177     * two values.  It has two states: on and off.
7178     *
7179     * Signals that you can add callbacks for are:
7180     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7181     *                 until the toggle is released by the cursor (assuming it
7182     *                 has been triggered by the cursor in the first place).
7183     *
7184     * @ref tutorial_toggle show how to use a toggle.
7185     * @{
7186     */
7187    /**
7188     * @brief Add a toggle to @p parent.
7189     *
7190     * @param parent The parent object
7191     *
7192     * @return The toggle object
7193     */
7194    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7195    /**
7196     * @brief Sets the label to be displayed with the toggle.
7197     *
7198     * @param obj The toggle object
7199     * @param label The label to be displayed
7200     *
7201     * @deprecated use elm_object_text_set() instead.
7202     */
7203    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7204    /**
7205     * @brief Gets the label of the toggle
7206     *
7207     * @param obj  toggle object
7208     * @return The label of the toggle
7209     *
7210     * @deprecated use elm_object_text_get() instead.
7211     */
7212    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7213    /**
7214     * @brief Set the icon used for the toggle
7215     *
7216     * @param obj The toggle object
7217     * @param icon The icon object for the button
7218     *
7219     * Once the icon object is set, a previously set one will be deleted
7220     * If you want to keep that old content object, use the
7221     * elm_toggle_icon_unset() function.
7222     */
7223    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7224    /**
7225     * @brief Get the icon used for the toggle
7226     *
7227     * @param obj The toggle object
7228     * @return The icon object that is being used
7229     *
7230     * Return the icon object which is set for this widget.
7231     *
7232     * @see elm_toggle_icon_set()
7233     */
7234    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7235    /**
7236     * @brief Unset the icon used for the toggle
7237     *
7238     * @param obj The toggle object
7239     * @return The icon object that was being used
7240     *
7241     * Unparent and return the icon object which was set for this widget.
7242     *
7243     * @see elm_toggle_icon_set()
7244     */
7245    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7246    /**
7247     * @brief Sets the labels to be associated with the on and off states of the toggle.
7248     *
7249     * @param obj The toggle object
7250     * @param onlabel The label displayed when the toggle is in the "on" state
7251     * @param offlabel The label displayed when the toggle is in the "off" state
7252     */
7253    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7254    /**
7255     * @brief Gets the labels associated with the on and off states of the toggle.
7256     *
7257     * @param obj The toggle object
7258     * @param onlabel A char** to place the onlabel of @p obj into
7259     * @param offlabel A char** to place the offlabel of @p obj into
7260     */
7261    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7262    /**
7263     * @brief Sets the state of the toggle to @p state.
7264     *
7265     * @param obj The toggle object
7266     * @param state The state of @p obj
7267     */
7268    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7269    /**
7270     * @brief Gets the state of the toggle to @p state.
7271     *
7272     * @param obj The toggle object
7273     * @return The state of @p obj
7274     */
7275    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7276    /**
7277     * @brief Sets the state pointer of the toggle to @p statep.
7278     *
7279     * @param obj The toggle object
7280     * @param statep The state pointer of @p obj
7281     */
7282    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7283    /**
7284     * @}
7285     */
7286
7287    /**
7288     * @defgroup Frame Frame
7289     *
7290     * @image html img/widget/frame/preview-00.png
7291     * @image latex img/widget/frame/preview-00.eps
7292     *
7293     * @brief Frame is a widget that holds some content and has a title.
7294     *
7295     * The default look is a frame with a title, but Frame supports multple
7296     * styles:
7297     * @li default
7298     * @li pad_small
7299     * @li pad_medium
7300     * @li pad_large
7301     * @li pad_huge
7302     * @li outdent_top
7303     * @li outdent_bottom
7304     *
7305     * Of all this styles only default shows the title. Frame emits no signals.
7306     *
7307     * For a detailed example see the @ref tutorial_frame.
7308     *
7309     * @{
7310     */
7311    /**
7312     * @brief Add a new frame to the parent
7313     *
7314     * @param parent The parent object
7315     * @return The new object or NULL if it cannot be created
7316     */
7317    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7318    /**
7319     * @brief Set the frame label
7320     *
7321     * @param obj The frame object
7322     * @param label The label of this frame object
7323     *
7324     * @deprecated use elm_object_text_set() instead.
7325     */
7326    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7327    /**
7328     * @brief Get the frame label
7329     *
7330     * @param obj The frame object
7331     *
7332     * @return The label of this frame objet or NULL if unable to get frame
7333     *
7334     * @deprecated use elm_object_text_get() instead.
7335     */
7336    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7337    /**
7338     * @brief Set the content of the frame widget
7339     *
7340     * Once the content object is set, a previously set one will be deleted.
7341     * If you want to keep that old content object, use the
7342     * elm_frame_content_unset() function.
7343     *
7344     * @param obj The frame object
7345     * @param content The content will be filled in this frame object
7346     */
7347    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7348    /**
7349     * @brief Get the content of the frame widget
7350     *
7351     * Return the content object which is set for this widget
7352     *
7353     * @param obj The frame object
7354     * @return The content that is being used
7355     */
7356    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7357    /**
7358     * @brief Unset the content of the frame widget
7359     *
7360     * Unparent and return the content object which was set for this widget
7361     *
7362     * @param obj The frame object
7363     * @return The content that was being used
7364     */
7365    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7366    /**
7367     * @}
7368     */
7369
7370    /**
7371     * @defgroup Table Table
7372     *
7373     * A container widget to arrange other widgets in a table where items can
7374     * also span multiple columns or rows - even overlap (and then be raised or
7375     * lowered accordingly to adjust stacking if they do overlap).
7376     *
7377     * The followin are examples of how to use a table:
7378     * @li @ref tutorial_table_01
7379     * @li @ref tutorial_table_02
7380     *
7381     * @{
7382     */
7383    /**
7384     * @brief Add a new table to the parent
7385     *
7386     * @param parent The parent object
7387     * @return The new object or NULL if it cannot be created
7388     */
7389    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7390    /**
7391     * @brief Set the homogeneous layout in the table
7392     *
7393     * @param obj The layout object
7394     * @param homogeneous A boolean to set if the layout is homogeneous in the
7395     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7396     */
7397    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7398    /**
7399     * @brief Get the current table homogeneous mode.
7400     *
7401     * @param obj The table object
7402     * @return A boolean to indicating if the layout is homogeneous in the table
7403     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7404     */
7405    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7406    /**
7407     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7408     */
7409    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7410    /**
7411     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7412     */
7413    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7414    /**
7415     * @brief Set padding between cells.
7416     *
7417     * @param obj The layout object.
7418     * @param horizontal set the horizontal padding.
7419     * @param vertical set the vertical padding.
7420     *
7421     * Default value is 0.
7422     */
7423    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7424    /**
7425     * @brief Get padding between cells.
7426     *
7427     * @param obj The layout object.
7428     * @param horizontal set the horizontal padding.
7429     * @param vertical set the vertical padding.
7430     */
7431    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7432    /**
7433     * @brief Add a subobject on the table with the coordinates passed
7434     *
7435     * @param obj The table object
7436     * @param subobj The subobject to be added to the table
7437     * @param x Row number
7438     * @param y Column number
7439     * @param w rowspan
7440     * @param h colspan
7441     *
7442     * @note All positioning inside the table is relative to rows and columns, so
7443     * a value of 0 for x and y, means the top left cell of the table, and a
7444     * value of 1 for w and h means @p subobj only takes that 1 cell.
7445     */
7446    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7447    /**
7448     * @brief Remove child from table.
7449     *
7450     * @param obj The table object
7451     * @param subobj The subobject
7452     */
7453    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7454    /**
7455     * @brief Faster way to remove all child objects from a table object.
7456     *
7457     * @param obj The table object
7458     * @param clear If true, will delete children, else just remove from table.
7459     */
7460    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7461    /**
7462     * @brief Set the packing location of an existing child of the table
7463     *
7464     * @param subobj The subobject to be modified in the table
7465     * @param x Row number
7466     * @param y Column number
7467     * @param w rowspan
7468     * @param h colspan
7469     *
7470     * Modifies the position of an object already in the table.
7471     *
7472     * @note All positioning inside the table is relative to rows and columns, so
7473     * a value of 0 for x and y, means the top left cell of the table, and a
7474     * value of 1 for w and h means @p subobj only takes that 1 cell.
7475     */
7476    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7477    /**
7478     * @brief Get the packing location of an existing child of the table
7479     *
7480     * @param subobj The subobject to be modified in the table
7481     * @param x Row number
7482     * @param y Column number
7483     * @param w rowspan
7484     * @param h colspan
7485     *
7486     * @see elm_table_pack_set()
7487     */
7488    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7489    /**
7490     * @}
7491     */
7492
7493    /**
7494     * @defgroup Gengrid Gengrid (Generic grid)
7495     *
7496     * This widget aims to position objects in a grid layout while
7497     * actually creating and rendering only the visible ones, using the
7498     * same idea as the @ref Genlist "genlist": the user defines a @b
7499     * class for each item, specifying functions that will be called at
7500     * object creation, deletion, etc. When those items are selected by
7501     * the user, a callback function is issued. Users may interact with
7502     * a gengrid via the mouse (by clicking on items to select them and
7503     * clicking on the grid's viewport and swiping to pan the whole
7504     * view) or via the keyboard, navigating through item with the
7505     * arrow keys.
7506     *
7507     * @section Gengrid_Layouts Gengrid layouts
7508     *
7509     * Gengrids may layout its items in one of two possible layouts:
7510     * - horizontal or
7511     * - vertical.
7512     *
7513     * When in "horizontal mode", items will be placed in @b columns,
7514     * from top to bottom and, when the space for a column is filled,
7515     * another one is started on the right, thus expanding the grid
7516     * horizontally, making for horizontal scrolling. When in "vertical
7517     * mode" , though, items will be placed in @b rows, from left to
7518     * right and, when the space for a row is filled, another one is
7519     * started below, thus expanding the grid vertically (and making
7520     * for vertical scrolling).
7521     *
7522     * @section Gengrid_Items Gengrid items
7523     *
7524     * An item in a gengrid can have 0 or more text labels (they can be
7525     * regular text or textblock Evas objects - that's up to the style
7526     * to determine), 0 or more icons (which are simply objects
7527     * swallowed into the gengrid item's theming Edje object) and 0 or
7528     * more <b>boolean states</b>, which have the behavior left to the
7529     * user to define. The Edje part names for each of these properties
7530     * will be looked up, in the theme file for the gengrid, under the
7531     * Edje (string) data items named @c "labels", @c "icons" and @c
7532     * "states", respectively. For each of those properties, if more
7533     * than one part is provided, they must have names listed separated
7534     * by spaces in the data fields. For the default gengrid item
7535     * theme, we have @b one label part (@c "elm.text"), @b two icon
7536     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7537     * no state parts.
7538     *
7539     * A gengrid item may be at one of several styles. Elementary
7540     * provides one by default - "default", but this can be extended by
7541     * system or application custom themes/overlays/extensions (see
7542     * @ref Theme "themes" for more details).
7543     *
7544     * @section Gengrid_Item_Class Gengrid item classes
7545     *
7546     * In order to have the ability to add and delete items on the fly,
7547     * gengrid implements a class (callback) system where the
7548     * application provides a structure with information about that
7549     * type of item (gengrid may contain multiple different items with
7550     * different classes, states and styles). Gengrid will call the
7551     * functions in this struct (methods) when an item is "realized"
7552     * (i.e., created dynamically, while the user is scrolling the
7553     * grid). All objects will simply be deleted when no longer needed
7554     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7555     * contains the following members:
7556     * - @c item_style - This is a constant string and simply defines
7557     * the name of the item style. It @b must be specified and the
7558     * default should be @c "default".
7559     * - @c func.label_get - This function is called when an item
7560     * object is actually created. The @c data parameter will point to
7561     * the same data passed to elm_gengrid_item_append() and related
7562     * item creation functions. The @c obj parameter is the gengrid
7563     * object itself, while the @c part one is the name string of one
7564     * of the existing text parts in the Edje group implementing the
7565     * item's theme. This function @b must return a strdup'()ed string,
7566     * as the caller will free() it when done. See
7567     * #Elm_Gengrid_Item_Label_Get_Cb.
7568     * - @c func.icon_get - This function is called when an item object
7569     * is actually created. The @c data parameter will point to the
7570     * same data passed to elm_gengrid_item_append() and related item
7571     * creation functions. The @c obj parameter is the gengrid object
7572     * itself, while the @c part one is the name string of one of the
7573     * existing (icon) swallow parts in the Edje group implementing the
7574     * item's theme. It must return @c NULL, when no icon is desired,
7575     * or a valid object handle, otherwise. The object will be deleted
7576     * by the gengrid on its deletion or when the item is "unrealized".
7577     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7578     * - @c func.state_get - This function is called when an item
7579     * object is actually created. The @c data parameter will point to
7580     * the same data passed to elm_gengrid_item_append() and related
7581     * item creation functions. The @c obj parameter is the gengrid
7582     * object itself, while the @c part one is the name string of one
7583     * of the state parts in the Edje group implementing the item's
7584     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7585     * true/on. Gengrids will emit a signal to its theming Edje object
7586     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7587     * "source" arguments, respectively, when the state is true (the
7588     * default is false), where @c XXX is the name of the (state) part.
7589     * See #Elm_Gengrid_Item_State_Get_Cb.
7590     * - @c func.del - This is called when elm_gengrid_item_del() is
7591     * called on an item or elm_gengrid_clear() is called on the
7592     * gengrid. This is intended for use when gengrid items are
7593     * deleted, so any data attached to the item (e.g. its data
7594     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7595     *
7596     * @section Gengrid_Usage_Hints Usage hints
7597     *
7598     * If the user wants to have multiple items selected at the same
7599     * time, elm_gengrid_multi_select_set() will permit it. If the
7600     * gengrid is single-selection only (the default), then
7601     * elm_gengrid_select_item_get() will return the selected item or
7602     * @c NULL, if none is selected. If the gengrid is under
7603     * multi-selection, then elm_gengrid_selected_items_get() will
7604     * return a list (that is only valid as long as no items are
7605     * modified (added, deleted, selected or unselected) of child items
7606     * on a gengrid.
7607     *
7608     * If an item changes (internal (boolean) state, label or icon
7609     * changes), then use elm_gengrid_item_update() to have gengrid
7610     * update the item with the new state. A gengrid will re-"realize"
7611     * the item, thus calling the functions in the
7612     * #Elm_Gengrid_Item_Class set for that item.
7613     *
7614     * To programmatically (un)select an item, use
7615     * elm_gengrid_item_selected_set(). To get its selected state use
7616     * elm_gengrid_item_selected_get(). To make an item disabled
7617     * (unable to be selected and appear differently) use
7618     * elm_gengrid_item_disabled_set() to set this and
7619     * elm_gengrid_item_disabled_get() to get the disabled state.
7620     *
7621     * Grid cells will only have their selection smart callbacks called
7622     * when firstly getting selected. Any further clicks will do
7623     * nothing, unless you enable the "always select mode", with
7624     * elm_gengrid_always_select_mode_set(), thus making every click to
7625     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7626     * turn off the ability to select items entirely in the widget and
7627     * they will neither appear selected nor call the selection smart
7628     * callbacks.
7629     *
7630     * Remember that you can create new styles and add your own theme
7631     * augmentation per application with elm_theme_extension_add(). If
7632     * you absolutely must have a specific style that overrides any
7633     * theme the user or system sets up you can use
7634     * elm_theme_overlay_add() to add such a file.
7635     *
7636     * @section Gengrid_Smart_Events Gengrid smart events
7637     *
7638     * Smart events that you can add callbacks for are:
7639     * - @c "activated" - The user has double-clicked or pressed
7640     *   (enter|return|spacebar) on an item. The @c event_info parameter
7641     *   is the gengrid item that was activated.
7642     * - @c "clicked,double" - The user has double-clicked an item.
7643     *   The @c event_info parameter is the gengrid item that was double-clicked.
7644     * - @c "selected" - The user has made an item selected. The
7645     *   @c event_info parameter is the gengrid item that was selected.
7646     * - @c "unselected" - The user has made an item unselected. The
7647     *   @c event_info parameter is the gengrid item that was unselected.
7648     * - @c "realized" - This is called when the item in the gengrid
7649     *   has its implementing Evas object instantiated, de facto. @c
7650     *   event_info is the gengrid item that was created. The object
7651     *   may be deleted at any time, so it is highly advised to the
7652     *   caller @b not to use the object pointer returned from
7653     *   elm_gengrid_item_object_get(), because it may point to freed
7654     *   objects.
7655     * - @c "unrealized" - This is called when the implementing Evas
7656     *   object for this item is deleted. @c event_info is the gengrid
7657     *   item that was deleted.
7658     * - @c "changed" - Called when an item is added, removed, resized
7659     *   or moved and when the gengrid is resized or gets "horizontal"
7660     *   property changes.
7661     * - @c "drag,start,up" - Called when the item in the gengrid has
7662     *   been dragged (not scrolled) up.
7663     * - @c "drag,start,down" - Called when the item in the gengrid has
7664     *   been dragged (not scrolled) down.
7665     * - @c "drag,start,left" - Called when the item in the gengrid has
7666     *   been dragged (not scrolled) left.
7667     * - @c "drag,start,right" - Called when the item in the gengrid has
7668     *   been dragged (not scrolled) right.
7669     * - @c "drag,stop" - Called when the item in the gengrid has
7670     *   stopped being dragged.
7671     * - @c "drag" - Called when the item in the gengrid is being
7672     *   dragged.
7673     * - @c "scroll" - called when the content has been scrolled
7674     *   (moved).
7675     * - @c "scroll,drag,start" - called when dragging the content has
7676     *   started.
7677     * - @c "scroll,drag,stop" - called when dragging the content has
7678     *   stopped.
7679     *
7680     * List of gendrid examples:
7681     * @li @ref gengrid_example
7682     */
7683
7684    /**
7685     * @addtogroup Gengrid
7686     * @{
7687     */
7688
7689    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7690    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7691    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7692    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7693    typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
7694    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. */
7695    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7696
7697    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7698    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7699    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7700    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7701
7702    /**
7703     * @struct _Elm_Gengrid_Item_Class
7704     *
7705     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7706     * field details.
7707     */
7708    struct _Elm_Gengrid_Item_Class
7709      {
7710         const char             *item_style;
7711         struct _Elm_Gengrid_Item_Class_Func
7712           {
7713              Elm_Gengrid_Item_Label_Get_Cb label_get;
7714              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7715              Elm_Gengrid_Item_State_Get_Cb state_get;
7716              Elm_Gengrid_Item_Del_Cb       del;
7717           } func;
7718      }; /**< #Elm_Gengrid_Item_Class member definitions */
7719
7720    /**
7721     * Add a new gengrid widget to the given parent Elementary
7722     * (container) object
7723     *
7724     * @param parent The parent object
7725     * @return a new gengrid widget handle or @c NULL, on errors
7726     *
7727     * This function inserts a new gengrid widget on the canvas.
7728     *
7729     * @see elm_gengrid_item_size_set()
7730     * @see elm_gengrid_horizontal_set()
7731     * @see elm_gengrid_item_append()
7732     * @see elm_gengrid_item_del()
7733     * @see elm_gengrid_clear()
7734     *
7735     * @ingroup Gengrid
7736     */
7737    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7738
7739    /**
7740     * Set the size for the items of a given gengrid widget
7741     *
7742     * @param obj The gengrid object.
7743     * @param w The items' width.
7744     * @param h The items' height;
7745     *
7746     * A gengrid, after creation, has still no information on the size
7747     * to give to each of its cells. So, you most probably will end up
7748     * with squares one @ref Fingers "finger" wide, the default
7749     * size. Use this function to force a custom size for you items,
7750     * making them as big as you wish.
7751     *
7752     * @see elm_gengrid_item_size_get()
7753     *
7754     * @ingroup Gengrid
7755     */
7756    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7757
7758    /**
7759     * Get the size set for the items of a given gengrid widget
7760     *
7761     * @param obj The gengrid object.
7762     * @param w Pointer to a variable where to store the items' width.
7763     * @param h Pointer to a variable where to store the items' height.
7764     *
7765     * @note Use @c NULL pointers on the size values you're not
7766     * interested in: they'll be ignored by the function.
7767     *
7768     * @see elm_gengrid_item_size_get() for more details
7769     *
7770     * @ingroup Gengrid
7771     */
7772    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7773
7774    /**
7775     * Set the items grid's alignment within a given gengrid widget
7776     *
7777     * @param obj The gengrid object.
7778     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7779     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7780     *
7781     * This sets the alignment of the whole grid of items of a gengrid
7782     * within its given viewport. By default, those values are both
7783     * 0.5, meaning that the gengrid will have its items grid placed
7784     * exactly in the middle of its viewport.
7785     *
7786     * @note If given alignment values are out of the cited ranges,
7787     * they'll be changed to the nearest boundary values on the valid
7788     * ranges.
7789     *
7790     * @see elm_gengrid_align_get()
7791     *
7792     * @ingroup Gengrid
7793     */
7794    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7795
7796    /**
7797     * Get the items grid's alignment values within a given gengrid
7798     * widget
7799     *
7800     * @param obj The gengrid object.
7801     * @param align_x Pointer to a variable where to store the
7802     * horizontal alignment.
7803     * @param align_y Pointer to a variable where to store the vertical
7804     * alignment.
7805     *
7806     * @note Use @c NULL pointers on the alignment values you're not
7807     * interested in: they'll be ignored by the function.
7808     *
7809     * @see elm_gengrid_align_set() for more details
7810     *
7811     * @ingroup Gengrid
7812     */
7813    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7814
7815    /**
7816     * Set whether a given gengrid widget is or not able have items
7817     * @b reordered
7818     *
7819     * @param obj The gengrid object
7820     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7821     * @c EINA_FALSE to turn it off
7822     *
7823     * If a gengrid is set to allow reordering, a click held for more
7824     * than 0.5 over a given item will highlight it specially,
7825     * signalling the gengrid has entered the reordering state. From
7826     * that time on, the user will be able to, while still holding the
7827     * mouse button down, move the item freely in the gengrid's
7828     * viewport, replacing to said item to the locations it goes to.
7829     * The replacements will be animated and, whenever the user
7830     * releases the mouse button, the item being replaced gets a new
7831     * definitive place in the grid.
7832     *
7833     * @see elm_gengrid_reorder_mode_get()
7834     *
7835     * @ingroup Gengrid
7836     */
7837    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7838
7839    /**
7840     * Get whether a given gengrid widget is or not able have items
7841     * @b reordered
7842     *
7843     * @param obj The gengrid object
7844     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7845     * off
7846     *
7847     * @see elm_gengrid_reorder_mode_set() for more details
7848     *
7849     * @ingroup Gengrid
7850     */
7851    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7852
7853    /**
7854     * Append a new item in a given gengrid widget.
7855     *
7856     * @param obj The gengrid object.
7857     * @param gic The item class for the item.
7858     * @param data The item data.
7859     * @param func Convenience function called when the item is
7860     * selected.
7861     * @param func_data Data to be passed to @p func.
7862     * @return A handle to the item added or @c NULL, on errors.
7863     *
7864     * This adds an item to the beginning of the gengrid.
7865     *
7866     * @see elm_gengrid_item_prepend()
7867     * @see elm_gengrid_item_insert_before()
7868     * @see elm_gengrid_item_insert_after()
7869     * @see elm_gengrid_item_del()
7870     *
7871     * @ingroup Gengrid
7872     */
7873    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);
7874
7875    /**
7876     * Prepend a new item in a given gengrid widget.
7877     *
7878     * @param obj The gengrid object.
7879     * @param gic The item class for the item.
7880     * @param data The item data.
7881     * @param func Convenience function called when the item is
7882     * selected.
7883     * @param func_data Data to be passed to @p func.
7884     * @return A handle to the item added or @c NULL, on errors.
7885     *
7886     * This adds an item to the end of the gengrid.
7887     *
7888     * @see elm_gengrid_item_append()
7889     * @see elm_gengrid_item_insert_before()
7890     * @see elm_gengrid_item_insert_after()
7891     * @see elm_gengrid_item_del()
7892     *
7893     * @ingroup Gengrid
7894     */
7895    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);
7896
7897    /**
7898     * Insert an item before another in a gengrid widget
7899     *
7900     * @param obj The gengrid object.
7901     * @param gic The item class for the item.
7902     * @param data The item data.
7903     * @param relative The item to place this new one before.
7904     * @param func Convenience function called when the item is
7905     * selected.
7906     * @param func_data Data to be passed to @p func.
7907     * @return A handle to the item added or @c NULL, on errors.
7908     *
7909     * This inserts an item before another in the gengrid.
7910     *
7911     * @see elm_gengrid_item_append()
7912     * @see elm_gengrid_item_prepend()
7913     * @see elm_gengrid_item_insert_after()
7914     * @see elm_gengrid_item_del()
7915     *
7916     * @ingroup Gengrid
7917     */
7918    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);
7919
7920    /**
7921     * Insert an item after another in a gengrid widget
7922     *
7923     * @param obj The gengrid object.
7924     * @param gic The item class for the item.
7925     * @param data The item data.
7926     * @param relative The item to place this new one after.
7927     * @param func Convenience function called when the item is
7928     * selected.
7929     * @param func_data Data to be passed to @p func.
7930     * @return A handle to the item added or @c NULL, on errors.
7931     *
7932     * This inserts an item after another in the gengrid.
7933     *
7934     * @see elm_gengrid_item_append()
7935     * @see elm_gengrid_item_prepend()
7936     * @see elm_gengrid_item_insert_after()
7937     * @see elm_gengrid_item_del()
7938     *
7939     * @ingroup Gengrid
7940     */
7941    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);
7942
7943    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);
7944
7945    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);
7946
7947    /**
7948     * Set whether items on a given gengrid widget are to get their
7949     * selection callbacks issued for @b every subsequent selection
7950     * click on them or just for the first click.
7951     *
7952     * @param obj The gengrid object
7953     * @param always_select @c EINA_TRUE to make items "always
7954     * selected", @c EINA_FALSE, otherwise
7955     *
7956     * By default, grid items will only call their selection callback
7957     * function when firstly getting selected, any subsequent further
7958     * clicks will do nothing. With this call, you make those
7959     * subsequent clicks also to issue the selection callbacks.
7960     *
7961     * @note <b>Double clicks</b> will @b always be reported on items.
7962     *
7963     * @see elm_gengrid_always_select_mode_get()
7964     *
7965     * @ingroup Gengrid
7966     */
7967    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7968
7969    /**
7970     * Get whether items on a given gengrid widget have their selection
7971     * callbacks issued for @b every subsequent selection click on them
7972     * or just for the first click.
7973     *
7974     * @param obj The gengrid object.
7975     * @return @c EINA_TRUE if the gengrid items are "always selected",
7976     * @c EINA_FALSE, otherwise
7977     *
7978     * @see elm_gengrid_always_select_mode_set() for more details
7979     *
7980     * @ingroup Gengrid
7981     */
7982    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7983
7984    /**
7985     * Set whether items on a given gengrid widget can be selected or not.
7986     *
7987     * @param obj The gengrid object
7988     * @param no_select @c EINA_TRUE to make items selectable,
7989     * @c EINA_FALSE otherwise
7990     *
7991     * This will make items in @p obj selectable or not. In the latter
7992     * case, any user interacion on the gendrid items will neither make
7993     * them appear selected nor them call their selection callback
7994     * functions.
7995     *
7996     * @see elm_gengrid_no_select_mode_get()
7997     *
7998     * @ingroup Gengrid
7999     */
8000    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8001
8002    /**
8003     * Get whether items on a given gengrid widget can be selected or
8004     * not.
8005     *
8006     * @param obj The gengrid object
8007     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8008     * otherwise
8009     *
8010     * @see elm_gengrid_no_select_mode_set() for more details
8011     *
8012     * @ingroup Gengrid
8013     */
8014    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8015
8016    /**
8017     * Enable or disable multi-selection in a given gengrid widget
8018     *
8019     * @param obj The gengrid object.
8020     * @param multi @c EINA_TRUE, to enable multi-selection,
8021     * @c EINA_FALSE to disable it.
8022     *
8023     * Multi-selection is the ability for one to have @b more than one
8024     * item selected, on a given gengrid, simultaneously. When it is
8025     * enabled, a sequence of clicks on different items will make them
8026     * all selected, progressively. A click on an already selected item
8027     * will unselect it. If interecting via the keyboard,
8028     * multi-selection is enabled while holding the "Shift" key.
8029     *
8030     * @note By default, multi-selection is @b disabled on gengrids
8031     *
8032     * @see elm_gengrid_multi_select_get()
8033     *
8034     * @ingroup Gengrid
8035     */
8036    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8037
8038    /**
8039     * Get whether multi-selection is enabled or disabled for a given
8040     * gengrid widget
8041     *
8042     * @param obj The gengrid object.
8043     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8044     * EINA_FALSE otherwise
8045     *
8046     * @see elm_gengrid_multi_select_set() for more details
8047     *
8048     * @ingroup Gengrid
8049     */
8050    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8051
8052    /**
8053     * Enable or disable bouncing effect for a given gengrid widget
8054     *
8055     * @param obj The gengrid object
8056     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8057     * @c EINA_FALSE to disable it
8058     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8059     * @c EINA_FALSE to disable it
8060     *
8061     * The bouncing effect occurs whenever one reaches the gengrid's
8062     * edge's while panning it -- it will scroll past its limits a
8063     * little bit and return to the edge again, in a animated for,
8064     * automatically.
8065     *
8066     * @note By default, gengrids have bouncing enabled on both axis
8067     *
8068     * @see elm_gengrid_bounce_get()
8069     *
8070     * @ingroup Gengrid
8071     */
8072    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8073
8074    /**
8075     * Get whether bouncing effects are enabled or disabled, for a
8076     * given gengrid widget, on each axis
8077     *
8078     * @param obj The gengrid object
8079     * @param h_bounce Pointer to a variable where to store the
8080     * horizontal bouncing flag.
8081     * @param v_bounce Pointer to a variable where to store the
8082     * vertical bouncing flag.
8083     *
8084     * @see elm_gengrid_bounce_set() for more details
8085     *
8086     * @ingroup Gengrid
8087     */
8088    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8089
8090    /**
8091     * Set a given gengrid widget's scrolling page size, relative to
8092     * its viewport size.
8093     *
8094     * @param obj The gengrid object
8095     * @param h_pagerel The horizontal page (relative) size
8096     * @param v_pagerel The vertical page (relative) size
8097     *
8098     * The gengrid's scroller is capable of binding scrolling by the
8099     * user to "pages". It means that, while scrolling and, specially
8100     * after releasing the mouse button, the grid will @b snap to the
8101     * nearest displaying page's area. When page sizes are set, the
8102     * grid's continuous content area is split into (equal) page sized
8103     * pieces.
8104     *
8105     * This function sets the size of a page <b>relatively to the
8106     * viewport dimensions</b> of the gengrid, for each axis. A value
8107     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8108     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8109     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8110     * 1.0. Values beyond those will make it behave behave
8111     * inconsistently. If you only want one axis to snap to pages, use
8112     * the value @c 0.0 for the other one.
8113     *
8114     * There is a function setting page size values in @b absolute
8115     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8116     * is mutually exclusive to this one.
8117     *
8118     * @see elm_gengrid_page_relative_get()
8119     *
8120     * @ingroup Gengrid
8121     */
8122    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8123
8124    /**
8125     * Get a given gengrid widget's scrolling page size, relative to
8126     * its viewport size.
8127     *
8128     * @param obj The gengrid object
8129     * @param h_pagerel Pointer to a variable where to store the
8130     * horizontal page (relative) size
8131     * @param v_pagerel Pointer to a variable where to store the
8132     * vertical page (relative) size
8133     *
8134     * @see elm_gengrid_page_relative_set() for more details
8135     *
8136     * @ingroup Gengrid
8137     */
8138    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8139
8140    /**
8141     * Set a given gengrid widget's scrolling page size
8142     *
8143     * @param obj The gengrid object
8144     * @param h_pagerel The horizontal page size, in pixels
8145     * @param v_pagerel The vertical page size, in pixels
8146     *
8147     * The gengrid's scroller is capable of binding scrolling by the
8148     * user to "pages". It means that, while scrolling and, specially
8149     * after releasing the mouse button, the grid will @b snap to the
8150     * nearest displaying page's area. When page sizes are set, the
8151     * grid's continuous content area is split into (equal) page sized
8152     * pieces.
8153     *
8154     * This function sets the size of a page of the gengrid, in pixels,
8155     * for each axis. Sane usable values are, between @c 0 and the
8156     * dimensions of @p obj, for each axis. Values beyond those will
8157     * make it behave behave inconsistently. If you only want one axis
8158     * to snap to pages, use the value @c 0 for the other one.
8159     *
8160     * There is a function setting page size values in @b relative
8161     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8162     * use is mutually exclusive to this one.
8163     *
8164     * @ingroup Gengrid
8165     */
8166    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8167
8168    /**
8169     * Set for what direction a given gengrid widget will expand while
8170     * placing its items.
8171     *
8172     * @param obj The gengrid object.
8173     * @param setting @c EINA_TRUE to make the gengrid expand
8174     * horizontally, @c EINA_FALSE to expand vertically.
8175     *
8176     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8177     * in @b columns, from top to bottom and, when the space for a
8178     * column is filled, another one is started on the right, thus
8179     * expanding the grid horizontally. When in "vertical mode"
8180     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8181     * to right and, when the space for a row is filled, another one is
8182     * started below, thus expanding the grid vertically.
8183     *
8184     * @see elm_gengrid_horizontal_get()
8185     *
8186     * @ingroup Gengrid
8187     */
8188    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8189
8190    /**
8191     * Get for what direction a given gengrid widget will expand while
8192     * placing its items.
8193     *
8194     * @param obj The gengrid object.
8195     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8196     * @c EINA_FALSE if it's set to expand vertically.
8197     *
8198     * @see elm_gengrid_horizontal_set() for more detais
8199     *
8200     * @ingroup Gengrid
8201     */
8202    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8203
8204    /**
8205     * Get the first item in a given gengrid widget
8206     *
8207     * @param obj The gengrid object
8208     * @return The first item's handle or @c NULL, if there are no
8209     * items in @p obj (and on errors)
8210     *
8211     * This returns the first item in the @p obj's internal list of
8212     * items.
8213     *
8214     * @see elm_gengrid_last_item_get()
8215     *
8216     * @ingroup Gengrid
8217     */
8218    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8219
8220    /**
8221     * Get the last item in a given gengrid widget
8222     *
8223     * @param obj The gengrid object
8224     * @return The last item's handle or @c NULL, if there are no
8225     * items in @p obj (and on errors)
8226     *
8227     * This returns the last item in the @p obj's internal list of
8228     * items.
8229     *
8230     * @see elm_gengrid_first_item_get()
8231     *
8232     * @ingroup Gengrid
8233     */
8234    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8235
8236    /**
8237     * Get the @b next item in a gengrid widget's internal list of items,
8238     * given a handle to one of those items.
8239     *
8240     * @param item The gengrid item to fetch next from
8241     * @return The item after @p item, or @c NULL if there's none (and
8242     * on errors)
8243     *
8244     * This returns the item placed after the @p item, on the container
8245     * gengrid.
8246     *
8247     * @see elm_gengrid_item_prev_get()
8248     *
8249     * @ingroup Gengrid
8250     */
8251    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8252
8253    /**
8254     * Get the @b previous item in a gengrid widget's internal list of items,
8255     * given a handle to one of those items.
8256     *
8257     * @param item The gengrid item to fetch previous from
8258     * @return The item before @p item, or @c NULL if there's none (and
8259     * on errors)
8260     *
8261     * This returns the item placed before the @p item, on the container
8262     * gengrid.
8263     *
8264     * @see elm_gengrid_item_next_get()
8265     *
8266     * @ingroup Gengrid
8267     */
8268    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8269
8270    /**
8271     * Get the gengrid object's handle which contains a given gengrid
8272     * item
8273     *
8274     * @param item The item to fetch the container from
8275     * @return The gengrid (parent) object
8276     *
8277     * This returns the gengrid object itself that an item belongs to.
8278     *
8279     * @ingroup Gengrid
8280     */
8281    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8282
8283    /**
8284     * Remove a gengrid item from the its parent, deleting it.
8285     *
8286     * @param item The item to be removed.
8287     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8288     *
8289     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8290     * once.
8291     *
8292     * @ingroup Gengrid
8293     */
8294    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8295
8296    /**
8297     * Update the contents of a given gengrid item
8298     *
8299     * @param item The gengrid item
8300     *
8301     * This updates an item by calling all the item class functions
8302     * again to get the icons, labels and states. Use this when the
8303     * original item data has changed and you want thta changes to be
8304     * reflected.
8305     *
8306     * @ingroup Gengrid
8307     */
8308    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8309    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8310    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8311
8312    /**
8313     * Return the data associated to a given gengrid item
8314     *
8315     * @param item The gengrid item.
8316     * @return the data associated to this item.
8317     *
8318     * This returns the @c data value passed on the
8319     * elm_gengrid_item_append() and related item addition calls.
8320     *
8321     * @see elm_gengrid_item_append()
8322     * @see elm_gengrid_item_data_set()
8323     *
8324     * @ingroup Gengrid
8325     */
8326    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8327
8328    /**
8329     * Set the data associated to a given gengrid item
8330     *
8331     * @param item The gengrid item
8332     * @param data The new data pointer to set on it
8333     *
8334     * This @b overrides the @c data value passed on the
8335     * elm_gengrid_item_append() and related item addition calls. This
8336     * function @b won't call elm_gengrid_item_update() automatically,
8337     * so you'd issue it afterwards if you want to hove the item
8338     * updated to reflect the that new data.
8339     *
8340     * @see elm_gengrid_item_data_get()
8341     *
8342     * @ingroup Gengrid
8343     */
8344    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8345
8346    /**
8347     * Get a given gengrid item's position, relative to the whole
8348     * gengrid's grid area.
8349     *
8350     * @param item The Gengrid item.
8351     * @param x Pointer to variable where to store the item's <b>row
8352     * number</b>.
8353     * @param y Pointer to variable where to store the item's <b>column
8354     * number</b>.
8355     *
8356     * This returns the "logical" position of the item whithin the
8357     * gengrid. For example, @c (0, 1) would stand for first row,
8358     * second column.
8359     *
8360     * @ingroup Gengrid
8361     */
8362    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8363
8364    /**
8365     * Set whether a given gengrid item is selected or not
8366     *
8367     * @param item The gengrid item
8368     * @param selected Use @c EINA_TRUE, to make it selected, @c
8369     * EINA_FALSE to make it unselected
8370     *
8371     * This sets the selected state of an item. If multi selection is
8372     * not enabled on the containing gengrid and @p selected is @c
8373     * EINA_TRUE, any other previously selected items will get
8374     * unselected in favor of this new one.
8375     *
8376     * @see elm_gengrid_item_selected_get()
8377     *
8378     * @ingroup Gengrid
8379     */
8380    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8381
8382    /**
8383     * Get whether a given gengrid item is selected or not
8384     *
8385     * @param item The gengrid item
8386     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8387     *
8388     * @see elm_gengrid_item_selected_set() for more details
8389     *
8390     * @ingroup Gengrid
8391     */
8392    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8393
8394    /**
8395     * Get the real Evas object created to implement the view of a
8396     * given gengrid item
8397     *
8398     * @param item The gengrid item.
8399     * @return the Evas object implementing this item's view.
8400     *
8401     * This returns the actual Evas object used to implement the
8402     * specified gengrid item's view. This may be @c NULL, as it may
8403     * not have been created or may have been deleted, at any time, by
8404     * the gengrid. <b>Do not modify this object</b> (move, resize,
8405     * show, hide, etc.), as the gengrid is controlling it. This
8406     * function is for querying, emitting custom signals or hooking
8407     * lower level callbacks for events on that object. Do not delete
8408     * this object under any circumstances.
8409     *
8410     * @see elm_gengrid_item_data_get()
8411     *
8412     * @ingroup Gengrid
8413     */
8414    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8415
8416    /**
8417     * Show the portion of a gengrid's internal grid containing a given
8418     * item, @b immediately.
8419     *
8420     * @param item The item to display
8421     *
8422     * This causes gengrid to @b redraw its viewport's contents to the
8423     * region contining the given @p item item, if it is not fully
8424     * visible.
8425     *
8426     * @see elm_gengrid_item_bring_in()
8427     *
8428     * @ingroup Gengrid
8429     */
8430    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8431
8432    /**
8433     * Animatedly bring in, to the visible are of a gengrid, a given
8434     * item on it.
8435     *
8436     * @param item The gengrid item to display
8437     *
8438     * This causes gengrig to jump to the given @p item item and show
8439     * it (by scrolling), if it is not fully visible. This will use
8440     * animation to do so and take a period of time to complete.
8441     *
8442     * @see elm_gengrid_item_show()
8443     *
8444     * @ingroup Gengrid
8445     */
8446    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8447
8448    /**
8449     * Set whether a given gengrid item is disabled or not.
8450     *
8451     * @param item The gengrid item
8452     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8453     * to enable it back.
8454     *
8455     * A disabled item cannot be selected or unselected. It will also
8456     * change its appearance, to signal the user it's disabled.
8457     *
8458     * @see elm_gengrid_item_disabled_get()
8459     *
8460     * @ingroup Gengrid
8461     */
8462    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8463
8464    /**
8465     * Get whether a given gengrid item is disabled or not.
8466     *
8467     * @param item The gengrid item
8468     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8469     * (and on errors).
8470     *
8471     * @see elm_gengrid_item_disabled_set() for more details
8472     *
8473     * @ingroup Gengrid
8474     */
8475    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8476
8477    /**
8478     * Set the text to be shown in a given gengrid item's tooltips.
8479     *
8480     * @param item The gengrid item
8481     * @param text The text to set in the content
8482     *
8483     * This call will setup the text to be used as tooltip to that item
8484     * (analogous to elm_object_tooltip_text_set(), but being item
8485     * tooltips with higher precedence than object tooltips). It can
8486     * have only one tooltip at a time, so any previous tooltip data
8487     * will get removed.
8488     *
8489     * @ingroup Gengrid
8490     */
8491    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8492
8493    /**
8494     * Set the content to be shown in a given gengrid item's tooltips
8495     *
8496     * @param item The gengrid item.
8497     * @param func The function returning the tooltip contents.
8498     * @param data What to provide to @a func as callback data/context.
8499     * @param del_cb Called when data is not needed anymore, either when
8500     *        another callback replaces @p func, the tooltip is unset with
8501     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8502     *        dies. This callback receives as its first parameter the
8503     *        given @p data, being @c event_info the item handle.
8504     *
8505     * This call will setup the tooltip's contents to @p item
8506     * (analogous to elm_object_tooltip_content_cb_set(), but being
8507     * item tooltips with higher precedence than object tooltips). It
8508     * can have only one tooltip at a time, so any previous tooltip
8509     * content will get removed. @p func (with @p data) will be called
8510     * every time Elementary needs to show the tooltip and it should
8511     * return a valid Evas object, which will be fully managed by the
8512     * tooltip system, getting deleted when the tooltip is gone.
8513     *
8514     * @ingroup Gengrid
8515     */
8516    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);
8517
8518    /**
8519     * Unset a tooltip from a given gengrid item
8520     *
8521     * @param item gengrid item to remove a previously set tooltip from.
8522     *
8523     * This call removes any tooltip set on @p item. The callback
8524     * provided as @c del_cb to
8525     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8526     * notify it is not used anymore (and have resources cleaned, if
8527     * need be).
8528     *
8529     * @see elm_gengrid_item_tooltip_content_cb_set()
8530     *
8531     * @ingroup Gengrid
8532     */
8533    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8534
8535    /**
8536     * Set a different @b style for a given gengrid item's tooltip.
8537     *
8538     * @param item gengrid item with tooltip set
8539     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8540     * "default", @c "transparent", etc)
8541     *
8542     * Tooltips can have <b>alternate styles</b> to be displayed on,
8543     * which are defined by the theme set on Elementary. This function
8544     * works analogously as elm_object_tooltip_style_set(), but here
8545     * applied only to gengrid item objects. The default style for
8546     * tooltips is @c "default".
8547     *
8548     * @note before you set a style you should define a tooltip with
8549     *       elm_gengrid_item_tooltip_content_cb_set() or
8550     *       elm_gengrid_item_tooltip_text_set()
8551     *
8552     * @see elm_gengrid_item_tooltip_style_get()
8553     *
8554     * @ingroup Gengrid
8555     */
8556    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8557
8558    /**
8559     * Get the style set a given gengrid item's tooltip.
8560     *
8561     * @param item gengrid item with tooltip already set on.
8562     * @return style the theme style in use, which defaults to
8563     *         "default". If the object does not have a tooltip set,
8564     *         then @c NULL is returned.
8565     *
8566     * @see elm_gengrid_item_tooltip_style_set() for more details
8567     *
8568     * @ingroup Gengrid
8569     */
8570    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8571    /**
8572     * @brief Disable size restrictions on an object's tooltip
8573     * @param item The tooltip's anchor object
8574     * @param disable If EINA_TRUE, size restrictions are disabled
8575     * @return EINA_FALSE on failure, EINA_TRUE on success
8576     *
8577     * This function allows a tooltip to expand beyond its parant window's canvas.
8578     * It will instead be limited only by the size of the display.
8579     */
8580    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8581    /**
8582     * @brief Retrieve size restriction state of an object's tooltip
8583     * @param item The tooltip's anchor object
8584     * @return If EINA_TRUE, size restrictions are disabled
8585     *
8586     * This function returns whether a tooltip is allowed to expand beyond
8587     * its parant window's canvas.
8588     * It will instead be limited only by the size of the display.
8589     */
8590    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8591    /**
8592     * Set the type of mouse pointer/cursor decoration to be shown,
8593     * when the mouse pointer is over the given gengrid widget item
8594     *
8595     * @param item gengrid item to customize cursor on
8596     * @param cursor the cursor type's name
8597     *
8598     * This function works analogously as elm_object_cursor_set(), but
8599     * here the cursor's changing area is restricted to the item's
8600     * area, and not the whole widget's. Note that that item cursors
8601     * have precedence over widget cursors, so that a mouse over @p
8602     * item will always show cursor @p type.
8603     *
8604     * If this function is called twice for an object, a previously set
8605     * cursor will be unset on the second call.
8606     *
8607     * @see elm_object_cursor_set()
8608     * @see elm_gengrid_item_cursor_get()
8609     * @see elm_gengrid_item_cursor_unset()
8610     *
8611     * @ingroup Gengrid
8612     */
8613    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8614
8615    /**
8616     * Get the type of mouse pointer/cursor decoration set to be shown,
8617     * when the mouse pointer is over the given gengrid widget item
8618     *
8619     * @param item gengrid item with custom cursor set
8620     * @return the cursor type's name or @c NULL, if no custom cursors
8621     * were set to @p item (and on errors)
8622     *
8623     * @see elm_object_cursor_get()
8624     * @see elm_gengrid_item_cursor_set() for more details
8625     * @see elm_gengrid_item_cursor_unset()
8626     *
8627     * @ingroup Gengrid
8628     */
8629    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8630
8631    /**
8632     * Unset any custom mouse pointer/cursor decoration set to be
8633     * shown, when the mouse pointer is over the given gengrid widget
8634     * item, thus making it show the @b default cursor again.
8635     *
8636     * @param item a gengrid item
8637     *
8638     * Use this call to undo any custom settings on this item's cursor
8639     * decoration, bringing it back to defaults (no custom style set).
8640     *
8641     * @see elm_object_cursor_unset()
8642     * @see elm_gengrid_item_cursor_set() for more details
8643     *
8644     * @ingroup Gengrid
8645     */
8646    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8647
8648    /**
8649     * Set a different @b style for a given custom cursor set for a
8650     * gengrid item.
8651     *
8652     * @param item gengrid item with custom cursor set
8653     * @param style the <b>theme style</b> to use (e.g. @c "default",
8654     * @c "transparent", etc)
8655     *
8656     * This function only makes sense when one is using custom mouse
8657     * cursor decorations <b>defined in a theme file</b> , which can
8658     * have, given a cursor name/type, <b>alternate styles</b> on
8659     * it. It works analogously as elm_object_cursor_style_set(), but
8660     * here applied only to gengrid item objects.
8661     *
8662     * @warning Before you set a cursor style you should have defined a
8663     *       custom cursor previously on the item, with
8664     *       elm_gengrid_item_cursor_set()
8665     *
8666     * @see elm_gengrid_item_cursor_engine_only_set()
8667     * @see elm_gengrid_item_cursor_style_get()
8668     *
8669     * @ingroup Gengrid
8670     */
8671    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8672
8673    /**
8674     * Get the current @b style set for a given gengrid item's custom
8675     * cursor
8676     *
8677     * @param item gengrid item with custom cursor set.
8678     * @return style the cursor style in use. If the object does not
8679     *         have a cursor set, then @c NULL is returned.
8680     *
8681     * @see elm_gengrid_item_cursor_style_set() for more details
8682     *
8683     * @ingroup Gengrid
8684     */
8685    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8686
8687    /**
8688     * Set if the (custom) cursor for a given gengrid item should be
8689     * searched in its theme, also, or should only rely on the
8690     * rendering engine.
8691     *
8692     * @param item item with custom (custom) cursor already set on
8693     * @param engine_only Use @c EINA_TRUE to have cursors looked for
8694     * only on those provided by the rendering engine, @c EINA_FALSE to
8695     * have them searched on the widget's theme, as well.
8696     *
8697     * @note This call is of use only if you've set a custom cursor
8698     * for gengrid items, with elm_gengrid_item_cursor_set().
8699     *
8700     * @note By default, cursors will only be looked for between those
8701     * provided by the rendering engine.
8702     *
8703     * @ingroup Gengrid
8704     */
8705    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8706
8707    /**
8708     * Get if the (custom) cursor for a given gengrid item is being
8709     * searched in its theme, also, or is only relying on the rendering
8710     * engine.
8711     *
8712     * @param item a gengrid item
8713     * @return @c EINA_TRUE, if cursors are being looked for only on
8714     * those provided by the rendering engine, @c EINA_FALSE if they
8715     * are being searched on the widget's theme, as well.
8716     *
8717     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8718     *
8719     * @ingroup Gengrid
8720     */
8721    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8722
8723    /**
8724     * Remove all items from a given gengrid widget
8725     *
8726     * @param obj The gengrid object.
8727     *
8728     * This removes (and deletes) all items in @p obj, leaving it
8729     * empty.
8730     *
8731     * @see elm_gengrid_item_del(), to remove just one item.
8732     *
8733     * @ingroup Gengrid
8734     */
8735    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8736
8737    /**
8738     * Get the selected item in a given gengrid widget
8739     *
8740     * @param obj The gengrid object.
8741     * @return The selected item's handleor @c NULL, if none is
8742     * selected at the moment (and on errors)
8743     *
8744     * This returns the selected item in @p obj. If multi selection is
8745     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8746     * the first item in the list is selected, which might not be very
8747     * useful. For that case, see elm_gengrid_selected_items_get().
8748     *
8749     * @ingroup Gengrid
8750     */
8751    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8752
8753    /**
8754     * Get <b>a list</b> of selected items in a given gengrid
8755     *
8756     * @param obj The gengrid object.
8757     * @return The list of selected items or @c NULL, if none is
8758     * selected at the moment (and on errors)
8759     *
8760     * This returns a list of the selected items, in the order that
8761     * they appear in the grid. This list is only valid as long as no
8762     * more items are selected or unselected (or unselected implictly
8763     * by deletion). The list contains #Elm_Gengrid_Item pointers as
8764     * data, naturally.
8765     *
8766     * @see elm_gengrid_selected_item_get()
8767     *
8768     * @ingroup Gengrid
8769     */
8770    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8771
8772    /**
8773     * @}
8774     */
8775
8776    /**
8777     * @defgroup Clock Clock
8778     *
8779     * @image html img/widget/clock/preview-00.png
8780     * @image latex img/widget/clock/preview-00.eps
8781     *
8782     * This is a @b digital clock widget. In its default theme, it has a
8783     * vintage "flipping numbers clock" appearance, which will animate
8784     * sheets of individual algarisms individually as time goes by.
8785     *
8786     * A newly created clock will fetch system's time (already
8787     * considering local time adjustments) to start with, and will tick
8788     * accondingly. It may or may not show seconds.
8789     *
8790     * Clocks have an @b edition mode. When in it, the sheets will
8791     * display extra arrow indications on the top and bottom and the
8792     * user may click on them to raise or lower the time values. After
8793     * it's told to exit edition mode, it will keep ticking with that
8794     * new time set (it keeps the difference from local time).
8795     *
8796     * Also, when under edition mode, user clicks on the cited arrows
8797     * which are @b held for some time will make the clock to flip the
8798     * sheet, thus editing the time, continuosly and automatically for
8799     * the user. The interval between sheet flips will keep growing in
8800     * time, so that it helps the user to reach a time which is distant
8801     * from the one set.
8802     *
8803     * The time display is, by default, in military mode (24h), but an
8804     * am/pm indicator may be optionally shown, too, when it will
8805     * switch to 12h.
8806     *
8807     * Smart callbacks one can register to:
8808     * - "changed" - the clock's user changed the time
8809     *
8810     * Here is an example on its usage:
8811     * @li @ref clock_example
8812     */
8813
8814    /**
8815     * @addtogroup Clock
8816     * @{
8817     */
8818
8819    /**
8820     * Identifiers for which clock digits should be editable, when a
8821     * clock widget is in edition mode. Values may be ORed together to
8822     * make a mask, naturally.
8823     *
8824     * @see elm_clock_edit_set()
8825     * @see elm_clock_digit_edit_set()
8826     */
8827    typedef enum _Elm_Clock_Digedit
8828      {
8829         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8830         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8831         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
8832         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8833         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
8834         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8835         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
8836         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
8837      } Elm_Clock_Digedit;
8838
8839    /**
8840     * Add a new clock widget to the given parent Elementary
8841     * (container) object
8842     *
8843     * @param parent The parent object
8844     * @return a new clock widget handle or @c NULL, on errors
8845     *
8846     * This function inserts a new clock widget on the canvas.
8847     *
8848     * @ingroup Clock
8849     */
8850    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8851
8852    /**
8853     * Set a clock widget's time, programmatically
8854     *
8855     * @param obj The clock widget object
8856     * @param hrs The hours to set
8857     * @param min The minutes to set
8858     * @param sec The secondes to set
8859     *
8860     * This function updates the time that is showed by the clock
8861     * widget.
8862     *
8863     *  Values @b must be set within the following ranges:
8864     * - 0 - 23, for hours
8865     * - 0 - 59, for minutes
8866     * - 0 - 59, for seconds,
8867     *
8868     * even if the clock is not in "military" mode.
8869     *
8870     * @warning The behavior for values set out of those ranges is @b
8871     * indefined.
8872     *
8873     * @ingroup Clock
8874     */
8875    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8876
8877    /**
8878     * Get a clock widget's time values
8879     *
8880     * @param obj The clock object
8881     * @param[out] hrs Pointer to the variable to get the hours value
8882     * @param[out] min Pointer to the variable to get the minutes value
8883     * @param[out] sec Pointer to the variable to get the seconds value
8884     *
8885     * This function gets the time set for @p obj, returning
8886     * it on the variables passed as the arguments to function
8887     *
8888     * @note Use @c NULL pointers on the time values you're not
8889     * interested in: they'll be ignored by the function.
8890     *
8891     * @ingroup Clock
8892     */
8893    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8894
8895    /**
8896     * Set whether a given clock widget is under <b>edition mode</b> or
8897     * under (default) displaying-only mode.
8898     *
8899     * @param obj The clock object
8900     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8901     * put it back to "displaying only" mode
8902     *
8903     * This function makes a clock's time to be editable or not <b>by
8904     * user interaction</b>. When in edition mode, clocks @b stop
8905     * ticking, until one brings them back to canonical mode. The
8906     * elm_clock_digit_edit_set() function will influence which digits
8907     * of the clock will be editable. By default, all of them will be
8908     * (#ELM_CLOCK_NONE).
8909     *
8910     * @note am/pm sheets, if being shown, will @b always be editable
8911     * under edition mode.
8912     *
8913     * @see elm_clock_edit_get()
8914     *
8915     * @ingroup Clock
8916     */
8917    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
8918
8919    /**
8920     * Retrieve whether a given clock widget is under <b>edition
8921     * mode</b> or under (default) displaying-only mode.
8922     *
8923     * @param obj The clock object
8924     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
8925     * otherwise
8926     *
8927     * This function retrieves whether the clock's time can be edited
8928     * or not by user interaction.
8929     *
8930     * @see elm_clock_edit_set() for more details
8931     *
8932     * @ingroup Clock
8933     */
8934    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8935
8936    /**
8937     * Set what digits of the given clock widget should be editable
8938     * when in edition mode.
8939     *
8940     * @param obj The clock object
8941     * @param digedit Bit mask indicating the digits to be editable
8942     * (values in #Elm_Clock_Digedit).
8943     *
8944     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
8945     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
8946     * EINA_FALSE).
8947     *
8948     * @see elm_clock_digit_edit_get()
8949     *
8950     * @ingroup Clock
8951     */
8952    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
8953
8954    /**
8955     * Retrieve what digits of the given clock widget should be
8956     * editable when in edition mode.
8957     *
8958     * @param obj The clock object
8959     * @return Bit mask indicating the digits to be editable
8960     * (values in #Elm_Clock_Digedit).
8961     *
8962     * @see elm_clock_digit_edit_set() for more details
8963     *
8964     * @ingroup Clock
8965     */
8966    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8967
8968    /**
8969     * Set if the given clock widget must show hours in military or
8970     * am/pm mode
8971     *
8972     * @param obj The clock object
8973     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
8974     * to military mode
8975     *
8976     * This function sets if the clock must show hours in military or
8977     * am/pm mode. In some countries like Brazil the military mode
8978     * (00-24h-format) is used, in opposition to the USA, where the
8979     * am/pm mode is more commonly used.
8980     *
8981     * @see elm_clock_show_am_pm_get()
8982     *
8983     * @ingroup Clock
8984     */
8985    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
8986
8987    /**
8988     * Get if the given clock widget shows hours in military or am/pm
8989     * mode
8990     *
8991     * @param obj The clock object
8992     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
8993     * military
8994     *
8995     * This function gets if the clock shows hours in military or am/pm
8996     * mode.
8997     *
8998     * @see elm_clock_show_am_pm_set() for more details
8999     *
9000     * @ingroup Clock
9001     */
9002    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9003
9004    /**
9005     * Set if the given clock widget must show time with seconds or not
9006     *
9007     * @param obj The clock object
9008     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9009     *
9010     * This function sets if the given clock must show or not elapsed
9011     * seconds. By default, they are @b not shown.
9012     *
9013     * @see elm_clock_show_seconds_get()
9014     *
9015     * @ingroup Clock
9016     */
9017    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9018
9019    /**
9020     * Get whether the given clock widget is showing time with seconds
9021     * or not
9022     *
9023     * @param obj The clock object
9024     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9025     *
9026     * This function gets whether @p obj is showing or not the elapsed
9027     * seconds.
9028     *
9029     * @see elm_clock_show_seconds_set()
9030     *
9031     * @ingroup Clock
9032     */
9033    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9034
9035    /**
9036     * Set the interval on time updates for an user mouse button hold
9037     * on clock widgets' time edition.
9038     *
9039     * @param obj The clock object
9040     * @param interval The (first) interval value in seconds
9041     *
9042     * This interval value is @b decreased while the user holds the
9043     * mouse pointer either incrementing or decrementing a given the
9044     * clock digit's value.
9045     *
9046     * This helps the user to get to a given time distant from the
9047     * current one easier/faster, as it will start to flip quicker and
9048     * quicker on mouse button holds.
9049     *
9050     * The calculation for the next flip interval value, starting from
9051     * the one set with this call, is the previous interval divided by
9052     * 1.05, so it decreases a little bit.
9053     *
9054     * The default starting interval value for automatic flips is
9055     * @b 0.85 seconds.
9056     *
9057     * @see elm_clock_interval_get()
9058     *
9059     * @ingroup Clock
9060     */
9061    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9062
9063    /**
9064     * Get the interval on time updates for an user mouse button hold
9065     * on clock widgets' time edition.
9066     *
9067     * @param obj The clock object
9068     * @return The (first) interval value, in seconds, set on it
9069     *
9070     * @see elm_clock_interval_set() for more details
9071     *
9072     * @ingroup Clock
9073     */
9074    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9075
9076    /**
9077     * @}
9078     */
9079
9080    /**
9081     * @defgroup Layout Layout
9082     *
9083     * @image html img/widget/layout/preview-00.png
9084     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9085     *
9086     * @image html img/layout-predefined.png
9087     * @image latex img/layout-predefined.eps width=\textwidth
9088     *
9089     * This is a container widget that takes a standard Edje design file and
9090     * wraps it very thinly in a widget.
9091     *
9092     * An Edje design (theme) file has a very wide range of possibilities to
9093     * describe the behavior of elements added to the Layout. Check out the Edje
9094     * documentation and the EDC reference to get more information about what can
9095     * be done with Edje.
9096     *
9097     * Just like @ref List, @ref Box, and other container widgets, any
9098     * object added to the Layout will become its child, meaning that it will be
9099     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9100     *
9101     * The Layout widget can contain as many Contents, Boxes or Tables as
9102     * described in its theme file. For instance, objects can be added to
9103     * different Tables by specifying the respective Table part names. The same
9104     * is valid for Content and Box.
9105     *
9106     * The objects added as child of the Layout will behave as described in the
9107     * part description where they were added. There are 3 possible types of
9108     * parts where a child can be added:
9109     *
9110     * @section secContent Content (SWALLOW part)
9111     *
9112     * Only one object can be added to the @c SWALLOW part (but you still can
9113     * have many @c SWALLOW parts and one object on each of them). Use the @c
9114     * elm_layout_content_* set of functions to set, retrieve and unset objects
9115     * as content of the @c SWALLOW. After being set to this part, the object
9116     * size, position, visibility, clipping and other description properties
9117     * will be totally controled by the description of the given part (inside
9118     * the Edje theme file).
9119     *
9120     * One can use @c evas_object_size_hint_* functions on the child to have some
9121     * kind of control over its behavior, but the resulting behavior will still
9122     * depend heavily on the @c SWALLOW part description.
9123     *
9124     * The Edje theme also can change the part description, based on signals or
9125     * scripts running inside the theme. This change can also be animated. All of
9126     * this will affect the child object set as content accordingly. The object
9127     * size will be changed if the part size is changed, it will animate move if
9128     * the part is moving, and so on.
9129     *
9130     * The following picture demonstrates a Layout widget with a child object
9131     * added to its @c SWALLOW:
9132     *
9133     * @image html layout_swallow.png
9134     * @image latex layout_swallow.eps width=\textwidth
9135     *
9136     * @section secBox Box (BOX part)
9137     *
9138     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9139     * allows one to add objects to the box and have them distributed along its
9140     * area, accordingly to the specified @a layout property (now by @a layout we
9141     * mean the chosen layouting design of the Box, not the Layout widget
9142     * itself).
9143     *
9144     * A similar effect for having a box with its position, size and other things
9145     * controled by the Layout theme would be to create an Elementary @ref Box
9146     * widget and add it as a Content in the @c SWALLOW part.
9147     *
9148     * The main difference of using the Layout Box is that its behavior, the box
9149     * properties like layouting format, padding, align, etc. will be all
9150     * controled by the theme. This means, for example, that a signal could be
9151     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9152     * handled the signal by changing the box padding, or align, or both. Using
9153     * the Elementary @ref Box widget is not necessarily harder or easier, it
9154     * just depends on the circunstances and requirements.
9155     *
9156     * The Layout Box can be used through the @c elm_layout_box_* set of
9157     * functions.
9158     *
9159     * The following picture demonstrates a Layout widget with many child objects
9160     * added to its @c BOX part:
9161     *
9162     * @image html layout_box.png
9163     * @image latex layout_box.eps width=\textwidth
9164     *
9165     * @section secTable Table (TABLE part)
9166     *
9167     * Just like the @ref secBox, the Layout Table is very similar to the
9168     * Elementary @ref Table widget. It allows one to add objects to the Table
9169     * specifying the row and column where the object should be added, and any
9170     * column or row span if necessary.
9171     *
9172     * Again, we could have this design by adding a @ref Table widget to the @c
9173     * SWALLOW part using elm_layout_content_set(). The same difference happens
9174     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9175     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9176     *
9177     * The Layout Table can be used through the @c elm_layout_table_* set of
9178     * functions.
9179     *
9180     * The following picture demonstrates a Layout widget with many child objects
9181     * added to its @c TABLE part:
9182     *
9183     * @image html layout_table.png
9184     * @image latex layout_table.eps width=\textwidth
9185     *
9186     * @section secPredef Predefined Layouts
9187     *
9188     * Another interesting thing about the Layout widget is that it offers some
9189     * predefined themes that come with the default Elementary theme. These
9190     * themes can be set by the call elm_layout_theme_set(), and provide some
9191     * basic functionality depending on the theme used.
9192     *
9193     * Most of them already send some signals, some already provide a toolbar or
9194     * back and next buttons.
9195     *
9196     * These are available predefined theme layouts. All of them have class = @c
9197     * layout, group = @c application, and style = one of the following options:
9198     *
9199     * @li @c toolbar-content - application with toolbar and main content area
9200     * @li @c toolbar-content-back - application with toolbar and main content
9201     * area with a back button and title area
9202     * @li @c toolbar-content-back-next - application with toolbar and main
9203     * content area with a back and next buttons and title area
9204     * @li @c content-back - application with a main content area with a back
9205     * button and title area
9206     * @li @c content-back-next - application with a main content area with a
9207     * back and next buttons and title area
9208     * @li @c toolbar-vbox - application with toolbar and main content area as a
9209     * vertical box
9210     * @li @c toolbar-table - application with toolbar and main content area as a
9211     * table
9212     *
9213     * @section secExamples Examples
9214     *
9215     * Some examples of the Layout widget can be found here:
9216     * @li @ref layout_example_01
9217     * @li @ref layout_example_02
9218     * @li @ref layout_example_03
9219     * @li @ref layout_example_edc
9220     *
9221     */
9222
9223    /**
9224     * Add a new layout to the parent
9225     *
9226     * @param parent The parent object
9227     * @return The new object or NULL if it cannot be created
9228     *
9229     * @see elm_layout_file_set()
9230     * @see elm_layout_theme_set()
9231     *
9232     * @ingroup Layout
9233     */
9234    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9235    /**
9236     * Set the file that will be used as layout
9237     *
9238     * @param obj The layout object
9239     * @param file The path to file (edj) that will be used as layout
9240     * @param group The group that the layout belongs in edje file
9241     *
9242     * @return (1 = success, 0 = error)
9243     *
9244     * @ingroup Layout
9245     */
9246    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9247    /**
9248     * Set the edje group from the elementary theme that will be used as layout
9249     *
9250     * @param obj The layout object
9251     * @param clas the clas of the group
9252     * @param group the group
9253     * @param style the style to used
9254     *
9255     * @return (1 = success, 0 = error)
9256     *
9257     * @ingroup Layout
9258     */
9259    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9260    /**
9261     * Set the layout content.
9262     *
9263     * @param obj The layout object
9264     * @param swallow The swallow part name in the edje file
9265     * @param content The child that will be added in this layout object
9266     *
9267     * Once the content object is set, a previously set one will be deleted.
9268     * If you want to keep that old content object, use the
9269     * elm_layout_content_unset() function.
9270     *
9271     * @note In an Edje theme, the part used as a content container is called @c
9272     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9273     * expected to be a part name just like the second parameter of
9274     * elm_layout_box_append().
9275     *
9276     * @see elm_layout_box_append()
9277     * @see elm_layout_content_get()
9278     * @see elm_layout_content_unset()
9279     * @see @ref secBox
9280     *
9281     * @ingroup Layout
9282     */
9283    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9284    /**
9285     * Get the child object in the given content part.
9286     *
9287     * @param obj The layout object
9288     * @param swallow The SWALLOW part to get its content
9289     *
9290     * @return The swallowed object or NULL if none or an error occurred
9291     *
9292     * @see elm_layout_content_set()
9293     *
9294     * @ingroup Layout
9295     */
9296    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9297    /**
9298     * Unset the layout content.
9299     *
9300     * @param obj The layout object
9301     * @param swallow The swallow part name in the edje file
9302     * @return The content that was being used
9303     *
9304     * Unparent and return the content object which was set for this part.
9305     *
9306     * @see elm_layout_content_set()
9307     *
9308     * @ingroup Layout
9309     */
9310     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9311    /**
9312     * Set the text of the given part
9313     *
9314     * @param obj The layout object
9315     * @param part The TEXT part where to set the text
9316     * @param text The text to set
9317     *
9318     * @ingroup Layout
9319     * @deprecated use elm_object_text_* instead.
9320     */
9321    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9322    /**
9323     * Get the text set in the given part
9324     *
9325     * @param obj The layout object
9326     * @param part The TEXT part to retrieve the text off
9327     *
9328     * @return The text set in @p part
9329     *
9330     * @ingroup Layout
9331     * @deprecated use elm_object_text_* instead.
9332     */
9333    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9334    /**
9335     * Append child to layout box part.
9336     *
9337     * @param obj the layout object
9338     * @param part the box part to which the object will be appended.
9339     * @param child the child object to append to box.
9340     *
9341     * Once the object is appended, it will become child of the layout. Its
9342     * lifetime will be bound to the layout, whenever the layout dies the child
9343     * will be deleted automatically. One should use elm_layout_box_remove() to
9344     * make this layout forget about the object.
9345     *
9346     * @see elm_layout_box_prepend()
9347     * @see elm_layout_box_insert_before()
9348     * @see elm_layout_box_insert_at()
9349     * @see elm_layout_box_remove()
9350     *
9351     * @ingroup Layout
9352     */
9353    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9354    /**
9355     * Prepend child to layout box part.
9356     *
9357     * @param obj the layout object
9358     * @param part the box part to prepend.
9359     * @param child the child object to prepend to box.
9360     *
9361     * Once the object is prepended, it will become child of the layout. Its
9362     * lifetime will be bound to the layout, whenever the layout dies the child
9363     * will be deleted automatically. One should use elm_layout_box_remove() to
9364     * make this layout forget about the object.
9365     *
9366     * @see elm_layout_box_append()
9367     * @see elm_layout_box_insert_before()
9368     * @see elm_layout_box_insert_at()
9369     * @see elm_layout_box_remove()
9370     *
9371     * @ingroup Layout
9372     */
9373    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9374    /**
9375     * Insert child to layout box part before a reference object.
9376     *
9377     * @param obj the layout object
9378     * @param part the box part to insert.
9379     * @param child the child object to insert into box.
9380     * @param reference another reference object to insert before in box.
9381     *
9382     * Once the object is inserted, it will become child of the layout. Its
9383     * lifetime will be bound to the layout, whenever the layout dies the child
9384     * will be deleted automatically. One should use elm_layout_box_remove() to
9385     * make this layout forget about the object.
9386     *
9387     * @see elm_layout_box_append()
9388     * @see elm_layout_box_prepend()
9389     * @see elm_layout_box_insert_before()
9390     * @see elm_layout_box_remove()
9391     *
9392     * @ingroup Layout
9393     */
9394    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9395    /**
9396     * Insert child to layout box part at a given position.
9397     *
9398     * @param obj the layout object
9399     * @param part the box part to insert.
9400     * @param child the child object to insert into box.
9401     * @param pos the numeric position >=0 to insert the child.
9402     *
9403     * Once the object is inserted, it will become child of the layout. Its
9404     * lifetime will be bound to the layout, whenever the layout dies the child
9405     * will be deleted automatically. One should use elm_layout_box_remove() to
9406     * make this layout forget about the object.
9407     *
9408     * @see elm_layout_box_append()
9409     * @see elm_layout_box_prepend()
9410     * @see elm_layout_box_insert_before()
9411     * @see elm_layout_box_remove()
9412     *
9413     * @ingroup Layout
9414     */
9415    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9416    /**
9417     * Remove a child of the given part box.
9418     *
9419     * @param obj The layout object
9420     * @param part The box part name to remove child.
9421     * @param child The object to remove from box.
9422     * @return The object that was being used, or NULL if not found.
9423     *
9424     * The object will be removed from the box part and its lifetime will
9425     * not be handled by the layout anymore. This is equivalent to
9426     * elm_layout_content_unset() for box.
9427     *
9428     * @see elm_layout_box_append()
9429     * @see elm_layout_box_remove_all()
9430     *
9431     * @ingroup Layout
9432     */
9433    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9434    /**
9435     * Remove all child of the given part box.
9436     *
9437     * @param obj The layout object
9438     * @param part The box part name to remove child.
9439     * @param clear If EINA_TRUE, then all objects will be deleted as
9440     *        well, otherwise they will just be removed and will be
9441     *        dangling on the canvas.
9442     *
9443     * The objects will be removed from the box part and their lifetime will
9444     * not be handled by the layout anymore. This is equivalent to
9445     * elm_layout_box_remove() for all box children.
9446     *
9447     * @see elm_layout_box_append()
9448     * @see elm_layout_box_remove()
9449     *
9450     * @ingroup Layout
9451     */
9452    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9453    /**
9454     * Insert child to layout table part.
9455     *
9456     * @param obj the layout object
9457     * @param part the box part to pack child.
9458     * @param child_obj the child object to pack into table.
9459     * @param col the column to which the child should be added. (>= 0)
9460     * @param row the row to which the child should be added. (>= 0)
9461     * @param colspan how many columns should be used to store this object. (>=
9462     *        1)
9463     * @param rowspan how many rows should be used to store this object. (>= 1)
9464     *
9465     * Once the object is inserted, it will become child of the table. Its
9466     * lifetime will be bound to the layout, and whenever the layout dies the
9467     * child will be deleted automatically. One should use
9468     * elm_layout_table_remove() to make this layout forget about the object.
9469     *
9470     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9471     * more space than a single cell. For instance, the following code:
9472     * @code
9473     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9474     * @endcode
9475     *
9476     * Would result in an object being added like the following picture:
9477     *
9478     * @image html layout_colspan.png
9479     * @image latex layout_colspan.eps width=\textwidth
9480     *
9481     * @see elm_layout_table_unpack()
9482     * @see elm_layout_table_clear()
9483     *
9484     * @ingroup Layout
9485     */
9486    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);
9487    /**
9488     * Unpack (remove) a child of the given part table.
9489     *
9490     * @param obj The layout object
9491     * @param part The table part name to remove child.
9492     * @param child_obj The object to remove from table.
9493     * @return The object that was being used, or NULL if not found.
9494     *
9495     * The object will be unpacked from the table part and its lifetime
9496     * will not be handled by the layout anymore. This is equivalent to
9497     * elm_layout_content_unset() for table.
9498     *
9499     * @see elm_layout_table_pack()
9500     * @see elm_layout_table_clear()
9501     *
9502     * @ingroup Layout
9503     */
9504    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9505    /**
9506     * Remove all child of the given part table.
9507     *
9508     * @param obj The layout object
9509     * @param part The table part name to remove child.
9510     * @param clear If EINA_TRUE, then all objects will be deleted as
9511     *        well, otherwise they will just be removed and will be
9512     *        dangling on the canvas.
9513     *
9514     * The objects will be removed from the table part and their lifetime will
9515     * not be handled by the layout anymore. This is equivalent to
9516     * elm_layout_table_unpack() for all table children.
9517     *
9518     * @see elm_layout_table_pack()
9519     * @see elm_layout_table_unpack()
9520     *
9521     * @ingroup Layout
9522     */
9523    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9524    /**
9525     * Get the edje layout
9526     *
9527     * @param obj The layout object
9528     *
9529     * @return A Evas_Object with the edje layout settings loaded
9530     * with function elm_layout_file_set
9531     *
9532     * This returns the edje object. It is not expected to be used to then
9533     * swallow objects via edje_object_part_swallow() for example. Use
9534     * elm_layout_content_set() instead so child object handling and sizing is
9535     * done properly.
9536     *
9537     * @note This function should only be used if you really need to call some
9538     * low level Edje function on this edje object. All the common stuff (setting
9539     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9540     * with proper elementary functions.
9541     *
9542     * @see elm_object_signal_callback_add()
9543     * @see elm_object_signal_emit()
9544     * @see elm_object_text_part_set()
9545     * @see elm_layout_content_set()
9546     * @see elm_layout_box_append()
9547     * @see elm_layout_table_pack()
9548     * @see elm_layout_data_get()
9549     *
9550     * @ingroup Layout
9551     */
9552    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9553    /**
9554     * Get the edje data from the given layout
9555     *
9556     * @param obj The layout object
9557     * @param key The data key
9558     *
9559     * @return The edje data string
9560     *
9561     * This function fetches data specified inside the edje theme of this layout.
9562     * This function return NULL if data is not found.
9563     *
9564     * In EDC this comes from a data block within the group block that @p
9565     * obj was loaded from. E.g.
9566     *
9567     * @code
9568     * collections {
9569     *   group {
9570     *     name: "a_group";
9571     *     data {
9572     *       item: "key1" "value1";
9573     *       item: "key2" "value2";
9574     *     }
9575     *   }
9576     * }
9577     * @endcode
9578     *
9579     * @ingroup Layout
9580     */
9581    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9582    /**
9583     * Eval sizing
9584     *
9585     * @param obj The layout object
9586     *
9587     * Manually forces a sizing re-evaluation. This is useful when the minimum
9588     * size required by the edje theme of this layout has changed. The change on
9589     * the minimum size required by the edje theme is not immediately reported to
9590     * the elementary layout, so one needs to call this function in order to tell
9591     * the widget (layout) that it needs to reevaluate its own size.
9592     *
9593     * The minimum size of the theme is calculated based on minimum size of
9594     * parts, the size of elements inside containers like box and table, etc. All
9595     * of this can change due to state changes, and that's when this function
9596     * should be called.
9597     *
9598     * Also note that a standard signal of "size,eval" "elm" emitted from the
9599     * edje object will cause this to happen too.
9600     *
9601     * @ingroup Layout
9602     */
9603    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9604
9605    /**
9606     * Sets a specific cursor for an edje part.
9607     *
9608     * @param obj The layout object.
9609     * @param part_name a part from loaded edje group.
9610     * @param cursor cursor name to use, see Elementary_Cursor.h
9611     *
9612     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9613     *         part not exists or it has "mouse_events: 0".
9614     *
9615     * @ingroup Layout
9616     */
9617    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9618
9619    /**
9620     * Get the cursor to be shown when mouse is over an edje part
9621     *
9622     * @param obj The layout object.
9623     * @param part_name a part from loaded edje group.
9624     * @return the cursor name.
9625     *
9626     * @ingroup Layout
9627     */
9628    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9629
9630    /**
9631     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9632     *
9633     * @param obj The layout object.
9634     * @param part_name a part from loaded edje group, that had a cursor set
9635     *        with elm_layout_part_cursor_set().
9636     *
9637     * @ingroup Layout
9638     */
9639    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9640
9641    /**
9642     * Sets a specific cursor style for an edje part.
9643     *
9644     * @param obj The layout object.
9645     * @param part_name a part from loaded edje group.
9646     * @param style the theme style to use (default, transparent, ...)
9647     *
9648     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9649     *         part not exists or it did not had a cursor set.
9650     *
9651     * @ingroup Layout
9652     */
9653    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9654
9655    /**
9656     * Gets a specific cursor style for an edje part.
9657     *
9658     * @param obj The layout object.
9659     * @param part_name a part from loaded edje group.
9660     *
9661     * @return the theme style in use, defaults to "default". If the
9662     *         object does not have a cursor set, then NULL is returned.
9663     *
9664     * @ingroup Layout
9665     */
9666    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9667
9668    /**
9669     * Sets if the cursor set should be searched on the theme or should use
9670     * the provided by the engine, only.
9671     *
9672     * @note before you set if should look on theme you should define a
9673     * cursor with elm_layout_part_cursor_set(). By default it will only
9674     * look for cursors provided by the engine.
9675     *
9676     * @param obj The layout object.
9677     * @param part_name a part from loaded edje group.
9678     * @param engine_only if cursors should be just provided by the engine
9679     *        or should also search on widget's theme as well
9680     *
9681     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9682     *         part not exists or it did not had a cursor set.
9683     *
9684     * @ingroup Layout
9685     */
9686    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);
9687
9688    /**
9689     * Gets a specific cursor engine_only for an edje part.
9690     *
9691     * @param obj The layout object.
9692     * @param part_name a part from loaded edje group.
9693     *
9694     * @return whenever the cursor is just provided by engine or also from theme.
9695     *
9696     * @ingroup Layout
9697     */
9698    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9699
9700 /**
9701  * @def elm_layout_icon_set
9702  * Convienience macro to set the icon object in a layout that follows the
9703  * Elementary naming convention for its parts.
9704  *
9705  * @ingroup Layout
9706  */
9707 #define elm_layout_icon_set(_ly, _obj) \
9708   do { \
9709     const char *sig; \
9710     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9711     if ((_obj)) sig = "elm,state,icon,visible"; \
9712     else sig = "elm,state,icon,hidden"; \
9713     elm_object_signal_emit((_ly), sig, "elm"); \
9714   } while (0)
9715
9716 /**
9717  * @def elm_layout_icon_get
9718  * Convienience macro to get the icon object from a layout that follows the
9719  * Elementary naming convention for its parts.
9720  *
9721  * @ingroup Layout
9722  */
9723 #define elm_layout_icon_get(_ly) \
9724   elm_layout_content_get((_ly), "elm.swallow.icon")
9725
9726 /**
9727  * @def elm_layout_end_set
9728  * Convienience macro to set the end object in a layout that follows the
9729  * Elementary naming convention for its parts.
9730  *
9731  * @ingroup Layout
9732  */
9733 #define elm_layout_end_set(_ly, _obj) \
9734   do { \
9735     const char *sig; \
9736     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9737     if ((_obj)) sig = "elm,state,end,visible"; \
9738     else sig = "elm,state,end,hidden"; \
9739     elm_object_signal_emit((_ly), sig, "elm"); \
9740   } while (0)
9741
9742 /**
9743  * @def elm_layout_end_get
9744  * Convienience macro to get the end object in a layout that follows the
9745  * Elementary naming convention for its parts.
9746  *
9747  * @ingroup Layout
9748  */
9749 #define elm_layout_end_get(_ly) \
9750   elm_layout_content_get((_ly), "elm.swallow.end")
9751
9752 /**
9753  * @def elm_layout_label_set
9754  * Convienience macro to set the label in a layout that follows the
9755  * Elementary naming convention for its parts.
9756  *
9757  * @ingroup Layout
9758  * @deprecated use elm_object_text_* instead.
9759  */
9760 #define elm_layout_label_set(_ly, _txt) \
9761   elm_layout_text_set((_ly), "elm.text", (_txt))
9762
9763 /**
9764  * @def elm_layout_label_get
9765  * Convienience macro to get the label in a layout that follows the
9766  * Elementary naming convention for its parts.
9767  *
9768  * @ingroup Layout
9769  * @deprecated use elm_object_text_* instead.
9770  */
9771 #define elm_layout_label_get(_ly) \
9772   elm_layout_text_get((_ly), "elm.text")
9773
9774    /* smart callbacks called:
9775     * "theme,changed" - when elm theme is changed.
9776     */
9777
9778    /**
9779     * @defgroup Notify Notify
9780     *
9781     * @image html img/widget/notify/preview-00.png
9782     * @image latex img/widget/notify/preview-00.eps
9783     *
9784     * Display a container in a particular region of the parent(top, bottom,
9785     * etc.  A timeout can be set to automatically hide the notify. This is so
9786     * that, after an evas_object_show() on a notify object, if a timeout was set
9787     * on it, it will @b automatically get hidden after that time.
9788     *
9789     * Signals that you can add callbacks for are:
9790     * @li "timeout" - when timeout happens on notify and it's hidden
9791     * @li "block,clicked" - when a click outside of the notify happens
9792     *
9793     * @ref tutorial_notify show usage of the API.
9794     *
9795     * @{
9796     */
9797    /**
9798     * @brief Possible orient values for notify.
9799     *
9800     * This values should be used in conjunction to elm_notify_orient_set() to
9801     * set the position in which the notify should appear(relative to its parent)
9802     * and in conjunction with elm_notify_orient_get() to know where the notify
9803     * is appearing.
9804     */
9805    typedef enum _Elm_Notify_Orient
9806      {
9807         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9808         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9809         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9810         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9811         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9812         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9813         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9814         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9815         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9816         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9817      } Elm_Notify_Orient;
9818    /**
9819     * @brief Add a new notify to the parent
9820     *
9821     * @param parent The parent object
9822     * @return The new object or NULL if it cannot be created
9823     */
9824    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9825    /**
9826     * @brief Set the content of the notify widget
9827     *
9828     * @param obj The notify object
9829     * @param content The content will be filled in this notify object
9830     *
9831     * Once the content object is set, a previously set one will be deleted. If
9832     * you want to keep that old content object, use the
9833     * elm_notify_content_unset() function.
9834     */
9835    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9836    /**
9837     * @brief Unset the content of the notify widget
9838     *
9839     * @param obj The notify object
9840     * @return The content that was being used
9841     *
9842     * Unparent and return the content object which was set for this widget
9843     *
9844     * @see elm_notify_content_set()
9845     */
9846    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9847    /**
9848     * @brief Return the content of the notify widget
9849     *
9850     * @param obj The notify object
9851     * @return The content that is being used
9852     *
9853     * @see elm_notify_content_set()
9854     */
9855    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9856    /**
9857     * @brief Set the notify parent
9858     *
9859     * @param obj The notify object
9860     * @param content The new parent
9861     *
9862     * Once the parent object is set, a previously set one will be disconnected
9863     * and replaced.
9864     */
9865    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9866    /**
9867     * @brief Get the notify parent
9868     *
9869     * @param obj The notify object
9870     * @return The parent
9871     *
9872     * @see elm_notify_parent_set()
9873     */
9874    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9875    /**
9876     * @brief Set the orientation
9877     *
9878     * @param obj The notify object
9879     * @param orient The new orientation
9880     *
9881     * Sets the position in which the notify will appear in its parent.
9882     *
9883     * @see @ref Elm_Notify_Orient for possible values.
9884     */
9885    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9886    /**
9887     * @brief Return the orientation
9888     * @param obj The notify object
9889     * @return The orientation of the notification
9890     *
9891     * @see elm_notify_orient_set()
9892     * @see Elm_Notify_Orient
9893     */
9894    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9895    /**
9896     * @brief Set the time interval after which the notify window is going to be
9897     * hidden.
9898     *
9899     * @param obj The notify object
9900     * @param time The timeout in seconds
9901     *
9902     * This function sets a timeout and starts the timer controlling when the
9903     * notify is hidden. Since calling evas_object_show() on a notify restarts
9904     * the timer controlling when the notify is hidden, setting this before the
9905     * notify is shown will in effect mean starting the timer when the notify is
9906     * shown.
9907     *
9908     * @note Set a value <= 0.0 to disable a running timer.
9909     *
9910     * @note If the value > 0.0 and the notify is previously visible, the
9911     * timer will be started with this value, canceling any running timer.
9912     */
9913    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
9914    /**
9915     * @brief Return the timeout value (in seconds)
9916     * @param obj the notify object
9917     *
9918     * @see elm_notify_timeout_set()
9919     */
9920    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9921    /**
9922     * @brief Sets whether events should be passed to by a click outside
9923     * its area.
9924     *
9925     * @param obj The notify object
9926     * @param repeats EINA_TRUE Events are repeats, else no
9927     *
9928     * When true if the user clicks outside the window the events will be caught
9929     * by the others widgets, else the events are blocked.
9930     *
9931     * @note The default value is EINA_TRUE.
9932     */
9933    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
9934    /**
9935     * @brief Return true if events are repeat below the notify object
9936     * @param obj the notify object
9937     *
9938     * @see elm_notify_repeat_events_set()
9939     */
9940    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9941    /**
9942     * @}
9943     */
9944
9945    /**
9946     * @defgroup Hover Hover
9947     *
9948     * @image html img/widget/hover/preview-00.png
9949     * @image latex img/widget/hover/preview-00.eps
9950     *
9951     * A Hover object will hover over its @p parent object at the @p target
9952     * location. Anything in the background will be given a darker coloring to
9953     * indicate that the hover object is on top (at the default theme). When the
9954     * hover is clicked it is dismissed(hidden), if the contents of the hover are
9955     * clicked that @b doesn't cause the hover to be dismissed.
9956     *
9957     * @note The hover object will take up the entire space of @p target
9958     * object.
9959     *
9960     * Elementary has the following styles for the hover widget:
9961     * @li default
9962     * @li popout
9963     * @li menu
9964     * @li hoversel_vertical
9965     *
9966     * The following are the available position for content:
9967     * @li left
9968     * @li top-left
9969     * @li top
9970     * @li top-right
9971     * @li right
9972     * @li bottom-right
9973     * @li bottom
9974     * @li bottom-left
9975     * @li middle
9976     * @li smart
9977     *
9978     * Signals that you can add callbacks for are:
9979     * @li "clicked" - the user clicked the empty space in the hover to dismiss
9980     * @li "smart,changed" - a content object placed under the "smart"
9981     *                   policy was replaced to a new slot direction.
9982     *
9983     * See @ref tutorial_hover for more information.
9984     *
9985     * @{
9986     */
9987    typedef enum _Elm_Hover_Axis
9988      {
9989         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
9990         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
9991         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
9992         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
9993      } Elm_Hover_Axis;
9994    /**
9995     * @brief Adds a hover object to @p parent
9996     *
9997     * @param parent The parent object
9998     * @return The hover object or NULL if one could not be created
9999     */
10000    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10001    /**
10002     * @brief Sets the target object for the hover.
10003     *
10004     * @param obj The hover object
10005     * @param target The object to center the hover onto. The hover
10006     *
10007     * This function will cause the hover to be centered on the target object.
10008     */
10009    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10010    /**
10011     * @brief Gets the target object for the hover.
10012     *
10013     * @param obj The hover object
10014     * @param parent The object to locate the hover over.
10015     *
10016     * @see elm_hover_target_set()
10017     */
10018    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10019    /**
10020     * @brief Sets the parent object for the hover.
10021     *
10022     * @param obj The hover object
10023     * @param parent The object to locate the hover over.
10024     *
10025     * This function will cause the hover to take up the entire space that the
10026     * parent object fills.
10027     */
10028    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10029    /**
10030     * @brief Gets the parent object for the hover.
10031     *
10032     * @param obj The hover object
10033     * @return The parent object to locate the hover over.
10034     *
10035     * @see elm_hover_parent_set()
10036     */
10037    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10038    /**
10039     * @brief Sets the content of the hover object and the direction in which it
10040     * will pop out.
10041     *
10042     * @param obj The hover object
10043     * @param swallow The direction that the object will be displayed
10044     * at. Accepted values are "left", "top-left", "top", "top-right",
10045     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10046     * "smart".
10047     * @param content The content to place at @p swallow
10048     *
10049     * Once the content object is set for a given direction, a previously
10050     * set one (on the same direction) will be deleted. If you want to
10051     * keep that old content object, use the elm_hover_content_unset()
10052     * function.
10053     *
10054     * All directions may have contents at the same time, except for
10055     * "smart". This is a special placement hint and its use case
10056     * independs of the calculations coming from
10057     * elm_hover_best_content_location_get(). Its use is for cases when
10058     * one desires only one hover content, but with a dinamic special
10059     * placement within the hover area. The content's geometry, whenever
10060     * it changes, will be used to decide on a best location not
10061     * extrapolating the hover's parent object view to show it in (still
10062     * being the hover's target determinant of its medium part -- move and
10063     * resize it to simulate finger sizes, for example). If one of the
10064     * directions other than "smart" are used, a previously content set
10065     * using it will be deleted, and vice-versa.
10066     */
10067    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10068    /**
10069     * @brief Get the content of the hover object, in a given direction.
10070     *
10071     * Return the content object which was set for this widget in the
10072     * @p swallow direction.
10073     *
10074     * @param obj The hover object
10075     * @param swallow The direction that the object was display at.
10076     * @return The content that was being used
10077     *
10078     * @see elm_hover_content_set()
10079     */
10080    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10081    /**
10082     * @brief Unset the content of the hover object, in a given direction.
10083     *
10084     * Unparent and return the content object set at @p swallow direction.
10085     *
10086     * @param obj The hover object
10087     * @param swallow The direction that the object was display at.
10088     * @return The content that was being used.
10089     *
10090     * @see elm_hover_content_set()
10091     */
10092    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10093    /**
10094     * @brief Returns the best swallow location for content in the hover.
10095     *
10096     * @param obj The hover object
10097     * @param pref_axis The preferred orientation axis for the hover object to use
10098     * @return The edje location to place content into the hover or @c
10099     *         NULL, on errors.
10100     *
10101     * Best is defined here as the location at which there is the most available
10102     * space.
10103     *
10104     * @p pref_axis may be one of
10105     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10106     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10107     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10108     * - @c ELM_HOVER_AXIS_BOTH -- both
10109     *
10110     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10111     * nescessarily be along the horizontal axis("left" or "right"). If
10112     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10113     * be along the vertical axis("top" or "bottom"). Chossing
10114     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10115     * returned position may be in either axis.
10116     *
10117     * @see elm_hover_content_set()
10118     */
10119    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10120    /**
10121     * @}
10122     */
10123
10124    /* entry */
10125    /**
10126     * @defgroup Entry Entry
10127     *
10128     * @image html img/widget/entry/preview-00.png
10129     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10130     * @image html img/widget/entry/preview-01.png
10131     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10132     * @image html img/widget/entry/preview-02.png
10133     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10134     * @image html img/widget/entry/preview-03.png
10135     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10136     *
10137     * An entry is a convenience widget which shows a box that the user can
10138     * enter text into. Entries by default don't scroll, so they grow to
10139     * accomodate the entire text, resizing the parent window as needed. This
10140     * can be changed with the elm_entry_scrollable_set() function.
10141     *
10142     * They can also be single line or multi line (the default) and when set
10143     * to multi line mode they support text wrapping in any of the modes
10144     * indicated by #Elm_Wrap_Type.
10145     *
10146     * Other features include password mode, filtering of inserted text with
10147     * elm_entry_text_filter_append() and related functions, inline "items" and
10148     * formatted markup text.
10149     *
10150     * @section entry-markup Formatted text
10151     *
10152     * The markup tags supported by the Entry are defined by the theme, but
10153     * even when writing new themes or extensions it's a good idea to stick to
10154     * a sane default, to maintain coherency and avoid application breakages.
10155     * Currently defined by the default theme are the following tags:
10156     * @li \<br\>: Inserts a line break.
10157     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10158     * breaks.
10159     * @li \<tab\>: Inserts a tab.
10160     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10161     * enclosed text.
10162     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10163     * @li \<link\>...\</link\>: Underlines the enclosed text.
10164     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10165     *
10166     * @section entry-special Special markups
10167     *
10168     * Besides those used to format text, entries support two special markup
10169     * tags used to insert clickable portions of text or items inlined within
10170     * the text.
10171     *
10172     * @subsection entry-anchors Anchors
10173     *
10174     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10175     * \</a\> tags and an event will be generated when this text is clicked,
10176     * like this:
10177     *
10178     * @code
10179     * This text is outside <a href=anc-01>but this one is an anchor</a>
10180     * @endcode
10181     *
10182     * The @c href attribute in the opening tag gives the name that will be
10183     * used to identify the anchor and it can be any valid utf8 string.
10184     *
10185     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10186     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10187     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10188     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10189     * an anchor.
10190     *
10191     * @subsection entry-items Items
10192     *
10193     * Inlined in the text, any other @c Evas_Object can be inserted by using
10194     * \<item\> tags this way:
10195     *
10196     * @code
10197     * <item size=16x16 vsize=full href=emoticon/haha></item>
10198     * @endcode
10199     *
10200     * Just like with anchors, the @c href identifies each item, but these need,
10201     * in addition, to indicate their size, which is done using any one of
10202     * @c size, @c absize or @c relsize attributes. These attributes take their
10203     * value in the WxH format, where W is the width and H the height of the
10204     * item.
10205     *
10206     * @li absize: Absolute pixel size for the item. Whatever value is set will
10207     * be the item's size regardless of any scale value the object may have
10208     * been set to. The final line height will be adjusted to fit larger items.
10209     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10210     * for the object.
10211     * @li relsize: Size is adjusted for the item to fit within the current
10212     * line height.
10213     *
10214     * Besides their size, items are specificed a @c vsize value that affects
10215     * how their final size and position are calculated. The possible values
10216     * are:
10217     * @li ascent: Item will be placed within the line's baseline and its
10218     * ascent. That is, the height between the line where all characters are
10219     * positioned and the highest point in the line. For @c size and @c absize
10220     * items, the descent value will be added to the total line height to make
10221     * them fit. @c relsize items will be adjusted to fit within this space.
10222     * @li full: Items will be placed between the descent and ascent, or the
10223     * lowest point in the line and its highest.
10224     *
10225     * The next image shows different configurations of items and how they
10226     * are the previously mentioned options affect their sizes. In all cases,
10227     * the green line indicates the ascent, blue for the baseline and red for
10228     * the descent.
10229     *
10230     * @image html entry_item.png
10231     * @image latex entry_item.eps width=\textwidth
10232     *
10233     * And another one to show how size differs from absize. In the first one,
10234     * the scale value is set to 1.0, while the second one is using one of 2.0.
10235     *
10236     * @image html entry_item_scale.png
10237     * @image latex entry_item_scale.eps width=\textwidth
10238     *
10239     * After the size for an item is calculated, the entry will request an
10240     * object to place in its space. For this, the functions set with
10241     * elm_entry_item_provider_append() and related functions will be called
10242     * in order until one of them returns a @c non-NULL value. If no providers
10243     * are available, or all of them return @c NULL, then the entry falls back
10244     * to one of the internal defaults, provided the name matches with one of
10245     * them.
10246     *
10247     * All of the following are currently supported:
10248     *
10249     * - emoticon/angry
10250     * - emoticon/angry-shout
10251     * - emoticon/crazy-laugh
10252     * - emoticon/evil-laugh
10253     * - emoticon/evil
10254     * - emoticon/goggle-smile
10255     * - emoticon/grumpy
10256     * - emoticon/grumpy-smile
10257     * - emoticon/guilty
10258     * - emoticon/guilty-smile
10259     * - emoticon/haha
10260     * - emoticon/half-smile
10261     * - emoticon/happy-panting
10262     * - emoticon/happy
10263     * - emoticon/indifferent
10264     * - emoticon/kiss
10265     * - emoticon/knowing-grin
10266     * - emoticon/laugh
10267     * - emoticon/little-bit-sorry
10268     * - emoticon/love-lots
10269     * - emoticon/love
10270     * - emoticon/minimal-smile
10271     * - emoticon/not-happy
10272     * - emoticon/not-impressed
10273     * - emoticon/omg
10274     * - emoticon/opensmile
10275     * - emoticon/smile
10276     * - emoticon/sorry
10277     * - emoticon/squint-laugh
10278     * - emoticon/surprised
10279     * - emoticon/suspicious
10280     * - emoticon/tongue-dangling
10281     * - emoticon/tongue-poke
10282     * - emoticon/uh
10283     * - emoticon/unhappy
10284     * - emoticon/very-sorry
10285     * - emoticon/what
10286     * - emoticon/wink
10287     * - emoticon/worried
10288     * - emoticon/wtf
10289     *
10290     * Alternatively, an item may reference an image by its path, using
10291     * the URI form @c file:///path/to/an/image.png and the entry will then
10292     * use that image for the item.
10293     *
10294     * @section entry-files Loading and saving files
10295     *
10296     * Entries have convinience functions to load text from a file and save
10297     * changes back to it after a short delay. The automatic saving is enabled
10298     * by default, but can be disabled with elm_entry_autosave_set() and files
10299     * can be loaded directly as plain text or have any markup in them
10300     * recognized. See elm_entry_file_set() for more details.
10301     *
10302     * @section entry-signals Emitted signals
10303     *
10304     * This widget emits the following signals:
10305     *
10306     * @li "changed": The text within the entry was changed.
10307     * @li "changed,user": The text within the entry was changed because of user interaction.
10308     * @li "activated": The enter key was pressed on a single line entry.
10309     * @li "press": A mouse button has been pressed on the entry.
10310     * @li "longpressed": A mouse button has been pressed and held for a couple
10311     * seconds.
10312     * @li "clicked": The entry has been clicked (mouse press and release).
10313     * @li "clicked,double": The entry has been double clicked.
10314     * @li "clicked,triple": The entry has been triple clicked.
10315     * @li "focused": The entry has received focus.
10316     * @li "unfocused": The entry has lost focus.
10317     * @li "selection,paste": A paste of the clipboard contents was requested.
10318     * @li "selection,copy": A copy of the selected text into the clipboard was
10319     * requested.
10320     * @li "selection,cut": A cut of the selected text into the clipboard was
10321     * requested.
10322     * @li "selection,start": A selection has begun and no previous selection
10323     * existed.
10324     * @li "selection,changed": The current selection has changed.
10325     * @li "selection,cleared": The current selection has been cleared.
10326     * @li "cursor,changed": The cursor has changed position.
10327     * @li "anchor,clicked": An anchor has been clicked. The event_info
10328     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10329     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10330     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10331     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10332     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10333     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10334     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10335     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10336     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10337     * @li "preedit,changed": The preedit string has changed.
10338     *
10339     * @section entry-examples
10340     *
10341     * An overview of the Entry API can be seen in @ref entry_example_01
10342     *
10343     * @{
10344     */
10345    /**
10346     * @typedef Elm_Entry_Anchor_Info
10347     *
10348     * The info sent in the callback for the "anchor,clicked" signals emitted
10349     * by entries.
10350     */
10351    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10352    /**
10353     * @struct _Elm_Entry_Anchor_Info
10354     *
10355     * The info sent in the callback for the "anchor,clicked" signals emitted
10356     * by entries.
10357     */
10358    struct _Elm_Entry_Anchor_Info
10359      {
10360         const char *name; /**< The name of the anchor, as stated in its href */
10361         int         button; /**< The mouse button used to click on it */
10362         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10363                     y, /**< Anchor geometry, relative to canvas */
10364                     w, /**< Anchor geometry, relative to canvas */
10365                     h; /**< Anchor geometry, relative to canvas */
10366      };
10367    /**
10368     * @typedef Elm_Entry_Filter_Cb
10369     * This callback type is used by entry filters to modify text.
10370     * @param data The data specified as the last param when adding the filter
10371     * @param entry The entry object
10372     * @param text A pointer to the location of the text being filtered. This data can be modified,
10373     * but any additional allocations must be managed by the user.
10374     * @see elm_entry_text_filter_append
10375     * @see elm_entry_text_filter_prepend
10376     */
10377    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10378
10379    /**
10380     * This adds an entry to @p parent object.
10381     *
10382     * By default, entries are:
10383     * @li not scrolled
10384     * @li multi-line
10385     * @li word wrapped
10386     * @li autosave is enabled
10387     *
10388     * @param parent The parent object
10389     * @return The new object or NULL if it cannot be created
10390     */
10391    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10392    /**
10393     * Sets the entry to single line mode.
10394     *
10395     * In single line mode, entries don't ever wrap when the text reaches the
10396     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10397     * key will generate an @c "activate" event instead of adding a new line.
10398     *
10399     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10400     * and pressing enter will break the text into a different line
10401     * without generating any events.
10402     *
10403     * @param obj The entry object
10404     * @param single_line If true, the text in the entry
10405     * will be on a single line.
10406     */
10407    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10408    /**
10409     * Gets whether the entry is set to be single line.
10410     *
10411     * @param obj The entry object
10412     * @return single_line If true, the text in the entry is set to display
10413     * on a single line.
10414     *
10415     * @see elm_entry_single_line_set()
10416     */
10417    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10418    /**
10419     * Sets the entry to password mode.
10420     *
10421     * In password mode, entries are implicitly single line and the display of
10422     * any text in them is replaced with asterisks (*).
10423     *
10424     * @param obj The entry object
10425     * @param password If true, password mode is enabled.
10426     */
10427    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10428    /**
10429     * Gets whether the entry is set to password mode.
10430     *
10431     * @param obj The entry object
10432     * @return If true, the entry is set to display all characters
10433     * as asterisks (*).
10434     *
10435     * @see elm_entry_password_set()
10436     */
10437    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10438    /**
10439     * This sets the text displayed within the entry to @p entry.
10440     *
10441     * @param obj The entry object
10442     * @param entry The text to be displayed
10443     *
10444     * @deprecated Use elm_object_text_set() instead.
10445     */
10446    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10447    /**
10448     * This returns the text currently shown in object @p entry.
10449     * See also elm_entry_entry_set().
10450     *
10451     * @param obj The entry object
10452     * @return The currently displayed text or NULL on failure
10453     *
10454     * @deprecated Use elm_object_text_get() instead.
10455     */
10456    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10457    /**
10458     * Appends @p entry to the text of the entry.
10459     *
10460     * Adds the text in @p entry to the end of any text already present in the
10461     * widget.
10462     *
10463     * The appended text is subject to any filters set for the widget.
10464     *
10465     * @param obj The entry object
10466     * @param entry The text to be displayed
10467     *
10468     * @see elm_entry_text_filter_append()
10469     */
10470    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10471    /**
10472     * Gets whether the entry is empty.
10473     *
10474     * Empty means no text at all. If there are any markup tags, like an item
10475     * tag for which no provider finds anything, and no text is displayed, this
10476     * function still returns EINA_FALSE.
10477     *
10478     * @param obj The entry object
10479     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10480     */
10481    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10482    /**
10483     * Gets any selected text within the entry.
10484     *
10485     * If there's any selected text in the entry, this function returns it as
10486     * a string in markup format. NULL is returned if no selection exists or
10487     * if an error occurred.
10488     *
10489     * The returned value points to an internal string and should not be freed
10490     * or modified in any way. If the @p entry object is deleted or its
10491     * contents are changed, the returned pointer should be considered invalid.
10492     *
10493     * @param obj The entry object
10494     * @return The selected text within the entry or NULL on failure
10495     */
10496    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10497    /**
10498     * Inserts the given text into the entry at the current cursor position.
10499     *
10500     * This inserts text at the cursor position as if it was typed
10501     * by the user (note that this also allows markup which a user
10502     * can't just "type" as it would be converted to escaped text, so this
10503     * call can be used to insert things like emoticon items or bold push/pop
10504     * tags, other font and color change tags etc.)
10505     *
10506     * If any selection exists, it will be replaced by the inserted text.
10507     *
10508     * The inserted text is subject to any filters set for the widget.
10509     *
10510     * @param obj The entry object
10511     * @param entry The text to insert
10512     *
10513     * @see elm_entry_text_filter_append()
10514     */
10515    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10516    /**
10517     * Set the line wrap type to use on multi-line entries.
10518     *
10519     * Sets the wrap type used by the entry to any of the specified in
10520     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10521     * line (without inserting a line break or paragraph separator) when it
10522     * reaches the far edge of the widget.
10523     *
10524     * Note that this only makes sense for multi-line entries. A widget set
10525     * to be single line will never wrap.
10526     *
10527     * @param obj The entry object
10528     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10529     */
10530    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10531    /**
10532     * Gets the wrap mode the entry was set to use.
10533     *
10534     * @param obj The entry object
10535     * @return Wrap type
10536     *
10537     * @see also elm_entry_line_wrap_set()
10538     */
10539    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10540    /**
10541     * Sets if the entry is to be editable or not.
10542     *
10543     * By default, entries are editable and when focused, any text input by the
10544     * user will be inserted at the current cursor position. But calling this
10545     * function with @p editable as EINA_FALSE will prevent the user from
10546     * inputting text into the entry.
10547     *
10548     * The only way to change the text of a non-editable entry is to use
10549     * elm_object_text_set(), elm_entry_entry_insert() and other related
10550     * functions.
10551     *
10552     * @param obj The entry object
10553     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10554     * if not, the entry is read-only and no user input is allowed.
10555     */
10556    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10557    /**
10558     * Gets whether the entry is editable or not.
10559     *
10560     * @param obj The entry object
10561     * @return If true, the entry is editable by the user.
10562     * If false, it is not editable by the user
10563     *
10564     * @see elm_entry_editable_set()
10565     */
10566    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10567    /**
10568     * This drops any existing text selection within the entry.
10569     *
10570     * @param obj The entry object
10571     */
10572    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10573    /**
10574     * This selects all text within the entry.
10575     *
10576     * @param obj The entry object
10577     */
10578    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10579    /**
10580     * This moves the cursor one place to the right within the entry.
10581     *
10582     * @param obj The entry object
10583     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10584     */
10585    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10586    /**
10587     * This moves the cursor one place to the left within the entry.
10588     *
10589     * @param obj The entry object
10590     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10591     */
10592    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10593    /**
10594     * This moves the cursor one line up within the entry.
10595     *
10596     * @param obj The entry object
10597     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10598     */
10599    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10600    /**
10601     * This moves the cursor one line down within the entry.
10602     *
10603     * @param obj The entry object
10604     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10605     */
10606    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10607    /**
10608     * This moves the cursor to the beginning of the entry.
10609     *
10610     * @param obj The entry object
10611     */
10612    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10613    /**
10614     * This moves the cursor to the end of the entry.
10615     *
10616     * @param obj The entry object
10617     */
10618    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10619    /**
10620     * This moves the cursor to the beginning of the current line.
10621     *
10622     * @param obj The entry object
10623     */
10624    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10625    /**
10626     * This moves the cursor to the end of the current line.
10627     *
10628     * @param obj The entry object
10629     */
10630    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10631    /**
10632     * This begins a selection within the entry as though
10633     * the user were holding down the mouse button to make a selection.
10634     *
10635     * @param obj The entry object
10636     */
10637    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10638    /**
10639     * This ends a selection within the entry as though
10640     * the user had just released the mouse button while making a selection.
10641     *
10642     * @param obj The entry object
10643     */
10644    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10645    /**
10646     * Gets whether a format node exists at the current cursor position.
10647     *
10648     * A format node is anything that defines how the text is rendered. It can
10649     * be a visible format node, such as a line break or a paragraph separator,
10650     * or an invisible one, such as bold begin or end tag.
10651     * This function returns whether any format node exists at the current
10652     * cursor position.
10653     *
10654     * @param obj The entry object
10655     * @return EINA_TRUE if the current cursor position contains a format node,
10656     * EINA_FALSE otherwise.
10657     *
10658     * @see elm_entry_cursor_is_visible_format_get()
10659     */
10660    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10661    /**
10662     * Gets if the current cursor position holds a visible format node.
10663     *
10664     * @param obj The entry object
10665     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10666     * if it's an invisible one or no format exists.
10667     *
10668     * @see elm_entry_cursor_is_format_get()
10669     */
10670    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10671    /**
10672     * Gets the character pointed by the cursor at its current position.
10673     *
10674     * This function returns a string with the utf8 character stored at the
10675     * current cursor position.
10676     * Only the text is returned, any format that may exist will not be part
10677     * of the return value.
10678     *
10679     * @param obj The entry object
10680     * @return The text pointed by the cursors.
10681     */
10682    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10683    /**
10684     * This function returns the geometry of the cursor.
10685     *
10686     * It's useful if you want to draw something on the cursor (or where it is),
10687     * or for example in the case of scrolled entry where you want to show the
10688     * cursor.
10689     *
10690     * @param obj The entry object
10691     * @param x returned geometry
10692     * @param y returned geometry
10693     * @param w returned geometry
10694     * @param h returned geometry
10695     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10696     */
10697    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);
10698    /**
10699     * Sets the cursor position in the entry to the given value
10700     *
10701     * The value in @p pos is the index of the character position within the
10702     * contents of the string as returned by elm_entry_cursor_pos_get().
10703     *
10704     * @param obj The entry object
10705     * @param pos The position of the cursor
10706     */
10707    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10708    /**
10709     * Retrieves the current position of the cursor in the entry
10710     *
10711     * @param obj The entry object
10712     * @return The cursor position
10713     */
10714    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10715    /**
10716     * This executes a "cut" action on the selected text in the entry.
10717     *
10718     * @param obj The entry object
10719     */
10720    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10721    /**
10722     * This executes a "copy" action on the selected text in the entry.
10723     *
10724     * @param obj The entry object
10725     */
10726    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10727    /**
10728     * This executes a "paste" action in the entry.
10729     *
10730     * @param obj The entry object
10731     */
10732    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10733    /**
10734     * This clears and frees the items in a entry's contextual (longpress)
10735     * menu.
10736     *
10737     * @param obj The entry object
10738     *
10739     * @see elm_entry_context_menu_item_add()
10740     */
10741    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10742    /**
10743     * This adds an item to the entry's contextual menu.
10744     *
10745     * A longpress on an entry will make the contextual menu show up, if this
10746     * hasn't been disabled with elm_entry_context_menu_disabled_set().
10747     * By default, this menu provides a few options like enabling selection mode,
10748     * which is useful on embedded devices that need to be explicit about it,
10749     * and when a selection exists it also shows the copy and cut actions.
10750     *
10751     * With this function, developers can add other options to this menu to
10752     * perform any action they deem necessary.
10753     *
10754     * @param obj The entry object
10755     * @param label The item's text label
10756     * @param icon_file The item's icon file
10757     * @param icon_type The item's icon type
10758     * @param func The callback to execute when the item is clicked
10759     * @param data The data to associate with the item for related functions
10760     */
10761    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);
10762    /**
10763     * This disables the entry's contextual (longpress) menu.
10764     *
10765     * @param obj The entry object
10766     * @param disabled If true, the menu is disabled
10767     */
10768    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10769    /**
10770     * This returns whether the entry's contextual (longpress) menu is
10771     * disabled.
10772     *
10773     * @param obj The entry object
10774     * @return If true, the menu is disabled
10775     */
10776    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10777    /**
10778     * This appends a custom item provider to the list for that entry
10779     *
10780     * This appends the given callback. The list is walked from beginning to end
10781     * with each function called given the item href string in the text. If the
10782     * function returns an object handle other than NULL (it should create an
10783     * object to do this), then this object is used to replace that item. If
10784     * not the next provider is called until one provides an item object, or the
10785     * default provider in entry does.
10786     *
10787     * @param obj The entry object
10788     * @param func The function called to provide the item object
10789     * @param data The data passed to @p func
10790     *
10791     * @see @ref entry-items
10792     */
10793    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);
10794    /**
10795     * This prepends a custom item provider to the list for that entry
10796     *
10797     * This prepends the given callback. See elm_entry_item_provider_append() for
10798     * more information
10799     *
10800     * @param obj The entry object
10801     * @param func The function called to provide the item object
10802     * @param data The data passed to @p func
10803     */
10804    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);
10805    /**
10806     * This removes a custom item provider to the list for that entry
10807     *
10808     * This removes the given callback. See elm_entry_item_provider_append() for
10809     * more information
10810     *
10811     * @param obj The entry object
10812     * @param func The function called to provide the item object
10813     * @param data The data passed to @p func
10814     */
10815    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);
10816    /**
10817     * Append a filter function for text inserted in the entry
10818     *
10819     * Append the given callback to the list. This functions will be called
10820     * whenever any text is inserted into the entry, with the text to be inserted
10821     * as a parameter. The callback function is free to alter the text in any way
10822     * it wants, but it must remember to free the given pointer and update it.
10823     * If the new text is to be discarded, the function can free it and set its
10824     * text parameter to NULL. This will also prevent any following filters from
10825     * being called.
10826     *
10827     * @param obj The entry object
10828     * @param func The function to use as text filter
10829     * @param data User data to pass to @p func
10830     */
10831    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10832    /**
10833     * Prepend a filter function for text insdrted in the entry
10834     *
10835     * Prepend the given callback to the list. See elm_entry_text_filter_append()
10836     * for more information
10837     *
10838     * @param obj The entry object
10839     * @param func The function to use as text filter
10840     * @param data User data to pass to @p func
10841     */
10842    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10843    /**
10844     * Remove a filter from the list
10845     *
10846     * Removes the given callback from the filter list. See
10847     * elm_entry_text_filter_append() for more information.
10848     *
10849     * @param obj The entry object
10850     * @param func The filter function to remove
10851     * @param data The user data passed when adding the function
10852     */
10853    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10854    /**
10855     * This converts a markup (HTML-like) string into UTF-8.
10856     *
10857     * The returned string is a malloc'ed buffer and it should be freed when
10858     * not needed anymore.
10859     *
10860     * @param s The string (in markup) to be converted
10861     * @return The converted string (in UTF-8). It should be freed.
10862     */
10863    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10864    /**
10865     * This converts a UTF-8 string into markup (HTML-like).
10866     *
10867     * The returned string is a malloc'ed buffer and it should be freed when
10868     * not needed anymore.
10869     *
10870     * @param s The string (in UTF-8) to be converted
10871     * @return The converted string (in markup). It should be freed.
10872     */
10873    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10874    /**
10875     * This sets the file (and implicitly loads it) for the text to display and
10876     * then edit. All changes are written back to the file after a short delay if
10877     * the entry object is set to autosave (which is the default).
10878     *
10879     * If the entry had any other file set previously, any changes made to it
10880     * will be saved if the autosave feature is enabled, otherwise, the file
10881     * will be silently discarded and any non-saved changes will be lost.
10882     *
10883     * @param obj The entry object
10884     * @param file The path to the file to load and save
10885     * @param format The file format
10886     */
10887    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10888    /**
10889     * Gets the file being edited by the entry.
10890     *
10891     * This function can be used to retrieve any file set on the entry for
10892     * edition, along with the format used to load and save it.
10893     *
10894     * @param obj The entry object
10895     * @param file The path to the file to load and save
10896     * @param format The file format
10897     */
10898    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10899    /**
10900     * This function writes any changes made to the file set with
10901     * elm_entry_file_set()
10902     *
10903     * @param obj The entry object
10904     */
10905    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
10906    /**
10907     * This sets the entry object to 'autosave' the loaded text file or not.
10908     *
10909     * @param obj The entry object
10910     * @param autosave Autosave the loaded file or not
10911     *
10912     * @see elm_entry_file_set()
10913     */
10914    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
10915    /**
10916     * This gets the entry object's 'autosave' status.
10917     *
10918     * @param obj The entry object
10919     * @return Autosave the loaded file or not
10920     *
10921     * @see elm_entry_file_set()
10922     */
10923    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10924    /**
10925     * Control pasting of text and images for the widget.
10926     *
10927     * Normally the entry allows both text and images to be pasted.  By setting
10928     * textonly to be true, this prevents images from being pasted.
10929     *
10930     * Note this only changes the behaviour of text.
10931     *
10932     * @param obj The entry object
10933     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
10934     * text+image+other.
10935     */
10936    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
10937    /**
10938     * Getting elm_entry text paste/drop mode.
10939     *
10940     * In textonly mode, only text may be pasted or dropped into the widget.
10941     *
10942     * @param obj The entry object
10943     * @return If the widget only accepts text from pastes.
10944     */
10945    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10946    /**
10947     * Enable or disable scrolling in entry
10948     *
10949     * Normally the entry is not scrollable unless you enable it with this call.
10950     *
10951     * @param obj The entry object
10952     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
10953     */
10954    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
10955    /**
10956     * Get the scrollable state of the entry
10957     *
10958     * Normally the entry is not scrollable. This gets the scrollable state
10959     * of the entry. See elm_entry_scrollable_set() for more information.
10960     *
10961     * @param obj The entry object
10962     * @return The scrollable state
10963     */
10964    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
10965    /**
10966     * This sets a widget to be displayed to the left of a scrolled entry.
10967     *
10968     * @param obj The scrolled entry object
10969     * @param icon The widget to display on the left side of the scrolled
10970     * entry.
10971     *
10972     * @note A previously set widget will be destroyed.
10973     * @note If the object being set does not have minimum size hints set,
10974     * it won't get properly displayed.
10975     *
10976     * @see elm_entry_end_set()
10977     */
10978    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
10979    /**
10980     * Gets the leftmost widget of the scrolled entry. This object is
10981     * owned by the scrolled entry and should not be modified.
10982     *
10983     * @param obj The scrolled entry object
10984     * @return the left widget inside the scroller
10985     */
10986    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
10987    /**
10988     * Unset the leftmost widget of the scrolled entry, unparenting and
10989     * returning it.
10990     *
10991     * @param obj The scrolled entry object
10992     * @return the previously set icon sub-object of this entry, on
10993     * success.
10994     *
10995     * @see elm_entry_icon_set()
10996     */
10997    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
10998    /**
10999     * Sets the visibility of the left-side widget of the scrolled entry,
11000     * set by elm_entry_icon_set().
11001     *
11002     * @param obj The scrolled entry object
11003     * @param setting EINA_TRUE if the object should be displayed,
11004     * EINA_FALSE if not.
11005     */
11006    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11007    /**
11008     * This sets a widget to be displayed to the end of a scrolled entry.
11009     *
11010     * @param obj The scrolled entry object
11011     * @param end The widget to display on the right side of the scrolled
11012     * entry.
11013     *
11014     * @note A previously set widget will be destroyed.
11015     * @note If the object being set does not have minimum size hints set,
11016     * it won't get properly displayed.
11017     *
11018     * @see elm_entry_icon_set
11019     */
11020    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11021    /**
11022     * Gets the endmost widget of the scrolled entry. This object is owned
11023     * by the scrolled entry and should not be modified.
11024     *
11025     * @param obj The scrolled entry object
11026     * @return the right widget inside the scroller
11027     */
11028    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11029    /**
11030     * Unset the endmost widget of the scrolled entry, unparenting and
11031     * returning it.
11032     *
11033     * @param obj The scrolled entry object
11034     * @return the previously set icon sub-object of this entry, on
11035     * success.
11036     *
11037     * @see elm_entry_icon_set()
11038     */
11039    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11040    /**
11041     * Sets the visibility of the end widget of the scrolled entry, set by
11042     * elm_entry_end_set().
11043     *
11044     * @param obj The scrolled entry object
11045     * @param setting EINA_TRUE if the object should be displayed,
11046     * EINA_FALSE if not.
11047     */
11048    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11049    /**
11050     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11051     * them).
11052     *
11053     * Setting an entry to single-line mode with elm_entry_single_line_set()
11054     * will automatically disable the display of scrollbars when the entry
11055     * moves inside its scroller.
11056     *
11057     * @param obj The scrolled entry object
11058     * @param h The horizontal scrollbar policy to apply
11059     * @param v The vertical scrollbar policy to apply
11060     */
11061    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11062    /**
11063     * This enables/disables bouncing within the entry.
11064     *
11065     * This function sets whether the entry will bounce when scrolling reaches
11066     * the end of the contained entry.
11067     *
11068     * @param obj The scrolled entry object
11069     * @param h The horizontal bounce state
11070     * @param v The vertical bounce state
11071     */
11072    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11073    /**
11074     * Get the bounce mode
11075     *
11076     * @param obj The Entry object
11077     * @param h_bounce Allow bounce horizontally
11078     * @param v_bounce Allow bounce vertically
11079     */
11080    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11081
11082    /* pre-made filters for entries */
11083    /**
11084     * @typedef Elm_Entry_Filter_Limit_Size
11085     *
11086     * Data for the elm_entry_filter_limit_size() entry filter.
11087     */
11088    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11089    /**
11090     * @struct _Elm_Entry_Filter_Limit_Size
11091     *
11092     * Data for the elm_entry_filter_limit_size() entry filter.
11093     */
11094    struct _Elm_Entry_Filter_Limit_Size
11095      {
11096         int max_char_count; /**< The maximum number of characters allowed. */
11097         int max_byte_count; /**< The maximum number of bytes allowed*/
11098      };
11099    /**
11100     * Filter inserted text based on user defined character and byte limits
11101     *
11102     * Add this filter to an entry to limit the characters that it will accept
11103     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11104     * The funtion works on the UTF-8 representation of the string, converting
11105     * it from the set markup, thus not accounting for any format in it.
11106     *
11107     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11108     * it as data when setting the filter. In it, it's possible to set limits
11109     * by character count or bytes (any of them is disabled if 0), and both can
11110     * be set at the same time. In that case, it first checks for characters,
11111     * then bytes.
11112     *
11113     * The function will cut the inserted text in order to allow only the first
11114     * number of characters that are still allowed. The cut is made in
11115     * characters, even when limiting by bytes, in order to always contain
11116     * valid ones and avoid half unicode characters making it in.
11117     *
11118     * This filter, like any others, does not apply when setting the entry text
11119     * directly with elm_object_text_set() (or the deprecated
11120     * elm_entry_entry_set()).
11121     */
11122    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11123    /**
11124     * @typedef Elm_Entry_Filter_Accept_Set
11125     *
11126     * Data for the elm_entry_filter_accept_set() entry filter.
11127     */
11128    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11129    /**
11130     * @struct _Elm_Entry_Filter_Accept_Set
11131     *
11132     * Data for the elm_entry_filter_accept_set() entry filter.
11133     */
11134    struct _Elm_Entry_Filter_Accept_Set
11135      {
11136         const char *accepted; /**< Set of characters accepted in the entry. */
11137         const char *rejected; /**< Set of characters rejected from the entry. */
11138      };
11139    /**
11140     * Filter inserted text based on accepted or rejected sets of characters
11141     *
11142     * Add this filter to an entry to restrict the set of accepted characters
11143     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11144     * This structure contains both accepted and rejected sets, but they are
11145     * mutually exclusive.
11146     *
11147     * The @c accepted set takes preference, so if it is set, the filter will
11148     * only work based on the accepted characters, ignoring anything in the
11149     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11150     *
11151     * In both cases, the function filters by matching utf8 characters to the
11152     * raw markup text, so it can be used to remove formatting tags.
11153     *
11154     * This filter, like any others, does not apply when setting the entry text
11155     * directly with elm_object_text_set() (or the deprecated
11156     * elm_entry_entry_set()).
11157     */
11158    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11159    /**
11160     * @}
11161     */
11162
11163    /* composite widgets - these basically put together basic widgets above
11164     * in convenient packages that do more than basic stuff */
11165
11166    /* anchorview */
11167    /**
11168     * @defgroup Anchorview Anchorview
11169     *
11170     * @image html img/widget/anchorview/preview-00.png
11171     * @image latex img/widget/anchorview/preview-00.eps
11172     *
11173     * Anchorview is for displaying text that contains markup with anchors
11174     * like <c>\<a href=1234\>something\</\></c> in it.
11175     *
11176     * Besides being styled differently, the anchorview widget provides the
11177     * necessary functionality so that clicking on these anchors brings up a
11178     * popup with user defined content such as "call", "add to contacts" or
11179     * "open web page". This popup is provided using the @ref Hover widget.
11180     *
11181     * This widget is very similar to @ref Anchorblock, so refer to that
11182     * widget for an example. The only difference Anchorview has is that the
11183     * widget is already provided with scrolling functionality, so if the
11184     * text set to it is too large to fit in the given space, it will scroll,
11185     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11186     * text can be displayed.
11187     *
11188     * This widget emits the following signals:
11189     * @li "anchor,clicked": will be called when an anchor is clicked. The
11190     * @p event_info parameter on the callback will be a pointer of type
11191     * ::Elm_Entry_Anchorview_Info.
11192     *
11193     * See @ref Anchorblock for an example on how to use both of them.
11194     *
11195     * @see Anchorblock
11196     * @see Entry
11197     * @see Hover
11198     *
11199     * @{
11200     */
11201    /**
11202     * @typedef Elm_Entry_Anchorview_Info
11203     *
11204     * The info sent in the callback for "anchor,clicked" signals emitted by
11205     * the Anchorview widget.
11206     */
11207    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11208    /**
11209     * @struct _Elm_Entry_Anchorview_Info
11210     *
11211     * The info sent in the callback for "anchor,clicked" signals emitted by
11212     * the Anchorview widget.
11213     */
11214    struct _Elm_Entry_Anchorview_Info
11215      {
11216         const char     *name; /**< Name of the anchor, as indicated in its href
11217                                    attribute */
11218         int             button; /**< The mouse button used to click on it */
11219         Evas_Object    *hover; /**< The hover object to use for the popup */
11220         struct {
11221              Evas_Coord    x, y, w, h;
11222         } anchor, /**< Geometry selection of text used as anchor */
11223           hover_parent; /**< Geometry of the object used as parent by the
11224                              hover */
11225         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11226                                              for content on the left side of
11227                                              the hover. Before calling the
11228                                              callback, the widget will make the
11229                                              necessary calculations to check
11230                                              which sides are fit to be set with
11231                                              content, based on the position the
11232                                              hover is activated and its distance
11233                                              to the edges of its parent object
11234                                              */
11235         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11236                                               the right side of the hover.
11237                                               See @ref hover_left */
11238         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11239                                             of the hover. See @ref hover_left */
11240         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11241                                                below the hover. See @ref
11242                                                hover_left */
11243      };
11244    /**
11245     * Add a new Anchorview object
11246     *
11247     * @param parent The parent object
11248     * @return The new object or NULL if it cannot be created
11249     */
11250    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11251    /**
11252     * Set the text to show in the anchorview
11253     *
11254     * Sets the text of the anchorview to @p text. This text can include markup
11255     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11256     * text that will be specially styled and react to click events, ended with
11257     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11258     * "anchor,clicked" signal that you can attach a callback to with
11259     * evas_object_smart_callback_add(). The name of the anchor given in the
11260     * event info struct will be the one set in the href attribute, in this
11261     * case, anchorname.
11262     *
11263     * Other markup can be used to style the text in different ways, but it's
11264     * up to the style defined in the theme which tags do what.
11265     * @deprecated use elm_object_text_set() instead.
11266     */
11267    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11268    /**
11269     * Get the markup text set for the anchorview
11270     *
11271     * Retrieves the text set on the anchorview, with markup tags included.
11272     *
11273     * @param obj The anchorview object
11274     * @return The markup text set or @c NULL if nothing was set or an error
11275     * occurred
11276     * @deprecated use elm_object_text_set() instead.
11277     */
11278    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11279    /**
11280     * Set the parent of the hover popup
11281     *
11282     * Sets the parent object to use by the hover created by the anchorview
11283     * when an anchor is clicked. See @ref Hover for more details on this.
11284     * If no parent is set, the same anchorview object will be used.
11285     *
11286     * @param obj The anchorview object
11287     * @param parent The object to use as parent for the hover
11288     */
11289    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11290    /**
11291     * Get the parent of the hover popup
11292     *
11293     * Get the object used as parent for the hover created by the anchorview
11294     * widget. See @ref Hover for more details on this.
11295     *
11296     * @param obj The anchorview object
11297     * @return The object used as parent for the hover, NULL if none is set.
11298     */
11299    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11300    /**
11301     * Set the style that the hover should use
11302     *
11303     * When creating the popup hover, anchorview will request that it's
11304     * themed according to @p style.
11305     *
11306     * @param obj The anchorview object
11307     * @param style The style to use for the underlying hover
11308     *
11309     * @see elm_object_style_set()
11310     */
11311    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11312    /**
11313     * Get the style that the hover should use
11314     *
11315     * Get the style the hover created by anchorview will use.
11316     *
11317     * @param obj The anchorview object
11318     * @return The style to use by the hover. NULL means the default is used.
11319     *
11320     * @see elm_object_style_set()
11321     */
11322    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11323    /**
11324     * Ends the hover popup in the anchorview
11325     *
11326     * When an anchor is clicked, the anchorview widget will create a hover
11327     * object to use as a popup with user provided content. This function
11328     * terminates this popup, returning the anchorview to its normal state.
11329     *
11330     * @param obj The anchorview object
11331     */
11332    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11333    /**
11334     * Set bouncing behaviour when the scrolled content reaches an edge
11335     *
11336     * Tell the internal scroller object whether it should bounce or not
11337     * when it reaches the respective edges for each axis.
11338     *
11339     * @param obj The anchorview object
11340     * @param h_bounce Whether to bounce or not in the horizontal axis
11341     * @param v_bounce Whether to bounce or not in the vertical axis
11342     *
11343     * @see elm_scroller_bounce_set()
11344     */
11345    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11346    /**
11347     * Get the set bouncing behaviour of the internal scroller
11348     *
11349     * Get whether the internal scroller should bounce when the edge of each
11350     * axis is reached scrolling.
11351     *
11352     * @param obj The anchorview object
11353     * @param h_bounce Pointer where to store the bounce state of the horizontal
11354     *                 axis
11355     * @param v_bounce Pointer where to store the bounce state of the vertical
11356     *                 axis
11357     *
11358     * @see elm_scroller_bounce_get()
11359     */
11360    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11361    /**
11362     * Appends a custom item provider to the given anchorview
11363     *
11364     * Appends the given function to the list of items providers. This list is
11365     * called, one function at a time, with the given @p data pointer, the
11366     * anchorview object and, in the @p item parameter, the item name as
11367     * referenced in its href string. Following functions in the list will be
11368     * called in order until one of them returns something different to NULL,
11369     * which should be an Evas_Object which will be used in place of the item
11370     * element.
11371     *
11372     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11373     * href=item/name\>\</item\>
11374     *
11375     * @param obj The anchorview object
11376     * @param func The function to add to the list of providers
11377     * @param data User data that will be passed to the callback function
11378     *
11379     * @see elm_entry_item_provider_append()
11380     */
11381    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);
11382    /**
11383     * Prepend a custom item provider to the given anchorview
11384     *
11385     * Like elm_anchorview_item_provider_append(), but it adds the function
11386     * @p func to the beginning of the list, instead of the end.
11387     *
11388     * @param obj The anchorview object
11389     * @param func The function to add to the list of providers
11390     * @param data User data that will be passed to the callback function
11391     */
11392    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);
11393    /**
11394     * Remove a custom item provider from the list of the given anchorview
11395     *
11396     * Removes the function and data pairing that matches @p func and @p data.
11397     * That is, unless the same function and same user data are given, the
11398     * function will not be removed from the list. This allows us to add the
11399     * same callback several times, with different @p data pointers and be
11400     * able to remove them later without conflicts.
11401     *
11402     * @param obj The anchorview object
11403     * @param func The function to remove from the list
11404     * @param data The data matching the function to remove from the list
11405     */
11406    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);
11407    /**
11408     * @}
11409     */
11410
11411    /* anchorblock */
11412    /**
11413     * @defgroup Anchorblock Anchorblock
11414     *
11415     * @image html img/widget/anchorblock/preview-00.png
11416     * @image latex img/widget/anchorblock/preview-00.eps
11417     *
11418     * Anchorblock is for displaying text that contains markup with anchors
11419     * like <c>\<a href=1234\>something\</\></c> in it.
11420     *
11421     * Besides being styled differently, the anchorblock widget provides the
11422     * necessary functionality so that clicking on these anchors brings up a
11423     * popup with user defined content such as "call", "add to contacts" or
11424     * "open web page". This popup is provided using the @ref Hover widget.
11425     *
11426     * This widget emits the following signals:
11427     * @li "anchor,clicked": will be called when an anchor is clicked. The
11428     * @p event_info parameter on the callback will be a pointer of type
11429     * ::Elm_Entry_Anchorblock_Info.
11430     *
11431     * @see Anchorview
11432     * @see Entry
11433     * @see Hover
11434     *
11435     * Since examples are usually better than plain words, we might as well
11436     * try @ref tutorial_anchorblock_example "one".
11437     */
11438    /**
11439     * @addtogroup Anchorblock
11440     * @{
11441     */
11442    /**
11443     * @typedef Elm_Entry_Anchorblock_Info
11444     *
11445     * The info sent in the callback for "anchor,clicked" signals emitted by
11446     * the Anchorblock widget.
11447     */
11448    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11449    /**
11450     * @struct _Elm_Entry_Anchorblock_Info
11451     *
11452     * The info sent in the callback for "anchor,clicked" signals emitted by
11453     * the Anchorblock widget.
11454     */
11455    struct _Elm_Entry_Anchorblock_Info
11456      {
11457         const char     *name; /**< Name of the anchor, as indicated in its href
11458                                    attribute */
11459         int             button; /**< The mouse button used to click on it */
11460         Evas_Object    *hover; /**< The hover object to use for the popup */
11461         struct {
11462              Evas_Coord    x, y, w, h;
11463         } anchor, /**< Geometry selection of text used as anchor */
11464           hover_parent; /**< Geometry of the object used as parent by the
11465                              hover */
11466         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11467                                              for content on the left side of
11468                                              the hover. Before calling the
11469                                              callback, the widget will make the
11470                                              necessary calculations to check
11471                                              which sides are fit to be set with
11472                                              content, based on the position the
11473                                              hover is activated and its distance
11474                                              to the edges of its parent object
11475                                              */
11476         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11477                                               the right side of the hover.
11478                                               See @ref hover_left */
11479         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11480                                             of the hover. See @ref hover_left */
11481         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11482                                                below the hover. See @ref
11483                                                hover_left */
11484      };
11485    /**
11486     * Add a new Anchorblock object
11487     *
11488     * @param parent The parent object
11489     * @return The new object or NULL if it cannot be created
11490     */
11491    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11492    /**
11493     * Set the text to show in the anchorblock
11494     *
11495     * Sets the text of the anchorblock to @p text. This text can include markup
11496     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11497     * of text that will be specially styled and react to click events, ended
11498     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11499     * "anchor,clicked" signal that you can attach a callback to with
11500     * evas_object_smart_callback_add(). The name of the anchor given in the
11501     * event info struct will be the one set in the href attribute, in this
11502     * case, anchorname.
11503     *
11504     * Other markup can be used to style the text in different ways, but it's
11505     * up to the style defined in the theme which tags do what.
11506     * @deprecated use elm_object_text_set() instead.
11507     */
11508    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11509    /**
11510     * Get the markup text set for the anchorblock
11511     *
11512     * Retrieves the text set on the anchorblock, with markup tags included.
11513     *
11514     * @param obj The anchorblock object
11515     * @return The markup text set or @c NULL if nothing was set or an error
11516     * occurred
11517     * @deprecated use elm_object_text_set() instead.
11518     */
11519    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11520    /**
11521     * Set the parent of the hover popup
11522     *
11523     * Sets the parent object to use by the hover created by the anchorblock
11524     * when an anchor is clicked. See @ref Hover for more details on this.
11525     *
11526     * @param obj The anchorblock object
11527     * @param parent The object to use as parent for the hover
11528     */
11529    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11530    /**
11531     * Get the parent of the hover popup
11532     *
11533     * Get the object used as parent for the hover created by the anchorblock
11534     * widget. See @ref Hover for more details on this.
11535     * If no parent is set, the same anchorblock object will be used.
11536     *
11537     * @param obj The anchorblock object
11538     * @return The object used as parent for the hover, NULL if none is set.
11539     */
11540    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11541    /**
11542     * Set the style that the hover should use
11543     *
11544     * When creating the popup hover, anchorblock will request that it's
11545     * themed according to @p style.
11546     *
11547     * @param obj The anchorblock object
11548     * @param style The style to use for the underlying hover
11549     *
11550     * @see elm_object_style_set()
11551     */
11552    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11553    /**
11554     * Get the style that the hover should use
11555     *
11556     * Get the style the hover created by anchorblock will use.
11557     *
11558     * @param obj The anchorblock object
11559     * @return The style to use by the hover. NULL means the default is used.
11560     *
11561     * @see elm_object_style_set()
11562     */
11563    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11564    /**
11565     * Ends the hover popup in the anchorblock
11566     *
11567     * When an anchor is clicked, the anchorblock widget will create a hover
11568     * object to use as a popup with user provided content. This function
11569     * terminates this popup, returning the anchorblock to its normal state.
11570     *
11571     * @param obj The anchorblock object
11572     */
11573    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11574    /**
11575     * Appends a custom item provider to the given anchorblock
11576     *
11577     * Appends the given function to the list of items providers. This list is
11578     * called, one function at a time, with the given @p data pointer, the
11579     * anchorblock object and, in the @p item parameter, the item name as
11580     * referenced in its href string. Following functions in the list will be
11581     * called in order until one of them returns something different to NULL,
11582     * which should be an Evas_Object which will be used in place of the item
11583     * element.
11584     *
11585     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11586     * href=item/name\>\</item\>
11587     *
11588     * @param obj The anchorblock object
11589     * @param func The function to add to the list of providers
11590     * @param data User data that will be passed to the callback function
11591     *
11592     * @see elm_entry_item_provider_append()
11593     */
11594    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);
11595    /**
11596     * Prepend a custom item provider to the given anchorblock
11597     *
11598     * Like elm_anchorblock_item_provider_append(), but it adds the function
11599     * @p func to the beginning of the list, instead of the end.
11600     *
11601     * @param obj The anchorblock object
11602     * @param func The function to add to the list of providers
11603     * @param data User data that will be passed to the callback function
11604     */
11605    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);
11606    /**
11607     * Remove a custom item provider from the list of the given anchorblock
11608     *
11609     * Removes the function and data pairing that matches @p func and @p data.
11610     * That is, unless the same function and same user data are given, the
11611     * function will not be removed from the list. This allows us to add the
11612     * same callback several times, with different @p data pointers and be
11613     * able to remove them later without conflicts.
11614     *
11615     * @param obj The anchorblock object
11616     * @param func The function to remove from the list
11617     * @param data The data matching the function to remove from the list
11618     */
11619    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);
11620    /**
11621     * @}
11622     */
11623
11624    /**
11625     * @defgroup Bubble Bubble
11626     *
11627     * @image html img/widget/bubble/preview-00.png
11628     * @image latex img/widget/bubble/preview-00.eps
11629     * @image html img/widget/bubble/preview-01.png
11630     * @image latex img/widget/bubble/preview-01.eps
11631     * @image html img/widget/bubble/preview-02.png
11632     * @image latex img/widget/bubble/preview-02.eps
11633     *
11634     * @brief The Bubble is a widget to show text similarly to how speech is
11635     * represented in comics.
11636     *
11637     * The bubble widget contains 5 important visual elements:
11638     * @li The frame is a rectangle with rounded rectangles and an "arrow".
11639     * @li The @p icon is an image to which the frame's arrow points to.
11640     * @li The @p label is a text which appears to the right of the icon if the
11641     * corner is "top_left" or "bottom_left" and is right aligned to the frame
11642     * otherwise.
11643     * @li The @p info is a text which appears to the right of the label. Info's
11644     * font is of a ligther color than label.
11645     * @li The @p content is an evas object that is shown inside the frame.
11646     *
11647     * The position of the arrow, icon, label and info depends on which corner is
11648     * selected. The four available corners are:
11649     * @li "top_left" - Default
11650     * @li "top_right"
11651     * @li "bottom_left"
11652     * @li "bottom_right"
11653     *
11654     * Signals that you can add callbacks for are:
11655     * @li "clicked" - This is called when a user has clicked the bubble.
11656     *
11657     * For an example of using a buble see @ref bubble_01_example_page "this".
11658     *
11659     * @{
11660     */
11661    /**
11662     * Add a new bubble to the parent
11663     *
11664     * @param parent The parent object
11665     * @return The new object or NULL if it cannot be created
11666     *
11667     * This function adds a text bubble to the given parent evas object.
11668     */
11669    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11670    /**
11671     * Set the label of the bubble
11672     *
11673     * @param obj The bubble object
11674     * @param label The string to set in the label
11675     *
11676     * This function sets the title of the bubble. Where this appears depends on
11677     * the selected corner.
11678     * @deprecated use elm_object_text_set() instead.
11679     */
11680    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11681    /**
11682     * Get the label of the bubble
11683     *
11684     * @param obj The bubble object
11685     * @return The string of set in the label
11686     *
11687     * This function gets the title of the bubble.
11688     * @deprecated use elm_object_text_get() instead.
11689     */
11690    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11691    /**
11692     * Set the info of the bubble
11693     *
11694     * @param obj The bubble object
11695     * @param info The given info about the bubble
11696     *
11697     * This function sets the info of the bubble. Where this appears depends on
11698     * the selected corner.
11699     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11700     */
11701    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11702    /**
11703     * Get the info of the bubble
11704     *
11705     * @param obj The bubble object
11706     *
11707     * @return The "info" string of the bubble
11708     *
11709     * This function gets the info text.
11710     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11711     */
11712    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11713    /**
11714     * Set the content to be shown in the bubble
11715     *
11716     * Once the content object is set, a previously set one will be deleted.
11717     * If you want to keep the old content object, use the
11718     * elm_bubble_content_unset() function.
11719     *
11720     * @param obj The bubble object
11721     * @param content The given content of the bubble
11722     *
11723     * This function sets the content shown on the middle of the bubble.
11724     */
11725    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11726    /**
11727     * Get the content shown in the bubble
11728     *
11729     * Return the content object which is set for this widget.
11730     *
11731     * @param obj The bubble object
11732     * @return The content that is being used
11733     */
11734    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11735    /**
11736     * Unset the content shown in the bubble
11737     *
11738     * Unparent and return the content object which was set for this widget.
11739     *
11740     * @param obj The bubble object
11741     * @return The content that was being used
11742     */
11743    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11744    /**
11745     * Set the icon of the bubble
11746     *
11747     * Once the icon object is set, a previously set one will be deleted.
11748     * If you want to keep the old content object, use the
11749     * elm_icon_content_unset() function.
11750     *
11751     * @param obj The bubble object
11752     * @param icon The given icon for the bubble
11753     */
11754    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11755    /**
11756     * Get the icon of the bubble
11757     *
11758     * @param obj The bubble object
11759     * @return The icon for the bubble
11760     *
11761     * This function gets the icon shown on the top left of bubble.
11762     */
11763    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11764    /**
11765     * Unset the icon of the bubble
11766     *
11767     * Unparent and return the icon object which was set for this widget.
11768     *
11769     * @param obj The bubble object
11770     * @return The icon that was being used
11771     */
11772    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11773    /**
11774     * Set the corner of the bubble
11775     *
11776     * @param obj The bubble object.
11777     * @param corner The given corner for the bubble.
11778     *
11779     * This function sets the corner of the bubble. The corner will be used to
11780     * determine where the arrow in the frame points to and where label, icon and
11781     * info arre shown.
11782     *
11783     * Possible values for corner are:
11784     * @li "top_left" - Default
11785     * @li "top_right"
11786     * @li "bottom_left"
11787     * @li "bottom_right"
11788     */
11789    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11790    /**
11791     * Get the corner of the bubble
11792     *
11793     * @param obj The bubble object.
11794     * @return The given corner for the bubble.
11795     *
11796     * This function gets the selected corner of the bubble.
11797     */
11798    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11799    /**
11800     * @}
11801     */
11802
11803    /**
11804     * @defgroup Photo Photo
11805     *
11806     * For displaying the photo of a person (contact). Simple yet
11807     * with a very specific purpose.
11808     *
11809     * Signals that you can add callbacks for are:
11810     *
11811     * "clicked" - This is called when a user has clicked the photo
11812     * "drag,start" - Someone started dragging the image out of the object
11813     * "drag,end" - Dragged item was dropped (somewhere)
11814     *
11815     * @{
11816     */
11817
11818    /**
11819     * Add a new photo to the parent
11820     *
11821     * @param parent The parent object
11822     * @return The new object or NULL if it cannot be created
11823     *
11824     * @ingroup Photo
11825     */
11826    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11827
11828    /**
11829     * Set the file that will be used as photo
11830     *
11831     * @param obj The photo object
11832     * @param file The path to file that will be used as photo
11833     *
11834     * @return (1 = success, 0 = error)
11835     *
11836     * @ingroup Photo
11837     */
11838    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11839
11840    /**
11841     * Set the size that will be used on the photo
11842     *
11843     * @param obj The photo object
11844     * @param size The size that the photo will be
11845     *
11846     * @ingroup Photo
11847     */
11848    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11849
11850    /**
11851     * Set if the photo should be completely visible or not.
11852     *
11853     * @param obj The photo object
11854     * @param fill if true the photo will be completely visible
11855     *
11856     * @ingroup Photo
11857     */
11858    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11859
11860    /**
11861     * Set editability of the photo.
11862     *
11863     * An editable photo can be dragged to or from, and can be cut or
11864     * pasted too.  Note that pasting an image or dropping an item on
11865     * the image will delete the existing content.
11866     *
11867     * @param obj The photo object.
11868     * @param set To set of clear editablity.
11869     */
11870    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11871
11872    /**
11873     * @}
11874     */
11875
11876    /* gesture layer */
11877    /**
11878     * @defgroup Elm_Gesture_Layer Gesture Layer
11879     * Gesture Layer Usage:
11880     *
11881     * Use Gesture Layer to detect gestures.
11882     * The advantage is that you don't have to implement
11883     * gesture detection, just set callbacks of gesture state.
11884     * By using gesture layer we make standard interface.
11885     *
11886     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11887     * with a parent object parameter.
11888     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11889     * call. Usually with same object as target (2nd parameter).
11890     *
11891     * Now you need to tell gesture layer what gestures you follow.
11892     * This is done with @ref elm_gesture_layer_cb_set call.
11893     * By setting the callback you actually saying to gesture layer:
11894     * I would like to know when the gesture @ref Elm_Gesture_Types
11895     * switches to state @ref Elm_Gesture_State.
11896     *
11897     * Next, you need to implement the actual action that follows the input
11898     * in your callback.
11899     *
11900     * Note that if you like to stop being reported about a gesture, just set
11901     * all callbacks referring this gesture to NULL.
11902     * (again with @ref elm_gesture_layer_cb_set)
11903     *
11904     * The information reported by gesture layer to your callback is depending
11905     * on @ref Elm_Gesture_Types:
11906     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
11907     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
11908     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
11909     *
11910     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
11911     * @ref ELM_GESTURE_MOMENTUM.
11912     *
11913     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
11914     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
11915     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
11916     * Note that we consider a flick as a line-gesture that should be completed
11917     * in flick-time-limit as defined in @ref Config.
11918     *
11919     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
11920     *
11921     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
11922     * */
11923
11924    /**
11925     * @enum _Elm_Gesture_Types
11926     * Enum of supported gesture types.
11927     * @ingroup Elm_Gesture_Layer
11928     */
11929    enum _Elm_Gesture_Types
11930      {
11931         ELM_GESTURE_FIRST = 0,
11932
11933         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
11934         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
11935         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
11936         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
11937
11938         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
11939
11940         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
11941         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
11942
11943         ELM_GESTURE_ZOOM, /**< Zoom */
11944         ELM_GESTURE_ROTATE, /**< Rotate */
11945
11946         ELM_GESTURE_LAST
11947      };
11948
11949    /**
11950     * @typedef Elm_Gesture_Types
11951     * gesture types enum
11952     * @ingroup Elm_Gesture_Layer
11953     */
11954    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
11955
11956    /**
11957     * @enum _Elm_Gesture_State
11958     * Enum of gesture states.
11959     * @ingroup Elm_Gesture_Layer
11960     */
11961    enum _Elm_Gesture_State
11962      {
11963         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
11964         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
11965         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
11966         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
11967         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
11968      };
11969
11970    /**
11971     * @typedef Elm_Gesture_State
11972     * gesture states enum
11973     * @ingroup Elm_Gesture_Layer
11974     */
11975    typedef enum _Elm_Gesture_State Elm_Gesture_State;
11976
11977    /**
11978     * @struct _Elm_Gesture_Taps_Info
11979     * Struct holds taps info for user
11980     * @ingroup Elm_Gesture_Layer
11981     */
11982    struct _Elm_Gesture_Taps_Info
11983      {
11984         Evas_Coord x, y;         /**< Holds center point between fingers */
11985         unsigned int n;          /**< Number of fingers tapped           */
11986         unsigned int timestamp;  /**< event timestamp       */
11987      };
11988
11989    /**
11990     * @typedef Elm_Gesture_Taps_Info
11991     * holds taps info for user
11992     * @ingroup Elm_Gesture_Layer
11993     */
11994    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
11995
11996    /**
11997     * @struct _Elm_Gesture_Momentum_Info
11998     * Struct holds momentum info for user
11999     * x1 and y1 are not necessarily in sync
12000     * x1 holds x value of x direction starting point
12001     * and same holds for y1.
12002     * This is noticeable when doing V-shape movement
12003     * @ingroup Elm_Gesture_Layer
12004     */
12005    struct _Elm_Gesture_Momentum_Info
12006      {  /* Report line ends, timestamps, and momentum computed        */
12007         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12008         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12009         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12010         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12011
12012         unsigned int tx; /**< Timestamp of start of final x-swipe */
12013         unsigned int ty; /**< Timestamp of start of final y-swipe */
12014
12015         Evas_Coord mx; /**< Momentum on X */
12016         Evas_Coord my; /**< Momentum on Y */
12017      };
12018
12019    /**
12020     * @typedef Elm_Gesture_Momentum_Info
12021     * holds momentum info for user
12022     * @ingroup Elm_Gesture_Layer
12023     */
12024     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12025
12026    /**
12027     * @struct _Elm_Gesture_Line_Info
12028     * Struct holds line info for user
12029     * @ingroup Elm_Gesture_Layer
12030     */
12031    struct _Elm_Gesture_Line_Info
12032      {  /* Report line ends, timestamps, and momentum computed      */
12033         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12034         unsigned int n;            /**< Number of fingers (lines)   */
12035         /* FIXME should be radians, bot degrees */
12036         double angle;              /**< Angle (direction) of lines  */
12037      };
12038
12039    /**
12040     * @typedef Elm_Gesture_Line_Info
12041     * Holds line info for user
12042     * @ingroup Elm_Gesture_Layer
12043     */
12044     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12045
12046    /**
12047     * @struct _Elm_Gesture_Zoom_Info
12048     * Struct holds zoom info for user
12049     * @ingroup Elm_Gesture_Layer
12050     */
12051    struct _Elm_Gesture_Zoom_Info
12052      {
12053         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12054         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12055         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12056         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12057      };
12058
12059    /**
12060     * @typedef Elm_Gesture_Zoom_Info
12061     * Holds zoom info for user
12062     * @ingroup Elm_Gesture_Layer
12063     */
12064    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12065
12066    /**
12067     * @struct _Elm_Gesture_Rotate_Info
12068     * Struct holds rotation info for user
12069     * @ingroup Elm_Gesture_Layer
12070     */
12071    struct _Elm_Gesture_Rotate_Info
12072      {
12073         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12074         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12075         double base_angle; /**< Holds start-angle */
12076         double angle;      /**< Rotation value: 0.0 means no rotation         */
12077         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12078      };
12079
12080    /**
12081     * @typedef Elm_Gesture_Rotate_Info
12082     * Holds rotation info for user
12083     * @ingroup Elm_Gesture_Layer
12084     */
12085    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12086
12087    /**
12088     * @typedef Elm_Gesture_Event_Cb
12089     * User callback used to stream gesture info from gesture layer
12090     * @param data user data
12091     * @param event_info gesture report info
12092     * Returns a flag field to be applied on the causing event.
12093     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12094     * upon the event, in an irreversible way.
12095     *
12096     * @ingroup Elm_Gesture_Layer
12097     */
12098    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12099
12100    /**
12101     * Use function to set callbacks to be notified about
12102     * change of state of gesture.
12103     * When a user registers a callback with this function
12104     * this means this gesture has to be tested.
12105     *
12106     * When ALL callbacks for a gesture are set to NULL
12107     * it means user isn't interested in gesture-state
12108     * and it will not be tested.
12109     *
12110     * @param obj Pointer to gesture-layer.
12111     * @param idx The gesture you would like to track its state.
12112     * @param cb callback function pointer.
12113     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12114     * @param data user info to be sent to callback (usually, Smart Data)
12115     *
12116     * @ingroup Elm_Gesture_Layer
12117     */
12118    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);
12119
12120    /**
12121     * Call this function to get repeat-events settings.
12122     *
12123     * @param obj Pointer to gesture-layer.
12124     *
12125     * @return repeat events settings.
12126     * @see elm_gesture_layer_hold_events_set()
12127     * @ingroup Elm_Gesture_Layer
12128     */
12129    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12130
12131    /**
12132     * This function called in order to make gesture-layer repeat events.
12133     * Set this of you like to get the raw events only if gestures were not detected.
12134     * Clear this if you like gesture layer to fwd events as testing gestures.
12135     *
12136     * @param obj Pointer to gesture-layer.
12137     * @param r Repeat: TRUE/FALSE
12138     *
12139     * @ingroup Elm_Gesture_Layer
12140     */
12141    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12142
12143    /**
12144     * This function sets step-value for zoom action.
12145     * Set step to any positive value.
12146     * Cancel step setting by setting to 0.0
12147     *
12148     * @param obj Pointer to gesture-layer.
12149     * @param s new zoom step value.
12150     *
12151     * @ingroup Elm_Gesture_Layer
12152     */
12153    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12154
12155    /**
12156     * This function sets step-value for rotate action.
12157     * Set step to any positive value.
12158     * Cancel step setting by setting to 0.0
12159     *
12160     * @param obj Pointer to gesture-layer.
12161     * @param s new roatate step value.
12162     *
12163     * @ingroup Elm_Gesture_Layer
12164     */
12165    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12166
12167    /**
12168     * This function called to attach gesture-layer to an Evas_Object.
12169     * @param obj Pointer to gesture-layer.
12170     * @param t Pointer to underlying object (AKA Target)
12171     *
12172     * @return TRUE, FALSE on success, failure.
12173     *
12174     * @ingroup Elm_Gesture_Layer
12175     */
12176    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12177
12178    /**
12179     * Call this function to construct a new gesture-layer object.
12180     * This does not activate the gesture layer. You have to
12181     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12182     *
12183     * @param parent the parent object.
12184     *
12185     * @return Pointer to new gesture-layer object.
12186     *
12187     * @ingroup Elm_Gesture_Layer
12188     */
12189    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12190
12191    /**
12192     * @defgroup Thumb Thumb
12193     *
12194     * @image html img/widget/thumb/preview-00.png
12195     * @image latex img/widget/thumb/preview-00.eps
12196     *
12197     * A thumb object is used for displaying the thumbnail of an image or video.
12198     * You must have compiled Elementary with Ethumb_Client support and the DBus
12199     * service must be present and auto-activated in order to have thumbnails to
12200     * be generated.
12201     *
12202     * Once the thumbnail object becomes visible, it will check if there is a
12203     * previously generated thumbnail image for the file set on it. If not, it
12204     * will start generating this thumbnail.
12205     *
12206     * Different config settings will cause different thumbnails to be generated
12207     * even on the same file.
12208     *
12209     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12210     * Ethumb documentation to change this path, and to see other configuration
12211     * options.
12212     *
12213     * Signals that you can add callbacks for are:
12214     *
12215     * - "clicked" - This is called when a user has clicked the thumb without dragging
12216     *             around.
12217     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12218     * - "press" - This is called when a user has pressed down the thumb.
12219     * - "generate,start" - The thumbnail generation started.
12220     * - "generate,stop" - The generation process stopped.
12221     * - "generate,error" - The generation failed.
12222     * - "load,error" - The thumbnail image loading failed.
12223     *
12224     * available styles:
12225     * - default
12226     * - noframe
12227     *
12228     * An example of use of thumbnail:
12229     *
12230     * - @ref thumb_example_01
12231     */
12232
12233    /**
12234     * @addtogroup Thumb
12235     * @{
12236     */
12237
12238    /**
12239     * @enum _Elm_Thumb_Animation_Setting
12240     * @typedef Elm_Thumb_Animation_Setting
12241     *
12242     * Used to set if a video thumbnail is animating or not.
12243     *
12244     * @ingroup Thumb
12245     */
12246    typedef enum _Elm_Thumb_Animation_Setting
12247      {
12248         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12249         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12250         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12251         ELM_THUMB_ANIMATION_LAST
12252      } Elm_Thumb_Animation_Setting;
12253
12254    /**
12255     * Add a new thumb object to the parent.
12256     *
12257     * @param parent The parent object.
12258     * @return The new object or NULL if it cannot be created.
12259     *
12260     * @see elm_thumb_file_set()
12261     * @see elm_thumb_ethumb_client_get()
12262     *
12263     * @ingroup Thumb
12264     */
12265    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12266    /**
12267     * Reload thumbnail if it was generated before.
12268     *
12269     * @param obj The thumb object to reload
12270     *
12271     * This is useful if the ethumb client configuration changed, like its
12272     * size, aspect or any other property one set in the handle returned
12273     * by elm_thumb_ethumb_client_get().
12274     *
12275     * If the options didn't change, the thumbnail won't be generated again, but
12276     * the old one will still be used.
12277     *
12278     * @see elm_thumb_file_set()
12279     *
12280     * @ingroup Thumb
12281     */
12282    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12283    /**
12284     * Set the file that will be used as thumbnail.
12285     *
12286     * @param obj The thumb object.
12287     * @param file The path to file that will be used as thumb.
12288     * @param key The key used in case of an EET file.
12289     *
12290     * The file can be an image or a video (in that case, acceptable extensions are:
12291     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12292     * function elm_thumb_animate().
12293     *
12294     * @see elm_thumb_file_get()
12295     * @see elm_thumb_reload()
12296     * @see elm_thumb_animate()
12297     *
12298     * @ingroup Thumb
12299     */
12300    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12301    /**
12302     * Get the image or video path and key used to generate the thumbnail.
12303     *
12304     * @param obj The thumb object.
12305     * @param file Pointer to filename.
12306     * @param key Pointer to key.
12307     *
12308     * @see elm_thumb_file_set()
12309     * @see elm_thumb_path_get()
12310     *
12311     * @ingroup Thumb
12312     */
12313    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12314    /**
12315     * Get the path and key to the image or video generated by ethumb.
12316     *
12317     * One just need to make sure that the thumbnail was generated before getting
12318     * its path; otherwise, the path will be NULL. One way to do that is by asking
12319     * for the path when/after the "generate,stop" smart callback is called.
12320     *
12321     * @param obj The thumb object.
12322     * @param file Pointer to thumb path.
12323     * @param key Pointer to thumb key.
12324     *
12325     * @see elm_thumb_file_get()
12326     *
12327     * @ingroup Thumb
12328     */
12329    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12330    /**
12331     * Set the animation state for the thumb object. If its content is an animated
12332     * video, you may start/stop the animation or tell it to play continuously and
12333     * looping.
12334     *
12335     * @param obj The thumb object.
12336     * @param setting The animation setting.
12337     *
12338     * @see elm_thumb_file_set()
12339     *
12340     * @ingroup Thumb
12341     */
12342    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12343    /**
12344     * Get the animation state for the thumb object.
12345     *
12346     * @param obj The thumb object.
12347     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12348     * on errors.
12349     *
12350     * @see elm_thumb_animate_set()
12351     *
12352     * @ingroup Thumb
12353     */
12354    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12355    /**
12356     * Get the ethumb_client handle so custom configuration can be made.
12357     *
12358     * @return Ethumb_Client instance or NULL.
12359     *
12360     * This must be called before the objects are created to be sure no object is
12361     * visible and no generation started.
12362     *
12363     * Example of usage:
12364     *
12365     * @code
12366     * #include <Elementary.h>
12367     * #ifndef ELM_LIB_QUICKLAUNCH
12368     * EAPI int
12369     * elm_main(int argc, char **argv)
12370     * {
12371     *    Ethumb_Client *client;
12372     *
12373     *    elm_need_ethumb();
12374     *
12375     *    // ... your code
12376     *
12377     *    client = elm_thumb_ethumb_client_get();
12378     *    if (!client)
12379     *      {
12380     *         ERR("could not get ethumb_client");
12381     *         return 1;
12382     *      }
12383     *    ethumb_client_size_set(client, 100, 100);
12384     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12385     *    // ... your code
12386     *
12387     *    // Create elm_thumb objects here
12388     *
12389     *    elm_run();
12390     *    elm_shutdown();
12391     *    return 0;
12392     * }
12393     * #endif
12394     * ELM_MAIN()
12395     * @endcode
12396     *
12397     * @note There's only one client handle for Ethumb, so once a configuration
12398     * change is done to it, any other request for thumbnails (for any thumbnail
12399     * object) will use that configuration. Thus, this configuration is global.
12400     *
12401     * @ingroup Thumb
12402     */
12403    EAPI void                        *elm_thumb_ethumb_client_get(void);
12404    /**
12405     * Get the ethumb_client connection state.
12406     *
12407     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12408     * otherwise.
12409     */
12410    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12411    /**
12412     * Make the thumbnail 'editable'.
12413     *
12414     * @param obj Thumb object.
12415     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12416     *
12417     * This means the thumbnail is a valid drag target for drag and drop, and can be
12418     * cut or pasted too.
12419     *
12420     * @see elm_thumb_editable_get()
12421     *
12422     * @ingroup Thumb
12423     */
12424    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12425    /**
12426     * Make the thumbnail 'editable'.
12427     *
12428     * @param obj Thumb object.
12429     * @return Editability.
12430     *
12431     * This means the thumbnail is a valid drag target for drag and drop, and can be
12432     * cut or pasted too.
12433     *
12434     * @see elm_thumb_editable_set()
12435     *
12436     * @ingroup Thumb
12437     */
12438    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12439
12440    /**
12441     * @}
12442     */
12443
12444    /**
12445     * @defgroup Hoversel Hoversel
12446     *
12447     * @image html img/widget/hoversel/preview-00.png
12448     * @image latex img/widget/hoversel/preview-00.eps
12449     *
12450     * A hoversel is a button that pops up a list of items (automatically
12451     * choosing the direction to display) that have a label and, optionally, an
12452     * icon to select from. It is a convenience widget to avoid the need to do
12453     * all the piecing together yourself. It is intended for a small number of
12454     * items in the hoversel menu (no more than 8), though is capable of many
12455     * more.
12456     *
12457     * Signals that you can add callbacks for are:
12458     * "clicked" - the user clicked the hoversel button and popped up the sel
12459     * "selected" - an item in the hoversel list is selected. event_info is the item
12460     * "dismissed" - the hover is dismissed
12461     *
12462     * See @ref tutorial_hoversel for an example.
12463     * @{
12464     */
12465    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12466    /**
12467     * @brief Add a new Hoversel object
12468     *
12469     * @param parent The parent object
12470     * @return The new object or NULL if it cannot be created
12471     */
12472    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12473    /**
12474     * @brief This sets the hoversel to expand horizontally.
12475     *
12476     * @param obj The hoversel object
12477     * @param horizontal If true, the hover will expand horizontally to the
12478     * right.
12479     *
12480     * @note The initial button will display horizontally regardless of this
12481     * setting.
12482     */
12483    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12484    /**
12485     * @brief This returns whether the hoversel is set to expand horizontally.
12486     *
12487     * @param obj The hoversel object
12488     * @return If true, the hover will expand horizontally to the right.
12489     *
12490     * @see elm_hoversel_horizontal_set()
12491     */
12492    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12493    /**
12494     * @brief Set the Hover parent
12495     *
12496     * @param obj The hoversel object
12497     * @param parent The parent to use
12498     *
12499     * Sets the hover parent object, the area that will be darkened when the
12500     * hoversel is clicked. Should probably be the window that the hoversel is
12501     * in. See @ref Hover objects for more information.
12502     */
12503    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12504    /**
12505     * @brief Get the Hover parent
12506     *
12507     * @param obj The hoversel object
12508     * @return The used parent
12509     *
12510     * Gets the hover parent object.
12511     *
12512     * @see elm_hoversel_hover_parent_set()
12513     */
12514    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12515    /**
12516     * @brief Set the hoversel button label
12517     *
12518     * @param obj The hoversel object
12519     * @param label The label text.
12520     *
12521     * This sets the label of the button that is always visible (before it is
12522     * clicked and expanded).
12523     *
12524     * @deprecated elm_object_text_set()
12525     */
12526    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12527    /**
12528     * @brief Get the hoversel button label
12529     *
12530     * @param obj The hoversel object
12531     * @return The label text.
12532     *
12533     * @deprecated elm_object_text_get()
12534     */
12535    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12536    /**
12537     * @brief Set the icon of the hoversel button
12538     *
12539     * @param obj The hoversel object
12540     * @param icon The icon object
12541     *
12542     * Sets the icon of the button that is always visible (before it is clicked
12543     * and expanded).  Once the icon object is set, a previously set one will be
12544     * deleted, if you want to keep that old content object, use the
12545     * elm_hoversel_icon_unset() function.
12546     *
12547     * @see elm_button_icon_set()
12548     */
12549    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12550    /**
12551     * @brief Get the icon of the hoversel button
12552     *
12553     * @param obj The hoversel object
12554     * @return The icon object
12555     *
12556     * Get the icon of the button that is always visible (before it is clicked
12557     * and expanded). Also see elm_button_icon_get().
12558     *
12559     * @see elm_hoversel_icon_set()
12560     */
12561    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12562    /**
12563     * @brief Get and unparent the icon of the hoversel button
12564     *
12565     * @param obj The hoversel object
12566     * @return The icon object that was being used
12567     *
12568     * Unparent and return the icon of the button that is always visible
12569     * (before it is clicked and expanded).
12570     *
12571     * @see elm_hoversel_icon_set()
12572     * @see elm_button_icon_unset()
12573     */
12574    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12575    /**
12576     * @brief This triggers the hoversel popup from code, the same as if the user
12577     * had clicked the button.
12578     *
12579     * @param obj The hoversel object
12580     */
12581    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12582    /**
12583     * @brief This dismisses the hoversel popup as if the user had clicked
12584     * outside the hover.
12585     *
12586     * @param obj The hoversel object
12587     */
12588    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12589    /**
12590     * @brief Returns whether the hoversel is expanded.
12591     *
12592     * @param obj The hoversel object
12593     * @return  This will return EINA_TRUE if the hoversel is expanded or
12594     * EINA_FALSE if it is not expanded.
12595     */
12596    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12597    /**
12598     * @brief This will remove all the children items from the hoversel.
12599     *
12600     * @param obj The hoversel object
12601     *
12602     * @warning Should @b not be called while the hoversel is active; use
12603     * elm_hoversel_expanded_get() to check first.
12604     *
12605     * @see elm_hoversel_item_del_cb_set()
12606     * @see elm_hoversel_item_del()
12607     */
12608    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12609    /**
12610     * @brief Get the list of items within the given hoversel.
12611     *
12612     * @param obj The hoversel object
12613     * @return Returns a list of Elm_Hoversel_Item*
12614     *
12615     * @see elm_hoversel_item_add()
12616     */
12617    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12618    /**
12619     * @brief Add an item to the hoversel button
12620     *
12621     * @param obj The hoversel object
12622     * @param label The text label to use for the item (NULL if not desired)
12623     * @param icon_file An image file path on disk to use for the icon or standard
12624     * icon name (NULL if not desired)
12625     * @param icon_type The icon type if relevant
12626     * @param func Convenience function to call when this item is selected
12627     * @param data Data to pass to item-related functions
12628     * @return A handle to the item added.
12629     *
12630     * This adds an item to the hoversel to show when it is clicked. Note: if you
12631     * need to use an icon from an edje file then use
12632     * elm_hoversel_item_icon_set() right after the this function, and set
12633     * icon_file to NULL here.
12634     *
12635     * For more information on what @p icon_file and @p icon_type are see the
12636     * @ref Icon "icon documentation".
12637     */
12638    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);
12639    /**
12640     * @brief Delete an item from the hoversel
12641     *
12642     * @param item The item to delete
12643     *
12644     * This deletes the item from the hoversel (should not be called while the
12645     * hoversel is active; use elm_hoversel_expanded_get() to check first).
12646     *
12647     * @see elm_hoversel_item_add()
12648     * @see elm_hoversel_item_del_cb_set()
12649     */
12650    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12651    /**
12652     * @brief Set the function to be called when an item from the hoversel is
12653     * freed.
12654     *
12655     * @param item The item to set the callback on
12656     * @param func The function called
12657     *
12658     * That function will receive these parameters:
12659     * @li void *item_data
12660     * @li Evas_Object *the_item_object
12661     * @li Elm_Hoversel_Item *the_object_struct
12662     *
12663     * @see elm_hoversel_item_add()
12664     */
12665    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12666    /**
12667     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12668     * that will be passed to associated function callbacks.
12669     *
12670     * @param item The item to get the data from
12671     * @return The data pointer set with elm_hoversel_item_add()
12672     *
12673     * @see elm_hoversel_item_add()
12674     */
12675    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12676    /**
12677     * @brief This returns the label text of the given hoversel item.
12678     *
12679     * @param item The item to get the label
12680     * @return The label text of the hoversel item
12681     *
12682     * @see elm_hoversel_item_add()
12683     */
12684    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12685    /**
12686     * @brief This sets the icon for the given hoversel item.
12687     *
12688     * @param item The item to set the icon
12689     * @param icon_file An image file path on disk to use for the icon or standard
12690     * icon name
12691     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12692     * to NULL if the icon is not an edje file
12693     * @param icon_type The icon type
12694     *
12695     * The icon can be loaded from the standard set, from an image file, or from
12696     * an edje file.
12697     *
12698     * @see elm_hoversel_item_add()
12699     */
12700    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);
12701    /**
12702     * @brief Get the icon object of the hoversel item
12703     *
12704     * @param item The item to get the icon from
12705     * @param icon_file The image file path on disk used for the icon or standard
12706     * icon name
12707     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12708     * if the icon is not an edje file
12709     * @param icon_type The icon type
12710     *
12711     * @see elm_hoversel_item_icon_set()
12712     * @see elm_hoversel_item_add()
12713     */
12714    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);
12715    /**
12716     * @}
12717     */
12718
12719    /**
12720     * @defgroup Toolbar Toolbar
12721     * @ingroup Elementary
12722     *
12723     * @image html img/widget/toolbar/preview-00.png
12724     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12725     *
12726     * @image html img/toolbar.png
12727     * @image latex img/toolbar.eps width=\textwidth
12728     *
12729     * A toolbar is a widget that displays a list of items inside
12730     * a box. It can be scrollable, show a menu with items that don't fit
12731     * to toolbar size or even crop them.
12732     *
12733     * Only one item can be selected at a time.
12734     *
12735     * Items can have multiple states, or show menus when selected by the user.
12736     *
12737     * Smart callbacks one can listen to:
12738     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12739     *
12740     * Available styles for it:
12741     * - @c "default"
12742     * - @c "transparent" - no background or shadow, just show the content
12743     *
12744     * List of examples:
12745     * @li @ref toolbar_example_01
12746     * @li @ref toolbar_example_02
12747     * @li @ref toolbar_example_03
12748     */
12749
12750    /**
12751     * @addtogroup Toolbar
12752     * @{
12753     */
12754
12755    /**
12756     * @enum _Elm_Toolbar_Shrink_Mode
12757     * @typedef Elm_Toolbar_Shrink_Mode
12758     *
12759     * Set toolbar's items display behavior, it can be scrollabel,
12760     * show a menu with exceeding items, or simply hide them.
12761     *
12762     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12763     * from elm config.
12764     *
12765     * Values <b> don't </b> work as bitmask, only one can be choosen.
12766     *
12767     * @see elm_toolbar_mode_shrink_set()
12768     * @see elm_toolbar_mode_shrink_get()
12769     *
12770     * @ingroup Toolbar
12771     */
12772    typedef enum _Elm_Toolbar_Shrink_Mode
12773      {
12774         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
12775         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
12776         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12777         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
12778      } Elm_Toolbar_Shrink_Mode;
12779
12780    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(). */
12781
12782    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(). */
12783
12784    /**
12785     * Add a new toolbar widget to the given parent Elementary
12786     * (container) object.
12787     *
12788     * @param parent The parent object.
12789     * @return a new toolbar widget handle or @c NULL, on errors.
12790     *
12791     * This function inserts a new toolbar widget on the canvas.
12792     *
12793     * @ingroup Toolbar
12794     */
12795    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12796
12797    /**
12798     * Set the icon size, in pixels, to be used by toolbar items.
12799     *
12800     * @param obj The toolbar object
12801     * @param icon_size The icon size in pixels
12802     *
12803     * @note Default value is @c 32. It reads value from elm config.
12804     *
12805     * @see elm_toolbar_icon_size_get()
12806     *
12807     * @ingroup Toolbar
12808     */
12809    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12810
12811    /**
12812     * Get the icon size, in pixels, to be used by toolbar items.
12813     *
12814     * @param obj The toolbar object.
12815     * @return The icon size in pixels.
12816     *
12817     * @see elm_toolbar_icon_size_set() for details.
12818     *
12819     * @ingroup Toolbar
12820     */
12821    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12822
12823    /**
12824     * Sets icon lookup order, for toolbar items' icons.
12825     *
12826     * @param obj The toolbar object.
12827     * @param order The icon lookup order.
12828     *
12829     * Icons added before calling this function will not be affected.
12830     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12831     *
12832     * @see elm_toolbar_icon_order_lookup_get()
12833     *
12834     * @ingroup Toolbar
12835     */
12836    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12837
12838    /**
12839     * Gets the icon lookup order.
12840     *
12841     * @param obj The toolbar object.
12842     * @return The icon lookup order.
12843     *
12844     * @see elm_toolbar_icon_order_lookup_set() for details.
12845     *
12846     * @ingroup Toolbar
12847     */
12848    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12849
12850    /**
12851     * Set whether the toolbar items' should be selected by the user or not.
12852     *
12853     * @param obj The toolbar object.
12854     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12855     * enable it.
12856     *
12857     * This will turn off the ability to select items entirely and they will
12858     * neither appear selected nor emit selected signals. The clicked
12859     * callback function will still be called.
12860     *
12861     * Selection is enabled by default.
12862     *
12863     * @see elm_toolbar_no_select_mode_get().
12864     *
12865     * @ingroup Toolbar
12866     */
12867    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12868
12869    /**
12870     * Set whether the toolbar items' should be selected by the user or not.
12871     *
12872     * @param obj The toolbar object.
12873     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12874     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12875     *
12876     * @see elm_toolbar_no_select_mode_set() for details.
12877     *
12878     * @ingroup Toolbar
12879     */
12880    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12881
12882    /**
12883     * Append item to the toolbar.
12884     *
12885     * @param obj The toolbar object.
12886     * @param icon A string with icon name or the absolute path of an image file.
12887     * @param label The label of the item.
12888     * @param func The function to call when the item is clicked.
12889     * @param data The data to associate with the item for related callbacks.
12890     * @return The created item or @c NULL upon failure.
12891     *
12892     * A new item will be created and appended to the toolbar, i.e., will
12893     * be set as @b last item.
12894     *
12895     * Items created with this method can be deleted with
12896     * elm_toolbar_item_del().
12897     *
12898     * Associated @p data can be properly freed when item is deleted if a
12899     * callback function is set with elm_toolbar_item_del_cb_set().
12900     *
12901     * If a function is passed as argument, it will be called everytime this item
12902     * is selected, i.e., the user clicks over an unselected item.
12903     * If such function isn't needed, just passing
12904     * @c NULL as @p func is enough. The same should be done for @p data.
12905     *
12906     * Toolbar will load icon image from fdo or current theme.
12907     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12908     * If an absolute path is provided it will load it direct from a file.
12909     *
12910     * @see elm_toolbar_item_icon_set()
12911     * @see elm_toolbar_item_del()
12912     * @see elm_toolbar_item_del_cb_set()
12913     *
12914     * @ingroup Toolbar
12915     */
12916    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);
12917
12918    /**
12919     * Prepend item to the toolbar.
12920     *
12921     * @param obj The toolbar object.
12922     * @param icon A string with icon name or the absolute path of an image file.
12923     * @param label The label of the item.
12924     * @param func The function to call when the item is clicked.
12925     * @param data The data to associate with the item for related callbacks.
12926     * @return The created item or @c NULL upon failure.
12927     *
12928     * A new item will be created and prepended to the toolbar, i.e., will
12929     * be set as @b first item.
12930     *
12931     * Items created with this method can be deleted with
12932     * elm_toolbar_item_del().
12933     *
12934     * Associated @p data can be properly freed when item is deleted if a
12935     * callback function is set with elm_toolbar_item_del_cb_set().
12936     *
12937     * If a function is passed as argument, it will be called everytime this item
12938     * is selected, i.e., the user clicks over an unselected item.
12939     * If such function isn't needed, just passing
12940     * @c NULL as @p func is enough. The same should be done for @p data.
12941     *
12942     * Toolbar will load icon image from fdo or current theme.
12943     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12944     * If an absolute path is provided it will load it direct from a file.
12945     *
12946     * @see elm_toolbar_item_icon_set()
12947     * @see elm_toolbar_item_del()
12948     * @see elm_toolbar_item_del_cb_set()
12949     *
12950     * @ingroup Toolbar
12951     */
12952    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);
12953
12954    /**
12955     * Insert a new item into the toolbar object before item @p before.
12956     *
12957     * @param obj The toolbar object.
12958     * @param before The toolbar item to insert before.
12959     * @param icon A string with icon name or the absolute path of an image file.
12960     * @param label The label of the item.
12961     * @param func The function to call when the item is clicked.
12962     * @param data The data to associate with the item for related callbacks.
12963     * @return The created item or @c NULL upon failure.
12964     *
12965     * A new item will be created and added to the toolbar. Its position in
12966     * this toolbar will be just before item @p before.
12967     *
12968     * Items created with this method can be deleted with
12969     * elm_toolbar_item_del().
12970     *
12971     * Associated @p data can be properly freed when item is deleted if a
12972     * callback function is set with elm_toolbar_item_del_cb_set().
12973     *
12974     * If a function is passed as argument, it will be called everytime this item
12975     * is selected, i.e., the user clicks over an unselected item.
12976     * If such function isn't needed, just passing
12977     * @c NULL as @p func is enough. The same should be done for @p data.
12978     *
12979     * Toolbar will load icon image from fdo or current theme.
12980     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12981     * If an absolute path is provided it will load it direct from a file.
12982     *
12983     * @see elm_toolbar_item_icon_set()
12984     * @see elm_toolbar_item_del()
12985     * @see elm_toolbar_item_del_cb_set()
12986     *
12987     * @ingroup Toolbar
12988     */
12989    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);
12990
12991    /**
12992     * Insert a new item into the toolbar object after item @p after.
12993     *
12994     * @param obj The toolbar object.
12995     * @param before The toolbar item to insert before.
12996     * @param icon A string with icon name or the absolute path of an image file.
12997     * @param label The label of the item.
12998     * @param func The function to call when the item is clicked.
12999     * @param data The data to associate with the item for related callbacks.
13000     * @return The created item or @c NULL upon failure.
13001     *
13002     * A new item will be created and added to the toolbar. Its position in
13003     * this toolbar will be just after item @p after.
13004     *
13005     * Items created with this method can be deleted with
13006     * elm_toolbar_item_del().
13007     *
13008     * Associated @p data can be properly freed when item is deleted if a
13009     * callback function is set with elm_toolbar_item_del_cb_set().
13010     *
13011     * If a function is passed as argument, it will be called everytime this item
13012     * is selected, i.e., the user clicks over an unselected item.
13013     * If such function isn't needed, just passing
13014     * @c NULL as @p func is enough. The same should be done for @p data.
13015     *
13016     * Toolbar will load icon image from fdo or current theme.
13017     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13018     * If an absolute path is provided it will load it direct from a file.
13019     *
13020     * @see elm_toolbar_item_icon_set()
13021     * @see elm_toolbar_item_del()
13022     * @see elm_toolbar_item_del_cb_set()
13023     *
13024     * @ingroup Toolbar
13025     */
13026    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);
13027
13028    /**
13029     * Get the first item in the given toolbar widget's list of
13030     * items.
13031     *
13032     * @param obj The toolbar object
13033     * @return The first item or @c NULL, if it has no items (and on
13034     * errors)
13035     *
13036     * @see elm_toolbar_item_append()
13037     * @see elm_toolbar_last_item_get()
13038     *
13039     * @ingroup Toolbar
13040     */
13041    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13042
13043    /**
13044     * Get the last item in the given toolbar widget's list of
13045     * items.
13046     *
13047     * @param obj The toolbar object
13048     * @return The last item or @c NULL, if it has no items (and on
13049     * errors)
13050     *
13051     * @see elm_toolbar_item_prepend()
13052     * @see elm_toolbar_first_item_get()
13053     *
13054     * @ingroup Toolbar
13055     */
13056    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13057
13058    /**
13059     * Get the item after @p item in toolbar.
13060     *
13061     * @param item The toolbar item.
13062     * @return The item after @p item, or @c NULL if none or on failure.
13063     *
13064     * @note If it is the last item, @c NULL will be returned.
13065     *
13066     * @see elm_toolbar_item_append()
13067     *
13068     * @ingroup Toolbar
13069     */
13070    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13071
13072    /**
13073     * Get the item before @p item in toolbar.
13074     *
13075     * @param item The toolbar item.
13076     * @return The item before @p item, or @c NULL if none or on failure.
13077     *
13078     * @note If it is the first item, @c NULL will be returned.
13079     *
13080     * @see elm_toolbar_item_prepend()
13081     *
13082     * @ingroup Toolbar
13083     */
13084    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13085
13086    /**
13087     * Get the toolbar object from an item.
13088     *
13089     * @param item The item.
13090     * @return The toolbar object.
13091     *
13092     * This returns the toolbar object itself that an item belongs to.
13093     *
13094     * @ingroup Toolbar
13095     */
13096    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13097
13098    /**
13099     * Set the priority of a toolbar item.
13100     *
13101     * @param item The toolbar item.
13102     * @param priority The item priority. The default is zero.
13103     *
13104     * This is used only when the toolbar shrink mode is set to
13105     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13106     * When space is less than required, items with low priority
13107     * will be removed from the toolbar and added to a dynamically-created menu,
13108     * while items with higher priority will remain on the toolbar,
13109     * with the same order they were added.
13110     *
13111     * @see elm_toolbar_item_priority_get()
13112     *
13113     * @ingroup Toolbar
13114     */
13115    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13116
13117    /**
13118     * Get the priority of a toolbar item.
13119     *
13120     * @param item The toolbar item.
13121     * @return The @p item priority, or @c 0 on failure.
13122     *
13123     * @see elm_toolbar_item_priority_set() for details.
13124     *
13125     * @ingroup Toolbar
13126     */
13127    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13128
13129    /**
13130     * Get the label of item.
13131     *
13132     * @param item The item of toolbar.
13133     * @return The label of item.
13134     *
13135     * The return value is a pointer to the label associated to @p item when
13136     * it was created, with function elm_toolbar_item_append() or similar,
13137     * or later,
13138     * with function elm_toolbar_item_label_set. If no label
13139     * was passed as argument, it will return @c NULL.
13140     *
13141     * @see elm_toolbar_item_label_set() for more details.
13142     * @see elm_toolbar_item_append()
13143     *
13144     * @ingroup Toolbar
13145     */
13146    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13147
13148    /**
13149     * Set the label of item.
13150     *
13151     * @param item The item of toolbar.
13152     * @param text The label of item.
13153     *
13154     * The label to be displayed by the item.
13155     * Label will be placed at icons bottom (if set).
13156     *
13157     * If a label was passed as argument on item creation, with function
13158     * elm_toolbar_item_append() or similar, it will be already
13159     * displayed by the item.
13160     *
13161     * @see elm_toolbar_item_label_get()
13162     * @see elm_toolbar_item_append()
13163     *
13164     * @ingroup Toolbar
13165     */
13166    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13167
13168    /**
13169     * Return the data associated with a given toolbar widget item.
13170     *
13171     * @param item The toolbar widget item handle.
13172     * @return The data associated with @p item.
13173     *
13174     * @see elm_toolbar_item_data_set()
13175     *
13176     * @ingroup Toolbar
13177     */
13178    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13179
13180    /**
13181     * Set the data associated with a given toolbar widget item.
13182     *
13183     * @param item The toolbar widget item handle.
13184     * @param data The new data pointer to set to @p item.
13185     *
13186     * This sets new item data on @p item.
13187     *
13188     * @warning The old data pointer won't be touched by this function, so
13189     * the user had better to free that old data himself/herself.
13190     *
13191     * @ingroup Toolbar
13192     */
13193    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13194
13195    /**
13196     * Returns a pointer to a toolbar item by its label.
13197     *
13198     * @param obj The toolbar object.
13199     * @param label The label of the item to find.
13200     *
13201     * @return The pointer to the toolbar item matching @p label or @c NULL
13202     * on failure.
13203     *
13204     * @ingroup Toolbar
13205     */
13206    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13207
13208    /*
13209     * Get whether the @p item is selected or not.
13210     *
13211     * @param item The toolbar item.
13212     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13213     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13214     *
13215     * @see elm_toolbar_selected_item_set() for details.
13216     * @see elm_toolbar_item_selected_get()
13217     *
13218     * @ingroup Toolbar
13219     */
13220    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13221
13222    /**
13223     * Set the selected state of an item.
13224     *
13225     * @param item The toolbar item
13226     * @param selected The selected state
13227     *
13228     * This sets the selected state of the given item @p it.
13229     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13230     *
13231     * If a new item is selected the previosly selected will be unselected.
13232     * Previoulsy selected item can be get with function
13233     * elm_toolbar_selected_item_get().
13234     *
13235     * Selected items will be highlighted.
13236     *
13237     * @see elm_toolbar_item_selected_get()
13238     * @see elm_toolbar_selected_item_get()
13239     *
13240     * @ingroup Toolbar
13241     */
13242    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13243
13244    /**
13245     * Get the selected item.
13246     *
13247     * @param obj The toolbar object.
13248     * @return The selected toolbar item.
13249     *
13250     * The selected item can be unselected with function
13251     * elm_toolbar_item_selected_set().
13252     *
13253     * The selected item always will be highlighted on toolbar.
13254     *
13255     * @see elm_toolbar_selected_items_get()
13256     *
13257     * @ingroup Toolbar
13258     */
13259    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13260
13261    /**
13262     * Set the icon associated with @p item.
13263     *
13264     * @param obj The parent of this item.
13265     * @param item The toolbar item.
13266     * @param icon A string with icon name or the absolute path of an image file.
13267     *
13268     * Toolbar will load icon image from fdo or current theme.
13269     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13270     * If an absolute path is provided it will load it direct from a file.
13271     *
13272     * @see elm_toolbar_icon_order_lookup_set()
13273     * @see elm_toolbar_icon_order_lookup_get()
13274     *
13275     * @ingroup Toolbar
13276     */
13277    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13278
13279    /**
13280     * Get the string used to set the icon of @p item.
13281     *
13282     * @param item The toolbar item.
13283     * @return The string associated with the icon object.
13284     *
13285     * @see elm_toolbar_item_icon_set() for details.
13286     *
13287     * @ingroup Toolbar
13288     */
13289    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13290
13291    /**
13292     * Delete them item from the toolbar.
13293     *
13294     * @param item The item of toolbar to be deleted.
13295     *
13296     * @see elm_toolbar_item_append()
13297     * @see elm_toolbar_item_del_cb_set()
13298     *
13299     * @ingroup Toolbar
13300     */
13301    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13302
13303    /**
13304     * Set the function called when a toolbar item is freed.
13305     *
13306     * @param item The item to set the callback on.
13307     * @param func The function called.
13308     *
13309     * If there is a @p func, then it will be called prior item's memory release.
13310     * That will be called with the following arguments:
13311     * @li item's data;
13312     * @li item's Evas object;
13313     * @li item itself;
13314     *
13315     * This way, a data associated to a toolbar item could be properly freed.
13316     *
13317     * @ingroup Toolbar
13318     */
13319    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13320
13321    /**
13322     * Get a value whether toolbar item is disabled or not.
13323     *
13324     * @param item The item.
13325     * @return The disabled state.
13326     *
13327     * @see elm_toolbar_item_disabled_set() for more details.
13328     *
13329     * @ingroup Toolbar
13330     */
13331    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13332
13333    /**
13334     * Sets the disabled/enabled state of a toolbar item.
13335     *
13336     * @param item The item.
13337     * @param disabled The disabled state.
13338     *
13339     * A disabled item cannot be selected or unselected. It will also
13340     * change its appearance (generally greyed out). This sets the
13341     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13342     * enabled).
13343     *
13344     * @ingroup Toolbar
13345     */
13346    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13347
13348    /**
13349     * Set or unset item as a separator.
13350     *
13351     * @param item The toolbar item.
13352     * @param setting @c EINA_TRUE to set item @p item as separator or
13353     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13354     *
13355     * Items aren't set as separator by default.
13356     *
13357     * If set as separator it will display separator theme, so won't display
13358     * icons or label.
13359     *
13360     * @see elm_toolbar_item_separator_get()
13361     *
13362     * @ingroup Toolbar
13363     */
13364    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13365
13366    /**
13367     * Get a value whether item is a separator or not.
13368     *
13369     * @param item The toolbar item.
13370     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13371     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13372     *
13373     * @see elm_toolbar_item_separator_set() for details.
13374     *
13375     * @ingroup Toolbar
13376     */
13377    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13378
13379    /**
13380     * Set the shrink state of toolbar @p obj.
13381     *
13382     * @param obj The toolbar object.
13383     * @param shrink_mode Toolbar's items display behavior.
13384     *
13385     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13386     * but will enforce a minimun size so all the items will fit, won't scroll
13387     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13388     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13389     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13390     *
13391     * @ingroup Toolbar
13392     */
13393    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13394
13395    /**
13396     * Get the shrink mode of toolbar @p obj.
13397     *
13398     * @param obj The toolbar object.
13399     * @return Toolbar's items display behavior.
13400     *
13401     * @see elm_toolbar_mode_shrink_set() for details.
13402     *
13403     * @ingroup Toolbar
13404     */
13405    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13406
13407    /**
13408     * Enable/disable homogenous mode.
13409     *
13410     * @param obj The toolbar object
13411     * @param homogeneous Assume the items within the toolbar are of the
13412     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13413     *
13414     * This will enable the homogeneous mode where items are of the same size.
13415     * @see elm_toolbar_homogeneous_get()
13416     *
13417     * @ingroup Toolbar
13418     */
13419    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13420
13421    /**
13422     * Get whether the homogenous mode is enabled.
13423     *
13424     * @param obj The toolbar object.
13425     * @return Assume the items within the toolbar are of the same height
13426     * and width (EINA_TRUE = on, EINA_FALSE = off).
13427     *
13428     * @see elm_toolbar_homogeneous_set()
13429     *
13430     * @ingroup Toolbar
13431     */
13432    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13433
13434    /**
13435     * Enable/disable homogenous mode.
13436     *
13437     * @param obj The toolbar object
13438     * @param homogeneous Assume the items within the toolbar are of the
13439     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13440     *
13441     * This will enable the homogeneous mode where items are of the same size.
13442     * @see elm_toolbar_homogeneous_get()
13443     *
13444     * @deprecated use elm_toolbar_homogeneous_set() instead.
13445     *
13446     * @ingroup Toolbar
13447     */
13448    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13449
13450    /**
13451     * Get whether the homogenous mode is enabled.
13452     *
13453     * @param obj The toolbar object.
13454     * @return Assume the items within the toolbar are of the same height
13455     * and width (EINA_TRUE = on, EINA_FALSE = off).
13456     *
13457     * @see elm_toolbar_homogeneous_set()
13458     * @deprecated use elm_toolbar_homogeneous_get() instead.
13459     *
13460     * @ingroup Toolbar
13461     */
13462    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13463
13464    /**
13465     * Set the parent object of the toolbar items' menus.
13466     *
13467     * @param obj The toolbar object.
13468     * @param parent The parent of the menu objects.
13469     *
13470     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13471     *
13472     * For more details about setting the parent for toolbar menus, see
13473     * elm_menu_parent_set().
13474     *
13475     * @see elm_menu_parent_set() for details.
13476     * @see elm_toolbar_item_menu_set() for details.
13477     *
13478     * @ingroup Toolbar
13479     */
13480    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13481
13482    /**
13483     * Get the parent object of the toolbar items' menus.
13484     *
13485     * @param obj The toolbar object.
13486     * @return The parent of the menu objects.
13487     *
13488     * @see elm_toolbar_menu_parent_set() for details.
13489     *
13490     * @ingroup Toolbar
13491     */
13492    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13493
13494    /**
13495     * Set the alignment of the items.
13496     *
13497     * @param obj The toolbar object.
13498     * @param align The new alignment, a float between <tt> 0.0 </tt>
13499     * and <tt> 1.0 </tt>.
13500     *
13501     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13502     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13503     * items.
13504     *
13505     * Centered items by default.
13506     *
13507     * @see elm_toolbar_align_get()
13508     *
13509     * @ingroup Toolbar
13510     */
13511    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13512
13513    /**
13514     * Get the alignment of the items.
13515     *
13516     * @param obj The toolbar object.
13517     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13518     * <tt> 1.0 </tt>.
13519     *
13520     * @see elm_toolbar_align_set() for details.
13521     *
13522     * @ingroup Toolbar
13523     */
13524    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13525
13526    /**
13527     * Set whether the toolbar item opens a menu.
13528     *
13529     * @param item The toolbar item.
13530     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13531     *
13532     * A toolbar item can be set to be a menu, using this function.
13533     *
13534     * Once it is set to be a menu, it can be manipulated through the
13535     * menu-like function elm_toolbar_menu_parent_set() and the other
13536     * elm_menu functions, using the Evas_Object @c menu returned by
13537     * elm_toolbar_item_menu_get().
13538     *
13539     * So, items to be displayed in this item's menu should be added with
13540     * elm_menu_item_add().
13541     *
13542     * The following code exemplifies the most basic usage:
13543     * @code
13544     * tb = elm_toolbar_add(win)
13545     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13546     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13547     * elm_toolbar_menu_parent_set(tb, win);
13548     * menu = elm_toolbar_item_menu_get(item);
13549     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13550     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13551     * NULL);
13552     * @endcode
13553     *
13554     * @see elm_toolbar_item_menu_get()
13555     *
13556     * @ingroup Toolbar
13557     */
13558    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13559
13560    /**
13561     * Get toolbar item's menu.
13562     *
13563     * @param item The toolbar item.
13564     * @return Item's menu object or @c NULL on failure.
13565     *
13566     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13567     * this function will set it.
13568     *
13569     * @see elm_toolbar_item_menu_set() for details.
13570     *
13571     * @ingroup Toolbar
13572     */
13573    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13574
13575    /**
13576     * Add a new state to @p item.
13577     *
13578     * @param item The item.
13579     * @param icon A string with icon name or the absolute path of an image file.
13580     * @param label The label of the new state.
13581     * @param func The function to call when the item is clicked when this
13582     * state is selected.
13583     * @param data The data to associate with the state.
13584     * @return The toolbar item state, or @c NULL upon failure.
13585     *
13586     * Toolbar will load icon image from fdo or current theme.
13587     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13588     * If an absolute path is provided it will load it direct from a file.
13589     *
13590     * States created with this function can be removed with
13591     * elm_toolbar_item_state_del().
13592     *
13593     * @see elm_toolbar_item_state_del()
13594     * @see elm_toolbar_item_state_sel()
13595     * @see elm_toolbar_item_state_get()
13596     *
13597     * @ingroup Toolbar
13598     */
13599    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);
13600
13601    /**
13602     * Delete a previoulsy added state to @p item.
13603     *
13604     * @param item The toolbar item.
13605     * @param state The state to be deleted.
13606     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13607     *
13608     * @see elm_toolbar_item_state_add()
13609     */
13610    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13611
13612    /**
13613     * Set @p state as the current state of @p it.
13614     *
13615     * @param it The item.
13616     * @param state The state to use.
13617     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13618     *
13619     * If @p state is @c NULL, it won't select any state and the default item's
13620     * icon and label will be used. It's the same behaviour than
13621     * elm_toolbar_item_state_unser().
13622     *
13623     * @see elm_toolbar_item_state_unset()
13624     *
13625     * @ingroup Toolbar
13626     */
13627    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13628
13629    /**
13630     * Unset the state of @p it.
13631     *
13632     * @param it The item.
13633     *
13634     * The default icon and label from this item will be displayed.
13635     *
13636     * @see elm_toolbar_item_state_set() for more details.
13637     *
13638     * @ingroup Toolbar
13639     */
13640    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13641
13642    /**
13643     * Get the current state of @p it.
13644     *
13645     * @param item The item.
13646     * @return The selected state or @c NULL if none is selected or on failure.
13647     *
13648     * @see elm_toolbar_item_state_set() for details.
13649     * @see elm_toolbar_item_state_unset()
13650     * @see elm_toolbar_item_state_add()
13651     *
13652     * @ingroup Toolbar
13653     */
13654    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13655
13656    /**
13657     * Get the state after selected state in toolbar's @p item.
13658     *
13659     * @param it The toolbar item to change state.
13660     * @return The state after current state, or @c NULL on failure.
13661     *
13662     * If last state is selected, this function will return first state.
13663     *
13664     * @see elm_toolbar_item_state_set()
13665     * @see elm_toolbar_item_state_add()
13666     *
13667     * @ingroup Toolbar
13668     */
13669    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13670
13671    /**
13672     * Get the state before selected state in toolbar's @p item.
13673     *
13674     * @param it The toolbar item to change state.
13675     * @return The state before current state, or @c NULL on failure.
13676     *
13677     * If first state is selected, this function will return last state.
13678     *
13679     * @see elm_toolbar_item_state_set()
13680     * @see elm_toolbar_item_state_add()
13681     *
13682     * @ingroup Toolbar
13683     */
13684    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13685
13686    /**
13687     * Set the text to be shown in a given toolbar item's tooltips.
13688     *
13689     * @param item Target item.
13690     * @param text The text to set in the content.
13691     *
13692     * Setup the text as tooltip to object. The item can have only one tooltip,
13693     * so any previous tooltip data - set with this function or
13694     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13695     *
13696     * @see elm_object_tooltip_text_set() for more details.
13697     *
13698     * @ingroup Toolbar
13699     */
13700    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13701
13702    /**
13703     * Set the content to be shown in the tooltip item.
13704     *
13705     * Setup the tooltip to item. The item can have only one tooltip,
13706     * so any previous tooltip data is removed. @p func(with @p data) will
13707     * be called every time that need show the tooltip and it should
13708     * return a valid Evas_Object. This object is then managed fully by
13709     * tooltip system and is deleted when the tooltip is gone.
13710     *
13711     * @param item the toolbar item being attached a tooltip.
13712     * @param func the function used to create the tooltip contents.
13713     * @param data what to provide to @a func as callback data/context.
13714     * @param del_cb called when data is not needed anymore, either when
13715     *        another callback replaces @a func, the tooltip is unset with
13716     *        elm_toolbar_item_tooltip_unset() or the owner @a item
13717     *        dies. This callback receives as the first parameter the
13718     *        given @a data, and @c event_info is the item.
13719     *
13720     * @see elm_object_tooltip_content_cb_set() for more details.
13721     *
13722     * @ingroup Toolbar
13723     */
13724    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);
13725
13726    /**
13727     * Unset tooltip from item.
13728     *
13729     * @param item toolbar item to remove previously set tooltip.
13730     *
13731     * Remove tooltip from item. The callback provided as del_cb to
13732     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13733     * it is not used anymore.
13734     *
13735     * @see elm_object_tooltip_unset() for more details.
13736     * @see elm_toolbar_item_tooltip_content_cb_set()
13737     *
13738     * @ingroup Toolbar
13739     */
13740    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13741
13742    /**
13743     * Sets a different style for this item tooltip.
13744     *
13745     * @note before you set a style you should define a tooltip with
13746     *       elm_toolbar_item_tooltip_content_cb_set() or
13747     *       elm_toolbar_item_tooltip_text_set()
13748     *
13749     * @param item toolbar item with tooltip already set.
13750     * @param style the theme style to use (default, transparent, ...)
13751     *
13752     * @see elm_object_tooltip_style_set() for more details.
13753     *
13754     * @ingroup Toolbar
13755     */
13756    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13757
13758    /**
13759     * Get the style for this item tooltip.
13760     *
13761     * @param item toolbar item with tooltip already set.
13762     * @return style the theme style in use, defaults to "default". If the
13763     *         object does not have a tooltip set, then NULL is returned.
13764     *
13765     * @see elm_object_tooltip_style_get() for more details.
13766     * @see elm_toolbar_item_tooltip_style_set()
13767     *
13768     * @ingroup Toolbar
13769     */
13770    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13771
13772    /**
13773     * Set the type of mouse pointer/cursor decoration to be shown,
13774     * when the mouse pointer is over the given toolbar widget item
13775     *
13776     * @param item toolbar item to customize cursor on
13777     * @param cursor the cursor type's name
13778     *
13779     * This function works analogously as elm_object_cursor_set(), but
13780     * here the cursor's changing area is restricted to the item's
13781     * area, and not the whole widget's. Note that that item cursors
13782     * have precedence over widget cursors, so that a mouse over an
13783     * item with custom cursor set will always show @b that cursor.
13784     *
13785     * If this function is called twice for an object, a previously set
13786     * cursor will be unset on the second call.
13787     *
13788     * @see elm_object_cursor_set()
13789     * @see elm_toolbar_item_cursor_get()
13790     * @see elm_toolbar_item_cursor_unset()
13791     *
13792     * @ingroup Toolbar
13793     */
13794    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13795
13796    /*
13797     * Get the type of mouse pointer/cursor decoration set to be shown,
13798     * when the mouse pointer is over the given toolbar widget item
13799     *
13800     * @param item toolbar item with custom cursor set
13801     * @return the cursor type's name or @c NULL, if no custom cursors
13802     * were set to @p item (and on errors)
13803     *
13804     * @see elm_object_cursor_get()
13805     * @see elm_toolbar_item_cursor_set()
13806     * @see elm_toolbar_item_cursor_unset()
13807     *
13808     * @ingroup Toolbar
13809     */
13810    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13811
13812    /**
13813     * Unset any custom mouse pointer/cursor decoration set to be
13814     * shown, when the mouse pointer is over the given toolbar widget
13815     * item, thus making it show the @b default cursor again.
13816     *
13817     * @param item a toolbar item
13818     *
13819     * Use this call to undo any custom settings on this item's cursor
13820     * decoration, bringing it back to defaults (no custom style set).
13821     *
13822     * @see elm_object_cursor_unset()
13823     * @see elm_toolbar_item_cursor_set()
13824     *
13825     * @ingroup Toolbar
13826     */
13827    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13828
13829    /**
13830     * Set a different @b style for a given custom cursor set for a
13831     * toolbar item.
13832     *
13833     * @param item toolbar item with custom cursor set
13834     * @param style the <b>theme style</b> to use (e.g. @c "default",
13835     * @c "transparent", etc)
13836     *
13837     * This function only makes sense when one is using custom mouse
13838     * cursor decorations <b>defined in a theme file</b>, which can have,
13839     * given a cursor name/type, <b>alternate styles</b> on it. It
13840     * works analogously as elm_object_cursor_style_set(), but here
13841     * applyed only to toolbar item objects.
13842     *
13843     * @warning Before you set a cursor style you should have definen a
13844     *       custom cursor previously on the item, with
13845     *       elm_toolbar_item_cursor_set()
13846     *
13847     * @see elm_toolbar_item_cursor_engine_only_set()
13848     * @see elm_toolbar_item_cursor_style_get()
13849     *
13850     * @ingroup Toolbar
13851     */
13852    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13853
13854    /**
13855     * Get the current @b style set for a given toolbar item's custom
13856     * cursor
13857     *
13858     * @param item toolbar item with custom cursor set.
13859     * @return style the cursor style in use. If the object does not
13860     *         have a cursor set, then @c NULL is returned.
13861     *
13862     * @see elm_toolbar_item_cursor_style_set() for more details
13863     *
13864     * @ingroup Toolbar
13865     */
13866    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13867
13868    /**
13869     * Set if the (custom)cursor for a given toolbar item should be
13870     * searched in its theme, also, or should only rely on the
13871     * rendering engine.
13872     *
13873     * @param item item with custom (custom) cursor already set on
13874     * @param engine_only Use @c EINA_TRUE to have cursors looked for
13875     * only on those provided by the rendering engine, @c EINA_FALSE to
13876     * have them searched on the widget's theme, as well.
13877     *
13878     * @note This call is of use only if you've set a custom cursor
13879     * for toolbar items, with elm_toolbar_item_cursor_set().
13880     *
13881     * @note By default, cursors will only be looked for between those
13882     * provided by the rendering engine.
13883     *
13884     * @ingroup Toolbar
13885     */
13886    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13887
13888    /**
13889     * Get if the (custom) cursor for a given toolbar item is being
13890     * searched in its theme, also, or is only relying on the rendering
13891     * engine.
13892     *
13893     * @param item a toolbar item
13894     * @return @c EINA_TRUE, if cursors are being looked for only on
13895     * those provided by the rendering engine, @c EINA_FALSE if they
13896     * are being searched on the widget's theme, as well.
13897     *
13898     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13899     *
13900     * @ingroup Toolbar
13901     */
13902    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13903
13904    /**
13905     * Change a toolbar's orientation
13906     * @param obj The toolbar object
13907     * @param vertical If @c EINA_TRUE, the toolbar is vertical
13908     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
13909     * @ingroup Toolbar
13910     */
13911    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
13912
13913    /**
13914     * Get a toolbar's orientation
13915     * @param obj The toolbar object
13916     * @return If @c EINA_TRUE, the toolbar is vertical
13917     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
13918     * @ingroup Toolbar
13919     */
13920    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13921
13922    /**
13923     * @}
13924     */
13925
13926    /**
13927     * @defgroup Tooltips Tooltips
13928     *
13929     * The Tooltip is an (internal, for now) smart object used to show a
13930     * content in a frame on mouse hover of objects(or widgets), with
13931     * tips/information about them.
13932     *
13933     * @{
13934     */
13935
13936    EAPI double       elm_tooltip_delay_get(void);
13937    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
13938    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
13939    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
13940    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
13941    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);
13942    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13943    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13944    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13945    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
13946    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
13947
13948    /**
13949     * @}
13950     */
13951
13952    /**
13953     * @defgroup Cursors Cursors
13954     *
13955     * The Elementary cursor is an internal smart object used to
13956     * customize the mouse cursor displayed over objects (or
13957     * widgets). In the most common scenario, the cursor decoration
13958     * comes from the graphical @b engine Elementary is running
13959     * on. Those engines may provide different decorations for cursors,
13960     * and Elementary provides functions to choose them (think of X11
13961     * cursors, as an example).
13962     *
13963     * There's also the possibility of, besides using engine provided
13964     * cursors, also use ones coming from Edje theming files. Both
13965     * globally and per widget, Elementary makes it possible for one to
13966     * make the cursors lookup to be held on engines only or on
13967     * Elementary's theme file, too.
13968     *
13969     * @{
13970     */
13971
13972    /**
13973     * Set the cursor to be shown when mouse is over the object
13974     *
13975     * Set the cursor that will be displayed when mouse is over the
13976     * object. The object can have only one cursor set to it, so if
13977     * this function is called twice for an object, the previous set
13978     * will be unset.
13979     * If using X cursors, a definition of all the valid cursor names
13980     * is listed on Elementary_Cursors.h. If an invalid name is set
13981     * the default cursor will be used.
13982     *
13983     * @param obj the object being set a cursor.
13984     * @param cursor the cursor name to be used.
13985     *
13986     * @ingroup Cursors
13987     */
13988    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
13989
13990    /**
13991     * Get the cursor to be shown when mouse is over the object
13992     *
13993     * @param obj an object with cursor already set.
13994     * @return the cursor name.
13995     *
13996     * @ingroup Cursors
13997     */
13998    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13999
14000    /**
14001     * Unset cursor for object
14002     *
14003     * Unset cursor for object, and set the cursor to default if the mouse
14004     * was over this object.
14005     *
14006     * @param obj Target object
14007     * @see elm_object_cursor_set()
14008     *
14009     * @ingroup Cursors
14010     */
14011    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14012
14013    /**
14014     * Sets a different style for this object cursor.
14015     *
14016     * @note before you set a style you should define a cursor with
14017     *       elm_object_cursor_set()
14018     *
14019     * @param obj an object with cursor already set.
14020     * @param style the theme style to use (default, transparent, ...)
14021     *
14022     * @ingroup Cursors
14023     */
14024    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14025
14026    /**
14027     * Get the style for this object cursor.
14028     *
14029     * @param obj an object with cursor already set.
14030     * @return style the theme style in use, defaults to "default". If the
14031     *         object does not have a cursor set, then NULL is returned.
14032     *
14033     * @ingroup Cursors
14034     */
14035    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14036
14037    /**
14038     * Set if the cursor set should be searched on the theme or should use
14039     * the provided by the engine, only.
14040     *
14041     * @note before you set if should look on theme you should define a cursor
14042     * with elm_object_cursor_set(). By default it will only look for cursors
14043     * provided by the engine.
14044     *
14045     * @param obj an object with cursor already set.
14046     * @param engine_only boolean to define it cursors should be looked only
14047     * between the provided by the engine or searched on widget's theme as well.
14048     *
14049     * @ingroup Cursors
14050     */
14051    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14052
14053    /**
14054     * Get the cursor engine only usage for this object cursor.
14055     *
14056     * @param obj an object with cursor already set.
14057     * @return engine_only boolean to define it cursors should be
14058     * looked only between the provided by the engine or searched on
14059     * widget's theme as well. If the object does not have a cursor
14060     * set, then EINA_FALSE is returned.
14061     *
14062     * @ingroup Cursors
14063     */
14064    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14065
14066    /**
14067     * Get the configured cursor engine only usage
14068     *
14069     * This gets the globally configured exclusive usage of engine cursors.
14070     *
14071     * @return 1 if only engine cursors should be used
14072     * @ingroup Cursors
14073     */
14074    EAPI int          elm_cursor_engine_only_get(void);
14075
14076    /**
14077     * Set the configured cursor engine only usage
14078     *
14079     * This sets the globally configured exclusive usage of engine cursors.
14080     * It won't affect cursors set before changing this value.
14081     *
14082     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14083     * look for them on theme before.
14084     * @return EINA_TRUE if value is valid and setted (0 or 1)
14085     * @ingroup Cursors
14086     */
14087    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
14088
14089    /**
14090     * @}
14091     */
14092
14093    /**
14094     * @defgroup Menu Menu
14095     *
14096     * @image html img/widget/menu/preview-00.png
14097     * @image latex img/widget/menu/preview-00.eps
14098     *
14099     * A menu is a list of items displayed above its parent. When the menu is
14100     * showing its parent is darkened. Each item can have a sub-menu. The menu
14101     * object can be used to display a menu on a right click event, in a toolbar,
14102     * anywhere.
14103     *
14104     * Signals that you can add callbacks for are:
14105     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14106     *             event_info is NULL.
14107     *
14108     * @see @ref tutorial_menu
14109     * @{
14110     */
14111    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14112    /**
14113     * @brief Add a new menu to the parent
14114     *
14115     * @param parent The parent object.
14116     * @return The new object or NULL if it cannot be created.
14117     */
14118    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14119    /**
14120     * @brief Set the parent for the given menu widget
14121     *
14122     * @param obj The menu object.
14123     * @param parent The new parent.
14124     */
14125    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14126    /**
14127     * @brief Get the parent for the given menu widget
14128     *
14129     * @param obj The menu object.
14130     * @return The parent.
14131     *
14132     * @see elm_menu_parent_set()
14133     */
14134    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14135    /**
14136     * @brief Move the menu to a new position
14137     *
14138     * @param obj The menu object.
14139     * @param x The new position.
14140     * @param y The new position.
14141     *
14142     * Sets the top-left position of the menu to (@p x,@p y).
14143     *
14144     * @note @p x and @p y coordinates are relative to parent.
14145     */
14146    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14147    /**
14148     * @brief Close a opened menu
14149     *
14150     * @param obj the menu object
14151     * @return void
14152     *
14153     * Hides the menu and all it's sub-menus.
14154     */
14155    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14156    /**
14157     * @brief Returns a list of @p item's items.
14158     *
14159     * @param obj The menu object
14160     * @return An Eina_List* of @p item's items
14161     */
14162    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14163    /**
14164     * @brief Get the Evas_Object of an Elm_Menu_Item
14165     *
14166     * @param item The menu item object.
14167     * @return The edje object containing the swallowed content
14168     *
14169     * @warning Don't manipulate this object!
14170     */
14171    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14172    /**
14173     * @brief Add an item at the end of the given menu widget
14174     *
14175     * @param obj The menu object.
14176     * @param parent The parent menu item (optional)
14177     * @param icon A icon display on the item. The icon will be destryed by the menu.
14178     * @param label The label of the item.
14179     * @param func Function called when the user select the item.
14180     * @param data Data sent by the callback.
14181     * @return Returns the new item.
14182     */
14183    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);
14184    /**
14185     * @brief Add an object swallowed in an item at the end of the given menu
14186     * widget
14187     *
14188     * @param obj The menu object.
14189     * @param parent The parent menu item (optional)
14190     * @param subobj The object to swallow
14191     * @param func Function called when the user select the item.
14192     * @param data Data sent by the callback.
14193     * @return Returns the new item.
14194     *
14195     * Add an evas object as an item to the menu.
14196     */
14197    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);
14198    /**
14199     * @brief Set the label of a menu item
14200     *
14201     * @param item The menu item object.
14202     * @param label The label to set for @p item
14203     *
14204     * @warning Don't use this funcion on items created with
14205     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14206     */
14207    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14208    /**
14209     * @brief Get the label of a menu item
14210     *
14211     * @param item The menu item object.
14212     * @return The label of @p item
14213     */
14214    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14215    /**
14216     * @brief Set the icon of a menu item to the standard icon with name @p icon
14217     *
14218     * @param item The menu item object.
14219     * @param icon The icon object to set for the content of @p item
14220     *
14221     * Once this icon is set, any previously set icon will be deleted.
14222     */
14223    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14224    /**
14225     * @brief Get the string representation from the icon of a menu item
14226     *
14227     * @param item The menu item object.
14228     * @return The string representation of @p item's icon or NULL
14229     *
14230     * @see elm_menu_item_object_icon_name_set()
14231     */
14232    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14233    /**
14234     * @brief Set the content object of a menu item
14235     *
14236     * @param item The menu item object
14237     * @param The content object or NULL
14238     * @return EINA_TRUE on success, else EINA_FALSE
14239     *
14240     * Use this function to change the object swallowed by a menu item, deleting
14241     * any previously swallowed object.
14242     */
14243    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14244    /**
14245     * @brief Get the content object of a menu item
14246     *
14247     * @param item The menu item object
14248     * @return The content object or NULL
14249     * @note If @p item was added with elm_menu_item_add_object, this
14250     * function will return the object passed, else it will return the
14251     * icon object.
14252     *
14253     * @see elm_menu_item_object_content_set()
14254     */
14255    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14256    /**
14257     * @brief Set the selected state of @p item.
14258     *
14259     * @param item The menu item object.
14260     * @param selected The selected/unselected state of the item
14261     */
14262    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14263    /**
14264     * @brief Get the selected state of @p item.
14265     *
14266     * @param item The menu item object.
14267     * @return The selected/unselected state of the item
14268     *
14269     * @see elm_menu_item_selected_set()
14270     */
14271    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14272    /**
14273     * @brief Set the disabled state of @p item.
14274     *
14275     * @param item The menu item object.
14276     * @param disabled The enabled/disabled state of the item
14277     */
14278    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14279    /**
14280     * @brief Get the disabled state of @p item.
14281     *
14282     * @param item The menu item object.
14283     * @return The enabled/disabled state of the item
14284     *
14285     * @see elm_menu_item_disabled_set()
14286     */
14287    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14288    /**
14289     * @brief Add a separator item to menu @p obj under @p parent.
14290     *
14291     * @param obj The menu object
14292     * @param parent The item to add the separator under
14293     * @return The created item or NULL on failure
14294     *
14295     * This is item is a @ref Separator.
14296     */
14297    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14298    /**
14299     * @brief Returns whether @p item is a separator.
14300     *
14301     * @param item The item to check
14302     * @return If true, @p item is a separator
14303     *
14304     * @see elm_menu_item_separator_add()
14305     */
14306    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14307    /**
14308     * @brief Deletes an item from the menu.
14309     *
14310     * @param item The item to delete.
14311     *
14312     * @see elm_menu_item_add()
14313     */
14314    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14315    /**
14316     * @brief Set the function called when a menu item is deleted.
14317     *
14318     * @param item The item to set the callback on
14319     * @param func The function called
14320     *
14321     * @see elm_menu_item_add()
14322     * @see elm_menu_item_del()
14323     */
14324    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14325    /**
14326     * @brief Returns the data associated with menu item @p item.
14327     *
14328     * @param item The item
14329     * @return The data associated with @p item or NULL if none was set.
14330     *
14331     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14332     */
14333    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14334    /**
14335     * @brief Sets the data to be associated with menu item @p item.
14336     *
14337     * @param item The item
14338     * @param data The data to be associated with @p item
14339     */
14340    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14341    /**
14342     * @brief Returns a list of @p item's subitems.
14343     *
14344     * @param item The item
14345     * @return An Eina_List* of @p item's subitems
14346     *
14347     * @see elm_menu_add()
14348     */
14349    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14350    /**
14351     * @brief Get the position of a menu item
14352     *
14353     * @param item The menu item
14354     * @return The item's index
14355     *
14356     * This function returns the index position of a menu item in a menu.
14357     * For a sub-menu, this number is relative to the first item in the sub-menu.
14358     *
14359     * @note Index values begin with 0
14360     */
14361    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14362    /**
14363     * @brief @brief Return a menu item's owner menu
14364     *
14365     * @param item The menu item
14366     * @return The menu object owning @p item, or NULL on failure
14367     *
14368     * Use this function to get the menu object owning an item.
14369     */
14370    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14371    /**
14372     * @brief Get the selected item in the menu
14373     *
14374     * @param obj The menu object
14375     * @return The selected item, or NULL if none
14376     *
14377     * @see elm_menu_item_selected_get()
14378     * @see elm_menu_item_selected_set()
14379     */
14380    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14381    /**
14382     * @brief Get the last item in the menu
14383     *
14384     * @param obj The menu object
14385     * @return The last item, or NULL if none
14386     */
14387    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14388    /**
14389     * @brief Get the first item in the menu
14390     *
14391     * @param obj The menu object
14392     * @return The first item, or NULL if none
14393     */
14394    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14395    /**
14396     * @brief Get the next item in the menu.
14397     *
14398     * @param item The menu item object.
14399     * @return The item after it, or NULL if none
14400     */
14401    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14402    /**
14403     * @brief Get the previous item in the menu.
14404     *
14405     * @param item The menu item object.
14406     * @return The item before it, or NULL if none
14407     */
14408    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14409    /**
14410     * @}
14411     */
14412
14413    /**
14414     * @defgroup List List
14415     * @ingroup Elementary
14416     *
14417     * @image html img/widget/list/preview-00.png
14418     * @image latex img/widget/list/preview-00.eps width=\textwidth
14419     *
14420     * @image html img/list.png
14421     * @image latex img/list.eps width=\textwidth
14422     *
14423     * A list widget is a container whose children are displayed vertically or
14424     * horizontally, in order, and can be selected.
14425     * The list can accept only one or multiple items selection. Also has many
14426     * modes of items displaying.
14427     *
14428     * A list is a very simple type of list widget.  For more robust
14429     * lists, @ref Genlist should probably be used.
14430     *
14431     * Smart callbacks one can listen to:
14432     * - @c "activated" - The user has double-clicked or pressed
14433     *   (enter|return|spacebar) on an item. The @c event_info parameter
14434     *   is the item that was activated.
14435     * - @c "clicked,double" - The user has double-clicked an item.
14436     *   The @c event_info parameter is the item that was double-clicked.
14437     * - "selected" - when the user selected an item
14438     * - "unselected" - when the user unselected an item
14439     * - "longpressed" - an item in the list is long-pressed
14440     * - "scroll,edge,top" - the list is scrolled until the top edge
14441     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14442     * - "scroll,edge,left" - the list is scrolled until the left edge
14443     * - "scroll,edge,right" - the list is scrolled until the right edge
14444     *
14445     * Available styles for it:
14446     * - @c "default"
14447     *
14448     * List of examples:
14449     * @li @ref list_example_01
14450     * @li @ref list_example_02
14451     * @li @ref list_example_03
14452     */
14453
14454    /**
14455     * @addtogroup List
14456     * @{
14457     */
14458
14459    /**
14460     * @enum _Elm_List_Mode
14461     * @typedef Elm_List_Mode
14462     *
14463     * Set list's resize behavior, transverse axis scroll and
14464     * items cropping. See each mode's description for more details.
14465     *
14466     * @note Default value is #ELM_LIST_SCROLL.
14467     *
14468     * Values <b> don't </b> work as bitmask, only one can be choosen.
14469     *
14470     * @see elm_list_mode_set()
14471     * @see elm_list_mode_get()
14472     *
14473     * @ingroup List
14474     */
14475    typedef enum _Elm_List_Mode
14476      {
14477         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. */
14478         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). */
14479         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. */
14480         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. */
14481         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14482      } Elm_List_Mode;
14483
14484    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().  */
14485
14486    /**
14487     * Add a new list widget to the given parent Elementary
14488     * (container) object.
14489     *
14490     * @param parent The parent object.
14491     * @return a new list widget handle or @c NULL, on errors.
14492     *
14493     * This function inserts a new list widget on the canvas.
14494     *
14495     * @ingroup List
14496     */
14497    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14498
14499    /**
14500     * Starts the list.
14501     *
14502     * @param obj The list object
14503     *
14504     * @note Call before running show() on the list object.
14505     * @warning If not called, it won't display the list properly.
14506     *
14507     * @code
14508     * li = elm_list_add(win);
14509     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14510     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14511     * elm_list_go(li);
14512     * evas_object_show(li);
14513     * @endcode
14514     *
14515     * @ingroup List
14516     */
14517    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14518
14519    /**
14520     * Enable or disable multiple items selection on the list object.
14521     *
14522     * @param obj The list object
14523     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14524     * disable it.
14525     *
14526     * Disabled by default. If disabled, the user can select a single item of
14527     * the list each time. Selected items are highlighted on list.
14528     * If enabled, many items can be selected.
14529     *
14530     * If a selected item is selected again, it will be unselected.
14531     *
14532     * @see elm_list_multi_select_get()
14533     *
14534     * @ingroup List
14535     */
14536    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14537
14538    /**
14539     * Get a value whether multiple items selection is enabled or not.
14540     *
14541     * @see elm_list_multi_select_set() for details.
14542     *
14543     * @param obj The list object.
14544     * @return @c EINA_TRUE means multiple items selection is enabled.
14545     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14546     * @c EINA_FALSE is returned.
14547     *
14548     * @ingroup List
14549     */
14550    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14551
14552    /**
14553     * Set which mode to use for the list object.
14554     *
14555     * @param obj The list object
14556     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14557     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14558     *
14559     * Set list's resize behavior, transverse axis scroll and
14560     * items cropping. See each mode's description for more details.
14561     *
14562     * @note Default value is #ELM_LIST_SCROLL.
14563     *
14564     * Only one can be set, if a previous one was set, it will be changed
14565     * by the new mode set. Bitmask won't work as well.
14566     *
14567     * @see elm_list_mode_get()
14568     *
14569     * @ingroup List
14570     */
14571    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14572
14573    /**
14574     * Get the mode the list is at.
14575     *
14576     * @param obj The list object
14577     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14578     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14579     *
14580     * @note see elm_list_mode_set() for more information.
14581     *
14582     * @ingroup List
14583     */
14584    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14585
14586    /**
14587     * Enable or disable horizontal mode on the list object.
14588     *
14589     * @param obj The list object.
14590     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14591     * disable it, i.e., to enable vertical mode.
14592     *
14593     * @note Vertical mode is set by default.
14594     *
14595     * On horizontal mode items are displayed on list from left to right,
14596     * instead of from top to bottom. Also, the list will scroll horizontally.
14597     * Each item will presents left icon on top and right icon, or end, at
14598     * the bottom.
14599     *
14600     * @see elm_list_horizontal_get()
14601     *
14602     * @ingroup List
14603     */
14604    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14605
14606    /**
14607     * Get a value whether horizontal mode is enabled or not.
14608     *
14609     * @param obj The list object.
14610     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14611     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14612     * @c EINA_FALSE is returned.
14613     *
14614     * @see elm_list_horizontal_set() for details.
14615     *
14616     * @ingroup List
14617     */
14618    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14619
14620    /**
14621     * Enable or disable always select mode on the list object.
14622     *
14623     * @param obj The list object
14624     * @param always_select @c EINA_TRUE to enable always select mode or
14625     * @c EINA_FALSE to disable it.
14626     *
14627     * @note Always select mode is disabled by default.
14628     *
14629     * Default behavior of list items is to only call its callback function
14630     * the first time it's pressed, i.e., when it is selected. If a selected
14631     * item is pressed again, and multi-select is disabled, it won't call
14632     * this function (if multi-select is enabled it will unselect the item).
14633     *
14634     * If always select is enabled, it will call the callback function
14635     * everytime a item is pressed, so it will call when the item is selected,
14636     * and again when a selected item is pressed.
14637     *
14638     * @see elm_list_always_select_mode_get()
14639     * @see elm_list_multi_select_set()
14640     *
14641     * @ingroup List
14642     */
14643    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14644
14645    /**
14646     * Get a value whether always select mode is enabled or not, meaning that
14647     * an item will always call its callback function, even if already selected.
14648     *
14649     * @param obj The list object
14650     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14651     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14652     * @c EINA_FALSE is returned.
14653     *
14654     * @see elm_list_always_select_mode_set() for details.
14655     *
14656     * @ingroup List
14657     */
14658    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14659
14660    /**
14661     * Set bouncing behaviour when the scrolled content reaches an edge.
14662     *
14663     * Tell the internal scroller object whether it should bounce or not
14664     * when it reaches the respective edges for each axis.
14665     *
14666     * @param obj The list object
14667     * @param h_bounce Whether to bounce or not in the horizontal axis.
14668     * @param v_bounce Whether to bounce or not in the vertical axis.
14669     *
14670     * @see elm_scroller_bounce_set()
14671     *
14672     * @ingroup List
14673     */
14674    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14675
14676    /**
14677     * Get the bouncing behaviour of the internal scroller.
14678     *
14679     * Get whether the internal scroller should bounce when the edge of each
14680     * axis is reached scrolling.
14681     *
14682     * @param obj The list object.
14683     * @param h_bounce Pointer where to store the bounce state of the horizontal
14684     * axis.
14685     * @param v_bounce Pointer where to store the bounce state of the vertical
14686     * axis.
14687     *
14688     * @see elm_scroller_bounce_get()
14689     * @see elm_list_bounce_set()
14690     *
14691     * @ingroup List
14692     */
14693    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14694
14695    /**
14696     * Set the scrollbar policy.
14697     *
14698     * @param obj The list object
14699     * @param policy_h Horizontal scrollbar policy.
14700     * @param policy_v Vertical scrollbar policy.
14701     *
14702     * This sets the scrollbar visibility policy for the given scroller.
14703     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14704     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14705     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14706     * This applies respectively for the horizontal and vertical scrollbars.
14707     *
14708     * The both are disabled by default, i.e., are set to
14709     * #ELM_SCROLLER_POLICY_OFF.
14710     *
14711     * @ingroup List
14712     */
14713    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14714
14715    /**
14716     * Get the scrollbar policy.
14717     *
14718     * @see elm_list_scroller_policy_get() for details.
14719     *
14720     * @param obj The list object.
14721     * @param policy_h Pointer where to store horizontal scrollbar policy.
14722     * @param policy_v Pointer where to store vertical scrollbar policy.
14723     *
14724     * @ingroup List
14725     */
14726    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);
14727
14728    /**
14729     * Append a new item to the list object.
14730     *
14731     * @param obj The list object.
14732     * @param label The label of the list item.
14733     * @param icon The icon object to use for the left side of the item. An
14734     * icon can be any Evas object, but usually it is an icon created
14735     * with elm_icon_add().
14736     * @param end The icon object to use for the right side of the item. An
14737     * icon can be any Evas object.
14738     * @param func The function to call when the item is clicked.
14739     * @param data The data to associate with the item for related callbacks.
14740     *
14741     * @return The created item or @c NULL upon failure.
14742     *
14743     * A new item will be created and appended to the list, i.e., will
14744     * be set as @b last item.
14745     *
14746     * Items created with this method can be deleted with
14747     * elm_list_item_del().
14748     *
14749     * Associated @p data can be properly freed when item is deleted if a
14750     * callback function is set with elm_list_item_del_cb_set().
14751     *
14752     * If a function is passed as argument, it will be called everytime this item
14753     * is selected, i.e., the user clicks over an unselected item.
14754     * If always select is enabled it will call this function every time
14755     * user clicks over an item (already selected or not).
14756     * If such function isn't needed, just passing
14757     * @c NULL as @p func is enough. The same should be done for @p data.
14758     *
14759     * Simple example (with no function callback or data associated):
14760     * @code
14761     * li = elm_list_add(win);
14762     * ic = elm_icon_add(win);
14763     * elm_icon_file_set(ic, "path/to/image", NULL);
14764     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14765     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14766     * elm_list_go(li);
14767     * evas_object_show(li);
14768     * @endcode
14769     *
14770     * @see elm_list_always_select_mode_set()
14771     * @see elm_list_item_del()
14772     * @see elm_list_item_del_cb_set()
14773     * @see elm_list_clear()
14774     * @see elm_icon_add()
14775     *
14776     * @ingroup List
14777     */
14778    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);
14779
14780    /**
14781     * Prepend a new item to the list object.
14782     *
14783     * @param obj The list object.
14784     * @param label The label of the list item.
14785     * @param icon The icon object to use for the left side of the item. An
14786     * icon can be any Evas object, but usually it is an icon created
14787     * with elm_icon_add().
14788     * @param end The icon object to use for the right side of the item. An
14789     * icon can be any Evas object.
14790     * @param func The function to call when the item is clicked.
14791     * @param data The data to associate with the item for related callbacks.
14792     *
14793     * @return The created item or @c NULL upon failure.
14794     *
14795     * A new item will be created and prepended to the list, i.e., will
14796     * be set as @b first item.
14797     *
14798     * Items created with this method can be deleted with
14799     * elm_list_item_del().
14800     *
14801     * Associated @p data can be properly freed when item is deleted if a
14802     * callback function is set with elm_list_item_del_cb_set().
14803     *
14804     * If a function is passed as argument, it will be called everytime this item
14805     * is selected, i.e., the user clicks over an unselected item.
14806     * If always select is enabled it will call this function every time
14807     * user clicks over an item (already selected or not).
14808     * If such function isn't needed, just passing
14809     * @c NULL as @p func is enough. The same should be done for @p data.
14810     *
14811     * @see elm_list_item_append() for a simple code example.
14812     * @see elm_list_always_select_mode_set()
14813     * @see elm_list_item_del()
14814     * @see elm_list_item_del_cb_set()
14815     * @see elm_list_clear()
14816     * @see elm_icon_add()
14817     *
14818     * @ingroup List
14819     */
14820    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);
14821
14822    /**
14823     * Insert a new item into the list object before item @p before.
14824     *
14825     * @param obj The list object.
14826     * @param before The list item to insert before.
14827     * @param label The label of the list item.
14828     * @param icon The icon object to use for the left side of the item. An
14829     * icon can be any Evas object, but usually it is an icon created
14830     * with elm_icon_add().
14831     * @param end The icon object to use for the right side of the item. An
14832     * icon can be any Evas object.
14833     * @param func The function to call when the item is clicked.
14834     * @param data The data to associate with the item for related callbacks.
14835     *
14836     * @return The created item or @c NULL upon failure.
14837     *
14838     * A new item will be created and added to the list. Its position in
14839     * this list will be just before item @p before.
14840     *
14841     * Items created with this method can be deleted with
14842     * elm_list_item_del().
14843     *
14844     * Associated @p data can be properly freed when item is deleted if a
14845     * callback function is set with elm_list_item_del_cb_set().
14846     *
14847     * If a function is passed as argument, it will be called everytime this item
14848     * is selected, i.e., the user clicks over an unselected item.
14849     * If always select is enabled it will call this function every time
14850     * user clicks over an item (already selected or not).
14851     * If such function isn't needed, just passing
14852     * @c NULL as @p func is enough. The same should be done for @p data.
14853     *
14854     * @see elm_list_item_append() for a simple code example.
14855     * @see elm_list_always_select_mode_set()
14856     * @see elm_list_item_del()
14857     * @see elm_list_item_del_cb_set()
14858     * @see elm_list_clear()
14859     * @see elm_icon_add()
14860     *
14861     * @ingroup List
14862     */
14863    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);
14864
14865    /**
14866     * Insert a new item into the list object after item @p after.
14867     *
14868     * @param obj The list object.
14869     * @param after The list item to insert after.
14870     * @param label The label of the list item.
14871     * @param icon The icon object to use for the left side of the item. An
14872     * icon can be any Evas object, but usually it is an icon created
14873     * with elm_icon_add().
14874     * @param end The icon object to use for the right side of the item. An
14875     * icon can be any Evas object.
14876     * @param func The function to call when the item is clicked.
14877     * @param data The data to associate with the item for related callbacks.
14878     *
14879     * @return The created item or @c NULL upon failure.
14880     *
14881     * A new item will be created and added to the list. Its position in
14882     * this list will be just after item @p after.
14883     *
14884     * Items created with this method can be deleted with
14885     * elm_list_item_del().
14886     *
14887     * Associated @p data can be properly freed when item is deleted if a
14888     * callback function is set with elm_list_item_del_cb_set().
14889     *
14890     * If a function is passed as argument, it will be called everytime this item
14891     * is selected, i.e., the user clicks over an unselected item.
14892     * If always select is enabled it will call this function every time
14893     * user clicks over an item (already selected or not).
14894     * If such function isn't needed, just passing
14895     * @c NULL as @p func is enough. The same should be done for @p data.
14896     *
14897     * @see elm_list_item_append() for a simple code example.
14898     * @see elm_list_always_select_mode_set()
14899     * @see elm_list_item_del()
14900     * @see elm_list_item_del_cb_set()
14901     * @see elm_list_clear()
14902     * @see elm_icon_add()
14903     *
14904     * @ingroup List
14905     */
14906    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);
14907
14908    /**
14909     * Insert a new item into the sorted list object.
14910     *
14911     * @param obj The list object.
14912     * @param label The label of the list item.
14913     * @param icon The icon object to use for the left side of the item. An
14914     * icon can be any Evas object, but usually it is an icon created
14915     * with elm_icon_add().
14916     * @param end The icon object to use for the right side of the item. An
14917     * icon can be any Evas object.
14918     * @param func The function to call when the item is clicked.
14919     * @param data The data to associate with the item for related callbacks.
14920     * @param cmp_func The comparing function to be used to sort list
14921     * items <b>by #Elm_List_Item item handles</b>. This function will
14922     * receive two items and compare them, returning a non-negative integer
14923     * if the second item should be place after the first, or negative value
14924     * if should be placed before.
14925     *
14926     * @return The created item or @c NULL upon failure.
14927     *
14928     * @note This function inserts values into a list object assuming it was
14929     * sorted and the result will be sorted.
14930     *
14931     * A new item will be created and added to the list. Its position in
14932     * this list will be found comparing the new item with previously inserted
14933     * items using function @p cmp_func.
14934     *
14935     * Items created with this method can be deleted with
14936     * elm_list_item_del().
14937     *
14938     * Associated @p data can be properly freed when item is deleted if a
14939     * callback function is set with elm_list_item_del_cb_set().
14940     *
14941     * If a function is passed as argument, it will be called everytime this item
14942     * is selected, i.e., the user clicks over an unselected item.
14943     * If always select is enabled it will call this function every time
14944     * user clicks over an item (already selected or not).
14945     * If such function isn't needed, just passing
14946     * @c NULL as @p func is enough. The same should be done for @p data.
14947     *
14948     * @see elm_list_item_append() for a simple code example.
14949     * @see elm_list_always_select_mode_set()
14950     * @see elm_list_item_del()
14951     * @see elm_list_item_del_cb_set()
14952     * @see elm_list_clear()
14953     * @see elm_icon_add()
14954     *
14955     * @ingroup List
14956     */
14957    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);
14958
14959    /**
14960     * Remove all list's items.
14961     *
14962     * @param obj The list object
14963     *
14964     * @see elm_list_item_del()
14965     * @see elm_list_item_append()
14966     *
14967     * @ingroup List
14968     */
14969    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14970
14971    /**
14972     * Get a list of all the list items.
14973     *
14974     * @param obj The list object
14975     * @return An @c Eina_List of list items, #Elm_List_Item,
14976     * or @c NULL on failure.
14977     *
14978     * @see elm_list_item_append()
14979     * @see elm_list_item_del()
14980     * @see elm_list_clear()
14981     *
14982     * @ingroup List
14983     */
14984    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14985
14986    /**
14987     * Get the selected item.
14988     *
14989     * @param obj The list object.
14990     * @return The selected list item.
14991     *
14992     * The selected item can be unselected with function
14993     * elm_list_item_selected_set().
14994     *
14995     * The selected item always will be highlighted on list.
14996     *
14997     * @see elm_list_selected_items_get()
14998     *
14999     * @ingroup List
15000     */
15001    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15002
15003    /**
15004     * Return a list of the currently selected list items.
15005     *
15006     * @param obj The list object.
15007     * @return An @c Eina_List of list items, #Elm_List_Item,
15008     * or @c NULL on failure.
15009     *
15010     * Multiple items can be selected if multi select is enabled. It can be
15011     * done with elm_list_multi_select_set().
15012     *
15013     * @see elm_list_selected_item_get()
15014     * @see elm_list_multi_select_set()
15015     *
15016     * @ingroup List
15017     */
15018    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15019
15020    /**
15021     * Set the selected state of an item.
15022     *
15023     * @param item The list item
15024     * @param selected The selected state
15025     *
15026     * This sets the selected state of the given item @p it.
15027     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15028     *
15029     * If a new item is selected the previosly selected will be unselected,
15030     * unless multiple selection is enabled with elm_list_multi_select_set().
15031     * Previoulsy selected item can be get with function
15032     * elm_list_selected_item_get().
15033     *
15034     * Selected items will be highlighted.
15035     *
15036     * @see elm_list_item_selected_get()
15037     * @see elm_list_selected_item_get()
15038     * @see elm_list_multi_select_set()
15039     *
15040     * @ingroup List
15041     */
15042    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15043
15044    /*
15045     * Get whether the @p item is selected or not.
15046     *
15047     * @param item The list item.
15048     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15049     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15050     *
15051     * @see elm_list_selected_item_set() for details.
15052     * @see elm_list_item_selected_get()
15053     *
15054     * @ingroup List
15055     */
15056    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15057
15058    /**
15059     * Set or unset item as a separator.
15060     *
15061     * @param it The list item.
15062     * @param setting @c EINA_TRUE to set item @p it as separator or
15063     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15064     *
15065     * Items aren't set as separator by default.
15066     *
15067     * If set as separator it will display separator theme, so won't display
15068     * icons or label.
15069     *
15070     * @see elm_list_item_separator_get()
15071     *
15072     * @ingroup List
15073     */
15074    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15075
15076    /**
15077     * Get a value whether item is a separator or not.
15078     *
15079     * @see elm_list_item_separator_set() for details.
15080     *
15081     * @param it The list item.
15082     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15083     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15084     *
15085     * @ingroup List
15086     */
15087    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15088
15089    /**
15090     * Show @p item in the list view.
15091     *
15092     * @param item The list item to be shown.
15093     *
15094     * It won't animate list until item is visible. If such behavior is wanted,
15095     * use elm_list_bring_in() intead.
15096     *
15097     * @ingroup List
15098     */
15099    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15100
15101    /**
15102     * Bring in the given item to list view.
15103     *
15104     * @param item The item.
15105     *
15106     * This causes list to jump to the given item @p item and show it
15107     * (by scrolling), if it is not fully visible.
15108     *
15109     * This may use animation to do so and take a period of time.
15110     *
15111     * If animation isn't wanted, elm_list_item_show() can be used.
15112     *
15113     * @ingroup List
15114     */
15115    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15116
15117    /**
15118     * Delete them item from the list.
15119     *
15120     * @param item The item of list to be deleted.
15121     *
15122     * If deleting all list items is required, elm_list_clear()
15123     * should be used instead of getting items list and deleting each one.
15124     *
15125     * @see elm_list_clear()
15126     * @see elm_list_item_append()
15127     * @see elm_list_item_del_cb_set()
15128     *
15129     * @ingroup List
15130     */
15131    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15132
15133    /**
15134     * Set the function called when a list item is freed.
15135     *
15136     * @param item The item to set the callback on
15137     * @param func The function called
15138     *
15139     * If there is a @p func, then it will be called prior item's memory release.
15140     * That will be called with the following arguments:
15141     * @li item's data;
15142     * @li item's Evas object;
15143     * @li item itself;
15144     *
15145     * This way, a data associated to a list item could be properly freed.
15146     *
15147     * @ingroup List
15148     */
15149    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15150
15151    /**
15152     * Get the data associated to the item.
15153     *
15154     * @param item The list item
15155     * @return The data associated to @p item
15156     *
15157     * The return value is a pointer to data associated to @p item when it was
15158     * created, with function elm_list_item_append() or similar. If no data
15159     * was passed as argument, it will return @c NULL.
15160     *
15161     * @see elm_list_item_append()
15162     *
15163     * @ingroup List
15164     */
15165    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15166
15167    /**
15168     * Get the left side icon associated to the item.
15169     *
15170     * @param item The list item
15171     * @return The left side icon associated to @p item
15172     *
15173     * The return value is a pointer to the icon associated to @p item when
15174     * it was
15175     * created, with function elm_list_item_append() or similar, or later
15176     * with function elm_list_item_icon_set(). If no icon
15177     * was passed as argument, it will return @c NULL.
15178     *
15179     * @see elm_list_item_append()
15180     * @see elm_list_item_icon_set()
15181     *
15182     * @ingroup List
15183     */
15184    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15185
15186    /**
15187     * Set the left side icon associated to the item.
15188     *
15189     * @param item The list item
15190     * @param icon The left side icon object to associate with @p item
15191     *
15192     * The icon object to use at left side of the item. An
15193     * icon can be any Evas object, but usually it is an icon created
15194     * with elm_icon_add().
15195     *
15196     * Once the icon object is set, a previously set one will be deleted.
15197     * @warning Setting the same icon for two items will cause the icon to
15198     * dissapear from the first item.
15199     *
15200     * If an icon was passed as argument on item creation, with function
15201     * elm_list_item_append() or similar, it will be already
15202     * associated to the item.
15203     *
15204     * @see elm_list_item_append()
15205     * @see elm_list_item_icon_get()
15206     *
15207     * @ingroup List
15208     */
15209    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15210
15211    /**
15212     * Get the right side icon associated to the item.
15213     *
15214     * @param item The list item
15215     * @return The right side icon associated to @p item
15216     *
15217     * The return value is a pointer to the icon associated to @p item when
15218     * it was
15219     * created, with function elm_list_item_append() or similar, or later
15220     * with function elm_list_item_icon_set(). If no icon
15221     * was passed as argument, it will return @c NULL.
15222     *
15223     * @see elm_list_item_append()
15224     * @see elm_list_item_icon_set()
15225     *
15226     * @ingroup List
15227     */
15228    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15229
15230    /**
15231     * Set the right side icon associated to the item.
15232     *
15233     * @param item The list item
15234     * @param end The right side icon object to associate with @p item
15235     *
15236     * The icon object to use at right side of the item. An
15237     * icon can be any Evas object, but usually it is an icon created
15238     * with elm_icon_add().
15239     *
15240     * Once the icon object is set, a previously set one will be deleted.
15241     * @warning Setting the same icon for two items will cause the icon to
15242     * dissapear from the first item.
15243     *
15244     * If an icon was passed as argument on item creation, with function
15245     * elm_list_item_append() or similar, it will be already
15246     * associated to the item.
15247     *
15248     * @see elm_list_item_append()
15249     * @see elm_list_item_end_get()
15250     *
15251     * @ingroup List
15252     */
15253    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15254
15255    /**
15256     * Gets the base object of the item.
15257     *
15258     * @param item The list item
15259     * @return The base object associated with @p item
15260     *
15261     * Base object is the @c Evas_Object that represents that item.
15262     *
15263     * @ingroup List
15264     */
15265    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15266
15267    /**
15268     * Get the label of item.
15269     *
15270     * @param item The item of list.
15271     * @return The label of item.
15272     *
15273     * The return value is a pointer to the label associated to @p item when
15274     * it was created, with function elm_list_item_append(), or later
15275     * with function elm_list_item_label_set. If no label
15276     * was passed as argument, it will return @c NULL.
15277     *
15278     * @see elm_list_item_label_set() for more details.
15279     * @see elm_list_item_append()
15280     *
15281     * @ingroup List
15282     */
15283    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15284
15285    /**
15286     * Set the label of item.
15287     *
15288     * @param item The item of list.
15289     * @param text The label of item.
15290     *
15291     * The label to be displayed by the item.
15292     * Label will be placed between left and right side icons (if set).
15293     *
15294     * If a label was passed as argument on item creation, with function
15295     * elm_list_item_append() or similar, it will be already
15296     * displayed by the item.
15297     *
15298     * @see elm_list_item_label_get()
15299     * @see elm_list_item_append()
15300     *
15301     * @ingroup List
15302     */
15303    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15304
15305
15306    /**
15307     * Get the item before @p it in list.
15308     *
15309     * @param it The list item.
15310     * @return The item before @p it, or @c NULL if none or on failure.
15311     *
15312     * @note If it is the first item, @c NULL will be returned.
15313     *
15314     * @see elm_list_item_append()
15315     * @see elm_list_items_get()
15316     *
15317     * @ingroup List
15318     */
15319    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15320
15321    /**
15322     * Get the item after @p it in list.
15323     *
15324     * @param it The list item.
15325     * @return The item after @p it, or @c NULL if none or on failure.
15326     *
15327     * @note If it is the last item, @c NULL will be returned.
15328     *
15329     * @see elm_list_item_append()
15330     * @see elm_list_items_get()
15331     *
15332     * @ingroup List
15333     */
15334    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15335
15336    /**
15337     * Sets the disabled/enabled state of a list item.
15338     *
15339     * @param it The item.
15340     * @param disabled The disabled state.
15341     *
15342     * A disabled item cannot be selected or unselected. It will also
15343     * change its appearance (generally greyed out). This sets the
15344     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15345     * enabled).
15346     *
15347     * @ingroup List
15348     */
15349    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15350
15351    /**
15352     * Get a value whether list item is disabled or not.
15353     *
15354     * @param it The item.
15355     * @return The disabled state.
15356     *
15357     * @see elm_list_item_disabled_set() for more details.
15358     *
15359     * @ingroup List
15360     */
15361    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15362
15363    /**
15364     * Set the text to be shown in a given list item's tooltips.
15365     *
15366     * @param item Target item.
15367     * @param text The text to set in the content.
15368     *
15369     * Setup the text as tooltip to object. The item can have only one tooltip,
15370     * so any previous tooltip data - set with this function or
15371     * elm_list_item_tooltip_content_cb_set() - is removed.
15372     *
15373     * @see elm_object_tooltip_text_set() for more details.
15374     *
15375     * @ingroup List
15376     */
15377    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15378
15379
15380    /**
15381     * @brief Disable size restrictions on an object's tooltip
15382     * @param item The tooltip's anchor object
15383     * @param disable If EINA_TRUE, size restrictions are disabled
15384     * @return EINA_FALSE on failure, EINA_TRUE on success
15385     *
15386     * This function allows a tooltip to expand beyond its parant window's canvas.
15387     * It will instead be limited only by the size of the display.
15388     */
15389    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15390    /**
15391     * @brief Retrieve size restriction state of an object's tooltip
15392     * @param obj The tooltip's anchor object
15393     * @return If EINA_TRUE, size restrictions are disabled
15394     *
15395     * This function returns whether a tooltip is allowed to expand beyond
15396     * its parant window's canvas.
15397     * It will instead be limited only by the size of the display.
15398     */
15399    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15400
15401    /**
15402     * Set the content to be shown in the tooltip item.
15403     *
15404     * Setup the tooltip to item. The item can have only one tooltip,
15405     * so any previous tooltip data is removed. @p func(with @p data) will
15406     * be called every time that need show the tooltip and it should
15407     * return a valid Evas_Object. This object is then managed fully by
15408     * tooltip system and is deleted when the tooltip is gone.
15409     *
15410     * @param item the list item being attached a tooltip.
15411     * @param func the function used to create the tooltip contents.
15412     * @param data what to provide to @a func as callback data/context.
15413     * @param del_cb called when data is not needed anymore, either when
15414     *        another callback replaces @a func, the tooltip is unset with
15415     *        elm_list_item_tooltip_unset() or the owner @a item
15416     *        dies. This callback receives as the first parameter the
15417     *        given @a data, and @c event_info is the item.
15418     *
15419     * @see elm_object_tooltip_content_cb_set() for more details.
15420     *
15421     * @ingroup List
15422     */
15423    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);
15424
15425    /**
15426     * Unset tooltip from item.
15427     *
15428     * @param item list item to remove previously set tooltip.
15429     *
15430     * Remove tooltip from item. The callback provided as del_cb to
15431     * elm_list_item_tooltip_content_cb_set() will be called to notify
15432     * it is not used anymore.
15433     *
15434     * @see elm_object_tooltip_unset() for more details.
15435     * @see elm_list_item_tooltip_content_cb_set()
15436     *
15437     * @ingroup List
15438     */
15439    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15440
15441    /**
15442     * Sets a different style for this item tooltip.
15443     *
15444     * @note before you set a style you should define a tooltip with
15445     *       elm_list_item_tooltip_content_cb_set() or
15446     *       elm_list_item_tooltip_text_set()
15447     *
15448     * @param item list item with tooltip already set.
15449     * @param style the theme style to use (default, transparent, ...)
15450     *
15451     * @see elm_object_tooltip_style_set() for more details.
15452     *
15453     * @ingroup List
15454     */
15455    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15456
15457    /**
15458     * Get the style for this item tooltip.
15459     *
15460     * @param item list item with tooltip already set.
15461     * @return style the theme style in use, defaults to "default". If the
15462     *         object does not have a tooltip set, then NULL is returned.
15463     *
15464     * @see elm_object_tooltip_style_get() for more details.
15465     * @see elm_list_item_tooltip_style_set()
15466     *
15467     * @ingroup List
15468     */
15469    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15470
15471    /**
15472     * Set the type of mouse pointer/cursor decoration to be shown,
15473     * when the mouse pointer is over the given list widget item
15474     *
15475     * @param item list item to customize cursor on
15476     * @param cursor the cursor type's name
15477     *
15478     * This function works analogously as elm_object_cursor_set(), but
15479     * here the cursor's changing area is restricted to the item's
15480     * area, and not the whole widget's. Note that that item cursors
15481     * have precedence over widget cursors, so that a mouse over an
15482     * item with custom cursor set will always show @b that cursor.
15483     *
15484     * If this function is called twice for an object, a previously set
15485     * cursor will be unset on the second call.
15486     *
15487     * @see elm_object_cursor_set()
15488     * @see elm_list_item_cursor_get()
15489     * @see elm_list_item_cursor_unset()
15490     *
15491     * @ingroup List
15492     */
15493    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15494
15495    /*
15496     * Get the type of mouse pointer/cursor decoration set to be shown,
15497     * when the mouse pointer is over the given list widget item
15498     *
15499     * @param item list item with custom cursor set
15500     * @return the cursor type's name or @c NULL, if no custom cursors
15501     * were set to @p item (and on errors)
15502     *
15503     * @see elm_object_cursor_get()
15504     * @see elm_list_item_cursor_set()
15505     * @see elm_list_item_cursor_unset()
15506     *
15507     * @ingroup List
15508     */
15509    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15510
15511    /**
15512     * Unset any custom mouse pointer/cursor decoration set to be
15513     * shown, when the mouse pointer is over the given list widget
15514     * item, thus making it show the @b default cursor again.
15515     *
15516     * @param item a list item
15517     *
15518     * Use this call to undo any custom settings on this item's cursor
15519     * decoration, bringing it back to defaults (no custom style set).
15520     *
15521     * @see elm_object_cursor_unset()
15522     * @see elm_list_item_cursor_set()
15523     *
15524     * @ingroup List
15525     */
15526    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15527
15528    /**
15529     * Set a different @b style for a given custom cursor set for a
15530     * list item.
15531     *
15532     * @param item list item with custom cursor set
15533     * @param style the <b>theme style</b> to use (e.g. @c "default",
15534     * @c "transparent", etc)
15535     *
15536     * This function only makes sense when one is using custom mouse
15537     * cursor decorations <b>defined in a theme file</b>, which can have,
15538     * given a cursor name/type, <b>alternate styles</b> on it. It
15539     * works analogously as elm_object_cursor_style_set(), but here
15540     * applyed only to list item objects.
15541     *
15542     * @warning Before you set a cursor style you should have definen a
15543     *       custom cursor previously on the item, with
15544     *       elm_list_item_cursor_set()
15545     *
15546     * @see elm_list_item_cursor_engine_only_set()
15547     * @see elm_list_item_cursor_style_get()
15548     *
15549     * @ingroup List
15550     */
15551    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15552
15553    /**
15554     * Get the current @b style set for a given list item's custom
15555     * cursor
15556     *
15557     * @param item list item with custom cursor set.
15558     * @return style the cursor style in use. If the object does not
15559     *         have a cursor set, then @c NULL is returned.
15560     *
15561     * @see elm_list_item_cursor_style_set() for more details
15562     *
15563     * @ingroup List
15564     */
15565    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15566
15567    /**
15568     * Set if the (custom)cursor for a given list item should be
15569     * searched in its theme, also, or should only rely on the
15570     * rendering engine.
15571     *
15572     * @param item item with custom (custom) cursor already set on
15573     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15574     * only on those provided by the rendering engine, @c EINA_FALSE to
15575     * have them searched on the widget's theme, as well.
15576     *
15577     * @note This call is of use only if you've set a custom cursor
15578     * for list items, with elm_list_item_cursor_set().
15579     *
15580     * @note By default, cursors will only be looked for between those
15581     * provided by the rendering engine.
15582     *
15583     * @ingroup List
15584     */
15585    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15586
15587    /**
15588     * Get if the (custom) cursor for a given list item is being
15589     * searched in its theme, also, or is only relying on the rendering
15590     * engine.
15591     *
15592     * @param item a list item
15593     * @return @c EINA_TRUE, if cursors are being looked for only on
15594     * those provided by the rendering engine, @c EINA_FALSE if they
15595     * are being searched on the widget's theme, as well.
15596     *
15597     * @see elm_list_item_cursor_engine_only_set(), for more details
15598     *
15599     * @ingroup List
15600     */
15601    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15602
15603    /**
15604     * @}
15605     */
15606
15607    /**
15608     * @defgroup Slider Slider
15609     * @ingroup Elementary
15610     *
15611     * @image html img/widget/slider/preview-00.png
15612     * @image latex img/widget/slider/preview-00.eps width=\textwidth
15613     *
15614     * The slider adds a dragable “slider” widget for selecting the value of
15615     * something within a range.
15616     *
15617     * A slider can be horizontal or vertical. It can contain an Icon and has a
15618     * primary label as well as a units label (that is formatted with floating
15619     * point values and thus accepts a printf-style format string, like
15620     * “%1.2f units”. There is also an indicator string that may be somewhere
15621     * else (like on the slider itself) that also accepts a format string like
15622     * units. Label, Icon Unit and Indicator strings/objects are optional.
15623     *
15624     * A slider may be inverted which means values invert, with high vales being
15625     * on the left or top and low values on the right or bottom (as opposed to
15626     * normally being low on the left or top and high on the bottom and right).
15627     *
15628     * The slider should have its minimum and maximum values set by the
15629     * application with  elm_slider_min_max_set() and value should also be set by
15630     * the application before use with  elm_slider_value_set(). The span of the
15631     * slider is its length (horizontally or vertically). This will be scaled by
15632     * the object or applications scaling factor. At any point code can query the
15633     * slider for its value with elm_slider_value_get().
15634     *
15635     * Smart callbacks one can listen to:
15636     * - "changed" - Whenever the slider value is changed by the user.
15637     * - "slider,drag,start" - dragging the slider indicator around has started.
15638     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15639     * - "delay,changed" - A short time after the value is changed by the user.
15640     * This will be called only when the user stops dragging for
15641     * a very short period or when they release their
15642     * finger/mouse, so it avoids possibly expensive reactions to
15643     * the value change.
15644     *
15645     * Available styles for it:
15646     * - @c "default"
15647     *
15648     * Here is an example on its usage:
15649     * @li @ref slider_example
15650     */
15651
15652    /**
15653     * @addtogroup Slider
15654     * @{
15655     */
15656
15657    /**
15658     * Add a new slider widget to the given parent Elementary
15659     * (container) object.
15660     *
15661     * @param parent The parent object.
15662     * @return a new slider widget handle or @c NULL, on errors.
15663     *
15664     * This function inserts a new slider widget on the canvas.
15665     *
15666     * @ingroup Slider
15667     */
15668    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15669
15670    /**
15671     * Set the label of a given slider widget
15672     *
15673     * @param obj The progress bar object
15674     * @param label The text label string, in UTF-8
15675     *
15676     * @ingroup Slider
15677     * @deprecated use elm_object_text_set() instead.
15678     */
15679    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15680
15681    /**
15682     * Get the label of a given slider widget
15683     *
15684     * @param obj The progressbar object
15685     * @return The text label string, in UTF-8
15686     *
15687     * @ingroup Slider
15688     * @deprecated use elm_object_text_get() instead.
15689     */
15690    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15691
15692    /**
15693     * Set the icon object of the slider object.
15694     *
15695     * @param obj The slider object.
15696     * @param icon The icon object.
15697     *
15698     * On horizontal mode, icon is placed at left, and on vertical mode,
15699     * placed at top.
15700     *
15701     * @note Once the icon object is set, a previously set one will be deleted.
15702     * If you want to keep that old content object, use the
15703     * elm_slider_icon_unset() function.
15704     *
15705     * @warning If the object being set does not have minimum size hints set,
15706     * it won't get properly displayed.
15707     *
15708     * @ingroup Slider
15709     */
15710    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15711
15712    /**
15713     * Unset an icon set on a given slider widget.
15714     *
15715     * @param obj The slider object.
15716     * @return The icon object that was being used, if any was set, or
15717     * @c NULL, otherwise (and on errors).
15718     *
15719     * On horizontal mode, icon is placed at left, and on vertical mode,
15720     * placed at top.
15721     *
15722     * This call will unparent and return the icon object which was set
15723     * for this widget, previously, on success.
15724     *
15725     * @see elm_slider_icon_set() for more details
15726     * @see elm_slider_icon_get()
15727     *
15728     * @ingroup Slider
15729     */
15730    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15731
15732    /**
15733     * Retrieve the icon object set for a given slider widget.
15734     *
15735     * @param obj The slider object.
15736     * @return The icon object's handle, if @p obj had one set, or @c NULL,
15737     * otherwise (and on errors).
15738     *
15739     * On horizontal mode, icon is placed at left, and on vertical mode,
15740     * placed at top.
15741     *
15742     * @see elm_slider_icon_set() for more details
15743     * @see elm_slider_icon_unset()
15744     *
15745     * @ingroup Slider
15746     */
15747    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15748
15749    /**
15750     * Set the end object of the slider object.
15751     *
15752     * @param obj The slider object.
15753     * @param end The end object.
15754     *
15755     * On horizontal mode, end is placed at left, and on vertical mode,
15756     * placed at bottom.
15757     *
15758     * @note Once the icon object is set, a previously set one will be deleted.
15759     * If you want to keep that old content object, use the
15760     * elm_slider_end_unset() function.
15761     *
15762     * @warning If the object being set does not have minimum size hints set,
15763     * it won't get properly displayed.
15764     *
15765     * @ingroup Slider
15766     */
15767    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15768
15769    /**
15770     * Unset an end object set on a given slider widget.
15771     *
15772     * @param obj The slider object.
15773     * @return The end object that was being used, if any was set, or
15774     * @c NULL, otherwise (and on errors).
15775     *
15776     * On horizontal mode, end is placed at left, and on vertical mode,
15777     * placed at bottom.
15778     *
15779     * This call will unparent and return the icon object which was set
15780     * for this widget, previously, on success.
15781     *
15782     * @see elm_slider_end_set() for more details.
15783     * @see elm_slider_end_get()
15784     *
15785     * @ingroup Slider
15786     */
15787    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15788
15789    /**
15790     * Retrieve the end object set for a given slider widget.
15791     *
15792     * @param obj The slider object.
15793     * @return The end object's handle, if @p obj had one set, or @c NULL,
15794     * otherwise (and on errors).
15795     *
15796     * On horizontal mode, icon is placed at right, and on vertical mode,
15797     * placed at bottom.
15798     *
15799     * @see elm_slider_end_set() for more details.
15800     * @see elm_slider_end_unset()
15801     *
15802     * @ingroup Slider
15803     */
15804    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15805
15806    /**
15807     * Set the (exact) length of the bar region of a given slider widget.
15808     *
15809     * @param obj The slider object.
15810     * @param size The length of the slider's bar region.
15811     *
15812     * This sets the minimum width (when in horizontal mode) or height
15813     * (when in vertical mode) of the actual bar area of the slider
15814     * @p obj. This in turn affects the object's minimum size. Use
15815     * this when you're not setting other size hints expanding on the
15816     * given direction (like weight and alignment hints) and you would
15817     * like it to have a specific size.
15818     *
15819     * @note Icon, end, label, indicator and unit text around @p obj
15820     * will require their
15821     * own space, which will make @p obj to require more the @p size,
15822     * actually.
15823     *
15824     * @see elm_slider_span_size_get()
15825     *
15826     * @ingroup Slider
15827     */
15828    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15829
15830    /**
15831     * Get the length set for the bar region of a given slider widget
15832     *
15833     * @param obj The slider object.
15834     * @return The length of the slider's bar region.
15835     *
15836     * If that size was not set previously, with
15837     * elm_slider_span_size_set(), this call will return @c 0.
15838     *
15839     * @ingroup Slider
15840     */
15841    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15842
15843    /**
15844     * Set the format string for the unit label.
15845     *
15846     * @param obj The slider object.
15847     * @param format The format string for the unit display.
15848     *
15849     * Unit label is displayed all the time, if set, after slider's bar.
15850     * In horizontal mode, at right and in vertical mode, at bottom.
15851     *
15852     * If @c NULL, unit label won't be visible. If not it sets the format
15853     * string for the label text. To the label text is provided a floating point
15854     * value, so the label text can display up to 1 floating point value.
15855     * Note that this is optional.
15856     *
15857     * Use a format string such as "%1.2f meters" for example, and it will
15858     * display values like: "3.14 meters" for a value equal to 3.14159.
15859     *
15860     * Default is unit label disabled.
15861     *
15862     * @see elm_slider_indicator_format_get()
15863     *
15864     * @ingroup Slider
15865     */
15866    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15867
15868    /**
15869     * Get the unit label format of the slider.
15870     *
15871     * @param obj The slider object.
15872     * @return The unit label format string in UTF-8.
15873     *
15874     * Unit label is displayed all the time, if set, after slider's bar.
15875     * In horizontal mode, at right and in vertical mode, at bottom.
15876     *
15877     * @see elm_slider_unit_format_set() for more
15878     * information on how this works.
15879     *
15880     * @ingroup Slider
15881     */
15882    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15883
15884    /**
15885     * Set the format string for the indicator label.
15886     *
15887     * @param obj The slider object.
15888     * @param indicator The format string for the indicator display.
15889     *
15890     * The slider may display its value somewhere else then unit label,
15891     * for example, above the slider knob that is dragged around. This function
15892     * sets the format string used for this.
15893     *
15894     * If @c NULL, indicator label won't be visible. If not it sets the format
15895     * string for the label text. To the label text is provided a floating point
15896     * value, so the label text can display up to 1 floating point value.
15897     * Note that this is optional.
15898     *
15899     * Use a format string such as "%1.2f meters" for example, and it will
15900     * display values like: "3.14 meters" for a value equal to 3.14159.
15901     *
15902     * Default is indicator label disabled.
15903     *
15904     * @see elm_slider_indicator_format_get()
15905     *
15906     * @ingroup Slider
15907     */
15908    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
15909
15910    /**
15911     * Get the indicator label format of the slider.
15912     *
15913     * @param obj The slider object.
15914     * @return The indicator label format string in UTF-8.
15915     *
15916     * The slider may display its value somewhere else then unit label,
15917     * for example, above the slider knob that is dragged around. This function
15918     * gets the format string used for this.
15919     *
15920     * @see elm_slider_indicator_format_set() for more
15921     * information on how this works.
15922     *
15923     * @ingroup Slider
15924     */
15925    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15926
15927    /**
15928     * Set the format function pointer for the indicator label
15929     *
15930     * @param obj The slider object.
15931     * @param func The indicator format function.
15932     * @param free_func The freeing function for the format string.
15933     *
15934     * Set the callback function to format the indicator string.
15935     *
15936     * @see elm_slider_indicator_format_set() for more info on how this works.
15937     *
15938     * @ingroup Slider
15939     */
15940   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);
15941
15942   /**
15943    * Set the format function pointer for the units label
15944    *
15945    * @param obj The slider object.
15946    * @param func The units format function.
15947    * @param free_func The freeing function for the format string.
15948    *
15949    * Set the callback function to format the indicator string.
15950    *
15951    * @see elm_slider_units_format_set() for more info on how this works.
15952    *
15953    * @ingroup Slider
15954    */
15955   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);
15956
15957   /**
15958    * Set the orientation of a given slider widget.
15959    *
15960    * @param obj The slider object.
15961    * @param horizontal Use @c EINA_TRUE to make @p obj to be
15962    * @b horizontal, @c EINA_FALSE to make it @b vertical.
15963    *
15964    * Use this function to change how your slider is to be
15965    * disposed: vertically or horizontally.
15966    *
15967    * By default it's displayed horizontally.
15968    *
15969    * @see elm_slider_horizontal_get()
15970    *
15971    * @ingroup Slider
15972    */
15973    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15974
15975    /**
15976     * Retrieve the orientation of a given slider widget
15977     *
15978     * @param obj The slider object.
15979     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
15980     * @c EINA_FALSE if it's @b vertical (and on errors).
15981     *
15982     * @see elm_slider_horizontal_set() for more details.
15983     *
15984     * @ingroup Slider
15985     */
15986    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15987
15988    /**
15989     * Set the minimum and maximum values for the slider.
15990     *
15991     * @param obj The slider object.
15992     * @param min The minimum value.
15993     * @param max The maximum value.
15994     *
15995     * Define the allowed range of values to be selected by the user.
15996     *
15997     * If actual value is less than @p min, it will be updated to @p min. If it
15998     * is bigger then @p max, will be updated to @p max. Actual value can be
15999     * get with elm_slider_value_get().
16000     *
16001     * By default, min is equal to 0.0, and max is equal to 1.0.
16002     *
16003     * @warning Maximum must be greater than minimum, otherwise behavior
16004     * is undefined.
16005     *
16006     * @see elm_slider_min_max_get()
16007     *
16008     * @ingroup Slider
16009     */
16010    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16011
16012    /**
16013     * Get the minimum and maximum values of the slider.
16014     *
16015     * @param obj The slider object.
16016     * @param min Pointer where to store the minimum value.
16017     * @param max Pointer where to store the maximum value.
16018     *
16019     * @note If only one value is needed, the other pointer can be passed
16020     * as @c NULL.
16021     *
16022     * @see elm_slider_min_max_set() for details.
16023     *
16024     * @ingroup Slider
16025     */
16026    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16027
16028    /**
16029     * Set the value the slider displays.
16030     *
16031     * @param obj The slider object.
16032     * @param val The value to be displayed.
16033     *
16034     * Value will be presented on the unit label following format specified with
16035     * elm_slider_unit_format_set() and on indicator with
16036     * elm_slider_indicator_format_set().
16037     *
16038     * @warning The value must to be between min and max values. This values
16039     * are set by elm_slider_min_max_set().
16040     *
16041     * @see elm_slider_value_get()
16042     * @see elm_slider_unit_format_set()
16043     * @see elm_slider_indicator_format_set()
16044     * @see elm_slider_min_max_set()
16045     *
16046     * @ingroup Slider
16047     */
16048    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16049
16050    /**
16051     * Get the value displayed by the spinner.
16052     *
16053     * @param obj The spinner object.
16054     * @return The value displayed.
16055     *
16056     * @see elm_spinner_value_set() for details.
16057     *
16058     * @ingroup Slider
16059     */
16060    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16061
16062    /**
16063     * Invert a given slider widget's displaying values order
16064     *
16065     * @param obj The slider object.
16066     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16067     * @c EINA_FALSE to bring it back to default, non-inverted values.
16068     *
16069     * A slider may be @b inverted, in which state it gets its
16070     * values inverted, with high vales being on the left or top and
16071     * low values on the right or bottom, as opposed to normally have
16072     * the low values on the former and high values on the latter,
16073     * respectively, for horizontal and vertical modes.
16074     *
16075     * @see elm_slider_inverted_get()
16076     *
16077     * @ingroup Slider
16078     */
16079    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16080
16081    /**
16082     * Get whether a given slider widget's displaying values are
16083     * inverted or not.
16084     *
16085     * @param obj The slider object.
16086     * @return @c EINA_TRUE, if @p obj has inverted values,
16087     * @c EINA_FALSE otherwise (and on errors).
16088     *
16089     * @see elm_slider_inverted_set() for more details.
16090     *
16091     * @ingroup Slider
16092     */
16093    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16094
16095    /**
16096     * Set whether to enlarge slider indicator (augmented knob) or not.
16097     *
16098     * @param obj The slider object.
16099     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16100     * let the knob always at default size.
16101     *
16102     * By default, indicator will be bigger while dragged by the user.
16103     *
16104     * @warning It won't display values set with
16105     * elm_slider_indicator_format_set() if you disable indicator.
16106     *
16107     * @ingroup Slider
16108     */
16109    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16110
16111    /**
16112     * Get whether a given slider widget's enlarging indicator or not.
16113     *
16114     * @param obj The slider object.
16115     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16116     * @c EINA_FALSE otherwise (and on errors).
16117     *
16118     * @see elm_slider_indicator_show_set() for details.
16119     *
16120     * @ingroup Slider
16121     */
16122    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16123
16124    /**
16125     * @}
16126     */
16127
16128    /**
16129     * @addtogroup Actionslider Actionslider
16130     *
16131     * @image html img/widget/actionslider/preview-00.png
16132     * @image latex img/widget/actionslider/preview-00.eps
16133     *
16134     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16135     * properties. The indicator is the element the user drags to choose a label.
16136     * When the position is set with magnet, when released the indicator will be
16137     * moved to it if it's nearest the magnetized position.
16138     *
16139     * @note By default all positions are set as enabled.
16140     *
16141     * Signals that you can add callbacks for are:
16142     *
16143     * "selected" - when user selects an enabled position (the label is passed
16144     *              as event info)".
16145     * @n
16146     * "pos_changed" - when the indicator reaches any of the positions("left",
16147     *                 "right" or "center").
16148     *
16149     * See an example of actionslider usage @ref actionslider_example_page "here"
16150     * @{
16151     */
16152    typedef enum _Elm_Actionslider_Pos
16153      {
16154         ELM_ACTIONSLIDER_NONE = 0,
16155         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16156         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16157         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16158         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16159      } Elm_Actionslider_Pos;
16160
16161    /**
16162     * Add a new actionslider to the parent.
16163     *
16164     * @param parent The parent object
16165     * @return The new actionslider object or NULL if it cannot be created
16166     */
16167    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16168    /**
16169     * Set actionslider labels.
16170     *
16171     * @param obj The actionslider object
16172     * @param left_label The label to be set on the left.
16173     * @param center_label The label to be set on the center.
16174     * @param right_label The label to be set on the right.
16175     * @deprecated use elm_object_text_set() instead.
16176     */
16177    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
16178    /**
16179     * Get actionslider labels.
16180     *
16181     * @param obj The actionslider object
16182     * @param left_label A char** to place the left_label of @p obj into.
16183     * @param center_label A char** to place the center_label of @p obj into.
16184     * @param right_label A char** to place the right_label of @p obj into.
16185     * @deprecated use elm_object_text_set() instead.
16186     */
16187    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
16188    /**
16189     * Get actionslider selected label.
16190     *
16191     * @param obj The actionslider object
16192     * @return The selected label
16193     */
16194    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16195    /**
16196     * Set actionslider indicator position.
16197     *
16198     * @param obj The actionslider object.
16199     * @param pos The position of the indicator.
16200     */
16201    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16202    /**
16203     * Get actionslider indicator position.
16204     *
16205     * @param obj The actionslider object.
16206     * @return The position of the indicator.
16207     */
16208    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16209    /**
16210     * Set actionslider magnet position. To make multiple positions magnets @c or
16211     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16212     *
16213     * @param obj The actionslider object.
16214     * @param pos Bit mask indicating the magnet positions.
16215     */
16216    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16217    /**
16218     * Get actionslider magnet position.
16219     *
16220     * @param obj The actionslider object.
16221     * @return The positions with magnet property.
16222     */
16223    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16224    /**
16225     * Set actionslider enabled position. To set multiple positions as enabled @c or
16226     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16227     *
16228     * @note All the positions are enabled by default.
16229     *
16230     * @param obj The actionslider object.
16231     * @param pos Bit mask indicating the enabled positions.
16232     */
16233    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16234    /**
16235     * Get actionslider enabled position.
16236     *
16237     * @param obj The actionslider object.
16238     * @return The enabled positions.
16239     */
16240    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16241    /**
16242     * Set the label used on the indicator.
16243     *
16244     * @param obj The actionslider object
16245     * @param label The label to be set on the indicator.
16246     * @deprecated use elm_object_text_set() instead.
16247     */
16248    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16249    /**
16250     * Get the label used on the indicator object.
16251     *
16252     * @param obj The actionslider object
16253     * @return The indicator label
16254     * @deprecated use elm_object_text_get() instead.
16255     */
16256    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16257    /**
16258     * @}
16259     */
16260
16261    /**
16262     * @defgroup Genlist Genlist
16263     *
16264     * @image html img/widget/genlist/preview-00.png
16265     * @image latex img/widget/genlist/preview-00.eps
16266     * @image html img/genlist.png
16267     * @image latex img/genlist.eps
16268     *
16269     * This widget aims to have more expansive list than the simple list in
16270     * Elementary that could have more flexible items and allow many more entries
16271     * while still being fast and low on memory usage. At the same time it was
16272     * also made to be able to do tree structures. But the price to pay is more
16273     * complexity when it comes to usage. If all you want is a simple list with
16274     * icons and a single label, use the normal @ref List object.
16275     *
16276     * Genlist has a fairly large API, mostly because it's relatively complex,
16277     * trying to be both expansive, powerful and efficient. First we will begin
16278     * an overview on the theory behind genlist.
16279     *
16280     * @section Genlist_Item_Class Genlist item classes - creating items
16281     *
16282     * In order to have the ability to add and delete items on the fly, genlist
16283     * implements a class (callback) system where the application provides a
16284     * structure with information about that type of item (genlist may contain
16285     * multiple different items with different classes, states and styles).
16286     * Genlist will call the functions in this struct (methods) when an item is
16287     * "realized" (i.e., created dynamically, while the user is scrolling the
16288     * grid). All objects will simply be deleted when no longer needed with
16289     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16290     * following members:
16291     * - @c item_style - This is a constant string and simply defines the name
16292     *   of the item style. It @b must be specified and the default should be @c
16293     *   "default".
16294     * - @c mode_item_style - This is a constant string and simply defines the
16295     *   name of the style that will be used for mode animations. It can be left
16296     *   as @c NULL if you don't plan to use Genlist mode. See
16297     *   elm_genlist_item_mode_set() for more info.
16298     *
16299     * - @c func - A struct with pointers to functions that will be called when
16300     *   an item is going to be actually created. All of them receive a @c data
16301     *   parameter that will point to the same data passed to
16302     *   elm_genlist_item_append() and related item creation functions, and a @c
16303     *   obj parameter that points to the genlist object itself.
16304     *
16305     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16306     * state_get and @c del. The 3 first functions also receive a @c part
16307     * parameter described below. A brief description of these functions follows:
16308     *
16309     * - @c label_get - The @c part parameter is the name string of one of the
16310     *   existing text parts in the Edje group implementing the item's theme.
16311     *   This function @b must return a strdup'()ed string, as the caller will
16312     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16313     * - @c icon_get - The @c part parameter is the name string of one of the
16314     *   existing (icon) swallow parts in the Edje group implementing the item's
16315     *   theme. It must return @c NULL, when no icon is desired, or a valid
16316     *   object handle, otherwise.  The object will be deleted by the genlist on
16317     *   its deletion or when the item is "unrealized".  See
16318     *   #Elm_Genlist_Item_Icon_Get_Cb.
16319     * - @c func.state_get - The @c part parameter is the name string of one of
16320     *   the state parts in the Edje group implementing the item's theme. Return
16321     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16322     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16323     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16324     *   the state is true (the default is false), where @c XXX is the name of
16325     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16326     * - @c func.del - This is intended for use when genlist items are deleted,
16327     *   so any data attached to the item (e.g. its data parameter on creation)
16328     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16329     *
16330     * available item styles:
16331     * - default
16332     * - default_style - The text part is a textblock
16333     *
16334     * @image html img/widget/genlist/preview-04.png
16335     * @image latex img/widget/genlist/preview-04.eps
16336     *
16337     * - double_label
16338     *
16339     * @image html img/widget/genlist/preview-01.png
16340     * @image latex img/widget/genlist/preview-01.eps
16341     *
16342     * - icon_top_text_bottom
16343     *
16344     * @image html img/widget/genlist/preview-02.png
16345     * @image latex img/widget/genlist/preview-02.eps
16346     *
16347     * - group_index
16348     *
16349     * @image html img/widget/genlist/preview-03.png
16350     * @image latex img/widget/genlist/preview-03.eps
16351     *
16352     * @section Genlist_Items Structure of items
16353     *
16354     * An item in a genlist can have 0 or more text labels (they can be regular
16355     * text or textblock Evas objects - that's up to the style to determine), 0
16356     * or more icons (which are simply objects swallowed into the genlist item's
16357     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16358     * behavior left to the user to define. The Edje part names for each of
16359     * these properties will be looked up, in the theme file for the genlist,
16360     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16361     * "states", respectively. For each of those properties, if more than one
16362     * part is provided, they must have names listed separated by spaces in the
16363     * data fields. For the default genlist item theme, we have @b one label
16364     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16365     * "elm.swallow.end") and @b no state parts.
16366     *
16367     * A genlist item may be at one of several styles. Elementary provides one
16368     * by default - "default", but this can be extended by system or application
16369     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16370     * details).
16371     *
16372     * @section Genlist_Manipulation Editing and Navigating
16373     *
16374     * Items can be added by several calls. All of them return a @ref
16375     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16376     * They all take a data parameter that is meant to be used for a handle to
16377     * the applications internal data (eg the struct with the original item
16378     * data). The parent parameter is the parent genlist item this belongs to if
16379     * it is a tree or an indexed group, and NULL if there is no parent. The
16380     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16381     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16382     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16383     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16384     * is set then this item is group index item that is displayed at the top
16385     * until the next group comes. The func parameter is a convenience callback
16386     * that is called when the item is selected and the data parameter will be
16387     * the func_data parameter, obj be the genlist object and event_info will be
16388     * the genlist item.
16389     *
16390     * elm_genlist_item_append() adds an item to the end of the list, or if
16391     * there is a parent, to the end of all the child items of the parent.
16392     * elm_genlist_item_prepend() is the same but adds to the beginning of
16393     * the list or children list. elm_genlist_item_insert_before() inserts at
16394     * item before another item and elm_genlist_item_insert_after() inserts after
16395     * the indicated item.
16396     *
16397     * The application can clear the list with elm_genlist_clear() which deletes
16398     * all the items in the list and elm_genlist_item_del() will delete a specific
16399     * item. elm_genlist_item_subitems_clear() will clear all items that are
16400     * children of the indicated parent item.
16401     *
16402     * To help inspect list items you can jump to the item at the top of the list
16403     * with elm_genlist_first_item_get() which will return the item pointer, and
16404     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16405     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16406     * and previous items respectively relative to the indicated item. Using
16407     * these calls you can walk the entire item list/tree. Note that as a tree
16408     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16409     * let you know which item is the parent (and thus know how to skip them if
16410     * wanted).
16411     *
16412     * @section Genlist_Muti_Selection Multi-selection
16413     *
16414     * If the application wants multiple items to be able to be selected,
16415     * elm_genlist_multi_select_set() can enable this. If the list is
16416     * single-selection only (the default), then elm_genlist_selected_item_get()
16417     * will return the selected item, if any, or NULL I none is selected. If the
16418     * list is multi-select then elm_genlist_selected_items_get() will return a
16419     * list (that is only valid as long as no items are modified (added, deleted,
16420     * selected or unselected)).
16421     *
16422     * @section Genlist_Usage_Hints Usage hints
16423     *
16424     * There are also convenience functions. elm_genlist_item_genlist_get() will
16425     * return the genlist object the item belongs to. elm_genlist_item_show()
16426     * will make the scroller scroll to show that specific item so its visible.
16427     * elm_genlist_item_data_get() returns the data pointer set by the item
16428     * creation functions.
16429     *
16430     * If an item changes (state of boolean changes, label or icons change),
16431     * then use elm_genlist_item_update() to have genlist update the item with
16432     * the new state. Genlist will re-realize the item thus call the functions
16433     * in the _Elm_Genlist_Item_Class for that item.
16434     *
16435     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16436     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16437     * to expand/contract an item and get its expanded state, use
16438     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16439     * again to make an item disabled (unable to be selected and appear
16440     * differently) use elm_genlist_item_disabled_set() to set this and
16441     * elm_genlist_item_disabled_get() to get the disabled state.
16442     *
16443     * In general to indicate how the genlist should expand items horizontally to
16444     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16445     * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16446     * mode means that if items are too wide to fit, the scroller will scroll
16447     * horizontally. Otherwise items are expanded to fill the width of the
16448     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16449     * to the viewport width and limited to that size. This can be combined with
16450     * a different style that uses edjes' ellipsis feature (cutting text off like
16451     * this: "tex...").
16452     *
16453     * Items will only call their selection func and callback when first becoming
16454     * selected. Any further clicks will do nothing, unless you enable always
16455     * select with elm_genlist_always_select_mode_set(). This means even if
16456     * selected, every click will make the selected callbacks be called.
16457     * elm_genlist_no_select_mode_set() will turn off the ability to select
16458     * items entirely and they will neither appear selected nor call selected
16459     * callback functions.
16460     *
16461     * Remember that you can create new styles and add your own theme augmentation
16462     * per application with elm_theme_extension_add(). If you absolutely must
16463     * have a specific style that overrides any theme the user or system sets up
16464     * you can use elm_theme_overlay_add() to add such a file.
16465     *
16466     * @section Genlist_Implementation Implementation
16467     *
16468     * Evas tracks every object you create. Every time it processes an event
16469     * (mouse move, down, up etc.) it needs to walk through objects and find out
16470     * what event that affects. Even worse every time it renders display updates,
16471     * in order to just calculate what to re-draw, it needs to walk through many
16472     * many many objects. Thus, the more objects you keep active, the more
16473     * overhead Evas has in just doing its work. It is advisable to keep your
16474     * active objects to the minimum working set you need. Also remember that
16475     * object creation and deletion carries an overhead, so there is a
16476     * middle-ground, which is not easily determined. But don't keep massive lists
16477     * of objects you can't see or use. Genlist does this with list objects. It
16478     * creates and destroys them dynamically as you scroll around. It groups them
16479     * into blocks so it can determine the visibility etc. of a whole block at
16480     * once as opposed to having to walk the whole list. This 2-level list allows
16481     * for very large numbers of items to be in the list (tests have used up to
16482     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16483     * may be different sizes, every item added needs to be calculated as to its
16484     * size and thus this presents a lot of overhead on populating the list, this
16485     * genlist employs a queue. Any item added is queued and spooled off over
16486     * time, actually appearing some time later, so if your list has many members
16487     * you may find it takes a while for them to all appear, with your process
16488     * consuming a lot of CPU while it is busy spooling.
16489     *
16490     * Genlist also implements a tree structure, but it does so with callbacks to
16491     * the application, with the application filling in tree structures when
16492     * requested (allowing for efficient building of a very deep tree that could
16493     * even be used for file-management). See the above smart signal callbacks for
16494     * details.
16495     *
16496     * @section Genlist_Smart_Events Genlist smart events
16497     *
16498     * Signals that you can add callbacks for are:
16499     * - @c "activated" - The user has double-clicked or pressed
16500     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16501     *   item that was activated.
16502     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16503     *   event_info parameter is the item that was double-clicked.
16504     * - @c "selected" - This is called when a user has made an item selected.
16505     *   The event_info parameter is the genlist item that was selected.
16506     * - @c "unselected" - This is called when a user has made an item
16507     *   unselected. The event_info parameter is the genlist item that was
16508     *   unselected.
16509     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16510     *   called and the item is now meant to be expanded. The event_info
16511     *   parameter is the genlist item that was indicated to expand.  It is the
16512     *   job of this callback to then fill in the child items.
16513     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16514     *   called and the item is now meant to be contracted. The event_info
16515     *   parameter is the genlist item that was indicated to contract. It is the
16516     *   job of this callback to then delete the child items.
16517     * - @c "expand,request" - This is called when a user has indicated they want
16518     *   to expand a tree branch item. The callback should decide if the item can
16519     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16520     *   appropriately to set the state. The event_info parameter is the genlist
16521     *   item that was indicated to expand.
16522     * - @c "contract,request" - This is called when a user has indicated they
16523     *   want to contract a tree branch item. The callback should decide if the
16524     *   item can contract (has any children) and then call
16525     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16526     *   event_info parameter is the genlist item that was indicated to contract.
16527     * - @c "realized" - This is called when the item in the list is created as a
16528     *   real evas object. event_info parameter is the genlist item that was
16529     *   created. The object may be deleted at any time, so it is up to the
16530     *   caller to not use the object pointer from elm_genlist_item_object_get()
16531     *   in a way where it may point to freed objects.
16532     * - @c "unrealized" - This is called just before an item is unrealized.
16533     *   After this call icon objects provided will be deleted and the item
16534     *   object itself delete or be put into a floating cache.
16535     * - @c "drag,start,up" - This is called when the item in the list has been
16536     *   dragged (not scrolled) up.
16537     * - @c "drag,start,down" - This is called when the item in the list has been
16538     *   dragged (not scrolled) down.
16539     * - @c "drag,start,left" - This is called when the item in the list has been
16540     *   dragged (not scrolled) left.
16541     * - @c "drag,start,right" - This is called when the item in the list has
16542     *   been dragged (not scrolled) right.
16543     * - @c "drag,stop" - This is called when the item in the list has stopped
16544     *   being dragged.
16545     * - @c "drag" - This is called when the item in the list is being dragged.
16546     * - @c "longpressed" - This is called when the item is pressed for a certain
16547     *   amount of time. By default it's 1 second.
16548     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16549     *   the top edge.
16550     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16551     *   until the bottom edge.
16552     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16553     *   until the left edge.
16554     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16555     *   until the right edge.
16556     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16557     *   swiped left.
16558     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16559     *   swiped right.
16560     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16561     *   swiped up.
16562     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16563     *   swiped down.
16564     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16565     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
16566     *   multi-touch pinched in.
16567     * - @c "swipe" - This is called when the genlist is swiped.
16568     *
16569     * @section Genlist_Examples Examples
16570     *
16571     * Here is a list of examples that use the genlist, trying to show some of
16572     * its capabilities:
16573     * - @ref genlist_example_01
16574     * - @ref genlist_example_02
16575     * - @ref genlist_example_03
16576     * - @ref genlist_example_04
16577     * - @ref genlist_example_05
16578     */
16579
16580    /**
16581     * @addtogroup Genlist
16582     * @{
16583     */
16584
16585    /**
16586     * @enum _Elm_Genlist_Item_Flags
16587     * @typedef Elm_Genlist_Item_Flags
16588     *
16589     * Defines if the item is of any special type (has subitems or it's the
16590     * index of a group), or is just a simple item.
16591     *
16592     * @ingroup Genlist
16593     */
16594    typedef enum _Elm_Genlist_Item_Flags
16595      {
16596         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16597         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16598         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16599      } Elm_Genlist_Item_Flags;
16600    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
16601    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16602    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16603    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16604    typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
16605    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
16606    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16607    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16608
16609    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16610    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16611    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16612    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16613
16614    /**
16615     * @struct _Elm_Genlist_Item_Class
16616     *
16617     * Genlist item class definition structs.
16618     *
16619     * This struct contains the style and fetching functions that will define the
16620     * contents of each item.
16621     *
16622     * @see @ref Genlist_Item_Class
16623     */
16624    struct _Elm_Genlist_Item_Class
16625      {
16626         const char                *item_style; /**< style of this class. */
16627         struct
16628           {
16629              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
16630              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
16631              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
16632              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
16633              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
16634           } func;
16635         const char                *mode_item_style;
16636      };
16637
16638    /**
16639     * Add a new genlist widget to the given parent Elementary
16640     * (container) object
16641     *
16642     * @param parent The parent object
16643     * @return a new genlist widget handle or @c NULL, on errors
16644     *
16645     * This function inserts a new genlist widget on the canvas.
16646     *
16647     * @see elm_genlist_item_append()
16648     * @see elm_genlist_item_del()
16649     * @see elm_genlist_clear()
16650     *
16651     * @ingroup Genlist
16652     */
16653    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16654    /**
16655     * Remove all items from a given genlist widget.
16656     *
16657     * @param obj The genlist object
16658     *
16659     * This removes (and deletes) all items in @p obj, leaving it empty.
16660     *
16661     * @see elm_genlist_item_del(), to remove just one item.
16662     *
16663     * @ingroup Genlist
16664     */
16665    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16666    /**
16667     * Enable or disable multi-selection in the genlist
16668     *
16669     * @param obj The genlist object
16670     * @param multi Multi-select enable/disable. Default is disabled.
16671     *
16672     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16673     * the list. This allows more than 1 item to be selected. To retrieve the list
16674     * of selected items, use elm_genlist_selected_items_get().
16675     *
16676     * @see elm_genlist_selected_items_get()
16677     * @see elm_genlist_multi_select_get()
16678     *
16679     * @ingroup Genlist
16680     */
16681    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16682    /**
16683     * Gets if multi-selection in genlist is enabled or disabled.
16684     *
16685     * @param obj The genlist object
16686     * @return Multi-select enabled/disabled
16687     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16688     *
16689     * @see elm_genlist_multi_select_set()
16690     *
16691     * @ingroup Genlist
16692     */
16693    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16694    /**
16695     * This sets the horizontal stretching mode.
16696     *
16697     * @param obj The genlist object
16698     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16699     *
16700     * This sets the mode used for sizing items horizontally. Valid modes
16701     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16702     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16703     * the scroller will scroll horizontally. Otherwise items are expanded
16704     * to fill the width of the viewport of the scroller. If it is
16705     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16706     * limited to that size.
16707     *
16708     * @see elm_genlist_horizontal_get()
16709     *
16710     * @ingroup Genlist
16711     */
16712    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16713    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16714    /**
16715     * Gets the horizontal stretching mode.
16716     *
16717     * @param obj The genlist object
16718     * @return The mode to use
16719     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16720     *
16721     * @see elm_genlist_horizontal_set()
16722     *
16723     * @ingroup Genlist
16724     */
16725    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16726    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16727    /**
16728     * Set the always select mode.
16729     *
16730     * @param obj The genlist object
16731     * @param always_select The always select mode (@c EINA_TRUE = on, @c
16732     * EINA_FALSE = off). Default is @c EINA_FALSE.
16733     *
16734     * Items will only call their selection func and callback when first
16735     * becoming selected. Any further clicks will do nothing, unless you
16736     * enable always select with elm_genlist_always_select_mode_set().
16737     * This means that, even if selected, every click will make the selected
16738     * callbacks be called.
16739     *
16740     * @see elm_genlist_always_select_mode_get()
16741     *
16742     * @ingroup Genlist
16743     */
16744    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16745    /**
16746     * Get the always select mode.
16747     *
16748     * @param obj The genlist object
16749     * @return The always select mode
16750     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16751     *
16752     * @see elm_genlist_always_select_mode_set()
16753     *
16754     * @ingroup Genlist
16755     */
16756    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16757    /**
16758     * Enable/disable the no select mode.
16759     *
16760     * @param obj The genlist object
16761     * @param no_select The no select mode
16762     * (EINA_TRUE = on, EINA_FALSE = off)
16763     *
16764     * This will turn off the ability to select items entirely and they
16765     * will neither appear selected nor call selected callback functions.
16766     *
16767     * @see elm_genlist_no_select_mode_get()
16768     *
16769     * @ingroup Genlist
16770     */
16771    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16772    /**
16773     * Gets whether the no select mode is enabled.
16774     *
16775     * @param obj The genlist object
16776     * @return The no select mode
16777     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16778     *
16779     * @see elm_genlist_no_select_mode_set()
16780     *
16781     * @ingroup Genlist
16782     */
16783    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16784    /**
16785     * Enable/disable compress mode.
16786     *
16787     * @param obj The genlist object
16788     * @param compress The compress mode
16789     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16790     *
16791     * This will enable the compress mode where items are "compressed"
16792     * horizontally to fit the genlist scrollable viewport width. This is
16793     * special for genlist.  Do not rely on
16794     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16795     * work as genlist needs to handle it specially.
16796     *
16797     * @see elm_genlist_compress_mode_get()
16798     *
16799     * @ingroup Genlist
16800     */
16801    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16802    /**
16803     * Get whether the compress mode is enabled.
16804     *
16805     * @param obj The genlist object
16806     * @return The compress mode
16807     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16808     *
16809     * @see elm_genlist_compress_mode_set()
16810     *
16811     * @ingroup Genlist
16812     */
16813    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16814    /**
16815     * Enable/disable height-for-width mode.
16816     *
16817     * @param obj The genlist object
16818     * @param setting The height-for-width mode (@c EINA_TRUE = on,
16819     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16820     *
16821     * With height-for-width mode the item width will be fixed (restricted
16822     * to a minimum of) to the list width when calculating its size in
16823     * order to allow the height to be calculated based on it. This allows,
16824     * for instance, text block to wrap lines if the Edje part is
16825     * configured with "text.min: 0 1".
16826     *
16827     * @note This mode will make list resize slower as it will have to
16828     *       recalculate every item height again whenever the list width
16829     *       changes!
16830     *
16831     * @note When height-for-width mode is enabled, it also enables
16832     *       compress mode (see elm_genlist_compress_mode_set()) and
16833     *       disables homogeneous (see elm_genlist_homogeneous_set()).
16834     *
16835     * @ingroup Genlist
16836     */
16837    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16838    /**
16839     * Get whether the height-for-width mode is enabled.
16840     *
16841     * @param obj The genlist object
16842     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16843     * off)
16844     *
16845     * @ingroup Genlist
16846     */
16847    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16848    /**
16849     * Enable/disable horizontal and vertical bouncing effect.
16850     *
16851     * @param obj The genlist object
16852     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16853     * EINA_FALSE = off). Default is @c EINA_FALSE.
16854     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16855     * EINA_FALSE = off). Default is @c EINA_TRUE.
16856     *
16857     * This will enable or disable the scroller bouncing effect for the
16858     * genlist. See elm_scroller_bounce_set() for details.
16859     *
16860     * @see elm_scroller_bounce_set()
16861     * @see elm_genlist_bounce_get()
16862     *
16863     * @ingroup Genlist
16864     */
16865    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16866    /**
16867     * Get whether the horizontal and vertical bouncing effect is enabled.
16868     *
16869     * @param obj The genlist object
16870     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16871     * option is set.
16872     * @param v_bounce Pointer to a bool to receive if the bounce vertically
16873     * option is set.
16874     *
16875     * @see elm_genlist_bounce_set()
16876     *
16877     * @ingroup Genlist
16878     */
16879    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16880    /**
16881     * Enable/disable homogenous mode.
16882     *
16883     * @param obj The genlist object
16884     * @param homogeneous Assume the items within the genlist are of the
16885     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16886     * EINA_FALSE.
16887     *
16888     * This will enable the homogeneous mode where items are of the same
16889     * height and width so that genlist may do the lazy-loading at its
16890     * maximum (which increases the performance for scrolling the list). This
16891     * implies 'compressed' mode.
16892     *
16893     * @see elm_genlist_compress_mode_set()
16894     * @see elm_genlist_homogeneous_get()
16895     *
16896     * @ingroup Genlist
16897     */
16898    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16899    /**
16900     * Get whether the homogenous mode is enabled.
16901     *
16902     * @param obj The genlist object
16903     * @return Assume the items within the genlist are of the same height
16904     * and width (EINA_TRUE = on, EINA_FALSE = off)
16905     *
16906     * @see elm_genlist_homogeneous_set()
16907     *
16908     * @ingroup Genlist
16909     */
16910    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16911    /**
16912     * Set the maximum number of items within an item block
16913     *
16914     * @param obj The genlist object
16915     * @param n   Maximum number of items within an item block. Default is 32.
16916     *
16917     * This will configure the block count to tune to the target with
16918     * particular performance matrix.
16919     *
16920     * A block of objects will be used to reduce the number of operations due to
16921     * many objects in the screen. It can determine the visibility, or if the
16922     * object has changed, it theme needs to be updated, etc. doing this kind of
16923     * calculation to the entire block, instead of per object.
16924     *
16925     * The default value for the block count is enough for most lists, so unless
16926     * you know you will have a lot of objects visible in the screen at the same
16927     * time, don't try to change this.
16928     *
16929     * @see elm_genlist_block_count_get()
16930     * @see @ref Genlist_Implementation
16931     *
16932     * @ingroup Genlist
16933     */
16934    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
16935    /**
16936     * Get the maximum number of items within an item block
16937     *
16938     * @param obj The genlist object
16939     * @return Maximum number of items within an item block
16940     *
16941     * @see elm_genlist_block_count_set()
16942     *
16943     * @ingroup Genlist
16944     */
16945    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16946    /**
16947     * Set the timeout in seconds for the longpress event.
16948     *
16949     * @param obj The genlist object
16950     * @param timeout timeout in seconds. Default is 1.
16951     *
16952     * This option will change how long it takes to send an event "longpressed"
16953     * after the mouse down signal is sent to the list. If this event occurs, no
16954     * "clicked" event will be sent.
16955     *
16956     * @see elm_genlist_longpress_timeout_set()
16957     *
16958     * @ingroup Genlist
16959     */
16960    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16961    /**
16962     * Get the timeout in seconds for the longpress event.
16963     *
16964     * @param obj The genlist object
16965     * @return timeout in seconds
16966     *
16967     * @see elm_genlist_longpress_timeout_get()
16968     *
16969     * @ingroup Genlist
16970     */
16971    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16972    /**
16973     * Append a new item in a given genlist widget.
16974     *
16975     * @param obj The genlist object
16976     * @param itc The item class for the item
16977     * @param data The item data
16978     * @param parent The parent item, or NULL if none
16979     * @param flags Item flags
16980     * @param func Convenience function called when the item is selected
16981     * @param func_data Data passed to @p func above.
16982     * @return A handle to the item added or @c NULL if not possible
16983     *
16984     * This adds the given item to the end of the list or the end of
16985     * the children list if the @p parent is given.
16986     *
16987     * @see elm_genlist_item_prepend()
16988     * @see elm_genlist_item_insert_before()
16989     * @see elm_genlist_item_insert_after()
16990     * @see elm_genlist_item_del()
16991     *
16992     * @ingroup Genlist
16993     */
16994    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);
16995    /**
16996     * Prepend a new item in a given genlist widget.
16997     *
16998     * @param obj The genlist object
16999     * @param itc The item class for the item
17000     * @param data The item data
17001     * @param parent The parent item, or NULL if none
17002     * @param flags Item flags
17003     * @param func Convenience function called when the item is selected
17004     * @param func_data Data passed to @p func above.
17005     * @return A handle to the item added or NULL if not possible
17006     *
17007     * This adds an item to the beginning of the list or beginning of the
17008     * children of the parent if given.
17009     *
17010     * @see elm_genlist_item_append()
17011     * @see elm_genlist_item_insert_before()
17012     * @see elm_genlist_item_insert_after()
17013     * @see elm_genlist_item_del()
17014     *
17015     * @ingroup Genlist
17016     */
17017    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);
17018    /**
17019     * Insert an item before another in a genlist widget
17020     *
17021     * @param obj The genlist object
17022     * @param itc The item class for the item
17023     * @param data The item data
17024     * @param before The item to place this new one before.
17025     * @param flags Item flags
17026     * @param func Convenience function called when the item is selected
17027     * @param func_data Data passed to @p func above.
17028     * @return A handle to the item added or @c NULL if not possible
17029     *
17030     * This inserts an item before another in the list. It will be in the
17031     * same tree level or group as the item it is inserted before.
17032     *
17033     * @see elm_genlist_item_append()
17034     * @see elm_genlist_item_prepend()
17035     * @see elm_genlist_item_insert_after()
17036     * @see elm_genlist_item_del()
17037     *
17038     * @ingroup Genlist
17039     */
17040    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);
17041    /**
17042     * Insert an item after another in a genlist widget
17043     *
17044     * @param obj The genlist object
17045     * @param itc The item class for the item
17046     * @param data The item data
17047     * @param after The item to place this new one after.
17048     * @param flags Item flags
17049     * @param func Convenience function called when the item is selected
17050     * @param func_data Data passed to @p func above.
17051     * @return A handle to the item added or @c NULL if not possible
17052     *
17053     * This inserts an item after another in the list. It will be in the
17054     * same tree level or group as the item it is inserted after.
17055     *
17056     * @see elm_genlist_item_append()
17057     * @see elm_genlist_item_prepend()
17058     * @see elm_genlist_item_insert_before()
17059     * @see elm_genlist_item_del()
17060     *
17061     * @ingroup Genlist
17062     */
17063    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);
17064    /**
17065     * Insert a new item into the sorted genlist object
17066     *
17067     * @param obj The genlist object
17068     * @param itc The item class for the item
17069     * @param data The item data
17070     * @param parent The parent item, or NULL if none
17071     * @param flags Item flags
17072     * @param comp The function called for the sort
17073     * @param func Convenience function called when item selected
17074     * @param func_data Data passed to @p func above.
17075     * @return A handle to the item added or NULL if not possible
17076     *
17077     * @ingroup Genlist
17078     */
17079    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);
17080    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);
17081    /* operations to retrieve existing items */
17082    /**
17083     * Get the selectd item in the genlist.
17084     *
17085     * @param obj The genlist object
17086     * @return The selected item, or NULL if none is selected.
17087     *
17088     * This gets the selected item in the list (if multi-selection is enabled, only
17089     * the item that was first selected in the list is returned - which is not very
17090     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17091     * used).
17092     *
17093     * If no item is selected, NULL is returned.
17094     *
17095     * @see elm_genlist_selected_items_get()
17096     *
17097     * @ingroup Genlist
17098     */
17099    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17100    /**
17101     * Get a list of selected items in the genlist.
17102     *
17103     * @param obj The genlist object
17104     * @return The list of selected items, or NULL if none are selected.
17105     *
17106     * It returns a list of the selected items. This list pointer is only valid so
17107     * long as the selection doesn't change (no items are selected or unselected, or
17108     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17109     * pointers. The order of the items in this list is the order which they were
17110     * selected, i.e. the first item in this list is the first item that was
17111     * selected, and so on.
17112     *
17113     * @note If not in multi-select mode, consider using function
17114     * elm_genlist_selected_item_get() instead.
17115     *
17116     * @see elm_genlist_multi_select_set()
17117     * @see elm_genlist_selected_item_get()
17118     *
17119     * @ingroup Genlist
17120     */
17121    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17122    /**
17123     * Get a list of realized items in genlist
17124     *
17125     * @param obj The genlist object
17126     * @return The list of realized items, nor NULL if none are realized.
17127     *
17128     * This returns a list of the realized items in the genlist. The list
17129     * contains Elm_Genlist_Item pointers. The list must be freed by the
17130     * caller when done with eina_list_free(). The item pointers in the
17131     * list are only valid so long as those items are not deleted or the
17132     * genlist is not deleted.
17133     *
17134     * @see elm_genlist_realized_items_update()
17135     *
17136     * @ingroup Genlist
17137     */
17138    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17139    /**
17140     * Get the item that is at the x, y canvas coords.
17141     *
17142     * @param obj The gelinst object.
17143     * @param x The input x coordinate
17144     * @param y The input y coordinate
17145     * @param posret The position relative to the item returned here
17146     * @return The item at the coordinates or NULL if none
17147     *
17148     * This returns the item at the given coordinates (which are canvas
17149     * relative, not object-relative). If an item is at that coordinate,
17150     * that item handle is returned, and if @p posret is not NULL, the
17151     * integer pointed to is set to a value of -1, 0 or 1, depending if
17152     * the coordinate is on the upper portion of that item (-1), on the
17153     * middle section (0) or on the lower part (1). If NULL is returned as
17154     * an item (no item found there), then posret may indicate -1 or 1
17155     * based if the coordinate is above or below all items respectively in
17156     * the genlist.
17157     *
17158     * @ingroup Genlist
17159     */
17160    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);
17161    /**
17162     * Get the first item in the genlist
17163     *
17164     * This returns the first item in the list.
17165     *
17166     * @param obj The genlist object
17167     * @return The first item, or NULL if none
17168     *
17169     * @ingroup Genlist
17170     */
17171    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17172    /**
17173     * Get the last item in the genlist
17174     *
17175     * This returns the last item in the list.
17176     *
17177     * @return The last item, or NULL if none
17178     *
17179     * @ingroup Genlist
17180     */
17181    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17182    /**
17183     * Set the scrollbar policy
17184     *
17185     * @param obj The genlist object
17186     * @param policy_h Horizontal scrollbar policy.
17187     * @param policy_v Vertical scrollbar policy.
17188     *
17189     * This sets the scrollbar visibility policy for the given genlist
17190     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17191     * made visible if it is needed, and otherwise kept hidden.
17192     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17193     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17194     * respectively for the horizontal and vertical scrollbars. Default is
17195     * #ELM_SMART_SCROLLER_POLICY_AUTO
17196     *
17197     * @see elm_genlist_scroller_policy_get()
17198     *
17199     * @ingroup Genlist
17200     */
17201    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17202    /**
17203     * Get the scrollbar policy
17204     *
17205     * @param obj The genlist object
17206     * @param policy_h Pointer to store the horizontal scrollbar policy.
17207     * @param policy_v Pointer to store the vertical scrollbar policy.
17208     *
17209     * @see elm_genlist_scroller_policy_set()
17210     *
17211     * @ingroup Genlist
17212     */
17213    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);
17214    /**
17215     * Get the @b next item in a genlist widget's internal list of items,
17216     * given a handle to one of those items.
17217     *
17218     * @param item The genlist item to fetch next from
17219     * @return The item after @p item, or @c NULL if there's none (and
17220     * on errors)
17221     *
17222     * This returns the item placed after the @p item, on the container
17223     * genlist.
17224     *
17225     * @see elm_genlist_item_prev_get()
17226     *
17227     * @ingroup Genlist
17228     */
17229    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17230    /**
17231     * Get the @b previous item in a genlist widget's internal list of items,
17232     * given a handle to one of those items.
17233     *
17234     * @param item The genlist item to fetch previous from
17235     * @return The item before @p item, or @c NULL if there's none (and
17236     * on errors)
17237     *
17238     * This returns the item placed before the @p item, on the container
17239     * genlist.
17240     *
17241     * @see elm_genlist_item_next_get()
17242     *
17243     * @ingroup Genlist
17244     */
17245    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17246    /**
17247     * Get the genlist object's handle which contains a given genlist
17248     * item
17249     *
17250     * @param item The item to fetch the container from
17251     * @return The genlist (parent) object
17252     *
17253     * This returns the genlist object itself that an item belongs to.
17254     *
17255     * @ingroup Genlist
17256     */
17257    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17258    /**
17259     * Get the parent item of the given item
17260     *
17261     * @param it The item
17262     * @return The parent of the item or @c NULL if it has no parent.
17263     *
17264     * This returns the item that was specified as parent of the item @p it on
17265     * elm_genlist_item_append() and insertion related functions.
17266     *
17267     * @ingroup Genlist
17268     */
17269    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17270    /**
17271     * Remove all sub-items (children) of the given item
17272     *
17273     * @param it The item
17274     *
17275     * This removes all items that are children (and their descendants) of the
17276     * given item @p it.
17277     *
17278     * @see elm_genlist_clear()
17279     * @see elm_genlist_item_del()
17280     *
17281     * @ingroup Genlist
17282     */
17283    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17284    /**
17285     * Set whether a given genlist item is selected or not
17286     *
17287     * @param it The item
17288     * @param selected Use @c EINA_TRUE, to make it selected, @c
17289     * EINA_FALSE to make it unselected
17290     *
17291     * This sets the selected state of an item. If multi selection is
17292     * not enabled on the containing genlist and @p selected is @c
17293     * EINA_TRUE, any other previously selected items will get
17294     * unselected in favor of this new one.
17295     *
17296     * @see elm_genlist_item_selected_get()
17297     *
17298     * @ingroup Genlist
17299     */
17300    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17301    /**
17302     * Get whether a given genlist item is selected or not
17303     *
17304     * @param it The item
17305     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17306     *
17307     * @see elm_genlist_item_selected_set() for more details
17308     *
17309     * @ingroup Genlist
17310     */
17311    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17312    /**
17313     * Sets the expanded state of an item.
17314     *
17315     * @param it The item
17316     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17317     *
17318     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17319     * expanded or not.
17320     *
17321     * The theme will respond to this change visually, and a signal "expanded" or
17322     * "contracted" will be sent from the genlist with a pointer to the item that
17323     * has been expanded/contracted.
17324     *
17325     * Calling this function won't show or hide any child of this item (if it is
17326     * a parent). You must manually delete and create them on the callbacks fo
17327     * the "expanded" or "contracted" signals.
17328     *
17329     * @see elm_genlist_item_expanded_get()
17330     *
17331     * @ingroup Genlist
17332     */
17333    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17334    /**
17335     * Get the expanded state of an item
17336     *
17337     * @param it The item
17338     * @return The expanded state
17339     *
17340     * This gets the expanded state of an item.
17341     *
17342     * @see elm_genlist_item_expanded_set()
17343     *
17344     * @ingroup Genlist
17345     */
17346    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17347    /**
17348     * Get the depth of expanded item
17349     *
17350     * @param it The genlist item object
17351     * @return The depth of expanded item
17352     *
17353     * @ingroup Genlist
17354     */
17355    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17356    /**
17357     * Set whether a given genlist item is disabled or not.
17358     *
17359     * @param it The item
17360     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17361     * to enable it back.
17362     *
17363     * A disabled item cannot be selected or unselected. It will also
17364     * change its appearance, to signal the user it's disabled.
17365     *
17366     * @see elm_genlist_item_disabled_get()
17367     *
17368     * @ingroup Genlist
17369     */
17370    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17371    /**
17372     * Get whether a given genlist item is disabled or not.
17373     *
17374     * @param it The item
17375     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17376     * (and on errors).
17377     *
17378     * @see elm_genlist_item_disabled_set() for more details
17379     *
17380     * @ingroup Genlist
17381     */
17382    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17383    /**
17384     * Sets the display only state of an item.
17385     *
17386     * @param it The item
17387     * @param display_only @c EINA_TRUE if the item is display only, @c
17388     * EINA_FALSE otherwise.
17389     *
17390     * A display only item cannot be selected or unselected. It is for
17391     * display only and not selecting or otherwise clicking, dragging
17392     * etc. by the user, thus finger size rules will not be applied to
17393     * this item.
17394     *
17395     * It's good to set group index items to display only state.
17396     *
17397     * @see elm_genlist_item_display_only_get()
17398     *
17399     * @ingroup Genlist
17400     */
17401    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17402    /**
17403     * Get the display only state of an item
17404     *
17405     * @param it The item
17406     * @return @c EINA_TRUE if the item is display only, @c
17407     * EINA_FALSE otherwise.
17408     *
17409     * @see elm_genlist_item_display_only_set()
17410     *
17411     * @ingroup Genlist
17412     */
17413    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17414    /**
17415     * Show the portion of a genlist's internal list containing a given
17416     * item, immediately.
17417     *
17418     * @param it The item to display
17419     *
17420     * This causes genlist to jump to the given item @p it and show it (by
17421     * immediately scrolling to that position), if it is not fully visible.
17422     *
17423     * @see elm_genlist_item_bring_in()
17424     * @see elm_genlist_item_top_show()
17425     * @see elm_genlist_item_middle_show()
17426     *
17427     * @ingroup Genlist
17428     */
17429    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17430    /**
17431     * Animatedly bring in, to the visible are of a genlist, a given
17432     * item on it.
17433     *
17434     * @param it The item to display
17435     *
17436     * This causes genlist to jump to the given item @p it and show it (by
17437     * animatedly scrolling), if it is not fully visible. This may use animation
17438     * to do so and take a period of time
17439     *
17440     * @see elm_genlist_item_show()
17441     * @see elm_genlist_item_top_bring_in()
17442     * @see elm_genlist_item_middle_bring_in()
17443     *
17444     * @ingroup Genlist
17445     */
17446    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17447    /**
17448     * Show the portion of a genlist's internal list containing a given
17449     * item, immediately.
17450     *
17451     * @param it The item to display
17452     *
17453     * This causes genlist to jump to the given item @p it and show it (by
17454     * immediately scrolling to that position), if it is not fully visible.
17455     *
17456     * The item will be positioned at the top of the genlist viewport.
17457     *
17458     * @see elm_genlist_item_show()
17459     * @see elm_genlist_item_top_bring_in()
17460     *
17461     * @ingroup Genlist
17462     */
17463    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17464    /**
17465     * Animatedly bring in, to the visible are of a genlist, a given
17466     * item on it.
17467     *
17468     * @param it The item
17469     *
17470     * This causes genlist to jump to the given item @p it and show it (by
17471     * animatedly scrolling), if it is not fully visible. This may use animation
17472     * to do so and take a period of time
17473     *
17474     * The item will be positioned at the top of the genlist viewport.
17475     *
17476     * @see elm_genlist_item_bring_in()
17477     * @see elm_genlist_item_top_show()
17478     *
17479     * @ingroup Genlist
17480     */
17481    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17482    /**
17483     * Show the portion of a genlist's internal list containing a given
17484     * item, immediately.
17485     *
17486     * @param it The item to display
17487     *
17488     * This causes genlist to jump to the given item @p it and show it (by
17489     * immediately scrolling to that position), if it is not fully visible.
17490     *
17491     * The item will be positioned at the middle of the genlist viewport.
17492     *
17493     * @see elm_genlist_item_show()
17494     * @see elm_genlist_item_middle_bring_in()
17495     *
17496     * @ingroup Genlist
17497     */
17498    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17499    /**
17500     * Animatedly bring in, to the visible are of a genlist, a given
17501     * item on it.
17502     *
17503     * @param it The item
17504     *
17505     * This causes genlist to jump to the given item @p it and show it (by
17506     * animatedly scrolling), if it is not fully visible. This may use animation
17507     * to do so and take a period of time
17508     *
17509     * The item will be positioned at the middle of the genlist viewport.
17510     *
17511     * @see elm_genlist_item_bring_in()
17512     * @see elm_genlist_item_middle_show()
17513     *
17514     * @ingroup Genlist
17515     */
17516    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17517    /**
17518     * Remove a genlist item from the its parent, deleting it.
17519     *
17520     * @param item The item to be removed.
17521     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17522     *
17523     * @see elm_genlist_clear(), to remove all items in a genlist at
17524     * once.
17525     *
17526     * @ingroup Genlist
17527     */
17528    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17529    /**
17530     * Return the data associated to a given genlist item
17531     *
17532     * @param item The genlist item.
17533     * @return the data associated to this item.
17534     *
17535     * This returns the @c data value passed on the
17536     * elm_genlist_item_append() and related item addition calls.
17537     *
17538     * @see elm_genlist_item_append()
17539     * @see elm_genlist_item_data_set()
17540     *
17541     * @ingroup Genlist
17542     */
17543    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17544    /**
17545     * Set the data associated to a given genlist item
17546     *
17547     * @param item The genlist item
17548     * @param data The new data pointer to set on it
17549     *
17550     * This @b overrides the @c data value passed on the
17551     * elm_genlist_item_append() and related item addition calls. This
17552     * function @b won't call elm_genlist_item_update() automatically,
17553     * so you'd issue it afterwards if you want to hove the item
17554     * updated to reflect the that new data.
17555     *
17556     * @see elm_genlist_item_data_get()
17557     *
17558     * @ingroup Genlist
17559     */
17560    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17561    /**
17562     * Tells genlist to "orphan" icons fetchs by the item class
17563     *
17564     * @param it The item
17565     *
17566     * This instructs genlist to release references to icons in the item,
17567     * meaning that they will no longer be managed by genlist and are
17568     * floating "orphans" that can be re-used elsewhere if the user wants
17569     * to.
17570     *
17571     * @ingroup Genlist
17572     */
17573    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17574    /**
17575     * Get the real Evas object created to implement the view of a
17576     * given genlist item
17577     *
17578     * @param item The genlist item.
17579     * @return the Evas object implementing this item's view.
17580     *
17581     * This returns the actual Evas object used to implement the
17582     * specified genlist item's view. This may be @c NULL, as it may
17583     * not have been created or may have been deleted, at any time, by
17584     * the genlist. <b>Do not modify this object</b> (move, resize,
17585     * show, hide, etc.), as the genlist is controlling it. This
17586     * function is for querying, emitting custom signals or hooking
17587     * lower level callbacks for events on that object. Do not delete
17588     * this object under any circumstances.
17589     *
17590     * @see elm_genlist_item_data_get()
17591     *
17592     * @ingroup Genlist
17593     */
17594    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17595    /**
17596     * Update the contents of an item
17597     *
17598     * @param it The item
17599     *
17600     * This updates an item by calling all the item class functions again
17601     * to get the icons, labels and states. Use this when the original
17602     * item data has changed and the changes are desired to be reflected.
17603     *
17604     * Use elm_genlist_realized_items_update() to update all already realized
17605     * items.
17606     *
17607     * @see elm_genlist_realized_items_update()
17608     *
17609     * @ingroup Genlist
17610     */
17611    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17612    /**
17613     * Update the item class of an item
17614     *
17615     * @param it The item
17616     * @param itc The item class for the item
17617     *
17618     * This sets another class fo the item, changing the way that it is
17619     * displayed. After changing the item class, elm_genlist_item_update() is
17620     * called on the item @p it.
17621     *
17622     * @ingroup Genlist
17623     */
17624    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17625    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17626    /**
17627     * Set the text to be shown in a given genlist item's tooltips.
17628     *
17629     * @param item The genlist item
17630     * @param text The text to set in the content
17631     *
17632     * This call will setup the text to be used as tooltip to that item
17633     * (analogous to elm_object_tooltip_text_set(), but being item
17634     * tooltips with higher precedence than object tooltips). It can
17635     * have only one tooltip at a time, so any previous tooltip data
17636     * will get removed.
17637     *
17638     * In order to set an icon or something else as a tooltip, look at
17639     * elm_genlist_item_tooltip_content_cb_set().
17640     *
17641     * @ingroup Genlist
17642     */
17643    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17644    /**
17645     * Set the content to be shown in a given genlist item's tooltips
17646     *
17647     * @param item The genlist item.
17648     * @param func The function returning the tooltip contents.
17649     * @param data What to provide to @a func as callback data/context.
17650     * @param del_cb Called when data is not needed anymore, either when
17651     *        another callback replaces @p func, the tooltip is unset with
17652     *        elm_genlist_item_tooltip_unset() or the owner @p item
17653     *        dies. This callback receives as its first parameter the
17654     *        given @p data, being @c event_info the item handle.
17655     *
17656     * This call will setup the tooltip's contents to @p item
17657     * (analogous to elm_object_tooltip_content_cb_set(), but being
17658     * item tooltips with higher precedence than object tooltips). It
17659     * can have only one tooltip at a time, so any previous tooltip
17660     * content will get removed. @p func (with @p data) will be called
17661     * every time Elementary needs to show the tooltip and it should
17662     * return a valid Evas object, which will be fully managed by the
17663     * tooltip system, getting deleted when the tooltip is gone.
17664     *
17665     * In order to set just a text as a tooltip, look at
17666     * elm_genlist_item_tooltip_text_set().
17667     *
17668     * @ingroup Genlist
17669     */
17670    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);
17671    /**
17672     * Unset a tooltip from a given genlist item
17673     *
17674     * @param item genlist item to remove a previously set tooltip from.
17675     *
17676     * This call removes any tooltip set on @p item. The callback
17677     * provided as @c del_cb to
17678     * elm_genlist_item_tooltip_content_cb_set() will be called to
17679     * notify it is not used anymore (and have resources cleaned, if
17680     * need be).
17681     *
17682     * @see elm_genlist_item_tooltip_content_cb_set()
17683     *
17684     * @ingroup Genlist
17685     */
17686    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17687    /**
17688     * Set a different @b style for a given genlist item's tooltip.
17689     *
17690     * @param item genlist item with tooltip set
17691     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17692     * "default", @c "transparent", etc)
17693     *
17694     * Tooltips can have <b>alternate styles</b> to be displayed on,
17695     * which are defined by the theme set on Elementary. This function
17696     * works analogously as elm_object_tooltip_style_set(), but here
17697     * applied only to genlist item objects. The default style for
17698     * tooltips is @c "default".
17699     *
17700     * @note before you set a style you should define a tooltip with
17701     *       elm_genlist_item_tooltip_content_cb_set() or
17702     *       elm_genlist_item_tooltip_text_set()
17703     *
17704     * @see elm_genlist_item_tooltip_style_get()
17705     *
17706     * @ingroup Genlist
17707     */
17708    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17709    /**
17710     * Get the style set a given genlist item's tooltip.
17711     *
17712     * @param item genlist item with tooltip already set on.
17713     * @return style the theme style in use, which defaults to
17714     *         "default". If the object does not have a tooltip set,
17715     *         then @c NULL is returned.
17716     *
17717     * @see elm_genlist_item_tooltip_style_set() for more details
17718     *
17719     * @ingroup Genlist
17720     */
17721    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17722    /**
17723     * @brief Disable size restrictions on an object's tooltip
17724     * @param item The tooltip's anchor object
17725     * @param disable If EINA_TRUE, size restrictions are disabled
17726     * @return EINA_FALSE on failure, EINA_TRUE on success
17727     *
17728     * This function allows a tooltip to expand beyond its parant window's canvas.
17729     * It will instead be limited only by the size of the display.
17730     */
17731    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17732    /**
17733     * @brief Retrieve size restriction state of an object's tooltip
17734     * @param item The tooltip's anchor object
17735     * @return If EINA_TRUE, size restrictions are disabled
17736     *
17737     * This function returns whether a tooltip is allowed to expand beyond
17738     * its parant window's canvas.
17739     * It will instead be limited only by the size of the display.
17740     */
17741    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17742    /**
17743     * Set the type of mouse pointer/cursor decoration to be shown,
17744     * when the mouse pointer is over the given genlist widget item
17745     *
17746     * @param item genlist item to customize cursor on
17747     * @param cursor the cursor type's name
17748     *
17749     * This function works analogously as elm_object_cursor_set(), but
17750     * here the cursor's changing area is restricted to the item's
17751     * area, and not the whole widget's. Note that that item cursors
17752     * have precedence over widget cursors, so that a mouse over @p
17753     * item will always show cursor @p type.
17754     *
17755     * If this function is called twice for an object, a previously set
17756     * cursor will be unset on the second call.
17757     *
17758     * @see elm_object_cursor_set()
17759     * @see elm_genlist_item_cursor_get()
17760     * @see elm_genlist_item_cursor_unset()
17761     *
17762     * @ingroup Genlist
17763     */
17764    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17765    /**
17766     * Get the type of mouse pointer/cursor decoration set to be shown,
17767     * when the mouse pointer is over the given genlist widget item
17768     *
17769     * @param item genlist item with custom cursor set
17770     * @return the cursor type's name or @c NULL, if no custom cursors
17771     * were set to @p item (and on errors)
17772     *
17773     * @see elm_object_cursor_get()
17774     * @see elm_genlist_item_cursor_set() for more details
17775     * @see elm_genlist_item_cursor_unset()
17776     *
17777     * @ingroup Genlist
17778     */
17779    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17780    /**
17781     * Unset any custom mouse pointer/cursor decoration set to be
17782     * shown, when the mouse pointer is over the given genlist widget
17783     * item, thus making it show the @b default cursor again.
17784     *
17785     * @param item a genlist item
17786     *
17787     * Use this call to undo any custom settings on this item's cursor
17788     * decoration, bringing it back to defaults (no custom style set).
17789     *
17790     * @see elm_object_cursor_unset()
17791     * @see elm_genlist_item_cursor_set() for more details
17792     *
17793     * @ingroup Genlist
17794     */
17795    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17796    /**
17797     * Set a different @b style for a given custom cursor set for a
17798     * genlist item.
17799     *
17800     * @param item genlist item with custom cursor set
17801     * @param style the <b>theme style</b> to use (e.g. @c "default",
17802     * @c "transparent", etc)
17803     *
17804     * This function only makes sense when one is using custom mouse
17805     * cursor decorations <b>defined in a theme file</b> , which can
17806     * have, given a cursor name/type, <b>alternate styles</b> on
17807     * it. It works analogously as elm_object_cursor_style_set(), but
17808     * here applied only to genlist item objects.
17809     *
17810     * @warning Before you set a cursor style you should have defined a
17811     *       custom cursor previously on the item, with
17812     *       elm_genlist_item_cursor_set()
17813     *
17814     * @see elm_genlist_item_cursor_engine_only_set()
17815     * @see elm_genlist_item_cursor_style_get()
17816     *
17817     * @ingroup Genlist
17818     */
17819    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17820    /**
17821     * Get the current @b style set for a given genlist item's custom
17822     * cursor
17823     *
17824     * @param item genlist item with custom cursor set.
17825     * @return style the cursor style in use. If the object does not
17826     *         have a cursor set, then @c NULL is returned.
17827     *
17828     * @see elm_genlist_item_cursor_style_set() for more details
17829     *
17830     * @ingroup Genlist
17831     */
17832    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17833    /**
17834     * Set if the (custom) cursor for a given genlist item should be
17835     * searched in its theme, also, or should only rely on the
17836     * rendering engine.
17837     *
17838     * @param item item with custom (custom) cursor already set on
17839     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17840     * only on those provided by the rendering engine, @c EINA_FALSE to
17841     * have them searched on the widget's theme, as well.
17842     *
17843     * @note This call is of use only if you've set a custom cursor
17844     * for genlist items, with elm_genlist_item_cursor_set().
17845     *
17846     * @note By default, cursors will only be looked for between those
17847     * provided by the rendering engine.
17848     *
17849     * @ingroup Genlist
17850     */
17851    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17852    /**
17853     * Get if the (custom) cursor for a given genlist item is being
17854     * searched in its theme, also, or is only relying on the rendering
17855     * engine.
17856     *
17857     * @param item a genlist item
17858     * @return @c EINA_TRUE, if cursors are being looked for only on
17859     * those provided by the rendering engine, @c EINA_FALSE if they
17860     * are being searched on the widget's theme, as well.
17861     *
17862     * @see elm_genlist_item_cursor_engine_only_set(), for more details
17863     *
17864     * @ingroup Genlist
17865     */
17866    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17867    /**
17868     * Update the contents of all realized items.
17869     *
17870     * @param obj The genlist object.
17871     *
17872     * This updates all realized items by calling all the item class functions again
17873     * to get the icons, labels and states. Use this when the original
17874     * item data has changed and the changes are desired to be reflected.
17875     *
17876     * To update just one item, use elm_genlist_item_update().
17877     *
17878     * @see elm_genlist_realized_items_get()
17879     * @see elm_genlist_item_update()
17880     *
17881     * @ingroup Genlist
17882     */
17883    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17884    /**
17885     * Activate a genlist mode on an item
17886     *
17887     * @param item The genlist item
17888     * @param mode Mode name
17889     * @param mode_set Boolean to define set or unset mode.
17890     *
17891     * A genlist mode is a different way of selecting an item. Once a mode is
17892     * activated on an item, any other selected item is immediately unselected.
17893     * This feature provides an easy way of implementing a new kind of animation
17894     * for selecting an item, without having to entirely rewrite the item style
17895     * theme. However, the elm_genlist_selected_* API can't be used to get what
17896     * item is activate for a mode.
17897     *
17898     * The current item style will still be used, but applying a genlist mode to
17899     * an item will select it using a different kind of animation.
17900     *
17901     * The current active item for a mode can be found by
17902     * elm_genlist_mode_item_get().
17903     *
17904     * The characteristics of genlist mode are:
17905     * - Only one mode can be active at any time, and for only one item.
17906     * - Genlist handles deactivating other items when one item is activated.
17907     * - A mode is defined in the genlist theme (edc), and more modes can easily
17908     *   be added.
17909     * - A mode style and the genlist item style are different things. They
17910     *   can be combined to provide a default style to the item, with some kind
17911     *   of animation for that item when the mode is activated.
17912     *
17913     * When a mode is activated on an item, a new view for that item is created.
17914     * The theme of this mode defines the animation that will be used to transit
17915     * the item from the old view to the new view. This second (new) view will be
17916     * active for that item while the mode is active on the item, and will be
17917     * destroyed after the mode is totally deactivated from that item.
17918     *
17919     * @see elm_genlist_mode_get()
17920     * @see elm_genlist_mode_item_get()
17921     *
17922     * @ingroup Genlist
17923     */
17924    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
17925    /**
17926     * Get the last (or current) genlist mode used.
17927     *
17928     * @param obj The genlist object
17929     *
17930     * This function just returns the name of the last used genlist mode. It will
17931     * be the current mode if it's still active.
17932     *
17933     * @see elm_genlist_item_mode_set()
17934     * @see elm_genlist_mode_item_get()
17935     *
17936     * @ingroup Genlist
17937     */
17938    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17939    /**
17940     * Get active genlist mode item
17941     *
17942     * @param obj The genlist object
17943     * @return The active item for that current mode. Or @c NULL if no item is
17944     * activated with any mode.
17945     *
17946     * This function returns the item that was activated with a mode, by the
17947     * function elm_genlist_item_mode_set().
17948     *
17949     * @see elm_genlist_item_mode_set()
17950     * @see elm_genlist_mode_get()
17951     *
17952     * @ingroup Genlist
17953     */
17954    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17955
17956    /**
17957     * Set reorder mode
17958     *
17959     * @param obj The genlist object
17960     * @param reorder_mode The reorder mode
17961     * (EINA_TRUE = on, EINA_FALSE = off)
17962     *
17963     * @ingroup Genlist
17964     */
17965    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
17966
17967    /**
17968     * Get the reorder mode
17969     *
17970     * @param obj The genlist object
17971     * @return The reorder mode
17972     * (EINA_TRUE = on, EINA_FALSE = off)
17973     *
17974     * @ingroup Genlist
17975     */
17976    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17977
17978    /**
17979     * @}
17980     */
17981
17982    /**
17983     * @defgroup Check Check
17984     *
17985     * @image html img/widget/check/preview-00.png
17986     * @image latex img/widget/check/preview-00.eps
17987     * @image html img/widget/check/preview-01.png
17988     * @image latex img/widget/check/preview-01.eps
17989     * @image html img/widget/check/preview-02.png
17990     * @image latex img/widget/check/preview-02.eps
17991     *
17992     * @brief The check widget allows for toggling a value between true and
17993     * false.
17994     *
17995     * Check objects are a lot like radio objects in layout and functionality
17996     * except they do not work as a group, but independently and only toggle the
17997     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
17998     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
17999     * returns the current state. For convenience, like the radio objects, you
18000     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18001     * for it to modify.
18002     *
18003     * Signals that you can add callbacks for are:
18004     * "changed" - This is called whenever the user changes the state of one of
18005     *             the check object(event_info is NULL).
18006     *
18007     * @ref tutorial_check should give you a firm grasp of how to use this widget.
18008     * @{
18009     */
18010    /**
18011     * @brief Add a new Check object
18012     *
18013     * @param parent The parent object
18014     * @return The new object or NULL if it cannot be created
18015     */
18016    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18017    /**
18018     * @brief Set the text label of the check object
18019     *
18020     * @param obj The check object
18021     * @param label The text label string in UTF-8
18022     *
18023     * @deprecated use elm_object_text_set() instead.
18024     */
18025    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18026    /**
18027     * @brief Get the text label of the check object
18028     *
18029     * @param obj The check object
18030     * @return The text label string in UTF-8
18031     *
18032     * @deprecated use elm_object_text_get() instead.
18033     */
18034    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18035    /**
18036     * @brief Set the icon object of the check object
18037     *
18038     * @param obj The check object
18039     * @param icon The icon object
18040     *
18041     * Once the icon object is set, a previously set one will be deleted.
18042     * If you want to keep that old content object, use the
18043     * elm_check_icon_unset() function.
18044     */
18045    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18046    /**
18047     * @brief Get the icon object of the check object
18048     *
18049     * @param obj The check object
18050     * @return The icon object
18051     */
18052    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18053    /**
18054     * @brief Unset the icon used for the check object
18055     *
18056     * @param obj The check object
18057     * @return The icon object that was being used
18058     *
18059     * Unparent and return the icon object which was set for this widget.
18060     */
18061    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18062    /**
18063     * @brief Set the on/off state of the check object
18064     *
18065     * @param obj The check object
18066     * @param state The state to use (1 == on, 0 == off)
18067     *
18068     * This sets the state of the check. If set
18069     * with elm_check_state_pointer_set() the state of that variable is also
18070     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18071     */
18072    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18073    /**
18074     * @brief Get the state of the check object
18075     *
18076     * @param obj The check object
18077     * @return The boolean state
18078     */
18079    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18080    /**
18081     * @brief Set a convenience pointer to a boolean to change
18082     *
18083     * @param obj The check object
18084     * @param statep Pointer to the boolean to modify
18085     *
18086     * This sets a pointer to a boolean, that, in addition to the check objects
18087     * state will also be modified directly. To stop setting the object pointed
18088     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18089     * then when this is called, the check objects state will also be modified to
18090     * reflect the value of the boolean @p statep points to, just like calling
18091     * elm_check_state_set().
18092     */
18093    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18094    /**
18095     * @}
18096     */
18097
18098    /**
18099     * @defgroup Radio Radio
18100     *
18101     * @image html img/widget/radio/preview-00.png
18102     * @image latex img/widget/radio/preview-00.eps
18103     *
18104     * @brief Radio is a widget that allows for 1 or more options to be displayed
18105     * and have the user choose only 1 of them.
18106     *
18107     * A radio object contains an indicator, an optional Label and an optional
18108     * icon object. While it's possible to have a group of only one radio they,
18109     * are normally used in groups of 2 or more. To add a radio to a group use
18110     * elm_radio_group_add(). The radio object(s) will select from one of a set
18111     * of integer values, so any value they are configuring needs to be mapped to
18112     * a set of integers. To configure what value that radio object represents,
18113     * use  elm_radio_state_value_set() to set the integer it represents. To set
18114     * the value the whole group(which one is currently selected) is to indicate
18115     * use elm_radio_value_set() on any group member, and to get the groups value
18116     * use elm_radio_value_get(). For convenience the radio objects are also able
18117     * to directly set an integer(int) to the value that is selected. To specify
18118     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18119     * The radio objects will modify this directly. That implies the pointer must
18120     * point to valid memory for as long as the radio objects exist.
18121     *
18122     * Signals that you can add callbacks for are:
18123     * @li changed - This is called whenever the user changes the state of one of
18124     * the radio objects within the group of radio objects that work together.
18125     *
18126     * @ref tutorial_radio show most of this API in action.
18127     * @{
18128     */
18129    /**
18130     * @brief Add a new radio to the parent
18131     *
18132     * @param parent The parent object
18133     * @return The new object or NULL if it cannot be created
18134     */
18135    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18136    /**
18137     * @brief Set the text label of the radio object
18138     *
18139     * @param obj The radio object
18140     * @param label The text label string in UTF-8
18141     *
18142     * @deprecated use elm_object_text_set() instead.
18143     */
18144    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18145    /**
18146     * @brief Get the text label of the radio object
18147     *
18148     * @param obj The radio object
18149     * @return The text label string in UTF-8
18150     *
18151     * @deprecated use elm_object_text_set() instead.
18152     */
18153    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18154    /**
18155     * @brief Set the icon object of the radio object
18156     *
18157     * @param obj The radio object
18158     * @param icon The icon object
18159     *
18160     * Once the icon object is set, a previously set one will be deleted. If you
18161     * want to keep that old content object, use the elm_radio_icon_unset()
18162     * function.
18163     */
18164    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18165    /**
18166     * @brief Get the icon object of the radio object
18167     *
18168     * @param obj The radio object
18169     * @return The icon object
18170     *
18171     * @see elm_radio_icon_set()
18172     */
18173    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18174    /**
18175     * @brief Unset the icon used for the radio object
18176     *
18177     * @param obj The radio object
18178     * @return The icon object that was being used
18179     *
18180     * Unparent and return the icon object which was set for this widget.
18181     *
18182     * @see elm_radio_icon_set()
18183     */
18184    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18185    /**
18186     * @brief Add this radio to a group of other radio objects
18187     *
18188     * @param obj The radio object
18189     * @param group Any object whose group the @p obj is to join.
18190     *
18191     * Radio objects work in groups. Each member should have a different integer
18192     * value assigned. In order to have them work as a group, they need to know
18193     * about each other. This adds the given radio object to the group of which
18194     * the group object indicated is a member.
18195     */
18196    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18197    /**
18198     * @brief Set the integer value that this radio object represents
18199     *
18200     * @param obj The radio object
18201     * @param value The value to use if this radio object is selected
18202     *
18203     * This sets the value of the radio.
18204     */
18205    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18206    /**
18207     * @brief Get the integer value that this radio object represents
18208     *
18209     * @param obj The radio object
18210     * @return The value used if this radio object is selected
18211     *
18212     * This gets the value of the radio.
18213     *
18214     * @see elm_radio_value_set()
18215     */
18216    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18217    /**
18218     * @brief Set the value of the radio.
18219     *
18220     * @param obj The radio object
18221     * @param value The value to use for the group
18222     *
18223     * This sets the value of the radio group and will also set the value if
18224     * pointed to, to the value supplied, but will not call any callbacks.
18225     */
18226    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18227    /**
18228     * @brief Get the state of the radio object
18229     *
18230     * @param obj The radio object
18231     * @return The integer state
18232     */
18233    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18234    /**
18235     * @brief Set a convenience pointer to a integer to change
18236     *
18237     * @param obj The radio object
18238     * @param valuep Pointer to the integer to modify
18239     *
18240     * This sets a pointer to a integer, that, in addition to the radio objects
18241     * state will also be modified directly. To stop setting the object pointed
18242     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18243     * when this is called, the radio objects state will also be modified to
18244     * reflect the value of the integer valuep points to, just like calling
18245     * elm_radio_value_set().
18246     */
18247    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18248    /**
18249     * @}
18250     */
18251
18252    /**
18253     * @defgroup Pager Pager
18254     *
18255     * @image html img/widget/pager/preview-00.png
18256     * @image latex img/widget/pager/preview-00.eps
18257     *
18258     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18259     *
18260     * The flipping between “pages” of objects is animated. All content in pager
18261     * is kept in a stack, the last content to be added will be on the top of the
18262     * stack(be visible).
18263     *
18264     * Objects can be pushed or popped from the stack or deleted as normal.
18265     * Pushes and pops will animate (and a pop will delete the object once the
18266     * animation is finished). Any object already in the pager can be promoted to
18267     * the top(from its current stacking position) through the use of
18268     * elm_pager_content_promote(). Objects are pushed to the top with
18269     * elm_pager_content_push() and when the top item is no longer wanted, simply
18270     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18271     * object is no longer needed and is not the top item, just delete it as
18272     * normal. You can query which objects are the top and bottom with
18273     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18274     *
18275     * Signals that you can add callbacks for are:
18276     * "hide,finished" - when the previous page is hided
18277     *
18278     * This widget has the following styles available:
18279     * @li default
18280     * @li fade
18281     * @li fade_translucide
18282     * @li fade_invisible
18283     * @note This styles affect only the flipping animations, the appearance when
18284     * not animating is unaffected by styles.
18285     *
18286     * @ref tutorial_pager gives a good overview of the usage of the API.
18287     * @{
18288     */
18289    /**
18290     * Add a new pager to the parent
18291     *
18292     * @param parent The parent object
18293     * @return The new object or NULL if it cannot be created
18294     *
18295     * @ingroup Pager
18296     */
18297    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18298    /**
18299     * @brief Push an object to the top of the pager stack (and show it).
18300     *
18301     * @param obj The pager object
18302     * @param content The object to push
18303     *
18304     * The object pushed becomes a child of the pager, it will be controlled and
18305     * deleted when the pager is deleted.
18306     *
18307     * @note If the content is already in the stack use
18308     * elm_pager_content_promote().
18309     * @warning Using this function on @p content already in the stack results in
18310     * undefined behavior.
18311     */
18312    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18313    /**
18314     * @brief Pop the object that is on top of the stack
18315     *
18316     * @param obj The pager object
18317     *
18318     * This pops the object that is on the top(visible) of the pager, makes it
18319     * disappear, then deletes the object. The object that was underneath it on
18320     * the stack will become visible.
18321     */
18322    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18323    /**
18324     * @brief Moves an object already in the pager stack to the top of the stack.
18325     *
18326     * @param obj The pager object
18327     * @param content The object to promote
18328     *
18329     * This will take the @p content and move it to the top of the stack as
18330     * if it had been pushed there.
18331     *
18332     * @note If the content isn't already in the stack use
18333     * elm_pager_content_push().
18334     * @warning Using this function on @p content not already in the stack
18335     * results in undefined behavior.
18336     */
18337    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18338    /**
18339     * @brief Return the object at the bottom of the pager stack
18340     *
18341     * @param obj The pager object
18342     * @return The bottom object or NULL if none
18343     */
18344    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18345    /**
18346     * @brief  Return the object at the top of the pager stack
18347     *
18348     * @param obj The pager object
18349     * @return The top object or NULL if none
18350     */
18351    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18352    /**
18353     * @}
18354     */
18355
18356    /**
18357     * @defgroup Slideshow Slideshow
18358     *
18359     * @image html img/widget/slideshow/preview-00.png
18360     * @image latex img/widget/slideshow/preview-00.eps
18361     *
18362     * This widget, as the name indicates, is a pre-made image
18363     * slideshow panel, with API functions acting on (child) image
18364     * items presentation. Between those actions, are:
18365     * - advance to next/previous image
18366     * - select the style of image transition animation
18367     * - set the exhibition time for each image
18368     * - start/stop the slideshow
18369     *
18370     * The transition animations are defined in the widget's theme,
18371     * consequently new animations can be added without having to
18372     * update the widget's code.
18373     *
18374     * @section Slideshow_Items Slideshow items
18375     *
18376     * For slideshow items, just like for @ref Genlist "genlist" ones,
18377     * the user defines a @b classes, specifying functions that will be
18378     * called on the item's creation and deletion times.
18379     *
18380     * The #Elm_Slideshow_Item_Class structure contains the following
18381     * members:
18382     *
18383     * - @c func.get - When an item is displayed, this function is
18384     *   called, and it's where one should create the item object, de
18385     *   facto. For example, the object can be a pure Evas image object
18386     *   or an Elementary @ref Photocam "photocam" widget. See
18387     *   #SlideshowItemGetFunc.
18388     * - @c func.del - When an item is no more displayed, this function
18389     *   is called, where the user must delete any data associated to
18390     *   the item. See #SlideshowItemDelFunc.
18391     *
18392     * @section Slideshow_Caching Slideshow caching
18393     *
18394     * The slideshow provides facilities to have items adjacent to the
18395     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18396     * you, so that the system does not have to decode image data
18397     * anymore at the time it has to actually switch images on its
18398     * viewport. The user is able to set the numbers of items to be
18399     * cached @b before and @b after the current item, in the widget's
18400     * item list.
18401     *
18402     * Smart events one can add callbacks for are:
18403     *
18404     * - @c "changed" - when the slideshow switches its view to a new
18405     *   item
18406     *
18407     * List of examples for the slideshow widget:
18408     * @li @ref slideshow_example
18409     */
18410
18411    /**
18412     * @addtogroup Slideshow
18413     * @{
18414     */
18415
18416    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18417    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18418    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18419    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18420    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18421
18422    /**
18423     * @struct _Elm_Slideshow_Item_Class
18424     *
18425     * Slideshow item class definition. See @ref Slideshow_Items for
18426     * field details.
18427     */
18428    struct _Elm_Slideshow_Item_Class
18429      {
18430         struct _Elm_Slideshow_Item_Class_Func
18431           {
18432              SlideshowItemGetFunc get;
18433              SlideshowItemDelFunc del;
18434           } func;
18435      }; /**< #Elm_Slideshow_Item_Class member definitions */
18436
18437    /**
18438     * Add a new slideshow widget to the given parent Elementary
18439     * (container) object
18440     *
18441     * @param parent The parent object
18442     * @return A new slideshow widget handle or @c NULL, on errors
18443     *
18444     * This function inserts a new slideshow widget on the canvas.
18445     *
18446     * @ingroup Slideshow
18447     */
18448    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18449
18450    /**
18451     * Add (append) a new item in a given slideshow widget.
18452     *
18453     * @param obj The slideshow object
18454     * @param itc The item class for the item
18455     * @param data The item's data
18456     * @return A handle to the item added or @c NULL, on errors
18457     *
18458     * Add a new item to @p obj's internal list of items, appending it.
18459     * The item's class must contain the function really fetching the
18460     * image object to show for this item, which could be an Evas image
18461     * object or an Elementary photo, for example. The @p data
18462     * parameter is going to be passed to both class functions of the
18463     * item.
18464     *
18465     * @see #Elm_Slideshow_Item_Class
18466     * @see elm_slideshow_item_sorted_insert()
18467     *
18468     * @ingroup Slideshow
18469     */
18470    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18471
18472    /**
18473     * Insert a new item into the given slideshow widget, using the @p func
18474     * function to sort items (by item handles).
18475     *
18476     * @param obj The slideshow object
18477     * @param itc The item class for the item
18478     * @param data The item's data
18479     * @param func The comparing function to be used to sort slideshow
18480     * items <b>by #Elm_Slideshow_Item item handles</b>
18481     * @return Returns The slideshow item handle, on success, or
18482     * @c NULL, on errors
18483     *
18484     * Add a new item to @p obj's internal list of items, in a position
18485     * determined by the @p func comparing function. The item's class
18486     * must contain the function really fetching the image object to
18487     * show for this item, which could be an Evas image object or an
18488     * Elementary photo, for example. The @p data parameter is going to
18489     * be passed to both class functions of the item.
18490     *
18491     * @see #Elm_Slideshow_Item_Class
18492     * @see elm_slideshow_item_add()
18493     *
18494     * @ingroup Slideshow
18495     */
18496    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);
18497
18498    /**
18499     * Display a given slideshow widget's item, programmatically.
18500     *
18501     * @param obj The slideshow object
18502     * @param item The item to display on @p obj's viewport
18503     *
18504     * The change between the current item and @p item will use the
18505     * transition @p obj is set to use (@see
18506     * elm_slideshow_transition_set()).
18507     *
18508     * @ingroup Slideshow
18509     */
18510    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18511
18512    /**
18513     * Slide to the @b next item, in a given slideshow widget
18514     *
18515     * @param obj The slideshow object
18516     *
18517     * The sliding animation @p obj is set to use will be the
18518     * transition effect used, after this call is issued.
18519     *
18520     * @note If the end of the slideshow's internal list of items is
18521     * reached, it'll wrap around to the list's beginning, again.
18522     *
18523     * @ingroup Slideshow
18524     */
18525    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18526
18527    /**
18528     * Slide to the @b previous item, in a given slideshow widget
18529     *
18530     * @param obj The slideshow object
18531     *
18532     * The sliding animation @p obj is set to use will be the
18533     * transition effect used, after this call is issued.
18534     *
18535     * @note If the beginning of the slideshow's internal list of items
18536     * is reached, it'll wrap around to the list's end, again.
18537     *
18538     * @ingroup Slideshow
18539     */
18540    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18541
18542    /**
18543     * Returns the list of sliding transition/effect names available, for a
18544     * given slideshow widget.
18545     *
18546     * @param obj The slideshow object
18547     * @return The list of transitions (list of @b stringshared strings
18548     * as data)
18549     *
18550     * The transitions, which come from @p obj's theme, must be an EDC
18551     * data item named @c "transitions" on the theme file, with (prefix)
18552     * names of EDC programs actually implementing them.
18553     *
18554     * The available transitions for slideshows on the default theme are:
18555     * - @c "fade" - the current item fades out, while the new one
18556     *   fades in to the slideshow's viewport.
18557     * - @c "black_fade" - the current item fades to black, and just
18558     *   then, the new item will fade in.
18559     * - @c "horizontal" - the current item slides horizontally, until
18560     *   it gets out of the slideshow's viewport, while the new item
18561     *   comes from the left to take its place.
18562     * - @c "vertical" - the current item slides vertically, until it
18563     *   gets out of the slideshow's viewport, while the new item comes
18564     *   from the bottom to take its place.
18565     * - @c "square" - the new item starts to appear from the middle of
18566     *   the current one, but with a tiny size, growing until its
18567     *   target (full) size and covering the old one.
18568     *
18569     * @warning The stringshared strings get no new references
18570     * exclusive to the user grabbing the list, here, so if you'd like
18571     * to use them out of this call's context, you'd better @c
18572     * eina_stringshare_ref() them.
18573     *
18574     * @see elm_slideshow_transition_set()
18575     *
18576     * @ingroup Slideshow
18577     */
18578    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18579
18580    /**
18581     * Set the current slide transition/effect in use for a given
18582     * slideshow widget
18583     *
18584     * @param obj The slideshow object
18585     * @param transition The new transition's name string
18586     *
18587     * If @p transition is implemented in @p obj's theme (i.e., is
18588     * contained in the list returned by
18589     * elm_slideshow_transitions_get()), this new sliding effect will
18590     * be used on the widget.
18591     *
18592     * @see elm_slideshow_transitions_get() for more details
18593     *
18594     * @ingroup Slideshow
18595     */
18596    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18597
18598    /**
18599     * Get the current slide transition/effect in use for a given
18600     * slideshow widget
18601     *
18602     * @param obj The slideshow object
18603     * @return The current transition's name
18604     *
18605     * @see elm_slideshow_transition_set() for more details
18606     *
18607     * @ingroup Slideshow
18608     */
18609    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18610
18611    /**
18612     * Set the interval between each image transition on a given
18613     * slideshow widget, <b>and start the slideshow, itself</b>
18614     *
18615     * @param obj The slideshow object
18616     * @param timeout The new displaying timeout for images
18617     *
18618     * After this call, the slideshow widget will start cycling its
18619     * view, sequentially and automatically, with the images of the
18620     * items it has. The time between each new image displayed is going
18621     * to be @p timeout, in @b seconds. If a different timeout was set
18622     * previously and an slideshow was in progress, it will continue
18623     * with the new time between transitions, after this call.
18624     *
18625     * @note A value less than or equal to 0 on @p timeout will disable
18626     * the widget's internal timer, thus halting any slideshow which
18627     * could be happening on @p obj.
18628     *
18629     * @see elm_slideshow_timeout_get()
18630     *
18631     * @ingroup Slideshow
18632     */
18633    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18634
18635    /**
18636     * Get the interval set for image transitions on a given slideshow
18637     * widget.
18638     *
18639     * @param obj The slideshow object
18640     * @return Returns the timeout set on it
18641     *
18642     * @see elm_slideshow_timeout_set() for more details
18643     *
18644     * @ingroup Slideshow
18645     */
18646    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18647
18648    /**
18649     * Set if, after a slideshow is started, for a given slideshow
18650     * widget, its items should be displayed cyclically or not.
18651     *
18652     * @param obj The slideshow object
18653     * @param loop Use @c EINA_TRUE to make it cycle through items or
18654     * @c EINA_FALSE for it to stop at the end of @p obj's internal
18655     * list of items
18656     *
18657     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18658     * ignore what is set by this functions, i.e., they'll @b always
18659     * cycle through items. This affects only the "automatic"
18660     * slideshow, as set by elm_slideshow_timeout_set().
18661     *
18662     * @see elm_slideshow_loop_get()
18663     *
18664     * @ingroup Slideshow
18665     */
18666    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18667
18668    /**
18669     * Get if, after a slideshow is started, for a given slideshow
18670     * widget, its items are to be displayed cyclically or not.
18671     *
18672     * @param obj The slideshow object
18673     * @return @c EINA_TRUE, if the items in @p obj will be cycled
18674     * through or @c EINA_FALSE, otherwise
18675     *
18676     * @see elm_slideshow_loop_set() for more details
18677     *
18678     * @ingroup Slideshow
18679     */
18680    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18681
18682    /**
18683     * Remove all items from a given slideshow widget
18684     *
18685     * @param obj The slideshow object
18686     *
18687     * This removes (and deletes) all items in @p obj, leaving it
18688     * empty.
18689     *
18690     * @see elm_slideshow_item_del(), to remove just one item.
18691     *
18692     * @ingroup Slideshow
18693     */
18694    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18695
18696    /**
18697     * Get the internal list of items in a given slideshow widget.
18698     *
18699     * @param obj The slideshow object
18700     * @return The list of items (#Elm_Slideshow_Item as data) or
18701     * @c NULL on errors.
18702     *
18703     * This list is @b not to be modified in any way and must not be
18704     * freed. Use the list members with functions like
18705     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18706     *
18707     * @warning This list is only valid until @p obj object's internal
18708     * items list is changed. It should be fetched again with another
18709     * call to this function when changes happen.
18710     *
18711     * @ingroup Slideshow
18712     */
18713    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18714
18715    /**
18716     * Delete a given item from a slideshow widget.
18717     *
18718     * @param item The slideshow item
18719     *
18720     * @ingroup Slideshow
18721     */
18722    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18723
18724    /**
18725     * Return the data associated with a given slideshow item
18726     *
18727     * @param item The slideshow item
18728     * @return Returns the data associated to this item
18729     *
18730     * @ingroup Slideshow
18731     */
18732    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18733
18734    /**
18735     * Returns the currently displayed item, in a given slideshow widget
18736     *
18737     * @param obj The slideshow object
18738     * @return A handle to the item being displayed in @p obj or
18739     * @c NULL, if none is (and on errors)
18740     *
18741     * @ingroup Slideshow
18742     */
18743    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18744
18745    /**
18746     * Get the real Evas object created to implement the view of a
18747     * given slideshow item
18748     *
18749     * @param item The slideshow item.
18750     * @return the Evas object implementing this item's view.
18751     *
18752     * This returns the actual Evas object used to implement the
18753     * specified slideshow item's view. This may be @c NULL, as it may
18754     * not have been created or may have been deleted, at any time, by
18755     * the slideshow. <b>Do not modify this object</b> (move, resize,
18756     * show, hide, etc.), as the slideshow is controlling it. This
18757     * function is for querying, emitting custom signals or hooking
18758     * lower level callbacks for events on that object. Do not delete
18759     * this object under any circumstances.
18760     *
18761     * @see elm_slideshow_item_data_get()
18762     *
18763     * @ingroup Slideshow
18764     */
18765    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18766
18767    /**
18768     * Get the the item, in a given slideshow widget, placed at
18769     * position @p nth, in its internal items list
18770     *
18771     * @param obj The slideshow object
18772     * @param nth The number of the item to grab a handle to (0 being
18773     * the first)
18774     * @return The item stored in @p obj at position @p nth or @c NULL,
18775     * if there's no item with that index (and on errors)
18776     *
18777     * @ingroup Slideshow
18778     */
18779    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18780
18781    /**
18782     * Set the current slide layout in use for a given slideshow widget
18783     *
18784     * @param obj The slideshow object
18785     * @param layout The new layout's name string
18786     *
18787     * If @p layout is implemented in @p obj's theme (i.e., is contained
18788     * in the list returned by elm_slideshow_layouts_get()), this new
18789     * images layout will be used on the widget.
18790     *
18791     * @see elm_slideshow_layouts_get() for more details
18792     *
18793     * @ingroup Slideshow
18794     */
18795    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18796
18797    /**
18798     * Get the current slide layout in use for a given slideshow widget
18799     *
18800     * @param obj The slideshow object
18801     * @return The current layout's name
18802     *
18803     * @see elm_slideshow_layout_set() for more details
18804     *
18805     * @ingroup Slideshow
18806     */
18807    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18808
18809    /**
18810     * Returns the list of @b layout names available, for a given
18811     * slideshow widget.
18812     *
18813     * @param obj The slideshow object
18814     * @return The list of layouts (list of @b stringshared strings
18815     * as data)
18816     *
18817     * Slideshow layouts will change how the widget is to dispose each
18818     * image item in its viewport, with regard to cropping, scaling,
18819     * etc.
18820     *
18821     * The layouts, which come from @p obj's theme, must be an EDC
18822     * data item name @c "layouts" on the theme file, with (prefix)
18823     * names of EDC programs actually implementing them.
18824     *
18825     * The available layouts for slideshows on the default theme are:
18826     * - @c "fullscreen" - item images with original aspect, scaled to
18827     *   touch top and down slideshow borders or, if the image's heigh
18828     *   is not enough, left and right slideshow borders.
18829     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18830     *   one, but always leaving 10% of the slideshow's dimensions of
18831     *   distance between the item image's borders and the slideshow
18832     *   borders, for each axis.
18833     *
18834     * @warning The stringshared strings get no new references
18835     * exclusive to the user grabbing the list, here, so if you'd like
18836     * to use them out of this call's context, you'd better @c
18837     * eina_stringshare_ref() them.
18838     *
18839     * @see elm_slideshow_layout_set()
18840     *
18841     * @ingroup Slideshow
18842     */
18843    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18844
18845    /**
18846     * Set the number of items to cache, on a given slideshow widget,
18847     * <b>before the current item</b>
18848     *
18849     * @param obj The slideshow object
18850     * @param count Number of items to cache before the current one
18851     *
18852     * The default value for this property is @c 2. See
18853     * @ref Slideshow_Caching "slideshow caching" for more details.
18854     *
18855     * @see elm_slideshow_cache_before_get()
18856     *
18857     * @ingroup Slideshow
18858     */
18859    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18860
18861    /**
18862     * Retrieve the number of items to cache, on a given slideshow widget,
18863     * <b>before the current item</b>
18864     *
18865     * @param obj The slideshow object
18866     * @return The number of items set to be cached before the current one
18867     *
18868     * @see elm_slideshow_cache_before_set() for more details
18869     *
18870     * @ingroup Slideshow
18871     */
18872    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18873
18874    /**
18875     * Set the number of items to cache, on a given slideshow widget,
18876     * <b>after the current item</b>
18877     *
18878     * @param obj The slideshow object
18879     * @param count Number of items to cache after the current one
18880     *
18881     * The default value for this property is @c 2. See
18882     * @ref Slideshow_Caching "slideshow caching" for more details.
18883     *
18884     * @see elm_slideshow_cache_after_get()
18885     *
18886     * @ingroup Slideshow
18887     */
18888    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18889
18890    /**
18891     * Retrieve the number of items to cache, on a given slideshow widget,
18892     * <b>after the current item</b>
18893     *
18894     * @param obj The slideshow object
18895     * @return The number of items set to be cached after the current one
18896     *
18897     * @see elm_slideshow_cache_after_set() for more details
18898     *
18899     * @ingroup Slideshow
18900     */
18901    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18902
18903    /**
18904     * Get the number of items stored in a given slideshow widget
18905     *
18906     * @param obj The slideshow object
18907     * @return The number of items on @p obj, at the moment of this call
18908     *
18909     * @ingroup Slideshow
18910     */
18911    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18912
18913    /**
18914     * @}
18915     */
18916
18917    /**
18918     * @defgroup Fileselector File Selector
18919     *
18920     * @image html img/widget/fileselector/preview-00.png
18921     * @image latex img/widget/fileselector/preview-00.eps
18922     *
18923     * A file selector is a widget that allows a user to navigate
18924     * through a file system, reporting file selections back via its
18925     * API.
18926     *
18927     * It contains shortcut buttons for home directory (@c ~) and to
18928     * jump one directory upwards (..), as well as cancel/ok buttons to
18929     * confirm/cancel a given selection. After either one of those two
18930     * former actions, the file selector will issue its @c "done" smart
18931     * callback.
18932     *
18933     * There's a text entry on it, too, showing the name of the current
18934     * selection. There's the possibility of making it editable, so it
18935     * is useful on file saving dialogs on applications, where one
18936     * gives a file name to save contents to, in a given directory in
18937     * the system. This custom file name will be reported on the @c
18938     * "done" smart callback (explained in sequence).
18939     *
18940     * Finally, it has a view to display file system items into in two
18941     * possible forms:
18942     * - list
18943     * - grid
18944     *
18945     * If Elementary is built with support of the Ethumb thumbnailing
18946     * library, the second form of view will display preview thumbnails
18947     * of files which it supports.
18948     *
18949     * Smart callbacks one can register to:
18950     *
18951     * - @c "selected" - the user has clicked on a file (when not in
18952     *      folders-only mode) or directory (when in folders-only mode)
18953     * - @c "directory,open" - the list has been populated with new
18954     *      content (@c event_info is a pointer to the directory's
18955     *      path, a @b stringshared string)
18956     * - @c "done" - the user has clicked on the "ok" or "cancel"
18957     *      buttons (@c event_info is a pointer to the selection's
18958     *      path, a @b stringshared string)
18959     *
18960     * Here is an example on its usage:
18961     * @li @ref fileselector_example
18962     */
18963
18964    /**
18965     * @addtogroup Fileselector
18966     * @{
18967     */
18968
18969    /**
18970     * Defines how a file selector widget is to layout its contents
18971     * (file system entries).
18972     */
18973    typedef enum _Elm_Fileselector_Mode
18974      {
18975         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
18976         ELM_FILESELECTOR_GRID, /**< layout as a grid */
18977         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
18978      } Elm_Fileselector_Mode;
18979
18980    /**
18981     * Add a new file selector widget to the given parent Elementary
18982     * (container) object
18983     *
18984     * @param parent The parent object
18985     * @return a new file selector widget handle or @c NULL, on errors
18986     *
18987     * This function inserts a new file selector widget on the canvas.
18988     *
18989     * @ingroup Fileselector
18990     */
18991    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18992
18993    /**
18994     * Enable/disable the file name entry box where the user can type
18995     * in a name for a file, in a given file selector widget
18996     *
18997     * @param obj The file selector object
18998     * @param is_save @c EINA_TRUE to make the file selector a "saving
18999     * dialog", @c EINA_FALSE otherwise
19000     *
19001     * Having the entry editable is useful on file saving dialogs on
19002     * applications, where one gives a file name to save contents to,
19003     * in a given directory in the system. This custom file name will
19004     * be reported on the @c "done" smart callback.
19005     *
19006     * @see elm_fileselector_is_save_get()
19007     *
19008     * @ingroup Fileselector
19009     */
19010    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19011
19012    /**
19013     * Get whether the given file selector is in "saving dialog" mode
19014     *
19015     * @param obj The file selector object
19016     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19017     * mode, @c EINA_FALSE otherwise (and on errors)
19018     *
19019     * @see elm_fileselector_is_save_set() for more details
19020     *
19021     * @ingroup Fileselector
19022     */
19023    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19024
19025    /**
19026     * Enable/disable folder-only view for a given file selector widget
19027     *
19028     * @param obj The file selector object
19029     * @param only @c EINA_TRUE to make @p obj only display
19030     * directories, @c EINA_FALSE to make files to be displayed in it
19031     * too
19032     *
19033     * If enabled, the widget's view will only display folder items,
19034     * naturally.
19035     *
19036     * @see elm_fileselector_folder_only_get()
19037     *
19038     * @ingroup Fileselector
19039     */
19040    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19041
19042    /**
19043     * Get whether folder-only view is set for a given file selector
19044     * widget
19045     *
19046     * @param obj The file selector object
19047     * @return only @c EINA_TRUE if @p obj is only displaying
19048     * directories, @c EINA_FALSE if files are being displayed in it
19049     * too (and on errors)
19050     *
19051     * @see elm_fileselector_folder_only_get()
19052     *
19053     * @ingroup Fileselector
19054     */
19055    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19056
19057    /**
19058     * Enable/disable the "ok" and "cancel" buttons on a given file
19059     * selector widget
19060     *
19061     * @param obj The file selector object
19062     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19063     *
19064     * @note A file selector without those buttons will never emit the
19065     * @c "done" smart event, and is only usable if one is just hooking
19066     * to the other two events.
19067     *
19068     * @see elm_fileselector_buttons_ok_cancel_get()
19069     *
19070     * @ingroup Fileselector
19071     */
19072    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19073
19074    /**
19075     * Get whether the "ok" and "cancel" buttons on a given file
19076     * selector widget are being shown.
19077     *
19078     * @param obj The file selector object
19079     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19080     * otherwise (and on errors)
19081     *
19082     * @see elm_fileselector_buttons_ok_cancel_set() for more details
19083     *
19084     * @ingroup Fileselector
19085     */
19086    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19087
19088    /**
19089     * Enable/disable a tree view in the given file selector widget,
19090     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19091     *
19092     * @param obj The file selector object
19093     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19094     * disable
19095     *
19096     * In a tree view, arrows are created on the sides of directories,
19097     * allowing them to expand in place.
19098     *
19099     * @note If it's in other mode, the changes made by this function
19100     * will only be visible when one switches back to "list" mode.
19101     *
19102     * @see elm_fileselector_expandable_get()
19103     *
19104     * @ingroup Fileselector
19105     */
19106    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19107
19108    /**
19109     * Get whether tree view is enabled for the given file selector
19110     * widget
19111     *
19112     * @param obj The file selector object
19113     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19114     * otherwise (and or errors)
19115     *
19116     * @see elm_fileselector_expandable_set() for more details
19117     *
19118     * @ingroup Fileselector
19119     */
19120    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19121
19122    /**
19123     * Set, programmatically, the @b directory that a given file
19124     * selector widget will display contents from
19125     *
19126     * @param obj The file selector object
19127     * @param path The path to display in @p obj
19128     *
19129     * This will change the @b directory that @p obj is displaying. It
19130     * will also clear the text entry area on the @p obj object, which
19131     * displays select files' names.
19132     *
19133     * @see elm_fileselector_path_get()
19134     *
19135     * @ingroup Fileselector
19136     */
19137    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19138
19139    /**
19140     * Get the parent directory's path that a given file selector
19141     * widget is displaying
19142     *
19143     * @param obj The file selector object
19144     * @return The (full) path of the directory the file selector is
19145     * displaying, a @b stringshared string
19146     *
19147     * @see elm_fileselector_path_set()
19148     *
19149     * @ingroup Fileselector
19150     */
19151    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19152
19153    /**
19154     * Set, programmatically, the currently selected file/directory in
19155     * the given file selector widget
19156     *
19157     * @param obj The file selector object
19158     * @param path The (full) path to a file or directory
19159     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19160     * latter case occurs if the directory or file pointed to do not
19161     * exist.
19162     *
19163     * @see elm_fileselector_selected_get()
19164     *
19165     * @ingroup Fileselector
19166     */
19167    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19168
19169    /**
19170     * Get the currently selected item's (full) path, in the given file
19171     * selector widget
19172     *
19173     * @param obj The file selector object
19174     * @return The absolute path of the selected item, a @b
19175     * stringshared string
19176     *
19177     * @note Custom editions on @p obj object's text entry, if made,
19178     * will appear on the return string of this function, naturally.
19179     *
19180     * @see elm_fileselector_selected_set() for more details
19181     *
19182     * @ingroup Fileselector
19183     */
19184    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19185
19186    /**
19187     * Set the mode in which a given file selector widget will display
19188     * (layout) file system entries in its view
19189     *
19190     * @param obj The file selector object
19191     * @param mode The mode of the fileselector, being it one of
19192     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19193     * first one, naturally, will display the files in a list. The
19194     * latter will make the widget to display its entries in a grid
19195     * form.
19196     *
19197     * @note By using elm_fileselector_expandable_set(), the user may
19198     * trigger a tree view for that list.
19199     *
19200     * @note If Elementary is built with support of the Ethumb
19201     * thumbnailing library, the second form of view will display
19202     * preview thumbnails of files which it supports. You must have
19203     * elm_need_ethumb() called in your Elementary for thumbnailing to
19204     * work, though.
19205     *
19206     * @see elm_fileselector_expandable_set().
19207     * @see elm_fileselector_mode_get().
19208     *
19209     * @ingroup Fileselector
19210     */
19211    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19212
19213    /**
19214     * Get the mode in which a given file selector widget is displaying
19215     * (layouting) file system entries in its view
19216     *
19217     * @param obj The fileselector object
19218     * @return The mode in which the fileselector is at
19219     *
19220     * @see elm_fileselector_mode_set() for more details
19221     *
19222     * @ingroup Fileselector
19223     */
19224    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19225
19226    /**
19227     * @}
19228     */
19229
19230    /**
19231     * @defgroup Progressbar Progress bar
19232     *
19233     * The progress bar is a widget for visually representing the
19234     * progress status of a given job/task.
19235     *
19236     * A progress bar may be horizontal or vertical. It may display an
19237     * icon besides it, as well as primary and @b units labels. The
19238     * former is meant to label the widget as a whole, while the
19239     * latter, which is formatted with floating point values (and thus
19240     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19241     * units"</c>), is meant to label the widget's <b>progress
19242     * value</b>. Label, icon and unit strings/objects are @b optional
19243     * for progress bars.
19244     *
19245     * A progress bar may be @b inverted, in which state it gets its
19246     * values inverted, with high values being on the left or top and
19247     * low values on the right or bottom, as opposed to normally have
19248     * the low values on the former and high values on the latter,
19249     * respectively, for horizontal and vertical modes.
19250     *
19251     * The @b span of the progress, as set by
19252     * elm_progressbar_span_size_set(), is its length (horizontally or
19253     * vertically), unless one puts size hints on the widget to expand
19254     * on desired directions, by any container. That length will be
19255     * scaled by the object or applications scaling factor. At any
19256     * point code can query the progress bar for its value with
19257     * elm_progressbar_value_get().
19258     *
19259     * Available widget styles for progress bars:
19260     * - @c "default"
19261     * - @c "wheel" (simple style, no text, no progression, only
19262     *      "pulse" effect is available)
19263     *
19264     * Here is an example on its usage:
19265     * @li @ref progressbar_example
19266     */
19267
19268    /**
19269     * Add a new progress bar widget to the given parent Elementary
19270     * (container) object
19271     *
19272     * @param parent The parent object
19273     * @return a new progress bar widget handle or @c NULL, on errors
19274     *
19275     * This function inserts a new progress bar widget on the canvas.
19276     *
19277     * @ingroup Progressbar
19278     */
19279    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19280
19281    /**
19282     * Set whether a given progress bar widget is at "pulsing mode" or
19283     * not.
19284     *
19285     * @param obj The progress bar object
19286     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19287     * @c EINA_FALSE to put it back to its default one
19288     *
19289     * By default, progress bars will display values from the low to
19290     * high value boundaries. There are, though, contexts in which the
19291     * state of progression of a given task is @b unknown.  For those,
19292     * one can set a progress bar widget to a "pulsing state", to give
19293     * the user an idea that some computation is being held, but
19294     * without exact progress values. In the default theme it will
19295     * animate its bar with the contents filling in constantly and back
19296     * to non-filled, in a loop. To start and stop this pulsing
19297     * animation, one has to explicitly call elm_progressbar_pulse().
19298     *
19299     * @see elm_progressbar_pulse_get()
19300     * @see elm_progressbar_pulse()
19301     *
19302     * @ingroup Progressbar
19303     */
19304    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19305
19306    /**
19307     * Get whether a given progress bar widget is at "pulsing mode" or
19308     * not.
19309     *
19310     * @param obj The progress bar object
19311     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19312     * if it's in the default one (and on errors)
19313     *
19314     * @ingroup Progressbar
19315     */
19316    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19317
19318    /**
19319     * Start/stop a given progress bar "pulsing" animation, if its
19320     * under that mode
19321     *
19322     * @param obj The progress bar object
19323     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19324     * @c EINA_FALSE to @b stop it
19325     *
19326     * @note This call won't do anything if @p obj is not under "pulsing mode".
19327     *
19328     * @see elm_progressbar_pulse_set() for more details.
19329     *
19330     * @ingroup Progressbar
19331     */
19332    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19333
19334    /**
19335     * Set the progress value (in percentage) on a given progress bar
19336     * widget
19337     *
19338     * @param obj The progress bar object
19339     * @param val The progress value (@b must be between @c 0.0 and @c
19340     * 1.0)
19341     *
19342     * Use this call to set progress bar levels.
19343     *
19344     * @note If you passes a value out of the specified range for @p
19345     * val, it will be interpreted as the @b closest of the @b boundary
19346     * values in the range.
19347     *
19348     * @ingroup Progressbar
19349     */
19350    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19351
19352    /**
19353     * Get the progress value (in percentage) on a given progress bar
19354     * widget
19355     *
19356     * @param obj The progress bar object
19357     * @return The value of the progressbar
19358     *
19359     * @see elm_progressbar_value_set() for more details
19360     *
19361     * @ingroup Progressbar
19362     */
19363    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19364
19365    /**
19366     * Set the label of a given progress bar widget
19367     *
19368     * @param obj The progress bar object
19369     * @param label The text label string, in UTF-8
19370     *
19371     * @ingroup Progressbar
19372     * @deprecated use elm_object_text_set() instead.
19373     */
19374    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19375
19376    /**
19377     * Get the label of a given progress bar widget
19378     *
19379     * @param obj The progressbar object
19380     * @return The text label string, in UTF-8
19381     *
19382     * @ingroup Progressbar
19383     * @deprecated use elm_object_text_set() instead.
19384     */
19385    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19386
19387    /**
19388     * Set the icon object of a given progress bar widget
19389     *
19390     * @param obj The progress bar object
19391     * @param icon The icon object
19392     *
19393     * Use this call to decorate @p obj with an icon next to it.
19394     *
19395     * @note Once the icon object is set, a previously set one will be
19396     * deleted. If you want to keep that old content object, use the
19397     * elm_progressbar_icon_unset() function.
19398     *
19399     * @see elm_progressbar_icon_get()
19400     *
19401     * @ingroup Progressbar
19402     */
19403    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19404
19405    /**
19406     * Retrieve the icon object set for a given progress bar widget
19407     *
19408     * @param obj The progress bar object
19409     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19410     * otherwise (and on errors)
19411     *
19412     * @see elm_progressbar_icon_set() for more details
19413     *
19414     * @ingroup Progressbar
19415     */
19416    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19417
19418    /**
19419     * Unset an icon set on a given progress bar widget
19420     *
19421     * @param obj The progress bar object
19422     * @return The icon object that was being used, if any was set, or
19423     * @c NULL, otherwise (and on errors)
19424     *
19425     * This call will unparent and return the icon object which was set
19426     * for this widget, previously, on success.
19427     *
19428     * @see elm_progressbar_icon_set() for more details
19429     *
19430     * @ingroup Progressbar
19431     */
19432    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19433
19434    /**
19435     * Set the (exact) length of the bar region of a given progress bar
19436     * widget
19437     *
19438     * @param obj The progress bar object
19439     * @param size The length of the progress bar's bar region
19440     *
19441     * This sets the minimum width (when in horizontal mode) or height
19442     * (when in vertical mode) of the actual bar area of the progress
19443     * bar @p obj. This in turn affects the object's minimum size. Use
19444     * this when you're not setting other size hints expanding on the
19445     * given direction (like weight and alignment hints) and you would
19446     * like it to have a specific size.
19447     *
19448     * @note Icon, label and unit text around @p obj will require their
19449     * own space, which will make @p obj to require more the @p size,
19450     * actually.
19451     *
19452     * @see elm_progressbar_span_size_get()
19453     *
19454     * @ingroup Progressbar
19455     */
19456    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19457
19458    /**
19459     * Get the length set for the bar region of a given progress bar
19460     * widget
19461     *
19462     * @param obj The progress bar object
19463     * @return The length of the progress bar's bar region
19464     *
19465     * If that size was not set previously, with
19466     * elm_progressbar_span_size_set(), this call will return @c 0.
19467     *
19468     * @ingroup Progressbar
19469     */
19470    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19471
19472    /**
19473     * Set the format string for a given progress bar widget's units
19474     * label
19475     *
19476     * @param obj The progress bar object
19477     * @param format The format string for @p obj's units label
19478     *
19479     * If @c NULL is passed on @p format, it will make @p obj's units
19480     * area to be hidden completely. If not, it'll set the <b>format
19481     * string</b> for the units label's @b text. The units label is
19482     * provided a floating point value, so the units text is up display
19483     * at most one floating point falue. Note that the units label is
19484     * optional. Use a format string such as "%1.2f meters" for
19485     * example.
19486     *
19487     * @note The default format string for a progress bar is an integer
19488     * percentage, as in @c "%.0f %%".
19489     *
19490     * @see elm_progressbar_unit_format_get()
19491     *
19492     * @ingroup Progressbar
19493     */
19494    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19495
19496    /**
19497     * Retrieve the format string set for a given progress bar widget's
19498     * units label
19499     *
19500     * @param obj The progress bar object
19501     * @return The format set string for @p obj's units label or
19502     * @c NULL, if none was set (and on errors)
19503     *
19504     * @see elm_progressbar_unit_format_set() for more details
19505     *
19506     * @ingroup Progressbar
19507     */
19508    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19509
19510    /**
19511     * Set the orientation of a given progress bar widget
19512     *
19513     * @param obj The progress bar object
19514     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19515     * @b horizontal, @c EINA_FALSE to make it @b vertical
19516     *
19517     * Use this function to change how your progress bar is to be
19518     * disposed: vertically or horizontally.
19519     *
19520     * @see elm_progressbar_horizontal_get()
19521     *
19522     * @ingroup Progressbar
19523     */
19524    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19525
19526    /**
19527     * Retrieve the orientation of a given progress bar widget
19528     *
19529     * @param obj The progress bar object
19530     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19531     * @c EINA_FALSE if it's @b vertical (and on errors)
19532     *
19533     * @see elm_progressbar_horizontal_set() for more details
19534     *
19535     * @ingroup Progressbar
19536     */
19537    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19538
19539    /**
19540     * Invert a given progress bar widget's displaying values order
19541     *
19542     * @param obj The progress bar object
19543     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19544     * @c EINA_FALSE to bring it back to default, non-inverted values.
19545     *
19546     * A progress bar may be @b inverted, in which state it gets its
19547     * values inverted, with high values being on the left or top and
19548     * low values on the right or bottom, as opposed to normally have
19549     * the low values on the former and high values on the latter,
19550     * respectively, for horizontal and vertical modes.
19551     *
19552     * @see elm_progressbar_inverted_get()
19553     *
19554     * @ingroup Progressbar
19555     */
19556    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19557
19558    /**
19559     * Get whether a given progress bar widget's displaying values are
19560     * inverted or not
19561     *
19562     * @param obj The progress bar object
19563     * @return @c EINA_TRUE, if @p obj has inverted values,
19564     * @c EINA_FALSE otherwise (and on errors)
19565     *
19566     * @see elm_progressbar_inverted_set() for more details
19567     *
19568     * @ingroup Progressbar
19569     */
19570    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19571
19572    /**
19573     * @defgroup Separator Separator
19574     *
19575     * @brief Separator is a very thin object used to separate other objects.
19576     *
19577     * A separator can be vertical or horizontal.
19578     *
19579     * @ref tutorial_separator is a good example of how to use a separator.
19580     * @{
19581     */
19582    /**
19583     * @brief Add a separator object to @p parent
19584     *
19585     * @param parent The parent object
19586     *
19587     * @return The separator object, or NULL upon failure
19588     */
19589    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19590    /**
19591     * @brief Set the horizontal mode of a separator object
19592     *
19593     * @param obj The separator object
19594     * @param horizontal If true, the separator is horizontal
19595     */
19596    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19597    /**
19598     * @brief Get the horizontal mode of a separator object
19599     *
19600     * @param obj The separator object
19601     * @return If true, the separator is horizontal
19602     *
19603     * @see elm_separator_horizontal_set()
19604     */
19605    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19606    /**
19607     * @}
19608     */
19609
19610    /**
19611     * @defgroup Spinner Spinner
19612     * @ingroup Elementary
19613     *
19614     * @image html img/widget/spinner/preview-00.png
19615     * @image latex img/widget/spinner/preview-00.eps
19616     *
19617     * A spinner is a widget which allows the user to increase or decrease
19618     * numeric values using arrow buttons, or edit values directly, clicking
19619     * over it and typing the new value.
19620     *
19621     * By default the spinner will not wrap and has a label
19622     * of "%.0f" (just showing the integer value of the double).
19623     *
19624     * A spinner has a label that is formatted with floating
19625     * point values and thus accepts a printf-style format string, like
19626     * “%1.2f units”.
19627     *
19628     * It also allows specific values to be replaced by pre-defined labels.
19629     *
19630     * Smart callbacks one can register to:
19631     *
19632     * - "changed" - Whenever the spinner value is changed.
19633     * - "delay,changed" - A short time after the value is changed by the user.
19634     *    This will be called only when the user stops dragging for a very short
19635     *    period or when they release their finger/mouse, so it avoids possibly
19636     *    expensive reactions to the value change.
19637     *
19638     * Available styles for it:
19639     * - @c "default";
19640     * - @c "vertical": up/down buttons at the right side and text left aligned.
19641     *
19642     * Here is an example on its usage:
19643     * @ref spinner_example
19644     */
19645
19646    /**
19647     * @addtogroup Spinner
19648     * @{
19649     */
19650
19651    /**
19652     * Add a new spinner widget to the given parent Elementary
19653     * (container) object.
19654     *
19655     * @param parent The parent object.
19656     * @return a new spinner widget handle or @c NULL, on errors.
19657     *
19658     * This function inserts a new spinner widget on the canvas.
19659     *
19660     * @ingroup Spinner
19661     *
19662     */
19663    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19664
19665    /**
19666     * Set the format string of the displayed label.
19667     *
19668     * @param obj The spinner object.
19669     * @param fmt The format string for the label display.
19670     *
19671     * If @c NULL, this sets the format to "%.0f". If not it sets the format
19672     * string for the label text. The label text is provided a floating point
19673     * value, so the label text can display up to 1 floating point value.
19674     * Note that this is optional.
19675     *
19676     * Use a format string such as "%1.2f meters" for example, and it will
19677     * display values like: "3.14 meters" for a value equal to 3.14159.
19678     *
19679     * Default is "%0.f".
19680     *
19681     * @see elm_spinner_label_format_get()
19682     *
19683     * @ingroup Spinner
19684     */
19685    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19686
19687    /**
19688     * Get the label format of the spinner.
19689     *
19690     * @param obj The spinner object.
19691     * @return The text label format string in UTF-8.
19692     *
19693     * @see elm_spinner_label_format_set() for details.
19694     *
19695     * @ingroup Spinner
19696     */
19697    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19698
19699    /**
19700     * Set the minimum and maximum values for the spinner.
19701     *
19702     * @param obj The spinner object.
19703     * @param min The minimum value.
19704     * @param max The maximum value.
19705     *
19706     * Define the allowed range of values to be selected by the user.
19707     *
19708     * If actual value is less than @p min, it will be updated to @p min. If it
19709     * is bigger then @p max, will be updated to @p max. Actual value can be
19710     * get with elm_spinner_value_get().
19711     *
19712     * By default, min is equal to 0, and max is equal to 100.
19713     *
19714     * @warning Maximum must be greater than minimum.
19715     *
19716     * @see elm_spinner_min_max_get()
19717     *
19718     * @ingroup Spinner
19719     */
19720    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19721
19722    /**
19723     * Get the minimum and maximum values of the spinner.
19724     *
19725     * @param obj The spinner object.
19726     * @param min Pointer where to store the minimum value.
19727     * @param max Pointer where to store the maximum value.
19728     *
19729     * @note If only one value is needed, the other pointer can be passed
19730     * as @c NULL.
19731     *
19732     * @see elm_spinner_min_max_set() for details.
19733     *
19734     * @ingroup Spinner
19735     */
19736    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19737
19738    /**
19739     * Set the step used to increment or decrement the spinner value.
19740     *
19741     * @param obj The spinner object.
19742     * @param step The step value.
19743     *
19744     * This value will be incremented or decremented to the displayed value.
19745     * It will be incremented while the user keep right or top arrow pressed,
19746     * and will be decremented while the user keep left or bottom arrow pressed.
19747     *
19748     * The interval to increment / decrement can be set with
19749     * elm_spinner_interval_set().
19750     *
19751     * By default step value is equal to 1.
19752     *
19753     * @see elm_spinner_step_get()
19754     *
19755     * @ingroup Spinner
19756     */
19757    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19758
19759    /**
19760     * Get the step used to increment or decrement the spinner value.
19761     *
19762     * @param obj The spinner object.
19763     * @return The step value.
19764     *
19765     * @see elm_spinner_step_get() for more details.
19766     *
19767     * @ingroup Spinner
19768     */
19769    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19770
19771    /**
19772     * Set the value the spinner displays.
19773     *
19774     * @param obj The spinner object.
19775     * @param val The value to be displayed.
19776     *
19777     * Value will be presented on the label following format specified with
19778     * elm_spinner_format_set().
19779     *
19780     * @warning The value must to be between min and max values. This values
19781     * are set by elm_spinner_min_max_set().
19782     *
19783     * @see elm_spinner_value_get().
19784     * @see elm_spinner_format_set().
19785     * @see elm_spinner_min_max_set().
19786     *
19787     * @ingroup Spinner
19788     */
19789    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19790
19791    /**
19792     * Get the value displayed by the spinner.
19793     *
19794     * @param obj The spinner object.
19795     * @return The value displayed.
19796     *
19797     * @see elm_spinner_value_set() for details.
19798     *
19799     * @ingroup Spinner
19800     */
19801    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19802
19803    /**
19804     * Set whether the spinner should wrap when it reaches its
19805     * minimum or maximum value.
19806     *
19807     * @param obj The spinner object.
19808     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19809     * disable it.
19810     *
19811     * Disabled by default. If disabled, when the user tries to increment the
19812     * value,
19813     * but displayed value plus step value is bigger than maximum value,
19814     * the spinner
19815     * won't allow it. The same happens when the user tries to decrement it,
19816     * but the value less step is less than minimum value.
19817     *
19818     * When wrap is enabled, in such situations it will allow these changes,
19819     * but will get the value that would be less than minimum and subtracts
19820     * from maximum. Or add the value that would be more than maximum to
19821     * the minimum.
19822     *
19823     * E.g.:
19824     * @li min value = 10
19825     * @li max value = 50
19826     * @li step value = 20
19827     * @li displayed value = 20
19828     *
19829     * When the user decrement value (using left or bottom arrow), it will
19830     * displays @c 40, because max - (min - (displayed - step)) is
19831     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19832     *
19833     * @see elm_spinner_wrap_get().
19834     *
19835     * @ingroup Spinner
19836     */
19837    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19838
19839    /**
19840     * Get whether the spinner should wrap when it reaches its
19841     * minimum or maximum value.
19842     *
19843     * @param obj The spinner object
19844     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19845     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19846     *
19847     * @see elm_spinner_wrap_set() for details.
19848     *
19849     * @ingroup Spinner
19850     */
19851    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19852
19853    /**
19854     * Set whether the spinner can be directly edited by the user or not.
19855     *
19856     * @param obj The spinner object.
19857     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19858     * don't allow users to edit it directly.
19859     *
19860     * Spinner objects can have edition @b disabled, in which state they will
19861     * be changed only by arrows.
19862     * Useful for contexts
19863     * where you don't want your users to interact with it writting the value.
19864     * Specially
19865     * when using special values, the user can see real value instead
19866     * of special label on edition.
19867     *
19868     * It's enabled by default.
19869     *
19870     * @see elm_spinner_editable_get()
19871     *
19872     * @ingroup Spinner
19873     */
19874    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19875
19876    /**
19877     * Get whether the spinner can be directly edited by the user or not.
19878     *
19879     * @param obj The spinner object.
19880     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19881     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19882     *
19883     * @see elm_spinner_editable_set() for details.
19884     *
19885     * @ingroup Spinner
19886     */
19887    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19888
19889    /**
19890     * Set a special string to display in the place of the numerical value.
19891     *
19892     * @param obj The spinner object.
19893     * @param value The value to be replaced.
19894     * @param label The label to be used.
19895     *
19896     * It's useful for cases when a user should select an item that is
19897     * better indicated by a label than a value. For example, weekdays or months.
19898     *
19899     * E.g.:
19900     * @code
19901     * sp = elm_spinner_add(win);
19902     * elm_spinner_min_max_set(sp, 1, 3);
19903     * elm_spinner_special_value_add(sp, 1, "January");
19904     * elm_spinner_special_value_add(sp, 2, "February");
19905     * elm_spinner_special_value_add(sp, 3, "March");
19906     * evas_object_show(sp);
19907     * @endcode
19908     *
19909     * @ingroup Spinner
19910     */
19911    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
19912
19913    /**
19914     * Set the interval on time updates for an user mouse button hold
19915     * on spinner widgets' arrows.
19916     *
19917     * @param obj The spinner object.
19918     * @param interval The (first) interval value in seconds.
19919     *
19920     * This interval value is @b decreased while the user holds the
19921     * mouse pointer either incrementing or decrementing spinner's value.
19922     *
19923     * This helps the user to get to a given value distant from the
19924     * current one easier/faster, as it will start to change quicker and
19925     * quicker on mouse button holds.
19926     *
19927     * The calculation for the next change interval value, starting from
19928     * the one set with this call, is the previous interval divided by
19929     * @c 1.05, so it decreases a little bit.
19930     *
19931     * The default starting interval value for automatic changes is
19932     * @c 0.85 seconds.
19933     *
19934     * @see elm_spinner_interval_get()
19935     *
19936     * @ingroup Spinner
19937     */
19938    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
19939
19940    /**
19941     * Get the interval on time updates for an user mouse button hold
19942     * on spinner widgets' arrows.
19943     *
19944     * @param obj The spinner object.
19945     * @return The (first) interval value, in seconds, set on it.
19946     *
19947     * @see elm_spinner_interval_set() for more details.
19948     *
19949     * @ingroup Spinner
19950     */
19951    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19952
19953    /**
19954     * @}
19955     */
19956
19957    /**
19958     * @defgroup Index Index
19959     *
19960     * @image html img/widget/index/preview-00.png
19961     * @image latex img/widget/index/preview-00.eps
19962     *
19963     * An index widget gives you an index for fast access to whichever
19964     * group of other UI items one might have. It's a list of text
19965     * items (usually letters, for alphabetically ordered access).
19966     *
19967     * Index widgets are by default hidden and just appear when the
19968     * user clicks over it's reserved area in the canvas. In its
19969     * default theme, it's an area one @ref Fingers "finger" wide on
19970     * the right side of the index widget's container.
19971     *
19972     * When items on the index are selected, smart callbacks get
19973     * called, so that its user can make other container objects to
19974     * show a given area or child object depending on the index item
19975     * selected. You'd probably be using an index together with @ref
19976     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
19977     * "general grids".
19978     *
19979     * Smart events one  can add callbacks for are:
19980     * - @c "changed" - When the selected index item changes. @c
19981     *      event_info is the selected item's data pointer.
19982     * - @c "delay,changed" - When the selected index item changes, but
19983     *      after a small idling period. @c event_info is the selected
19984     *      item's data pointer.
19985     * - @c "selected" - When the user releases a mouse button and
19986     *      selects an item. @c event_info is the selected item's data
19987     *      pointer.
19988     * - @c "level,up" - when the user moves a finger from the first
19989     *      level to the second level
19990     * - @c "level,down" - when the user moves a finger from the second
19991     *      level to the first level
19992     *
19993     * The @c "delay,changed" event is so that it'll wait a small time
19994     * before actually reporting those events and, moreover, just the
19995     * last event happening on those time frames will actually be
19996     * reported.
19997     *
19998     * Here are some examples on its usage:
19999     * @li @ref index_example_01
20000     * @li @ref index_example_02
20001     */
20002
20003    /**
20004     * @addtogroup Index
20005     * @{
20006     */
20007
20008    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20009
20010    /**
20011     * Add a new index widget to the given parent Elementary
20012     * (container) object
20013     *
20014     * @param parent The parent object
20015     * @return a new index widget handle or @c NULL, on errors
20016     *
20017     * This function inserts a new index widget on the canvas.
20018     *
20019     * @ingroup Index
20020     */
20021    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20022
20023    /**
20024     * Set whether a given index widget is or not visible,
20025     * programatically.
20026     *
20027     * @param obj The index object
20028     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20029     *
20030     * Not to be confused with visible as in @c evas_object_show() --
20031     * visible with regard to the widget's auto hiding feature.
20032     *
20033     * @see elm_index_active_get()
20034     *
20035     * @ingroup Index
20036     */
20037    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20038
20039    /**
20040     * Get whether a given index widget is currently visible or not.
20041     *
20042     * @param obj The index object
20043     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20044     *
20045     * @see elm_index_active_set() for more details
20046     *
20047     * @ingroup Index
20048     */
20049    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20050
20051    /**
20052     * Set the items level for a given index widget.
20053     *
20054     * @param obj The index object.
20055     * @param level @c 0 or @c 1, the currently implemented levels.
20056     *
20057     * @see elm_index_item_level_get()
20058     *
20059     * @ingroup Index
20060     */
20061    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20062
20063    /**
20064     * Get the items level set for a given index widget.
20065     *
20066     * @param obj The index object.
20067     * @return @c 0 or @c 1, which are the levels @p obj might be at.
20068     *
20069     * @see elm_index_item_level_set() for more information
20070     *
20071     * @ingroup Index
20072     */
20073    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20074
20075    /**
20076     * Returns the last selected item's data, for a given index widget.
20077     *
20078     * @param obj The index object.
20079     * @return The item @b data associated to the last selected item on
20080     * @p obj (or @c NULL, on errors).
20081     *
20082     * @warning The returned value is @b not an #Elm_Index_Item item
20083     * handle, but the data associated to it (see the @c item parameter
20084     * in elm_index_item_append(), as an example).
20085     *
20086     * @ingroup Index
20087     */
20088    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20089
20090    /**
20091     * Append a new item on a given index widget.
20092     *
20093     * @param obj The index object.
20094     * @param letter Letter under which the item should be indexed
20095     * @param item The item data to set for the index's item
20096     *
20097     * Despite the most common usage of the @p letter argument is for
20098     * single char strings, one could use arbitrary strings as index
20099     * entries.
20100     *
20101     * @c item will be the pointer returned back on @c "changed", @c
20102     * "delay,changed" and @c "selected" smart events.
20103     *
20104     * @ingroup Index
20105     */
20106    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20107
20108    /**
20109     * Prepend a new item on a given index widget.
20110     *
20111     * @param obj The index object.
20112     * @param letter Letter under which the item should be indexed
20113     * @param item The item data to set for the index's item
20114     *
20115     * Despite the most common usage of the @p letter argument is for
20116     * single char strings, one could use arbitrary strings as index
20117     * entries.
20118     *
20119     * @c item will be the pointer returned back on @c "changed", @c
20120     * "delay,changed" and @c "selected" smart events.
20121     *
20122     * @ingroup Index
20123     */
20124    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20125
20126    /**
20127     * Append a new item, on a given index widget, <b>after the item
20128     * having @p relative as data</b>.
20129     *
20130     * @param obj The index object.
20131     * @param letter Letter under which the item should be indexed
20132     * @param item The item data to set for the index's item
20133     * @param relative The item data of the index item to be the
20134     * predecessor of this new one
20135     *
20136     * Despite the most common usage of the @p letter argument is for
20137     * single char strings, one could use arbitrary strings as index
20138     * entries.
20139     *
20140     * @c item will be the pointer returned back on @c "changed", @c
20141     * "delay,changed" and @c "selected" smart events.
20142     *
20143     * @note If @p relative is @c NULL or if it's not found to be data
20144     * set on any previous item on @p obj, this function will behave as
20145     * elm_index_item_append().
20146     *
20147     * @ingroup Index
20148     */
20149    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20150
20151    /**
20152     * Prepend a new item, on a given index widget, <b>after the item
20153     * having @p relative as data</b>.
20154     *
20155     * @param obj The index object.
20156     * @param letter Letter under which the item should be indexed
20157     * @param item The item data to set for the index's item
20158     * @param relative The item data of the index item to be the
20159     * successor of this new one
20160     *
20161     * Despite the most common usage of the @p letter argument is for
20162     * single char strings, one could use arbitrary strings as index
20163     * entries.
20164     *
20165     * @c item will be the pointer returned back on @c "changed", @c
20166     * "delay,changed" and @c "selected" smart events.
20167     *
20168     * @note If @p relative is @c NULL or if it's not found to be data
20169     * set on any previous item on @p obj, this function will behave as
20170     * elm_index_item_prepend().
20171     *
20172     * @ingroup Index
20173     */
20174    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20175
20176    /**
20177     * Insert a new item into the given index widget, using @p cmp_func
20178     * function to sort items (by item handles).
20179     *
20180     * @param obj The index object.
20181     * @param letter Letter under which the item should be indexed
20182     * @param item The item data to set for the index's item
20183     * @param cmp_func The comparing function to be used to sort index
20184     * items <b>by #Elm_Index_Item item handles</b>
20185     * @param cmp_data_func A @b fallback function to be called for the
20186     * sorting of index items <b>by item data</b>). It will be used
20187     * when @p cmp_func returns @c 0 (equality), which means an index
20188     * item with provided item data already exists. To decide which
20189     * data item should be pointed to by the index item in question, @p
20190     * cmp_data_func will be used. If @p cmp_data_func returns a
20191     * non-negative value, the previous index item data will be
20192     * replaced by the given @p item pointer. If the previous data need
20193     * to be freed, it should be done by the @p cmp_data_func function,
20194     * because all references to it will be lost. If this function is
20195     * not provided (@c NULL is given), index items will be @b
20196     * duplicated, if @p cmp_func returns @c 0.
20197     *
20198     * Despite the most common usage of the @p letter argument is for
20199     * single char strings, one could use arbitrary strings as index
20200     * entries.
20201     *
20202     * @c item will be the pointer returned back on @c "changed", @c
20203     * "delay,changed" and @c "selected" smart events.
20204     *
20205     * @ingroup Index
20206     */
20207    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);
20208
20209    /**
20210     * Remove an item from a given index widget, <b>to be referenced by
20211     * it's data value</b>.
20212     *
20213     * @param obj The index object
20214     * @param item The item's data pointer for the item to be removed
20215     * from @p obj
20216     *
20217     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20218     * that callback function will be called by this one.
20219     *
20220     * @warning The item to be removed from @p obj will be found via
20221     * its item data pointer, and not by an #Elm_Index_Item handle.
20222     *
20223     * @ingroup Index
20224     */
20225    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20226
20227    /**
20228     * Find a given index widget's item, <b>using item data</b>.
20229     *
20230     * @param obj The index object
20231     * @param item The item data pointed to by the desired index item
20232     * @return The index item handle, if found, or @c NULL otherwise
20233     *
20234     * @ingroup Index
20235     */
20236    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20237
20238    /**
20239     * Removes @b all items from a given index widget.
20240     *
20241     * @param obj The index object.
20242     *
20243     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20244     * that callback function will be called for each item in @p obj.
20245     *
20246     * @ingroup Index
20247     */
20248    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20249
20250    /**
20251     * Go to a given items level on a index widget
20252     *
20253     * @param obj The index object
20254     * @param level The index level (one of @c 0 or @c 1)
20255     *
20256     * @ingroup Index
20257     */
20258    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20259
20260    /**
20261     * Return the data associated with a given index widget item
20262     *
20263     * @param it The index widget item handle
20264     * @return The data associated with @p it
20265     *
20266     * @see elm_index_item_data_set()
20267     *
20268     * @ingroup Index
20269     */
20270    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20271
20272    /**
20273     * Set the data associated with a given index widget item
20274     *
20275     * @param it The index widget item handle
20276     * @param data The new data pointer to set to @p it
20277     *
20278     * This sets new item data on @p it.
20279     *
20280     * @warning The old data pointer won't be touched by this function, so
20281     * the user had better to free that old data himself/herself.
20282     *
20283     * @ingroup Index
20284     */
20285    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20286
20287    /**
20288     * Set the function to be called when a given index widget item is freed.
20289     *
20290     * @param it The item to set the callback on
20291     * @param func The function to call on the item's deletion
20292     *
20293     * When called, @p func will have both @c data and @c event_info
20294     * arguments with the @p it item's data value and, naturally, the
20295     * @c obj argument with a handle to the parent index widget.
20296     *
20297     * @ingroup Index
20298     */
20299    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20300
20301    /**
20302     * Get the letter (string) set on a given index widget item.
20303     *
20304     * @param it The index item handle
20305     * @return The letter string set on @p it
20306     *
20307     * @ingroup Index
20308     */
20309    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20310
20311    /**
20312     * @}
20313     */
20314
20315    /**
20316     * @defgroup Photocam Photocam
20317     *
20318     * @image html img/widget/photocam/preview-00.png
20319     * @image latex img/widget/photocam/preview-00.eps
20320     *
20321     * This is a widget specifically for displaying high-resolution digital
20322     * camera photos giving speedy feedback (fast load), low memory footprint
20323     * and zooming and panning as well as fitting logic. It is entirely focused
20324     * on jpeg images, and takes advantage of properties of the jpeg format (via
20325     * evas loader features in the jpeg loader).
20326     *
20327     * Signals that you can add callbacks for are:
20328     * @li "clicked" - This is called when a user has clicked the photo without
20329     *                 dragging around.
20330     * @li "press" - This is called when a user has pressed down on the photo.
20331     * @li "longpressed" - This is called when a user has pressed down on the
20332     *                     photo for a long time without dragging around.
20333     * @li "clicked,double" - This is called when a user has double-clicked the
20334     *                        photo.
20335     * @li "load" - Photo load begins.
20336     * @li "loaded" - This is called when the image file load is complete for the
20337     *                first view (low resolution blurry version).
20338     * @li "load,detail" - Photo detailed data load begins.
20339     * @li "loaded,detail" - This is called when the image file load is complete
20340     *                      for the detailed image data (full resolution needed).
20341     * @li "zoom,start" - Zoom animation started.
20342     * @li "zoom,stop" - Zoom animation stopped.
20343     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20344     * @li "scroll" - the content has been scrolled (moved)
20345     * @li "scroll,anim,start" - scrolling animation has started
20346     * @li "scroll,anim,stop" - scrolling animation has stopped
20347     * @li "scroll,drag,start" - dragging the contents around has started
20348     * @li "scroll,drag,stop" - dragging the contents around has stopped
20349     *
20350     * @ref tutorial_photocam shows the API in action.
20351     * @{
20352     */
20353    /**
20354     * @brief Types of zoom available.
20355     */
20356    typedef enum _Elm_Photocam_Zoom_Mode
20357      {
20358         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20359         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20360         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20361         ELM_PHOTOCAM_ZOOM_MODE_LAST
20362      } Elm_Photocam_Zoom_Mode;
20363    /**
20364     * @brief Add a new Photocam object
20365     *
20366     * @param parent The parent object
20367     * @return The new object or NULL if it cannot be created
20368     */
20369    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20370    /**
20371     * @brief Set the photo file to be shown
20372     *
20373     * @param obj The photocam object
20374     * @param file The photo file
20375     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20376     *
20377     * This sets (and shows) the specified file (with a relative or absolute
20378     * path) and will return a load error (same error that
20379     * evas_object_image_load_error_get() will return). The image will change and
20380     * adjust its size at this point and begin a background load process for this
20381     * photo that at some time in the future will be displayed at the full
20382     * quality needed.
20383     */
20384    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20385    /**
20386     * @brief Returns the path of the current image file
20387     *
20388     * @param obj The photocam object
20389     * @return Returns the path
20390     *
20391     * @see elm_photocam_file_set()
20392     */
20393    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20394    /**
20395     * @brief Set the zoom level of the photo
20396     *
20397     * @param obj The photocam object
20398     * @param zoom The zoom level to set
20399     *
20400     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20401     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20402     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20403     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20404     * 16, 32, etc.).
20405     */
20406    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20407    /**
20408     * @brief Get the zoom level of the photo
20409     *
20410     * @param obj The photocam object
20411     * @return The current zoom level
20412     *
20413     * This returns the current zoom level of the photocam object. Note that if
20414     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20415     * (which is the default), the zoom level may be changed at any time by the
20416     * photocam object itself to account for photo size and photocam viewpoer
20417     * size.
20418     *
20419     * @see elm_photocam_zoom_set()
20420     * @see elm_photocam_zoom_mode_set()
20421     */
20422    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20423    /**
20424     * @brief Set the zoom mode
20425     *
20426     * @param obj The photocam object
20427     * @param mode The desired mode
20428     *
20429     * This sets the zoom mode to manual or one of several automatic levels.
20430     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20431     * elm_photocam_zoom_set() and will stay at that level until changed by code
20432     * or until zoom mode is changed. This is the default mode. The Automatic
20433     * modes will allow the photocam object to automatically adjust zoom mode
20434     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20435     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20436     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20437     * pixels within the frame are left unfilled.
20438     */
20439    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20440    /**
20441     * @brief Get the zoom mode
20442     *
20443     * @param obj The photocam object
20444     * @return The current zoom mode
20445     *
20446     * This gets the current zoom mode of the photocam object.
20447     *
20448     * @see elm_photocam_zoom_mode_set()
20449     */
20450    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20451    /**
20452     * @brief Get the current image pixel width and height
20453     *
20454     * @param obj The photocam object
20455     * @param w A pointer to the width return
20456     * @param h A pointer to the height return
20457     *
20458     * This gets the current photo pixel width and height (for the original).
20459     * The size will be returned in the integers @p w and @p h that are pointed
20460     * to.
20461     */
20462    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20463    /**
20464     * @brief Get the area of the image that is currently shown
20465     *
20466     * @param obj
20467     * @param x A pointer to the X-coordinate of region
20468     * @param y A pointer to the Y-coordinate of region
20469     * @param w A pointer to the width
20470     * @param h A pointer to the height
20471     *
20472     * @see elm_photocam_image_region_show()
20473     * @see elm_photocam_image_region_bring_in()
20474     */
20475    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20476    /**
20477     * @brief Set the viewed portion of the image
20478     *
20479     * @param obj The photocam object
20480     * @param x X-coordinate of region in image original pixels
20481     * @param y Y-coordinate of region in image original pixels
20482     * @param w Width of region in image original pixels
20483     * @param h Height of region in image original pixels
20484     *
20485     * This shows the region of the image without using animation.
20486     */
20487    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20488    /**
20489     * @brief Bring in the viewed portion of the image
20490     *
20491     * @param obj The photocam object
20492     * @param x X-coordinate of region in image original pixels
20493     * @param y Y-coordinate of region in image original pixels
20494     * @param w Width of region in image original pixels
20495     * @param h Height of region in image original pixels
20496     *
20497     * This shows the region of the image using animation.
20498     */
20499    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20500    /**
20501     * @brief Set the paused state for photocam
20502     *
20503     * @param obj The photocam object
20504     * @param paused The pause state to set
20505     *
20506     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20507     * photocam. The default is off. This will stop zooming using animation on
20508     * zoom levels changes and change instantly. This will stop any existing
20509     * animations that are running.
20510     */
20511    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20512    /**
20513     * @brief Get the paused state for photocam
20514     *
20515     * @param obj The photocam object
20516     * @return The current paused state
20517     *
20518     * This gets the current paused state for the photocam object.
20519     *
20520     * @see elm_photocam_paused_set()
20521     */
20522    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20523    /**
20524     * @brief Get the internal low-res image used for photocam
20525     *
20526     * @param obj The photocam object
20527     * @return The internal image object handle, or NULL if none exists
20528     *
20529     * This gets the internal image object inside photocam. Do not modify it. It
20530     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20531     * deleted at any time as well.
20532     */
20533    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20534    /**
20535     * @brief Set the photocam scrolling bouncing.
20536     *
20537     * @param obj The photocam object
20538     * @param h_bounce bouncing for horizontal
20539     * @param v_bounce bouncing for vertical
20540     */
20541    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20542    /**
20543     * @brief Get the photocam scrolling bouncing.
20544     *
20545     * @param obj The photocam object
20546     * @param h_bounce bouncing for horizontal
20547     * @param v_bounce bouncing for vertical
20548     *
20549     * @see elm_photocam_bounce_set()
20550     */
20551    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20552    /**
20553     * @}
20554     */
20555
20556    /**
20557     * @defgroup Map Map
20558     * @ingroup Elementary
20559     *
20560     * @image html img/widget/map/preview-00.png
20561     * @image latex img/widget/map/preview-00.eps
20562     *
20563     * This is a widget specifically for displaying a map. It uses basically
20564     * OpenStreetMap provider http://www.openstreetmap.org/,
20565     * but custom providers can be added.
20566     *
20567     * It supports some basic but yet nice features:
20568     * @li zoom and scroll
20569     * @li markers with content to be displayed when user clicks over it
20570     * @li group of markers
20571     * @li routes
20572     *
20573     * Smart callbacks one can listen to:
20574     *
20575     * - "clicked" - This is called when a user has clicked the map without
20576     *   dragging around.
20577     * - "press" - This is called when a user has pressed down on the map.
20578     * - "longpressed" - This is called when a user has pressed down on the map
20579     *   for a long time without dragging around.
20580     * - "clicked,double" - This is called when a user has double-clicked
20581     *   the map.
20582     * - "load,detail" - Map detailed data load begins.
20583     * - "loaded,detail" - This is called when all currently visible parts of
20584     *   the map are loaded.
20585     * - "zoom,start" - Zoom animation started.
20586     * - "zoom,stop" - Zoom animation stopped.
20587     * - "zoom,change" - Zoom changed when using an auto zoom mode.
20588     * - "scroll" - the content has been scrolled (moved).
20589     * - "scroll,anim,start" - scrolling animation has started.
20590     * - "scroll,anim,stop" - scrolling animation has stopped.
20591     * - "scroll,drag,start" - dragging the contents around has started.
20592     * - "scroll,drag,stop" - dragging the contents around has stopped.
20593     * - "downloaded" - This is called when all currently required map images
20594     *   are downloaded.
20595     * - "route,load" - This is called when route request begins.
20596     * - "route,loaded" - This is called when route request ends.
20597     * - "name,load" - This is called when name request begins.
20598     * - "name,loaded- This is called when name request ends.
20599     *
20600     * Available style for map widget:
20601     * - @c "default"
20602     *
20603     * Available style for markers:
20604     * - @c "radio"
20605     * - @c "radio2"
20606     * - @c "empty"
20607     *
20608     * Available style for marker bubble:
20609     * - @c "default"
20610     *
20611     * List of examples:
20612     * @li @ref map_example_01
20613     * @li @ref map_example_02
20614     * @li @ref map_example_03
20615     */
20616
20617    /**
20618     * @addtogroup Map
20619     * @{
20620     */
20621
20622    /**
20623     * @enum _Elm_Map_Zoom_Mode
20624     * @typedef Elm_Map_Zoom_Mode
20625     *
20626     * Set map's zoom behavior. It can be set to manual or automatic.
20627     *
20628     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20629     *
20630     * Values <b> don't </b> work as bitmask, only one can be choosen.
20631     *
20632     * @note Valid sizes are 2^zoom, consequently the map may be smaller
20633     * than the scroller view.
20634     *
20635     * @see elm_map_zoom_mode_set()
20636     * @see elm_map_zoom_mode_get()
20637     *
20638     * @ingroup Map
20639     */
20640    typedef enum _Elm_Map_Zoom_Mode
20641      {
20642         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20643         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20644         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20645         ELM_MAP_ZOOM_MODE_LAST
20646      } Elm_Map_Zoom_Mode;
20647
20648    /**
20649     * @enum _Elm_Map_Route_Sources
20650     * @typedef Elm_Map_Route_Sources
20651     *
20652     * Set route service to be used. By default used source is
20653     * #ELM_MAP_ROUTE_SOURCE_YOURS.
20654     *
20655     * @see elm_map_route_source_set()
20656     * @see elm_map_route_source_get()
20657     *
20658     * @ingroup Map
20659     */
20660    typedef enum _Elm_Map_Route_Sources
20661      {
20662         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20663         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. */
20664         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20665         ELM_MAP_ROUTE_SOURCE_LAST
20666      } Elm_Map_Route_Sources;
20667
20668    typedef enum _Elm_Map_Name_Sources
20669      {
20670         ELM_MAP_NAME_SOURCE_NOMINATIM,
20671         ELM_MAP_NAME_SOURCE_LAST
20672      } Elm_Map_Name_Sources;
20673
20674    /**
20675     * @enum _Elm_Map_Route_Type
20676     * @typedef Elm_Map_Route_Type
20677     *
20678     * Set type of transport used on route.
20679     *
20680     * @see elm_map_route_add()
20681     *
20682     * @ingroup Map
20683     */
20684    typedef enum _Elm_Map_Route_Type
20685      {
20686         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20687         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20688         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20689         ELM_MAP_ROUTE_TYPE_LAST
20690      } Elm_Map_Route_Type;
20691
20692    /**
20693     * @enum _Elm_Map_Route_Method
20694     * @typedef Elm_Map_Route_Method
20695     *
20696     * Set the routing method, what should be priorized, time or distance.
20697     *
20698     * @see elm_map_route_add()
20699     *
20700     * @ingroup Map
20701     */
20702    typedef enum _Elm_Map_Route_Method
20703      {
20704         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20705         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20706         ELM_MAP_ROUTE_METHOD_LAST
20707      } Elm_Map_Route_Method;
20708
20709    typedef enum _Elm_Map_Name_Method
20710      {
20711         ELM_MAP_NAME_METHOD_SEARCH,
20712         ELM_MAP_NAME_METHOD_REVERSE,
20713         ELM_MAP_NAME_METHOD_LAST
20714      } Elm_Map_Name_Method;
20715
20716    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(). */
20717    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(). */
20718    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(). */
20719    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(). */
20720    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
20721    typedef struct _Elm_Map_Track           Elm_Map_Track;
20722
20723    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. */
20724    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20725    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20726    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20727
20728    typedef char        *(*ElmMapModuleSourceFunc) (void);
20729    typedef int          (*ElmMapModuleZoomMinFunc) (void);
20730    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
20731    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20732    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
20733    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20734    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20735    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20736    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20737
20738    /**
20739     * Add a new map widget to the given parent Elementary (container) object.
20740     *
20741     * @param parent The parent object.
20742     * @return a new map widget handle or @c NULL, on errors.
20743     *
20744     * This function inserts a new map widget on the canvas.
20745     *
20746     * @ingroup Map
20747     */
20748    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20749
20750    /**
20751     * Set the zoom level of the map.
20752     *
20753     * @param obj The map object.
20754     * @param zoom The zoom level to set.
20755     *
20756     * This sets the zoom level.
20757     *
20758     * It will respect limits defined by elm_map_source_zoom_min_set() and
20759     * elm_map_source_zoom_max_set().
20760     *
20761     * By default these values are 0 (world map) and 18 (maximum zoom).
20762     *
20763     * This function should be used when zoom mode is set to
20764     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20765     * with elm_map_zoom_mode_set().
20766     *
20767     * @see elm_map_zoom_mode_set().
20768     * @see elm_map_zoom_get().
20769     *
20770     * @ingroup Map
20771     */
20772    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20773
20774    /**
20775     * Get the zoom level of the map.
20776     *
20777     * @param obj The map object.
20778     * @return The current zoom level.
20779     *
20780     * This returns the current zoom level of the map object.
20781     *
20782     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20783     * (which is the default), the zoom level may be changed at any time by the
20784     * map object itself to account for map size and map viewport size.
20785     *
20786     * @see elm_map_zoom_set() for details.
20787     *
20788     * @ingroup Map
20789     */
20790    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20791
20792    /**
20793     * Set the zoom mode used by the map object.
20794     *
20795     * @param obj The map object.
20796     * @param mode The zoom mode of the map, being it one of
20797     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20798     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20799     *
20800     * This sets the zoom mode to manual or one of the automatic levels.
20801     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20802     * elm_map_zoom_set() and will stay at that level until changed by code
20803     * or until zoom mode is changed. This is the default mode.
20804     *
20805     * The Automatic modes will allow the map object to automatically
20806     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20807     * adjust zoom so the map fits inside the scroll frame with no pixels
20808     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20809     * ensure no pixels within the frame are left unfilled. Do not forget that
20810     * the valid sizes are 2^zoom, consequently the map may be smaller than
20811     * the scroller view.
20812     *
20813     * @see elm_map_zoom_set()
20814     *
20815     * @ingroup Map
20816     */
20817    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20818
20819    /**
20820     * Get the zoom mode used by the map object.
20821     *
20822     * @param obj The map object.
20823     * @return The zoom mode of the map, being it one of
20824     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20825     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20826     *
20827     * This function returns the current zoom mode used by the map object.
20828     *
20829     * @see elm_map_zoom_mode_set() for more details.
20830     *
20831     * @ingroup Map
20832     */
20833    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20834
20835    /**
20836     * Get the current coordinates of the map.
20837     *
20838     * @param obj The map object.
20839     * @param lon Pointer where to store longitude.
20840     * @param lat Pointer where to store latitude.
20841     *
20842     * This gets the current center coordinates of the map object. It can be
20843     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20844     *
20845     * @see elm_map_geo_region_bring_in()
20846     * @see elm_map_geo_region_show()
20847     *
20848     * @ingroup Map
20849     */
20850    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20851
20852    /**
20853     * Animatedly bring in given coordinates to the center of the map.
20854     *
20855     * @param obj The map object.
20856     * @param lon Longitude to center at.
20857     * @param lat Latitude to center at.
20858     *
20859     * This causes map to jump to the given @p lat and @p lon coordinates
20860     * and show it (by scrolling) in the center of the viewport, if it is not
20861     * already centered. This will use animation to do so and take a period
20862     * of time to complete.
20863     *
20864     * @see elm_map_geo_region_show() for a function to avoid animation.
20865     * @see elm_map_geo_region_get()
20866     *
20867     * @ingroup Map
20868     */
20869    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20870
20871    /**
20872     * Show the given coordinates at the center of the map, @b immediately.
20873     *
20874     * @param obj The map object.
20875     * @param lon Longitude to center at.
20876     * @param lat Latitude to center at.
20877     *
20878     * This causes map to @b redraw its viewport's contents to the
20879     * region contining the given @p lat and @p lon, that will be moved to the
20880     * center of the map.
20881     *
20882     * @see elm_map_geo_region_bring_in() for a function to move with animation.
20883     * @see elm_map_geo_region_get()
20884     *
20885     * @ingroup Map
20886     */
20887    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20888
20889    /**
20890     * Pause or unpause the map.
20891     *
20892     * @param obj The map object.
20893     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20894     * to unpause it.
20895     *
20896     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20897     * for map.
20898     *
20899     * The default is off.
20900     *
20901     * This will stop zooming using animation, changing zoom levels will
20902     * change instantly. This will stop any existing animations that are running.
20903     *
20904     * @see elm_map_paused_get()
20905     *
20906     * @ingroup Map
20907     */
20908    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20909
20910    /**
20911     * Get a value whether map is paused or not.
20912     *
20913     * @param obj The map object.
20914     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
20915     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
20916     *
20917     * This gets the current paused state for the map object.
20918     *
20919     * @see elm_map_paused_set() for details.
20920     *
20921     * @ingroup Map
20922     */
20923    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20924
20925    /**
20926     * Set to show markers during zoom level changes or not.
20927     *
20928     * @param obj The map object.
20929     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
20930     * to show them.
20931     *
20932     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20933     * for map.
20934     *
20935     * The default is off.
20936     *
20937     * This will stop zooming using animation, changing zoom levels will
20938     * change instantly. This will stop any existing animations that are running.
20939     *
20940     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20941     * for the markers.
20942     *
20943     * The default  is off.
20944     *
20945     * Enabling it will force the map to stop displaying the markers during
20946     * zoom level changes. Set to on if you have a large number of markers.
20947     *
20948     * @see elm_map_paused_markers_get()
20949     *
20950     * @ingroup Map
20951     */
20952    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20953
20954    /**
20955     * Get a value whether markers will be displayed on zoom level changes or not
20956     *
20957     * @param obj The map object.
20958     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
20959     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
20960     *
20961     * This gets the current markers paused state for the map object.
20962     *
20963     * @see elm_map_paused_markers_set() for details.
20964     *
20965     * @ingroup Map
20966     */
20967    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20968
20969    /**
20970     * Get the information of downloading status.
20971     *
20972     * @param obj The map object.
20973     * @param try_num Pointer where to store number of tiles being downloaded.
20974     * @param finish_num Pointer where to store number of tiles successfully
20975     * downloaded.
20976     *
20977     * This gets the current downloading status for the map object, the number
20978     * of tiles being downloaded and the number of tiles already downloaded.
20979     *
20980     * @ingroup Map
20981     */
20982    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
20983
20984    /**
20985     * Convert a pixel coordinate (x,y) into a geographic coordinate
20986     * (longitude, latitude).
20987     *
20988     * @param obj The map object.
20989     * @param x the coordinate.
20990     * @param y the coordinate.
20991     * @param size the size in pixels of the map.
20992     * The map is a square and generally his size is : pow(2.0, zoom)*256.
20993     * @param lon Pointer where to store the longitude that correspond to x.
20994     * @param lat Pointer where to store the latitude that correspond to y.
20995     *
20996     * @note Origin pixel point is the top left corner of the viewport.
20997     * Map zoom and size are taken on account.
20998     *
20999     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21000     *
21001     * @ingroup Map
21002     */
21003    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);
21004
21005    /**
21006     * Convert a geographic coordinate (longitude, latitude) into a pixel
21007     * coordinate (x, y).
21008     *
21009     * @param obj The map object.
21010     * @param lon the longitude.
21011     * @param lat the latitude.
21012     * @param size the size in pixels of the map. The map is a square
21013     * and generally his size is : pow(2.0, zoom)*256.
21014     * @param x Pointer where to store the horizontal pixel coordinate that
21015     * correspond to the longitude.
21016     * @param y Pointer where to store the vertical pixel coordinate that
21017     * correspond to the latitude.
21018     *
21019     * @note Origin pixel point is the top left corner of the viewport.
21020     * Map zoom and size are taken on account.
21021     *
21022     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21023     *
21024     * @ingroup Map
21025     */
21026    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);
21027
21028    /**
21029     * Convert a geographic coordinate (longitude, latitude) into a name
21030     * (address).
21031     *
21032     * @param obj The map object.
21033     * @param lon the longitude.
21034     * @param lat the latitude.
21035     * @return name A #Elm_Map_Name handle for this coordinate.
21036     *
21037     * To get the string for this address, elm_map_name_address_get()
21038     * should be used.
21039     *
21040     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21041     *
21042     * @ingroup Map
21043     */
21044    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21045
21046    /**
21047     * Convert a name (address) into a geographic coordinate
21048     * (longitude, latitude).
21049     *
21050     * @param obj The map object.
21051     * @param name The address.
21052     * @return name A #Elm_Map_Name handle for this address.
21053     *
21054     * To get the longitude and latitude, elm_map_name_region_get()
21055     * should be used.
21056     *
21057     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21058     *
21059     * @ingroup Map
21060     */
21061    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21062
21063    /**
21064     * Convert a pixel coordinate into a rotated pixel coordinate.
21065     *
21066     * @param obj The map object.
21067     * @param x horizontal coordinate of the point to rotate.
21068     * @param y vertical coordinate of the point to rotate.
21069     * @param cx rotation's center horizontal position.
21070     * @param cy rotation's center vertical position.
21071     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21072     * @param xx Pointer where to store rotated x.
21073     * @param yy Pointer where to store rotated y.
21074     *
21075     * @ingroup Map
21076     */
21077    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);
21078
21079    /**
21080     * Add a new marker to the map object.
21081     *
21082     * @param obj The map object.
21083     * @param lon The longitude of the marker.
21084     * @param lat The latitude of the marker.
21085     * @param clas The class, to use when marker @b isn't grouped to others.
21086     * @param clas_group The class group, to use when marker is grouped to others
21087     * @param data The data passed to the callbacks.
21088     *
21089     * @return The created marker or @c NULL upon failure.
21090     *
21091     * A marker will be created and shown in a specific point of the map, defined
21092     * by @p lon and @p lat.
21093     *
21094     * It will be displayed using style defined by @p class when this marker
21095     * is displayed alone (not grouped). A new class can be created with
21096     * elm_map_marker_class_new().
21097     *
21098     * If the marker is grouped to other markers, it will be displayed with
21099     * style defined by @p class_group. Markers with the same group are grouped
21100     * if they are close. A new group class can be created with
21101     * elm_map_marker_group_class_new().
21102     *
21103     * Markers created with this method can be deleted with
21104     * elm_map_marker_remove().
21105     *
21106     * A marker can have associated content to be displayed by a bubble,
21107     * when a user click over it, as well as an icon. These objects will
21108     * be fetch using class' callback functions.
21109     *
21110     * @see elm_map_marker_class_new()
21111     * @see elm_map_marker_group_class_new()
21112     * @see elm_map_marker_remove()
21113     *
21114     * @ingroup Map
21115     */
21116    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);
21117
21118    /**
21119     * Set the maximum numbers of markers' content to be displayed in a group.
21120     *
21121     * @param obj The map object.
21122     * @param max The maximum numbers of items displayed in a bubble.
21123     *
21124     * A bubble will be displayed when the user clicks over the group,
21125     * and will place the content of markers that belong to this group
21126     * inside it.
21127     *
21128     * A group can have a long list of markers, consequently the creation
21129     * of the content of the bubble can be very slow.
21130     *
21131     * In order to avoid this, a maximum number of items is displayed
21132     * in a bubble.
21133     *
21134     * By default this number is 30.
21135     *
21136     * Marker with the same group class are grouped if they are close.
21137     *
21138     * @see elm_map_marker_add()
21139     *
21140     * @ingroup Map
21141     */
21142    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21143
21144    /**
21145     * Remove a marker from the map.
21146     *
21147     * @param marker The marker to remove.
21148     *
21149     * @see elm_map_marker_add()
21150     *
21151     * @ingroup Map
21152     */
21153    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21154
21155    /**
21156     * Get the current coordinates of the marker.
21157     *
21158     * @param marker marker.
21159     * @param lat Pointer where to store the marker's latitude.
21160     * @param lon Pointer where to store the marker's longitude.
21161     *
21162     * These values are set when adding markers, with function
21163     * elm_map_marker_add().
21164     *
21165     * @see elm_map_marker_add()
21166     *
21167     * @ingroup Map
21168     */
21169    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21170
21171    /**
21172     * Animatedly bring in given marker to the center of the map.
21173     *
21174     * @param marker The marker to center at.
21175     *
21176     * This causes map to jump to the given @p marker's coordinates
21177     * and show it (by scrolling) in the center of the viewport, if it is not
21178     * already centered. This will use animation to do so and take a period
21179     * of time to complete.
21180     *
21181     * @see elm_map_marker_show() for a function to avoid animation.
21182     * @see elm_map_marker_region_get()
21183     *
21184     * @ingroup Map
21185     */
21186    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21187
21188    /**
21189     * Show the given marker at the center of the map, @b immediately.
21190     *
21191     * @param marker The marker to center at.
21192     *
21193     * This causes map to @b redraw its viewport's contents to the
21194     * region contining the given @p marker's coordinates, that will be
21195     * moved to the center of the map.
21196     *
21197     * @see elm_map_marker_bring_in() for a function to move with animation.
21198     * @see elm_map_markers_list_show() if more than one marker need to be
21199     * displayed.
21200     * @see elm_map_marker_region_get()
21201     *
21202     * @ingroup Map
21203     */
21204    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21205
21206    /**
21207     * Move and zoom the map to display a list of markers.
21208     *
21209     * @param markers A list of #Elm_Map_Marker handles.
21210     *
21211     * The map will be centered on the center point of the markers in the list.
21212     * Then the map will be zoomed in order to fit the markers using the maximum
21213     * zoom which allows display of all the markers.
21214     *
21215     * @warning All the markers should belong to the same map object.
21216     *
21217     * @see elm_map_marker_show() to show a single marker.
21218     * @see elm_map_marker_bring_in()
21219     *
21220     * @ingroup Map
21221     */
21222    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21223
21224    /**
21225     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21226     *
21227     * @param marker The marker wich content should be returned.
21228     * @return Return the evas object if it exists, else @c NULL.
21229     *
21230     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21231     * elm_map_marker_class_get_cb_set() should be used.
21232     *
21233     * This content is what will be inside the bubble that will be displayed
21234     * when an user clicks over the marker.
21235     *
21236     * This returns the actual Evas object used to be placed inside
21237     * the bubble. This may be @c NULL, as it may
21238     * not have been created or may have been deleted, at any time, by
21239     * the map. <b>Do not modify this object</b> (move, resize,
21240     * show, hide, etc.), as the map is controlling it. This
21241     * function is for querying, emitting custom signals or hooking
21242     * lower level callbacks for events on that object. Do not delete
21243     * this object under any circumstances.
21244     *
21245     * @ingroup Map
21246     */
21247    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21248
21249    /**
21250     * Update the marker
21251     *
21252     * @param marker The marker to be updated.
21253     *
21254     * If a content is set to this marker, it will call function to delete it,
21255     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21256     * #ElmMapMarkerGetFunc.
21257     *
21258     * These functions are set for the marker class with
21259     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21260     *
21261     * @ingroup Map
21262     */
21263    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21264
21265    /**
21266     * Close all the bubbles opened by the user.
21267     *
21268     * @param obj The map object.
21269     *
21270     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21271     * when the user clicks on a marker.
21272     *
21273     * This functions is set for the marker class with
21274     * elm_map_marker_class_get_cb_set().
21275     *
21276     * @ingroup Map
21277     */
21278    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21279
21280    /**
21281     * Create a new group class.
21282     *
21283     * @param obj The map object.
21284     * @return Returns the new group class.
21285     *
21286     * Each marker must be associated to a group class. Markers in the same
21287     * group are grouped if they are close.
21288     *
21289     * The group class defines the style of the marker when a marker is grouped
21290     * to others markers. When it is alone, another class will be used.
21291     *
21292     * A group class will need to be provided when creating a marker with
21293     * elm_map_marker_add().
21294     *
21295     * Some properties and functions can be set by class, as:
21296     * - style, with elm_map_group_class_style_set()
21297     * - data - to be associated to the group class. It can be set using
21298     *   elm_map_group_class_data_set().
21299     * - min zoom to display markers, set with
21300     *   elm_map_group_class_zoom_displayed_set().
21301     * - max zoom to group markers, set using
21302     *   elm_map_group_class_zoom_grouped_set().
21303     * - visibility - set if markers will be visible or not, set with
21304     *   elm_map_group_class_hide_set().
21305     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21306     *   It can be set using elm_map_group_class_icon_cb_set().
21307     *
21308     * @see elm_map_marker_add()
21309     * @see elm_map_group_class_style_set()
21310     * @see elm_map_group_class_data_set()
21311     * @see elm_map_group_class_zoom_displayed_set()
21312     * @see elm_map_group_class_zoom_grouped_set()
21313     * @see elm_map_group_class_hide_set()
21314     * @see elm_map_group_class_icon_cb_set()
21315     *
21316     * @ingroup Map
21317     */
21318    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21319
21320    /**
21321     * Set the marker's style of a group class.
21322     *
21323     * @param clas The group class.
21324     * @param style The style to be used by markers.
21325     *
21326     * Each marker must be associated to a group class, and will use the style
21327     * defined by such class when grouped to other markers.
21328     *
21329     * The following styles are provided by default theme:
21330     * @li @c radio - blue circle
21331     * @li @c radio2 - green circle
21332     * @li @c empty
21333     *
21334     * @see elm_map_group_class_new() for more details.
21335     * @see elm_map_marker_add()
21336     *
21337     * @ingroup Map
21338     */
21339    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21340
21341    /**
21342     * Set the icon callback function of a group class.
21343     *
21344     * @param clas The group class.
21345     * @param icon_get The callback function that will return the icon.
21346     *
21347     * Each marker must be associated to a group class, and it can display a
21348     * custom icon. The function @p icon_get must return this icon.
21349     *
21350     * @see elm_map_group_class_new() for more details.
21351     * @see elm_map_marker_add()
21352     *
21353     * @ingroup Map
21354     */
21355    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21356
21357    /**
21358     * Set the data associated to the group class.
21359     *
21360     * @param clas The group class.
21361     * @param data The new user data.
21362     *
21363     * This data will be passed for callback functions, like icon get callback,
21364     * that can be set with elm_map_group_class_icon_cb_set().
21365     *
21366     * If a data was previously set, the object will lose the pointer for it,
21367     * so if needs to be freed, you must do it yourself.
21368     *
21369     * @see elm_map_group_class_new() for more details.
21370     * @see elm_map_group_class_icon_cb_set()
21371     * @see elm_map_marker_add()
21372     *
21373     * @ingroup Map
21374     */
21375    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21376
21377    /**
21378     * Set the minimum zoom from where the markers are displayed.
21379     *
21380     * @param clas The group class.
21381     * @param zoom The minimum zoom.
21382     *
21383     * Markers only will be displayed when the map is displayed at @p zoom
21384     * or bigger.
21385     *
21386     * @see elm_map_group_class_new() for more details.
21387     * @see elm_map_marker_add()
21388     *
21389     * @ingroup Map
21390     */
21391    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21392
21393    /**
21394     * Set the zoom from where the markers are no more grouped.
21395     *
21396     * @param clas The group class.
21397     * @param zoom The maximum zoom.
21398     *
21399     * Markers only will be grouped when the map is displayed at
21400     * less than @p zoom.
21401     *
21402     * @see elm_map_group_class_new() for more details.
21403     * @see elm_map_marker_add()
21404     *
21405     * @ingroup Map
21406     */
21407    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21408
21409    /**
21410     * Set if the markers associated to the group class @clas are hidden or not.
21411     *
21412     * @param clas The group class.
21413     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21414     * to show them.
21415     *
21416     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21417     * is to show them.
21418     *
21419     * @ingroup Map
21420     */
21421    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21422
21423    /**
21424     * Create a new marker class.
21425     *
21426     * @param obj The map object.
21427     * @return Returns the new group class.
21428     *
21429     * Each marker must be associated to a class.
21430     *
21431     * The marker class defines the style of the marker when a marker is
21432     * displayed alone, i.e., not grouped to to others markers. When grouped
21433     * it will use group class style.
21434     *
21435     * A marker class will need to be provided when creating a marker with
21436     * elm_map_marker_add().
21437     *
21438     * Some properties and functions can be set by class, as:
21439     * - style, with elm_map_marker_class_style_set()
21440     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21441     *   It can be set using elm_map_marker_class_icon_cb_set().
21442     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21443     *   Set using elm_map_marker_class_get_cb_set().
21444     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21445     *   Set using elm_map_marker_class_del_cb_set().
21446     *
21447     * @see elm_map_marker_add()
21448     * @see elm_map_marker_class_style_set()
21449     * @see elm_map_marker_class_icon_cb_set()
21450     * @see elm_map_marker_class_get_cb_set()
21451     * @see elm_map_marker_class_del_cb_set()
21452     *
21453     * @ingroup Map
21454     */
21455    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21456
21457    /**
21458     * Set the marker's style of a marker class.
21459     *
21460     * @param clas The marker class.
21461     * @param style The style to be used by markers.
21462     *
21463     * Each marker must be associated to a marker class, and will use the style
21464     * defined by such class when alone, i.e., @b not grouped to other markers.
21465     *
21466     * The following styles are provided by default theme:
21467     * @li @c radio
21468     * @li @c radio2
21469     * @li @c empty
21470     *
21471     * @see elm_map_marker_class_new() for more details.
21472     * @see elm_map_marker_add()
21473     *
21474     * @ingroup Map
21475     */
21476    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21477
21478    /**
21479     * Set the icon callback function of a marker class.
21480     *
21481     * @param clas The marker class.
21482     * @param icon_get The callback function that will return the icon.
21483     *
21484     * Each marker must be associated to a marker class, and it can display a
21485     * custom icon. The function @p icon_get must return this icon.
21486     *
21487     * @see elm_map_marker_class_new() for more details.
21488     * @see elm_map_marker_add()
21489     *
21490     * @ingroup Map
21491     */
21492    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21493
21494    /**
21495     * Set the bubble content callback function of a marker class.
21496     *
21497     * @param clas The marker class.
21498     * @param get The callback function that will return the content.
21499     *
21500     * Each marker must be associated to a marker class, and it can display a
21501     * a content on a bubble that opens when the user click over the marker.
21502     * The function @p get must return this content object.
21503     *
21504     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21505     * can be used.
21506     *
21507     * @see elm_map_marker_class_new() for more details.
21508     * @see elm_map_marker_class_del_cb_set()
21509     * @see elm_map_marker_add()
21510     *
21511     * @ingroup Map
21512     */
21513    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21514
21515    /**
21516     * Set the callback function used to delete bubble content of a marker class.
21517     *
21518     * @param clas The marker class.
21519     * @param del The callback function that will delete the content.
21520     *
21521     * Each marker must be associated to a marker class, and it can display a
21522     * a content on a bubble that opens when the user click over the marker.
21523     * The function to return such content can be set with
21524     * elm_map_marker_class_get_cb_set().
21525     *
21526     * If this content must be freed, a callback function need to be
21527     * set for that task with this function.
21528     *
21529     * If this callback is defined it will have to delete (or not) the
21530     * object inside, but if the callback is not defined the object will be
21531     * destroyed with evas_object_del().
21532     *
21533     * @see elm_map_marker_class_new() for more details.
21534     * @see elm_map_marker_class_get_cb_set()
21535     * @see elm_map_marker_add()
21536     *
21537     * @ingroup Map
21538     */
21539    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21540
21541    /**
21542     * Get the list of available sources.
21543     *
21544     * @param obj The map object.
21545     * @return The source names list.
21546     *
21547     * It will provide a list with all available sources, that can be set as
21548     * current source with elm_map_source_name_set(), or get with
21549     * elm_map_source_name_get().
21550     *
21551     * Available sources:
21552     * @li "Mapnik"
21553     * @li "Osmarender"
21554     * @li "CycleMap"
21555     * @li "Maplint"
21556     *
21557     * @see elm_map_source_name_set() for more details.
21558     * @see elm_map_source_name_get()
21559     *
21560     * @ingroup Map
21561     */
21562    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21563
21564    /**
21565     * Set the source of the map.
21566     *
21567     * @param obj The map object.
21568     * @param source The source to be used.
21569     *
21570     * Map widget retrieves images that composes the map from a web service.
21571     * This web service can be set with this method.
21572     *
21573     * A different service can return a different maps with different
21574     * information and it can use different zoom values.
21575     *
21576     * The @p source_name need to match one of the names provided by
21577     * elm_map_source_names_get().
21578     *
21579     * The current source can be get using elm_map_source_name_get().
21580     *
21581     * @see elm_map_source_names_get()
21582     * @see elm_map_source_name_get()
21583     *
21584     *
21585     * @ingroup Map
21586     */
21587    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21588
21589    /**
21590     * Get the name of currently used source.
21591     *
21592     * @param obj The map object.
21593     * @return Returns the name of the source in use.
21594     *
21595     * @see elm_map_source_name_set() for more details.
21596     *
21597     * @ingroup Map
21598     */
21599    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21600
21601    /**
21602     * Set the source of the route service to be used by the map.
21603     *
21604     * @param obj The map object.
21605     * @param source The route service to be used, being it one of
21606     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21607     * and #ELM_MAP_ROUTE_SOURCE_ORS.
21608     *
21609     * Each one has its own algorithm, so the route retrieved may
21610     * differ depending on the source route. Now, only the default is working.
21611     *
21612     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21613     * http://www.yournavigation.org/.
21614     *
21615     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21616     * assumptions. Its routing core is based on Contraction Hierarchies.
21617     *
21618     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21619     *
21620     * @see elm_map_route_source_get().
21621     *
21622     * @ingroup Map
21623     */
21624    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21625
21626    /**
21627     * Get the current route source.
21628     *
21629     * @param obj The map object.
21630     * @return The source of the route service used by the map.
21631     *
21632     * @see elm_map_route_source_set() for details.
21633     *
21634     * @ingroup Map
21635     */
21636    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21637
21638    /**
21639     * Set the minimum zoom of the source.
21640     *
21641     * @param obj The map object.
21642     * @param zoom New minimum zoom value to be used.
21643     *
21644     * By default, it's 0.
21645     *
21646     * @ingroup Map
21647     */
21648    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21649
21650    /**
21651     * Get the minimum zoom of the source.
21652     *
21653     * @param obj The map object.
21654     * @return Returns the minimum zoom of the source.
21655     *
21656     * @see elm_map_source_zoom_min_set() for details.
21657     *
21658     * @ingroup Map
21659     */
21660    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21661
21662    /**
21663     * Set the maximum zoom of the source.
21664     *
21665     * @param obj The map object.
21666     * @param zoom New maximum zoom value to be used.
21667     *
21668     * By default, it's 18.
21669     *
21670     * @ingroup Map
21671     */
21672    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21673
21674    /**
21675     * Get the maximum zoom of the source.
21676     *
21677     * @param obj The map object.
21678     * @return Returns the maximum zoom of the source.
21679     *
21680     * @see elm_map_source_zoom_min_set() for details.
21681     *
21682     * @ingroup Map
21683     */
21684    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21685
21686    /**
21687     * Set the user agent used by the map object to access routing services.
21688     *
21689     * @param obj The map object.
21690     * @param user_agent The user agent to be used by the map.
21691     *
21692     * User agent is a client application implementing a network protocol used
21693     * in communications within a client–server distributed computing system
21694     *
21695     * The @p user_agent identification string will transmitted in a header
21696     * field @c User-Agent.
21697     *
21698     * @see elm_map_user_agent_get()
21699     *
21700     * @ingroup Map
21701     */
21702    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21703
21704    /**
21705     * Get the user agent used by the map object.
21706     *
21707     * @param obj The map object.
21708     * @return The user agent identification string used by the map.
21709     *
21710     * @see elm_map_user_agent_set() for details.
21711     *
21712     * @ingroup Map
21713     */
21714    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21715
21716    /**
21717     * Add a new route to the map object.
21718     *
21719     * @param obj The map object.
21720     * @param type The type of transport to be considered when tracing a route.
21721     * @param method The routing method, what should be priorized.
21722     * @param flon The start longitude.
21723     * @param flat The start latitude.
21724     * @param tlon The destination longitude.
21725     * @param tlat The destination latitude.
21726     *
21727     * @return The created route or @c NULL upon failure.
21728     *
21729     * A route will be traced by point on coordinates (@p flat, @p flon)
21730     * to point on coordinates (@p tlat, @p tlon), using the route service
21731     * set with elm_map_route_source_set().
21732     *
21733     * It will take @p type on consideration to define the route,
21734     * depending if the user will be walking or driving, the route may vary.
21735     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21736     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21737     *
21738     * Another parameter is what the route should priorize, the minor distance
21739     * or the less time to be spend on the route. So @p method should be one
21740     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21741     *
21742     * Routes created with this method can be deleted with
21743     * elm_map_route_remove(), colored with elm_map_route_color_set(),
21744     * and distance can be get with elm_map_route_distance_get().
21745     *
21746     * @see elm_map_route_remove()
21747     * @see elm_map_route_color_set()
21748     * @see elm_map_route_distance_get()
21749     * @see elm_map_route_source_set()
21750     *
21751     * @ingroup Map
21752     */
21753    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);
21754
21755    /**
21756     * Remove a route from the map.
21757     *
21758     * @param route The route to remove.
21759     *
21760     * @see elm_map_route_add()
21761     *
21762     * @ingroup Map
21763     */
21764    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21765
21766    /**
21767     * Set the route color.
21768     *
21769     * @param route The route object.
21770     * @param r Red channel value, from 0 to 255.
21771     * @param g Green channel value, from 0 to 255.
21772     * @param b Blue channel value, from 0 to 255.
21773     * @param a Alpha channel value, from 0 to 255.
21774     *
21775     * It uses an additive color model, so each color channel represents
21776     * how much of each primary colors must to be used. 0 represents
21777     * ausence of this color, so if all of the three are set to 0,
21778     * the color will be black.
21779     *
21780     * These component values should be integers in the range 0 to 255,
21781     * (single 8-bit byte).
21782     *
21783     * This sets the color used for the route. By default, it is set to
21784     * solid red (r = 255, g = 0, b = 0, a = 255).
21785     *
21786     * For alpha channel, 0 represents completely transparent, and 255, opaque.
21787     *
21788     * @see elm_map_route_color_get()
21789     *
21790     * @ingroup Map
21791     */
21792    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21793
21794    /**
21795     * Get the route color.
21796     *
21797     * @param route The route object.
21798     * @param r Pointer where to store the red channel value.
21799     * @param g Pointer where to store the green channel value.
21800     * @param b Pointer where to store the blue channel value.
21801     * @param a Pointer where to store the alpha channel value.
21802     *
21803     * @see elm_map_route_color_set() for details.
21804     *
21805     * @ingroup Map
21806     */
21807    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21808
21809    /**
21810     * Get the route distance in kilometers.
21811     *
21812     * @param route The route object.
21813     * @return The distance of route (unit : km).
21814     *
21815     * @ingroup Map
21816     */
21817    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21818
21819    /**
21820     * Get the information of route nodes.
21821     *
21822     * @param route The route object.
21823     * @return Returns a string with the nodes of route.
21824     *
21825     * @ingroup Map
21826     */
21827    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21828
21829    /**
21830     * Get the information of route waypoint.
21831     *
21832     * @param route the route object.
21833     * @return Returns a string with information about waypoint of route.
21834     *
21835     * @ingroup Map
21836     */
21837    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21838
21839    /**
21840     * Get the address of the name.
21841     *
21842     * @param name The name handle.
21843     * @return Returns the address string of @p name.
21844     *
21845     * This gets the coordinates of the @p name, created with one of the
21846     * conversion functions.
21847     *
21848     * @see elm_map_utils_convert_name_into_coord()
21849     * @see elm_map_utils_convert_coord_into_name()
21850     *
21851     * @ingroup Map
21852     */
21853    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21854
21855    /**
21856     * Get the current coordinates of the name.
21857     *
21858     * @param name The name handle.
21859     * @param lat Pointer where to store the latitude.
21860     * @param lon Pointer where to store The longitude.
21861     *
21862     * This gets the coordinates of the @p name, created with one of the
21863     * conversion functions.
21864     *
21865     * @see elm_map_utils_convert_name_into_coord()
21866     * @see elm_map_utils_convert_coord_into_name()
21867     *
21868     * @ingroup Map
21869     */
21870    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21871
21872    /**
21873     * Remove a name from the map.
21874     *
21875     * @param name The name to remove.
21876     *
21877     * Basically the struct handled by @p name will be freed, so convertions
21878     * between address and coordinates will be lost.
21879     *
21880     * @see elm_map_utils_convert_name_into_coord()
21881     * @see elm_map_utils_convert_coord_into_name()
21882     *
21883     * @ingroup Map
21884     */
21885    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21886
21887    /**
21888     * Rotate the map.
21889     *
21890     * @param obj The map object.
21891     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21892     * @param cx Rotation's center horizontal position.
21893     * @param cy Rotation's center vertical position.
21894     *
21895     * @see elm_map_rotate_get()
21896     *
21897     * @ingroup Map
21898     */
21899    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
21900
21901    /**
21902     * Get the rotate degree of the map
21903     *
21904     * @param obj The map object
21905     * @param degree Pointer where to store degrees from 0.0 to 360.0
21906     * to rotate arount Z axis.
21907     * @param cx Pointer where to store rotation's center horizontal position.
21908     * @param cy Pointer where to store rotation's center vertical position.
21909     *
21910     * @see elm_map_rotate_set() to set map rotation.
21911     *
21912     * @ingroup Map
21913     */
21914    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);
21915
21916    /**
21917     * Enable or disable mouse wheel to be used to zoom in / out the map.
21918     *
21919     * @param obj The map object.
21920     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
21921     * to enable it.
21922     *
21923     * Mouse wheel can be used for the user to zoom in or zoom out the map.
21924     *
21925     * It's disabled by default.
21926     *
21927     * @see elm_map_wheel_disabled_get()
21928     *
21929     * @ingroup Map
21930     */
21931    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
21932
21933    /**
21934     * Get a value whether mouse wheel is enabled or not.
21935     *
21936     * @param obj The map object.
21937     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
21938     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21939     *
21940     * Mouse wheel can be used for the user to zoom in or zoom out the map.
21941     *
21942     * @see elm_map_wheel_disabled_set() for details.
21943     *
21944     * @ingroup Map
21945     */
21946    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21947
21948 #ifdef ELM_EMAP
21949    /**
21950     * Add a track on the map
21951     *
21952     * @param obj The map object.
21953     * @param emap The emap route object.
21954     * @return The route object. This is an elm object of type Route.
21955     *
21956     * @see elm_route_add() for details.
21957     *
21958     * @ingroup Map
21959     */
21960    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
21961 #endif
21962
21963    /**
21964     * Remove a track from the map
21965     *
21966     * @param obj The map object.
21967     * @param route The track to remove.
21968     *
21969     * @ingroup Map
21970     */
21971    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
21972
21973    /**
21974     * @}
21975     */
21976
21977    /* Route */
21978    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
21979 #ifdef ELM_EMAP
21980    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
21981 #endif
21982    EAPI double elm_route_lon_min_get(Evas_Object *obj);
21983    EAPI double elm_route_lat_min_get(Evas_Object *obj);
21984    EAPI double elm_route_lon_max_get(Evas_Object *obj);
21985    EAPI double elm_route_lat_max_get(Evas_Object *obj);
21986
21987
21988    /**
21989     * @defgroup Panel Panel
21990     *
21991     * @image html img/widget/panel/preview-00.png
21992     * @image latex img/widget/panel/preview-00.eps
21993     *
21994     * @brief A panel is a type of animated container that contains subobjects.
21995     * It can be expanded or contracted by clicking the button on it's edge.
21996     *
21997     * Orientations are as follows:
21998     * @li ELM_PANEL_ORIENT_TOP
21999     * @li ELM_PANEL_ORIENT_LEFT
22000     * @li ELM_PANEL_ORIENT_RIGHT
22001     *
22002     * @ref tutorial_panel shows one way to use this widget.
22003     * @{
22004     */
22005    typedef enum _Elm_Panel_Orient
22006      {
22007         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22008         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22009         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22010         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22011      } Elm_Panel_Orient;
22012    /**
22013     * @brief Adds a panel object
22014     *
22015     * @param parent The parent object
22016     *
22017     * @return The panel object, or NULL on failure
22018     */
22019    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22020    /**
22021     * @brief Sets the orientation of the panel
22022     *
22023     * @param parent The parent object
22024     * @param orient The panel orientation. Can be one of the following:
22025     * @li ELM_PANEL_ORIENT_TOP
22026     * @li ELM_PANEL_ORIENT_LEFT
22027     * @li ELM_PANEL_ORIENT_RIGHT
22028     *
22029     * Sets from where the panel will (dis)appear.
22030     */
22031    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22032    /**
22033     * @brief Get the orientation of the panel.
22034     *
22035     * @param obj The panel object
22036     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22037     */
22038    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22039    /**
22040     * @brief Set the content of the panel.
22041     *
22042     * @param obj The panel object
22043     * @param content The panel content
22044     *
22045     * Once the content object is set, a previously set one will be deleted.
22046     * If you want to keep that old content object, use the
22047     * elm_panel_content_unset() function.
22048     */
22049    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22050    /**
22051     * @brief Get the content of the panel.
22052     *
22053     * @param obj The panel object
22054     * @return The content that is being used
22055     *
22056     * Return the content object which is set for this widget.
22057     *
22058     * @see elm_panel_content_set()
22059     */
22060    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22061    /**
22062     * @brief Unset the content of the panel.
22063     *
22064     * @param obj The panel object
22065     * @return The content that was being used
22066     *
22067     * Unparent and return the content object which was set for this widget.
22068     *
22069     * @see elm_panel_content_set()
22070     */
22071    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22072    /**
22073     * @brief Set the state of the panel.
22074     *
22075     * @param obj The panel object
22076     * @param hidden If true, the panel will run the animation to contract
22077     */
22078    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22079    /**
22080     * @brief Get the state of the panel.
22081     *
22082     * @param obj The panel object
22083     * @param hidden If true, the panel is in the "hide" state
22084     */
22085    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22086    /**
22087     * @brief Toggle the hidden state of the panel from code
22088     *
22089     * @param obj The panel object
22090     */
22091    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22092    /**
22093     * @}
22094     */
22095
22096    /**
22097     * @defgroup Panes Panes
22098     * @ingroup Elementary
22099     *
22100     * @image html img/widget/panes/preview-00.png
22101     * @image latex img/widget/panes/preview-00.eps width=\textwidth
22102     *
22103     * @image html img/panes.png
22104     * @image latex img/panes.eps width=\textwidth
22105     *
22106     * The panes adds a dragable bar between two contents. When dragged
22107     * this bar will resize contents size.
22108     *
22109     * Panes can be displayed vertically or horizontally, and contents
22110     * size proportion can be customized (homogeneous by default).
22111     *
22112     * Smart callbacks one can listen to:
22113     * - "press" - The panes has been pressed (button wasn't released yet).
22114     * - "unpressed" - The panes was released after being pressed.
22115     * - "clicked" - The panes has been clicked>
22116     * - "clicked,double" - The panes has been double clicked
22117     *
22118     * Available styles for it:
22119     * - @c "default"
22120     *
22121     * Here is an example on its usage:
22122     * @li @ref panes_example
22123     */
22124
22125    /**
22126     * @addtogroup Panes
22127     * @{
22128     */
22129
22130    /**
22131     * Add a new panes widget to the given parent Elementary
22132     * (container) object.
22133     *
22134     * @param parent The parent object.
22135     * @return a new panes widget handle or @c NULL, on errors.
22136     *
22137     * This function inserts a new panes widget on the canvas.
22138     *
22139     * @ingroup Panes
22140     */
22141    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22142
22143    /**
22144     * Set the left content of the panes widget.
22145     *
22146     * @param obj The panes object.
22147     * @param content The new left content object.
22148     *
22149     * Once the content object is set, a previously set one will be deleted.
22150     * If you want to keep that old content object, use the
22151     * elm_panes_content_left_unset() function.
22152     *
22153     * If panes is displayed vertically, left content will be displayed at
22154     * top.
22155     *
22156     * @see elm_panes_content_left_get()
22157     * @see elm_panes_content_right_set() to set content on the other side.
22158     *
22159     * @ingroup Panes
22160     */
22161    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22162
22163    /**
22164     * Set the right content of the panes widget.
22165     *
22166     * @param obj The panes object.
22167     * @param content The new right content object.
22168     *
22169     * Once the content object is set, a previously set one will be deleted.
22170     * If you want to keep that old content object, use the
22171     * elm_panes_content_right_unset() function.
22172     *
22173     * If panes is displayed vertically, left content will be displayed at
22174     * bottom.
22175     *
22176     * @see elm_panes_content_right_get()
22177     * @see elm_panes_content_left_set() to set content on the other side.
22178     *
22179     * @ingroup Panes
22180     */
22181    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22182
22183    /**
22184     * Get the left content of the panes.
22185     *
22186     * @param obj The panes object.
22187     * @return The left content object that is being used.
22188     *
22189     * Return the left content object which is set for this widget.
22190     *
22191     * @see elm_panes_content_left_set() for details.
22192     *
22193     * @ingroup Panes
22194     */
22195    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22196
22197    /**
22198     * Get the right content of the panes.
22199     *
22200     * @param obj The panes object
22201     * @return The right content object that is being used
22202     *
22203     * Return the right content object which is set for this widget.
22204     *
22205     * @see elm_panes_content_right_set() for details.
22206     *
22207     * @ingroup Panes
22208     */
22209    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22210
22211    /**
22212     * Unset the left content used for the panes.
22213     *
22214     * @param obj The panes object.
22215     * @return The left content object that was being used.
22216     *
22217     * Unparent and return the left content object which was set for this widget.
22218     *
22219     * @see elm_panes_content_left_set() for details.
22220     * @see elm_panes_content_left_get().
22221     *
22222     * @ingroup Panes
22223     */
22224    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22225
22226    /**
22227     * Unset the right content used for the panes.
22228     *
22229     * @param obj The panes object.
22230     * @return The right content object that was being used.
22231     *
22232     * Unparent and return the right content object which was set for this
22233     * widget.
22234     *
22235     * @see elm_panes_content_right_set() for details.
22236     * @see elm_panes_content_right_get().
22237     *
22238     * @ingroup Panes
22239     */
22240    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22241
22242    /**
22243     * Get the size proportion of panes widget's left side.
22244     *
22245     * @param obj The panes object.
22246     * @return float value between 0.0 and 1.0 representing size proportion
22247     * of left side.
22248     *
22249     * @see elm_panes_content_left_size_set() for more details.
22250     *
22251     * @ingroup Panes
22252     */
22253    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22254
22255    /**
22256     * Set the size proportion of panes widget's left side.
22257     *
22258     * @param obj The panes object.
22259     * @param size Value between 0.0 and 1.0 representing size proportion
22260     * of left side.
22261     *
22262     * By default it's homogeneous, i.e., both sides have the same size.
22263     *
22264     * If something different is required, it can be set with this function.
22265     * For example, if the left content should be displayed over
22266     * 75% of the panes size, @p size should be passed as @c 0.75.
22267     * This way, right content will be resized to 25% of panes size.
22268     *
22269     * If displayed vertically, left content is displayed at top, and
22270     * right content at bottom.
22271     *
22272     * @note This proportion will change when user drags the panes bar.
22273     *
22274     * @see elm_panes_content_left_size_get()
22275     *
22276     * @ingroup Panes
22277     */
22278    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22279
22280   /**
22281    * Set the orientation of a given panes widget.
22282    *
22283    * @param obj The panes object.
22284    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22285    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22286    *
22287    * Use this function to change how your panes is to be
22288    * disposed: vertically or horizontally.
22289    *
22290    * By default it's displayed horizontally.
22291    *
22292    * @see elm_panes_horizontal_get()
22293    *
22294    * @ingroup Panes
22295    */
22296    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22297
22298    /**
22299     * Retrieve the orientation of a given panes widget.
22300     *
22301     * @param obj The panes object.
22302     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22303     * @c EINA_FALSE if it's @b vertical (and on errors).
22304     *
22305     * @see elm_panes_horizontal_set() for more details.
22306     *
22307     * @ingroup Panes
22308     */
22309    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22310
22311    /**
22312     * @}
22313     */
22314
22315    /**
22316     * @defgroup Flip Flip
22317     *
22318     * @image html img/widget/flip/preview-00.png
22319     * @image latex img/widget/flip/preview-00.eps
22320     *
22321     * This widget holds 2 content objects(Evas_Object): one on the front and one
22322     * on the back. It allows you to flip from front to back and vice-versa using
22323     * various animations.
22324     *
22325     * If either the front or back contents are not set the flip will treat that
22326     * as transparent. So if you wore to set the front content but not the back,
22327     * and then call elm_flip_go() you would see whatever is below the flip.
22328     *
22329     * For a list of supported animations see elm_flip_go().
22330     *
22331     * Signals that you can add callbacks for are:
22332     * "animate,begin" - when a flip animation was started
22333     * "animate,done" - when a flip animation is finished
22334     *
22335     * @ref tutorial_flip show how to use most of the API.
22336     *
22337     * @{
22338     */
22339    typedef enum _Elm_Flip_Mode
22340      {
22341         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22342         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22343         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22344         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22345         ELM_FLIP_CUBE_LEFT,
22346         ELM_FLIP_CUBE_RIGHT,
22347         ELM_FLIP_CUBE_UP,
22348         ELM_FLIP_CUBE_DOWN,
22349         ELM_FLIP_PAGE_LEFT,
22350         ELM_FLIP_PAGE_RIGHT,
22351         ELM_FLIP_PAGE_UP,
22352         ELM_FLIP_PAGE_DOWN
22353      } Elm_Flip_Mode;
22354    typedef enum _Elm_Flip_Interaction
22355      {
22356         ELM_FLIP_INTERACTION_NONE,
22357         ELM_FLIP_INTERACTION_ROTATE,
22358         ELM_FLIP_INTERACTION_CUBE,
22359         ELM_FLIP_INTERACTION_PAGE
22360      } Elm_Flip_Interaction;
22361    typedef enum _Elm_Flip_Direction
22362      {
22363         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22364         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22365         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22366         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22367      } Elm_Flip_Direction;
22368    /**
22369     * @brief Add a new flip to the parent
22370     *
22371     * @param parent The parent object
22372     * @return The new object or NULL if it cannot be created
22373     */
22374    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22375    /**
22376     * @brief Set the front content of the flip widget.
22377     *
22378     * @param obj The flip object
22379     * @param content The new front content object
22380     *
22381     * Once the content object is set, a previously set one will be deleted.
22382     * If you want to keep that old content object, use the
22383     * elm_flip_content_front_unset() function.
22384     */
22385    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22386    /**
22387     * @brief Set the back content of the flip widget.
22388     *
22389     * @param obj The flip object
22390     * @param content The new back content object
22391     *
22392     * Once the content object is set, a previously set one will be deleted.
22393     * If you want to keep that old content object, use the
22394     * elm_flip_content_back_unset() function.
22395     */
22396    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22397    /**
22398     * @brief Get the front content used for the flip
22399     *
22400     * @param obj The flip object
22401     * @return The front content object that is being used
22402     *
22403     * Return the front content object which is set for this widget.
22404     */
22405    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22406    /**
22407     * @brief Get the back content used for the flip
22408     *
22409     * @param obj The flip object
22410     * @return The back content object that is being used
22411     *
22412     * Return the back content object which is set for this widget.
22413     */
22414    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22415    /**
22416     * @brief Unset the front content used for the flip
22417     *
22418     * @param obj The flip object
22419     * @return The front content object that was being used
22420     *
22421     * Unparent and return the front content object which was set for this widget.
22422     */
22423    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22424    /**
22425     * @brief Unset the back content used for the flip
22426     *
22427     * @param obj The flip object
22428     * @return The back content object that was being used
22429     *
22430     * Unparent and return the back content object which was set for this widget.
22431     */
22432    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22433    /**
22434     * @brief Get flip front visibility state
22435     *
22436     * @param obj The flip objct
22437     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22438     * showing.
22439     */
22440    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22441    /**
22442     * @brief Set flip perspective
22443     *
22444     * @param obj The flip object
22445     * @param foc The coordinate to set the focus on
22446     * @param x The X coordinate
22447     * @param y The Y coordinate
22448     *
22449     * @warning This function currently does nothing.
22450     */
22451    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22452    /**
22453     * @brief Runs the flip animation
22454     *
22455     * @param obj The flip object
22456     * @param mode The mode type
22457     *
22458     * Flips the front and back contents using the @p mode animation. This
22459     * efectively hides the currently visible content and shows the hidden one.
22460     *
22461     * There a number of possible animations to use for the flipping:
22462     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22463     * around a horizontal axis in the middle of its height, the other content
22464     * is shown as the other side of the flip.
22465     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22466     * around a vertical axis in the middle of its width, the other content is
22467     * shown as the other side of the flip.
22468     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22469     * around a diagonal axis in the middle of its width, the other content is
22470     * shown as the other side of the flip.
22471     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22472     * around a diagonal axis in the middle of its height, the other content is
22473     * shown as the other side of the flip.
22474     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22475     * as if the flip was a cube, the other content is show as the right face of
22476     * the cube.
22477     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22478     * right as if the flip was a cube, the other content is show as the left
22479     * face of the cube.
22480     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22481     * flip was a cube, the other content is show as the bottom face of the cube.
22482     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22483     * the flip was a cube, the other content is show as the upper face of the
22484     * cube.
22485     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22486     * if the flip was a book, the other content is shown as the page below that.
22487     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22488     * as if the flip was a book, the other content is shown as the page below
22489     * that.
22490     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22491     * flip was a book, the other content is shown as the page below that.
22492     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22493     * flip was a book, the other content is shown as the page below that.
22494     *
22495     * @image html elm_flip.png
22496     * @image latex elm_flip.eps width=\textwidth
22497     */
22498    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22499    /**
22500     * @brief Set the interactive flip mode
22501     *
22502     * @param obj The flip object
22503     * @param mode The interactive flip mode to use
22504     *
22505     * This sets if the flip should be interactive (allow user to click and
22506     * drag a side of the flip to reveal the back page and cause it to flip).
22507     * By default a flip is not interactive. You may also need to set which
22508     * sides of the flip are "active" for flipping and how much space they use
22509     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22510     * and elm_flip_interacton_direction_hitsize_set()
22511     *
22512     * The four avilable mode of interaction are:
22513     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22514     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22515     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22516     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22517     *
22518     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22519     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22520     * happen, those can only be acheived with elm_flip_go();
22521     */
22522    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22523    /**
22524     * @brief Get the interactive flip mode
22525     *
22526     * @param obj The flip object
22527     * @return The interactive flip mode
22528     *
22529     * Returns the interactive flip mode set by elm_flip_interaction_set()
22530     */
22531    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22532    /**
22533     * @brief Set which directions of the flip respond to interactive flip
22534     *
22535     * @param obj The flip object
22536     * @param dir The direction to change
22537     * @param enabled If that direction is enabled or not
22538     *
22539     * By default all directions are disabled, so you may want to enable the
22540     * desired directions for flipping if you need interactive flipping. You must
22541     * call this function once for each direction that should be enabled.
22542     *
22543     * @see elm_flip_interaction_set()
22544     */
22545    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22546    /**
22547     * @brief Get the enabled state of that flip direction
22548     *
22549     * @param obj The flip object
22550     * @param dir The direction to check
22551     * @return If that direction is enabled or not
22552     *
22553     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22554     *
22555     * @see elm_flip_interaction_set()
22556     */
22557    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22558    /**
22559     * @brief Set the amount of the flip that is sensitive to interactive flip
22560     *
22561     * @param obj The flip object
22562     * @param dir The direction to modify
22563     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22564     *
22565     * Set the amount of the flip that is sensitive to interactive flip, with 0
22566     * representing no area in the flip and 1 representing the entire flip. There
22567     * is however a consideration to be made in that the area will never be
22568     * smaller than the finger size set(as set in your Elementary configuration).
22569     *
22570     * @see elm_flip_interaction_set()
22571     */
22572    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22573    /**
22574     * @brief Get the amount of the flip that is sensitive to interactive flip
22575     *
22576     * @param obj The flip object
22577     * @param dir The direction to check
22578     * @return The size set for that direction
22579     *
22580     * Returns the amount os sensitive area set by
22581     * elm_flip_interacton_direction_hitsize_set().
22582     */
22583    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22584    /**
22585     * @}
22586     */
22587
22588    /* scrolledentry */
22589    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22590    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22591    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22592    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22593    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22594    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22595    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22596    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22597    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22598    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22599    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22600    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22601    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22602    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22603    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22604    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22605    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22606    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22607    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22608    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22609    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22610    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22611    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22612    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22613    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22614    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22615    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22616    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22617    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22618    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22619    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22620    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22621    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22622    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22623    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22624    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);
22625    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22626    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22627    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);
22628    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22629    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);
22630    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22631    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22632    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22633    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22634    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22635    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22636    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22637    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22638    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);
22639    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);
22640    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);
22641    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);
22642    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);
22643    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);
22644    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22645    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22646    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22647    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22648    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22649    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22650    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22651
22652    /**
22653     * @defgroup Conformant Conformant
22654     * @ingroup Elementary
22655     *
22656     * @image html img/widget/conformant/preview-00.png
22657     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22658     *
22659     * @image html img/conformant.png
22660     * @image latex img/conformant.eps width=\textwidth
22661     *
22662     * The aim is to provide a widget that can be used in elementary apps to
22663     * account for space taken up by the indicator, virtual keypad & softkey
22664     * windows when running the illume2 module of E17.
22665     *
22666     * So conformant content will be sized and positioned considering the
22667     * space required for such stuff, and when they popup, as a keyboard
22668     * shows when an entry is selected, conformant content won't change.
22669     *
22670     * Available styles for it:
22671     * - @c "default"
22672     *
22673     * See how to use this widget in this example:
22674     * @ref conformant_example
22675     */
22676
22677    /**
22678     * @addtogroup Conformant
22679     * @{
22680     */
22681
22682    /**
22683     * Add a new conformant widget to the given parent Elementary
22684     * (container) object.
22685     *
22686     * @param parent The parent object.
22687     * @return A new conformant widget handle or @c NULL, on errors.
22688     *
22689     * This function inserts a new conformant widget on the canvas.
22690     *
22691     * @ingroup Conformant
22692     */
22693    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22694
22695    /**
22696     * Set the content of the conformant widget.
22697     *
22698     * @param obj The conformant object.
22699     * @param content The content to be displayed by the conformant.
22700     *
22701     * Content will be sized and positioned considering the space required
22702     * to display a virtual keyboard. So it won't fill all the conformant
22703     * size. This way is possible to be sure that content won't resize
22704     * or be re-positioned after the keyboard is displayed.
22705     *
22706     * Once the content object is set, a previously set one will be deleted.
22707     * If you want to keep that old content object, use the
22708     * elm_conformat_content_unset() function.
22709     *
22710     * @see elm_conformant_content_unset()
22711     * @see elm_conformant_content_get()
22712     *
22713     * @ingroup Conformant
22714     */
22715    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22716
22717    /**
22718     * Get the content of the conformant widget.
22719     *
22720     * @param obj The conformant object.
22721     * @return The content that is being used.
22722     *
22723     * Return the content object which is set for this widget.
22724     * It won't be unparent from conformant. For that, use
22725     * elm_conformant_content_unset().
22726     *
22727     * @see elm_conformant_content_set() for more details.
22728     * @see elm_conformant_content_unset()
22729     *
22730     * @ingroup Conformant
22731     */
22732    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22733
22734    /**
22735     * Unset the content of the conformant widget.
22736     *
22737     * @param obj The conformant object.
22738     * @return The content that was being used.
22739     *
22740     * Unparent and return the content object which was set for this widget.
22741     *
22742     * @see elm_conformant_content_set() for more details.
22743     *
22744     * @ingroup Conformant
22745     */
22746    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22747
22748    /**
22749     * Returns the Evas_Object that represents the content area.
22750     *
22751     * @param obj The conformant object.
22752     * @return The content area of the widget.
22753     *
22754     * @ingroup Conformant
22755     */
22756    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22757
22758    /**
22759     * @}
22760     */
22761
22762    /**
22763     * @defgroup Mapbuf Mapbuf
22764     * @ingroup Elementary
22765     *
22766     * @image html img/widget/mapbuf/preview-00.png
22767     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22768     *
22769     * This holds one content object and uses an Evas Map of transformation
22770     * points to be later used with this content. So the content will be
22771     * moved, resized, etc as a single image. So it will improve performance
22772     * when you have a complex interafce, with a lot of elements, and will
22773     * need to resize or move it frequently (the content object and its
22774     * children).
22775     *
22776     * See how to use this widget in this example:
22777     * @ref mapbuf_example
22778     */
22779
22780    /**
22781     * @addtogroup Mapbuf
22782     * @{
22783     */
22784
22785    /**
22786     * Add a new mapbuf widget to the given parent Elementary
22787     * (container) object.
22788     *
22789     * @param parent The parent object.
22790     * @return A new mapbuf widget handle or @c NULL, on errors.
22791     *
22792     * This function inserts a new mapbuf widget on the canvas.
22793     *
22794     * @ingroup Mapbuf
22795     */
22796    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22797
22798    /**
22799     * Set the content of the mapbuf.
22800     *
22801     * @param obj The mapbuf object.
22802     * @param content The content that will be filled in this mapbuf object.
22803     *
22804     * Once the content object is set, a previously set one will be deleted.
22805     * If you want to keep that old content object, use the
22806     * elm_mapbuf_content_unset() function.
22807     *
22808     * To enable map, elm_mapbuf_enabled_set() should be used.
22809     *
22810     * @ingroup Mapbuf
22811     */
22812    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22813
22814    /**
22815     * Get the content of the mapbuf.
22816     *
22817     * @param obj The mapbuf object.
22818     * @return The content that is being used.
22819     *
22820     * Return the content object which is set for this widget.
22821     *
22822     * @see elm_mapbuf_content_set() for details.
22823     *
22824     * @ingroup Mapbuf
22825     */
22826    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22827
22828    /**
22829     * Unset the content of the mapbuf.
22830     *
22831     * @param obj The mapbuf object.
22832     * @return The content that was being used.
22833     *
22834     * Unparent and return the content object which was set for this widget.
22835     *
22836     * @see elm_mapbuf_content_set() for details.
22837     *
22838     * @ingroup Mapbuf
22839     */
22840    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22841
22842    /**
22843     * Enable or disable the map.
22844     *
22845     * @param obj The mapbuf object.
22846     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22847     *
22848     * This enables the map that is set or disables it. On enable, the object
22849     * geometry will be saved, and the new geometry will change (position and
22850     * size) to reflect the map geometry set.
22851     *
22852     * Also, when enabled, alpha and smooth states will be used, so if the
22853     * content isn't solid, alpha should be enabled, for example, otherwise
22854     * a black retangle will fill the content.
22855     *
22856     * When disabled, the stored map will be freed and geometry prior to
22857     * enabling the map will be restored.
22858     *
22859     * It's disabled by default.
22860     *
22861     * @see elm_mapbuf_alpha_set()
22862     * @see elm_mapbuf_smooth_set()
22863     *
22864     * @ingroup Mapbuf
22865     */
22866    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22867
22868    /**
22869     * Get a value whether map is enabled or not.
22870     *
22871     * @param obj The mapbuf object.
22872     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22873     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22874     *
22875     * @see elm_mapbuf_enabled_set() for details.
22876     *
22877     * @ingroup Mapbuf
22878     */
22879    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22880
22881    /**
22882     * Enable or disable smooth map rendering.
22883     *
22884     * @param obj The mapbuf object.
22885     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22886     * to disable it.
22887     *
22888     * This sets smoothing for map rendering. If the object is a type that has
22889     * its own smoothing settings, then both the smooth settings for this object
22890     * and the map must be turned off.
22891     *
22892     * By default smooth maps are enabled.
22893     *
22894     * @ingroup Mapbuf
22895     */
22896    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
22897
22898    /**
22899     * Get a value whether smooth map rendering is enabled or not.
22900     *
22901     * @param obj The mapbuf object.
22902     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
22903     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22904     *
22905     * @see elm_mapbuf_smooth_set() for details.
22906     *
22907     * @ingroup Mapbuf
22908     */
22909    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22910
22911    /**
22912     * Set or unset alpha flag for map rendering.
22913     *
22914     * @param obj The mapbuf object.
22915     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
22916     * to disable it.
22917     *
22918     * This sets alpha flag for map rendering. If the object is a type that has
22919     * its own alpha settings, then this will take precedence. Only image objects
22920     * have this currently. It stops alpha blending of the map area, and is
22921     * useful if you know the object and/or all sub-objects is 100% solid.
22922     *
22923     * Alpha is enabled by default.
22924     *
22925     * @ingroup Mapbuf
22926     */
22927    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
22928
22929    /**
22930     * Get a value whether alpha blending is enabled or not.
22931     *
22932     * @param obj The mapbuf object.
22933     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
22934     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22935     *
22936     * @see elm_mapbuf_alpha_set() for details.
22937     *
22938     * @ingroup Mapbuf
22939     */
22940    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22941
22942    /**
22943     * @}
22944     */
22945
22946    /**
22947     * @defgroup Flipselector Flip Selector
22948     *
22949     * @image html img/widget/flipselector/preview-00.png
22950     * @image latex img/widget/flipselector/preview-00.eps
22951     *
22952     * A flip selector is a widget to show a set of @b text items, one
22953     * at a time, with the same sheet switching style as the @ref Clock
22954     * "clock" widget, when one changes the current displaying sheet
22955     * (thus, the "flip" in the name).
22956     *
22957     * User clicks to flip sheets which are @b held for some time will
22958     * make the flip selector to flip continuosly and automatically for
22959     * the user. The interval between flips will keep growing in time,
22960     * so that it helps the user to reach an item which is distant from
22961     * the current selection.
22962     *
22963     * Smart callbacks one can register to:
22964     * - @c "selected" - when the widget's selected text item is changed
22965     * - @c "overflowed" - when the widget's current selection is changed
22966     *   from the first item in its list to the last
22967     * - @c "underflowed" - when the widget's current selection is changed
22968     *   from the last item in its list to the first
22969     *
22970     * Available styles for it:
22971     * - @c "default"
22972     *
22973     * Here is an example on its usage:
22974     * @li @ref flipselector_example
22975     */
22976
22977    /**
22978     * @addtogroup Flipselector
22979     * @{
22980     */
22981
22982    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
22983
22984    /**
22985     * Add a new flip selector widget to the given parent Elementary
22986     * (container) widget
22987     *
22988     * @param parent The parent object
22989     * @return a new flip selector widget handle or @c NULL, on errors
22990     *
22991     * This function inserts a new flip selector widget on the canvas.
22992     *
22993     * @ingroup Flipselector
22994     */
22995    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22996
22997    /**
22998     * Programmatically select the next item of a flip selector widget
22999     *
23000     * @param obj The flipselector object
23001     *
23002     * @note The selection will be animated. Also, if it reaches the
23003     * end of its list of member items, it will continue with the first
23004     * one onwards.
23005     *
23006     * @ingroup Flipselector
23007     */
23008    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23009
23010    /**
23011     * Programmatically select the previous item of a flip selector
23012     * widget
23013     *
23014     * @param obj The flipselector object
23015     *
23016     * @note The selection will be animated.  Also, if it reaches the
23017     * beginning of its list of member items, it will continue with the
23018     * last one backwards.
23019     *
23020     * @ingroup Flipselector
23021     */
23022    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23023
23024    /**
23025     * Append a (text) item to a flip selector widget
23026     *
23027     * @param obj The flipselector object
23028     * @param label The (text) label of the new item
23029     * @param func Convenience callback function to take place when
23030     * item is selected
23031     * @param data Data passed to @p func, above
23032     * @return A handle to the item added or @c NULL, on errors
23033     *
23034     * The widget's list of labels to show will be appended with the
23035     * given value. If the user wishes so, a callback function pointer
23036     * can be passed, which will get called when this same item is
23037     * selected.
23038     *
23039     * @note The current selection @b won't be modified by appending an
23040     * element to the list.
23041     *
23042     * @note The maximum length of the text label is going to be
23043     * determined <b>by the widget's theme</b>. Strings larger than
23044     * that value are going to be @b truncated.
23045     *
23046     * @ingroup Flipselector
23047     */
23048    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23049
23050    /**
23051     * Prepend a (text) item to a flip selector widget
23052     *
23053     * @param obj The flipselector object
23054     * @param label The (text) label of the new item
23055     * @param func Convenience callback function to take place when
23056     * item is selected
23057     * @param data Data passed to @p func, above
23058     * @return A handle to the item added or @c NULL, on errors
23059     *
23060     * The widget's list of labels to show will be prepended with the
23061     * given value. If the user wishes so, a callback function pointer
23062     * can be passed, which will get called when this same item is
23063     * selected.
23064     *
23065     * @note The current selection @b won't be modified by prepending
23066     * an element to the list.
23067     *
23068     * @note The maximum length of the text label is going to be
23069     * determined <b>by the widget's theme</b>. Strings larger than
23070     * that value are going to be @b truncated.
23071     *
23072     * @ingroup Flipselector
23073     */
23074    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23075
23076    /**
23077     * Get the internal list of items in a given flip selector widget.
23078     *
23079     * @param obj The flipselector object
23080     * @return The list of items (#Elm_Flipselector_Item as data) or
23081     * @c NULL on errors.
23082     *
23083     * This list is @b not to be modified in any way and must not be
23084     * freed. Use the list members with functions like
23085     * elm_flipselector_item_label_set(),
23086     * elm_flipselector_item_label_get(),
23087     * elm_flipselector_item_del(),
23088     * elm_flipselector_item_selected_get(),
23089     * elm_flipselector_item_selected_set().
23090     *
23091     * @warning This list is only valid until @p obj object's internal
23092     * items list is changed. It should be fetched again with another
23093     * call to this function when changes happen.
23094     *
23095     * @ingroup Flipselector
23096     */
23097    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23098
23099    /**
23100     * Get the first item in the given flip selector widget's list of
23101     * items.
23102     *
23103     * @param obj The flipselector object
23104     * @return The first item or @c NULL, if it has no items (and on
23105     * errors)
23106     *
23107     * @see elm_flipselector_item_append()
23108     * @see elm_flipselector_last_item_get()
23109     *
23110     * @ingroup Flipselector
23111     */
23112    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23113
23114    /**
23115     * Get the last item in the given flip selector widget's list of
23116     * items.
23117     *
23118     * @param obj The flipselector object
23119     * @return The last item or @c NULL, if it has no items (and on
23120     * errors)
23121     *
23122     * @see elm_flipselector_item_prepend()
23123     * @see elm_flipselector_first_item_get()
23124     *
23125     * @ingroup Flipselector
23126     */
23127    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23128
23129    /**
23130     * Get the currently selected item in a flip selector widget.
23131     *
23132     * @param obj The flipselector object
23133     * @return The selected item or @c NULL, if the widget has no items
23134     * (and on erros)
23135     *
23136     * @ingroup Flipselector
23137     */
23138    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23139
23140    /**
23141     * Set whether a given flip selector widget's item should be the
23142     * currently selected one.
23143     *
23144     * @param item The flip selector item
23145     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23146     *
23147     * This sets whether @p item is or not the selected (thus, under
23148     * display) one. If @p item is different than one under display,
23149     * the latter will be unselected. If the @p item is set to be
23150     * unselected, on the other hand, the @b first item in the widget's
23151     * internal members list will be the new selected one.
23152     *
23153     * @see elm_flipselector_item_selected_get()
23154     *
23155     * @ingroup Flipselector
23156     */
23157    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23158
23159    /**
23160     * Get whether a given flip selector widget's item is the currently
23161     * selected one.
23162     *
23163     * @param item The flip selector item
23164     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23165     * (or on errors).
23166     *
23167     * @see elm_flipselector_item_selected_set()
23168     *
23169     * @ingroup Flipselector
23170     */
23171    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23172
23173    /**
23174     * Delete a given item from a flip selector widget.
23175     *
23176     * @param item The item to delete
23177     *
23178     * @ingroup Flipselector
23179     */
23180    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23181
23182    /**
23183     * Get the label of a given flip selector widget's item.
23184     *
23185     * @param item The item to get label from
23186     * @return The text label of @p item or @c NULL, on errors
23187     *
23188     * @see elm_flipselector_item_label_set()
23189     *
23190     * @ingroup Flipselector
23191     */
23192    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23193
23194    /**
23195     * Set the label of a given flip selector widget's item.
23196     *
23197     * @param item The item to set label on
23198     * @param label The text label string, in UTF-8 encoding
23199     *
23200     * @see elm_flipselector_item_label_get()
23201     *
23202     * @ingroup Flipselector
23203     */
23204    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23205
23206    /**
23207     * Gets the item before @p item in a flip selector widget's
23208     * internal list of items.
23209     *
23210     * @param item The item to fetch previous from
23211     * @return The item before the @p item, in its parent's list. If
23212     *         there is no previous item for @p item or there's an
23213     *         error, @c NULL is returned.
23214     *
23215     * @see elm_flipselector_item_next_get()
23216     *
23217     * @ingroup Flipselector
23218     */
23219    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23220
23221    /**
23222     * Gets the item after @p item in a flip selector widget's
23223     * internal list of items.
23224     *
23225     * @param item The item to fetch next from
23226     * @return The item after the @p item, in its parent's list. If
23227     *         there is no next item for @p item or there's an
23228     *         error, @c NULL is returned.
23229     *
23230     * @see elm_flipselector_item_next_get()
23231     *
23232     * @ingroup Flipselector
23233     */
23234    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23235
23236    /**
23237     * Set the interval on time updates for an user mouse button hold
23238     * on a flip selector widget.
23239     *
23240     * @param obj The flip selector object
23241     * @param interval The (first) interval value in seconds
23242     *
23243     * This interval value is @b decreased while the user holds the
23244     * mouse pointer either flipping up or flipping doww a given flip
23245     * selector.
23246     *
23247     * This helps the user to get to a given item distant from the
23248     * current one easier/faster, as it will start to flip quicker and
23249     * quicker on mouse button holds.
23250     *
23251     * The calculation for the next flip interval value, starting from
23252     * the one set with this call, is the previous interval divided by
23253     * 1.05, so it decreases a little bit.
23254     *
23255     * The default starting interval value for automatic flips is
23256     * @b 0.85 seconds.
23257     *
23258     * @see elm_flipselector_interval_get()
23259     *
23260     * @ingroup Flipselector
23261     */
23262    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23263
23264    /**
23265     * Get the interval on time updates for an user mouse button hold
23266     * on a flip selector widget.
23267     *
23268     * @param obj The flip selector object
23269     * @return The (first) interval value, in seconds, set on it
23270     *
23271     * @see elm_flipselector_interval_set() for more details
23272     *
23273     * @ingroup Flipselector
23274     */
23275    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23276    /**
23277     * @}
23278     */
23279
23280    /**
23281     * @addtogroup Calendar
23282     * @{
23283     */
23284
23285    /**
23286     * @enum _Elm_Calendar_Mark_Repeat
23287     * @typedef Elm_Calendar_Mark_Repeat
23288     *
23289     * Event periodicity, used to define if a mark should be repeated
23290     * @b beyond event's day. It's set when a mark is added.
23291     *
23292     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23293     * there will be marks every week after this date. Marks will be displayed
23294     * at 13th, 20th, 27th, 3rd June ...
23295     *
23296     * Values don't work as bitmask, only one can be choosen.
23297     *
23298     * @see elm_calendar_mark_add()
23299     *
23300     * @ingroup Calendar
23301     */
23302    typedef enum _Elm_Calendar_Mark_Repeat
23303      {
23304         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23305         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23306         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23307         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*/
23308         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. */
23309      } Elm_Calendar_Mark_Repeat;
23310
23311    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(). */
23312
23313    /**
23314     * Add a new calendar widget to the given parent Elementary
23315     * (container) object.
23316     *
23317     * @param parent The parent object.
23318     * @return a new calendar widget handle or @c NULL, on errors.
23319     *
23320     * This function inserts a new calendar widget on the canvas.
23321     *
23322     * @ref calendar_example_01
23323     *
23324     * @ingroup Calendar
23325     */
23326    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23327
23328    /**
23329     * Get weekdays names displayed by the calendar.
23330     *
23331     * @param obj The calendar object.
23332     * @return Array of seven strings to be used as weekday names.
23333     *
23334     * By default, weekdays abbreviations get from system are displayed:
23335     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23336     * The first string is related to Sunday, the second to Monday...
23337     *
23338     * @see elm_calendar_weekdays_name_set()
23339     *
23340     * @ref calendar_example_05
23341     *
23342     * @ingroup Calendar
23343     */
23344    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23345
23346    /**
23347     * Set weekdays names to be displayed by the calendar.
23348     *
23349     * @param obj The calendar object.
23350     * @param weekdays Array of seven strings to be used as weekday names.
23351     * @warning It must have 7 elements, or it will access invalid memory.
23352     * @warning The strings must be NULL terminated ('@\0').
23353     *
23354     * By default, weekdays abbreviations get from system are displayed:
23355     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23356     *
23357     * The first string should be related to Sunday, the second to Monday...
23358     *
23359     * The usage should be like this:
23360     * @code
23361     *   const char *weekdays[] =
23362     *   {
23363     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23364     *      "Thursday", "Friday", "Saturday"
23365     *   };
23366     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23367     * @endcode
23368     *
23369     * @see elm_calendar_weekdays_name_get()
23370     *
23371     * @ref calendar_example_02
23372     *
23373     * @ingroup Calendar
23374     */
23375    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23376
23377    /**
23378     * Set the minimum and maximum values for the year
23379     *
23380     * @param obj The calendar object
23381     * @param min The minimum year, greater than 1901;
23382     * @param max The maximum year;
23383     *
23384     * Maximum must be greater than minimum, except if you don't wan't to set
23385     * maximum year.
23386     * Default values are 1902 and -1.
23387     *
23388     * If the maximum year is a negative value, it will be limited depending
23389     * on the platform architecture (year 2037 for 32 bits);
23390     *
23391     * @see elm_calendar_min_max_year_get()
23392     *
23393     * @ref calendar_example_03
23394     *
23395     * @ingroup Calendar
23396     */
23397    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23398
23399    /**
23400     * Get the minimum and maximum values for the year
23401     *
23402     * @param obj The calendar object.
23403     * @param min The minimum year.
23404     * @param max The maximum year.
23405     *
23406     * Default values are 1902 and -1.
23407     *
23408     * @see elm_calendar_min_max_year_get() for more details.
23409     *
23410     * @ref calendar_example_05
23411     *
23412     * @ingroup Calendar
23413     */
23414    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23415
23416    /**
23417     * Enable or disable day selection
23418     *
23419     * @param obj The calendar object.
23420     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23421     * disable it.
23422     *
23423     * Enabled by default. If disabled, the user still can select months,
23424     * but not days. Selected days are highlighted on calendar.
23425     * It should be used if you won't need such selection for the widget usage.
23426     *
23427     * When a day is selected, or month is changed, smart callbacks for
23428     * signal "changed" will be called.
23429     *
23430     * @see elm_calendar_day_selection_enable_get()
23431     *
23432     * @ref calendar_example_04
23433     *
23434     * @ingroup Calendar
23435     */
23436    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23437
23438    /**
23439     * Get a value whether day selection is enabled or not.
23440     *
23441     * @see elm_calendar_day_selection_enable_set() for details.
23442     *
23443     * @param obj The calendar object.
23444     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23445     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23446     *
23447     * @ref calendar_example_05
23448     *
23449     * @ingroup Calendar
23450     */
23451    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23452
23453
23454    /**
23455     * Set selected date to be highlighted on calendar.
23456     *
23457     * @param obj The calendar object.
23458     * @param selected_time A @b tm struct to represent the selected date.
23459     *
23460     * Set the selected date, changing the displayed month if needed.
23461     * Selected date changes when the user goes to next/previous month or
23462     * select a day pressing over it on calendar.
23463     *
23464     * @see elm_calendar_selected_time_get()
23465     *
23466     * @ref calendar_example_04
23467     *
23468     * @ingroup Calendar
23469     */
23470    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23471
23472    /**
23473     * Get selected date.
23474     *
23475     * @param obj The calendar object
23476     * @param selected_time A @b tm struct to point to selected date
23477     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23478     * be considered.
23479     *
23480     * Get date selected by the user or set by function
23481     * elm_calendar_selected_time_set().
23482     * Selected date changes when the user goes to next/previous month or
23483     * select a day pressing over it on calendar.
23484     *
23485     * @see elm_calendar_selected_time_get()
23486     *
23487     * @ref calendar_example_05
23488     *
23489     * @ingroup Calendar
23490     */
23491    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23492
23493    /**
23494     * Set a function to format the string that will be used to display
23495     * month and year;
23496     *
23497     * @param obj The calendar object
23498     * @param format_function Function to set the month-year string given
23499     * the selected date
23500     *
23501     * By default it uses strftime with "%B %Y" format string.
23502     * It should allocate the memory that will be used by the string,
23503     * that will be freed by the widget after usage.
23504     * A pointer to the string and a pointer to the time struct will be provided.
23505     *
23506     * Example:
23507     * @code
23508     * static char *
23509     * _format_month_year(struct tm *selected_time)
23510     * {
23511     *    char buf[32];
23512     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23513     *    return strdup(buf);
23514     * }
23515     *
23516     * elm_calendar_format_function_set(calendar, _format_month_year);
23517     * @endcode
23518     *
23519     * @ref calendar_example_02
23520     *
23521     * @ingroup Calendar
23522     */
23523    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23524
23525    /**
23526     * Add a new mark to the calendar
23527     *
23528     * @param obj The calendar object
23529     * @param mark_type A string used to define the type of mark. It will be
23530     * emitted to the theme, that should display a related modification on these
23531     * days representation.
23532     * @param mark_time A time struct to represent the date of inclusion of the
23533     * mark. For marks that repeats it will just be displayed after the inclusion
23534     * date in the calendar.
23535     * @param repeat Repeat the event following this periodicity. Can be a unique
23536     * mark (that don't repeat), daily, weekly, monthly or annually.
23537     * @return The created mark or @p NULL upon failure.
23538     *
23539     * Add a mark that will be drawn in the calendar respecting the insertion
23540     * time and periodicity. It will emit the type as signal to the widget theme.
23541     * Default theme supports "holiday" and "checked", but it can be extended.
23542     *
23543     * It won't immediately update the calendar, drawing the marks.
23544     * For this, call elm_calendar_marks_draw(). However, when user selects
23545     * next or previous month calendar forces marks drawn.
23546     *
23547     * Marks created with this method can be deleted with
23548     * elm_calendar_mark_del().
23549     *
23550     * Example
23551     * @code
23552     * struct tm selected_time;
23553     * time_t current_time;
23554     *
23555     * current_time = time(NULL) + 5 * 84600;
23556     * localtime_r(&current_time, &selected_time);
23557     * elm_calendar_mark_add(cal, "holiday", selected_time,
23558     *     ELM_CALENDAR_ANNUALLY);
23559     *
23560     * current_time = time(NULL) + 1 * 84600;
23561     * localtime_r(&current_time, &selected_time);
23562     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23563     *
23564     * elm_calendar_marks_draw(cal);
23565     * @endcode
23566     *
23567     * @see elm_calendar_marks_draw()
23568     * @see elm_calendar_mark_del()
23569     *
23570     * @ref calendar_example_06
23571     *
23572     * @ingroup Calendar
23573     */
23574    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);
23575
23576    /**
23577     * Delete mark from the calendar.
23578     *
23579     * @param mark The mark to be deleted.
23580     *
23581     * If deleting all calendar marks is required, elm_calendar_marks_clear()
23582     * should be used instead of getting marks list and deleting each one.
23583     *
23584     * @see elm_calendar_mark_add()
23585     *
23586     * @ref calendar_example_06
23587     *
23588     * @ingroup Calendar
23589     */
23590    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23591
23592    /**
23593     * Remove all calendar's marks
23594     *
23595     * @param obj The calendar object.
23596     *
23597     * @see elm_calendar_mark_add()
23598     * @see elm_calendar_mark_del()
23599     *
23600     * @ingroup Calendar
23601     */
23602    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23603
23604
23605    /**
23606     * Get a list of all the calendar marks.
23607     *
23608     * @param obj The calendar object.
23609     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23610     *
23611     * @see elm_calendar_mark_add()
23612     * @see elm_calendar_mark_del()
23613     * @see elm_calendar_marks_clear()
23614     *
23615     * @ingroup Calendar
23616     */
23617    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23618
23619    /**
23620     * Draw calendar marks.
23621     *
23622     * @param obj The calendar object.
23623     *
23624     * Should be used after adding, removing or clearing marks.
23625     * It will go through the entire marks list updating the calendar.
23626     * If lots of marks will be added, add all the marks and then call
23627     * this function.
23628     *
23629     * When the month is changed, i.e. user selects next or previous month,
23630     * marks will be drawed.
23631     *
23632     * @see elm_calendar_mark_add()
23633     * @see elm_calendar_mark_del()
23634     * @see elm_calendar_marks_clear()
23635     *
23636     * @ref calendar_example_06
23637     *
23638     * @ingroup Calendar
23639     */
23640    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23641
23642    /**
23643     * Set a day text color to the same that represents Saturdays.
23644     *
23645     * @param obj The calendar object.
23646     * @param pos The text position. Position is the cell counter, from left
23647     * to right, up to down. It starts on 0 and ends on 41.
23648     *
23649     * @deprecated use elm_calendar_mark_add() instead like:
23650     *
23651     * @code
23652     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23653     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23654     * @endcode
23655     *
23656     * @see elm_calendar_mark_add()
23657     *
23658     * @ingroup Calendar
23659     */
23660    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23661
23662    /**
23663     * Set a day text color to the same that represents Sundays.
23664     *
23665     * @param obj The calendar object.
23666     * @param pos The text position. Position is the cell counter, from left
23667     * to right, up to down. It starts on 0 and ends on 41.
23668
23669     * @deprecated use elm_calendar_mark_add() instead like:
23670     *
23671     * @code
23672     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23673     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23674     * @endcode
23675     *
23676     * @see elm_calendar_mark_add()
23677     *
23678     * @ingroup Calendar
23679     */
23680    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23681
23682    /**
23683     * Set a day text color to the same that represents Weekdays.
23684     *
23685     * @param obj The calendar object
23686     * @param pos The text position. Position is the cell counter, from left
23687     * to right, up to down. It starts on 0 and ends on 41.
23688     *
23689     * @deprecated use elm_calendar_mark_add() instead like:
23690     *
23691     * @code
23692     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23693     *
23694     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23695     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23696     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23697     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23698     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23699     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23700     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23701     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23702     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23703     * @endcode
23704     *
23705     * @see elm_calendar_mark_add()
23706     *
23707     * @ingroup Calendar
23708     */
23709    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23710
23711    /**
23712     * Set the interval on time updates for an user mouse button hold
23713     * on calendar widgets' month selection.
23714     *
23715     * @param obj The calendar object
23716     * @param interval The (first) interval value in seconds
23717     *
23718     * This interval value is @b decreased while the user holds the
23719     * mouse pointer either selecting next or previous month.
23720     *
23721     * This helps the user to get to a given month distant from the
23722     * current one easier/faster, as it will start to change quicker and
23723     * quicker on mouse button holds.
23724     *
23725     * The calculation for the next change interval value, starting from
23726     * the one set with this call, is the previous interval divided by
23727     * 1.05, so it decreases a little bit.
23728     *
23729     * The default starting interval value for automatic changes is
23730     * @b 0.85 seconds.
23731     *
23732     * @see elm_calendar_interval_get()
23733     *
23734     * @ingroup Calendar
23735     */
23736    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23737
23738    /**
23739     * Get the interval on time updates for an user mouse button hold
23740     * on calendar widgets' month selection.
23741     *
23742     * @param obj The calendar object
23743     * @return The (first) interval value, in seconds, set on it
23744     *
23745     * @see elm_calendar_interval_set() for more details
23746     *
23747     * @ingroup Calendar
23748     */
23749    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23750
23751    /**
23752     * @}
23753     */
23754
23755    /**
23756     * @defgroup Diskselector Diskselector
23757     * @ingroup Elementary
23758     *
23759     * @image html img/widget/diskselector/preview-00.png
23760     * @image latex img/widget/diskselector/preview-00.eps
23761     *
23762     * A diskselector is a kind of list widget. It scrolls horizontally,
23763     * and can contain label and icon objects. Three items are displayed
23764     * with the selected one in the middle.
23765     *
23766     * It can act like a circular list with round mode and labels can be
23767     * reduced for a defined length for side items.
23768     *
23769     * Smart callbacks one can listen to:
23770     * - "selected" - when item is selected, i.e. scroller stops.
23771     *
23772     * Available styles for it:
23773     * - @c "default"
23774     *
23775     * List of examples:
23776     * @li @ref diskselector_example_01
23777     * @li @ref diskselector_example_02
23778     */
23779
23780    /**
23781     * @addtogroup Diskselector
23782     * @{
23783     */
23784
23785    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(). */
23786
23787    /**
23788     * Add a new diskselector widget to the given parent Elementary
23789     * (container) object.
23790     *
23791     * @param parent The parent object.
23792     * @return a new diskselector widget handle or @c NULL, on errors.
23793     *
23794     * This function inserts a new diskselector widget on the canvas.
23795     *
23796     * @ingroup Diskselector
23797     */
23798    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23799
23800    /**
23801     * Enable or disable round mode.
23802     *
23803     * @param obj The diskselector object.
23804     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23805     * disable it.
23806     *
23807     * Disabled by default. If round mode is enabled the items list will
23808     * work like a circle list, so when the user reaches the last item,
23809     * the first one will popup.
23810     *
23811     * @see elm_diskselector_round_get()
23812     *
23813     * @ingroup Diskselector
23814     */
23815    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23816
23817    /**
23818     * Get a value whether round mode is enabled or not.
23819     *
23820     * @see elm_diskselector_round_set() for details.
23821     *
23822     * @param obj The diskselector object.
23823     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23824     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23825     *
23826     * @ingroup Diskselector
23827     */
23828    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23829
23830    /**
23831     * Get the side labels max length.
23832     *
23833     * @deprecated use elm_diskselector_side_label_length_get() instead:
23834     *
23835     * @param obj The diskselector object.
23836     * @return The max length defined for side labels, or 0 if not a valid
23837     * diskselector.
23838     *
23839     * @ingroup Diskselector
23840     */
23841    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23842
23843    /**
23844     * Set the side labels max length.
23845     *
23846     * @deprecated use elm_diskselector_side_label_length_set() instead:
23847     *
23848     * @param obj The diskselector object.
23849     * @param len The max length defined for side labels.
23850     *
23851     * @ingroup Diskselector
23852     */
23853    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23854
23855    /**
23856     * Get the side labels max length.
23857     *
23858     * @see elm_diskselector_side_label_length_set() for details.
23859     *
23860     * @param obj The diskselector object.
23861     * @return The max length defined for side labels, or 0 if not a valid
23862     * diskselector.
23863     *
23864     * @ingroup Diskselector
23865     */
23866    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23867
23868    /**
23869     * Set the side labels max length.
23870     *
23871     * @param obj The diskselector object.
23872     * @param len The max length defined for side labels.
23873     *
23874     * Length is the number of characters of items' label that will be
23875     * visible when it's set on side positions. It will just crop
23876     * the string after defined size. E.g.:
23877     *
23878     * An item with label "January" would be displayed on side position as
23879     * "Jan" if max length is set to 3, or "Janu", if this property
23880     * is set to 4.
23881     *
23882     * When it's selected, the entire label will be displayed, except for
23883     * width restrictions. In this case label will be cropped and "..."
23884     * will be concatenated.
23885     *
23886     * Default side label max length is 3.
23887     *
23888     * This property will be applyed over all items, included before or
23889     * later this function call.
23890     *
23891     * @ingroup Diskselector
23892     */
23893    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23894
23895    /**
23896     * Set the number of items to be displayed.
23897     *
23898     * @param obj The diskselector object.
23899     * @param num The number of items the diskselector will display.
23900     *
23901     * Default value is 3, and also it's the minimun. If @p num is less
23902     * than 3, it will be set to 3.
23903     *
23904     * Also, it can be set on theme, using data item @c display_item_num
23905     * on group "elm/diskselector/item/X", where X is style set.
23906     * E.g.:
23907     *
23908     * group { name: "elm/diskselector/item/X";
23909     * data {
23910     *     item: "display_item_num" "5";
23911     *     }
23912     *
23913     * @ingroup Diskselector
23914     */
23915    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
23916
23917    /**
23918     * Set bouncing behaviour when the scrolled content reaches an edge.
23919     *
23920     * Tell the internal scroller object whether it should bounce or not
23921     * when it reaches the respective edges for each axis.
23922     *
23923     * @param obj The diskselector object.
23924     * @param h_bounce Whether to bounce or not in the horizontal axis.
23925     * @param v_bounce Whether to bounce or not in the vertical axis.
23926     *
23927     * @see elm_scroller_bounce_set()
23928     *
23929     * @ingroup Diskselector
23930     */
23931    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23932
23933    /**
23934     * Get the bouncing behaviour of the internal scroller.
23935     *
23936     * Get whether the internal scroller should bounce when the edge of each
23937     * axis is reached scrolling.
23938     *
23939     * @param obj The diskselector object.
23940     * @param h_bounce Pointer where to store the bounce state of the horizontal
23941     * axis.
23942     * @param v_bounce Pointer where to store the bounce state of the vertical
23943     * axis.
23944     *
23945     * @see elm_scroller_bounce_get()
23946     * @see elm_diskselector_bounce_set()
23947     *
23948     * @ingroup Diskselector
23949     */
23950    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23951
23952    /**
23953     * Get the scrollbar policy.
23954     *
23955     * @see elm_diskselector_scroller_policy_get() for details.
23956     *
23957     * @param obj The diskselector object.
23958     * @param policy_h Pointer where to store horizontal scrollbar policy.
23959     * @param policy_v Pointer where to store vertical scrollbar policy.
23960     *
23961     * @ingroup Diskselector
23962     */
23963    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);
23964
23965    /**
23966     * Set the scrollbar policy.
23967     *
23968     * @param obj The diskselector object.
23969     * @param policy_h Horizontal scrollbar policy.
23970     * @param policy_v Vertical scrollbar policy.
23971     *
23972     * This sets the scrollbar visibility policy for the given scroller.
23973     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
23974     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
23975     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
23976     * This applies respectively for the horizontal and vertical scrollbars.
23977     *
23978     * The both are disabled by default, i.e., are set to
23979     * #ELM_SCROLLER_POLICY_OFF.
23980     *
23981     * @ingroup Diskselector
23982     */
23983    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
23984
23985    /**
23986     * Remove all diskselector's items.
23987     *
23988     * @param obj The diskselector object.
23989     *
23990     * @see elm_diskselector_item_del()
23991     * @see elm_diskselector_item_append()
23992     *
23993     * @ingroup Diskselector
23994     */
23995    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23996
23997    /**
23998     * Get a list of all the diskselector items.
23999     *
24000     * @param obj The diskselector object.
24001     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24002     * or @c NULL on failure.
24003     *
24004     * @see elm_diskselector_item_append()
24005     * @see elm_diskselector_item_del()
24006     * @see elm_diskselector_clear()
24007     *
24008     * @ingroup Diskselector
24009     */
24010    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24011
24012    /**
24013     * Appends a new item to the diskselector object.
24014     *
24015     * @param obj The diskselector object.
24016     * @param label The label of the diskselector item.
24017     * @param icon The icon object to use at left side of the item. An
24018     * icon can be any Evas object, but usually it is an icon created
24019     * with elm_icon_add().
24020     * @param func The function to call when the item is selected.
24021     * @param data The data to associate with the item for related callbacks.
24022     *
24023     * @return The created item or @c NULL upon failure.
24024     *
24025     * A new item will be created and appended to the diskselector, i.e., will
24026     * be set as last item. Also, if there is no selected item, it will
24027     * be selected. This will always happens for the first appended item.
24028     *
24029     * If no icon is set, label will be centered on item position, otherwise
24030     * the icon will be placed at left of the label, that will be shifted
24031     * to the right.
24032     *
24033     * Items created with this method can be deleted with
24034     * elm_diskselector_item_del().
24035     *
24036     * Associated @p data can be properly freed when item is deleted if a
24037     * callback function is set with elm_diskselector_item_del_cb_set().
24038     *
24039     * If a function is passed as argument, it will be called everytime this item
24040     * is selected, i.e., the user stops the diskselector with this
24041     * item on center position. If such function isn't needed, just passing
24042     * @c NULL as @p func is enough. The same should be done for @p data.
24043     *
24044     * Simple example (with no function callback or data associated):
24045     * @code
24046     * disk = elm_diskselector_add(win);
24047     * ic = elm_icon_add(win);
24048     * elm_icon_file_set(ic, "path/to/image", NULL);
24049     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24050     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24051     * @endcode
24052     *
24053     * @see elm_diskselector_item_del()
24054     * @see elm_diskselector_item_del_cb_set()
24055     * @see elm_diskselector_clear()
24056     * @see elm_icon_add()
24057     *
24058     * @ingroup Diskselector
24059     */
24060    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);
24061
24062
24063    /**
24064     * Delete them item from the diskselector.
24065     *
24066     * @param it The item of diskselector to be deleted.
24067     *
24068     * If deleting all diskselector items is required, elm_diskselector_clear()
24069     * should be used instead of getting items list and deleting each one.
24070     *
24071     * @see elm_diskselector_clear()
24072     * @see elm_diskselector_item_append()
24073     * @see elm_diskselector_item_del_cb_set()
24074     *
24075     * @ingroup Diskselector
24076     */
24077    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24078
24079    /**
24080     * Set the function called when a diskselector item is freed.
24081     *
24082     * @param it The item to set the callback on
24083     * @param func The function called
24084     *
24085     * If there is a @p func, then it will be called prior item's memory release.
24086     * That will be called with the following arguments:
24087     * @li item's data;
24088     * @li item's Evas object;
24089     * @li item itself;
24090     *
24091     * This way, a data associated to a diskselector item could be properly
24092     * freed.
24093     *
24094     * @ingroup Diskselector
24095     */
24096    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24097
24098    /**
24099     * Get the data associated to the item.
24100     *
24101     * @param it The diskselector item
24102     * @return The data associated to @p it
24103     *
24104     * The return value is a pointer to data associated to @p item when it was
24105     * created, with function elm_diskselector_item_append(). If no data
24106     * was passed as argument, it will return @c NULL.
24107     *
24108     * @see elm_diskselector_item_append()
24109     *
24110     * @ingroup Diskselector
24111     */
24112    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24113
24114    /**
24115     * Set the icon associated to the item.
24116     *
24117     * @param it The diskselector item
24118     * @param icon The icon object to associate with @p it
24119     *
24120     * The icon object to use at left side of the item. An
24121     * icon can be any Evas object, but usually it is an icon created
24122     * with elm_icon_add().
24123     *
24124     * Once the icon object is set, a previously set one will be deleted.
24125     * @warning Setting the same icon for two items will cause the icon to
24126     * dissapear from the first item.
24127     *
24128     * If an icon was passed as argument on item creation, with function
24129     * elm_diskselector_item_append(), it will be already
24130     * associated to the item.
24131     *
24132     * @see elm_diskselector_item_append()
24133     * @see elm_diskselector_item_icon_get()
24134     *
24135     * @ingroup Diskselector
24136     */
24137    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24138
24139    /**
24140     * Get the icon associated to the item.
24141     *
24142     * @param it The diskselector item
24143     * @return The icon associated to @p it
24144     *
24145     * The return value is a pointer to the icon associated to @p item when it was
24146     * created, with function elm_diskselector_item_append(), or later
24147     * with function elm_diskselector_item_icon_set. If no icon
24148     * was passed as argument, it will return @c NULL.
24149     *
24150     * @see elm_diskselector_item_append()
24151     * @see elm_diskselector_item_icon_set()
24152     *
24153     * @ingroup Diskselector
24154     */
24155    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24156
24157    /**
24158     * Set the label of item.
24159     *
24160     * @param it The item of diskselector.
24161     * @param label The label of item.
24162     *
24163     * The label to be displayed by the item.
24164     *
24165     * If no icon is set, label will be centered on item position, otherwise
24166     * the icon will be placed at left of the label, that will be shifted
24167     * to the right.
24168     *
24169     * An item with label "January" would be displayed on side position as
24170     * "Jan" if max length is set to 3 with function
24171     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24172     * is set to 4.
24173     *
24174     * When this @p item is selected, the entire label will be displayed,
24175     * except for width restrictions.
24176     * In this case label will be cropped and "..." will be concatenated,
24177     * but only for display purposes. It will keep the entire string, so
24178     * if diskselector is resized the remaining characters will be displayed.
24179     *
24180     * If a label was passed as argument on item creation, with function
24181     * elm_diskselector_item_append(), it will be already
24182     * displayed by the item.
24183     *
24184     * @see elm_diskselector_side_label_lenght_set()
24185     * @see elm_diskselector_item_label_get()
24186     * @see elm_diskselector_item_append()
24187     *
24188     * @ingroup Diskselector
24189     */
24190    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24191
24192    /**
24193     * Get the label of item.
24194     *
24195     * @param it The item of diskselector.
24196     * @return The label of item.
24197     *
24198     * The return value is a pointer to the label associated to @p item when it was
24199     * created, with function elm_diskselector_item_append(), or later
24200     * with function elm_diskselector_item_label_set. If no label
24201     * was passed as argument, it will return @c NULL.
24202     *
24203     * @see elm_diskselector_item_label_set() for more details.
24204     * @see elm_diskselector_item_append()
24205     *
24206     * @ingroup Diskselector
24207     */
24208    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24209
24210    /**
24211     * Get the selected item.
24212     *
24213     * @param obj The diskselector object.
24214     * @return The selected diskselector item.
24215     *
24216     * The selected item can be unselected with function
24217     * elm_diskselector_item_selected_set(), and the first item of
24218     * diskselector will be selected.
24219     *
24220     * The selected item always will be centered on diskselector, with
24221     * full label displayed, i.e., max lenght set to side labels won't
24222     * apply on the selected item. More details on
24223     * elm_diskselector_side_label_length_set().
24224     *
24225     * @ingroup Diskselector
24226     */
24227    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24228
24229    /**
24230     * Set the selected state of an item.
24231     *
24232     * @param it The diskselector item
24233     * @param selected The selected state
24234     *
24235     * This sets the selected state of the given item @p it.
24236     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24237     *
24238     * If a new item is selected the previosly selected will be unselected.
24239     * Previoulsy selected item can be get with function
24240     * elm_diskselector_selected_item_get().
24241     *
24242     * If the item @p it is unselected, the first item of diskselector will
24243     * be selected.
24244     *
24245     * Selected items will be visible on center position of diskselector.
24246     * So if it was on another position before selected, or was invisible,
24247     * diskselector will animate items until the selected item reaches center
24248     * position.
24249     *
24250     * @see elm_diskselector_item_selected_get()
24251     * @see elm_diskselector_selected_item_get()
24252     *
24253     * @ingroup Diskselector
24254     */
24255    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24256
24257    /*
24258     * Get whether the @p item is selected or not.
24259     *
24260     * @param it The diskselector item.
24261     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24262     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24263     *
24264     * @see elm_diskselector_selected_item_set() for details.
24265     * @see elm_diskselector_item_selected_get()
24266     *
24267     * @ingroup Diskselector
24268     */
24269    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24270
24271    /**
24272     * Get the first item of the diskselector.
24273     *
24274     * @param obj The diskselector object.
24275     * @return The first item, or @c NULL if none.
24276     *
24277     * The list of items follows append order. So it will return the first
24278     * item appended to the widget that wasn't deleted.
24279     *
24280     * @see elm_diskselector_item_append()
24281     * @see elm_diskselector_items_get()
24282     *
24283     * @ingroup Diskselector
24284     */
24285    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24286
24287    /**
24288     * Get the last item of the diskselector.
24289     *
24290     * @param obj The diskselector object.
24291     * @return The last item, or @c NULL if none.
24292     *
24293     * The list of items follows append order. So it will return last first
24294     * item appended to the widget that wasn't deleted.
24295     *
24296     * @see elm_diskselector_item_append()
24297     * @see elm_diskselector_items_get()
24298     *
24299     * @ingroup Diskselector
24300     */
24301    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24302
24303    /**
24304     * Get the item before @p item in diskselector.
24305     *
24306     * @param it The diskselector item.
24307     * @return The item before @p item, or @c NULL if none or on failure.
24308     *
24309     * The list of items follows append order. So it will return item appended
24310     * just before @p item and that wasn't deleted.
24311     *
24312     * If it is the first item, @c NULL will be returned.
24313     * First item can be get by elm_diskselector_first_item_get().
24314     *
24315     * @see elm_diskselector_item_append()
24316     * @see elm_diskselector_items_get()
24317     *
24318     * @ingroup Diskselector
24319     */
24320    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24321
24322    /**
24323     * Get the item after @p item in diskselector.
24324     *
24325     * @param it The diskselector item.
24326     * @return The item after @p item, or @c NULL if none or on failure.
24327     *
24328     * The list of items follows append order. So it will return item appended
24329     * just after @p item and that wasn't deleted.
24330     *
24331     * If it is the last item, @c NULL will be returned.
24332     * Last item can be get by elm_diskselector_last_item_get().
24333     *
24334     * @see elm_diskselector_item_append()
24335     * @see elm_diskselector_items_get()
24336     *
24337     * @ingroup Diskselector
24338     */
24339    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24340
24341    /**
24342     * Set the text to be shown in the diskselector item.
24343     *
24344     * @param item Target item
24345     * @param text The text to set in the content
24346     *
24347     * Setup the text as tooltip to object. The item can have only one tooltip,
24348     * so any previous tooltip data is removed.
24349     *
24350     * @see elm_object_tooltip_text_set() for more details.
24351     *
24352     * @ingroup Diskselector
24353     */
24354    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24355
24356    /**
24357     * Set the content to be shown in the tooltip item.
24358     *
24359     * Setup the tooltip to item. The item can have only one tooltip,
24360     * so any previous tooltip data is removed. @p func(with @p data) will
24361     * be called every time that need show the tooltip and it should
24362     * return a valid Evas_Object. This object is then managed fully by
24363     * tooltip system and is deleted when the tooltip is gone.
24364     *
24365     * @param item the diskselector item being attached a tooltip.
24366     * @param func the function used to create the tooltip contents.
24367     * @param data what to provide to @a func as callback data/context.
24368     * @param del_cb called when data is not needed anymore, either when
24369     *        another callback replaces @p func, the tooltip is unset with
24370     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24371     *        dies. This callback receives as the first parameter the
24372     *        given @a data, and @c event_info is the item.
24373     *
24374     * @see elm_object_tooltip_content_cb_set() for more details.
24375     *
24376     * @ingroup Diskselector
24377     */
24378    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);
24379
24380    /**
24381     * Unset tooltip from item.
24382     *
24383     * @param item diskselector item to remove previously set tooltip.
24384     *
24385     * Remove tooltip from item. The callback provided as del_cb to
24386     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24387     * it is not used anymore.
24388     *
24389     * @see elm_object_tooltip_unset() for more details.
24390     * @see elm_diskselector_item_tooltip_content_cb_set()
24391     *
24392     * @ingroup Diskselector
24393     */
24394    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24395
24396
24397    /**
24398     * Sets a different style for this item tooltip.
24399     *
24400     * @note before you set a style you should define a tooltip with
24401     *       elm_diskselector_item_tooltip_content_cb_set() or
24402     *       elm_diskselector_item_tooltip_text_set()
24403     *
24404     * @param item diskselector item with tooltip already set.
24405     * @param style the theme style to use (default, transparent, ...)
24406     *
24407     * @see elm_object_tooltip_style_set() for more details.
24408     *
24409     * @ingroup Diskselector
24410     */
24411    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24412
24413    /**
24414     * Get the style for this item tooltip.
24415     *
24416     * @param item diskselector item with tooltip already set.
24417     * @return style the theme style in use, defaults to "default". If the
24418     *         object does not have a tooltip set, then NULL is returned.
24419     *
24420     * @see elm_object_tooltip_style_get() for more details.
24421     * @see elm_diskselector_item_tooltip_style_set()
24422     *
24423     * @ingroup Diskselector
24424     */
24425    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24426
24427    /**
24428     * Set the cursor to be shown when mouse is over the diskselector item
24429     *
24430     * @param item Target item
24431     * @param cursor the cursor name to be used.
24432     *
24433     * @see elm_object_cursor_set() for more details.
24434     *
24435     * @ingroup Diskselector
24436     */
24437    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24438
24439    /**
24440     * Get the cursor to be shown when mouse is over the diskselector item
24441     *
24442     * @param item diskselector item with cursor already set.
24443     * @return the cursor name.
24444     *
24445     * @see elm_object_cursor_get() for more details.
24446     * @see elm_diskselector_cursor_set()
24447     *
24448     * @ingroup Diskselector
24449     */
24450    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24451
24452
24453    /**
24454     * Unset the cursor to be shown when mouse is over the diskselector item
24455     *
24456     * @param item Target item
24457     *
24458     * @see elm_object_cursor_unset() for more details.
24459     * @see elm_diskselector_cursor_set()
24460     *
24461     * @ingroup Diskselector
24462     */
24463    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24464
24465    /**
24466     * Sets a different style for this item cursor.
24467     *
24468     * @note before you set a style you should define a cursor with
24469     *       elm_diskselector_item_cursor_set()
24470     *
24471     * @param item diskselector item with cursor already set.
24472     * @param style the theme style to use (default, transparent, ...)
24473     *
24474     * @see elm_object_cursor_style_set() for more details.
24475     *
24476     * @ingroup Diskselector
24477     */
24478    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24479
24480
24481    /**
24482     * Get the style for this item cursor.
24483     *
24484     * @param item diskselector item with cursor already set.
24485     * @return style the theme style in use, defaults to "default". If the
24486     *         object does not have a cursor set, then @c NULL is returned.
24487     *
24488     * @see elm_object_cursor_style_get() for more details.
24489     * @see elm_diskselector_item_cursor_style_set()
24490     *
24491     * @ingroup Diskselector
24492     */
24493    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24494
24495
24496    /**
24497     * Set if the cursor set should be searched on the theme or should use
24498     * the provided by the engine, only.
24499     *
24500     * @note before you set if should look on theme you should define a cursor
24501     * with elm_diskselector_item_cursor_set().
24502     * By default it will only look for cursors provided by the engine.
24503     *
24504     * @param item widget item with cursor already set.
24505     * @param engine_only boolean to define if cursors set with
24506     * elm_diskselector_item_cursor_set() should be searched only
24507     * between cursors provided by the engine or searched on widget's
24508     * theme as well.
24509     *
24510     * @see elm_object_cursor_engine_only_set() for more details.
24511     *
24512     * @ingroup Diskselector
24513     */
24514    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24515
24516    /**
24517     * Get the cursor engine only usage for this item cursor.
24518     *
24519     * @param item widget item with cursor already set.
24520     * @return engine_only boolean to define it cursors should be looked only
24521     * between the provided by the engine or searched on widget's theme as well.
24522     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24523     *
24524     * @see elm_object_cursor_engine_only_get() for more details.
24525     * @see elm_diskselector_item_cursor_engine_only_set()
24526     *
24527     * @ingroup Diskselector
24528     */
24529    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24530
24531    /**
24532     * @}
24533     */
24534
24535    /**
24536     * @defgroup Colorselector Colorselector
24537     *
24538     * @{
24539     *
24540     * @image html img/widget/colorselector/preview-00.png
24541     * @image latex img/widget/colorselector/preview-00.eps
24542     *
24543     * @brief Widget for user to select a color.
24544     *
24545     * Signals that you can add callbacks for are:
24546     * "changed" - When the color value changes(event_info is NULL).
24547     *
24548     * See @ref tutorial_colorselector.
24549     */
24550    /**
24551     * @brief Add a new colorselector to the parent
24552     *
24553     * @param parent The parent object
24554     * @return The new object or NULL if it cannot be created
24555     *
24556     * @ingroup Colorselector
24557     */
24558    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24559    /**
24560     * Set a color for the colorselector
24561     *
24562     * @param obj   Colorselector object
24563     * @param r     r-value of color
24564     * @param g     g-value of color
24565     * @param b     b-value of color
24566     * @param a     a-value of color
24567     *
24568     * @ingroup Colorselector
24569     */
24570    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24571    /**
24572     * Get a color from the colorselector
24573     *
24574     * @param obj   Colorselector object
24575     * @param r     integer pointer for r-value of color
24576     * @param g     integer pointer for g-value of color
24577     * @param b     integer pointer for b-value of color
24578     * @param a     integer pointer for a-value of color
24579     *
24580     * @ingroup Colorselector
24581     */
24582    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24583    /**
24584     * @}
24585     */
24586
24587    /**
24588     * @defgroup Ctxpopup Ctxpopup
24589     *
24590     * @image html img/widget/ctxpopup/preview-00.png
24591     * @image latex img/widget/ctxpopup/preview-00.eps
24592     *
24593     * @brief Context popup widet.
24594     *
24595     * A ctxpopup is a widget that, when shown, pops up a list of items.
24596     * It automatically chooses an area inside its parent object's view
24597     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24598     * optimally fit into it. In the default theme, it will also point an
24599     * arrow to it's top left position at the time one shows it. Ctxpopup
24600     * items have a label and/or an icon. It is intended for a small
24601     * number of items (hence the use of list, not genlist).
24602     *
24603     * @note Ctxpopup is a especialization of @ref Hover.
24604     *
24605     * Signals that you can add callbacks for are:
24606     * "dismissed" - the ctxpopup was dismissed
24607     *
24608     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24609     * @{
24610     */
24611    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
24612
24613    typedef enum _Elm_Ctxpopup_Direction
24614      {
24615         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24616                                           area */
24617         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24618                                            the clicked area */
24619         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24620                                           the clicked area */
24621         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24622                                         area */
24623      } Elm_Ctxpopup_Direction;
24624
24625    /**
24626     * @brief Add a new Ctxpopup object to the parent.
24627     *
24628     * @param parent Parent object
24629     * @return New object or @c NULL, if it cannot be created
24630     */
24631    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24632    /**
24633     * @brief Set the Ctxpopup's parent
24634     *
24635     * @param obj The ctxpopup object
24636     * @param area The parent to use
24637     *
24638     * Set the parent object.
24639     *
24640     * @note elm_ctxpopup_add() will automatically call this function
24641     * with its @c parent argument.
24642     *
24643     * @see elm_ctxpopup_add()
24644     * @see elm_hover_parent_set()
24645     */
24646    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24647    /**
24648     * @brief Get the Ctxpopup's parent
24649     *
24650     * @param obj The ctxpopup object
24651     *
24652     * @see elm_ctxpopup_hover_parent_set() for more information
24653     */
24654    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24655    /**
24656     * @brief Clear all items in the given ctxpopup object.
24657     *
24658     * @param obj Ctxpopup object
24659     */
24660    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24661    /**
24662     * @brief Change the ctxpopup's orientation to horizontal or vertical.
24663     *
24664     * @param obj Ctxpopup object
24665     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24666     */
24667    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24668    /**
24669     * @brief Get the value of current ctxpopup object's orientation.
24670     *
24671     * @param obj Ctxpopup object
24672     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24673     *
24674     * @see elm_ctxpopup_horizontal_set()
24675     */
24676    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24677    /**
24678     * @brief Add a new item to a ctxpopup object.
24679     *
24680     * @param obj Ctxpopup object
24681     * @param icon Icon to be set on new item
24682     * @param label The Label of the new item
24683     * @param func Convenience function called when item selected
24684     * @param data Data passed to @p func
24685     * @return A handle to the item added or @c NULL, on errors
24686     *
24687     * @warning Ctxpopup can't hold both an item list and a content at the same
24688     * time. When an item is added, any previous content will be removed.
24689     *
24690     * @see elm_ctxpopup_content_set()
24691     */
24692    Elm_Ctxpopup_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);
24693    /**
24694     * @brief Delete the given item in a ctxpopup object.
24695     *
24696     * @param item Ctxpopup item to be deleted
24697     *
24698     * @see elm_ctxpopup_item_append()
24699     */
24700    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
24701    /**
24702     * @brief Set the ctxpopup item's state as disabled or enabled.
24703     *
24704     * @param item Ctxpopup item to be enabled/disabled
24705     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24706     *
24707     * When disabled the item is greyed out to indicate it's state.
24708     */
24709    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24710    /**
24711     * @brief Get the ctxpopup item's disabled/enabled state.
24712     *
24713     * @param item Ctxpopup item to be enabled/disabled
24714     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24715     *
24716     * @see elm_ctxpopup_item_disabled_set()
24717     */
24718    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24719    /**
24720     * @brief Get the icon object for the given ctxpopup item.
24721     *
24722     * @param item Ctxpopup item
24723     * @return icon object or @c NULL, if the item does not have icon or an error
24724     * occurred
24725     *
24726     * @see elm_ctxpopup_item_append()
24727     * @see elm_ctxpopup_item_icon_set()
24728     */
24729    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24730    /**
24731     * @brief Sets the side icon associated with the ctxpopup item
24732     *
24733     * @param item Ctxpopup item
24734     * @param icon Icon object to be set
24735     *
24736     * Once the icon object is set, a previously set one will be deleted.
24737     * @warning Setting the same icon for two items will cause the icon to
24738     * dissapear from the first item.
24739     *
24740     * @see elm_ctxpopup_item_append()
24741     */
24742    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24743    /**
24744     * @brief Get the label for the given ctxpopup item.
24745     *
24746     * @param item Ctxpopup item
24747     * @return label string or @c NULL, if the item does not have label or an
24748     * error occured
24749     *
24750     * @see elm_ctxpopup_item_append()
24751     * @see elm_ctxpopup_item_label_set()
24752     */
24753    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24754    /**
24755     * @brief (Re)set the label on the given ctxpopup item.
24756     *
24757     * @param item Ctxpopup item
24758     * @param label String to set as label
24759     */
24760    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
24761    /**
24762     * @brief Set an elm widget as the content of the ctxpopup.
24763     *
24764     * @param obj Ctxpopup object
24765     * @param content Content to be swallowed
24766     *
24767     * If the content object is already set, a previous one will bedeleted. If
24768     * you want to keep that old content object, use the
24769     * elm_ctxpopup_content_unset() function.
24770     *
24771     * @deprecated use elm_object_content_set()
24772     *
24773     * @warning Ctxpopup can't hold both a item list and a content at the same
24774     * time. When a content is set, any previous items will be removed.
24775     */
24776    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24777    /**
24778     * @brief Unset the ctxpopup content
24779     *
24780     * @param obj Ctxpopup object
24781     * @return The content that was being used
24782     *
24783     * Unparent and return the content object which was set for this widget.
24784     *
24785     * @deprecated use elm_object_content_unset()
24786     *
24787     * @see elm_ctxpopup_content_set()
24788     */
24789    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24790    /**
24791     * @brief Set the direction priority of a ctxpopup.
24792     *
24793     * @param obj Ctxpopup object
24794     * @param first 1st priority of direction
24795     * @param second 2nd priority of direction
24796     * @param third 3th priority of direction
24797     * @param fourth 4th priority of direction
24798     *
24799     * This functions gives a chance to user to set the priority of ctxpopup
24800     * showing direction. This doesn't guarantee the ctxpopup will appear in the
24801     * requested direction.
24802     *
24803     * @see Elm_Ctxpopup_Direction
24804     */
24805    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);
24806    /**
24807     * @brief Get the direction priority of a ctxpopup.
24808     *
24809     * @param obj Ctxpopup object
24810     * @param first 1st priority of direction to be returned
24811     * @param second 2nd priority of direction to be returned
24812     * @param third 3th priority of direction to be returned
24813     * @param fourth 4th priority of direction to be returned
24814     *
24815     * @see elm_ctxpopup_direction_priority_set() for more information.
24816     */
24817    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);
24818    /**
24819     * @}
24820     */
24821
24822    /* transit */
24823    /**
24824     *
24825     * @defgroup Transit Transit
24826     * @ingroup Elementary
24827     *
24828     * Transit is designed to apply various animated transition effects to @c
24829     * Evas_Object, such like translation, rotation, etc. For using these
24830     * effects, create an @ref Elm_Transit and add the desired transition effects.
24831     *
24832     * Once the effects are added into transit, they will be automatically
24833     * managed (their callback will be called until the duration is ended, and
24834     * they will be deleted on completion).
24835     *
24836     * Example:
24837     * @code
24838     * Elm_Transit *trans = elm_transit_add();
24839     * elm_transit_object_add(trans, obj);
24840     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24841     * elm_transit_duration_set(transit, 1);
24842     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24843     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24844     * elm_transit_repeat_times_set(transit, 3);
24845     * @endcode
24846     *
24847     * Some transition effects are used to change the properties of objects. They
24848     * are:
24849     * @li @ref elm_transit_effect_translation_add
24850     * @li @ref elm_transit_effect_color_add
24851     * @li @ref elm_transit_effect_rotation_add
24852     * @li @ref elm_transit_effect_wipe_add
24853     * @li @ref elm_transit_effect_zoom_add
24854     * @li @ref elm_transit_effect_resizing_add
24855     *
24856     * Other transition effects are used to make one object disappear and another
24857     * object appear on its old place. These effects are:
24858     *
24859     * @li @ref elm_transit_effect_flip_add
24860     * @li @ref elm_transit_effect_resizable_flip_add
24861     * @li @ref elm_transit_effect_fade_add
24862     * @li @ref elm_transit_effect_blend_add
24863     *
24864     * It's also possible to make a transition chain with @ref
24865     * elm_transit_chain_transit_add.
24866     *
24867     * @warning We strongly recommend to use elm_transit just when edje can not do
24868     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24869     * animations can be manipulated inside the theme.
24870     *
24871     * List of examples:
24872     * @li @ref transit_example_01_explained
24873     * @li @ref transit_example_02_explained
24874     * @li @ref transit_example_03_c
24875     * @li @ref transit_example_04_c
24876     *
24877     * @{
24878     */
24879
24880    /**
24881     * @enum Elm_Transit_Tween_Mode
24882     *
24883     * The type of acceleration used in the transition.
24884     */
24885    typedef enum
24886      {
24887         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24888         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24889                                              over time, then decrease again
24890                                              and stop slowly */
24891         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24892                                              speed over time */
24893         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24894                                             over time */
24895      } Elm_Transit_Tween_Mode;
24896
24897    /**
24898     * @enum Elm_Transit_Effect_Flip_Axis
24899     *
24900     * The axis where flip effect should be applied.
24901     */
24902    typedef enum
24903      {
24904         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
24905         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
24906      } Elm_Transit_Effect_Flip_Axis;
24907    /**
24908     * @enum Elm_Transit_Effect_Wipe_Dir
24909     *
24910     * The direction where the wipe effect should occur.
24911     */
24912    typedef enum
24913      {
24914         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
24915         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
24916         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
24917         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
24918      } Elm_Transit_Effect_Wipe_Dir;
24919    /** @enum Elm_Transit_Effect_Wipe_Type
24920     *
24921     * Whether the wipe effect should show or hide the object.
24922     */
24923    typedef enum
24924      {
24925         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
24926                                              animation */
24927         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
24928                                             animation */
24929      } Elm_Transit_Effect_Wipe_Type;
24930
24931    /**
24932     * @typedef Elm_Transit
24933     *
24934     * The Transit created with elm_transit_add(). This type has the information
24935     * about the objects which the transition will be applied, and the
24936     * transition effects that will be used. It also contains info about
24937     * duration, number of repetitions, auto-reverse, etc.
24938     */
24939    typedef struct _Elm_Transit Elm_Transit;
24940    typedef void Elm_Transit_Effect;
24941    /**
24942     * @typedef Elm_Transit_Effect_Transition_Cb
24943     *
24944     * Transition callback called for this effect on each transition iteration.
24945     */
24946    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
24947    /**
24948     * Elm_Transit_Effect_End_Cb
24949     *
24950     * Transition callback called for this effect when the transition is over.
24951     */
24952    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
24953
24954    /**
24955     * Elm_Transit_Del_Cb
24956     *
24957     * A callback called when the transit is deleted.
24958     */
24959    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
24960
24961    /**
24962     * Add new transit.
24963     *
24964     * @note Is not necessary to delete the transit object, it will be deleted at
24965     * the end of its operation.
24966     * @note The transit will start playing when the program enter in the main loop, is not
24967     * necessary to give a start to the transit.
24968     *
24969     * @return The transit object.
24970     *
24971     * @ingroup Transit
24972     */
24973    EAPI Elm_Transit                *elm_transit_add(void);
24974
24975    /**
24976     * Stops the animation and delete the @p transit object.
24977     *
24978     * Call this function if you wants to stop the animation before the duration
24979     * time. Make sure the @p transit object is still alive with
24980     * elm_transit_del_cb_set() function.
24981     * All added effects will be deleted, calling its repective data_free_cb
24982     * functions. The function setted by elm_transit_del_cb_set() will be called.
24983     *
24984     * @see elm_transit_del_cb_set()
24985     *
24986     * @param transit The transit object to be deleted.
24987     *
24988     * @ingroup Transit
24989     * @warning Just call this function if you are sure the transit is alive.
24990     */
24991    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
24992
24993    /**
24994     * Add a new effect to the transit.
24995     *
24996     * @note The cb function and the data are the key to the effect. If you try to
24997     * add an already added effect, nothing is done.
24998     * @note After the first addition of an effect in @p transit, if its
24999     * effect list become empty again, the @p transit will be killed by
25000     * elm_transit_del(transit) function.
25001     *
25002     * Exemple:
25003     * @code
25004     * Elm_Transit *transit = elm_transit_add();
25005     * elm_transit_effect_add(transit,
25006     *                        elm_transit_effect_blend_op,
25007     *                        elm_transit_effect_blend_context_new(),
25008     *                        elm_transit_effect_blend_context_free);
25009     * @endcode
25010     *
25011     * @param transit The transit object.
25012     * @param transition_cb The operation function. It is called when the
25013     * animation begins, it is the function that actually performs the animation.
25014     * It is called with the @p data, @p transit and the time progression of the
25015     * animation (a double value between 0.0 and 1.0).
25016     * @param effect The context data of the effect.
25017     * @param end_cb The function to free the context data, it will be called
25018     * at the end of the effect, it must finalize the animation and free the
25019     * @p data.
25020     *
25021     * @ingroup Transit
25022     * @warning The transit free the context data at the and of the transition with
25023     * the data_free_cb function, do not use the context data in another transit.
25024     */
25025    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);
25026
25027    /**
25028     * Delete an added effect.
25029     *
25030     * This function will remove the effect from the @p transit, calling the
25031     * data_free_cb to free the @p data.
25032     *
25033     * @see elm_transit_effect_add()
25034     *
25035     * @note If the effect is not found, nothing is done.
25036     * @note If the effect list become empty, this function will call
25037     * elm_transit_del(transit), that is, it will kill the @p transit.
25038     *
25039     * @param transit The transit object.
25040     * @param transition_cb The operation function.
25041     * @param effect The context data of the effect.
25042     *
25043     * @ingroup Transit
25044     */
25045    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);
25046
25047    /**
25048     * Add new object to apply the effects.
25049     *
25050     * @note After the first addition of an object in @p transit, if its
25051     * object list become empty again, the @p transit will be killed by
25052     * elm_transit_del(transit) function.
25053     * @note If the @p obj belongs to another transit, the @p obj will be
25054     * removed from it and it will only belong to the @p transit. If the old
25055     * transit stays without objects, it will die.
25056     * @note When you add an object into the @p transit, its state from
25057     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25058     * transit ends, if you change this state whith evas_object_pass_events_set()
25059     * after add the object, this state will change again when @p transit stops to
25060     * run.
25061     *
25062     * @param transit The transit object.
25063     * @param obj Object to be animated.
25064     *
25065     * @ingroup Transit
25066     * @warning It is not allowed to add a new object after transit begins to go.
25067     */
25068    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25069
25070    /**
25071     * Removes an added object from the transit.
25072     *
25073     * @note If the @p obj is not in the @p transit, nothing is done.
25074     * @note If the list become empty, this function will call
25075     * elm_transit_del(transit), that is, it will kill the @p transit.
25076     *
25077     * @param transit The transit object.
25078     * @param obj Object to be removed from @p transit.
25079     *
25080     * @ingroup Transit
25081     * @warning It is not allowed to remove objects after transit begins to go.
25082     */
25083    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25084
25085    /**
25086     * Get the objects of the transit.
25087     *
25088     * @param transit The transit object.
25089     * @return a Eina_List with the objects from the transit.
25090     *
25091     * @ingroup Transit
25092     */
25093    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25094
25095    /**
25096     * Enable/disable keeping up the objects states.
25097     * If it is not kept, the objects states will be reset when transition ends.
25098     *
25099     * @note @p transit can not be NULL.
25100     * @note One state includes geometry, color, map data.
25101     *
25102     * @param transit The transit object.
25103     * @param state_keep Keeping or Non Keeping.
25104     *
25105     * @ingroup Transit
25106     */
25107    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25108
25109    /**
25110     * Get a value whether the objects states will be reset or not.
25111     *
25112     * @note @p transit can not be NULL
25113     *
25114     * @see elm_transit_objects_final_state_keep_set()
25115     *
25116     * @param transit The transit object.
25117     * @return EINA_TRUE means the states of the objects will be reset.
25118     * If @p transit is NULL, EINA_FALSE is returned
25119     *
25120     * @ingroup Transit
25121     */
25122    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25123
25124    /**
25125     * Set the event enabled when transit is operating.
25126     *
25127     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25128     * events from mouse and keyboard during the animation.
25129     * @note When you add an object with elm_transit_object_add(), its state from
25130     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25131     * transit ends, if you change this state with evas_object_pass_events_set()
25132     * after adding the object, this state will change again when @p transit stops
25133     * to run.
25134     *
25135     * @param transit The transit object.
25136     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25137     * ignored otherwise.
25138     *
25139     * @ingroup Transit
25140     */
25141    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25142
25143    /**
25144     * Get the value of event enabled status.
25145     *
25146     * @see elm_transit_event_enabled_set()
25147     *
25148     * @param transit The Transit object
25149     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25150     * EINA_FALSE is returned
25151     *
25152     * @ingroup Transit
25153     */
25154    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25155
25156    /**
25157     * Set the user-callback function when the transit is deleted.
25158     *
25159     * @note Using this function twice will overwrite the first function setted.
25160     * @note the @p transit object will be deleted after call @p cb function.
25161     *
25162     * @param transit The transit object.
25163     * @param cb Callback function pointer. This function will be called before
25164     * the deletion of the transit.
25165     * @param data Callback funtion user data. It is the @p op parameter.
25166     *
25167     * @ingroup Transit
25168     */
25169    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25170
25171    /**
25172     * Set reverse effect automatically.
25173     *
25174     * If auto reverse is setted, after running the effects with the progress
25175     * parameter from 0 to 1, it will call the effecs again with the progress
25176     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25177     * where the duration was setted with the function elm_transit_add and
25178     * the repeat with the function elm_transit_repeat_times_set().
25179     *
25180     * @param transit The transit object.
25181     * @param reverse EINA_TRUE means the auto_reverse is on.
25182     *
25183     * @ingroup Transit
25184     */
25185    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25186
25187    /**
25188     * Get if the auto reverse is on.
25189     *
25190     * @see elm_transit_auto_reverse_set()
25191     *
25192     * @param transit The transit object.
25193     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25194     * EINA_FALSE is returned
25195     *
25196     * @ingroup Transit
25197     */
25198    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25199
25200    /**
25201     * Set the transit repeat count. Effect will be repeated by repeat count.
25202     *
25203     * This function sets the number of repetition the transit will run after
25204     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25205     * If the @p repeat is a negative number, it will repeat infinite times.
25206     *
25207     * @note If this function is called during the transit execution, the transit
25208     * will run @p repeat times, ignoring the times it already performed.
25209     *
25210     * @param transit The transit object
25211     * @param repeat Repeat count
25212     *
25213     * @ingroup Transit
25214     */
25215    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25216
25217    /**
25218     * Get the transit repeat count.
25219     *
25220     * @see elm_transit_repeat_times_set()
25221     *
25222     * @param transit The Transit object.
25223     * @return The repeat count. If @p transit is NULL
25224     * 0 is returned
25225     *
25226     * @ingroup Transit
25227     */
25228    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25229
25230    /**
25231     * Set the transit animation acceleration type.
25232     *
25233     * This function sets the tween mode of the transit that can be:
25234     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25235     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25236     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25237     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25238     *
25239     * @param transit The transit object.
25240     * @param tween_mode The tween type.
25241     *
25242     * @ingroup Transit
25243     */
25244    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25245
25246    /**
25247     * Get the transit animation acceleration type.
25248     *
25249     * @note @p transit can not be NULL
25250     *
25251     * @param transit The transit object.
25252     * @return The tween type. If @p transit is NULL
25253     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25254     *
25255     * @ingroup Transit
25256     */
25257    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25258
25259    /**
25260     * Set the transit animation time
25261     *
25262     * @note @p transit can not be NULL
25263     *
25264     * @param transit The transit object.
25265     * @param duration The animation time.
25266     *
25267     * @ingroup Transit
25268     */
25269    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25270
25271    /**
25272     * Get the transit animation time
25273     *
25274     * @note @p transit can not be NULL
25275     *
25276     * @param transit The transit object.
25277     *
25278     * @return The transit animation time.
25279     *
25280     * @ingroup Transit
25281     */
25282    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25283
25284    /**
25285     * Starts the transition.
25286     * Once this API is called, the transit begins to measure the time.
25287     *
25288     * @note @p transit can not be NULL
25289     *
25290     * @param transit The transit object.
25291     *
25292     * @ingroup Transit
25293     */
25294    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25295
25296    /**
25297     * Pause/Resume the transition.
25298     *
25299     * If you call elm_transit_go again, the transit will be started from the
25300     * beginning, and will be unpaused.
25301     *
25302     * @note @p transit can not be NULL
25303     *
25304     * @param transit The transit object.
25305     * @param paused Whether the transition should be paused or not.
25306     *
25307     * @ingroup Transit
25308     */
25309    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25310
25311    /**
25312     * Get the value of paused status.
25313     *
25314     * @see elm_transit_paused_set()
25315     *
25316     * @note @p transit can not be NULL
25317     *
25318     * @param transit The transit object.
25319     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25320     * EINA_FALSE is returned
25321     *
25322     * @ingroup Transit
25323     */
25324    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25325
25326    /**
25327     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25328     *
25329     * The value returned is a fraction (current time / total time). It
25330     * represents the progression position relative to the total.
25331     *
25332     * @note @p transit can not be NULL
25333     *
25334     * @param transit The transit object.
25335     *
25336     * @return The time progression value. If @p transit is NULL
25337     * 0 is returned
25338     *
25339     * @ingroup Transit
25340     */
25341    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25342
25343    /**
25344     * Makes the chain relationship between two transits.
25345     *
25346     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25347     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25348     *
25349     * @param transit The transit object.
25350     * @param chain_transit The chain transit object. This transit will be operated
25351     *        after transit is done.
25352     *
25353     * This function adds @p chain_transit transition to a chain after the @p
25354     * transit, and will be started as soon as @p transit ends. See @ref
25355     * transit_example_02_explained for a full example.
25356     *
25357     * @ingroup Transit
25358     */
25359    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25360
25361    /**
25362     * Cut off the chain relationship between two transits.
25363     *
25364     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25365     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25366     *
25367     * @param transit The transit object.
25368     * @param chain_transit The chain transit object.
25369     *
25370     * This function remove the @p chain_transit transition from the @p transit.
25371     *
25372     * @ingroup Transit
25373     */
25374    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25375
25376    /**
25377     * Get the current chain transit list.
25378     *
25379     * @note @p transit can not be NULL.
25380     *
25381     * @param transit The transit object.
25382     * @return chain transit list.
25383     *
25384     * @ingroup Transit
25385     */
25386    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25387
25388    /**
25389     * Add the Resizing Effect to Elm_Transit.
25390     *
25391     * @note This API is one of the facades. It creates resizing effect context
25392     * and add it's required APIs to elm_transit_effect_add.
25393     *
25394     * @see elm_transit_effect_add()
25395     *
25396     * @param transit Transit object.
25397     * @param from_w Object width size when effect begins.
25398     * @param from_h Object height size when effect begins.
25399     * @param to_w Object width size when effect ends.
25400     * @param to_h Object height size when effect ends.
25401     * @return Resizing effect context data.
25402     *
25403     * @ingroup Transit
25404     */
25405    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);
25406
25407    /**
25408     * Add the Translation Effect to Elm_Transit.
25409     *
25410     * @note This API is one of the facades. It creates translation effect context
25411     * and add it's required APIs to elm_transit_effect_add.
25412     *
25413     * @see elm_transit_effect_add()
25414     *
25415     * @param transit Transit object.
25416     * @param from_dx X Position variation when effect begins.
25417     * @param from_dy Y Position variation when effect begins.
25418     * @param to_dx X Position variation when effect ends.
25419     * @param to_dy Y Position variation when effect ends.
25420     * @return Translation effect context data.
25421     *
25422     * @ingroup Transit
25423     * @warning It is highly recommended just create a transit with this effect when
25424     * the window that the objects of the transit belongs has already been created.
25425     * This is because this effect needs the geometry information about the objects,
25426     * and if the window was not created yet, it can get a wrong information.
25427     */
25428    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);
25429
25430    /**
25431     * Add the Zoom Effect to Elm_Transit.
25432     *
25433     * @note This API is one of the facades. It creates zoom effect context
25434     * and add it's required APIs to elm_transit_effect_add.
25435     *
25436     * @see elm_transit_effect_add()
25437     *
25438     * @param transit Transit object.
25439     * @param from_rate Scale rate when effect begins (1 is current rate).
25440     * @param to_rate Scale rate when effect ends.
25441     * @return Zoom effect context data.
25442     *
25443     * @ingroup Transit
25444     * @warning It is highly recommended just create a transit with this effect when
25445     * the window that the objects of the transit belongs has already been created.
25446     * This is because this effect needs the geometry information about the objects,
25447     * and if the window was not created yet, it can get a wrong information.
25448     */
25449    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25450
25451    /**
25452     * Add the Flip Effect to Elm_Transit.
25453     *
25454     * @note This API is one of the facades. It creates flip effect context
25455     * and add it's required APIs to elm_transit_effect_add.
25456     * @note This effect is applied to each pair of objects in the order they are listed
25457     * in the transit list of objects. The first object in the pair will be the
25458     * "front" object and the second will be the "back" object.
25459     *
25460     * @see elm_transit_effect_add()
25461     *
25462     * @param transit Transit object.
25463     * @param axis Flipping Axis(X or Y).
25464     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25465     * @return Flip effect context data.
25466     *
25467     * @ingroup Transit
25468     * @warning It is highly recommended just create a transit with this effect when
25469     * the window that the objects of the transit belongs has already been created.
25470     * This is because this effect needs the geometry information about the objects,
25471     * and if the window was not created yet, it can get a wrong information.
25472     */
25473    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25474
25475    /**
25476     * Add the Resizable Flip Effect to Elm_Transit.
25477     *
25478     * @note This API is one of the facades. It creates resizable flip effect context
25479     * and add it's required APIs to elm_transit_effect_add.
25480     * @note This effect is applied to each pair of objects in the order they are listed
25481     * in the transit list of objects. The first object in the pair will be the
25482     * "front" object and the second will be the "back" object.
25483     *
25484     * @see elm_transit_effect_add()
25485     *
25486     * @param transit Transit object.
25487     * @param axis Flipping Axis(X or Y).
25488     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25489     * @return Resizable flip effect context data.
25490     *
25491     * @ingroup Transit
25492     * @warning It is highly recommended just create a transit with this effect when
25493     * the window that the objects of the transit belongs has already been created.
25494     * This is because this effect needs the geometry information about the objects,
25495     * and if the window was not created yet, it can get a wrong information.
25496     */
25497    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25498
25499    /**
25500     * Add the Wipe Effect to Elm_Transit.
25501     *
25502     * @note This API is one of the facades. It creates wipe effect context
25503     * and add it's required APIs to elm_transit_effect_add.
25504     *
25505     * @see elm_transit_effect_add()
25506     *
25507     * @param transit Transit object.
25508     * @param type Wipe type. Hide or show.
25509     * @param dir Wipe Direction.
25510     * @return Wipe effect context data.
25511     *
25512     * @ingroup Transit
25513     * @warning It is highly recommended just create a transit with this effect when
25514     * the window that the objects of the transit belongs has already been created.
25515     * This is because this effect needs the geometry information about the objects,
25516     * and if the window was not created yet, it can get a wrong information.
25517     */
25518    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25519
25520    /**
25521     * Add the Color Effect to Elm_Transit.
25522     *
25523     * @note This API is one of the facades. It creates color effect context
25524     * and add it's required APIs to elm_transit_effect_add.
25525     *
25526     * @see elm_transit_effect_add()
25527     *
25528     * @param transit        Transit object.
25529     * @param  from_r        RGB R when effect begins.
25530     * @param  from_g        RGB G when effect begins.
25531     * @param  from_b        RGB B when effect begins.
25532     * @param  from_a        RGB A when effect begins.
25533     * @param  to_r          RGB R when effect ends.
25534     * @param  to_g          RGB G when effect ends.
25535     * @param  to_b          RGB B when effect ends.
25536     * @param  to_a          RGB A when effect ends.
25537     * @return               Color effect context data.
25538     *
25539     * @ingroup Transit
25540     */
25541    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);
25542
25543    /**
25544     * Add the Fade Effect to Elm_Transit.
25545     *
25546     * @note This API is one of the facades. It creates fade effect context
25547     * and add it's required APIs to elm_transit_effect_add.
25548     * @note This effect is applied to each pair of objects in the order they are listed
25549     * in the transit list of objects. The first object in the pair will be the
25550     * "before" object and the second will be the "after" object.
25551     *
25552     * @see elm_transit_effect_add()
25553     *
25554     * @param transit Transit object.
25555     * @return Fade effect context data.
25556     *
25557     * @ingroup Transit
25558     * @warning It is highly recommended just create a transit with this effect when
25559     * the window that the objects of the transit belongs has already been created.
25560     * This is because this effect needs the color information about the objects,
25561     * and if the window was not created yet, it can get a wrong information.
25562     */
25563    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25564
25565    /**
25566     * Add the Blend Effect to Elm_Transit.
25567     *
25568     * @note This API is one of the facades. It creates blend effect context
25569     * and add it's required APIs to elm_transit_effect_add.
25570     * @note This effect is applied to each pair of objects in the order they are listed
25571     * in the transit list of objects. The first object in the pair will be the
25572     * "before" object and the second will be the "after" object.
25573     *
25574     * @see elm_transit_effect_add()
25575     *
25576     * @param transit Transit object.
25577     * @return Blend effect context data.
25578     *
25579     * @ingroup Transit
25580     * @warning It is highly recommended just create a transit with this effect when
25581     * the window that the objects of the transit belongs has already been created.
25582     * This is because this effect needs the color information about the objects,
25583     * and if the window was not created yet, it can get a wrong information.
25584     */
25585    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25586
25587    /**
25588     * Add the Rotation Effect to Elm_Transit.
25589     *
25590     * @note This API is one of the facades. It creates rotation effect context
25591     * and add it's required APIs to elm_transit_effect_add.
25592     *
25593     * @see elm_transit_effect_add()
25594     *
25595     * @param transit Transit object.
25596     * @param from_degree Degree when effect begins.
25597     * @param to_degree Degree when effect is ends.
25598     * @return Rotation effect context data.
25599     *
25600     * @ingroup Transit
25601     * @warning It is highly recommended just create a transit with this effect when
25602     * the window that the objects of the transit belongs has already been created.
25603     * This is because this effect needs the geometry information about the objects,
25604     * and if the window was not created yet, it can get a wrong information.
25605     */
25606    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25607
25608    /**
25609     * Add the ImageAnimation Effect to Elm_Transit.
25610     *
25611     * @note This API is one of the facades. It creates image animation effect context
25612     * and add it's required APIs to elm_transit_effect_add.
25613     * The @p images parameter is a list images paths. This list and
25614     * its contents will be deleted at the end of the effect by
25615     * elm_transit_effect_image_animation_context_free() function.
25616     *
25617     * Example:
25618     * @code
25619     * char buf[PATH_MAX];
25620     * Eina_List *images = NULL;
25621     * Elm_Transit *transi = elm_transit_add();
25622     *
25623     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25624     * images = eina_list_append(images, eina_stringshare_add(buf));
25625     *
25626     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25627     * images = eina_list_append(images, eina_stringshare_add(buf));
25628     * elm_transit_effect_image_animation_add(transi, images);
25629     *
25630     * @endcode
25631     *
25632     * @see elm_transit_effect_add()
25633     *
25634     * @param transit Transit object.
25635     * @param images Eina_List of images file paths. This list and
25636     * its contents will be deleted at the end of the effect by
25637     * elm_transit_effect_image_animation_context_free() function.
25638     * @return Image Animation effect context data.
25639     *
25640     * @ingroup Transit
25641     */
25642    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25643    /**
25644     * @}
25645     */
25646
25647   typedef struct _Elm_Store                      Elm_Store;
25648   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
25649   typedef struct _Elm_Store_Item                 Elm_Store_Item;
25650   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
25651   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
25652   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25653   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
25654   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
25655   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
25656   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
25657   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
25658
25659   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25660   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25661   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25662   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25663
25664   typedef enum
25665     {
25666        ELM_STORE_ITEM_MAPPING_NONE = 0,
25667        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25668        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25669        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25670        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25671        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25672        // can add more here as needed by common apps
25673        ELM_STORE_ITEM_MAPPING_LAST
25674     } Elm_Store_Item_Mapping_Type;
25675
25676   struct _Elm_Store_Item_Mapping_Icon
25677     {
25678        // FIXME: allow edje file icons
25679        int                   w, h;
25680        Elm_Icon_Lookup_Order lookup_order;
25681        Eina_Bool             standard_name : 1;
25682        Eina_Bool             no_scale : 1;
25683        Eina_Bool             smooth : 1;
25684        Eina_Bool             scale_up : 1;
25685        Eina_Bool             scale_down : 1;
25686     };
25687
25688   struct _Elm_Store_Item_Mapping_Empty
25689     {
25690        Eina_Bool             dummy;
25691     };
25692
25693   struct _Elm_Store_Item_Mapping_Photo
25694     {
25695        int                   size;
25696     };
25697
25698   struct _Elm_Store_Item_Mapping_Custom
25699     {
25700        Elm_Store_Item_Mapping_Cb func;
25701     };
25702
25703   struct _Elm_Store_Item_Mapping
25704     {
25705        Elm_Store_Item_Mapping_Type     type;
25706        const char                     *part;
25707        int                             offset;
25708        union
25709          {
25710             Elm_Store_Item_Mapping_Empty  empty;
25711             Elm_Store_Item_Mapping_Icon   icon;
25712             Elm_Store_Item_Mapping_Photo  photo;
25713             Elm_Store_Item_Mapping_Custom custom;
25714             // add more types here
25715          } details;
25716     };
25717
25718   struct _Elm_Store_Item_Info
25719     {
25720       Elm_Genlist_Item_Class       *item_class;
25721       const Elm_Store_Item_Mapping *mapping;
25722       void                         *data;
25723       char                         *sort_id;
25724     };
25725
25726   struct _Elm_Store_Item_Info_Filesystem
25727     {
25728       Elm_Store_Item_Info  base;
25729       char                *path;
25730     };
25731
25732 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25733 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25734
25735   EAPI void                    elm_store_free(Elm_Store *st);
25736
25737   EAPI Elm_Store              *elm_store_filesystem_new(void);
25738   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25739   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25740   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25741
25742   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25743
25744   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25745   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25746   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25747   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25748   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25749   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25750
25751   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25752   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25753   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25754   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25755   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25756   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25757   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25758
25759    /**
25760     * @defgroup SegmentControl SegmentControl
25761     * @ingroup Elementary
25762     *
25763     * @image html img/widget/segment_control/preview-00.png
25764     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25765     *
25766     * @image html img/segment_control.png
25767     * @image latex img/segment_control.eps width=\textwidth
25768     *
25769     * Segment control widget is a horizontal control made of multiple segment
25770     * items, each segment item functioning similar to discrete two state button.
25771     * A segment control groups the items together and provides compact
25772     * single button with multiple equal size segments.
25773     *
25774     * Segment item size is determined by base widget
25775     * size and the number of items added.
25776     * Only one segment item can be at selected state. A segment item can display
25777     * combination of Text and any Evas_Object like Images or other widget.
25778     *
25779     * Smart callbacks one can listen to:
25780     * - "changed" - When the user clicks on a segment item which is not
25781     *   previously selected and get selected. The event_info parameter is the
25782     *   segment item index.
25783     *
25784     * Available styles for it:
25785     * - @c "default"
25786     *
25787     * Here is an example on its usage:
25788     * @li @ref segment_control_example
25789     */
25790
25791    /**
25792     * @addtogroup SegmentControl
25793     * @{
25794     */
25795
25796    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25797
25798    /**
25799     * Add a new segment control widget to the given parent Elementary
25800     * (container) object.
25801     *
25802     * @param parent The parent object.
25803     * @return a new segment control widget handle or @c NULL, on errors.
25804     *
25805     * This function inserts a new segment control widget on the canvas.
25806     *
25807     * @ingroup SegmentControl
25808     */
25809    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25810
25811    /**
25812     * Append a new item to the segment control object.
25813     *
25814     * @param obj The segment control object.
25815     * @param icon The icon object to use for the left side of the item. An
25816     * icon can be any Evas object, but usually it is an icon created
25817     * with elm_icon_add().
25818     * @param label The label of the item.
25819     *        Note that, NULL is different from empty string "".
25820     * @return The created item or @c NULL upon failure.
25821     *
25822     * A new item will be created and appended to the segment control, i.e., will
25823     * be set as @b last item.
25824     *
25825     * If it should be inserted at another position,
25826     * elm_segment_control_item_insert_at() should be used instead.
25827     *
25828     * Items created with this function can be deleted with function
25829     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25830     *
25831     * @note @p label set to @c NULL is different from empty string "".
25832     * If an item
25833     * only has icon, it will be displayed bigger and centered. If it has
25834     * icon and label, even that an empty string, icon will be smaller and
25835     * positioned at left.
25836     *
25837     * Simple example:
25838     * @code
25839     * sc = elm_segment_control_add(win);
25840     * ic = elm_icon_add(win);
25841     * elm_icon_file_set(ic, "path/to/image", NULL);
25842     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25843     * elm_segment_control_item_add(sc, ic, "label");
25844     * evas_object_show(sc);
25845     * @endcode
25846     *
25847     * @see elm_segment_control_item_insert_at()
25848     * @see elm_segment_control_item_del()
25849     *
25850     * @ingroup SegmentControl
25851     */
25852    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25853
25854    /**
25855     * Insert a new item to the segment control object at specified position.
25856     *
25857     * @param obj The segment control object.
25858     * @param icon The icon object to use for the left side of the item. An
25859     * icon can be any Evas object, but usually it is an icon created
25860     * with elm_icon_add().
25861     * @param label The label of the item.
25862     * @param index Item position. Value should be between 0 and items count.
25863     * @return The created item or @c NULL upon failure.
25864
25865     * Index values must be between @c 0, when item will be prepended to
25866     * segment control, and items count, that can be get with
25867     * elm_segment_control_item_count_get(), case when item will be appended
25868     * to segment control, just like elm_segment_control_item_add().
25869     *
25870     * Items created with this function can be deleted with function
25871     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25872     *
25873     * @note @p label set to @c NULL is different from empty string "".
25874     * If an item
25875     * only has icon, it will be displayed bigger and centered. If it has
25876     * icon and label, even that an empty string, icon will be smaller and
25877     * positioned at left.
25878     *
25879     * @see elm_segment_control_item_add()
25880     * @see elm_segment_control_count_get()
25881     * @see elm_segment_control_item_del()
25882     *
25883     * @ingroup SegmentControl
25884     */
25885    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);
25886
25887    /**
25888     * Remove a segment control item from its parent, deleting it.
25889     *
25890     * @param it The item to be removed.
25891     *
25892     * Items can be added with elm_segment_control_item_add() or
25893     * elm_segment_control_item_insert_at().
25894     *
25895     * @ingroup SegmentControl
25896     */
25897    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25898
25899    /**
25900     * Remove a segment control item at given index from its parent,
25901     * deleting it.
25902     *
25903     * @param obj The segment control object.
25904     * @param index The position of the segment control item to be deleted.
25905     *
25906     * Items can be added with elm_segment_control_item_add() or
25907     * elm_segment_control_item_insert_at().
25908     *
25909     * @ingroup SegmentControl
25910     */
25911    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25912
25913    /**
25914     * Get the Segment items count from segment control.
25915     *
25916     * @param obj The segment control object.
25917     * @return Segment items count.
25918     *
25919     * It will just return the number of items added to segment control @p obj.
25920     *
25921     * @ingroup SegmentControl
25922     */
25923    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25924
25925    /**
25926     * Get the item placed at specified index.
25927     *
25928     * @param obj The segment control object.
25929     * @param index The index of the segment item.
25930     * @return The segment control item or @c NULL on failure.
25931     *
25932     * Index is the position of an item in segment control widget. Its
25933     * range is from @c 0 to <tt> count - 1 </tt>.
25934     * Count is the number of items, that can be get with
25935     * elm_segment_control_item_count_get().
25936     *
25937     * @ingroup SegmentControl
25938     */
25939    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25940
25941    /**
25942     * Get the label of item.
25943     *
25944     * @param obj The segment control object.
25945     * @param index The index of the segment item.
25946     * @return The label of the item at @p index.
25947     *
25948     * The return value is a pointer to the label associated to the item when
25949     * it was created, with function elm_segment_control_item_add(), or later
25950     * with function elm_segment_control_item_label_set. If no label
25951     * was passed as argument, it will return @c NULL.
25952     *
25953     * @see elm_segment_control_item_label_set() for more details.
25954     * @see elm_segment_control_item_add()
25955     *
25956     * @ingroup SegmentControl
25957     */
25958    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25959
25960    /**
25961     * Set the label of item.
25962     *
25963     * @param it The item of segment control.
25964     * @param text The label of item.
25965     *
25966     * The label to be displayed by the item.
25967     * Label will be at right of the icon (if set).
25968     *
25969     * If a label was passed as argument on item creation, with function
25970     * elm_control_segment_item_add(), it will be already
25971     * displayed by the item.
25972     *
25973     * @see elm_segment_control_item_label_get()
25974     * @see elm_segment_control_item_add()
25975     *
25976     * @ingroup SegmentControl
25977     */
25978    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
25979
25980    /**
25981     * Get the icon associated to the item.
25982     *
25983     * @param obj The segment control object.
25984     * @param index The index of the segment item.
25985     * @return The left side icon associated to the item at @p index.
25986     *
25987     * The return value is a pointer to the icon associated to the item when
25988     * it was created, with function elm_segment_control_item_add(), or later
25989     * with function elm_segment_control_item_icon_set(). If no icon
25990     * was passed as argument, it will return @c NULL.
25991     *
25992     * @see elm_segment_control_item_add()
25993     * @see elm_segment_control_item_icon_set()
25994     *
25995     * @ingroup SegmentControl
25996     */
25997    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25998
25999    /**
26000     * Set the icon associated to the item.
26001     *
26002     * @param it The segment control item.
26003     * @param icon The icon object to associate with @p it.
26004     *
26005     * The icon object to use at left side of the item. An
26006     * icon can be any Evas object, but usually it is an icon created
26007     * with elm_icon_add().
26008     *
26009     * Once the icon object is set, a previously set one will be deleted.
26010     * @warning Setting the same icon for two items will cause the icon to
26011     * dissapear from the first item.
26012     *
26013     * If an icon was passed as argument on item creation, with function
26014     * elm_segment_control_item_add(), it will be already
26015     * associated to the item.
26016     *
26017     * @see elm_segment_control_item_add()
26018     * @see elm_segment_control_item_icon_get()
26019     *
26020     * @ingroup SegmentControl
26021     */
26022    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26023
26024    /**
26025     * Get the index of an item.
26026     *
26027     * @param it The segment control item.
26028     * @return The position of item in segment control widget.
26029     *
26030     * Index is the position of an item in segment control widget. Its
26031     * range is from @c 0 to <tt> count - 1 </tt>.
26032     * Count is the number of items, that can be get with
26033     * elm_segment_control_item_count_get().
26034     *
26035     * @ingroup SegmentControl
26036     */
26037    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26038
26039    /**
26040     * Get the base object of the item.
26041     *
26042     * @param it The segment control item.
26043     * @return The base object associated with @p it.
26044     *
26045     * Base object is the @c Evas_Object that represents that item.
26046     *
26047     * @ingroup SegmentControl
26048     */
26049    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26050
26051    /**
26052     * Get the selected item.
26053     *
26054     * @param obj The segment control object.
26055     * @return The selected item or @c NULL if none of segment items is
26056     * selected.
26057     *
26058     * The selected item can be unselected with function
26059     * elm_segment_control_item_selected_set().
26060     *
26061     * The selected item always will be highlighted on segment control.
26062     *
26063     * @ingroup SegmentControl
26064     */
26065    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26066
26067    /**
26068     * Set the selected state of an item.
26069     *
26070     * @param it The segment control item
26071     * @param select The selected state
26072     *
26073     * This sets the selected state of the given item @p it.
26074     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26075     *
26076     * If a new item is selected the previosly selected will be unselected.
26077     * Previoulsy selected item can be get with function
26078     * elm_segment_control_item_selected_get().
26079     *
26080     * The selected item always will be highlighted on segment control.
26081     *
26082     * @see elm_segment_control_item_selected_get()
26083     *
26084     * @ingroup SegmentControl
26085     */
26086    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26087
26088    /**
26089     * @}
26090     */
26091
26092    /**
26093     * @defgroup Grid Grid
26094     *
26095     * The grid is a grid layout widget that lays out a series of children as a
26096     * fixed "grid" of widgets using a given percentage of the grid width and
26097     * height each using the child object.
26098     *
26099     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26100     * widgets size itself. The default is 100 x 100, so that means the
26101     * position and sizes of children will effectively be percentages (0 to 100)
26102     * of the width or height of the grid widget
26103     *
26104     * @{
26105     */
26106
26107    /**
26108     * Add a new grid to the parent
26109     *
26110     * @param parent The parent object
26111     * @return The new object or NULL if it cannot be created
26112     *
26113     * @ingroup Grid
26114     */
26115    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26116
26117    /**
26118     * Set the virtual size of the grid
26119     *
26120     * @param obj The grid object
26121     * @param w The virtual width of the grid
26122     * @param h The virtual height of the grid
26123     *
26124     * @ingroup Grid
26125     */
26126    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26127
26128    /**
26129     * Get the virtual size of the grid
26130     *
26131     * @param obj The grid object
26132     * @param w Pointer to integer to store the virtual width of the grid
26133     * @param h Pointer to integer to store the virtual height of the grid
26134     *
26135     * @ingroup Grid
26136     */
26137    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26138
26139    /**
26140     * Pack child at given position and size
26141     *
26142     * @param obj The grid object
26143     * @param subobj The child to pack
26144     * @param x The virtual x coord at which to pack it
26145     * @param y The virtual y coord at which to pack it
26146     * @param w The virtual width at which to pack it
26147     * @param h The virtual height at which to pack it
26148     *
26149     * @ingroup Grid
26150     */
26151    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26152
26153    /**
26154     * Unpack a child from a grid object
26155     *
26156     * @param obj The grid object
26157     * @param subobj The child to unpack
26158     *
26159     * @ingroup Grid
26160     */
26161    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26162
26163    /**
26164     * Faster way to remove all child objects from a grid object.
26165     *
26166     * @param obj The grid object
26167     * @param clear If true, it will delete just removed children
26168     *
26169     * @ingroup Grid
26170     */
26171    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26172
26173    /**
26174     * Set packing of an existing child at to position and size
26175     *
26176     * @param subobj The child to set packing of
26177     * @param x The virtual x coord at which to pack it
26178     * @param y The virtual y coord at which to pack it
26179     * @param w The virtual width at which to pack it
26180     * @param h The virtual height at which to pack it
26181     *
26182     * @ingroup Grid
26183     */
26184    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26185
26186    /**
26187     * get packing of a child
26188     *
26189     * @param subobj The child to query
26190     * @param x Pointer to integer to store the virtual x coord
26191     * @param y Pointer to integer to store the virtual y coord
26192     * @param w Pointer to integer to store the virtual width
26193     * @param h Pointer to integer to store the virtual height
26194     *
26195     * @ingroup Grid
26196     */
26197    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26198
26199    /**
26200     * @}
26201     */
26202
26203    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26204    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26205    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26206
26207    /**
26208     * @defgroup Video Video
26209     *
26210     * This object display an player that let you control an Elm_Video
26211     * object. It take care of updating it's content according to what is
26212     * going on inside the Emotion object. It does activate the remember
26213     * function on the linked Elm_Video object.
26214     *
26215     * Signals that you cann add callback for are :
26216     *
26217     * "forward,clicked" - the user clicked the forward button.
26218     * "info,clicked" - the user clicked the info button.
26219     * "next,clicked" - the user clicked the next button.
26220     * "pause,clicked" - the user clicked the pause button.
26221     * "play,clicked" - the user clicked the play button.
26222     * "prev,clicked" - the user clicked the prev button.
26223     * "rewind,clicked" - the user clicked the rewind button.
26224     * "stop,clicked" - the user clicked the stop button.
26225     */
26226    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26227    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26228    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26229    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26230    EAPI void elm_video_play(Evas_Object *video);
26231    EAPI void elm_video_pause(Evas_Object *video);
26232    EAPI void elm_video_stop(Evas_Object *video);
26233    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26234    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26235    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26236    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26237    EAPI double elm_video_audio_level_get(Evas_Object *video);
26238    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26239    EAPI double elm_video_play_position_get(Evas_Object *video);
26240    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26241    EAPI double elm_video_play_length_get(Evas_Object *video);
26242    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26243    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26244    EAPI const char *elm_video_title_get(Evas_Object *video);
26245
26246    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26247    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26248
26249   /* naviframe */
26250    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26251    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);
26252    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26253    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26254    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26255    EAPI void                elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26256    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26257    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26258    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26259    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26260    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26261    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26262    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26263    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26264    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26265
26266 #ifdef __cplusplus
26267 }
26268 #endif
26269
26270 #endif