fix @see
[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  * #ifndef ELM_LIB_QUICKLAUNCH
56  * EAPI int
57  * elm_main(int argc, char **argv)
58  * {
59  *    // create window(s) here and do any application init
60  *    elm_run(); // run main loop
61  *    elm_shutdown(); // after mainloop finishes running, shutdown
62  *    return 0; // exit 0 for exit code
63  * }
64  * #endif
65  * ELM_MAIN()
66  * @endcode
67  *
68  * To take full advantage of the quicklaunch architecture for launching
69  * processes as quickly as possible (saving time at startup time like
70  * connecting to X11, loading and linking shared libraries) you may want to
71  * use the following configure.in/configure.ac and Makefile.am and autogen.sh
72  * script to generate your files. It is assumed your application uses the
73  * main.c file for its code.
74  *
75  * configure.in/configure.ac:
76  *
77 @verbatim
78 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
79 AC_PREREQ(2.52)
80 AC_CONFIG_SRCDIR(configure.in)
81
82 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
83 AM_CONFIG_HEADER(config.h)
84
85 AC_C_BIGENDIAN
86 AC_ISC_POSIX
87 AC_PROG_CC
88 AM_PROG_CC_STDC
89 AC_HEADER_STDC
90 AC_C_CONST
91
92 AC_LIBTOOL_WIN32_DLL
93 define([AC_LIBTOOL_LANG_CXX_CONFIG], [:])dnl
94 define([AC_LIBTOOL_LANG_F77_CONFIG], [:])dnl
95 AC_PROG_LIBTOOL
96
97 PKG_CHECK_MODULES([ELEMENTARY], elementary)
98
99 AC_OUTPUT(Makefile)
100 @endverbatim
101  *
102  * Makefile.am:
103  *
104 @verbatim
105 AUTOMAKE_OPTIONS     = 1.4 foreign
106 MAINTAINERCLEANFILES = Makefile.in
107
108 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
109
110 bin_PROGRAMS      = myapp
111 myapp_LTLIBRARIES = myapp.la
112
113 myappdir = $(libdir)
114
115 myapp_la_SOURCES = main.c
116 myapp_la_LIBADD = @ELEMENTARY_LIBS@
117 myapp_la_CFLAGS =
118 myapp_la_LDFLAGS = -module -avoid-version -no-undefined
119
120 myapp_SOURCES = main.c
121 myapp_LDADD = @ELEMENTARY_LIBS@
122 myapp_CFLAGS = -DELM_LIB_QUICKLAUNCH=1
123 @endverbatim
124  *
125  * autogen.sh:
126  *
127 @verbatim
128 #!/bin/sh
129 rm -rf autom4te.cache
130 rm -f aclocal.m4 ltmain.sh
131 rm -rf m4
132 mkdir m4
133
134 touch README
135 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS -I m4 || exit 1
136 echo "Running autoheader..." ; autoheader || exit 1
137 echo "Running autoconf..." ; autoconf || exit 1
138 echo "Running libtoolize..." ; (libtoolize --copy --automake || glibtoolize --automake) || exit 1
139 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
140
141 if [ -z "$NOCONFIGURE" ]; then
142   ./configure "$@"
143 fi
144 @endverbatim
145  *
146  * To generate all the things needed to bootstrap just run:
147  *
148 @verbatim
149 ./autogen.sh
150 @endverbatim
151  *
152  * This will generate Makefile.in's, the confgure script and everything else.
153  * After this it works like all normal autotools projects:
154 @verbatim
155 ./configure
156 make
157 sudo make install
158 @endverbatim
159  *
160  * Note sudo was assumed to get root permissions, as this would install in
161  * /usr/local which is system-owned. Use any way you like to gain root, or
162  * specify a different prefix with configure:
163  *
164 @verbatim
165 ./confiugre --prefix=$HOME/mysoftware
166 @endverbatim
167  *
168  * Also remember that autotools buys you some useful commands like:
169 @verbatim
170 make uninstall
171 @endverbatim
172  *
173  * This uninstalls the software after it was installed with "make install".
174  * It is very useful to clear up what you built if you wish to clean the
175  * system.
176  *
177 @verbatim
178 make distcheck
179 @endverbatim
180  *
181  * This firstly checks if your build tree is "clean" and ready for
182  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
183  * ready to upload and distribute to the world, that contains the generated
184  * Makefile.in's and configure script. The users do not need to run
185  * autogen.sh - just configure and on. They don't need autotools installed.
186  * This tarball also builds cleanly, has all the sources it needs to build
187  * included (that is sources for your application, not libraries it depends
188  * on like Elementary). It builds cleanly in a buildroot and does not
189  * contain any files that are temporarily generated like binaries and other
190  * build-generated files, so the tarball is clean, and no need to worry
191  * about cleaning up your tree before packaging.
192  *
193 @verbatim
194 make clean
195 @endverbatim
196  *
197  * This cleans up all build files (binaries, objects etc.) from the tree.
198  *
199 @verbatim
200 make distclean
201 @endverbatim
202  *
203  * This cleans out all files from the build and from configure's output too.
204  *
205 @verbatim
206 make maintainer-clean
207 @endverbatim
208  *
209  * This deletes all the files autogen.sh will produce so the tree is clean
210  * to be put into a revision-control system (like CVS, SVN or GIT for example).
211  *
212  * The above will build a library - libmyapp.so and install in the target
213  * library directory (default is /usr/local/lib). You will also get a
214  * myapp.a and myapp.la - these are useless and can be deleted. Libtool likes
215  * to generate these all the time. You will also get a binary in the target
216  * binary directory (default is /usr/local/bin). This is a "debug binary".
217  * This will run and dlopen() the myapp.so and then jump to it's elm_main
218  * function. This allows for easy debugging with GDB and Valgrind. When you
219  * are ready to go to production do the following:
220  *
221  * 1. delete the myapp binary. i.e. rm /usr/local/bin/myapp
222  *
223  * 2. symlink the myapp binary to elementary_run (supplied by elementary).
224  * i.e. ln -s elmentary_run /usr/local/bin/myapp
225  *
226  * 3. run elementary_quicklaunch as part of your graphical login session and
227  * keep it running.
228  *
229  * This will man elementary_quicklaunch does pre-initialization before the
230  * application needs to be run, saving the effort at the time the application
231  * is needed, thus speeding up the time it takes to appear.
232  *
233  * If you don't want to use the quicklaunch infrastructure (which is
234  * optional), you can execute the old fashioned way by just running the
235  * myapp binary loader than will load the myapp.so for you, or you can
236  * remove the split-file binary and put it into one binary as things always
237  * have been with the following configure.in/configure.ac and Makfile.am
238  * files:
239  *
240  * configure.in/configure.ac:
241  *
242 @verbatim
243 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
244 AC_PREREQ(2.52)
245 AC_CONFIG_SRCDIR(configure.in)
246
247 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
248 AM_CONFIG_HEADER(config.h)
249
250 AC_C_BIGENDIAN
251 AC_ISC_POSIX
252 AC_PROG_CC
253 AM_PROG_CC_STDC
254 AC_HEADER_STDC
255 AC_C_CONST
256
257 PKG_CHECK_MODULES([ELEMENTARY], elementary)
258
259 AC_OUTPUT(Makefile)
260 @endverbatim
261  *
262  * Makefile.am:
263  *
264 @verbatim
265 AUTOMAKE_OPTIONS     = 1.4 foreign
266 MAINTAINERCLEANFILES = Makefile.in
267
268 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
269
270 bin_PROGRAMS      = myapp
271
272 myapp_SOURCES = main.c
273 myapp_LDADD = @ELEMENTARY_LIBS@
274 myapp_CFLAGS =
275 @endverbatim
276  *
277  * Notice that they are the same as before, just with libtool and library
278  * building sections removed. Both ways work for building elementary
279  * applications. It is up to you to decide what is best for you. If you just
280  * follow the template above, you can do it both ways and can decide at build
281  * time. The more advanced of you may suggest making it a configure option.
282  * That is perfectly valid, but has been left out here for simplicity, as our
283  * aim to have an Elementary (and EFL) tutorial, not an autoconf & automake
284  * document.
285  *
286  */
287
288 /**
289 @page authors Authors
290 @author Carsten Haitzler <raster@@rasterman.com>
291 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
292 @author Cedric Bail <cedric.bail@@free.fr>
293 @author Vincent Torri <vtorri@@univ-evry.fr>
294 @author Daniel Kolesa <quaker66@@gmail.com>
295 @author Jaime Thomas <avi.thomas@@gmail.com>
296 @author Swisscom - http://www.swisscom.ch/
297 @author Christopher Michael <devilhorns@@comcast.net>
298 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
299 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
300 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
301 @author Brian Wang <brian.wang.0721@@gmail.com>
302 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
303 @author Samsung Electronics <tbd>
304 @author Samsung SAIT <tbd>
305 @author Brett Nash <nash@@nash.id.au>
306 @author Bruno Dilly <bdilly@@profusion.mobi>
307 @author Rafael Fonseca <rfonseca@@profusion.mobi>
308 @author Chuneon Park <hermet@@hermet.pe.kr>
309 @author Woohyun Jung <wh0705.jung@@samsung.com>
310 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
311 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
312 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
313 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
314 @author Gustavo Lima Chaves <glima@@profusion.mobi>
315 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
316 @author Tiago Falcão <tiago@@profusion.mobi>
317 @author Otavio Pontes <otavio@@profusion.mobi>
318 @author Viktor Kojouharov <vkojouharov@@gmail.com>
319 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
320 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
321 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
322 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
323 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
324 @author Jihoon Kim <jihoon48.kim@@samsung.com>
325 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
326 @author Tom Hacohen <tom@@stosb.com>
327 @author Aharon Hillel <a.hillel@@partner.samsung.com>
328 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
329 @author Shinwoo Kim <kimcinoo@@gmail.com>
330 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
331 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
332
333 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
334 contact with the developers and maintainers.
335  */
336
337 #ifndef ELEMENTARY_H
338 #define ELEMENTARY_H
339
340 /**
341  * @file Elementary.h
342  * @brief Elementary's API
343  *
344  * Elementary API.
345  */
346
347 @ELM_UNIX_DEF@ ELM_UNIX
348 @ELM_WIN32_DEF@ ELM_WIN32
349 @ELM_WINCE_DEF@ ELM_WINCE
350 @ELM_EDBUS_DEF@ ELM_EDBUS
351 @ELM_EFREET_DEF@ ELM_EFREET
352 @ELM_ETHUMB_DEF@ ELM_ETHUMB
353 @ELM_EMAP_DEF@ ELM_EMAP
354 @ELM_DEBUG_DEF@ ELM_DEBUG
355 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
356 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
357
358 /* Standard headers for standard system calls etc. */
359 #include <stdio.h>
360 #include <stdlib.h>
361 #include <unistd.h>
362 #include <string.h>
363 #include <sys/types.h>
364 #include <sys/stat.h>
365 #include <sys/time.h>
366 #include <sys/param.h>
367 #include <dlfcn.h>
368 #include <math.h>
369 #include <fnmatch.h>
370 #include <limits.h>
371 #include <ctype.h>
372 #include <time.h>
373 #include <dirent.h>
374 #include <pwd.h>
375 #include <errno.h>
376
377 #ifdef ELM_UNIX
378 # include <locale.h>
379 # ifdef ELM_LIBINTL_H
380 #  include <libintl.h>
381 # endif
382 # include <signal.h>
383 # include <grp.h>
384 # include <glob.h>
385 #endif
386
387 #ifdef ELM_ALLOCA_H
388 # include <alloca.h>
389 #endif
390
391 #if defined (ELM_WIN32) || defined (ELM_WINCE)
392 # include <malloc.h>
393 # ifndef alloca
394 #  define alloca _alloca
395 # endif
396 #endif
397
398
399 /* EFL headers */
400 #include <Eina.h>
401 #include <Eet.h>
402 #include <Evas.h>
403 #include <Evas_GL.h>
404 #include <Ecore.h>
405 #include <Ecore_Evas.h>
406 #include <Ecore_File.h>
407 #include <Ecore_IMF.h>
408 #include <Ecore_Con.h>
409 #include <Edje.h>
410
411 #ifdef ELM_EDBUS
412 # include <E_DBus.h>
413 #endif
414
415 #ifdef ELM_EFREET
416 # include <Efreet.h>
417 # include <Efreet_Mime.h>
418 # include <Efreet_Trash.h>
419 #endif
420
421 #ifdef ELM_ETHUMB
422 # include <Ethumb_Client.h>
423 #endif
424
425 #ifdef ELM_EMAP
426 # include <EMap.h>
427 #endif
428
429 #ifdef EAPI
430 # undef EAPI
431 #endif
432
433 #ifdef _WIN32
434 # ifdef ELEMENTARY_BUILD
435 #  ifdef DLL_EXPORT
436 #   define EAPI __declspec(dllexport)
437 #  else
438 #   define EAPI
439 #  endif /* ! DLL_EXPORT */
440 # else
441 #  define EAPI __declspec(dllimport)
442 # endif /* ! EFL_EVAS_BUILD */
443 #else
444 # ifdef __GNUC__
445 #  if __GNUC__ >= 4
446 #   define EAPI __attribute__ ((visibility("default")))
447 #  else
448 #   define EAPI
449 #  endif
450 # else
451 #  define EAPI
452 # endif
453 #endif /* ! _WIN32 */
454
455
456 /* allow usage from c++ */
457 #ifdef __cplusplus
458 extern "C" {
459 #endif
460
461 #define ELM_VERSION_MAJOR @VMAJ@
462 #define ELM_VERSION_MINOR @VMIN@
463
464    typedef struct _Elm_Version
465      {
466         int major;
467         int minor;
468         int micro;
469         int revision;
470      } Elm_Version;
471
472    EAPI extern Elm_Version *elm_version;
473
474 /* handy macros */
475 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
476 #define ELM_PI 3.14159265358979323846
477
478    /**
479     * @defgroup General General
480     *
481     * @brief General Elementary API. Functions that don't relate to
482     * Elementary objects specifically.
483     *
484     * Here are documented functions which init/shutdown the library,
485     * that apply to generic Elementary objects, that deal with
486     * configuration, et cetera.
487     *
488     * @ref general_functions_example_page "This" example contemplates
489     * some of these functions.
490     */
491
492    /**
493     * @addtogroup General
494     * @{
495     */
496
497   /**
498    * Defines couple of standard Evas_Object layers to be used
499    * with evas_object_layer_set().
500    *
501    * @note whenever extending with new values, try to keep some padding
502    *       to siblings so there is room for further extensions.
503    */
504   typedef enum _Elm_Object_Layer
505     {
506        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
507        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
508        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
509        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
510        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
511        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
512     } Elm_Object_Layer;
513
514 /**************************************************************************/
515    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
516
517    /**
518     * Emitted when any Elementary's policy value is changed.
519     */
520    EAPI extern int ELM_EVENT_POLICY_CHANGED;
521
522    /**
523     * @typedef Elm_Event_Policy_Changed
524     *
525     * Data on the event when an Elementary policy has changed
526     */
527     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
528
529    /**
530     * @struct _Elm_Event_Policy_Changed
531     *
532     * Data on the event when an Elementary policy has changed
533     */
534     struct _Elm_Event_Policy_Changed
535      {
536         unsigned int policy; /**< the policy identifier */
537         int          new_value; /**< value the policy had before the change */
538         int          old_value; /**< new value the policy got */
539     };
540
541    /**
542     * Policy identifiers.
543     */
544     typedef enum _Elm_Policy
545     {
546         ELM_POLICY_QUIT, /**< under which circunstances the application
547                           * should quit automatically. @see
548                           * Elm_Policy_Quit.
549                           */
550         ELM_POLICY_LAST
551     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
552  */
553
554    typedef enum _Elm_Policy_Quit
555      {
556         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
557                                    * automatically */
558         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
559                                             * application's last
560                                             * window is closed */
561      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
562
563    typedef enum _Elm_Focus_Direction
564      {
565         ELM_FOCUS_PREVIOUS,
566         ELM_FOCUS_NEXT
567      } Elm_Focus_Direction;
568
569    typedef enum _Elm_Text_Format
570      {
571         ELM_TEXT_FORMAT_PLAIN_UTF8,
572         ELM_TEXT_FORMAT_MARKUP_UTF8
573      } Elm_Text_Format;
574
575    /**
576     * Line wrapping types.
577     */
578    typedef enum _Elm_Wrap_Type
579      {
580         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
581         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
582         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
583         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
584         ELM_WRAP_LAST
585      } Elm_Wrap_Type;
586
587    /**
588     * @typedef Elm_Object_Item
589     * An Elementary Object item handle.
590     * @ingroup General
591     */
592    typedef struct _Elm_Object_Item Elm_Object_Item;
593
594
595    /**
596     * Called back when a widget's tooltip is activated and needs content.
597     * @param data user-data given to elm_object_tooltip_content_cb_set()
598     * @param obj owner widget.
599     * @param tooltip The tooltip object (affix content to this!)
600     */
601    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
602
603    /**
604     * Called back when a widget's item tooltip is activated and needs content.
605     * @param data user-data given to elm_object_tooltip_content_cb_set()
606     * @param obj owner widget.
607     * @param tooltip The tooltip object (affix content to this!)
608     * @param item context dependent item. As an example, if tooltip was
609     *        set on Elm_List_Item, then it is of this type.
610     */
611    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
612
613    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
614
615 #ifndef ELM_LIB_QUICKLAUNCH
616 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
617 #else
618 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
619 #endif
620
621 /**************************************************************************/
622    /* General calls */
623
624    /**
625     * Initialize Elementary
626     *
627     * @param[in] argc System's argument count value
628     * @param[in] argv System's pointer to array of argument strings
629     * @return The init counter value.
630     *
631     * This function initializes Elementary and increments a counter of
632     * the number of calls to it. It returs the new counter's value.
633     *
634     * @warning This call is exported only for use by the @c ELM_MAIN()
635     * macro. There is no need to use this if you use this macro (which
636     * is highly advisable). An elm_main() should contain the entry
637     * point code for your application, having the same prototype as
638     * elm_init(), and @b not being static (putting the @c EAPI symbol
639     * in front of its type declaration is advisable). The @c
640     * ELM_MAIN() call should be placed just after it.
641     *
642     * Example:
643     * @dontinclude bg_example_01.c
644     * @skip static void
645     * @until ELM_MAIN
646     *
647     * See the full @ref bg_example_01_c "example".
648     *
649     * @see elm_shutdown().
650     * @ingroup General
651     */
652    EAPI int          elm_init(int argc, char **argv);
653
654    /**
655     * Shut down Elementary
656     *
657     * @return The init counter value.
658     *
659     * This should be called at the end of your application, just
660     * before it ceases to do any more processing. This will clean up
661     * any permanent resources your application may have allocated via
662     * Elementary that would otherwise persist.
663     *
664     * @see elm_init() for an example
665     *
666     * @ingroup General
667     */
668    EAPI int          elm_shutdown(void);
669
670    /**
671     * Run Elementary's main loop
672     *
673     * This call should be issued just after all initialization is
674     * completed. This function will not return until elm_exit() is
675     * called. It will keep looping, running the main
676     * (event/processing) loop for Elementary.
677     *
678     * @see elm_init() for an example
679     *
680     * @ingroup General
681     */
682    EAPI void         elm_run(void);
683
684    /**
685     * Exit Elementary's main loop
686     *
687     * If this call is issued, it will flag the main loop to cease
688     * processing and return back to its parent function (usually your
689     * elm_main() function).
690     *
691     * @see elm_init() for an example. There, just after a request to
692     * close the window comes, the main loop will be left.
693     *
694     * @note By using the #ELM_POLICY_QUIT on your Elementary
695     * applications, you'll this function called automatically for you.
696     *
697     * @ingroup General
698     */
699    EAPI void         elm_exit(void);
700
701    /**
702     * Provide information in order to make Elementary determine the @b
703     * run time location of the software in question, so other data files
704     * such as images, sound files, executable utilities, libraries,
705     * modules and locale files can be found.
706     *
707     * @param mainfunc This is your application's main function name,
708     *        whose binary's location is to be found. Providing @c NULL
709     *        will make Elementary not to use it
710     * @param dom This will be used as the application's "domain", in the
711     *        form of a prefix to any environment variables that may
712     *        override prefix detection and the directory name, inside the
713     *        standard share or data directories, where the software's
714     *        data files will be looked for.
715     * @param checkfile This is an (optional) magic file's path to check
716     *        for existence (and it must be located in the data directory,
717     *        under the share directory provided above). Its presence will
718     *        help determine the prefix found was correct. Pass @c NULL if
719     *        the check is not to be done.
720     *
721     * This function allows one to re-locate the application somewhere
722     * else after compilation, if the developer wishes for easier
723     * distribution of pre-compiled binaries.
724     *
725     * The prefix system is designed to locate where the given software is
726     * installed (under a common path prefix) at run time and then report
727     * specific locations of this prefix and common directories inside
728     * this prefix like the binary, library, data and locale directories,
729     * through the @c elm_app_*_get() family of functions.
730     *
731     * Call elm_app_info_set() early on before you change working
732     * directory or anything about @c argv[0], so it gets accurate
733     * information.
734     *
735     * It will then try and trace back which file @p mainfunc comes from,
736     * if provided, to determine the application's prefix directory.
737     *
738     * The @p dom parameter provides a string prefix to prepend before
739     * environment variables, allowing a fallback to @b specific
740     * environment variables to locate the software. You would most
741     * probably provide a lowercase string there, because it will also
742     * serve as directory domain, explained next. For environment
743     * variables purposes, this string is made uppercase. For example if
744     * @c "myapp" is provided as the prefix, then the program would expect
745     * @c "MYAPP_PREFIX" as a master environment variable to specify the
746     * exact install prefix for the software, or more specific environment
747     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
748     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
749     * the user or scripts before launching. If not provided (@c NULL),
750     * environment variables will not be used to override compiled-in
751     * defaults or auto detections.
752     *
753     * The @p dom string also provides a subdirectory inside the system
754     * shared data directory for data files. For example, if the system
755     * directory is @c /usr/local/share, then this directory name is
756     * appended, creating @c /usr/local/share/myapp, if it @p was @c
757     * "myapp". It is expected the application installs data files in
758     * this directory.
759     *
760     * The @p checkfile is a file name or path of something inside the
761     * share or data directory to be used to test that the prefix
762     * detection worked. For example, your app will install a wallpaper
763     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
764     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
765     * checkfile string.
766     *
767     * @see elm_app_compile_bin_dir_set()
768     * @see elm_app_compile_lib_dir_set()
769     * @see elm_app_compile_data_dir_set()
770     * @see elm_app_compile_locale_set()
771     * @see elm_app_prefix_dir_get()
772     * @see elm_app_bin_dir_get()
773     * @see elm_app_lib_dir_get()
774     * @see elm_app_data_dir_get()
775     * @see elm_app_locale_dir_get()
776     */
777    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
778
779    /**
780     * Provide information on the @b fallback application's binaries
781     * directory, on scenarios where they get overriden by
782     * elm_app_info_set().
783     *
784     * @param dir The path to the default binaries directory (compile time
785     * one)
786     *
787     * @note Elementary will as well use this path to determine actual
788     * names of binaries' directory paths, maybe changing it to be @c
789     * something/local/bin instead of @c something/bin, only, for
790     * example.
791     *
792     * @warning You should call this function @b before
793     * elm_app_info_set().
794     */
795    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
796
797    /**
798     * Provide information on the @b fallback application's libraries
799     * directory, on scenarios where they get overriden by
800     * elm_app_info_set().
801     *
802     * @param dir The path to the default libraries directory (compile
803     * time one)
804     *
805     * @note Elementary will as well use this path to determine actual
806     * names of libraries' directory paths, maybe changing it to be @c
807     * something/lib32 or @c something/lib64 instead of @c something/lib,
808     * only, for example.
809     *
810     * @warning You should call this function @b before
811     * elm_app_info_set().
812     */
813    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
814
815    /**
816     * Provide information on the @b fallback application's data
817     * directory, on scenarios where they get overriden by
818     * elm_app_info_set().
819     *
820     * @param dir The path to the default data directory (compile time
821     * one)
822     *
823     * @note Elementary will as well use this path to determine actual
824     * names of data directory paths, maybe changing it to be @c
825     * something/local/share instead of @c something/share, only, for
826     * example.
827     *
828     * @warning You should call this function @b before
829     * elm_app_info_set().
830     */
831    EAPI void         elm_app_compile_data_dir_set(const char *dir);
832
833    /**
834     * Provide information on the @b fallback application's locale
835     * directory, on scenarios where they get overriden by
836     * elm_app_info_set().
837     *
838     * @param dir The path to the default locale directory (compile time
839     * one)
840     *
841     * @warning You should call this function @b before
842     * elm_app_info_set().
843     */
844    EAPI void         elm_app_compile_locale_set(const char *dir);
845
846    /**
847     * Retrieve the application's run time prefix directory, as set by
848     * elm_app_info_set() and the way (environment) the application was
849     * run from.
850     *
851     * @return The directory prefix the application is actually using
852     */
853    EAPI const char  *elm_app_prefix_dir_get(void);
854
855    /**
856     * Retrieve the application's run time binaries prefix directory, as
857     * set by elm_app_info_set() and the way (environment) the application
858     * was run from.
859     *
860     * @return The binaries directory prefix the application is actually
861     * using
862     */
863    EAPI const char  *elm_app_bin_dir_get(void);
864
865    /**
866     * Retrieve the application's run time libraries prefix directory, as
867     * set by elm_app_info_set() and the way (environment) the application
868     * was run from.
869     *
870     * @return The libraries directory prefix the application is actually
871     * using
872     */
873    EAPI const char  *elm_app_lib_dir_get(void);
874
875    /**
876     * Retrieve the application's run time data prefix directory, as
877     * set by elm_app_info_set() and the way (environment) the application
878     * was run from.
879     *
880     * @return The data directory prefix the application is actually
881     * using
882     */
883    EAPI const char  *elm_app_data_dir_get(void);
884
885    /**
886     * Retrieve the application's run time locale prefix directory, as
887     * set by elm_app_info_set() and the way (environment) the application
888     * was run from.
889     *
890     * @return The locale directory prefix the application is actually
891     * using
892     */
893    EAPI const char  *elm_app_locale_dir_get(void);
894
895    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
896    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
897    EAPI int          elm_quicklaunch_init(int argc, char **argv);
898    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
899    EAPI int          elm_quicklaunch_sub_shutdown(void);
900    EAPI int          elm_quicklaunch_shutdown(void);
901    EAPI void         elm_quicklaunch_seed(void);
902    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
903    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
904    EAPI void         elm_quicklaunch_cleanup(void);
905    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
906    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
907
908    EAPI Eina_Bool    elm_need_efreet(void);
909    EAPI Eina_Bool    elm_need_e_dbus(void);
910    EAPI Eina_Bool    elm_need_ethumb(void);
911
912    /**
913     * Set a new policy's value (for a given policy group/identifier).
914     *
915     * @param policy policy identifier, as in @ref Elm_Policy.
916     * @param value policy value, which depends on the identifier
917     *
918     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
919     *
920     * Elementary policies define applications' behavior,
921     * somehow. These behaviors are divided in policy groups (see
922     * #Elm_Policy enumeration). This call will emit the Ecore event
923     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
924     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
925     * then.
926     *
927     * @note Currently, we have only one policy identifier/group
928     * (#ELM_POLICY_QUIT), which has two possible values.
929     *
930     * @ingroup General
931     */
932    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
933
934    /**
935     * Gets the policy value set for given policy identifier.
936     *
937     * @param policy policy identifier, as in #Elm_Policy.
938     * @return The currently set policy value, for that
939     * identifier. Will be @c 0 if @p policy passed is invalid.
940     *
941     * @ingroup General
942     */
943    EAPI int          elm_policy_get(unsigned int policy);
944
945    /**
946     * Set a label of an object
947     *
948     * @param obj The Elementary object
949     * @param part The text part name to set (NULL for the default label)
950     * @param label The new text of the label
951     *
952     * @note Elementary objects may have many labels (e.g. Action Slider)
953     *
954     * @ingroup General
955     */
956    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
957
958 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
959
960    /**
961     * Get a label of an object
962     *
963     * @param obj The Elementary object
964     * @param part The text part name to get (NULL for the default label)
965     * @return text of the label or NULL for any error
966     *
967     * @note Elementary objects may have many labels (e.g. Action Slider)
968     *
969     * @ingroup General
970     */
971    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
972
973 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
974
975    /**
976     * Set a content of an object
977     *
978     * @param obj The Elementary object
979     * @param part The content part name to set (NULL for the default content)
980     * @param content The new content of the object
981     *
982     * @note Elementary objects may have many contents
983     *
984     * @ingroup General
985     */
986    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
987
988 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
989
990    /**
991     * Get a content of an object
992     *
993     * @param obj The Elementary object
994     * @param item The content part name to get (NULL for the default content)
995     * @return content of the object or NULL for any error
996     *
997     * @note Elementary objects may have many contents
998     *
999     * @ingroup General
1000     */
1001    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1002
1003 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1004
1005    /**
1006     * Unset a content of an object
1007     *
1008     * @param obj The Elementary object
1009     * @param item The content part name to unset (NULL for the default content)
1010     *
1011     * @note Elementary objects may have many contents
1012     *
1013     * @ingroup General
1014     */
1015    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1016
1017 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1018
1019    /**
1020     * Set a content of an object item
1021     *
1022     * @param it The Elementary object item
1023     * @param part The content part name to unset (NULL for the default content)
1024     * @param content The new content of the object item
1025     *
1026     * @note Elementary object items may have many contents
1027     *
1028     * @ingroup General
1029     */
1030    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1031
1032 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1033
1034    /**
1035     * Get a content of an object item
1036     *
1037     * @param it The Elementary object item
1038     * @param part The content part name to unset (NULL for the default content)
1039     * @return content of the object item or NULL for any error
1040     *
1041     * @note Elementary object items may have many contents
1042     *
1043     * @ingroup General
1044     */
1045    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1046
1047 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1048
1049    /**
1050     * Unset a content of an object item
1051     *
1052     * @param it The Elementary object item
1053     * @param part The content part name to unset (NULL for the default content)
1054     *
1055     * @note Elementary object items may have many contents
1056     *
1057     * @ingroup General
1058     */
1059    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1060
1061 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1062
1063    /**
1064     * Set a label of an objec itemt
1065     *
1066     * @param it The Elementary object item
1067     * @param part The text part name to set (NULL for the default label)
1068     * @param label The new text of the label
1069     *
1070     * @note Elementary object items may have many labels
1071     *
1072     * @ingroup General
1073     */
1074    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1075
1076 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1077
1078    /**
1079     * Get a label of an object
1080     *
1081     * @param it The Elementary object item
1082     * @param part The text part name to get (NULL for the default label)
1083     * @return text of the label or NULL for any error
1084     *
1085     * @note Elementary object items may have many labels
1086     *
1087     * @ingroup General
1088     */
1089    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1090
1091 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1092
1093    /**
1094     * @}
1095     */
1096
1097    EAPI void         elm_all_flush(void);
1098    EAPI int          elm_cache_flush_interval_get(void);
1099    EAPI void         elm_cache_flush_interval_set(int size);
1100    EAPI void         elm_cache_flush_interval_all_set(int size);
1101    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1102    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1103    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1104    EAPI int          elm_font_cache_get(void);
1105    EAPI void         elm_font_cache_set(int size);
1106    EAPI void         elm_font_cache_all_set(int size);
1107    EAPI int          elm_image_cache_get(void);
1108    EAPI void         elm_image_cache_set(int size);
1109    EAPI void         elm_image_cache_all_set(int size);
1110    EAPI int          elm_edje_file_cache_get(void);
1111    EAPI void         elm_edje_file_cache_set(int size);
1112    EAPI void         elm_edje_file_cache_all_set(int size);
1113    EAPI int          elm_edje_collection_cache_get(void);
1114    EAPI void         elm_edje_collection_cache_set(int size);
1115    EAPI void         elm_edje_collection_cache_all_set(int size);
1116
1117    /**
1118     * @defgroup Scaling Selective Widget Scaling
1119     *
1120     * Different widgets can be scaled independently. These functions
1121     * allow you to manipulate this scaling on a per-widget basis. The
1122     * object and all its children get their scaling factors multiplied
1123     * by the scale factor set. This is multiplicative, in that if a
1124     * child also has a scale size set it is in turn multiplied by its
1125     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1126     * double size, @c 0.5 is half, etc.
1127     *
1128     * @ref general_functions_example_page "This" example contemplates
1129     * some of these functions.
1130     */
1131
1132    /**
1133     * Set the scaling factor for a given Elementary object
1134     *
1135     * @param obj The Elementary to operate on
1136     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1137     * no scaling)
1138     *
1139     * @ingroup Scaling
1140     */
1141    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1142
1143    /**
1144     * Get the scaling factor for a given Elementary object
1145     *
1146     * @param obj The object
1147     * @return The scaling factor set by elm_object_scale_set()
1148     *
1149     * @ingroup Scaling
1150     */
1151    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1152    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1153    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1154    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1155    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1156    /**
1157     * Set the style to use by a widget
1158     *
1159     * Sets the style name that will define the appearance of a widget. Styles
1160     * vary from widget to widget and may also be defined by other themes
1161     * by means of extensions and overlays.
1162     *
1163     * @param obj The Elementary widget to style
1164     * @param style The style name to use
1165     *
1166     * @see elm_theme_extension_add()
1167     * @see elm_theme_overlay_add()
1168     *
1169     * @ingroup Theme
1170     */
1171    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1172    /**
1173     * Get the style used by the widget
1174     *
1175     * This gets the style being used for that widget. Note that the string
1176     * pointer is only valid as longas the object is valid and the style doesn't
1177     * change.
1178     *
1179     * @param obj The Elementary widget to query for its style
1180     * @return The style name used
1181     *
1182     * @see elm_object_style_set()
1183     *
1184     * @ingroup Theme
1185     */
1186    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1187
1188    /**
1189     * @defgroup Styles Styles
1190     *
1191     * Widgets can have different styles of look. These generic API's
1192     * set styles of widgets, if they support them (and if the theme(s)
1193     * do).
1194     *
1195     * @ref general_functions_example_page "This" example contemplates
1196     * some of these functions.
1197     */
1198
1199    /**
1200     * Set the disabled state of an Elementary object.
1201     *
1202     * @param obj The Elementary object to operate on
1203     * @param disabled The state to put in in: @c EINA_TRUE for
1204     *        disabled, @c EINA_FALSE for enabled
1205     *
1206     * Elementary objects can be @b disabled, in which state they won't
1207     * receive input and, in general, will be themed differently from
1208     * their normal state, usually greyed out. Useful for contexts
1209     * where you don't want your users to interact with some of the
1210     * parts of you interface.
1211     *
1212     * This sets the state for the widget, either disabling it or
1213     * enabling it back.
1214     *
1215     * @ingroup Styles
1216     */
1217    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1218
1219    /**
1220     * Get the disabled state of an Elementary object.
1221     *
1222     * @param obj The Elementary object to operate on
1223     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1224     *            if it's enabled (or on errors)
1225     *
1226     * This gets the state of the widget, which might be enabled or disabled.
1227     *
1228     * @ingroup Styles
1229     */
1230    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1231
1232    /**
1233     * @defgroup WidgetNavigation Widget Tree Navigation.
1234     *
1235     * How to check if an Evas Object is an Elementary widget? How to
1236     * get the first elementary widget that is parent of the given
1237     * object?  These are all covered in widget tree navigation.
1238     *
1239     * @ref general_functions_example_page "This" example contemplates
1240     * some of these functions.
1241     */
1242
1243    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1244
1245    /**
1246     * Get the first parent of the given object that is an Elementary
1247     * widget.
1248     *
1249     * @param obj the Elementary object to query parent from.
1250     * @return the parent object that is an Elementary widget, or @c
1251     *         NULL, if it was not found.
1252     *
1253     * Use this to query for an object's parent widget.
1254     *
1255     * @note Most of Elementary users wouldn't be mixing non-Elementary
1256     * smart objects in the objects tree of an application, as this is
1257     * an advanced usage of Elementary with Evas. So, except for the
1258     * application's window, which is the root of that tree, all other
1259     * objects would have valid Elementary widget parents.
1260     *
1261     * @ingroup WidgetNavigation
1262     */
1263    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1264    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1265    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1266
1267    EAPI double       elm_scale_get(void);
1268    EAPI void         elm_scale_set(double scale);
1269    EAPI void         elm_scale_all_set(double scale);
1270
1271    EAPI Eina_Bool    elm_mirrored_get(void);
1272    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1273
1274    EAPI Eina_Bool    elm_config_save(void);
1275    EAPI void         elm_config_reload(void);
1276
1277    EAPI const char  *elm_profile_current_get(void);
1278    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1279    EAPI void         elm_profile_dir_free(const char *p_dir);
1280    EAPI Eina_List   *elm_profile_list_get(void);
1281    EAPI void         elm_profile_list_free(Eina_List *l);
1282    EAPI void         elm_profile_set(const char *profile);
1283    EAPI void         elm_profile_all_set(const char *profile);
1284
1285    EAPI const char  *elm_engine_current_get(void);
1286    EAPI void         elm_engine_set(const char *engine);
1287
1288   typedef struct _Elm_Text_Class
1289     {
1290        const char *name;
1291        const char *desc;
1292     } Elm_Text_Class;
1293
1294   typedef struct _Elm_Font_Overlay
1295     {
1296        const char     *text_class;
1297        const char     *font;
1298        Evas_Font_Size  size;
1299     } Elm_Font_Overlay;
1300
1301   typedef struct _Elm_Font_Properties
1302     {
1303        const char *name;
1304        Eina_List  *styles;
1305     } Elm_Font_Properties;
1306
1307    EAPI const Eina_List     *elm_text_classes_list_get(void);
1308    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1309
1310    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1311    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1312    EAPI void                 elm_font_overlay_unset(const char *text_class);
1313    EAPI void                 elm_font_overlay_apply(void);
1314    EAPI void                 elm_font_overlay_all_apply(void);
1315
1316    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1317    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1318    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1319    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1320    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
1321    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
1322
1323    /**
1324     * @defgroup Fingers Fingers
1325     *
1326     * Elementary is designed to be finger-friendly for touchscreens,
1327     * and so in addition to scaling for display resolution, it can
1328     * also scale based on finger "resolution" (or size). You can then
1329     * customize the granularity of the areas meant to receive clicks
1330     * on touchscreens.
1331     *
1332     * Different profiles may have pre-set values for finger sizes.
1333     *
1334     * @ref general_functions_example_page "This" example contemplates
1335     * some of these functions.
1336     */
1337
1338    /**
1339     * Get the configured "finger size"
1340     *
1341     * @return The finger size
1342     *
1343     * This gets the globally configured finger size, <b>in pixels</b>
1344     *
1345     * @ingroup Fingers
1346     */
1347    EAPI Evas_Coord       elm_finger_size_get(void);
1348    EAPI void             elm_finger_size_set(Evas_Coord size);
1349    EAPI void             elm_finger_size_all_set(Evas_Coord size);
1350
1351    /**
1352     * @defgroup Focus Focus
1353     *
1354     * An Elementary application has, at all times, one (and only one)
1355     * @b focused object. This is what determines where the input
1356     * events go to within the application's window. Also, focused
1357     * objects can be decorated differently, in order to signal to the
1358     * user where the input is, at a given moment.
1359     *
1360     * Elementary applications also have the concept of <b>focus
1361     * chain</b>: one can cycle through all the windows' focusable
1362     * objects by input (tab key) or programmatically. The default
1363     * focus chain for an application is the one define by the order in
1364     * which the widgets where added in code. One will cycle through
1365     * top level widgets, and, for each one containg sub-objects, cycle
1366     * through them all, before returning to the level
1367     * above. Elementary also allows one to set @b custom focus chains
1368     * for their applications.
1369     *
1370     * Besides the focused decoration a widget may exhibit, when it
1371     * gets focus, Elementary has a @b global focus highlight object
1372     * that can be enabled for a window. If one chooses to do so, this
1373     * extra highlight effect will surround the current focused object,
1374     * too.
1375     *
1376     * @note Some Elementary widgets are @b unfocusable, after
1377     * creation, by their very nature: they are not meant to be
1378     * interacted with input events, but are there just for visual
1379     * purposes.
1380     *
1381     * @ref general_functions_example_page "This" example contemplates
1382     * some of these functions.
1383     */
1384
1385    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
1386    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
1387    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
1388    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
1389
1390    /**
1391     * Get the whether an Elementary object has the focus or not.
1392     *
1393     * @param obj The Elementary object to get the information from
1394     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1395     *            not (and on errors).
1396     *
1397     * @see elm_object_focus_set()
1398     *
1399     * @ingroup Focus
1400     */
1401    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1402
1403    /**
1404     * Set/unset focus to a given Elementary object.
1405     *
1406     * @param obj The Elementary object to operate on.
1407     * @param enable @c EINA_TRUE Set focus to a given object,
1408     *               @c EINA_FALSE Unset focus to a given object.
1409     *
1410     * @note When you set focus to this object, if it can handle focus, will
1411     * take the focus away from the one who had it previously and will, for
1412     * now on, be the one receiving input events. Unsetting focus will remove
1413     * the focus from @p obj, passing it back to the previous element in the
1414     * focus chain list.
1415     *
1416     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1417     *
1418     * @ingroup Focus
1419     */
1420    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1421
1422    /**
1423     * Make a given Elementary object the focused one.
1424     *
1425     * @param obj The Elementary object to make focused.
1426     *
1427     * @note This object, if it can handle focus, will take the focus
1428     * away from the one who had it previously and will, for now on, be
1429     * the one receiving input events.
1430     *
1431     * @see elm_object_focus_get()
1432     * @deprecated use elm_object_focus_set() instead.
1433     *
1434     * @ingroup Focus
1435     */
1436    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1437
1438    /**
1439     * Remove the focus from an Elementary object
1440     *
1441     * @param obj The Elementary to take focus from
1442     *
1443     * This removes the focus from @p obj, passing it back to the
1444     * previous element in the focus chain list.
1445     *
1446     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1447     * @deprecated use elm_object_focus_set() instead.
1448     *
1449     * @ingroup Focus
1450     */
1451    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1452
1453    /**
1454     * Set the ability for an Element object to be focused
1455     *
1456     * @param obj The Elementary object to operate on
1457     * @param enable @c EINA_TRUE if the object can be focused, @c
1458     *        EINA_FALSE if not (and on errors)
1459     *
1460     * This sets whether the object @p obj is able to take focus or
1461     * not. Unfocusable objects do nothing when programmatically
1462     * focused, being the nearest focusable parent object the one
1463     * really getting focus. Also, when they receive mouse input, they
1464     * will get the event, but not take away the focus from where it
1465     * was previously.
1466     *
1467     * @ingroup Focus
1468     */
1469    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1470
1471    /**
1472     * Get whether an Elementary object is focusable or not
1473     *
1474     * @param obj The Elementary object to operate on
1475     * @return @c EINA_TRUE if the object is allowed to be focused, @c
1476     *             EINA_FALSE if not (and on errors)
1477     *
1478     * @note Objects which are meant to be interacted with by input
1479     * events are created able to be focused, by default. All the
1480     * others are not.
1481     *
1482     * @ingroup Focus
1483     */
1484    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1485
1486    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1487    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1488    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1489    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1490    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1491    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1492    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1493
1494    /**
1495     * Make the elementary object and its children to be unfocusable (or focusable).
1496     *
1497     * @param obj The Elementary object to operate on
1498     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1499     *        @c EINA_FALSE for focusable.
1500     *
1501     * This sets whether the object @p obj and its children objects
1502     * are able to take focus or not. If the tree is set as unfocusable,
1503     * newest focused object which is not in this tree will get focus.
1504     * This API can be helpful for an object to be deleted.
1505     * When an object will be deleted soon, it and its children may not
1506     * want to get focus (by focus reverting or by other focus controls).
1507     * Then, just use this API before deleting.
1508     *
1509     * @see elm_object_tree_unfocusable_get()
1510     *
1511     * @ingroup Focus
1512     */
1513    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1514
1515    /**
1516     * Get whether an Elementary object and its children are unfocusable or not.
1517     *
1518     * @param obj The Elementary object to get the information from
1519     * @return @c EINA_TRUE, if the tree is unfocussable,
1520     *         @c EINA_FALSE if not (and on errors).
1521     *
1522     * @see elm_object_tree_unfocusable_set()
1523     *
1524     * @ingroup Focus
1525     */
1526    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1527
1528    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
1529    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1530    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1531    EAPI double           elm_scroll_bounce_friction_get(void);
1532    EAPI void             elm_scroll_bounce_friction_set(double friction);
1533    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
1534    EAPI double           elm_scroll_page_scroll_friction_get(void);
1535    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
1536    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
1537    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
1538    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
1539    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
1540    EAPI double           elm_scroll_zoom_friction_get(void);
1541    EAPI void             elm_scroll_zoom_friction_set(double friction);
1542    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
1543    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
1544    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1545    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1546    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
1547    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1548    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1549    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
1550    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1551    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1552    EAPI double           elm_scroll_thumbscroll_friction_get(void);
1553    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
1554    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
1555    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
1556    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
1557    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
1558
1559    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1560    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1561    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1562    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1563    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1564    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1565    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1566    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1567
1568    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1569    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);
1570    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);
1571
1572    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1573    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1574
1575    /**
1576     * Adjust size of an element for finger usage.
1577     *
1578     * @param times_w How many fingers should fit horizontally
1579     * @param w Pointer to the width size to adjust
1580     * @param times_h How many fingers should fit vertically
1581     * @param h Pointer to the height size to adjust
1582     *
1583     * This takes width and height sizes (in pixels) as input and a
1584     * size multiple (which is how many fingers you want to place
1585     * within the area, being "finger" the size set by
1586     * elm_finger_size_set()), and adjusts the size to be large enough
1587     * to accommodate the resulting size -- if it doesn't already
1588     * accommodate it. On return the @p w and @p h sizes pointed to by
1589     * these parameters will be modified, on those conditions.
1590     *
1591     * @note This is kind of a low level Elementary call, most useful
1592     * on size evaluation times for widgets. An external user wouldn't
1593     * be calling, most of the time.
1594     *
1595     * @ingroup Fingers
1596     */
1597    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1598
1599    EAPI double           elm_longpress_timeout_get(void);
1600    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
1601
1602    /* debug
1603     * don't use it unless you are sure
1604     */
1605    EAPI void             elm_object_tree_dump(const Evas_Object *top);
1606    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1607
1608
1609    /* theme */
1610    /**
1611     * @defgroup Theme Theme
1612     *
1613     * Elementary uses Edje to theme its widgets, naturally. But for the most
1614     * part this is hidden behind a simpler interface that lets the user set
1615     * extensions and choose the style of widgets in a much easier way.
1616     *
1617     * Instead of thinking in terms of paths to Edje files and their groups
1618     * each time you want to change the appearance of a widget, Elementary
1619     * works so you can add any theme file with extensions or replace the
1620     * main theme at one point in the application, and then just set the style
1621     * of widgets with elm_object_style_set() and related functions. Elementary
1622     * will then look in its list of themes for a matching group and apply it,
1623     * and when the theme changes midway through the application, all widgets
1624     * will be updated accordingly.
1625     *
1626     * There are three concepts you need to know to understand how Elementary
1627     * theming works: default theme, extensions and overlays.
1628     *
1629     * Default theme, obviously enough, is the one that provides the default
1630     * look of all widgets. End users can change the theme used by Elementary
1631     * by setting the @c ELM_THEME environment variable before running an
1632     * application, or globally for all programs using the @c elementary_config
1633     * utility. Applications can change the default theme using elm_theme_set(),
1634     * but this can go against the user wishes, so it's not an adviced practice.
1635     *
1636     * Ideally, applications should find everything they need in the already
1637     * provided theme, but there may be occasions when that's not enough and
1638     * custom styles are required to correctly express the idea. For this
1639     * cases, Elementary has extensions.
1640     *
1641     * Extensions allow the application developer to write styles of its own
1642     * to apply to some widgets. This requires knowledge of how each widget
1643     * is themed, as extensions will always replace the entire group used by
1644     * the widget, so important signals and parts need to be there for the
1645     * object to behave properly (see documentation of Edje for details).
1646     * Once the theme for the extension is done, the application needs to add
1647     * it to the list of themes Elementary will look into, using
1648     * elm_theme_extension_add(), and set the style of the desired widgets as
1649     * he would normally with elm_object_style_set().
1650     *
1651     * Overlays, on the other hand, can replace the look of all widgets by
1652     * overriding the default style. Like extensions, it's up to the application
1653     * developer to write the theme for the widgets it wants, the difference
1654     * being that when looking for the theme, Elementary will check first the
1655     * list of overlays, then the set theme and lastly the list of extensions,
1656     * so with overlays it's possible to replace the default view and every
1657     * widget will be affected. This is very much alike to setting the whole
1658     * theme for the application and will probably clash with the end user
1659     * options, not to mention the risk of ending up with not matching styles
1660     * across the program. Unless there's a very special reason to use them,
1661     * overlays should be avoided for the resons exposed before.
1662     *
1663     * All these theme lists are handled by ::Elm_Theme instances. Elementary
1664     * keeps one default internally and every function that receives one of
1665     * these can be called with NULL to refer to this default (except for
1666     * elm_theme_free()). It's possible to create a new instance of a
1667     * ::Elm_Theme to set other theme for a specific widget (and all of its
1668     * children), but this is as discouraged, if not even more so, than using
1669     * overlays. Don't use this unless you really know what you are doing.
1670     *
1671     * But to be less negative about things, you can look at the following
1672     * examples:
1673     * @li @ref theme_example_01 "Using extensions"
1674     * @li @ref theme_example_02 "Using overlays"
1675     *
1676     * @{
1677     */
1678    /**
1679     * @typedef Elm_Theme
1680     *
1681     * Opaque handler for the list of themes Elementary looks for when
1682     * rendering widgets.
1683     *
1684     * Stay out of this unless you really know what you are doing. For most
1685     * cases, sticking to the default is all a developer needs.
1686     */
1687    typedef struct _Elm_Theme Elm_Theme;
1688
1689    /**
1690     * Create a new specific theme
1691     *
1692     * This creates an empty specific theme that only uses the default theme. A
1693     * specific theme has its own private set of extensions and overlays too
1694     * (which are empty by default). Specific themes do not fall back to themes
1695     * of parent objects. They are not intended for this use. Use styles, overlays
1696     * and extensions when needed, but avoid specific themes unless there is no
1697     * other way (example: you want to have a preview of a new theme you are
1698     * selecting in a "theme selector" window. The preview is inside a scroller
1699     * and should display what the theme you selected will look like, but not
1700     * actually apply it yet. The child of the scroller will have a specific
1701     * theme set to show this preview before the user decides to apply it to all
1702     * applications).
1703     */
1704    EAPI Elm_Theme       *elm_theme_new(void);
1705    /**
1706     * Free a specific theme
1707     *
1708     * @param th The theme to free
1709     *
1710     * This frees a theme created with elm_theme_new().
1711     */
1712    EAPI void             elm_theme_free(Elm_Theme *th);
1713    /**
1714     * Copy the theme fom the source to the destination theme
1715     *
1716     * @param th The source theme to copy from
1717     * @param thdst The destination theme to copy data to
1718     *
1719     * This makes a one-time static copy of all the theme config, extensions
1720     * and overlays from @p th to @p thdst. If @p th references a theme, then
1721     * @p thdst is also set to reference it, with all the theme settings,
1722     * overlays and extensions that @p th had.
1723     */
1724    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1725    /**
1726     * Tell the source theme to reference the ref theme
1727     *
1728     * @param th The theme that will do the referencing
1729     * @param thref The theme that is the reference source
1730     *
1731     * This clears @p th to be empty and then sets it to refer to @p thref
1732     * so @p th acts as an override to @p thref, but where its overrides
1733     * don't apply, it will fall through to @p thref for configuration.
1734     */
1735    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1736    /**
1737     * Return the theme referred to
1738     *
1739     * @param th The theme to get the reference from
1740     * @return The referenced theme handle
1741     *
1742     * This gets the theme set as the reference theme by elm_theme_ref_set().
1743     * If no theme is set as a reference, NULL is returned.
1744     */
1745    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
1746    /**
1747     * Return the default theme
1748     *
1749     * @return The default theme handle
1750     *
1751     * This returns the internal default theme setup handle that all widgets
1752     * use implicitly unless a specific theme is set. This is also often use
1753     * as a shorthand of NULL.
1754     */
1755    EAPI Elm_Theme       *elm_theme_default_get(void);
1756    /**
1757     * Prepends a theme overlay to the list of overlays
1758     *
1759     * @param th The theme to add to, or if NULL, the default theme
1760     * @param item The Edje file path to be used
1761     *
1762     * Use this if your application needs to provide some custom overlay theme
1763     * (An Edje file that replaces some default styles of widgets) where adding
1764     * new styles, or changing system theme configuration is not possible. Do
1765     * NOT use this instead of a proper system theme configuration. Use proper
1766     * configuration files, profiles, environment variables etc. to set a theme
1767     * so that the theme can be altered by simple confiugration by a user. Using
1768     * this call to achieve that effect is abusing the API and will create lots
1769     * of trouble.
1770     *
1771     * @see elm_theme_extension_add()
1772     */
1773    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
1774    /**
1775     * Delete a theme overlay from the list of overlays
1776     *
1777     * @param th The theme to delete from, or if NULL, the default theme
1778     * @param item The name of the theme overlay
1779     *
1780     * @see elm_theme_overlay_add()
1781     */
1782    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
1783    /**
1784     * Appends a theme extension to the list of extensions.
1785     *
1786     * @param th The theme to add to, or if NULL, the default theme
1787     * @param item The Edje file path to be used
1788     *
1789     * This is intended when an application needs more styles of widgets or new
1790     * widget themes that the default does not provide (or may not provide). The
1791     * application has "extended" usage by coming up with new custom style names
1792     * for widgets for specific uses, but as these are not "standard", they are
1793     * not guaranteed to be provided by a default theme. This means the
1794     * application is required to provide these extra elements itself in specific
1795     * Edje files. This call adds one of those Edje files to the theme search
1796     * path to be search after the default theme. The use of this call is
1797     * encouraged when default styles do not meet the needs of the application.
1798     * Use this call instead of elm_theme_overlay_add() for almost all cases.
1799     *
1800     * @see elm_object_style_set()
1801     */
1802    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
1803    /**
1804     * Deletes a theme extension from the list of extensions.
1805     *
1806     * @param th The theme to delete from, or if NULL, the default theme
1807     * @param item The name of the theme extension
1808     *
1809     * @see elm_theme_extension_add()
1810     */
1811    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
1812    /**
1813     * Set the theme search order for the given theme
1814     *
1815     * @param th The theme to set the search order, or if NULL, the default theme
1816     * @param theme Theme search string
1817     *
1818     * This sets the search string for the theme in path-notation from first
1819     * theme to search, to last, delimited by the : character. Example:
1820     *
1821     * "shiny:/path/to/file.edj:default"
1822     *
1823     * See the ELM_THEME environment variable for more information.
1824     *
1825     * @see elm_theme_get()
1826     * @see elm_theme_list_get()
1827     */
1828    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
1829    /**
1830     * Return the theme search order
1831     *
1832     * @param th The theme to get the search order, or if NULL, the default theme
1833     * @return The internal search order path
1834     *
1835     * This function returns a colon separated string of theme elements as
1836     * returned by elm_theme_list_get().
1837     *
1838     * @see elm_theme_set()
1839     * @see elm_theme_list_get()
1840     */
1841    EAPI const char      *elm_theme_get(Elm_Theme *th);
1842    /**
1843     * Return a list of theme elements to be used in a theme.
1844     *
1845     * @param th Theme to get the list of theme elements from.
1846     * @return The internal list of theme elements
1847     *
1848     * This returns the internal list of theme elements (will only be valid as
1849     * long as the theme is not modified by elm_theme_set() or theme is not
1850     * freed by elm_theme_free(). This is a list of strings which must not be
1851     * altered as they are also internal. If @p th is NULL, then the default
1852     * theme element list is returned.
1853     *
1854     * A theme element can consist of a full or relative path to a .edj file,
1855     * or a name, without extension, for a theme to be searched in the known
1856     * theme paths for Elemementary.
1857     *
1858     * @see elm_theme_set()
1859     * @see elm_theme_get()
1860     */
1861    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1862    /**
1863     * Return the full patrh for a theme element
1864     *
1865     * @param f The theme element name
1866     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1867     * @return The full path to the file found.
1868     *
1869     * This returns a string you should free with free() on success, NULL on
1870     * failure. This will search for the given theme element, and if it is a
1871     * full or relative path element or a simple searchable name. The returned
1872     * path is the full path to the file, if searched, and the file exists, or it
1873     * is simply the full path given in the element or a resolved path if
1874     * relative to home. The @p in_search_path boolean pointed to is set to
1875     * EINA_TRUE if the file was a searchable file andis in the search path,
1876     * and EINA_FALSE otherwise.
1877     */
1878    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1879    /**
1880     * Flush the current theme.
1881     *
1882     * @param th Theme to flush
1883     *
1884     * This flushes caches that let elementary know where to find theme elements
1885     * in the given theme. If @p th is NULL, then the default theme is flushed.
1886     * Call this function if source theme data has changed in such a way as to
1887     * make any caches Elementary kept invalid.
1888     */
1889    EAPI void             elm_theme_flush(Elm_Theme *th);
1890    /**
1891     * This flushes all themes (default and specific ones).
1892     *
1893     * This will flush all themes in the current application context, by calling
1894     * elm_theme_flush() on each of them.
1895     */
1896    EAPI void             elm_theme_full_flush(void);
1897    /**
1898     * Set the theme for all elementary using applications on the current display
1899     *
1900     * @param theme The name of the theme to use. Format same as the ELM_THEME
1901     * environment variable.
1902     */
1903    EAPI void             elm_theme_all_set(const char *theme);
1904    /**
1905     * Return a list of theme elements in the theme search path
1906     *
1907     * @return A list of strings that are the theme element names.
1908     *
1909     * This lists all available theme files in the standard Elementary search path
1910     * for theme elements, and returns them in alphabetical order as theme
1911     * element names in a list of strings. Free this with
1912     * elm_theme_name_available_list_free() when you are done with the list.
1913     */
1914    EAPI Eina_List       *elm_theme_name_available_list_new(void);
1915    /**
1916     * Free the list returned by elm_theme_name_available_list_new()
1917     *
1918     * This frees the list of themes returned by
1919     * elm_theme_name_available_list_new(). Once freed the list should no longer
1920     * be used. a new list mys be created.
1921     */
1922    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
1923    /**
1924     * Set a specific theme to be used for this object and its children
1925     *
1926     * @param obj The object to set the theme on
1927     * @param th The theme to set
1928     *
1929     * This sets a specific theme that will be used for the given object and any
1930     * child objects it has. If @p th is NULL then the theme to be used is
1931     * cleared and the object will inherit its theme from its parent (which
1932     * ultimately will use the default theme if no specific themes are set).
1933     *
1934     * Use special themes with great care as this will annoy users and make
1935     * configuration difficult. Avoid any custom themes at all if it can be
1936     * helped.
1937     */
1938    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1939    /**
1940     * Get the specific theme to be used
1941     *
1942     * @param obj The object to get the specific theme from
1943     * @return The specifc theme set.
1944     *
1945     * This will return a specific theme set, or NULL if no specific theme is
1946     * set on that object. It will not return inherited themes from parents, only
1947     * the specific theme set for that specific object. See elm_object_theme_set()
1948     * for more information.
1949     */
1950    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1951    /**
1952     * @}
1953     */
1954
1955    /* win */
1956    /** @defgroup Win Win
1957     *
1958     * @image html img/widget/win/preview-00.png
1959     * @image latex img/widget/win/preview-00.eps
1960     *
1961     * The window class of Elementary.  Contains functions to manipulate
1962     * windows. The Evas engine used to render the window contents is specified
1963     * in the system or user elementary config files (whichever is found last),
1964     * and can be overridden with the ELM_ENGINE environment variable for
1965     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
1966     * compilation setup and modules actually installed at runtime) are (listed
1967     * in order of best supported and most likely to be complete and work to
1968     * lowest quality).
1969     *
1970     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1971     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1972     * rendering in X11)
1973     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1974     * exits)
1975     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1976     * rendering)
1977     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1978     * buffer)
1979     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1980     * rendering using SDL as the buffer)
1981     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1982     * GDI with software)
1983     * @li "dfb", "directfb" (Rendering to a DirectFB window)
1984     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1985     * grayscale using dedicated 8bit software engine in X11)
1986     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1987     * X11 using 16bit software engine)
1988     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1989     * (Windows CE rendering via GDI with 16bit software renderer)
1990     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1991     * buffer with 16bit software renderer)
1992     *
1993     * All engines use a simple string to select the engine to render, EXCEPT
1994     * the "shot" engine. This actually encodes the output of the virtual
1995     * screenshot and how long to delay in the engine string. The engine string
1996     * is encoded in the following way:
1997     *
1998     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1999     *
2000     * Where options are separated by a ":" char if more than one option is
2001     * given, with delay, if provided being the first option and file the last
2002     * (order is important). The delay specifies how long to wait after the
2003     * window is shown before doing the virtual "in memory" rendering and then
2004     * save the output to the file specified by the file option (and then exit).
2005     * If no delay is given, the default is 0.5 seconds. If no file is given the
2006     * default output file is "out.png". Repeat option is for continous
2007     * capturing screenshots. Repeat range is from 1 to 999 and filename is
2008     * fixed to "out001.png" Some examples of using the shot engine:
2009     *
2010     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
2011     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
2012     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
2013     *   ELM_ENGINE="shot:delay=2.0" elementary_test
2014     *   ELM_ENGINE="shot:" elementary_test
2015     *
2016     * Signals that you can add callbacks for are:
2017     *
2018     * @li "delete,request": the user requested to close the window. See
2019     * elm_win_autodel_set().
2020     * @li "focus,in": window got focus
2021     * @li "focus,out": window lost focus
2022     * @li "moved": window that holds the canvas was moved
2023     *
2024     * Examples:
2025     * @li @ref win_example_01
2026     *
2027     * @{
2028     */
2029    /**
2030     * Defines the types of window that can be created
2031     *
2032     * These are hints set on the window so that a running Window Manager knows
2033     * how the window should be handled and/or what kind of decorations it
2034     * should have.
2035     *
2036     * Currently, only the X11 backed engines use them.
2037     */
2038    typedef enum _Elm_Win_Type
2039      {
2040         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
2041                          window. Almost every window will be created with this
2042                          type. */
2043         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
2044         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
2045                            window holding desktop icons. */
2046         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
2047                         be kept on top of any other window by the Window
2048                         Manager. */
2049         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
2050                            similar. */
2051         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
2052         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
2053                            pallete. */
2054         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
2055         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
2056                                  entry in a menubar is clicked. Typically used
2057                                  with elm_win_override_set(). This hint exists
2058                                  for completion only, as the EFL way of
2059                                  implementing a menu would not normally use a
2060                                  separate window for its contents. */
2061         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
2062                               triggered by right-clicking an object. */
2063         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
2064                            explanatory text that typically appear after the
2065                            mouse cursor hovers over an object for a while.
2066                            Typically used with elm_win_override_set() and also
2067                            not very commonly used in the EFL. */
2068         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
2069                                 battery life or a new E-Mail received. */
2070         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
2071                          usually used in the EFL. */
2072         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
2073                        object being dragged across different windows, or even
2074                        applications. Typically used with
2075                        elm_win_override_set(). */
2076         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
2077                                  buffer. No actual window is created for this
2078                                  type, instead the window and all of its
2079                                  contents will be rendered to an image buffer.
2080                                  This allows to have children window inside a
2081                                  parent one just like any other object would
2082                                  be, and do other things like applying @c
2083                                  Evas_Map effects to it. This is the only type
2084                                  of window that requires the @c parent
2085                                  parameter of elm_win_add() to be a valid @c
2086                                  Evas_Object. */
2087      } Elm_Win_Type;
2088
2089    /**
2090     * The differents layouts that can be requested for the virtual keyboard.
2091     *
2092     * When the application window is being managed by Illume, it may request
2093     * any of the following layouts for the virtual keyboard.
2094     */
2095    typedef enum _Elm_Win_Keyboard_Mode
2096      {
2097         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
2098         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
2099         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
2100         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
2101         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
2102         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
2103         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
2104         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
2105         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
2106         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
2107         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
2108         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
2109         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
2110         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
2111         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
2112         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
2113      } Elm_Win_Keyboard_Mode;
2114
2115    /**
2116     * Available commands that can be sent to the Illume manager.
2117     *
2118     * When running under an Illume session, a window may send commands to the
2119     * Illume manager to perform different actions.
2120     */
2121    typedef enum _Elm_Illume_Command
2122      {
2123         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
2124                                          window */
2125         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
2126                                             in the list */
2127         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
2128                                          screen */
2129         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
2130      } Elm_Illume_Command;
2131
2132    /**
2133     * Adds a window object. If this is the first window created, pass NULL as
2134     * @p parent.
2135     *
2136     * @param parent Parent object to add the window to, or NULL
2137     * @param name The name of the window
2138     * @param type The window type, one of #Elm_Win_Type.
2139     *
2140     * The @p parent paramter can be @c NULL for every window @p type except
2141     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
2142     * which the image object will be created.
2143     *
2144     * @return The created object, or NULL on failure
2145     */
2146    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
2147    /**
2148     * Add @p subobj as a resize object of window @p obj.
2149     *
2150     *
2151     * Setting an object as a resize object of the window means that the
2152     * @p subobj child's size and position will be controlled by the window
2153     * directly. That is, the object will be resized to match the window size
2154     * and should never be moved or resized manually by the developer.
2155     *
2156     * In addition, resize objects of the window control what the minimum size
2157     * of it will be, as well as whether it can or not be resized by the user.
2158     *
2159     * For the end user to be able to resize a window by dragging the handles
2160     * or borders provided by the Window Manager, or using any other similar
2161     * mechanism, all of the resize objects in the window should have their
2162     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
2163     *
2164     * @param obj The window object
2165     * @param subobj The resize object to add
2166     */
2167    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2168    /**
2169     * Delete @p subobj as a resize object of window @p obj.
2170     *
2171     * This function removes the object @p subobj from the resize objects of
2172     * the window @p obj. It will not delete the object itself, which will be
2173     * left unmanaged and should be deleted by the developer, manually handled
2174     * or set as child of some other container.
2175     *
2176     * @param obj The window object
2177     * @param subobj The resize object to add
2178     */
2179    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2180    /**
2181     * Set the title of the window
2182     *
2183     * @param obj The window object
2184     * @param title The title to set
2185     */
2186    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2187    /**
2188     * Get the title of the window
2189     *
2190     * The returned string is an internal one and should not be freed or
2191     * modified. It will also be rendered invalid if a new title is set or if
2192     * the window is destroyed.
2193     *
2194     * @param obj The window object
2195     * @return The title
2196     */
2197    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2198    /**
2199     * Set the window's autodel state.
2200     *
2201     * When closing the window in any way outside of the program control, like
2202     * pressing the X button in the titlebar or using a command from the
2203     * Window Manager, a "delete,request" signal is emitted to indicate that
2204     * this event occurred and the developer can take any action, which may
2205     * include, or not, destroying the window object.
2206     *
2207     * When the @p autodel parameter is set, the window will be automatically
2208     * destroyed when this event occurs, after the signal is emitted.
2209     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
2210     * and is up to the program to do so when it's required.
2211     *
2212     * @param obj The window object
2213     * @param autodel If true, the window will automatically delete itself when
2214     * closed
2215     */
2216    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
2217    /**
2218     * Get the window's autodel state.
2219     *
2220     * @param obj The window object
2221     * @return If the window will automatically delete itself when closed
2222     *
2223     * @see elm_win_autodel_set()
2224     */
2225    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2226    /**
2227     * Activate a window object.
2228     *
2229     * This function sends a request to the Window Manager to activate the
2230     * window pointed by @p obj. If honored by the WM, the window will receive
2231     * the keyboard focus.
2232     *
2233     * @note This is just a request that a Window Manager may ignore, so calling
2234     * this function does not ensure in any way that the window will be the
2235     * active one after it.
2236     *
2237     * @param obj The window object
2238     */
2239    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2240    /**
2241     * Lower a window object.
2242     *
2243     * Places the window pointed by @p obj at the bottom of the stack, so that
2244     * no other window is covered by it.
2245     *
2246     * If elm_win_override_set() is not set, the Window Manager may ignore this
2247     * request.
2248     *
2249     * @param obj The window object
2250     */
2251    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2252    /**
2253     * Raise a window object.
2254     *
2255     * Places the window pointed by @p obj at the top of the stack, so that it's
2256     * not covered by any other window.
2257     *
2258     * If elm_win_override_set() is not set, the Window Manager may ignore this
2259     * request.
2260     *
2261     * @param obj The window object
2262     */
2263    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2264    /**
2265     * Set the borderless state of a window.
2266     *
2267     * This function requests the Window Manager to not draw any decoration
2268     * around the window.
2269     *
2270     * @param obj The window object
2271     * @param borderless If true, the window is borderless
2272     */
2273    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2274    /**
2275     * Get the borderless state of a window.
2276     *
2277     * @param obj The window object
2278     * @return If true, the window is borderless
2279     */
2280    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2281    /**
2282     * Set the shaped state of a window.
2283     *
2284     * Shaped windows, when supported, will render the parts of the window that
2285     * has no content, transparent.
2286     *
2287     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2288     * background object or cover the entire window in any other way, or the
2289     * parts of the canvas that have no data will show framebuffer artifacts.
2290     *
2291     * @param obj The window object
2292     * @param shaped If true, the window is shaped
2293     *
2294     * @see elm_win_alpha_set()
2295     */
2296    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2297    /**
2298     * Get the shaped state of a window.
2299     *
2300     * @param obj The window object
2301     * @return If true, the window is shaped
2302     *
2303     * @see elm_win_shaped_set()
2304     */
2305    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2306    /**
2307     * Set the alpha channel state of a window.
2308     *
2309     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2310     * possibly making parts of the window completely or partially transparent.
2311     * This is also subject to the underlying system supporting it, like for
2312     * example, running under a compositing manager. If no compositing is
2313     * available, enabling this option will instead fallback to using shaped
2314     * windows, with elm_win_shaped_set().
2315     *
2316     * @param obj The window object
2317     * @param alpha If true, the window has an alpha channel
2318     *
2319     * @see elm_win_alpha_set()
2320     */
2321    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2322    /**
2323     * Get the transparency state of a window.
2324     *
2325     * @param obj The window object
2326     * @return If true, the window is transparent
2327     *
2328     * @see elm_win_transparent_set()
2329     */
2330    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2331    /**
2332     * Set the transparency state of a window.
2333     *
2334     * Use elm_win_alpha_set() instead.
2335     *
2336     * @param obj The window object
2337     * @param transparent If true, the window is transparent
2338     *
2339     * @see elm_win_alpha_set()
2340     */
2341    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2342    /**
2343     * Get the alpha channel state of a window.
2344     *
2345     * @param obj The window object
2346     * @return If true, the window has an alpha channel
2347     */
2348    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2349    /**
2350     * Set the override state of a window.
2351     *
2352     * A window with @p override set to EINA_TRUE will not be managed by the
2353     * Window Manager. This means that no decorations of any kind will be shown
2354     * for it, moving and resizing must be handled by the application, as well
2355     * as the window visibility.
2356     *
2357     * This should not be used for normal windows, and even for not so normal
2358     * ones, it should only be used when there's a good reason and with a lot
2359     * of care. Mishandling override windows may result situations that
2360     * disrupt the normal workflow of the end user.
2361     *
2362     * @param obj The window object
2363     * @param override If true, the window is overridden
2364     */
2365    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2366    /**
2367     * Get the override state of a window.
2368     *
2369     * @param obj The window object
2370     * @return If true, the window is overridden
2371     *
2372     * @see elm_win_override_set()
2373     */
2374    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2375    /**
2376     * Set the fullscreen state of a window.
2377     *
2378     * @param obj The window object
2379     * @param fullscreen If true, the window is fullscreen
2380     */
2381    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2382    /**
2383     * Get the fullscreen state of a window.
2384     *
2385     * @param obj The window object
2386     * @return If true, the window is fullscreen
2387     */
2388    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2389    /**
2390     * Set the maximized state of a window.
2391     *
2392     * @param obj The window object
2393     * @param maximized If true, the window is maximized
2394     */
2395    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2396    /**
2397     * Get the maximized state of a window.
2398     *
2399     * @param obj The window object
2400     * @return If true, the window is maximized
2401     */
2402    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2403    /**
2404     * Set the iconified state of a window.
2405     *
2406     * @param obj The window object
2407     * @param iconified If true, the window is iconified
2408     */
2409    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2410    /**
2411     * Get the iconified state of a window.
2412     *
2413     * @param obj The window object
2414     * @return If true, the window is iconified
2415     */
2416    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2417    /**
2418     * Set the layer of the window.
2419     *
2420     * What this means exactly will depend on the underlying engine used.
2421     *
2422     * In the case of X11 backed engines, the value in @p layer has the
2423     * following meanings:
2424     * @li < 3: The window will be placed below all others.
2425     * @li > 5: The window will be placed above all others.
2426     * @li other: The window will be placed in the default layer.
2427     *
2428     * @param obj The window object
2429     * @param layer The layer of the window
2430     */
2431    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2432    /**
2433     * Get the layer of the window.
2434     *
2435     * @param obj The window object
2436     * @return The layer of the window
2437     *
2438     * @see elm_win_layer_set()
2439     */
2440    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2441    /**
2442     * Set the rotation of the window.
2443     *
2444     * Most engines only work with multiples of 90.
2445     *
2446     * This function is used to set the orientation of the window @p obj to
2447     * match that of the screen. The window itself will be resized to adjust
2448     * to the new geometry of its contents. If you want to keep the window size,
2449     * see elm_win_rotation_with_resize_set().
2450     *
2451     * @param obj The window object
2452     * @param rotation The rotation of the window, in degrees (0-360),
2453     * counter-clockwise.
2454     */
2455    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2456    /**
2457     * Rotates the window and resizes it.
2458     *
2459     * Like elm_win_rotation_set(), but it also resizes the window's contents so
2460     * that they fit inside the current window geometry.
2461     *
2462     * @param obj The window object
2463     * @param layer The rotation of the window in degrees (0-360),
2464     * counter-clockwise.
2465     */
2466    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2467    /**
2468     * Get the rotation of the window.
2469     *
2470     * @param obj The window object
2471     * @return The rotation of the window in degrees (0-360)
2472     *
2473     * @see elm_win_rotation_set()
2474     * @see elm_win_rotation_with_resize_set()
2475     */
2476    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2477    /**
2478     * Set the sticky state of the window.
2479     *
2480     * Hints the Window Manager that the window in @p obj should be left fixed
2481     * at its position even when the virtual desktop it's on moves or changes.
2482     *
2483     * @param obj The window object
2484     * @param sticky If true, the window's sticky state is enabled
2485     */
2486    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2487    /**
2488     * Get the sticky state of the window.
2489     *
2490     * @param obj The window object
2491     * @return If true, the window's sticky state is enabled
2492     *
2493     * @see elm_win_sticky_set()
2494     */
2495    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2496    /**
2497     * Set if this window is an illume conformant window
2498     *
2499     * @param obj The window object
2500     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2501     */
2502    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2503    /**
2504     * Get if this window is an illume conformant window
2505     *
2506     * @param obj The window object
2507     * @return A boolean if this window is illume conformant or not
2508     */
2509    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2510    /**
2511     * Set a window to be an illume quickpanel window
2512     *
2513     * By default window objects are not quickpanel windows.
2514     *
2515     * @param obj The window object
2516     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2517     */
2518    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2519    /**
2520     * Get if this window is a quickpanel or not
2521     *
2522     * @param obj The window object
2523     * @return A boolean if this window is a quickpanel or not
2524     */
2525    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2526    /**
2527     * Set the major priority of a quickpanel window
2528     *
2529     * @param obj The window object
2530     * @param priority The major priority for this quickpanel
2531     */
2532    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2533    /**
2534     * Get the major priority of a quickpanel window
2535     *
2536     * @param obj The window object
2537     * @return The major priority of this quickpanel
2538     */
2539    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2540    /**
2541     * Set the minor priority of a quickpanel window
2542     *
2543     * @param obj The window object
2544     * @param priority The minor priority for this quickpanel
2545     */
2546    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2547    /**
2548     * Get the minor priority of a quickpanel window
2549     *
2550     * @param obj The window object
2551     * @return The minor priority of this quickpanel
2552     */
2553    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2554    /**
2555     * Set which zone this quickpanel should appear in
2556     *
2557     * @param obj The window object
2558     * @param zone The requested zone for this quickpanel
2559     */
2560    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2561    /**
2562     * Get which zone this quickpanel should appear in
2563     *
2564     * @param obj The window object
2565     * @return The requested zone for this quickpanel
2566     */
2567    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2568    /**
2569     * Set the window to be skipped by keyboard focus
2570     *
2571     * This sets the window to be skipped by normal keyboard input. This means
2572     * a window manager will be asked to not focus this window as well as omit
2573     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2574     *
2575     * Call this and enable it on a window BEFORE you show it for the first time,
2576     * otherwise it may have no effect.
2577     *
2578     * Use this for windows that have only output information or might only be
2579     * interacted with by the mouse or fingers, and never for typing input.
2580     * Be careful that this may have side-effects like making the window
2581     * non-accessible in some cases unless the window is specially handled. Use
2582     * this with care.
2583     *
2584     * @param obj The window object
2585     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2586     */
2587    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2588    /**
2589     * Send a command to the windowing environment
2590     *
2591     * This is intended to work in touchscreen or small screen device
2592     * environments where there is a more simplistic window management policy in
2593     * place. This uses the window object indicated to select which part of the
2594     * environment to control (the part that this window lives in), and provides
2595     * a command and an optional parameter structure (use NULL for this if not
2596     * needed).
2597     *
2598     * @param obj The window object that lives in the environment to control
2599     * @param command The command to send
2600     * @param params Optional parameters for the command
2601     */
2602    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2603    /**
2604     * Get the inlined image object handle
2605     *
2606     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2607     * then the window is in fact an evas image object inlined in the parent
2608     * canvas. You can get this object (be careful to not manipulate it as it
2609     * is under control of elementary), and use it to do things like get pixel
2610     * data, save the image to a file, etc.
2611     *
2612     * @param obj The window object to get the inlined image from
2613     * @return The inlined image object, or NULL if none exists
2614     */
2615    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2616    /**
2617     * Set the enabled status for the focus highlight in a window
2618     *
2619     * This function will enable or disable the focus highlight only for the
2620     * given window, regardless of the global setting for it
2621     *
2622     * @param obj The window where to enable the highlight
2623     * @param enabled The enabled value for the highlight
2624     */
2625    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2626    /**
2627     * Get the enabled value of the focus highlight for this window
2628     *
2629     * @param obj The window in which to check if the focus highlight is enabled
2630     *
2631     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2632     */
2633    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2634    /**
2635     * Set the style for the focus highlight on this window
2636     *
2637     * Sets the style to use for theming the highlight of focused objects on
2638     * the given window. If @p style is NULL, the default will be used.
2639     *
2640     * @param obj The window where to set the style
2641     * @param style The style to set
2642     */
2643    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2644    /**
2645     * Get the style set for the focus highlight object
2646     *
2647     * Gets the style set for this windows highilght object, or NULL if none
2648     * is set.
2649     *
2650     * @param obj The window to retrieve the highlights style from
2651     *
2652     * @return The style set or NULL if none was. Default is used in that case.
2653     */
2654    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2655    /*...
2656     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2657     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2658     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2659     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2660     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2661     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2662     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2663     *
2664     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2665     * (blank mouse, private mouse obj, defaultmouse)
2666     *
2667     */
2668    /**
2669     * Sets the keyboard mode of the window.
2670     *
2671     * @param obj The window object
2672     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2673     */
2674    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2675    /**
2676     * Gets the keyboard mode of the window.
2677     *
2678     * @param obj The window object
2679     * @return The mode, one of #Elm_Win_Keyboard_Mode
2680     */
2681    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2682    /**
2683     * Sets whether the window is a keyboard.
2684     *
2685     * @param obj The window object
2686     * @param is_keyboard If true, the window is a virtual keyboard
2687     */
2688    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2689    /**
2690     * Gets whether the window is a keyboard.
2691     *
2692     * @param obj The window object
2693     * @return If the window is a virtual keyboard
2694     */
2695    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2696
2697    /**
2698     * Get the screen position of a window.
2699     *
2700     * @param obj The window object
2701     * @param x The int to store the x coordinate to
2702     * @param y The int to store the y coordinate to
2703     */
2704    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2705    /**
2706     * @}
2707     */
2708
2709    /**
2710     * @defgroup Inwin Inwin
2711     *
2712     * @image html img/widget/inwin/preview-00.png
2713     * @image latex img/widget/inwin/preview-00.eps
2714     * @image html img/widget/inwin/preview-01.png
2715     * @image latex img/widget/inwin/preview-01.eps
2716     * @image html img/widget/inwin/preview-02.png
2717     * @image latex img/widget/inwin/preview-02.eps
2718     *
2719     * An inwin is a window inside a window that is useful for a quick popup.
2720     * It does not hover.
2721     *
2722     * It works by creating an object that will occupy the entire window, so it
2723     * must be created using an @ref Win "elm_win" as parent only. The inwin
2724     * object can be hidden or restacked below every other object if it's
2725     * needed to show what's behind it without destroying it. If this is done,
2726     * the elm_win_inwin_activate() function can be used to bring it back to
2727     * full visibility again.
2728     *
2729     * There are three styles available in the default theme. These are:
2730     * @li default: The inwin is sized to take over most of the window it's
2731     * placed in.
2732     * @li minimal: The size of the inwin will be the minimum necessary to show
2733     * its contents.
2734     * @li minimal_vertical: Horizontally, the inwin takes as much space as
2735     * possible, but it's sized vertically the most it needs to fit its\
2736     * contents.
2737     *
2738     * Some examples of Inwin can be found in the following:
2739     * @li @ref inwin_example_01
2740     *
2741     * @{
2742     */
2743    /**
2744     * Adds an inwin to the current window
2745     *
2746     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2747     * Never call this function with anything other than the top-most window
2748     * as its parameter, unless you are fond of undefined behavior.
2749     *
2750     * After creating the object, the widget will set itself as resize object
2751     * for the window with elm_win_resize_object_add(), so when shown it will
2752     * appear to cover almost the entire window (how much of it depends on its
2753     * content and the style used). It must not be added into other container
2754     * objects and it needs not be moved or resized manually.
2755     *
2756     * @param parent The parent object
2757     * @return The new object or NULL if it cannot be created
2758     */
2759    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2760    /**
2761     * Activates an inwin object, ensuring its visibility
2762     *
2763     * This function will make sure that the inwin @p obj is completely visible
2764     * by calling evas_object_show() and evas_object_raise() on it, to bring it
2765     * to the front. It also sets the keyboard focus to it, which will be passed
2766     * onto its content.
2767     *
2768     * The object's theme will also receive the signal "elm,action,show" with
2769     * source "elm".
2770     *
2771     * @param obj The inwin to activate
2772     */
2773    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2774    /**
2775     * Set the content of an inwin object.
2776     *
2777     * Once the content object is set, a previously set one will be deleted.
2778     * If you want to keep that old content object, use the
2779     * elm_win_inwin_content_unset() function.
2780     *
2781     * @param obj The inwin object
2782     * @param content The object to set as content
2783     */
2784    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2785    /**
2786     * Get the content of an inwin object.
2787     *
2788     * Return the content object which is set for this widget.
2789     *
2790     * The returned object is valid as long as the inwin is still alive and no
2791     * other content is set on it. Deleting the object will notify the inwin
2792     * about it and this one will be left empty.
2793     *
2794     * If you need to remove an inwin's content to be reused somewhere else,
2795     * see elm_win_inwin_content_unset().
2796     *
2797     * @param obj The inwin object
2798     * @return The content that is being used
2799     */
2800    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2801    /**
2802     * Unset the content of an inwin object.
2803     *
2804     * Unparent and return the content object which was set for this widget.
2805     *
2806     * @param obj The inwin object
2807     * @return The content that was being used
2808     */
2809    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2810    /**
2811     * @}
2812     */
2813    /* X specific calls - won't work on non-x engines (return 0) */
2814    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2815    /* smart callbacks called:
2816     * "delete,request" - the user requested to delete the window
2817     * "focus,in" - window got focus
2818     * "focus,out" - window lost focus
2819     * "moved" - window that holds the canvas was moved
2820     */
2821
2822    /**
2823     * @defgroup Bg Bg
2824     *
2825     * @image html img/widget/bg/preview-00.png
2826     * @image latex img/widget/bg/preview-00.eps
2827     *
2828     * @brief Background object, used for setting a solid color, image or Edje
2829     * group as background to a window or any container object.
2830     *
2831     * The bg object is used for setting a solid background to a window or
2832     * packing into any container object. It works just like an image, but has
2833     * some properties useful to a background, like setting it to tiled,
2834     * centered, scaled or stretched.
2835     *
2836     * Here is some sample code using it:
2837     * @li @ref bg_01_example_page
2838     * @li @ref bg_02_example_page
2839     * @li @ref bg_03_example_page
2840     */
2841
2842    /* bg */
2843    typedef enum _Elm_Bg_Option
2844      {
2845         ELM_BG_OPTION_CENTER,  /**< center the background */
2846         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
2847         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2848         ELM_BG_OPTION_TILE     /**< tile background at its original size */
2849      } Elm_Bg_Option;
2850
2851    /**
2852     * Add a new background to the parent
2853     *
2854     * @param parent The parent object
2855     * @return The new object or NULL if it cannot be created
2856     *
2857     * @ingroup Bg
2858     */
2859    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2860
2861    /**
2862     * Set the file (image or edje) used for the background
2863     *
2864     * @param obj The bg object
2865     * @param file The file path
2866     * @param group Optional key (group in Edje) within the file
2867     *
2868     * This sets the image file used in the background object. The image (or edje)
2869     * will be stretched (retaining aspect if its an image file) to completely fill
2870     * the bg object. This may mean some parts are not visible.
2871     *
2872     * @note  Once the image of @p obj is set, a previously set one will be deleted,
2873     * even if @p file is NULL.
2874     *
2875     * @ingroup Bg
2876     */
2877    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2878
2879    /**
2880     * Get the file (image or edje) used for the background
2881     *
2882     * @param obj The bg object
2883     * @param file The file path
2884     * @param group Optional key (group in Edje) within the file
2885     *
2886     * @ingroup Bg
2887     */
2888    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2889
2890    /**
2891     * Set the option used for the background image
2892     *
2893     * @param obj The bg object
2894     * @param option The desired background option (TILE, SCALE)
2895     *
2896     * This sets the option used for manipulating the display of the background
2897     * image. The image can be tiled or scaled.
2898     *
2899     * @ingroup Bg
2900     */
2901    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2902
2903    /**
2904     * Get the option used for the background image
2905     *
2906     * @param obj The bg object
2907     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2908     *
2909     * @ingroup Bg
2910     */
2911    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2912    /**
2913     * Set the option used for the background color
2914     *
2915     * @param obj The bg object
2916     * @param r
2917     * @param g
2918     * @param b
2919     *
2920     * This sets the color used for the background rectangle. Its range goes
2921     * from 0 to 255.
2922     *
2923     * @ingroup Bg
2924     */
2925    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2926    /**
2927     * Get the option used for the background color
2928     *
2929     * @param obj The bg object
2930     * @param r
2931     * @param g
2932     * @param b
2933     *
2934     * @ingroup Bg
2935     */
2936    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2937
2938    /**
2939     * Set the overlay object used for the background object.
2940     *
2941     * @param obj The bg object
2942     * @param overlay The overlay object
2943     *
2944     * This provides a way for elm_bg to have an 'overlay' that will be on top
2945     * of the bg. Once the over object is set, a previously set one will be
2946     * deleted, even if you set the new one to NULL. If you want to keep that
2947     * old content object, use the elm_bg_overlay_unset() function.
2948     *
2949     * @ingroup Bg
2950     */
2951
2952    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2953
2954    /**
2955     * Get the overlay object used for the background object.
2956     *
2957     * @param obj The bg object
2958     * @return The content that is being used
2959     *
2960     * Return the content object which is set for this widget
2961     *
2962     * @ingroup Bg
2963     */
2964    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2965
2966    /**
2967     * Get the overlay object used for the background object.
2968     *
2969     * @param obj The bg object
2970     * @return The content that was being used
2971     *
2972     * Unparent and return the overlay object which was set for this widget
2973     *
2974     * @ingroup Bg
2975     */
2976    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2977
2978    /**
2979     * Set the size of the pixmap representation of the image.
2980     *
2981     * This option just makes sense if an image is going to be set in the bg.
2982     *
2983     * @param obj The bg object
2984     * @param w The new width of the image pixmap representation.
2985     * @param h The new height of the image pixmap representation.
2986     *
2987     * This function sets a new size for pixmap representation of the given bg
2988     * image. It allows the image to be loaded already in the specified size,
2989     * reducing the memory usage and load time when loading a big image with load
2990     * size set to a smaller size.
2991     *
2992     * NOTE: this is just a hint, the real size of the pixmap may differ
2993     * depending on the type of image being loaded, being bigger than requested.
2994     *
2995     * @ingroup Bg
2996     */
2997    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2998    /* smart callbacks called:
2999     */
3000
3001    /**
3002     * @defgroup Icon Icon
3003     *
3004     * @image html img/widget/icon/preview-00.png
3005     * @image latex img/widget/icon/preview-00.eps
3006     *
3007     * An object that provides standard icon images (delete, edit, arrows, etc.)
3008     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
3009     *
3010     * The icon image requested can be in the elementary theme, or in the
3011     * freedesktop.org paths. It's possible to set the order of preference from
3012     * where the image will be used.
3013     *
3014     * This API is very similar to @ref Image, but with ready to use images.
3015     *
3016     * Default images provided by the theme are described below.
3017     *
3018     * The first list contains icons that were first intended to be used in
3019     * toolbars, but can be used in many other places too:
3020     * @li home
3021     * @li close
3022     * @li apps
3023     * @li arrow_up
3024     * @li arrow_down
3025     * @li arrow_left
3026     * @li arrow_right
3027     * @li chat
3028     * @li clock
3029     * @li delete
3030     * @li edit
3031     * @li refresh
3032     * @li folder
3033     * @li file
3034     *
3035     * Now some icons that were designed to be used in menus (but again, you can
3036     * use them anywhere else):
3037     * @li menu/home
3038     * @li menu/close
3039     * @li menu/apps
3040     * @li menu/arrow_up
3041     * @li menu/arrow_down
3042     * @li menu/arrow_left
3043     * @li menu/arrow_right
3044     * @li menu/chat
3045     * @li menu/clock
3046     * @li menu/delete
3047     * @li menu/edit
3048     * @li menu/refresh
3049     * @li menu/folder
3050     * @li menu/file
3051     *
3052     * And here we have some media player specific icons:
3053     * @li media_player/forward
3054     * @li media_player/info
3055     * @li media_player/next
3056     * @li media_player/pause
3057     * @li media_player/play
3058     * @li media_player/prev
3059     * @li media_player/rewind
3060     * @li media_player/stop
3061     *
3062     * Signals that you can add callbacks for are:
3063     *
3064     * "clicked" - This is called when a user has clicked the icon
3065     *
3066     * An example of usage for this API follows:
3067     * @li @ref tutorial_icon
3068     */
3069
3070    /**
3071     * @addtogroup Icon
3072     * @{
3073     */
3074
3075    typedef enum _Elm_Icon_Type
3076      {
3077         ELM_ICON_NONE,
3078         ELM_ICON_FILE,
3079         ELM_ICON_STANDARD
3080      } Elm_Icon_Type;
3081    /**
3082     * @enum _Elm_Icon_Lookup_Order
3083     * @typedef Elm_Icon_Lookup_Order
3084     *
3085     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
3086     * theme, FDO paths, or both?
3087     *
3088     * @ingroup Icon
3089     */
3090    typedef enum _Elm_Icon_Lookup_Order
3091      {
3092         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
3093         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
3094         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
3095         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
3096      } Elm_Icon_Lookup_Order;
3097
3098    /**
3099     * Add a new icon object to the parent.
3100     *
3101     * @param parent The parent object
3102     * @return The new object or NULL if it cannot be created
3103     *
3104     * @see elm_icon_file_set()
3105     *
3106     * @ingroup Icon
3107     */
3108    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3109    /**
3110     * Set the file that will be used as icon.
3111     *
3112     * @param obj The icon object
3113     * @param file The path to file that will be used as icon image
3114     * @param group The group that the icon belongs to in edje file
3115     *
3116     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3117     *
3118     * @note The icon image set by this function can be changed by
3119     * elm_icon_standard_set().
3120     *
3121     * @see elm_icon_file_get()
3122     *
3123     * @ingroup Icon
3124     */
3125    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3126    /**
3127     * Set a location in memory to be used as an icon
3128     *
3129     * @param obj The icon object
3130     * @param img The binary data that will be used as an image
3131     * @param size The size of binary data @p img
3132     * @param format Optional format of @p img to pass to the image loader
3133     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
3134     *
3135     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3136     *
3137     * @note The icon image set by this function can be changed by
3138     * elm_icon_standard_set().
3139     *
3140     * @ingroup Icon
3141     */
3142    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);
3143    /**
3144     * Get the file that will be used as icon.
3145     *
3146     * @param obj The icon object
3147     * @param file The path to file that will be used as icon icon image
3148     * @param group The group that the icon belongs to in edje file
3149     *
3150     * @see elm_icon_file_set()
3151     *
3152     * @ingroup Icon
3153     */
3154    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3155    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3156    /**
3157     * Set the icon by icon standards names.
3158     *
3159     * @param obj The icon object
3160     * @param name The icon name
3161     *
3162     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3163     *
3164     * For example, freedesktop.org defines standard icon names such as "home",
3165     * "network", etc. There can be different icon sets to match those icon
3166     * keys. The @p name given as parameter is one of these "keys", and will be
3167     * used to look in the freedesktop.org paths and elementary theme. One can
3168     * change the lookup order with elm_icon_order_lookup_set().
3169     *
3170     * If name is not found in any of the expected locations and it is the
3171     * absolute path of an image file, this image will be used.
3172     *
3173     * @note The icon image set by this function can be changed by
3174     * elm_icon_file_set().
3175     *
3176     * @see elm_icon_standard_get()
3177     * @see elm_icon_file_set()
3178     *
3179     * @ingroup Icon
3180     */
3181    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
3182    /**
3183     * Get the icon name set by icon standard names.
3184     *
3185     * @param obj The icon object
3186     * @return The icon name
3187     *
3188     * If the icon image was set using elm_icon_file_set() instead of
3189     * elm_icon_standard_set(), then this function will return @c NULL.
3190     *
3191     * @see elm_icon_standard_set()
3192     *
3193     * @ingroup Icon
3194     */
3195    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3196    /**
3197     * Set the smooth effect for an icon object.
3198     *
3199     * @param obj The icon object
3200     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3201     * otherwise. Default is @c EINA_TRUE.
3202     *
3203     * Set the scaling algorithm to be used when scaling the icon image. Smooth
3204     * scaling provides a better resulting image, but is slower.
3205     *
3206     * The smooth scaling should be disabled when making animations that change
3207     * the icon size, since they will be faster. Animations that don't require
3208     * resizing of the icon can keep the smooth scaling enabled (even if the icon
3209     * is already scaled, since the scaled icon image will be cached).
3210     *
3211     * @see elm_icon_smooth_get()
3212     *
3213     * @ingroup Icon
3214     */
3215    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3216    /**
3217     * Get the smooth effect for an icon object.
3218     *
3219     * @param obj The icon object
3220     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3221     *
3222     * @see elm_icon_smooth_set()
3223     *
3224     * @ingroup Icon
3225     */
3226    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3227    /**
3228     * Disable scaling of this object.
3229     *
3230     * @param obj The icon object.
3231     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3232     * otherwise. Default is @c EINA_FALSE.
3233     *
3234     * This function disables scaling of the icon object through the function
3235     * elm_object_scale_set(). However, this does not affect the object
3236     * size/resize in any way. For that effect, take a look at
3237     * elm_icon_scale_set().
3238     *
3239     * @see elm_icon_no_scale_get()
3240     * @see elm_icon_scale_set()
3241     * @see elm_object_scale_set()
3242     *
3243     * @ingroup Icon
3244     */
3245    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3246    /**
3247     * Get whether scaling is disabled on the object.
3248     *
3249     * @param obj The icon object
3250     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3251     *
3252     * @see elm_icon_no_scale_set()
3253     *
3254     * @ingroup Icon
3255     */
3256    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3257    /**
3258     * Set if the object is (up/down) resizeable.
3259     *
3260     * @param obj The icon object
3261     * @param scale_up A bool to set if the object is resizeable up. Default is
3262     * @c EINA_TRUE.
3263     * @param scale_down A bool to set if the object is resizeable down. Default
3264     * is @c EINA_TRUE.
3265     *
3266     * This function limits the icon object resize ability. If @p scale_up is set to
3267     * @c EINA_FALSE, the object can't have its height or width resized to a value
3268     * higher than the original icon size. Same is valid for @p scale_down.
3269     *
3270     * @see elm_icon_scale_get()
3271     *
3272     * @ingroup Icon
3273     */
3274    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3275    /**
3276     * Get if the object is (up/down) resizeable.
3277     *
3278     * @param obj The icon object
3279     * @param scale_up A bool to set if the object is resizeable up
3280     * @param scale_down A bool to set if the object is resizeable down
3281     *
3282     * @see elm_icon_scale_set()
3283     *
3284     * @ingroup Icon
3285     */
3286    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3287    /**
3288     * Get the object's image size
3289     *
3290     * @param obj The icon object
3291     * @param w A pointer to store the width in
3292     * @param h A pointer to store the height in
3293     *
3294     * @ingroup Icon
3295     */
3296    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3297    /**
3298     * Set if the icon fill the entire object area.
3299     *
3300     * @param obj The icon object
3301     * @param fill_outside @c EINA_TRUE if the object is filled outside,
3302     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3303     *
3304     * When the icon object is resized to a different aspect ratio from the
3305     * original icon image, the icon image will still keep its aspect. This flag
3306     * tells how the image should fill the object's area. They are: keep the
3307     * entire icon inside the limits of height and width of the object (@p
3308     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3309     * of the object, and the icon will fill the entire object (@p fill_outside
3310     * is @c EINA_TRUE).
3311     *
3312     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3313     * retain property to false. Thus, the icon image will always keep its
3314     * original aspect ratio.
3315     *
3316     * @see elm_icon_fill_outside_get()
3317     * @see elm_image_fill_outside_set()
3318     *
3319     * @ingroup Icon
3320     */
3321    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3322    /**
3323     * Get if the object is filled outside.
3324     *
3325     * @param obj The icon object
3326     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3327     *
3328     * @see elm_icon_fill_outside_set()
3329     *
3330     * @ingroup Icon
3331     */
3332    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3333    /**
3334     * Set the prescale size for the icon.
3335     *
3336     * @param obj The icon object
3337     * @param size The prescale size. This value is used for both width and
3338     * height.
3339     *
3340     * This function sets a new size for pixmap representation of the given
3341     * icon. It allows the icon to be loaded already in the specified size,
3342     * reducing the memory usage and load time when loading a big icon with load
3343     * size set to a smaller size.
3344     *
3345     * It's equivalent to the elm_bg_load_size_set() function for bg.
3346     *
3347     * @note this is just a hint, the real size of the pixmap may differ
3348     * depending on the type of icon being loaded, being bigger than requested.
3349     *
3350     * @see elm_icon_prescale_get()
3351     * @see elm_bg_load_size_set()
3352     *
3353     * @ingroup Icon
3354     */
3355    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3356    /**
3357     * Get the prescale size for the icon.
3358     *
3359     * @param obj The icon object
3360     * @return The prescale size
3361     *
3362     * @see elm_icon_prescale_set()
3363     *
3364     * @ingroup Icon
3365     */
3366    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3367    /**
3368     * Sets the icon lookup order used by elm_icon_standard_set().
3369     *
3370     * @param obj The icon object
3371     * @param order The icon lookup order (can be one of
3372     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3373     * or ELM_ICON_LOOKUP_THEME)
3374     *
3375     * @see elm_icon_order_lookup_get()
3376     * @see Elm_Icon_Lookup_Order
3377     *
3378     * @ingroup Icon
3379     */
3380    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3381    /**
3382     * Gets the icon lookup order.
3383     *
3384     * @param obj The icon object
3385     * @return The icon lookup order
3386     *
3387     * @see elm_icon_order_lookup_set()
3388     * @see Elm_Icon_Lookup_Order
3389     *
3390     * @ingroup Icon
3391     */
3392    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3393
3394    /**
3395     * @}
3396     */
3397
3398    /**
3399     * @defgroup Image Image
3400     *
3401     * @image html img/widget/image/preview-00.png
3402     * @image latex img/widget/image/preview-00.eps
3403     *
3404     * An object that allows one to load an image file to it. It can be used
3405     * anywhere like any other elementary widget.
3406     *
3407     * This widget provides most of the functionality provided from @ref Bg or @ref
3408     * Icon, but with a slightly different API (use the one that fits better your
3409     * needs).
3410     *
3411     * The features not provided by those two other image widgets are:
3412     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3413     * @li change the object orientation with elm_image_orient_set();
3414     * @li and turning the image editable with elm_image_editable_set().
3415     *
3416     * Signals that you can add callbacks for are:
3417     *
3418     * @li @c "clicked" - This is called when a user has clicked the image
3419     *
3420     * An example of usage for this API follows:
3421     * @li @ref tutorial_image
3422     */
3423
3424    /**
3425     * @addtogroup Image
3426     * @{
3427     */
3428
3429    /**
3430     * @enum _Elm_Image_Orient
3431     * @typedef Elm_Image_Orient
3432     *
3433     * Possible orientation options for elm_image_orient_set().
3434     *
3435     * @image html elm_image_orient_set.png
3436     * @image latex elm_image_orient_set.eps width=\textwidth
3437     *
3438     * @ingroup Image
3439     */
3440    typedef enum _Elm_Image_Orient
3441      {
3442         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3443         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3444         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3445         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3446         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3447         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3448         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3449         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3450      } Elm_Image_Orient;
3451
3452    /**
3453     * Add a new image to the parent.
3454     *
3455     * @param parent The parent object
3456     * @return The new object or NULL if it cannot be created
3457     *
3458     * @see elm_image_file_set()
3459     *
3460     * @ingroup Image
3461     */
3462    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3463    /**
3464     * Set the file that will be used as image.
3465     *
3466     * @param obj The image object
3467     * @param file The path to file that will be used as image
3468     * @param group The group that the image belongs in edje file (if it's an
3469     * edje image)
3470     *
3471     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3472     *
3473     * @see elm_image_file_get()
3474     *
3475     * @ingroup Image
3476     */
3477    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3478    /**
3479     * Get the file that will be used as image.
3480     *
3481     * @param obj The image object
3482     * @param file The path to file
3483     * @param group The group that the image belongs in edje file
3484     *
3485     * @see elm_image_file_set()
3486     *
3487     * @ingroup Image
3488     */
3489    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3490    /**
3491     * Set the smooth effect for an image.
3492     *
3493     * @param obj The image object
3494     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3495     * otherwise. Default is @c EINA_TRUE.
3496     *
3497     * Set the scaling algorithm to be used when scaling the image. Smooth
3498     * scaling provides a better resulting image, but is slower.
3499     *
3500     * The smooth scaling should be disabled when making animations that change
3501     * the image size, since it will be faster. Animations that don't require
3502     * resizing of the image can keep the smooth scaling enabled (even if the
3503     * image is already scaled, since the scaled image will be cached).
3504     *
3505     * @see elm_image_smooth_get()
3506     *
3507     * @ingroup Image
3508     */
3509    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3510    /**
3511     * Get the smooth effect for an image.
3512     *
3513     * @param obj The image object
3514     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3515     *
3516     * @see elm_image_smooth_get()
3517     *
3518     * @ingroup Image
3519     */
3520    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3521    /**
3522     * Gets the current size of the image.
3523     *
3524     * @param obj The image object.
3525     * @param w Pointer to store width, or NULL.
3526     * @param h Pointer to store height, or NULL.
3527     *
3528     * This is the real size of the image, not the size of the object.
3529     *
3530     * On error, neither w or h will be written.
3531     *
3532     * @ingroup Image
3533     */
3534    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3535    /**
3536     * Disable scaling of this object.
3537     *
3538     * @param obj The image object.
3539     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3540     * otherwise. Default is @c EINA_FALSE.
3541     *
3542     * This function disables scaling of the elm_image widget through the
3543     * function elm_object_scale_set(). However, this does not affect the widget
3544     * size/resize in any way. For that effect, take a look at
3545     * elm_image_scale_set().
3546     *
3547     * @see elm_image_no_scale_get()
3548     * @see elm_image_scale_set()
3549     * @see elm_object_scale_set()
3550     *
3551     * @ingroup Image
3552     */
3553    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3554    /**
3555     * Get whether scaling is disabled on the object.
3556     *
3557     * @param obj The image object
3558     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3559     *
3560     * @see elm_image_no_scale_set()
3561     *
3562     * @ingroup Image
3563     */
3564    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3565    /**
3566     * Set if the object is (up/down) resizeable.
3567     *
3568     * @param obj The image object
3569     * @param scale_up A bool to set if the object is resizeable up. Default is
3570     * @c EINA_TRUE.
3571     * @param scale_down A bool to set if the object is resizeable down. Default
3572     * is @c EINA_TRUE.
3573     *
3574     * This function limits the image resize ability. If @p scale_up is set to
3575     * @c EINA_FALSE, the object can't have its height or width resized to a value
3576     * higher than the original image size. Same is valid for @p scale_down.
3577     *
3578     * @see elm_image_scale_get()
3579     *
3580     * @ingroup Image
3581     */
3582    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3583    /**
3584     * Get if the object is (up/down) resizeable.
3585     *
3586     * @param obj The image object
3587     * @param scale_up A bool to set if the object is resizeable up
3588     * @param scale_down A bool to set if the object is resizeable down
3589     *
3590     * @see elm_image_scale_set()
3591     *
3592     * @ingroup Image
3593     */
3594    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3595    /**
3596     * Set if the image fill the entire object area when keeping the aspect ratio.
3597     *
3598     * @param obj The image object
3599     * @param fill_outside @c EINA_TRUE if the object is filled outside,
3600     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3601     *
3602     * When the image should keep its aspect ratio even if resized to another
3603     * aspect ratio, there are two possibilities to resize it: keep the entire
3604     * image inside the limits of height and width of the object (@p fill_outside
3605     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3606     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3607     *
3608     * @note This option will have no effect if
3609     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3610     *
3611     * @see elm_image_fill_outside_get()
3612     * @see elm_image_aspect_ratio_retained_set()
3613     *
3614     * @ingroup Image
3615     */
3616    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3617    /**
3618     * Get if the object is filled outside
3619     *
3620     * @param obj The image object
3621     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3622     *
3623     * @see elm_image_fill_outside_set()
3624     *
3625     * @ingroup Image
3626     */
3627    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3628    /**
3629     * Set the prescale size for the image
3630     *
3631     * @param obj The image object
3632     * @param size The prescale size. This value is used for both width and
3633     * height.
3634     *
3635     * This function sets a new size for pixmap representation of the given
3636     * image. It allows the image to be loaded already in the specified size,
3637     * reducing the memory usage and load time when loading a big image with load
3638     * size set to a smaller size.
3639     *
3640     * It's equivalent to the elm_bg_load_size_set() function for bg.
3641     *
3642     * @note this is just a hint, the real size of the pixmap may differ
3643     * depending on the type of image being loaded, being bigger than requested.
3644     *
3645     * @see elm_image_prescale_get()
3646     * @see elm_bg_load_size_set()
3647     *
3648     * @ingroup Image
3649     */
3650    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3651    /**
3652     * Get the prescale size for the image
3653     *
3654     * @param obj The image object
3655     * @return The prescale size
3656     *
3657     * @see elm_image_prescale_set()
3658     *
3659     * @ingroup Image
3660     */
3661    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3662    /**
3663     * Set the image orientation.
3664     *
3665     * @param obj The image object
3666     * @param orient The image orientation
3667     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3668     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3669     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3670     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3671     *  Default is #ELM_IMAGE_ORIENT_NONE.
3672     *
3673     * This function allows to rotate or flip the given image.
3674     *
3675     * @see elm_image_orient_get()
3676     * @see @ref Elm_Image_Orient
3677     *
3678     * @ingroup Image
3679     */
3680    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3681    /**
3682     * Get the image orientation.
3683     *
3684     * @param obj The image object
3685     * @return The image orientation
3686     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3687     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3688     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3689     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3690     *
3691     * @see elm_image_orient_set()
3692     * @see @ref Elm_Image_Orient
3693     *
3694     * @ingroup Image
3695     */
3696    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3697    /**
3698     * Make the image 'editable'.
3699     *
3700     * @param obj Image object.
3701     * @param set Turn on or off editability. Default is @c EINA_FALSE.
3702     *
3703     * This means the image is a valid drag target for drag and drop, and can be
3704     * cut or pasted too.
3705     *
3706     * @ingroup Image
3707     */
3708    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3709    /**
3710     * Make the image 'editable'.
3711     *
3712     * @param obj Image object.
3713     * @return Editability.
3714     *
3715     * This means the image is a valid drag target for drag and drop, and can be
3716     * cut or pasted too.
3717     *
3718     * @ingroup Image
3719     */
3720    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3721    /**
3722     * Get the basic Evas_Image object from this object (widget).
3723     *
3724     * @param obj The image object to get the inlined image from
3725     * @return The inlined image object, or NULL if none exists
3726     *
3727     * This function allows one to get the underlying @c Evas_Object of type
3728     * Image from this elementary widget. It can be useful to do things like get
3729     * the pixel data, save the image to a file, etc.
3730     *
3731     * @note Be careful to not manipulate it, as it is under control of
3732     * elementary.
3733     *
3734     * @ingroup Image
3735     */
3736    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3737    /**
3738     * Set whether the original aspect ratio of the image should be kept on resize.
3739     *
3740     * @param obj The image object.
3741     * @param retained @c EINA_TRUE if the image should retain the aspect,
3742     * @c EINA_FALSE otherwise.
3743     *
3744     * The original aspect ratio (width / height) of the image is usually
3745     * distorted to match the object's size. Enabling this option will retain
3746     * this original aspect, and the way that the image is fit into the object's
3747     * area depends on the option set by elm_image_fill_outside_set().
3748     *
3749     * @see elm_image_aspect_ratio_retained_get()
3750     * @see elm_image_fill_outside_set()
3751     *
3752     * @ingroup Image
3753     */
3754    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3755    /**
3756     * Get if the object retains the original aspect ratio.
3757     *
3758     * @param obj The image object.
3759     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3760     * otherwise.
3761     *
3762     * @ingroup Image
3763     */
3764    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3765
3766    /* smart callbacks called:
3767     * "clicked" - the user clicked the image
3768     */
3769
3770    /**
3771     * @}
3772     */
3773
3774    /* glview */
3775    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3776
3777    typedef enum _Elm_GLView_Mode
3778      {
3779         ELM_GLVIEW_ALPHA   = 1,
3780         ELM_GLVIEW_DEPTH   = 2,
3781         ELM_GLVIEW_STENCIL = 4
3782      } Elm_GLView_Mode;
3783
3784    /**
3785     * Defines a policy for the glview resizing.
3786     *
3787     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3788     */
3789    typedef enum _Elm_GLView_Resize_Policy
3790      {
3791         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
3792         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
3793      } Elm_GLView_Resize_Policy;
3794
3795    typedef enum _Elm_GLView_Render_Policy
3796      {
3797         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
3798         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
3799      } Elm_GLView_Render_Policy;
3800
3801
3802    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3803    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3804    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3805    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3806    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3807    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3808    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3809    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3810    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3811    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3812    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3813    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3814
3815    /* box */
3816    /**
3817     * @defgroup Box Box
3818     *
3819     * @image html img/widget/box/preview-00.png
3820     * @image latex img/widget/box/preview-00.eps width=\textwidth
3821     *
3822     * @image html img/box.png
3823     * @image latex img/box.eps width=\textwidth
3824     *
3825     * A box arranges objects in a linear fashion, governed by a layout function
3826     * that defines the details of this arrangement.
3827     *
3828     * By default, the box will use an internal function to set the layout to
3829     * a single row, either vertical or horizontal. This layout is affected
3830     * by a number of parameters, such as the homogeneous flag set by
3831     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3832     * elm_box_align_set() and the hints set to each object in the box.
3833     *
3834     * For this default layout, it's possible to change the orientation with
3835     * elm_box_horizontal_set(). The box will start in the vertical orientation,
3836     * placing its elements ordered from top to bottom. When horizontal is set,
3837     * the order will go from left to right. If the box is set to be
3838     * homogeneous, every object in it will be assigned the same space, that
3839     * of the largest object. Padding can be used to set some spacing between
3840     * the cell given to each object. The alignment of the box, set with
3841     * elm_box_align_set(), determines how the bounding box of all the elements
3842     * will be placed within the space given to the box widget itself.
3843     *
3844     * The size hints of each object also affect how they are placed and sized
3845     * within the box. evas_object_size_hint_min_set() will give the minimum
3846     * size the object can have, and the box will use it as the basis for all
3847     * latter calculations. Elementary widgets set their own minimum size as
3848     * needed, so there's rarely any need to use it manually.
3849     *
3850     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3851     * used to tell whether the object will be allocated the minimum size it
3852     * needs or if the space given to it should be expanded. It's important
3853     * to realize that expanding the size given to the object is not the same
3854     * thing as resizing the object. It could very well end being a small
3855     * widget floating in a much larger empty space. If not set, the weight
3856     * for objects will normally be 0.0 for both axis, meaning the widget will
3857     * not be expanded. To take as much space possible, set the weight to
3858     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3859     *
3860     * Besides how much space each object is allocated, it's possible to control
3861     * how the widget will be placed within that space using
3862     * evas_object_size_hint_align_set(). By default, this value will be 0.5
3863     * for both axis, meaning the object will be centered, but any value from
3864     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3865     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3866     * is -1.0, means the object will be resized to fill the entire space it
3867     * was allocated.
3868     *
3869     * In addition, customized functions to define the layout can be set, which
3870     * allow the application developer to organize the objects within the box
3871     * in any number of ways.
3872     *
3873     * The special elm_box_layout_transition() function can be used
3874     * to switch from one layout to another, animating the motion of the
3875     * children of the box.
3876     *
3877     * @note Objects should not be added to box objects using _add() calls.
3878     *
3879     * Some examples on how to use boxes follow:
3880     * @li @ref box_example_01
3881     * @li @ref box_example_02
3882     *
3883     * @{
3884     */
3885    /**
3886     * @typedef Elm_Box_Transition
3887     *
3888     * Opaque handler containing the parameters to perform an animated
3889     * transition of the layout the box uses.
3890     *
3891     * @see elm_box_transition_new()
3892     * @see elm_box_layout_set()
3893     * @see elm_box_layout_transition()
3894     */
3895    typedef struct _Elm_Box_Transition Elm_Box_Transition;
3896
3897    /**
3898     * Add a new box to the parent
3899     *
3900     * By default, the box will be in vertical mode and non-homogeneous.
3901     *
3902     * @param parent The parent object
3903     * @return The new object or NULL if it cannot be created
3904     */
3905    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3906    /**
3907     * Set the horizontal orientation
3908     *
3909     * By default, box object arranges their contents vertically from top to
3910     * bottom.
3911     * By calling this function with @p horizontal as EINA_TRUE, the box will
3912     * become horizontal, arranging contents from left to right.
3913     *
3914     * @note This flag is ignored if a custom layout function is set.
3915     *
3916     * @param obj The box object
3917     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3918     * EINA_FALSE = vertical)
3919     */
3920    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3921    /**
3922     * Get the horizontal orientation
3923     *
3924     * @param obj The box object
3925     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3926     */
3927    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3928    /**
3929     * Set the box to arrange its children homogeneously
3930     *
3931     * If enabled, homogeneous layout makes all items the same size, according
3932     * to the size of the largest of its children.
3933     *
3934     * @note This flag is ignored if a custom layout function is set.
3935     *
3936     * @param obj The box object
3937     * @param homogeneous The homogeneous flag
3938     */
3939    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3940    /**
3941     * Get whether the box is using homogeneous mode or not
3942     *
3943     * @param obj The box object
3944     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3945     */
3946    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3947    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3948    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3949    /**
3950     * Add an object to the beginning of the pack list
3951     *
3952     * Pack @p subobj into the box @p obj, placing it first in the list of
3953     * children objects. The actual position the object will get on screen
3954     * depends on the layout used. If no custom layout is set, it will be at
3955     * the top or left, depending if the box is vertical or horizontal,
3956     * respectively.
3957     *
3958     * @param obj The box object
3959     * @param subobj The object to add to the box
3960     *
3961     * @see elm_box_pack_end()
3962     * @see elm_box_pack_before()
3963     * @see elm_box_pack_after()
3964     * @see elm_box_unpack()
3965     * @see elm_box_unpack_all()
3966     * @see elm_box_clear()
3967     */
3968    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3969    /**
3970     * Add an object at the end of the pack list
3971     *
3972     * Pack @p subobj into the box @p obj, placing it last in the list of
3973     * children objects. The actual position the object will get on screen
3974     * depends on the layout used. If no custom layout is set, it will be at
3975     * the bottom or right, depending if the box is vertical or horizontal,
3976     * respectively.
3977     *
3978     * @param obj The box object
3979     * @param subobj The object to add to the box
3980     *
3981     * @see elm_box_pack_start()
3982     * @see elm_box_pack_before()
3983     * @see elm_box_pack_after()
3984     * @see elm_box_unpack()
3985     * @see elm_box_unpack_all()
3986     * @see elm_box_clear()
3987     */
3988    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3989    /**
3990     * Adds an object to the box before the indicated object
3991     *
3992     * This will add the @p subobj to the box indicated before the object
3993     * indicated with @p before. If @p before is not already in the box, results
3994     * are undefined. Before means either to the left of the indicated object or
3995     * above it depending on orientation.
3996     *
3997     * @param obj The box object
3998     * @param subobj The object to add to the box
3999     * @param before The object before which to add it
4000     *
4001     * @see elm_box_pack_start()
4002     * @see elm_box_pack_end()
4003     * @see elm_box_pack_after()
4004     * @see elm_box_unpack()
4005     * @see elm_box_unpack_all()
4006     * @see elm_box_clear()
4007     */
4008    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
4009    /**
4010     * Adds an object to the box after the indicated object
4011     *
4012     * This will add the @p subobj to the box indicated after the object
4013     * indicated with @p after. If @p after is not already in the box, results
4014     * are undefined. After means either to the right of the indicated object or
4015     * below it depending on orientation.
4016     *
4017     * @param obj The box object
4018     * @param subobj The object to add to the box
4019     * @param after The object after which to add it
4020     *
4021     * @see elm_box_pack_start()
4022     * @see elm_box_pack_end()
4023     * @see elm_box_pack_before()
4024     * @see elm_box_unpack()
4025     * @see elm_box_unpack_all()
4026     * @see elm_box_clear()
4027     */
4028    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
4029    /**
4030     * Clear the box of all children
4031     *
4032     * Remove all the elements contained by the box, deleting the respective
4033     * objects.
4034     *
4035     * @param obj The box object
4036     *
4037     * @see elm_box_unpack()
4038     * @see elm_box_unpack_all()
4039     */
4040    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4041    /**
4042     * Unpack a box item
4043     *
4044     * Remove the object given by @p subobj from the box @p obj without
4045     * deleting it.
4046     *
4047     * @param obj The box object
4048     *
4049     * @see elm_box_unpack_all()
4050     * @see elm_box_clear()
4051     */
4052    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4053    /**
4054     * Remove all items from the box, without deleting them
4055     *
4056     * Clear the box from all children, but don't delete the respective objects.
4057     * If no other references of the box children exist, the objects will never
4058     * be deleted, and thus the application will leak the memory. Make sure
4059     * when using this function that you hold a reference to all the objects
4060     * in the box @p obj.
4061     *
4062     * @param obj The box object
4063     *
4064     * @see elm_box_clear()
4065     * @see elm_box_unpack()
4066     */
4067    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4068    /**
4069     * Retrieve a list of the objects packed into the box
4070     *
4071     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
4072     * The order of the list corresponds to the packing order the box uses.
4073     *
4074     * You must free this list with eina_list_free() once you are done with it.
4075     *
4076     * @param obj The box object
4077     */
4078    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4079    /**
4080     * Set the space (padding) between the box's elements.
4081     *
4082     * Extra space in pixels that will be added between a box child and its
4083     * neighbors after its containing cell has been calculated. This padding
4084     * is set for all elements in the box, besides any possible padding that
4085     * individual elements may have through their size hints.
4086     *
4087     * @param obj The box object
4088     * @param horizontal The horizontal space between elements
4089     * @param vertical The vertical space between elements
4090     */
4091    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
4092    /**
4093     * Get the space (padding) between the box's elements.
4094     *
4095     * @param obj The box object
4096     * @param horizontal The horizontal space between elements
4097     * @param vertical The vertical space between elements
4098     *
4099     * @see elm_box_padding_set()
4100     */
4101    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
4102    /**
4103     * Set the alignment of the whole bouding box of contents.
4104     *
4105     * Sets how the bounding box containing all the elements of the box, after
4106     * their sizes and position has been calculated, will be aligned within
4107     * the space given for the whole box widget.
4108     *
4109     * @param obj The box object
4110     * @param horizontal The horizontal alignment of elements
4111     * @param vertical The vertical alignment of elements
4112     */
4113    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
4114    /**
4115     * Get the alignment of the whole bouding box of contents.
4116     *
4117     * @param obj The box object
4118     * @param horizontal The horizontal alignment of elements
4119     * @param vertical The vertical alignment of elements
4120     *
4121     * @see elm_box_align_set()
4122     */
4123    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
4124
4125    /**
4126     * Set the layout defining function to be used by the box
4127     *
4128     * Whenever anything changes that requires the box in @p obj to recalculate
4129     * the size and position of its elements, the function @p cb will be called
4130     * to determine what the layout of the children will be.
4131     *
4132     * Once a custom function is set, everything about the children layout
4133     * is defined by it. The flags set by elm_box_horizontal_set() and
4134     * elm_box_homogeneous_set() no longer have any meaning, and the values
4135     * given by elm_box_padding_set() and elm_box_align_set() are up to this
4136     * layout function to decide if they are used and how. These last two
4137     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
4138     * passed to @p cb. The @c Evas_Object the function receives is not the
4139     * Elementary widget, but the internal Evas Box it uses, so none of the
4140     * functions described here can be used on it.
4141     *
4142     * Any of the layout functions in @c Evas can be used here, as well as the
4143     * special elm_box_layout_transition().
4144     *
4145     * The final @p data argument received by @p cb is the same @p data passed
4146     * here, and the @p free_data function will be called to free it
4147     * whenever the box is destroyed or another layout function is set.
4148     *
4149     * Setting @p cb to NULL will revert back to the default layout function.
4150     *
4151     * @param obj The box object
4152     * @param cb The callback function used for layout
4153     * @param data Data that will be passed to layout function
4154     * @param free_data Function called to free @p data
4155     *
4156     * @see elm_box_layout_transition()
4157     */
4158    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);
4159    /**
4160     * Special layout function that animates the transition from one layout to another
4161     *
4162     * Normally, when switching the layout function for a box, this will be
4163     * reflected immediately on screen on the next render, but it's also
4164     * possible to do this through an animated transition.
4165     *
4166     * This is done by creating an ::Elm_Box_Transition and setting the box
4167     * layout to this function.
4168     *
4169     * For example:
4170     * @code
4171     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
4172     *                            evas_object_box_layout_vertical, // start
4173     *                            NULL, // data for initial layout
4174     *                            NULL, // free function for initial data
4175     *                            evas_object_box_layout_horizontal, // end
4176     *                            NULL, // data for final layout
4177     *                            NULL, // free function for final data
4178     *                            anim_end, // will be called when animation ends
4179     *                            NULL); // data for anim_end function\
4180     * elm_box_layout_set(box, elm_box_layout_transition, t,
4181     *                    elm_box_transition_free);
4182     * @endcode
4183     *
4184     * @note This function can only be used with elm_box_layout_set(). Calling
4185     * it directly will not have the expected results.
4186     *
4187     * @see elm_box_transition_new
4188     * @see elm_box_transition_free
4189     * @see elm_box_layout_set
4190     */
4191    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
4192    /**
4193     * Create a new ::Elm_Box_Transition to animate the switch of layouts
4194     *
4195     * If you want to animate the change from one layout to another, you need
4196     * to set the layout function of the box to elm_box_layout_transition(),
4197     * passing as user data to it an instance of ::Elm_Box_Transition with the
4198     * necessary information to perform this animation. The free function to
4199     * set for the layout is elm_box_transition_free().
4200     *
4201     * The parameters to create an ::Elm_Box_Transition sum up to how long
4202     * will it be, in seconds, a layout function to describe the initial point,
4203     * another for the final position of the children and one function to be
4204     * called when the whole animation ends. This last function is useful to
4205     * set the definitive layout for the box, usually the same as the end
4206     * layout for the animation, but could be used to start another transition.
4207     *
4208     * @param start_layout The layout function that will be used to start the animation
4209     * @param start_layout_data The data to be passed the @p start_layout function
4210     * @param start_layout_free_data Function to free @p start_layout_data
4211     * @param end_layout The layout function that will be used to end the animation
4212     * @param end_layout_free_data The data to be passed the @p end_layout function
4213     * @param end_layout_free_data Function to free @p end_layout_data
4214     * @param transition_end_cb Callback function called when animation ends
4215     * @param transition_end_data Data to be passed to @p transition_end_cb
4216     * @return An instance of ::Elm_Box_Transition
4217     *
4218     * @see elm_box_transition_new
4219     * @see elm_box_layout_transition
4220     */
4221    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);
4222    /**
4223     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
4224     *
4225     * This function is mostly useful as the @c free_data parameter in
4226     * elm_box_layout_set() when elm_box_layout_transition().
4227     *
4228     * @param data The Elm_Box_Transition instance to be freed.
4229     *
4230     * @see elm_box_transition_new
4231     * @see elm_box_layout_transition
4232     */
4233    EAPI void                elm_box_transition_free(void *data);
4234    /**
4235     * @}
4236     */
4237
4238    /* button */
4239    /**
4240     * @defgroup Button Button
4241     *
4242     * @image html img/widget/button/preview-00.png
4243     * @image latex img/widget/button/preview-00.eps
4244     * @image html img/widget/button/preview-01.png
4245     * @image latex img/widget/button/preview-01.eps
4246     * @image html img/widget/button/preview-02.png
4247     * @image latex img/widget/button/preview-02.eps
4248     *
4249     * This is a push-button. Press it and run some function. It can contain
4250     * a simple label and icon object and it also has an autorepeat feature.
4251     *
4252     * This widgets emits the following signals:
4253     * @li "clicked": the user clicked the button (press/release).
4254     * @li "repeated": the user pressed the button without releasing it.
4255     * @li "pressed": button was pressed.
4256     * @li "unpressed": button was released after being pressed.
4257     * In all three cases, the @c event parameter of the callback will be
4258     * @c NULL.
4259     *
4260     * Also, defined in the default theme, the button has the following styles
4261     * available:
4262     * @li default: a normal button.
4263     * @li anchor: Like default, but the button fades away when the mouse is not
4264     * over it, leaving only the text or icon.
4265     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4266     * continuous look across its options.
4267     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4268     *
4269     * Follow through a complete example @ref button_example_01 "here".
4270     * @{
4271     */
4272    /**
4273     * Add a new button to the parent's canvas
4274     *
4275     * @param parent The parent object
4276     * @return The new object or NULL if it cannot be created
4277     */
4278    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4279    /**
4280     * Set the label used in the button
4281     *
4282     * The passed @p label can be NULL to clean any existing text in it and
4283     * leave the button as an icon only object.
4284     *
4285     * @param obj The button object
4286     * @param label The text will be written on the button
4287     * @deprecated use elm_object_text_set() instead.
4288     */
4289    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4290    /**
4291     * Get the label set for the button
4292     *
4293     * The string returned is an internal pointer and should not be freed or
4294     * altered. It will also become invalid when the button is destroyed.
4295     * The string returned, if not NULL, is a stringshare, so if you need to
4296     * keep it around even after the button is destroyed, you can use
4297     * eina_stringshare_ref().
4298     *
4299     * @param obj The button object
4300     * @return The text set to the label, or NULL if nothing is set
4301     * @deprecated use elm_object_text_set() instead.
4302     */
4303    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4304    /**
4305     * Set the icon used for the button
4306     *
4307     * Setting a new icon will delete any other that was previously set, making
4308     * any reference to them invalid. If you need to maintain the previous
4309     * object alive, unset it first with elm_button_icon_unset().
4310     *
4311     * @param obj The button object
4312     * @param icon The icon object for the button
4313     */
4314    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4315    /**
4316     * Get the icon used for the button
4317     *
4318     * Return the icon object which is set for this widget. If the button is
4319     * destroyed or another icon is set, the returned object will be deleted
4320     * and any reference to it will be invalid.
4321     *
4322     * @param obj The button object
4323     * @return The icon object that is being used
4324     *
4325     * @see elm_button_icon_unset()
4326     */
4327    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4328    /**
4329     * Remove the icon set without deleting it and return the object
4330     *
4331     * This function drops the reference the button holds of the icon object
4332     * and returns this last object. It is used in case you want to remove any
4333     * icon, or set another one, without deleting the actual object. The button
4334     * will be left without an icon set.
4335     *
4336     * @param obj The button object
4337     * @return The icon object that was being used
4338     */
4339    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4340    /**
4341     * Turn on/off the autorepeat event generated when the button is kept pressed
4342     *
4343     * When off, no autorepeat is performed and buttons emit a normal @c clicked
4344     * signal when they are clicked.
4345     *
4346     * When on, keeping a button pressed will continuously emit a @c repeated
4347     * signal until the button is released. The time it takes until it starts
4348     * emitting the signal is given by
4349     * elm_button_autorepeat_initial_timeout_set(), and the time between each
4350     * new emission by elm_button_autorepeat_gap_timeout_set().
4351     *
4352     * @param obj The button object
4353     * @param on  A bool to turn on/off the event
4354     */
4355    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4356    /**
4357     * Get whether the autorepeat feature is enabled
4358     *
4359     * @param obj The button object
4360     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4361     *
4362     * @see elm_button_autorepeat_set()
4363     */
4364    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4365    /**
4366     * Set the initial timeout before the autorepeat event is generated
4367     *
4368     * Sets the timeout, in seconds, since the button is pressed until the
4369     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4370     * won't be any delay and the even will be fired the moment the button is
4371     * pressed.
4372     *
4373     * @param obj The button object
4374     * @param t   Timeout in seconds
4375     *
4376     * @see elm_button_autorepeat_set()
4377     * @see elm_button_autorepeat_gap_timeout_set()
4378     */
4379    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4380    /**
4381     * Get the initial timeout before the autorepeat event is generated
4382     *
4383     * @param obj The button object
4384     * @return Timeout in seconds
4385     *
4386     * @see elm_button_autorepeat_initial_timeout_set()
4387     */
4388    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4389    /**
4390     * Set the interval between each generated autorepeat event
4391     *
4392     * After the first @c repeated event is fired, all subsequent ones will
4393     * follow after a delay of @p t seconds for each.
4394     *
4395     * @param obj The button object
4396     * @param t   Interval in seconds
4397     *
4398     * @see elm_button_autorepeat_initial_timeout_set()
4399     */
4400    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4401    /**
4402     * Get the interval between each generated autorepeat event
4403     *
4404     * @param obj The button object
4405     * @return Interval in seconds
4406     */
4407    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4408    /**
4409     * @}
4410     */
4411
4412    /**
4413     * @defgroup File_Selector_Button File Selector Button
4414     *
4415     * @image html img/widget/fileselector_button/preview-00.png
4416     * @image latex img/widget/fileselector_button/preview-00.eps
4417     * @image html img/widget/fileselector_button/preview-01.png
4418     * @image latex img/widget/fileselector_button/preview-01.eps
4419     * @image html img/widget/fileselector_button/preview-02.png
4420     * @image latex img/widget/fileselector_button/preview-02.eps
4421     *
4422     * This is a button that, when clicked, creates an Elementary
4423     * window (or inner window) <b> with a @ref Fileselector "file
4424     * selector widget" within</b>. When a file is chosen, the (inner)
4425     * window is closed and the button emits a signal having the
4426     * selected file as it's @c event_info.
4427     *
4428     * This widget encapsulates operations on its internal file
4429     * selector on its own API. There is less control over its file
4430     * selector than that one would have instatiating one directly.
4431     *
4432     * The following styles are available for this button:
4433     * @li @c "default"
4434     * @li @c "anchor"
4435     * @li @c "hoversel_vertical"
4436     * @li @c "hoversel_vertical_entry"
4437     *
4438     * Smart callbacks one can register to:
4439     * - @c "file,chosen" - the user has selected a path, whose string
4440     *   pointer comes as the @c event_info data (a stringshared
4441     *   string)
4442     *
4443     * Here is an example on its usage:
4444     * @li @ref fileselector_button_example
4445     *
4446     * @see @ref File_Selector_Entry for a similar widget.
4447     * @{
4448     */
4449
4450    /**
4451     * Add a new file selector button widget to the given parent
4452     * Elementary (container) object
4453     *
4454     * @param parent The parent object
4455     * @return a new file selector button widget handle or @c NULL, on
4456     * errors
4457     */
4458    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4459
4460    /**
4461     * Set the label for a given file selector button widget
4462     *
4463     * @param obj The file selector button widget
4464     * @param label The text label to be displayed on @p obj
4465     *
4466     * @deprecated use elm_object_text_set() instead.
4467     */
4468    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4469
4470    /**
4471     * Get the label set for a given file selector button widget
4472     *
4473     * @param obj The file selector button widget
4474     * @return The button label
4475     *
4476     * @deprecated use elm_object_text_set() instead.
4477     */
4478    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4479
4480    /**
4481     * Set the icon on a given file selector button widget
4482     *
4483     * @param obj The file selector button widget
4484     * @param icon The icon object for the button
4485     *
4486     * Once the icon object is set, a previously set one will be
4487     * deleted. If you want to keep the latter, use the
4488     * elm_fileselector_button_icon_unset() function.
4489     *
4490     * @see elm_fileselector_button_icon_get()
4491     */
4492    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4493
4494    /**
4495     * Get the icon set for a given file selector button widget
4496     *
4497     * @param obj The file selector button widget
4498     * @return The icon object currently set on @p obj or @c NULL, if
4499     * none is
4500     *
4501     * @see elm_fileselector_button_icon_set()
4502     */
4503    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4504
4505    /**
4506     * Unset the icon used in a given file selector button widget
4507     *
4508     * @param obj The file selector button widget
4509     * @return The icon object that was being used on @p obj or @c
4510     * NULL, on errors
4511     *
4512     * Unparent and return the icon object which was set for this
4513     * widget.
4514     *
4515     * @see elm_fileselector_button_icon_set()
4516     */
4517    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4518
4519    /**
4520     * Set the title for a given file selector button widget's window
4521     *
4522     * @param obj The file selector button widget
4523     * @param title The title string
4524     *
4525     * This will change the window's title, when the file selector pops
4526     * out after a click on the button. Those windows have the default
4527     * (unlocalized) value of @c "Select a file" as titles.
4528     *
4529     * @note It will only take any effect if the file selector
4530     * button widget is @b not under "inwin mode".
4531     *
4532     * @see elm_fileselector_button_window_title_get()
4533     */
4534    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4535
4536    /**
4537     * Get the title set for a given file selector button widget's
4538     * window
4539     *
4540     * @param obj The file selector button widget
4541     * @return Title of the file selector button's window
4542     *
4543     * @see elm_fileselector_button_window_title_get() for more details
4544     */
4545    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4546
4547    /**
4548     * Set the size of a given file selector button widget's window,
4549     * holding the file selector itself.
4550     *
4551     * @param obj The file selector button widget
4552     * @param width The window's width
4553     * @param height The window's height
4554     *
4555     * @note it will only take any effect if the file selector button
4556     * widget is @b not under "inwin mode". The default size for the
4557     * window (when applicable) is 400x400 pixels.
4558     *
4559     * @see elm_fileselector_button_window_size_get()
4560     */
4561    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4562
4563    /**
4564     * Get the size of a given file selector button widget's window,
4565     * holding the file selector itself.
4566     *
4567     * @param obj The file selector button widget
4568     * @param width Pointer into which to store the width value
4569     * @param height Pointer into which to store the height value
4570     *
4571     * @note Use @c NULL pointers on the size values you're not
4572     * interested in: they'll be ignored by the function.
4573     *
4574     * @see elm_fileselector_button_window_size_set(), for more details
4575     */
4576    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4577
4578    /**
4579     * Set the initial file system path for a given file selector
4580     * button widget
4581     *
4582     * @param obj The file selector button widget
4583     * @param path The path string
4584     *
4585     * It must be a <b>directory</b> path, which will have the contents
4586     * displayed initially in the file selector's view, when invoked
4587     * from @p obj. The default initial path is the @c "HOME"
4588     * environment variable's value.
4589     *
4590     * @see elm_fileselector_button_path_get()
4591     */
4592    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4593
4594    /**
4595     * Get the initial file system path set for a given file selector
4596     * button widget
4597     *
4598     * @param obj The file selector button widget
4599     * @return path The path string
4600     *
4601     * @see elm_fileselector_button_path_set() for more details
4602     */
4603    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4604
4605    /**
4606     * Enable/disable a tree view in the given file selector button
4607     * widget's internal file selector
4608     *
4609     * @param obj The file selector button widget
4610     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4611     * disable
4612     *
4613     * This has the same effect as elm_fileselector_expandable_set(),
4614     * but now applied to a file selector button's internal file
4615     * selector.
4616     *
4617     * @note There's no way to put a file selector button's internal
4618     * file selector in "grid mode", as one may do with "pure" file
4619     * selectors.
4620     *
4621     * @see elm_fileselector_expandable_get()
4622     */
4623    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4624
4625    /**
4626     * Get whether tree view is enabled for the given file selector
4627     * button widget's internal file selector
4628     *
4629     * @param obj The file selector button widget
4630     * @return @c EINA_TRUE if @p obj widget's internal file selector
4631     * is in tree view, @c EINA_FALSE otherwise (and or errors)
4632     *
4633     * @see elm_fileselector_expandable_set() for more details
4634     */
4635    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4636
4637    /**
4638     * Set whether a given file selector button widget's internal file
4639     * selector is to display folders only or the directory contents,
4640     * as well.
4641     *
4642     * @param obj The file selector button widget
4643     * @param only @c EINA_TRUE to make @p obj widget's internal file
4644     * selector only display directories, @c EINA_FALSE to make files
4645     * to be displayed in it too
4646     *
4647     * This has the same effect as elm_fileselector_folder_only_set(),
4648     * but now applied to a file selector button's internal file
4649     * selector.
4650     *
4651     * @see elm_fileselector_folder_only_get()
4652     */
4653    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4654
4655    /**
4656     * Get whether a given file selector button widget's internal file
4657     * selector is displaying folders only or the directory contents,
4658     * as well.
4659     *
4660     * @param obj The file selector button widget
4661     * @return @c EINA_TRUE if @p obj widget's internal file
4662     * selector is only displaying directories, @c EINA_FALSE if files
4663     * are being displayed in it too (and on errors)
4664     *
4665     * @see elm_fileselector_button_folder_only_set() for more details
4666     */
4667    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4668
4669    /**
4670     * Enable/disable the file name entry box where the user can type
4671     * in a name for a file, in a given file selector button widget's
4672     * internal file selector.
4673     *
4674     * @param obj The file selector button widget
4675     * @param is_save @c EINA_TRUE to make @p obj widget's internal
4676     * file selector a "saving dialog", @c EINA_FALSE otherwise
4677     *
4678     * This has the same effect as elm_fileselector_is_save_set(),
4679     * but now applied to a file selector button's internal file
4680     * selector.
4681     *
4682     * @see elm_fileselector_is_save_get()
4683     */
4684    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4685
4686    /**
4687     * Get whether the given file selector button widget's internal
4688     * file selector is in "saving dialog" mode
4689     *
4690     * @param obj The file selector button widget
4691     * @return @c EINA_TRUE, if @p obj widget's internal file selector
4692     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4693     * errors)
4694     *
4695     * @see elm_fileselector_button_is_save_set() for more details
4696     */
4697    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4698
4699    /**
4700     * Set whether a given file selector button widget's internal file
4701     * selector will raise an Elementary "inner window", instead of a
4702     * dedicated Elementary window. By default, it won't.
4703     *
4704     * @param obj The file selector button widget
4705     * @param value @c EINA_TRUE to make it use an inner window, @c
4706     * EINA_TRUE to make it use a dedicated window
4707     *
4708     * @see elm_win_inwin_add() for more information on inner windows
4709     * @see elm_fileselector_button_inwin_mode_get()
4710     */
4711    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4712
4713    /**
4714     * Get whether a given file selector button widget's internal file
4715     * selector will raise an Elementary "inner window", instead of a
4716     * dedicated Elementary window.
4717     *
4718     * @param obj The file selector button widget
4719     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4720     * if it will use a dedicated window
4721     *
4722     * @see elm_fileselector_button_inwin_mode_set() for more details
4723     */
4724    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4725
4726    /**
4727     * @}
4728     */
4729
4730     /**
4731     * @defgroup File_Selector_Entry File Selector Entry
4732     *
4733     * @image html img/widget/fileselector_entry/preview-00.png
4734     * @image latex img/widget/fileselector_entry/preview-00.eps
4735     *
4736     * This is an entry made to be filled with or display a <b>file
4737     * system path string</b>. Besides the entry itself, the widget has
4738     * a @ref File_Selector_Button "file selector button" on its side,
4739     * which will raise an internal @ref Fileselector "file selector widget",
4740     * when clicked, for path selection aided by file system
4741     * navigation.
4742     *
4743     * This file selector may appear in an Elementary window or in an
4744     * inner window. When a file is chosen from it, the (inner) window
4745     * is closed and the selected file's path string is exposed both as
4746     * an smart event and as the new text on the entry.
4747     *
4748     * This widget encapsulates operations on its internal file
4749     * selector on its own API. There is less control over its file
4750     * selector than that one would have instatiating one directly.
4751     *
4752     * Smart callbacks one can register to:
4753     * - @c "changed" - The text within the entry was changed
4754     * - @c "activated" - The entry has had editing finished and
4755     *   changes are to be "committed"
4756     * - @c "press" - The entry has been clicked
4757     * - @c "longpressed" - The entry has been clicked (and held) for a
4758     *   couple seconds
4759     * - @c "clicked" - The entry has been clicked
4760     * - @c "clicked,double" - The entry has been double clicked
4761     * - @c "focused" - The entry has received focus
4762     * - @c "unfocused" - The entry has lost focus
4763     * - @c "selection,paste" - A paste action has occurred on the
4764     *   entry
4765     * - @c "selection,copy" - A copy action has occurred on the entry
4766     * - @c "selection,cut" - A cut action has occurred on the entry
4767     * - @c "unpressed" - The file selector entry's button was released
4768     *   after being pressed.
4769     * - @c "file,chosen" - The user has selected a path via the file
4770     *   selector entry's internal file selector, whose string pointer
4771     *   comes as the @c event_info data (a stringshared string)
4772     *
4773     * Here is an example on its usage:
4774     * @li @ref fileselector_entry_example
4775     *
4776     * @see @ref File_Selector_Button for a similar widget.
4777     * @{
4778     */
4779
4780    /**
4781     * Add a new file selector entry widget to the given parent
4782     * Elementary (container) object
4783     *
4784     * @param parent The parent object
4785     * @return a new file selector entry widget handle or @c NULL, on
4786     * errors
4787     */
4788    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4789
4790    /**
4791     * Set the label for a given file selector entry widget's button
4792     *
4793     * @param obj The file selector entry widget
4794     * @param label The text label to be displayed on @p obj widget's
4795     * button
4796     *
4797     * @deprecated use elm_object_text_set() instead.
4798     */
4799    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4800
4801    /**
4802     * Get the label set for a given file selector entry widget's button
4803     *
4804     * @param obj The file selector entry widget
4805     * @return The widget button's label
4806     *
4807     * @deprecated use elm_object_text_set() instead.
4808     */
4809    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4810
4811    /**
4812     * Set the icon on a given file selector entry widget's button
4813     *
4814     * @param obj The file selector entry widget
4815     * @param icon The icon object for the entry's button
4816     *
4817     * Once the icon object is set, a previously set one will be
4818     * deleted. If you want to keep the latter, use the
4819     * elm_fileselector_entry_button_icon_unset() function.
4820     *
4821     * @see elm_fileselector_entry_button_icon_get()
4822     */
4823    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4824
4825    /**
4826     * Get the icon set for a given file selector entry widget's button
4827     *
4828     * @param obj The file selector entry widget
4829     * @return The icon object currently set on @p obj widget's button
4830     * or @c NULL, if none is
4831     *
4832     * @see elm_fileselector_entry_button_icon_set()
4833     */
4834    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4835
4836    /**
4837     * Unset the icon used in a given file selector entry widget's
4838     * button
4839     *
4840     * @param obj The file selector entry widget
4841     * @return The icon object that was being used on @p obj widget's
4842     * button or @c NULL, on errors
4843     *
4844     * Unparent and return the icon object which was set for this
4845     * widget's button.
4846     *
4847     * @see elm_fileselector_entry_button_icon_set()
4848     */
4849    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4850
4851    /**
4852     * Set the title for a given file selector entry widget's window
4853     *
4854     * @param obj The file selector entry widget
4855     * @param title The title string
4856     *
4857     * This will change the window's title, when the file selector pops
4858     * out after a click on the entry's button. Those windows have the
4859     * default (unlocalized) value of @c "Select a file" as titles.
4860     *
4861     * @note It will only take any effect if the file selector
4862     * entry widget is @b not under "inwin mode".
4863     *
4864     * @see elm_fileselector_entry_window_title_get()
4865     */
4866    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4867
4868    /**
4869     * Get the title set for a given file selector entry widget's
4870     * window
4871     *
4872     * @param obj The file selector entry widget
4873     * @return Title of the file selector entry's window
4874     *
4875     * @see elm_fileselector_entry_window_title_get() for more details
4876     */
4877    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4878
4879    /**
4880     * Set the size of a given file selector entry widget's window,
4881     * holding the file selector itself.
4882     *
4883     * @param obj The file selector entry widget
4884     * @param width The window's width
4885     * @param height The window's height
4886     *
4887     * @note it will only take any effect if the file selector entry
4888     * widget is @b not under "inwin mode". The default size for the
4889     * window (when applicable) is 400x400 pixels.
4890     *
4891     * @see elm_fileselector_entry_window_size_get()
4892     */
4893    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4894
4895    /**
4896     * Get the size of a given file selector entry widget's window,
4897     * holding the file selector itself.
4898     *
4899     * @param obj The file selector entry widget
4900     * @param width Pointer into which to store the width value
4901     * @param height Pointer into which to store the height value
4902     *
4903     * @note Use @c NULL pointers on the size values you're not
4904     * interested in: they'll be ignored by the function.
4905     *
4906     * @see elm_fileselector_entry_window_size_set(), for more details
4907     */
4908    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4909
4910    /**
4911     * Set the initial file system path and the entry's path string for
4912     * a given file selector entry widget
4913     *
4914     * @param obj The file selector entry widget
4915     * @param path The path string
4916     *
4917     * It must be a <b>directory</b> path, which will have the contents
4918     * displayed initially in the file selector's view, when invoked
4919     * from @p obj. The default initial path is the @c "HOME"
4920     * environment variable's value.
4921     *
4922     * @see elm_fileselector_entry_path_get()
4923     */
4924    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4925
4926    /**
4927     * Get the entry's path string for a given file selector entry
4928     * widget
4929     *
4930     * @param obj The file selector entry widget
4931     * @return path The path string
4932     *
4933     * @see elm_fileselector_entry_path_set() for more details
4934     */
4935    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4936
4937    /**
4938     * Enable/disable a tree view in the given file selector entry
4939     * widget's internal file selector
4940     *
4941     * @param obj The file selector entry widget
4942     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4943     * disable
4944     *
4945     * This has the same effect as elm_fileselector_expandable_set(),
4946     * but now applied to a file selector entry's internal file
4947     * selector.
4948     *
4949     * @note There's no way to put a file selector entry's internal
4950     * file selector in "grid mode", as one may do with "pure" file
4951     * selectors.
4952     *
4953     * @see elm_fileselector_expandable_get()
4954     */
4955    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4956
4957    /**
4958     * Get whether tree view is enabled for the given file selector
4959     * entry widget's internal file selector
4960     *
4961     * @param obj The file selector entry widget
4962     * @return @c EINA_TRUE if @p obj widget's internal file selector
4963     * is in tree view, @c EINA_FALSE otherwise (and or errors)
4964     *
4965     * @see elm_fileselector_expandable_set() for more details
4966     */
4967    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4968
4969    /**
4970     * Set whether a given file selector entry widget's internal file
4971     * selector is to display folders only or the directory contents,
4972     * as well.
4973     *
4974     * @param obj The file selector entry widget
4975     * @param only @c EINA_TRUE to make @p obj widget's internal file
4976     * selector only display directories, @c EINA_FALSE to make files
4977     * to be displayed in it too
4978     *
4979     * This has the same effect as elm_fileselector_folder_only_set(),
4980     * but now applied to a file selector entry's internal file
4981     * selector.
4982     *
4983     * @see elm_fileselector_folder_only_get()
4984     */
4985    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4986
4987    /**
4988     * Get whether a given file selector entry widget's internal file
4989     * selector is displaying folders only or the directory contents,
4990     * as well.
4991     *
4992     * @param obj The file selector entry widget
4993     * @return @c EINA_TRUE if @p obj widget's internal file
4994     * selector is only displaying directories, @c EINA_FALSE if files
4995     * are being displayed in it too (and on errors)
4996     *
4997     * @see elm_fileselector_entry_folder_only_set() for more details
4998     */
4999    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5000
5001    /**
5002     * Enable/disable the file name entry box where the user can type
5003     * in a name for a file, in a given file selector entry widget's
5004     * internal file selector.
5005     *
5006     * @param obj The file selector entry widget
5007     * @param is_save @c EINA_TRUE to make @p obj widget's internal
5008     * file selector a "saving dialog", @c EINA_FALSE otherwise
5009     *
5010     * This has the same effect as elm_fileselector_is_save_set(),
5011     * but now applied to a file selector entry's internal file
5012     * selector.
5013     *
5014     * @see elm_fileselector_is_save_get()
5015     */
5016    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5017
5018    /**
5019     * Get whether the given file selector entry widget's internal
5020     * file selector is in "saving dialog" mode
5021     *
5022     * @param obj The file selector entry widget
5023     * @return @c EINA_TRUE, if @p obj widget's internal file selector
5024     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
5025     * errors)
5026     *
5027     * @see elm_fileselector_entry_is_save_set() for more details
5028     */
5029    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5030
5031    /**
5032     * Set whether a given file selector entry widget's internal file
5033     * selector will raise an Elementary "inner window", instead of a
5034     * dedicated Elementary window. By default, it won't.
5035     *
5036     * @param obj The file selector entry widget
5037     * @param value @c EINA_TRUE to make it use an inner window, @c
5038     * EINA_TRUE to make it use a dedicated window
5039     *
5040     * @see elm_win_inwin_add() for more information on inner windows
5041     * @see elm_fileselector_entry_inwin_mode_get()
5042     */
5043    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5044
5045    /**
5046     * Get whether a given file selector entry widget's internal file
5047     * selector will raise an Elementary "inner window", instead of a
5048     * dedicated Elementary window.
5049     *
5050     * @param obj The file selector entry widget
5051     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
5052     * if it will use a dedicated window
5053     *
5054     * @see elm_fileselector_entry_inwin_mode_set() for more details
5055     */
5056    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5057
5058    /**
5059     * Set the initial file system path for a given file selector entry
5060     * widget
5061     *
5062     * @param obj The file selector entry widget
5063     * @param path The path string
5064     *
5065     * It must be a <b>directory</b> path, which will have the contents
5066     * displayed initially in the file selector's view, when invoked
5067     * from @p obj. The default initial path is the @c "HOME"
5068     * environment variable's value.
5069     *
5070     * @see elm_fileselector_entry_path_get()
5071     */
5072    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5073
5074    /**
5075     * Get the parent directory's path to the latest file selection on
5076     * a given filer selector entry widget
5077     *
5078     * @param obj The file selector object
5079     * @return The (full) path of the directory of the last selection
5080     * on @p obj widget, a @b stringshared string
5081     *
5082     * @see elm_fileselector_entry_path_set()
5083     */
5084    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5085
5086    /**
5087     * @}
5088     */
5089
5090    /**
5091     * @defgroup Scroller Scroller
5092     *
5093     * A scroller holds a single object and "scrolls it around". This means that
5094     * it allows the user to use a scrollbar (or a finger) to drag the viewable
5095     * region around, allowing to move through a much larger object that is
5096     * contained in the scroller. The scroiller will always have a small minimum
5097     * size by default as it won't be limited by the contents of the scroller.
5098     *
5099     * Signals that you can add callbacks for are:
5100     * @li "edge,left" - the left edge of the content has been reached
5101     * @li "edge,right" - the right edge of the content has been reached
5102     * @li "edge,top" - the top edge of the content has been reached
5103     * @li "edge,bottom" - the bottom edge of the content has been reached
5104     * @li "scroll" - the content has been scrolled (moved)
5105     * @li "scroll,anim,start" - scrolling animation has started
5106     * @li "scroll,anim,stop" - scrolling animation has stopped
5107     * @li "scroll,drag,start" - dragging the contents around has started
5108     * @li "scroll,drag,stop" - dragging the contents around has stopped
5109     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
5110     * user intervetion.
5111     *
5112     * @note When Elemementary is in embedded mode the scrollbars will not be
5113     * dragable, they appear merely as indicators of how much has been scrolled.
5114     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
5115     * fingerscroll) won't work.
5116     *
5117     * In @ref tutorial_scroller you'll find an example of how to use most of
5118     * this API.
5119     * @{
5120     */
5121    /**
5122     * @brief Type that controls when scrollbars should appear.
5123     *
5124     * @see elm_scroller_policy_set()
5125     */
5126    typedef enum _Elm_Scroller_Policy
5127      {
5128         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
5129         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
5130         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
5131         ELM_SCROLLER_POLICY_LAST
5132      } Elm_Scroller_Policy;
5133    /**
5134     * @brief Add a new scroller to the parent
5135     *
5136     * @param parent The parent object
5137     * @return The new object or NULL if it cannot be created
5138     */
5139    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5140    /**
5141     * @brief Set the content of the scroller widget (the object to be scrolled around).
5142     *
5143     * @param obj The scroller object
5144     * @param content The new content object
5145     *
5146     * Once the content object is set, a previously set one will be deleted.
5147     * If you want to keep that old content object, use the
5148     * elm_scroller_content_unset() function.
5149     */
5150    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
5151    /**
5152     * @brief Get the content of the scroller widget
5153     *
5154     * @param obj The slider object
5155     * @return The content that is being used
5156     *
5157     * Return the content object which is set for this widget
5158     *
5159     * @see elm_scroller_content_set()
5160     */
5161    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5162    /**
5163     * @brief Unset the content of the scroller widget
5164     *
5165     * @param obj The slider object
5166     * @return The content that was being used
5167     *
5168     * Unparent and return the content object which was set for this widget
5169     *
5170     * @see elm_scroller_content_set()
5171     */
5172    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5173    /**
5174     * @brief Set custom theme elements for the scroller
5175     *
5176     * @param obj The scroller object
5177     * @param widget The widget name to use (default is "scroller")
5178     * @param base The base name to use (default is "base")
5179     */
5180    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
5181    /**
5182     * @brief Make the scroller minimum size limited to the minimum size of the content
5183     *
5184     * @param obj The scroller object
5185     * @param w Enable limiting minimum size horizontally
5186     * @param h Enable limiting minimum size vertically
5187     *
5188     * By default the scroller will be as small as its design allows,
5189     * irrespective of its content. This will make the scroller minimum size the
5190     * right size horizontally and/or vertically to perfectly fit its content in
5191     * that direction.
5192     */
5193    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
5194    /**
5195     * @brief Show a specific virtual region within the scroller content object
5196     *
5197     * @param obj The scroller object
5198     * @param x X coordinate of the region
5199     * @param y Y coordinate of the region
5200     * @param w Width of the region
5201     * @param h Height of the region
5202     *
5203     * This will ensure all (or part if it does not fit) of the designated
5204     * region in the virtual content object (0, 0 starting at the top-left of the
5205     * virtual content object) is shown within the scroller.
5206     */
5207    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);
5208    /**
5209     * @brief Set the scrollbar visibility policy
5210     *
5211     * @param obj The scroller object
5212     * @param policy_h Horizontal scrollbar policy
5213     * @param policy_v Vertical scrollbar policy
5214     *
5215     * This sets the scrollbar visibility policy for the given scroller.
5216     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
5217     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
5218     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
5219     * respectively for the horizontal and vertical scrollbars.
5220     */
5221    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5222    /**
5223     * @brief Gets scrollbar visibility policy
5224     *
5225     * @param obj The scroller object
5226     * @param policy_h Horizontal scrollbar policy
5227     * @param policy_v Vertical scrollbar policy
5228     *
5229     * @see elm_scroller_policy_set()
5230     */
5231    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
5232    /**
5233     * @brief Get the currently visible content region
5234     *
5235     * @param obj The scroller object
5236     * @param x X coordinate of the region
5237     * @param y Y coordinate of the region
5238     * @param w Width of the region
5239     * @param h Height of the region
5240     *
5241     * This gets the current region in the content object that is visible through
5242     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
5243     * w, @p h values pointed to.
5244     *
5245     * @note All coordinates are relative to the content.
5246     *
5247     * @see elm_scroller_region_show()
5248     */
5249    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);
5250    /**
5251     * @brief Get the size of the content object
5252     *
5253     * @param obj The scroller object
5254     * @param w Width return
5255     * @param h Height return
5256     *
5257     * This gets the size of the content object of the scroller.
5258     */
5259    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5260    /**
5261     * @brief Set bouncing behavior
5262     *
5263     * @param obj The scroller object
5264     * @param h_bounce Will the scroller bounce horizontally or not
5265     * @param v_bounce Will the scroller bounce vertically or not
5266     *
5267     * When scrolling, the scroller may "bounce" when reaching an edge of the
5268     * content object. This is a visual way to indicate the end has been reached.
5269     * This is enabled by default for both axis. This will set if it is enabled
5270     * for that axis with the boolean parameters for each axis.
5271     */
5272    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5273    /**
5274     * @brief Get the bounce mode
5275     *
5276     * @param obj The Scroller object
5277     * @param h_bounce Allow bounce horizontally
5278     * @param v_bounce Allow bounce vertically
5279     *
5280     * @see elm_scroller_bounce_set()
5281     */
5282    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5283    /**
5284     * @brief Set scroll page size relative to viewport size.
5285     *
5286     * @param obj The scroller object
5287     * @param h_pagerel The horizontal page relative size
5288     * @param v_pagerel The vertical page relative size
5289     *
5290     * The scroller is capable of limiting scrolling by the user to "pages". That
5291     * is to jump by and only show a "whole page" at a time as if the continuous
5292     * area of the scroller content is split into page sized pieces. This sets
5293     * the size of a page relative to the viewport of the scroller. 1.0 is "1
5294     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5295     * axis. This is mutually exclusive with page size
5296     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
5297     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5298     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5299     * the other axis.
5300     */
5301    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5302    /**
5303     * @brief Set scroll page size.
5304     *
5305     * @param obj The scroller object
5306     * @param h_pagesize The horizontal page size
5307     * @param v_pagesize The vertical page size
5308     *
5309     * This sets the page size to an absolute fixed value, with 0 turning it off
5310     * for that axis.
5311     *
5312     * @see elm_scroller_page_relative_set()
5313     */
5314    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5315    /**
5316     * @brief Show a specific virtual region within the scroller content object.
5317     *
5318     * @param obj The scroller object
5319     * @param x X coordinate of the region
5320     * @param y Y coordinate of the region
5321     * @param w Width of the region
5322     * @param h Height of the region
5323     *
5324     * This will ensure all (or part if it does not fit) of the designated
5325     * region in the virtual content object (0, 0 starting at the top-left of the
5326     * virtual content object) is shown within the scroller. Unlike
5327     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5328     * to this location (if configuration in general calls for transitions). It
5329     * may not jump immediately to the new location and make take a while and
5330     * show other content along the way.
5331     *
5332     * @see elm_scroller_region_show()
5333     */
5334    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);
5335    /**
5336     * @brief Set event propagation on a scroller
5337     *
5338     * @param obj The scroller object
5339     * @param propagation If propagation is enabled or not
5340     *
5341     * This enables or disabled event propagation from the scroller content to
5342     * the scroller and its parent. By default event propagation is disabled.
5343     */
5344    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5345    /**
5346     * @brief Get event propagation for a scroller
5347     *
5348     * @param obj The scroller object
5349     * @return The propagation state
5350     *
5351     * This gets the event propagation for a scroller.
5352     *
5353     * @see elm_scroller_propagate_events_set()
5354     */
5355    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
5356    /**
5357     * @}
5358     */
5359
5360    /**
5361     * @defgroup Label Label
5362     *
5363     * @image html img/widget/label/preview-00.png
5364     * @image latex img/widget/label/preview-00.eps
5365     *
5366     * @brief Widget to display text, with simple html-like markup.
5367     *
5368     * The Label widget @b doesn't allow text to overflow its boundaries, if the
5369     * text doesn't fit the geometry of the label it will be ellipsized or be
5370     * cut. Elementary provides several themes for this widget:
5371     * @li default - No animation
5372     * @li marker - Centers the text in the label and make it bold by default
5373     * @li slide_long - The entire text appears from the right of the screen and
5374     * slides until it disappears in the left of the screen(reappering on the
5375     * right again).
5376     * @li slide_short - The text appears in the left of the label and slides to
5377     * the right to show the overflow. When all of the text has been shown the
5378     * position is reset.
5379     * @li slide_bounce - The text appears in the left of the label and slides to
5380     * the right to show the overflow. When all of the text has been shown the
5381     * animation reverses, moving the text to the left.
5382     *
5383     * Custom themes can of course invent new markup tags and style them any way
5384     * they like.
5385     *
5386     * See @ref tutorial_label for a demonstration of how to use a label widget.
5387     * @{
5388     */
5389    /**
5390     * @brief Add a new label to the parent
5391     *
5392     * @param parent The parent object
5393     * @return The new object or NULL if it cannot be created
5394     */
5395    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5396    /**
5397     * @brief Set the label on the label object
5398     *
5399     * @param obj The label object
5400     * @param label The label will be used on the label object
5401     * @deprecated See elm_object_text_set()
5402     */
5403    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 */
5404    /**
5405     * @brief Get the label used on the label object
5406     *
5407     * @param obj The label object
5408     * @return The string inside the label
5409     * @deprecated See elm_object_text_get()
5410     */
5411    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5412    /**
5413     * @brief Set the wrapping behavior of the label
5414     *
5415     * @param obj The label object
5416     * @param wrap To wrap text or not
5417     *
5418     * By default no wrapping is done. Possible values for @p wrap are:
5419     * @li ELM_WRAP_NONE - No wrapping
5420     * @li ELM_WRAP_CHAR - wrap between characters
5421     * @li ELM_WRAP_WORD - wrap between words
5422     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5423     */
5424    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5425    /**
5426     * @brief Get the wrapping behavior of the label
5427     *
5428     * @param obj The label object
5429     * @return Wrap type
5430     *
5431     * @see elm_label_line_wrap_set()
5432     */
5433    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5434    /**
5435     * @brief Set wrap width of the label
5436     *
5437     * @param obj The label object
5438     * @param w The wrap width in pixels at a minimum where words need to wrap
5439     *
5440     * This function sets the maximum width size hint of the label.
5441     *
5442     * @warning This is only relevant if the label is inside a container.
5443     */
5444    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5445    /**
5446     * @brief Get wrap width of the label
5447     *
5448     * @param obj The label object
5449     * @return The wrap width in pixels at a minimum where words need to wrap
5450     *
5451     * @see elm_label_wrap_width_set()
5452     */
5453    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5454    /**
5455     * @brief Set wrap height of the label
5456     *
5457     * @param obj The label object
5458     * @param h The wrap height in pixels at a minimum where words need to wrap
5459     *
5460     * This function sets the maximum height size hint of the label.
5461     *
5462     * @warning This is only relevant if the label is inside a container.
5463     */
5464    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5465    /**
5466     * @brief get wrap width of the label
5467     *
5468     * @param obj The label object
5469     * @return The wrap height in pixels at a minimum where words need to wrap
5470     */
5471    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5472    /**
5473     * @brief Set the font size on the label object.
5474     *
5475     * @param obj The label object
5476     * @param size font size
5477     *
5478     * @warning NEVER use this. It is for hyper-special cases only. use styles
5479     * instead. e.g. "big", "medium", "small" - or better name them by use:
5480     * "title", "footnote", "quote" etc.
5481     */
5482    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5483    /**
5484     * @brief Set the text color on the label object
5485     *
5486     * @param obj The label object
5487     * @param r Red property background color of The label object
5488     * @param g Green property background color of The label object
5489     * @param b Blue property background color of The label object
5490     * @param a Alpha property background color of The label object
5491     *
5492     * @warning NEVER use this. It is for hyper-special cases only. use styles
5493     * instead. e.g. "big", "medium", "small" - or better name them by use:
5494     * "title", "footnote", "quote" etc.
5495     */
5496    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);
5497    /**
5498     * @brief Set the text align on the label object
5499     *
5500     * @param obj The label object
5501     * @param align align mode ("left", "center", "right")
5502     *
5503     * @warning NEVER use this. It is for hyper-special cases only. use styles
5504     * instead. e.g. "big", "medium", "small" - or better name them by use:
5505     * "title", "footnote", "quote" etc.
5506     */
5507    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5508    /**
5509     * @brief Set background color of the label
5510     *
5511     * @param obj The label object
5512     * @param r Red property background color of The label object
5513     * @param g Green property background color of The label object
5514     * @param b Blue property background color of The label object
5515     * @param a Alpha property background alpha of The label object
5516     *
5517     * @warning NEVER use this. It is for hyper-special cases only. use styles
5518     * instead. e.g. "big", "medium", "small" - or better name them by use:
5519     * "title", "footnote", "quote" etc.
5520     */
5521    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);
5522    /**
5523     * @brief Set the ellipsis behavior of the label
5524     *
5525     * @param obj The label object
5526     * @param ellipsis To ellipsis text or not
5527     *
5528     * If set to true and the text doesn't fit in the label an ellipsis("...")
5529     * will be shown at the end of the widget.
5530     *
5531     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5532     * choosen wrap method was ELM_WRAP_WORD.
5533     */
5534    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5535    /**
5536     * @brief Set the text slide of the label
5537     *
5538     * @param obj The label object
5539     * @param slide To start slide or stop
5540     *
5541     * If set to true the text of the label will slide throught the length of
5542     * label.
5543     *
5544     * @warning This only work with the themes "slide_short", "slide_long" and
5545     * "slide_bounce".
5546     */
5547    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5548    /**
5549     * @brief Get the text slide mode of the label
5550     *
5551     * @param obj The label object
5552     * @return slide slide mode value
5553     *
5554     * @see elm_label_slide_set()
5555     */
5556    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5557    /**
5558     * @brief Set the slide duration(speed) of the label
5559     *
5560     * @param obj The label object
5561     * @return The duration in seconds in moving text from slide begin position
5562     * to slide end position
5563     */
5564    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5565    /**
5566     * @brief Get the slide duration(speed) of the label
5567     *
5568     * @param obj The label object
5569     * @return The duration time in moving text from slide begin position to slide end position
5570     *
5571     * @see elm_label_slide_duration_set()
5572     */
5573    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5574    /**
5575     * @}
5576     */
5577
5578    /**
5579     * @defgroup Toggle Toggle
5580     *
5581     * @image html img/widget/toggle/preview-00.png
5582     * @image latex img/widget/toggle/preview-00.eps
5583     *
5584     * @brief A toggle is a slider which can be used to toggle between
5585     * two values.  It has two states: on and off.
5586     *
5587     * Signals that you can add callbacks for are:
5588     * @li "changed" - Whenever the toggle value has been changed.  Is not called
5589     *                 until the toggle is released by the cursor (assuming it
5590     *                 has been triggered by the cursor in the first place).
5591     *
5592     * @ref tutorial_toggle show how to use a toggle.
5593     * @{
5594     */
5595    /**
5596     * @brief Add a toggle to @p parent.
5597     *
5598     * @param parent The parent object
5599     *
5600     * @return The toggle object
5601     */
5602    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5603    /**
5604     * @brief Sets the label to be displayed with the toggle.
5605     *
5606     * @param obj The toggle object
5607     * @param label The label to be displayed
5608     *
5609     * @deprecated use elm_object_text_set() instead.
5610     */
5611    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5612    /**
5613     * @brief Gets the label of the toggle
5614     *
5615     * @param obj  toggle object
5616     * @return The label of the toggle
5617     *
5618     * @deprecated use elm_object_text_get() instead.
5619     */
5620    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5621    /**
5622     * @brief Set the icon used for the toggle
5623     *
5624     * @param obj The toggle object
5625     * @param icon The icon object for the button
5626     *
5627     * Once the icon object is set, a previously set one will be deleted
5628     * If you want to keep that old content object, use the
5629     * elm_toggle_icon_unset() function.
5630     */
5631    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5632    /**
5633     * @brief Get the icon used for the toggle
5634     *
5635     * @param obj The toggle object
5636     * @return The icon object that is being used
5637     *
5638     * Return the icon object which is set for this widget.
5639     *
5640     * @see elm_toggle_icon_set()
5641     */
5642    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5643    /**
5644     * @brief Unset the icon used for the toggle
5645     *
5646     * @param obj The toggle object
5647     * @return The icon object that was being used
5648     *
5649     * Unparent and return the icon object which was set for this widget.
5650     *
5651     * @see elm_toggle_icon_set()
5652     */
5653    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5654    /**
5655     * @brief Sets the labels to be associated with the on and off states of the toggle.
5656     *
5657     * @param obj The toggle object
5658     * @param onlabel The label displayed when the toggle is in the "on" state
5659     * @param offlabel The label displayed when the toggle is in the "off" state
5660     */
5661    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5662    /**
5663     * @brief Gets the labels associated with the on and off states of the toggle.
5664     *
5665     * @param obj The toggle object
5666     * @param onlabel A char** to place the onlabel of @p obj into
5667     * @param offlabel A char** to place the offlabel of @p obj into
5668     */
5669    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5670    /**
5671     * @brief Sets the state of the toggle to @p state.
5672     *
5673     * @param obj The toggle object
5674     * @param state The state of @p obj
5675     */
5676    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5677    /**
5678     * @brief Gets the state of the toggle to @p state.
5679     *
5680     * @param obj The toggle object
5681     * @return The state of @p obj
5682     */
5683    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5684    /**
5685     * @brief Sets the state pointer of the toggle to @p statep.
5686     *
5687     * @param obj The toggle object
5688     * @param statep The state pointer of @p obj
5689     */
5690    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5691    /**
5692     * @}
5693     */
5694
5695    /**
5696     * @defgroup Frame Frame
5697     *
5698     * @image html img/widget/frame/preview-00.png
5699     * @image latex img/widget/frame/preview-00.eps
5700     *
5701     * @brief Frame is a widget that holds some content and has a title.
5702     *
5703     * The default look is a frame with a title, but Frame supports multple
5704     * styles:
5705     * @li default
5706     * @li pad_small
5707     * @li pad_medium
5708     * @li pad_large
5709     * @li pad_huge
5710     * @li outdent_top
5711     * @li outdent_bottom
5712     *
5713     * Of all this styles only default shows the title. Frame emits no signals.
5714     *
5715     * For a detailed example see the @ref tutorial_frame.
5716     *
5717     * @{
5718     */
5719    /**
5720     * @brief Add a new frame to the parent
5721     *
5722     * @param parent The parent object
5723     * @return The new object or NULL if it cannot be created
5724     */
5725    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5726    /**
5727     * @brief Set the frame label
5728     *
5729     * @param obj The frame object
5730     * @param label The label of this frame object
5731     *
5732     * @deprecated use elm_object_text_set() instead.
5733     */
5734    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5735    /**
5736     * @brief Get the frame label
5737     *
5738     * @param obj The frame object
5739     *
5740     * @return The label of this frame objet or NULL if unable to get frame
5741     *
5742     * @deprecated use elm_object_text_get() instead.
5743     */
5744    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5745    /**
5746     * @brief Set the content of the frame widget
5747     *
5748     * Once the content object is set, a previously set one will be deleted.
5749     * If you want to keep that old content object, use the
5750     * elm_frame_content_unset() function.
5751     *
5752     * @param obj The frame object
5753     * @param content The content will be filled in this frame object
5754     */
5755    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5756    /**
5757     * @brief Get the content of the frame widget
5758     *
5759     * Return the content object which is set for this widget
5760     *
5761     * @param obj The frame object
5762     * @return The content that is being used
5763     */
5764    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5765    /**
5766     * @brief Unset the content of the frame widget
5767     *
5768     * Unparent and return the content object which was set for this widget
5769     *
5770     * @param obj The frame object
5771     * @return The content that was being used
5772     */
5773    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5774    /**
5775     * @}
5776     */
5777
5778    /**
5779     * @defgroup Table Table
5780     *
5781     * A container widget to arrange other widgets in a table where items can
5782     * also span multiple columns or rows - even overlap (and then be raised or
5783     * lowered accordingly to adjust stacking if they do overlap).
5784     *
5785     * The followin are examples of how to use a table:
5786     * @li @ref tutorial_table_01
5787     * @li @ref tutorial_table_02
5788     *
5789     * @{
5790     */
5791    /**
5792     * @brief Add a new table to the parent
5793     *
5794     * @param parent The parent object
5795     * @return The new object or NULL if it cannot be created
5796     */
5797    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5798    /**
5799     * @brief Set the homogeneous layout in the table
5800     *
5801     * @param obj The layout object
5802     * @param homogeneous A boolean to set if the layout is homogeneous in the
5803     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
5804     */
5805    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5806    /**
5807     * @brief Get the current table homogeneous mode.
5808     *
5809     * @param obj The table object
5810     * @return A boolean to indicating if the layout is homogeneous in the table
5811     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
5812     */
5813    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5814    /**
5815     * @warning <b>Use elm_table_homogeneous_set() instead</b>
5816     */
5817    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5818    /**
5819     * @warning <b>Use elm_table_homogeneous_get() instead</b>
5820     */
5821    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5822    /**
5823     * @brief Set padding between cells.
5824     *
5825     * @param obj The layout object.
5826     * @param horizontal set the horizontal padding.
5827     * @param vertical set the vertical padding.
5828     *
5829     * Default value is 0.
5830     */
5831    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5832    /**
5833     * @brief Get padding between cells.
5834     *
5835     * @param obj The layout object.
5836     * @param horizontal set the horizontal padding.
5837     * @param vertical set the vertical padding.
5838     */
5839    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5840    /**
5841     * @brief Add a subobject on the table with the coordinates passed
5842     *
5843     * @param obj The table object
5844     * @param subobj The subobject to be added to the table
5845     * @param x Row number
5846     * @param y Column number
5847     * @param w rowspan
5848     * @param h colspan
5849     *
5850     * @note All positioning inside the table is relative to rows and columns, so
5851     * a value of 0 for x and y, means the top left cell of the table, and a
5852     * value of 1 for w and h means @p subobj only takes that 1 cell.
5853     */
5854    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5855    /**
5856     * @brief Remove child from table.
5857     *
5858     * @param obj The table object
5859     * @param subobj The subobject
5860     */
5861    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5862    /**
5863     * @brief Faster way to remove all child objects from a table object.
5864     *
5865     * @param obj The table object
5866     * @param clear If true, will delete children, else just remove from table.
5867     */
5868    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5869    /**
5870     * @brief Set the packing location of an existing child of the table
5871     *
5872     * @param subobj The subobject to be modified in the table
5873     * @param x Row number
5874     * @param y Column number
5875     * @param w rowspan
5876     * @param h colspan
5877     *
5878     * Modifies the position of an object already in the table.
5879     *
5880     * @note All positioning inside the table is relative to rows and columns, so
5881     * a value of 0 for x and y, means the top left cell of the table, and a
5882     * value of 1 for w and h means @p subobj only takes that 1 cell.
5883     */
5884    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5885    /**
5886     * @brief Get the packing location of an existing child of the table
5887     *
5888     * @param subobj The subobject to be modified in the table
5889     * @param x Row number
5890     * @param y Column number
5891     * @param w rowspan
5892     * @param h colspan
5893     *
5894     * @see elm_table_pack_set()
5895     */
5896    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5897    /**
5898     * @}
5899     */
5900
5901    /**
5902     * @defgroup Gengrid Gengrid (Generic grid)
5903     *
5904     * This widget aims to position objects in a grid layout while
5905     * actually creating and rendering only the visible ones, using the
5906     * same idea as the @ref Genlist "genlist": the user defines a @b
5907     * class for each item, specifying functions that will be called at
5908     * object creation, deletion, etc. When those items are selected by
5909     * the user, a callback function is issued. Users may interact with
5910     * a gengrid via the mouse (by clicking on items to select them and
5911     * clicking on the grid's viewport and swiping to pan the whole
5912     * view) or via the keyboard, navigating through item with the
5913     * arrow keys.
5914     *
5915     * @section Gengrid_Layouts Gengrid layouts
5916     *
5917     * Gengrids may layout its items in one of two possible layouts:
5918     * - horizontal or
5919     * - vertical.
5920     *
5921     * When in "horizontal mode", items will be placed in @b columns,
5922     * from top to bottom and, when the space for a column is filled,
5923     * another one is started on the right, thus expanding the grid
5924     * horizontally, making for horizontal scrolling. When in "vertical
5925     * mode" , though, items will be placed in @b rows, from left to
5926     * right and, when the space for a row is filled, another one is
5927     * started below, thus expanding the grid vertically (and making
5928     * for vertical scrolling).
5929     *
5930     * @section Gengrid_Items Gengrid items
5931     *
5932     * An item in a gengrid can have 0 or more text labels (they can be
5933     * regular text or textblock Evas objects - that's up to the style
5934     * to determine), 0 or more icons (which are simply objects
5935     * swallowed into the gengrid item's theming Edje object) and 0 or
5936     * more <b>boolean states</b>, which have the behavior left to the
5937     * user to define. The Edje part names for each of these properties
5938     * will be looked up, in the theme file for the gengrid, under the
5939     * Edje (string) data items named @c "labels", @c "icons" and @c
5940     * "states", respectively. For each of those properties, if more
5941     * than one part is provided, they must have names listed separated
5942     * by spaces in the data fields. For the default gengrid item
5943     * theme, we have @b one label part (@c "elm.text"), @b two icon
5944     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5945     * no state parts.
5946     *
5947     * A gengrid item may be at one of several styles. Elementary
5948     * provides one by default - "default", but this can be extended by
5949     * system or application custom themes/overlays/extensions (see
5950     * @ref Theme "themes" for more details).
5951     *
5952     * @section Gengrid_Item_Class Gengrid item classes
5953     *
5954     * In order to have the ability to add and delete items on the fly,
5955     * gengrid implements a class (callback) system where the
5956     * application provides a structure with information about that
5957     * type of item (gengrid may contain multiple different items with
5958     * different classes, states and styles). Gengrid will call the
5959     * functions in this struct (methods) when an item is "realized"
5960     * (i.e., created dynamically, while the user is scrolling the
5961     * grid). All objects will simply be deleted when no longer needed
5962     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5963     * contains the following members:
5964     * - @c item_style - This is a constant string and simply defines
5965     * the name of the item style. It @b must be specified and the
5966     * default should be @c "default".
5967     * - @c func.label_get - This function is called when an item
5968     * object is actually created. The @c data parameter will point to
5969     * the same data passed to elm_gengrid_item_append() and related
5970     * item creation functions. The @c obj parameter is the gengrid
5971     * object itself, while the @c part one is the name string of one
5972     * of the existing text parts in the Edje group implementing the
5973     * item's theme. This function @b must return a strdup'()ed string,
5974     * as the caller will free() it when done. See
5975     * #Elm_Gengrid_Item_Label_Get_Cb.
5976     * - @c func.icon_get - This function is called when an item object
5977     * is actually created. The @c data parameter will point to the
5978     * same data passed to elm_gengrid_item_append() and related item
5979     * creation functions. The @c obj parameter is the gengrid object
5980     * itself, while the @c part one is the name string of one of the
5981     * existing (icon) swallow parts in the Edje group implementing the
5982     * item's theme. It must return @c NULL, when no icon is desired,
5983     * or a valid object handle, otherwise. The object will be deleted
5984     * by the gengrid on its deletion or when the item is "unrealized".
5985     * See #Elm_Gengrid_Item_Icon_Get_Cb.
5986     * - @c func.state_get - This function is called when an item
5987     * object is actually created. The @c data parameter will point to
5988     * the same data passed to elm_gengrid_item_append() and related
5989     * item creation functions. The @c obj parameter is the gengrid
5990     * object itself, while the @c part one is the name string of one
5991     * of the state parts in the Edje group implementing the item's
5992     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5993     * true/on. Gengrids will emit a signal to its theming Edje object
5994     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5995     * "source" arguments, respectively, when the state is true (the
5996     * default is false), where @c XXX is the name of the (state) part.
5997     * See #Elm_Gengrid_Item_State_Get_Cb.
5998     * - @c func.del - This is called when elm_gengrid_item_del() is
5999     * called on an item or elm_gengrid_clear() is called on the
6000     * gengrid. This is intended for use when gengrid items are
6001     * deleted, so any data attached to the item (e.g. its data
6002     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
6003     *
6004     * @section Gengrid_Usage_Hints Usage hints
6005     *
6006     * If the user wants to have multiple items selected at the same
6007     * time, elm_gengrid_multi_select_set() will permit it. If the
6008     * gengrid is single-selection only (the default), then
6009     * elm_gengrid_select_item_get() will return the selected item or
6010     * @c NULL, if none is selected. If the gengrid is under
6011     * multi-selection, then elm_gengrid_selected_items_get() will
6012     * return a list (that is only valid as long as no items are
6013     * modified (added, deleted, selected or unselected) of child items
6014     * on a gengrid.
6015     *
6016     * If an item changes (internal (boolean) state, label or icon
6017     * changes), then use elm_gengrid_item_update() to have gengrid
6018     * update the item with the new state. A gengrid will re-"realize"
6019     * the item, thus calling the functions in the
6020     * #Elm_Gengrid_Item_Class set for that item.
6021     *
6022     * To programmatically (un)select an item, use
6023     * elm_gengrid_item_selected_set(). To get its selected state use
6024     * elm_gengrid_item_selected_get(). To make an item disabled
6025     * (unable to be selected and appear differently) use
6026     * elm_gengrid_item_disabled_set() to set this and
6027     * elm_gengrid_item_disabled_get() to get the disabled state.
6028     *
6029     * Grid cells will only have their selection smart callbacks called
6030     * when firstly getting selected. Any further clicks will do
6031     * nothing, unless you enable the "always select mode", with
6032     * elm_gengrid_always_select_mode_set(), thus making every click to
6033     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
6034     * turn off the ability to select items entirely in the widget and
6035     * they will neither appear selected nor call the selection smart
6036     * callbacks.
6037     *
6038     * Remember that you can create new styles and add your own theme
6039     * augmentation per application with elm_theme_extension_add(). If
6040     * you absolutely must have a specific style that overrides any
6041     * theme the user or system sets up you can use
6042     * elm_theme_overlay_add() to add such a file.
6043     *
6044     * @section Gengrid_Smart_Events Gengrid smart events
6045     *
6046     * Smart events that you can add callbacks for are:
6047     * - @c "activated" - The user has double-clicked or pressed
6048     *   (enter|return|spacebar) on an item. The @c event_info parameter
6049     *   is the gengrid item that was activated.
6050     * - @c "clicked,double" - The user has double-clicked an item.
6051     *   The @c event_info parameter is the gengrid item that was double-clicked.
6052     * - @c "selected" - The user has made an item selected. The
6053     *   @c event_info parameter is the gengrid item that was selected.
6054     * - @c "unselected" - The user has made an item unselected. The
6055     *   @c event_info parameter is the gengrid item that was unselected.
6056     * - @c "realized" - This is called when the item in the gengrid
6057     *   has its implementing Evas object instantiated, de facto. @c
6058     *   event_info is the gengrid item that was created. The object
6059     *   may be deleted at any time, so it is highly advised to the
6060     *   caller @b not to use the object pointer returned from
6061     *   elm_gengrid_item_object_get(), because it may point to freed
6062     *   objects.
6063     * - @c "unrealized" - This is called when the implementing Evas
6064     *   object for this item is deleted. @c event_info is the gengrid
6065     *   item that was deleted.
6066     * - @c "changed" - Called when an item is added, removed, resized
6067     *   or moved and when the gengrid is resized or gets "horizontal"
6068     *   property changes.
6069     * - @c "drag,start,up" - Called when the item in the gengrid has
6070     *   been dragged (not scrolled) up.
6071     * - @c "drag,start,down" - Called when the item in the gengrid has
6072     *   been dragged (not scrolled) down.
6073     * - @c "drag,start,left" - Called when the item in the gengrid has
6074     *   been dragged (not scrolled) left.
6075     * - @c "drag,start,right" - Called when the item in the gengrid has
6076     *   been dragged (not scrolled) right.
6077     * - @c "drag,stop" - Called when the item in the gengrid has
6078     *   stopped being dragged.
6079     * - @c "drag" - Called when the item in the gengrid is being
6080     *   dragged.
6081     * - @c "scroll" - called when the content has been scrolled
6082     *   (moved).
6083     * - @c "scroll,drag,start" - called when dragging the content has
6084     *   started.
6085     * - @c "scroll,drag,stop" - called when dragging the content has
6086     *   stopped.
6087     *
6088     * List of gendrid examples:
6089     * @li @ref gengrid_example
6090     */
6091
6092    /**
6093     * @addtogroup Gengrid
6094     * @{
6095     */
6096
6097    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
6098    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
6099    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
6100    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
6101    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. */
6102    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. */
6103    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
6104
6105    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
6106    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
6107    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
6108    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
6109
6110    /**
6111     * @struct _Elm_Gengrid_Item_Class
6112     *
6113     * Gengrid item class definition. See @ref Gengrid_Item_Class for
6114     * field details.
6115     */
6116    struct _Elm_Gengrid_Item_Class
6117      {
6118         const char             *item_style;
6119         struct _Elm_Gengrid_Item_Class_Func
6120           {
6121              Elm_Gengrid_Item_Label_Get_Cb label_get;
6122              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
6123              Elm_Gengrid_Item_State_Get_Cb state_get;
6124              Elm_Gengrid_Item_Del_Cb       del;
6125           } func;
6126      }; /**< #Elm_Gengrid_Item_Class member definitions */
6127
6128    /**
6129     * Add a new gengrid widget to the given parent Elementary
6130     * (container) object
6131     *
6132     * @param parent The parent object
6133     * @return a new gengrid widget handle or @c NULL, on errors
6134     *
6135     * This function inserts a new gengrid widget on the canvas.
6136     *
6137     * @see elm_gengrid_item_size_set()
6138     * @see elm_gengrid_horizontal_set()
6139     * @see elm_gengrid_item_append()
6140     * @see elm_gengrid_item_del()
6141     * @see elm_gengrid_clear()
6142     *
6143     * @ingroup Gengrid
6144     */
6145    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6146
6147    /**
6148     * Set the size for the items of a given gengrid widget
6149     *
6150     * @param obj The gengrid object.
6151     * @param w The items' width.
6152     * @param h The items' height;
6153     *
6154     * A gengrid, after creation, has still no information on the size
6155     * to give to each of its cells. So, you most probably will end up
6156     * with squares one @ref Fingers "finger" wide, the default
6157     * size. Use this function to force a custom size for you items,
6158     * making them as big as you wish.
6159     *
6160     * @see elm_gengrid_item_size_get()
6161     *
6162     * @ingroup Gengrid
6163     */
6164    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
6165
6166    /**
6167     * Get the size set for the items of a given gengrid widget
6168     *
6169     * @param obj The gengrid object.
6170     * @param w Pointer to a variable where to store the items' width.
6171     * @param h Pointer to a variable where to store the items' height.
6172     *
6173     * @note Use @c NULL pointers on the size values you're not
6174     * interested in: they'll be ignored by the function.
6175     *
6176     * @see elm_gengrid_item_size_get() for more details
6177     *
6178     * @ingroup Gengrid
6179     */
6180    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6181
6182    /**
6183     * Set the items grid's alignment within a given gengrid widget
6184     *
6185     * @param obj The gengrid object.
6186     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
6187     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
6188     *
6189     * This sets the alignment of the whole grid of items of a gengrid
6190     * within its given viewport. By default, those values are both
6191     * 0.5, meaning that the gengrid will have its items grid placed
6192     * exactly in the middle of its viewport.
6193     *
6194     * @note If given alignment values are out of the cited ranges,
6195     * they'll be changed to the nearest boundary values on the valid
6196     * ranges.
6197     *
6198     * @see elm_gengrid_align_get()
6199     *
6200     * @ingroup Gengrid
6201     */
6202    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
6203
6204    /**
6205     * Get the items grid's alignment values within a given gengrid
6206     * widget
6207     *
6208     * @param obj The gengrid object.
6209     * @param align_x Pointer to a variable where to store the
6210     * horizontal alignment.
6211     * @param align_y Pointer to a variable where to store the vertical
6212     * alignment.
6213     *
6214     * @note Use @c NULL pointers on the alignment values you're not
6215     * interested in: they'll be ignored by the function.
6216     *
6217     * @see elm_gengrid_align_set() for more details
6218     *
6219     * @ingroup Gengrid
6220     */
6221    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
6222
6223    /**
6224     * Set whether a given gengrid widget is or not able have items
6225     * @b reordered
6226     *
6227     * @param obj The gengrid object
6228     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
6229     * @c EINA_FALSE to turn it off
6230     *
6231     * If a gengrid is set to allow reordering, a click held for more
6232     * than 0.5 over a given item will highlight it specially,
6233     * signalling the gengrid has entered the reordering state. From
6234     * that time on, the user will be able to, while still holding the
6235     * mouse button down, move the item freely in the gengrid's
6236     * viewport, replacing to said item to the locations it goes to.
6237     * The replacements will be animated and, whenever the user
6238     * releases the mouse button, the item being replaced gets a new
6239     * definitive place in the grid.
6240     *
6241     * @see elm_gengrid_reorder_mode_get()
6242     *
6243     * @ingroup Gengrid
6244     */
6245    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6246
6247    /**
6248     * Get whether a given gengrid widget is or not able have items
6249     * @b reordered
6250     *
6251     * @param obj The gengrid object
6252     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6253     * off
6254     *
6255     * @see elm_gengrid_reorder_mode_set() for more details
6256     *
6257     * @ingroup Gengrid
6258     */
6259    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6260
6261    /**
6262     * Append a new item in a given gengrid widget.
6263     *
6264     * @param obj The gengrid object.
6265     * @param gic The item class for the item.
6266     * @param data The item data.
6267     * @param func Convenience function called when the item is
6268     * selected.
6269     * @param func_data Data to be passed to @p func.
6270     * @return A handle to the item added or @c NULL, on errors.
6271     *
6272     * This adds an item to the beginning of the gengrid.
6273     *
6274     * @see elm_gengrid_item_prepend()
6275     * @see elm_gengrid_item_insert_before()
6276     * @see elm_gengrid_item_insert_after()
6277     * @see elm_gengrid_item_del()
6278     *
6279     * @ingroup Gengrid
6280     */
6281    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);
6282
6283    /**
6284     * Prepend a new item in a given gengrid widget.
6285     *
6286     * @param obj The gengrid object.
6287     * @param gic The item class for the item.
6288     * @param data The item data.
6289     * @param func Convenience function called when the item is
6290     * selected.
6291     * @param func_data Data to be passed to @p func.
6292     * @return A handle to the item added or @c NULL, on errors.
6293     *
6294     * This adds an item to the end of the gengrid.
6295     *
6296     * @see elm_gengrid_item_append()
6297     * @see elm_gengrid_item_insert_before()
6298     * @see elm_gengrid_item_insert_after()
6299     * @see elm_gengrid_item_del()
6300     *
6301     * @ingroup Gengrid
6302     */
6303    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);
6304
6305    /**
6306     * Insert an item before another in a gengrid widget
6307     *
6308     * @param obj The gengrid object.
6309     * @param gic The item class for the item.
6310     * @param data The item data.
6311     * @param relative The item to place this new one before.
6312     * @param func Convenience function called when the item is
6313     * selected.
6314     * @param func_data Data to be passed to @p func.
6315     * @return A handle to the item added or @c NULL, on errors.
6316     *
6317     * This inserts an item before another in the gengrid.
6318     *
6319     * @see elm_gengrid_item_append()
6320     * @see elm_gengrid_item_prepend()
6321     * @see elm_gengrid_item_insert_after()
6322     * @see elm_gengrid_item_del()
6323     *
6324     * @ingroup Gengrid
6325     */
6326    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);
6327
6328    /**
6329     * Insert an item after another in a gengrid widget
6330     *
6331     * @param obj The gengrid object.
6332     * @param gic The item class for the item.
6333     * @param data The item data.
6334     * @param relative The item to place this new one after.
6335     * @param func Convenience function called when the item is
6336     * selected.
6337     * @param func_data Data to be passed to @p func.
6338     * @return A handle to the item added or @c NULL, on errors.
6339     *
6340     * This inserts an item after another in the gengrid.
6341     *
6342     * @see elm_gengrid_item_append()
6343     * @see elm_gengrid_item_prepend()
6344     * @see elm_gengrid_item_insert_after()
6345     * @see elm_gengrid_item_del()
6346     *
6347     * @ingroup Gengrid
6348     */
6349    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);
6350
6351    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);
6352
6353    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);
6354
6355    /**
6356     * Set whether items on a given gengrid widget are to get their
6357     * selection callbacks issued for @b every subsequent selection
6358     * click on them or just for the first click.
6359     *
6360     * @param obj The gengrid object
6361     * @param always_select @c EINA_TRUE to make items "always
6362     * selected", @c EINA_FALSE, otherwise
6363     *
6364     * By default, grid items will only call their selection callback
6365     * function when firstly getting selected, any subsequent further
6366     * clicks will do nothing. With this call, you make those
6367     * subsequent clicks also to issue the selection callbacks.
6368     *
6369     * @note <b>Double clicks</b> will @b always be reported on items.
6370     *
6371     * @see elm_gengrid_always_select_mode_get()
6372     *
6373     * @ingroup Gengrid
6374     */
6375    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6376
6377    /**
6378     * Get whether items on a given gengrid widget have their selection
6379     * callbacks issued for @b every subsequent selection click on them
6380     * or just for the first click.
6381     *
6382     * @param obj The gengrid object.
6383     * @return @c EINA_TRUE if the gengrid items are "always selected",
6384     * @c EINA_FALSE, otherwise
6385     *
6386     * @see elm_gengrid_always_select_mode_set() for more details
6387     *
6388     * @ingroup Gengrid
6389     */
6390    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6391
6392    /**
6393     * Set whether items on a given gengrid widget can be selected or not.
6394     *
6395     * @param obj The gengrid object
6396     * @param no_select @c EINA_TRUE to make items selectable,
6397     * @c EINA_FALSE otherwise
6398     *
6399     * This will make items in @p obj selectable or not. In the latter
6400     * case, any user interacion on the gendrid items will neither make
6401     * them appear selected nor them call their selection callback
6402     * functions.
6403     *
6404     * @see elm_gengrid_no_select_mode_get()
6405     *
6406     * @ingroup Gengrid
6407     */
6408    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6409
6410    /**
6411     * Get whether items on a given gengrid widget can be selected or
6412     * not.
6413     *
6414     * @param obj The gengrid object
6415     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6416     * otherwise
6417     *
6418     * @see elm_gengrid_no_select_mode_set() for more details
6419     *
6420     * @ingroup Gengrid
6421     */
6422    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6423
6424    /**
6425     * Enable or disable multi-selection in a given gengrid widget
6426     *
6427     * @param obj The gengrid object.
6428     * @param multi @c EINA_TRUE, to enable multi-selection,
6429     * @c EINA_FALSE to disable it.
6430     *
6431     * Multi-selection is the ability for one to have @b more than one
6432     * item selected, on a given gengrid, simultaneously. When it is
6433     * enabled, a sequence of clicks on different items will make them
6434     * all selected, progressively. A click on an already selected item
6435     * will unselect it. If interecting via the keyboard,
6436     * multi-selection is enabled while holding the "Shift" key.
6437     *
6438     * @note By default, multi-selection is @b disabled on gengrids
6439     *
6440     * @see elm_gengrid_multi_select_get()
6441     *
6442     * @ingroup Gengrid
6443     */
6444    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6445
6446    /**
6447     * Get whether multi-selection is enabled or disabled for a given
6448     * gengrid widget
6449     *
6450     * @param obj The gengrid object.
6451     * @return @c EINA_TRUE, if multi-selection is enabled, @c
6452     * EINA_FALSE otherwise
6453     *
6454     * @see elm_gengrid_multi_select_set() for more details
6455     *
6456     * @ingroup Gengrid
6457     */
6458    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6459
6460    /**
6461     * Enable or disable bouncing effect for a given gengrid widget
6462     *
6463     * @param obj The gengrid object
6464     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6465     * @c EINA_FALSE to disable it
6466     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6467     * @c EINA_FALSE to disable it
6468     *
6469     * The bouncing effect occurs whenever one reaches the gengrid's
6470     * edge's while panning it -- it will scroll past its limits a
6471     * little bit and return to the edge again, in a animated for,
6472     * automatically.
6473     *
6474     * @note By default, gengrids have bouncing enabled on both axis
6475     *
6476     * @see elm_gengrid_bounce_get()
6477     *
6478     * @ingroup Gengrid
6479     */
6480    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6481
6482    /**
6483     * Get whether bouncing effects are enabled or disabled, for a
6484     * given gengrid widget, on each axis
6485     *
6486     * @param obj The gengrid object
6487     * @param h_bounce Pointer to a variable where to store the
6488     * horizontal bouncing flag.
6489     * @param v_bounce Pointer to a variable where to store the
6490     * vertical bouncing flag.
6491     *
6492     * @see elm_gengrid_bounce_set() for more details
6493     *
6494     * @ingroup Gengrid
6495     */
6496    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6497
6498    /**
6499     * Set a given gengrid widget's scrolling page size, relative to
6500     * its viewport size.
6501     *
6502     * @param obj The gengrid object
6503     * @param h_pagerel The horizontal page (relative) size
6504     * @param v_pagerel The vertical page (relative) size
6505     *
6506     * The gengrid's scroller is capable of binding scrolling by the
6507     * user to "pages". It means that, while scrolling and, specially
6508     * after releasing the mouse button, the grid will @b snap to the
6509     * nearest displaying page's area. When page sizes are set, the
6510     * grid's continuous content area is split into (equal) page sized
6511     * pieces.
6512     *
6513     * This function sets the size of a page <b>relatively to the
6514     * viewport dimensions</b> of the gengrid, for each axis. A value
6515     * @c 1.0 means "the exact viewport's size", in that axis, while @c
6516     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6517     * a viewport". Sane usable values are, than, between @c 0.0 and @c
6518     * 1.0. Values beyond those will make it behave behave
6519     * inconsistently. If you only want one axis to snap to pages, use
6520     * the value @c 0.0 for the other one.
6521     *
6522     * There is a function setting page size values in @b absolute
6523     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6524     * is mutually exclusive to this one.
6525     *
6526     * @see elm_gengrid_page_relative_get()
6527     *
6528     * @ingroup Gengrid
6529     */
6530    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6531
6532    /**
6533     * Get a given gengrid widget's scrolling page size, relative to
6534     * its viewport size.
6535     *
6536     * @param obj The gengrid object
6537     * @param h_pagerel Pointer to a variable where to store the
6538     * horizontal page (relative) size
6539     * @param v_pagerel Pointer to a variable where to store the
6540     * vertical page (relative) size
6541     *
6542     * @see elm_gengrid_page_relative_set() for more details
6543     *
6544     * @ingroup Gengrid
6545     */
6546    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6547
6548    /**
6549     * Set a given gengrid widget's scrolling page size
6550     *
6551     * @param obj The gengrid object
6552     * @param h_pagerel The horizontal page size, in pixels
6553     * @param v_pagerel The vertical page size, in pixels
6554     *
6555     * The gengrid's scroller is capable of binding scrolling by the
6556     * user to "pages". It means that, while scrolling and, specially
6557     * after releasing the mouse button, the grid will @b snap to the
6558     * nearest displaying page's area. When page sizes are set, the
6559     * grid's continuous content area is split into (equal) page sized
6560     * pieces.
6561     *
6562     * This function sets the size of a page of the gengrid, in pixels,
6563     * for each axis. Sane usable values are, between @c 0 and the
6564     * dimensions of @p obj, for each axis. Values beyond those will
6565     * make it behave behave inconsistently. If you only want one axis
6566     * to snap to pages, use the value @c 0 for the other one.
6567     *
6568     * There is a function setting page size values in @b relative
6569     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6570     * use is mutually exclusive to this one.
6571     *
6572     * @ingroup Gengrid
6573     */
6574    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6575
6576    /**
6577     * Set for what direction a given gengrid widget will expand while
6578     * placing its items.
6579     *
6580     * @param obj The gengrid object.
6581     * @param setting @c EINA_TRUE to make the gengrid expand
6582     * horizontally, @c EINA_FALSE to expand vertically.
6583     *
6584     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6585     * in @b columns, from top to bottom and, when the space for a
6586     * column is filled, another one is started on the right, thus
6587     * expanding the grid horizontally. When in "vertical mode"
6588     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6589     * to right and, when the space for a row is filled, another one is
6590     * started below, thus expanding the grid vertically.
6591     *
6592     * @see elm_gengrid_horizontal_get()
6593     *
6594     * @ingroup Gengrid
6595     */
6596    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6597
6598    /**
6599     * Get for what direction a given gengrid widget will expand while
6600     * placing its items.
6601     *
6602     * @param obj The gengrid object.
6603     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6604     * @c EINA_FALSE if it's set to expand vertically.
6605     *
6606     * @see elm_gengrid_horizontal_set() for more detais
6607     *
6608     * @ingroup Gengrid
6609     */
6610    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6611
6612    /**
6613     * Get the first item in a given gengrid widget
6614     *
6615     * @param obj The gengrid object
6616     * @return The first item's handle or @c NULL, if there are no
6617     * items in @p obj (and on errors)
6618     *
6619     * This returns the first item in the @p obj's internal list of
6620     * items.
6621     *
6622     * @see elm_gengrid_last_item_get()
6623     *
6624     * @ingroup Gengrid
6625     */
6626    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6627
6628    /**
6629     * Get the last item in a given gengrid widget
6630     *
6631     * @param obj The gengrid object
6632     * @return The last item's handle or @c NULL, if there are no
6633     * items in @p obj (and on errors)
6634     *
6635     * This returns the last item in the @p obj's internal list of
6636     * items.
6637     *
6638     * @see elm_gengrid_first_item_get()
6639     *
6640     * @ingroup Gengrid
6641     */
6642    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6643
6644    /**
6645     * Get the @b next item in a gengrid widget's internal list of items,
6646     * given a handle to one of those items.
6647     *
6648     * @param item The gengrid item to fetch next from
6649     * @return The item after @p item, or @c NULL if there's none (and
6650     * on errors)
6651     *
6652     * This returns the item placed after the @p item, on the container
6653     * gengrid.
6654     *
6655     * @see elm_gengrid_item_prev_get()
6656     *
6657     * @ingroup Gengrid
6658     */
6659    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6660
6661    /**
6662     * Get the @b previous item in a gengrid widget's internal list of items,
6663     * given a handle to one of those items.
6664     *
6665     * @param item The gengrid item to fetch previous from
6666     * @return The item before @p item, or @c NULL if there's none (and
6667     * on errors)
6668     *
6669     * This returns the item placed before the @p item, on the container
6670     * gengrid.
6671     *
6672     * @see elm_gengrid_item_next_get()
6673     *
6674     * @ingroup Gengrid
6675     */
6676    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6677
6678    /**
6679     * Get the gengrid object's handle which contains a given gengrid
6680     * item
6681     *
6682     * @param item The item to fetch the container from
6683     * @return The gengrid (parent) object
6684     *
6685     * This returns the gengrid object itself that an item belongs to.
6686     *
6687     * @ingroup Gengrid
6688     */
6689    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6690
6691    /**
6692     * Remove a gengrid item from the its parent, deleting it.
6693     *
6694     * @param item The item to be removed.
6695     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6696     *
6697     * @see elm_gengrid_clear(), to remove all items in a gengrid at
6698     * once.
6699     *
6700     * @ingroup Gengrid
6701     */
6702    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6703
6704    /**
6705     * Update the contents of a given gengrid item
6706     *
6707     * @param item The gengrid item
6708     *
6709     * This updates an item by calling all the item class functions
6710     * again to get the icons, labels and states. Use this when the
6711     * original item data has changed and you want thta changes to be
6712     * reflected.
6713     *
6714     * @ingroup Gengrid
6715     */
6716    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6717    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6718    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6719
6720    /**
6721     * Return the data associated to a given gengrid item
6722     *
6723     * @param item The gengrid item.
6724     * @return the data associated to this item.
6725     *
6726     * This returns the @c data value passed on the
6727     * elm_gengrid_item_append() and related item addition calls.
6728     *
6729     * @see elm_gengrid_item_append()
6730     * @see elm_gengrid_item_data_set()
6731     *
6732     * @ingroup Gengrid
6733     */
6734    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6735
6736    /**
6737     * Set the data associated to a given gengrid item
6738     *
6739     * @param item The gengrid item
6740     * @param data The new data pointer to set on it
6741     *
6742     * This @b overrides the @c data value passed on the
6743     * elm_gengrid_item_append() and related item addition calls. This
6744     * function @b won't call elm_gengrid_item_update() automatically,
6745     * so you'd issue it afterwards if you want to hove the item
6746     * updated to reflect the that new data.
6747     *
6748     * @see elm_gengrid_item_data_get()
6749     *
6750     * @ingroup Gengrid
6751     */
6752    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6753
6754    /**
6755     * Get a given gengrid item's position, relative to the whole
6756     * gengrid's grid area.
6757     *
6758     * @param item The Gengrid item.
6759     * @param x Pointer to variable where to store the item's <b>row
6760     * number</b>.
6761     * @param y Pointer to variable where to store the item's <b>column
6762     * number</b>.
6763     *
6764     * This returns the "logical" position of the item whithin the
6765     * gengrid. For example, @c (0, 1) would stand for first row,
6766     * second column.
6767     *
6768     * @ingroup Gengrid
6769     */
6770    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6771
6772    /**
6773     * Set whether a given gengrid item is selected or not
6774     *
6775     * @param item The gengrid item
6776     * @param selected Use @c EINA_TRUE, to make it selected, @c
6777     * EINA_FALSE to make it unselected
6778     *
6779     * This sets the selected state of an item. If multi selection is
6780     * not enabled on the containing gengrid and @p selected is @c
6781     * EINA_TRUE, any other previously selected items will get
6782     * unselected in favor of this new one.
6783     *
6784     * @see elm_gengrid_item_selected_get()
6785     *
6786     * @ingroup Gengrid
6787     */
6788    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6789
6790    /**
6791     * Get whether a given gengrid item is selected or not
6792     *
6793     * @param item The gengrid item
6794     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6795     *
6796     * @see elm_gengrid_item_selected_set() for more details
6797     *
6798     * @ingroup Gengrid
6799     */
6800    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6801
6802    /**
6803     * Get the real Evas object created to implement the view of a
6804     * given gengrid item
6805     *
6806     * @param item The gengrid item.
6807     * @return the Evas object implementing this item's view.
6808     *
6809     * This returns the actual Evas object used to implement the
6810     * specified gengrid item's view. This may be @c NULL, as it may
6811     * not have been created or may have been deleted, at any time, by
6812     * the gengrid. <b>Do not modify this object</b> (move, resize,
6813     * show, hide, etc.), as the gengrid is controlling it. This
6814     * function is for querying, emitting custom signals or hooking
6815     * lower level callbacks for events on that object. Do not delete
6816     * this object under any circumstances.
6817     *
6818     * @see elm_gengrid_item_data_get()
6819     *
6820     * @ingroup Gengrid
6821     */
6822    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6823
6824    /**
6825     * Show the portion of a gengrid's internal grid containing a given
6826     * item, @b immediately.
6827     *
6828     * @param item The item to display
6829     *
6830     * This causes gengrid to @b redraw its viewport's contents to the
6831     * region contining the given @p item item, if it is not fully
6832     * visible.
6833     *
6834     * @see elm_gengrid_item_bring_in()
6835     *
6836     * @ingroup Gengrid
6837     */
6838    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6839
6840    /**
6841     * Animatedly bring in, to the visible are of a gengrid, a given
6842     * item on it.
6843     *
6844     * @param item The gengrid item to display
6845     *
6846     * This causes gengrig to jump to the given @p item item and show
6847     * it (by scrolling), if it is not fully visible. This will use
6848     * animation to do so and take a period of time to complete.
6849     *
6850     * @see elm_gengrid_item_show()
6851     *
6852     * @ingroup Gengrid
6853     */
6854    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6855
6856    /**
6857     * Set whether a given gengrid item is disabled or not.
6858     *
6859     * @param item The gengrid item
6860     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6861     * to enable it back.
6862     *
6863     * A disabled item cannot be selected or unselected. It will also
6864     * change its appearance, to signal the user it's disabled.
6865     *
6866     * @see elm_gengrid_item_disabled_get()
6867     *
6868     * @ingroup Gengrid
6869     */
6870    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6871
6872    /**
6873     * Get whether a given gengrid item is disabled or not.
6874     *
6875     * @param item The gengrid item
6876     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6877     * (and on errors).
6878     *
6879     * @see elm_gengrid_item_disabled_set() for more details
6880     *
6881     * @ingroup Gengrid
6882     */
6883    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6884
6885    /**
6886     * Set the text to be shown in a given gengrid item's tooltips.
6887     *
6888     * @param item The gengrid item
6889     * @param text The text to set in the content
6890     *
6891     * This call will setup the text to be used as tooltip to that item
6892     * (analogous to elm_object_tooltip_text_set(), but being item
6893     * tooltips with higher precedence than object tooltips). It can
6894     * have only one tooltip at a time, so any previous tooltip data
6895     * will get removed.
6896     *
6897     * @ingroup Gengrid
6898     */
6899    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6900
6901    /**
6902     * Set the content to be shown in a given gengrid item's tooltips
6903     *
6904     * @param item The gengrid item.
6905     * @param func The function returning the tooltip contents.
6906     * @param data What to provide to @a func as callback data/context.
6907     * @param del_cb Called when data is not needed anymore, either when
6908     *        another callback replaces @p func, the tooltip is unset with
6909     *        elm_gengrid_item_tooltip_unset() or the owner @p item
6910     *        dies. This callback receives as its first parameter the
6911     *        given @p data, being @c event_info the item handle.
6912     *
6913     * This call will setup the tooltip's contents to @p item
6914     * (analogous to elm_object_tooltip_content_cb_set(), but being
6915     * item tooltips with higher precedence than object tooltips). It
6916     * can have only one tooltip at a time, so any previous tooltip
6917     * content will get removed. @p func (with @p data) will be called
6918     * every time Elementary needs to show the tooltip and it should
6919     * return a valid Evas object, which will be fully managed by the
6920     * tooltip system, getting deleted when the tooltip is gone.
6921     *
6922     * @ingroup Gengrid
6923     */
6924    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);
6925
6926    /**
6927     * Unset a tooltip from a given gengrid item
6928     *
6929     * @param item gengrid item to remove a previously set tooltip from.
6930     *
6931     * This call removes any tooltip set on @p item. The callback
6932     * provided as @c del_cb to
6933     * elm_gengrid_item_tooltip_content_cb_set() will be called to
6934     * notify it is not used anymore (and have resources cleaned, if
6935     * need be).
6936     *
6937     * @see elm_gengrid_item_tooltip_content_cb_set()
6938     *
6939     * @ingroup Gengrid
6940     */
6941    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6942
6943    /**
6944     * Set a different @b style for a given gengrid item's tooltip.
6945     *
6946     * @param item gengrid item with tooltip set
6947     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6948     * "default", @c "transparent", etc)
6949     *
6950     * Tooltips can have <b>alternate styles</b> to be displayed on,
6951     * which are defined by the theme set on Elementary. This function
6952     * works analogously as elm_object_tooltip_style_set(), but here
6953     * applied only to gengrid item objects. The default style for
6954     * tooltips is @c "default".
6955     *
6956     * @note before you set a style you should define a tooltip with
6957     *       elm_gengrid_item_tooltip_content_cb_set() or
6958     *       elm_gengrid_item_tooltip_text_set()
6959     *
6960     * @see elm_gengrid_item_tooltip_style_get()
6961     *
6962     * @ingroup Gengrid
6963     */
6964    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6965
6966    /**
6967     * Get the style set a given gengrid item's tooltip.
6968     *
6969     * @param item gengrid item with tooltip already set on.
6970     * @return style the theme style in use, which defaults to
6971     *         "default". If the object does not have a tooltip set,
6972     *         then @c NULL is returned.
6973     *
6974     * @see elm_gengrid_item_tooltip_style_set() for more details
6975     *
6976     * @ingroup Gengrid
6977     */
6978    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6979    /**
6980     * @brief Disable size restrictions on an object's tooltip
6981     * @param item The tooltip's anchor object
6982     * @param disable If EINA_TRUE, size restrictions are disabled
6983     * @return EINA_FALSE on failure, EINA_TRUE on success
6984     *
6985     * This function allows a tooltip to expand beyond its parant window's canvas.
6986     * It will instead be limited only by the size of the display.
6987     */
6988    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6989    /**
6990     * @brief Retrieve size restriction state of an object's tooltip
6991     * @param item The tooltip's anchor object
6992     * @return If EINA_TRUE, size restrictions are disabled
6993     *
6994     * This function returns whether a tooltip is allowed to expand beyond
6995     * its parant window's canvas.
6996     * It will instead be limited only by the size of the display.
6997     */
6998    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6999    /**
7000     * Set the type of mouse pointer/cursor decoration to be shown,
7001     * when the mouse pointer is over the given gengrid widget item
7002     *
7003     * @param item gengrid item to customize cursor on
7004     * @param cursor the cursor type's name
7005     *
7006     * This function works analogously as elm_object_cursor_set(), but
7007     * here the cursor's changing area is restricted to the item's
7008     * area, and not the whole widget's. Note that that item cursors
7009     * have precedence over widget cursors, so that a mouse over @p
7010     * item will always show cursor @p type.
7011     *
7012     * If this function is called twice for an object, a previously set
7013     * cursor will be unset on the second call.
7014     *
7015     * @see elm_object_cursor_set()
7016     * @see elm_gengrid_item_cursor_get()
7017     * @see elm_gengrid_item_cursor_unset()
7018     *
7019     * @ingroup Gengrid
7020     */
7021    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7022
7023    /**
7024     * Get the type of mouse pointer/cursor decoration set to be shown,
7025     * when the mouse pointer is over the given gengrid widget item
7026     *
7027     * @param item gengrid item with custom cursor set
7028     * @return the cursor type's name or @c NULL, if no custom cursors
7029     * were set to @p item (and on errors)
7030     *
7031     * @see elm_object_cursor_get()
7032     * @see elm_gengrid_item_cursor_set() for more details
7033     * @see elm_gengrid_item_cursor_unset()
7034     *
7035     * @ingroup Gengrid
7036     */
7037    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7038
7039    /**
7040     * Unset any custom mouse pointer/cursor decoration set to be
7041     * shown, when the mouse pointer is over the given gengrid widget
7042     * item, thus making it show the @b default cursor again.
7043     *
7044     * @param item a gengrid item
7045     *
7046     * Use this call to undo any custom settings on this item's cursor
7047     * decoration, bringing it back to defaults (no custom style set).
7048     *
7049     * @see elm_object_cursor_unset()
7050     * @see elm_gengrid_item_cursor_set() for more details
7051     *
7052     * @ingroup Gengrid
7053     */
7054    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7055
7056    /**
7057     * Set a different @b style for a given custom cursor set for a
7058     * gengrid item.
7059     *
7060     * @param item gengrid item with custom cursor set
7061     * @param style the <b>theme style</b> to use (e.g. @c "default",
7062     * @c "transparent", etc)
7063     *
7064     * This function only makes sense when one is using custom mouse
7065     * cursor decorations <b>defined in a theme file</b> , which can
7066     * have, given a cursor name/type, <b>alternate styles</b> on
7067     * it. It works analogously as elm_object_cursor_style_set(), but
7068     * here applied only to gengrid item objects.
7069     *
7070     * @warning Before you set a cursor style you should have defined a
7071     *       custom cursor previously on the item, with
7072     *       elm_gengrid_item_cursor_set()
7073     *
7074     * @see elm_gengrid_item_cursor_engine_only_set()
7075     * @see elm_gengrid_item_cursor_style_get()
7076     *
7077     * @ingroup Gengrid
7078     */
7079    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
7080
7081    /**
7082     * Get the current @b style set for a given gengrid item's custom
7083     * cursor
7084     *
7085     * @param item gengrid item with custom cursor set.
7086     * @return style the cursor style in use. If the object does not
7087     *         have a cursor set, then @c NULL is returned.
7088     *
7089     * @see elm_gengrid_item_cursor_style_set() for more details
7090     *
7091     * @ingroup Gengrid
7092     */
7093    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7094
7095    /**
7096     * Set if the (custom) cursor for a given gengrid item should be
7097     * searched in its theme, also, or should only rely on the
7098     * rendering engine.
7099     *
7100     * @param item item with custom (custom) cursor already set on
7101     * @param engine_only Use @c EINA_TRUE to have cursors looked for
7102     * only on those provided by the rendering engine, @c EINA_FALSE to
7103     * have them searched on the widget's theme, as well.
7104     *
7105     * @note This call is of use only if you've set a custom cursor
7106     * for gengrid items, with elm_gengrid_item_cursor_set().
7107     *
7108     * @note By default, cursors will only be looked for between those
7109     * provided by the rendering engine.
7110     *
7111     * @ingroup Gengrid
7112     */
7113    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7114
7115    /**
7116     * Get if the (custom) cursor for a given gengrid item is being
7117     * searched in its theme, also, or is only relying on the rendering
7118     * engine.
7119     *
7120     * @param item a gengrid item
7121     * @return @c EINA_TRUE, if cursors are being looked for only on
7122     * those provided by the rendering engine, @c EINA_FALSE if they
7123     * are being searched on the widget's theme, as well.
7124     *
7125     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
7126     *
7127     * @ingroup Gengrid
7128     */
7129    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7130
7131    /**
7132     * Remove all items from a given gengrid widget
7133     *
7134     * @param obj The gengrid object.
7135     *
7136     * This removes (and deletes) all items in @p obj, leaving it
7137     * empty.
7138     *
7139     * @see elm_gengrid_item_del(), to remove just one item.
7140     *
7141     * @ingroup Gengrid
7142     */
7143    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7144
7145    /**
7146     * Get the selected item in a given gengrid widget
7147     *
7148     * @param obj The gengrid object.
7149     * @return The selected item's handleor @c NULL, if none is
7150     * selected at the moment (and on errors)
7151     *
7152     * This returns the selected item in @p obj. If multi selection is
7153     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
7154     * the first item in the list is selected, which might not be very
7155     * useful. For that case, see elm_gengrid_selected_items_get().
7156     *
7157     * @ingroup Gengrid
7158     */
7159    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7160
7161    /**
7162     * Get <b>a list</b> of selected items in a given gengrid
7163     *
7164     * @param obj The gengrid object.
7165     * @return The list of selected items or @c NULL, if none is
7166     * selected at the moment (and on errors)
7167     *
7168     * This returns a list of the selected items, in the order that
7169     * they appear in the grid. This list is only valid as long as no
7170     * more items are selected or unselected (or unselected implictly
7171     * by deletion). The list contains #Elm_Gengrid_Item pointers as
7172     * data, naturally.
7173     *
7174     * @see elm_gengrid_selected_item_get()
7175     *
7176     * @ingroup Gengrid
7177     */
7178    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7179
7180    /**
7181     * @}
7182     */
7183
7184    /**
7185     * @defgroup Clock Clock
7186     *
7187     * @image html img/widget/clock/preview-00.png
7188     * @image latex img/widget/clock/preview-00.eps
7189     *
7190     * This is a @b digital clock widget. In its default theme, it has a
7191     * vintage "flipping numbers clock" appearance, which will animate
7192     * sheets of individual algarisms individually as time goes by.
7193     *
7194     * A newly created clock will fetch system's time (already
7195     * considering local time adjustments) to start with, and will tick
7196     * accondingly. It may or may not show seconds.
7197     *
7198     * Clocks have an @b edition mode. When in it, the sheets will
7199     * display extra arrow indications on the top and bottom and the
7200     * user may click on them to raise or lower the time values. After
7201     * it's told to exit edition mode, it will keep ticking with that
7202     * new time set (it keeps the difference from local time).
7203     *
7204     * Also, when under edition mode, user clicks on the cited arrows
7205     * which are @b held for some time will make the clock to flip the
7206     * sheet, thus editing the time, continuosly and automatically for
7207     * the user. The interval between sheet flips will keep growing in
7208     * time, so that it helps the user to reach a time which is distant
7209     * from the one set.
7210     *
7211     * The time display is, by default, in military mode (24h), but an
7212     * am/pm indicator may be optionally shown, too, when it will
7213     * switch to 12h.
7214     *
7215     * Smart callbacks one can register to:
7216     * - "changed" - the clock's user changed the time
7217     *
7218     * Here is an example on its usage:
7219     * @li @ref clock_example
7220     */
7221
7222    /**
7223     * @addtogroup Clock
7224     * @{
7225     */
7226
7227    /**
7228     * Identifiers for which clock digits should be editable, when a
7229     * clock widget is in edition mode. Values may be ORed together to
7230     * make a mask, naturally.
7231     *
7232     * @see elm_clock_edit_set()
7233     * @see elm_clock_digit_edit_set()
7234     */
7235    typedef enum _Elm_Clock_Digedit
7236      {
7237         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
7238         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
7239         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
7240         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
7241         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
7242         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
7243         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
7244         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
7245      } Elm_Clock_Digedit;
7246
7247    /**
7248     * Add a new clock widget to the given parent Elementary
7249     * (container) object
7250     *
7251     * @param parent The parent object
7252     * @return a new clock widget handle or @c NULL, on errors
7253     *
7254     * This function inserts a new clock widget on the canvas.
7255     *
7256     * @ingroup Clock
7257     */
7258    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7259
7260    /**
7261     * Set a clock widget's time, programmatically
7262     *
7263     * @param obj The clock widget object
7264     * @param hrs The hours to set
7265     * @param min The minutes to set
7266     * @param sec The secondes to set
7267     *
7268     * This function updates the time that is showed by the clock
7269     * widget.
7270     *
7271     *  Values @b must be set within the following ranges:
7272     * - 0 - 23, for hours
7273     * - 0 - 59, for minutes
7274     * - 0 - 59, for seconds,
7275     *
7276     * even if the clock is not in "military" mode.
7277     *
7278     * @warning The behavior for values set out of those ranges is @b
7279     * indefined.
7280     *
7281     * @ingroup Clock
7282     */
7283    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7284
7285    /**
7286     * Get a clock widget's time values
7287     *
7288     * @param obj The clock object
7289     * @param[out] hrs Pointer to the variable to get the hours value
7290     * @param[out] min Pointer to the variable to get the minutes value
7291     * @param[out] sec Pointer to the variable to get the seconds value
7292     *
7293     * This function gets the time set for @p obj, returning
7294     * it on the variables passed as the arguments to function
7295     *
7296     * @note Use @c NULL pointers on the time values you're not
7297     * interested in: they'll be ignored by the function.
7298     *
7299     * @ingroup Clock
7300     */
7301    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7302
7303    /**
7304     * Set whether a given clock widget is under <b>edition mode</b> or
7305     * under (default) displaying-only mode.
7306     *
7307     * @param obj The clock object
7308     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7309     * put it back to "displaying only" mode
7310     *
7311     * This function makes a clock's time to be editable or not <b>by
7312     * user interaction</b>. When in edition mode, clocks @b stop
7313     * ticking, until one brings them back to canonical mode. The
7314     * elm_clock_digit_edit_set() function will influence which digits
7315     * of the clock will be editable. By default, all of them will be
7316     * (#ELM_CLOCK_NONE).
7317     *
7318     * @note am/pm sheets, if being shown, will @b always be editable
7319     * under edition mode.
7320     *
7321     * @see elm_clock_edit_get()
7322     *
7323     * @ingroup Clock
7324     */
7325    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7326
7327    /**
7328     * Retrieve whether a given clock widget is under <b>edition
7329     * mode</b> or under (default) displaying-only mode.
7330     *
7331     * @param obj The clock object
7332     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7333     * otherwise
7334     *
7335     * This function retrieves whether the clock's time can be edited
7336     * or not by user interaction.
7337     *
7338     * @see elm_clock_edit_set() for more details
7339     *
7340     * @ingroup Clock
7341     */
7342    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7343
7344    /**
7345     * Set what digits of the given clock widget should be editable
7346     * when in edition mode.
7347     *
7348     * @param obj The clock object
7349     * @param digedit Bit mask indicating the digits to be editable
7350     * (values in #Elm_Clock_Digedit).
7351     *
7352     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7353     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7354     * EINA_FALSE).
7355     *
7356     * @see elm_clock_digit_edit_get()
7357     *
7358     * @ingroup Clock
7359     */
7360    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7361
7362    /**
7363     * Retrieve what digits of the given clock widget should be
7364     * editable when in edition mode.
7365     *
7366     * @param obj The clock object
7367     * @return Bit mask indicating the digits to be editable
7368     * (values in #Elm_Clock_Digedit).
7369     *
7370     * @see elm_clock_digit_edit_set() for more details
7371     *
7372     * @ingroup Clock
7373     */
7374    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7375
7376    /**
7377     * Set if the given clock widget must show hours in military or
7378     * am/pm mode
7379     *
7380     * @param obj The clock object
7381     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7382     * to military mode
7383     *
7384     * This function sets if the clock must show hours in military or
7385     * am/pm mode. In some countries like Brazil the military mode
7386     * (00-24h-format) is used, in opposition to the USA, where the
7387     * am/pm mode is more commonly used.
7388     *
7389     * @see elm_clock_show_am_pm_get()
7390     *
7391     * @ingroup Clock
7392     */
7393    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7394
7395    /**
7396     * Get if the given clock widget shows hours in military or am/pm
7397     * mode
7398     *
7399     * @param obj The clock object
7400     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7401     * military
7402     *
7403     * This function gets if the clock shows hours in military or am/pm
7404     * mode.
7405     *
7406     * @see elm_clock_show_am_pm_set() for more details
7407     *
7408     * @ingroup Clock
7409     */
7410    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7411
7412    /**
7413     * Set if the given clock widget must show time with seconds or not
7414     *
7415     * @param obj The clock object
7416     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7417     *
7418     * This function sets if the given clock must show or not elapsed
7419     * seconds. By default, they are @b not shown.
7420     *
7421     * @see elm_clock_show_seconds_get()
7422     *
7423     * @ingroup Clock
7424     */
7425    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7426
7427    /**
7428     * Get whether the given clock widget is showing time with seconds
7429     * or not
7430     *
7431     * @param obj The clock object
7432     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7433     *
7434     * This function gets whether @p obj is showing or not the elapsed
7435     * seconds.
7436     *
7437     * @see elm_clock_show_seconds_set()
7438     *
7439     * @ingroup Clock
7440     */
7441    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7442
7443    /**
7444     * Set the interval on time updates for an user mouse button hold
7445     * on clock widgets' time edition.
7446     *
7447     * @param obj The clock object
7448     * @param interval The (first) interval value in seconds
7449     *
7450     * This interval value is @b decreased while the user holds the
7451     * mouse pointer either incrementing or decrementing a given the
7452     * clock digit's value.
7453     *
7454     * This helps the user to get to a given time distant from the
7455     * current one easier/faster, as it will start to flip quicker and
7456     * quicker on mouse button holds.
7457     *
7458     * The calculation for the next flip interval value, starting from
7459     * the one set with this call, is the previous interval divided by
7460     * 1.05, so it decreases a little bit.
7461     *
7462     * The default starting interval value for automatic flips is
7463     * @b 0.85 seconds.
7464     *
7465     * @see elm_clock_interval_get()
7466     *
7467     * @ingroup Clock
7468     */
7469    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7470
7471    /**
7472     * Get the interval on time updates for an user mouse button hold
7473     * on clock widgets' time edition.
7474     *
7475     * @param obj The clock object
7476     * @return The (first) interval value, in seconds, set on it
7477     *
7478     * @see elm_clock_interval_set() for more details
7479     *
7480     * @ingroup Clock
7481     */
7482    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7483
7484    /**
7485     * @}
7486     */
7487
7488    /**
7489     * @defgroup Layout Layout
7490     *
7491     * @image html img/widget/layout/preview-00.png
7492     * @image latex img/widget/layout/preview-00.eps width=\textwidth
7493     *
7494     * @image html img/layout-predefined.png
7495     * @image latex img/layout-predefined.eps width=\textwidth
7496     *
7497     * This is a container widget that takes a standard Edje design file and
7498     * wraps it very thinly in a widget.
7499     *
7500     * An Edje design (theme) file has a very wide range of possibilities to
7501     * describe the behavior of elements added to the Layout. Check out the Edje
7502     * documentation and the EDC reference to get more information about what can
7503     * be done with Edje.
7504     *
7505     * Just like @ref List, @ref Box, and other container widgets, any
7506     * object added to the Layout will become its child, meaning that it will be
7507     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7508     *
7509     * The Layout widget can contain as many Contents, Boxes or Tables as
7510     * described in its theme file. For instance, objects can be added to
7511     * different Tables by specifying the respective Table part names. The same
7512     * is valid for Content and Box.
7513     *
7514     * The objects added as child of the Layout will behave as described in the
7515     * part description where they were added. There are 3 possible types of
7516     * parts where a child can be added:
7517     *
7518     * @section secContent Content (SWALLOW part)
7519     *
7520     * Only one object can be added to the @c SWALLOW part (but you still can
7521     * have many @c SWALLOW parts and one object on each of them). Use the @c
7522     * elm_layout_content_* set of functions to set, retrieve and unset objects
7523     * as content of the @c SWALLOW. After being set to this part, the object
7524     * size, position, visibility, clipping and other description properties
7525     * will be totally controled by the description of the given part (inside
7526     * the Edje theme file).
7527     *
7528     * One can use @c evas_object_size_hint_* functions on the child to have some
7529     * kind of control over its behavior, but the resulting behavior will still
7530     * depend heavily on the @c SWALLOW part description.
7531     *
7532     * The Edje theme also can change the part description, based on signals or
7533     * scripts running inside the theme. This change can also be animated. All of
7534     * this will affect the child object set as content accordingly. The object
7535     * size will be changed if the part size is changed, it will animate move if
7536     * the part is moving, and so on.
7537     *
7538     * The following picture demonstrates a Layout widget with a child object
7539     * added to its @c SWALLOW:
7540     *
7541     * @image html layout_swallow.png
7542     * @image latex layout_swallow.eps width=\textwidth
7543     *
7544     * @section secBox Box (BOX part)
7545     *
7546     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7547     * allows one to add objects to the box and have them distributed along its
7548     * area, accordingly to the specified @a layout property (now by @a layout we
7549     * mean the chosen layouting design of the Box, not the Layout widget
7550     * itself).
7551     *
7552     * A similar effect for having a box with its position, size and other things
7553     * controled by the Layout theme would be to create an Elementary @ref Box
7554     * widget and add it as a Content in the @c SWALLOW part.
7555     *
7556     * The main difference of using the Layout Box is that its behavior, the box
7557     * properties like layouting format, padding, align, etc. will be all
7558     * controled by the theme. This means, for example, that a signal could be
7559     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7560     * handled the signal by changing the box padding, or align, or both. Using
7561     * the Elementary @ref Box widget is not necessarily harder or easier, it
7562     * just depends on the circunstances and requirements.
7563     *
7564     * The Layout Box can be used through the @c elm_layout_box_* set of
7565     * functions.
7566     *
7567     * The following picture demonstrates a Layout widget with many child objects
7568     * added to its @c BOX part:
7569     *
7570     * @image html layout_box.png
7571     * @image latex layout_box.eps width=\textwidth
7572     *
7573     * @section secTable Table (TABLE part)
7574     *
7575     * Just like the @ref secBox, the Layout Table is very similar to the
7576     * Elementary @ref Table widget. It allows one to add objects to the Table
7577     * specifying the row and column where the object should be added, and any
7578     * column or row span if necessary.
7579     *
7580     * Again, we could have this design by adding a @ref Table widget to the @c
7581     * SWALLOW part using elm_layout_content_set(). The same difference happens
7582     * here when choosing to use the Layout Table (a @c TABLE part) instead of
7583     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7584     *
7585     * The Layout Table can be used through the @c elm_layout_table_* set of
7586     * functions.
7587     *
7588     * The following picture demonstrates a Layout widget with many child objects
7589     * added to its @c TABLE part:
7590     *
7591     * @image html layout_table.png
7592     * @image latex layout_table.eps width=\textwidth
7593     *
7594     * @section secPredef Predefined Layouts
7595     *
7596     * Another interesting thing about the Layout widget is that it offers some
7597     * predefined themes that come with the default Elementary theme. These
7598     * themes can be set by the call elm_layout_theme_set(), and provide some
7599     * basic functionality depending on the theme used.
7600     *
7601     * Most of them already send some signals, some already provide a toolbar or
7602     * back and next buttons.
7603     *
7604     * These are available predefined theme layouts. All of them have class = @c
7605     * layout, group = @c application, and style = one of the following options:
7606     *
7607     * @li @c toolbar-content - application with toolbar and main content area
7608     * @li @c toolbar-content-back - application with toolbar and main content
7609     * area with a back button and title area
7610     * @li @c toolbar-content-back-next - application with toolbar and main
7611     * content area with a back and next buttons and title area
7612     * @li @c content-back - application with a main content area with a back
7613     * button and title area
7614     * @li @c content-back-next - application with a main content area with a
7615     * back and next buttons and title area
7616     * @li @c toolbar-vbox - application with toolbar and main content area as a
7617     * vertical box
7618     * @li @c toolbar-table - application with toolbar and main content area as a
7619     * table
7620     *
7621     * @section secExamples Examples
7622     *
7623     * Some examples of the Layout widget can be found here:
7624     * @li @ref layout_example_01
7625     * @li @ref layout_example_02
7626     * @li @ref layout_example_03
7627     * @li @ref layout_example_edc
7628     *
7629     */
7630
7631    /**
7632     * Add a new layout to the parent
7633     *
7634     * @param parent The parent object
7635     * @return The new object or NULL if it cannot be created
7636     *
7637     * @see elm_layout_file_set()
7638     * @see elm_layout_theme_set()
7639     *
7640     * @ingroup Layout
7641     */
7642    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7643    /**
7644     * Set the file that will be used as layout
7645     *
7646     * @param obj The layout object
7647     * @param file The path to file (edj) that will be used as layout
7648     * @param group The group that the layout belongs in edje file
7649     *
7650     * @return (1 = success, 0 = error)
7651     *
7652     * @ingroup Layout
7653     */
7654    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7655    /**
7656     * Set the edje group from the elementary theme that will be used as layout
7657     *
7658     * @param obj The layout object
7659     * @param clas the clas of the group
7660     * @param group the group
7661     * @param style the style to used
7662     *
7663     * @return (1 = success, 0 = error)
7664     *
7665     * @ingroup Layout
7666     */
7667    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7668    /**
7669     * Set the layout content.
7670     *
7671     * @param obj The layout object
7672     * @param swallow The swallow part name in the edje file
7673     * @param content The child that will be added in this layout object
7674     *
7675     * Once the content object is set, a previously set one will be deleted.
7676     * If you want to keep that old content object, use the
7677     * elm_layout_content_unset() function.
7678     *
7679     * @note In an Edje theme, the part used as a content container is called @c
7680     * SWALLOW. This is why the parameter name is called @p swallow, but it is
7681     * expected to be a part name just like the second parameter of
7682     * elm_layout_box_append().
7683     *
7684     * @see elm_layout_box_append()
7685     * @see elm_layout_content_get()
7686     * @see elm_layout_content_unset()
7687     * @see @ref secBox
7688     *
7689     * @ingroup Layout
7690     */
7691    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7692    /**
7693     * Get the child object in the given content part.
7694     *
7695     * @param obj The layout object
7696     * @param swallow The SWALLOW part to get its content
7697     *
7698     * @return The swallowed object or NULL if none or an error occurred
7699     *
7700     * @see elm_layout_content_set()
7701     *
7702     * @ingroup Layout
7703     */
7704    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7705    /**
7706     * Unset the layout content.
7707     *
7708     * @param obj The layout object
7709     * @param swallow The swallow part name in the edje file
7710     * @return The content that was being used
7711     *
7712     * Unparent and return the content object which was set for this part.
7713     *
7714     * @see elm_layout_content_set()
7715     *
7716     * @ingroup Layout
7717     */
7718     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7719    /**
7720     * Set the text of the given part
7721     *
7722     * @param obj The layout object
7723     * @param part The TEXT part where to set the text
7724     * @param text The text to set
7725     *
7726     * @ingroup Layout
7727     * @deprecated use elm_object_text_* instead.
7728     */
7729    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7730    /**
7731     * Get the text set in the given part
7732     *
7733     * @param obj The layout object
7734     * @param part The TEXT part to retrieve the text off
7735     *
7736     * @return The text set in @p part
7737     *
7738     * @ingroup Layout
7739     * @deprecated use elm_object_text_* instead.
7740     */
7741    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7742    /**
7743     * Append child to layout box part.
7744     *
7745     * @param obj the layout object
7746     * @param part the box part to which the object will be appended.
7747     * @param child the child object to append to box.
7748     *
7749     * Once the object is appended, it will become child of the layout. Its
7750     * lifetime will be bound to the layout, whenever the layout dies the child
7751     * will be deleted automatically. One should use elm_layout_box_remove() to
7752     * make this layout forget about the object.
7753     *
7754     * @see elm_layout_box_prepend()
7755     * @see elm_layout_box_insert_before()
7756     * @see elm_layout_box_insert_at()
7757     * @see elm_layout_box_remove()
7758     *
7759     * @ingroup Layout
7760     */
7761    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7762    /**
7763     * Prepend child to layout box part.
7764     *
7765     * @param obj the layout object
7766     * @param part the box part to prepend.
7767     * @param child the child object to prepend to box.
7768     *
7769     * Once the object is prepended, it will become child of the layout. Its
7770     * lifetime will be bound to the layout, whenever the layout dies the child
7771     * will be deleted automatically. One should use elm_layout_box_remove() to
7772     * make this layout forget about the object.
7773     *
7774     * @see elm_layout_box_append()
7775     * @see elm_layout_box_insert_before()
7776     * @see elm_layout_box_insert_at()
7777     * @see elm_layout_box_remove()
7778     *
7779     * @ingroup Layout
7780     */
7781    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7782    /**
7783     * Insert child to layout box part before a reference object.
7784     *
7785     * @param obj the layout object
7786     * @param part the box part to insert.
7787     * @param child the child object to insert into box.
7788     * @param reference another reference object to insert before in box.
7789     *
7790     * Once the object is inserted, it will become child of the layout. Its
7791     * lifetime will be bound to the layout, whenever the layout dies the child
7792     * will be deleted automatically. One should use elm_layout_box_remove() to
7793     * make this layout forget about the object.
7794     *
7795     * @see elm_layout_box_append()
7796     * @see elm_layout_box_prepend()
7797     * @see elm_layout_box_insert_before()
7798     * @see elm_layout_box_remove()
7799     *
7800     * @ingroup Layout
7801     */
7802    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7803    /**
7804     * Insert child to layout box part at a given position.
7805     *
7806     * @param obj the layout object
7807     * @param part the box part to insert.
7808     * @param child the child object to insert into box.
7809     * @param pos the numeric position >=0 to insert the child.
7810     *
7811     * Once the object is inserted, it will become child of the layout. Its
7812     * lifetime will be bound to the layout, whenever the layout dies the child
7813     * will be deleted automatically. One should use elm_layout_box_remove() to
7814     * make this layout forget about the object.
7815     *
7816     * @see elm_layout_box_append()
7817     * @see elm_layout_box_prepend()
7818     * @see elm_layout_box_insert_before()
7819     * @see elm_layout_box_remove()
7820     *
7821     * @ingroup Layout
7822     */
7823    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7824    /**
7825     * Remove a child of the given part box.
7826     *
7827     * @param obj The layout object
7828     * @param part The box part name to remove child.
7829     * @param child The object to remove from box.
7830     * @return The object that was being used, or NULL if not found.
7831     *
7832     * The object will be removed from the box part and its lifetime will
7833     * not be handled by the layout anymore. This is equivalent to
7834     * elm_layout_content_unset() for box.
7835     *
7836     * @see elm_layout_box_append()
7837     * @see elm_layout_box_remove_all()
7838     *
7839     * @ingroup Layout
7840     */
7841    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7842    /**
7843     * Remove all child of the given part box.
7844     *
7845     * @param obj The layout object
7846     * @param part The box part name to remove child.
7847     * @param clear If EINA_TRUE, then all objects will be deleted as
7848     *        well, otherwise they will just be removed and will be
7849     *        dangling on the canvas.
7850     *
7851     * The objects will be removed from the box part and their lifetime will
7852     * not be handled by the layout anymore. This is equivalent to
7853     * elm_layout_box_remove() for all box children.
7854     *
7855     * @see elm_layout_box_append()
7856     * @see elm_layout_box_remove()
7857     *
7858     * @ingroup Layout
7859     */
7860    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7861    /**
7862     * Insert child to layout table part.
7863     *
7864     * @param obj the layout object
7865     * @param part the box part to pack child.
7866     * @param child_obj the child object to pack into table.
7867     * @param col the column to which the child should be added. (>= 0)
7868     * @param row the row to which the child should be added. (>= 0)
7869     * @param colspan how many columns should be used to store this object. (>=
7870     *        1)
7871     * @param rowspan how many rows should be used to store this object. (>= 1)
7872     *
7873     * Once the object is inserted, it will become child of the table. Its
7874     * lifetime will be bound to the layout, and whenever the layout dies the
7875     * child will be deleted automatically. One should use
7876     * elm_layout_table_remove() to make this layout forget about the object.
7877     *
7878     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7879     * more space than a single cell. For instance, the following code:
7880     * @code
7881     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7882     * @endcode
7883     *
7884     * Would result in an object being added like the following picture:
7885     *
7886     * @image html layout_colspan.png
7887     * @image latex layout_colspan.eps width=\textwidth
7888     *
7889     * @see elm_layout_table_unpack()
7890     * @see elm_layout_table_clear()
7891     *
7892     * @ingroup Layout
7893     */
7894    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);
7895    /**
7896     * Unpack (remove) a child of the given part table.
7897     *
7898     * @param obj The layout object
7899     * @param part The table part name to remove child.
7900     * @param child_obj The object to remove from table.
7901     * @return The object that was being used, or NULL if not found.
7902     *
7903     * The object will be unpacked from the table part and its lifetime
7904     * will not be handled by the layout anymore. This is equivalent to
7905     * elm_layout_content_unset() for table.
7906     *
7907     * @see elm_layout_table_pack()
7908     * @see elm_layout_table_clear()
7909     *
7910     * @ingroup Layout
7911     */
7912    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7913    /**
7914     * Remove all child of the given part table.
7915     *
7916     * @param obj The layout object
7917     * @param part The table part name to remove child.
7918     * @param clear If EINA_TRUE, then all objects will be deleted as
7919     *        well, otherwise they will just be removed and will be
7920     *        dangling on the canvas.
7921     *
7922     * The objects will be removed from the table part and their lifetime will
7923     * not be handled by the layout anymore. This is equivalent to
7924     * elm_layout_table_unpack() for all table children.
7925     *
7926     * @see elm_layout_table_pack()
7927     * @see elm_layout_table_unpack()
7928     *
7929     * @ingroup Layout
7930     */
7931    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7932    /**
7933     * Get the edje layout
7934     *
7935     * @param obj The layout object
7936     *
7937     * @return A Evas_Object with the edje layout settings loaded
7938     * with function elm_layout_file_set
7939     *
7940     * This returns the edje object. It is not expected to be used to then
7941     * swallow objects via edje_object_part_swallow() for example. Use
7942     * elm_layout_content_set() instead so child object handling and sizing is
7943     * done properly.
7944     *
7945     * @note This function should only be used if you really need to call some
7946     * low level Edje function on this edje object. All the common stuff (setting
7947     * text, emitting signals, hooking callbacks to signals, etc.) can be done
7948     * with proper elementary functions.
7949     *
7950     * @see elm_object_signal_callback_add()
7951     * @see elm_object_signal_emit()
7952     * @see elm_object_text_part_set()
7953     * @see elm_layout_content_set()
7954     * @see elm_layout_box_append()
7955     * @see elm_layout_table_pack()
7956     * @see elm_layout_data_get()
7957     *
7958     * @ingroup Layout
7959     */
7960    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7961    /**
7962     * Get the edje data from the given layout
7963     *
7964     * @param obj The layout object
7965     * @param key The data key
7966     *
7967     * @return The edje data string
7968     *
7969     * This function fetches data specified inside the edje theme of this layout.
7970     * This function return NULL if data is not found.
7971     *
7972     * In EDC this comes from a data block within the group block that @p
7973     * obj was loaded from. E.g.
7974     *
7975     * @code
7976     * collections {
7977     *   group {
7978     *     name: "a_group";
7979     *     data {
7980     *       item: "key1" "value1";
7981     *       item: "key2" "value2";
7982     *     }
7983     *   }
7984     * }
7985     * @endcode
7986     *
7987     * @ingroup Layout
7988     */
7989    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7990    /**
7991     * Eval sizing
7992     *
7993     * @param obj The layout object
7994     *
7995     * Manually forces a sizing re-evaluation. This is useful when the minimum
7996     * size required by the edje theme of this layout has changed. The change on
7997     * the minimum size required by the edje theme is not immediately reported to
7998     * the elementary layout, so one needs to call this function in order to tell
7999     * the widget (layout) that it needs to reevaluate its own size.
8000     *
8001     * The minimum size of the theme is calculated based on minimum size of
8002     * parts, the size of elements inside containers like box and table, etc. All
8003     * of this can change due to state changes, and that's when this function
8004     * should be called.
8005     *
8006     * Also note that a standard signal of "size,eval" "elm" emitted from the
8007     * edje object will cause this to happen too.
8008     *
8009     * @ingroup Layout
8010     */
8011    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
8012    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
8013    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
8014    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
8015    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
8016    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
8017    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);
8018    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
8019 /**
8020  * @def elm_layout_icon_set
8021  * Convienience macro to set the icon object in a layout that follows the
8022  * Elementary naming convention for its parts.
8023  *
8024  * @ingroup Layout
8025  */
8026 #define elm_layout_icon_set(_ly, _obj) \
8027   do { \
8028     const char *sig; \
8029     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
8030     if ((_obj)) sig = "elm,state,icon,visible"; \
8031     else sig = "elm,state,icon,hidden"; \
8032     elm_object_signal_emit((_ly), sig, "elm"); \
8033   } while (0)
8034
8035 /**
8036  * @def elm_layout_icon_get
8037  * Convienience macro to get the icon object from a layout that follows the
8038  * Elementary naming convention for its parts.
8039  *
8040  * @ingroup Layout
8041  */
8042 #define elm_layout_icon_get(_ly) \
8043   elm_layout_content_get((_ly), "elm.swallow.icon")
8044
8045 /**
8046  * @def elm_layout_end_set
8047  * Convienience macro to set the end object in a layout that follows the
8048  * Elementary naming convention for its parts.
8049  *
8050  * @ingroup Layout
8051  */
8052 #define elm_layout_end_set(_ly, _obj) \
8053   do { \
8054     const char *sig; \
8055     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
8056     if ((_obj)) sig = "elm,state,end,visible"; \
8057     else sig = "elm,state,end,hidden"; \
8058     elm_object_signal_emit((_ly), sig, "elm"); \
8059   } while (0)
8060
8061 /**
8062  * @def elm_layout_end_get
8063  * Convienience macro to get the end object in a layout that follows the
8064  * Elementary naming convention for its parts.
8065  *
8066  * @ingroup Layout
8067  */
8068 #define elm_layout_end_get(_ly) \
8069   elm_layout_content_get((_ly), "elm.swallow.end")
8070
8071 /**
8072  * @def elm_layout_label_set
8073  * Convienience macro to set the label in a layout that follows the
8074  * Elementary naming convention for its parts.
8075  *
8076  * @ingroup Layout
8077  * @deprecated use elm_object_text_* instead.
8078  */
8079 #define elm_layout_label_set(_ly, _txt) \
8080   elm_layout_text_set((_ly), "elm.text", (_txt))
8081
8082 /**
8083  * @def elm_layout_label_get
8084  * Convienience macro to get the label in a layout that follows the
8085  * Elementary naming convention for its parts.
8086  *
8087  * @ingroup Layout
8088  * @deprecated use elm_object_text_* instead.
8089  */
8090 #define elm_layout_label_get(_ly) \
8091   elm_layout_text_get((_ly), "elm.text")
8092
8093    /* smart callbacks called:
8094     * "theme,changed" - when elm theme is changed.
8095     */
8096
8097    /**
8098     * @defgroup Notify Notify
8099     *
8100     * @image html img/widget/notify/preview-00.png
8101     * @image latex img/widget/notify/preview-00.eps
8102     *
8103     * Display a container in a particular region of the parent(top, bottom,
8104     * etc.  A timeout can be set to automatically hide the notify. This is so
8105     * that, after an evas_object_show() on a notify object, if a timeout was set
8106     * on it, it will @b automatically get hidden after that time.
8107     *
8108     * Signals that you can add callbacks for are:
8109     * @li "timeout" - when timeout happens on notify and it's hidden
8110     * @li "block,clicked" - when a click outside of the notify happens
8111     *
8112     * @ref tutorial_notify show usage of the API.
8113     *
8114     * @{
8115     */
8116    /**
8117     * @brief Possible orient values for notify.
8118     *
8119     * This values should be used in conjunction to elm_notify_orient_set() to
8120     * set the position in which the notify should appear(relative to its parent)
8121     * and in conjunction with elm_notify_orient_get() to know where the notify
8122     * is appearing.
8123     */
8124    typedef enum _Elm_Notify_Orient
8125      {
8126         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
8127         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
8128         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
8129         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
8130         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
8131         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
8132         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
8133         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
8134         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
8135         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
8136      } Elm_Notify_Orient;
8137    /**
8138     * @brief Add a new notify to the parent
8139     *
8140     * @param parent The parent object
8141     * @return The new object or NULL if it cannot be created
8142     */
8143    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8144    /**
8145     * @brief Set the content of the notify widget
8146     *
8147     * @param obj The notify object
8148     * @param content The content will be filled in this notify object
8149     *
8150     * Once the content object is set, a previously set one will be deleted. If
8151     * you want to keep that old content object, use the
8152     * elm_notify_content_unset() function.
8153     */
8154    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8155    /**
8156     * @brief Unset the content of the notify widget
8157     *
8158     * @param obj The notify object
8159     * @return The content that was being used
8160     *
8161     * Unparent and return the content object which was set for this widget
8162     *
8163     * @see elm_notify_content_set()
8164     */
8165    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8166    /**
8167     * @brief Return the content of the notify widget
8168     *
8169     * @param obj The notify object
8170     * @return The content that is being used
8171     *
8172     * @see elm_notify_content_set()
8173     */
8174    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8175    /**
8176     * @brief Set the notify parent
8177     *
8178     * @param obj The notify object
8179     * @param content The new parent
8180     *
8181     * Once the parent object is set, a previously set one will be disconnected
8182     * and replaced.
8183     */
8184    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8185    /**
8186     * @brief Get the notify parent
8187     *
8188     * @param obj The notify object
8189     * @return The parent
8190     *
8191     * @see elm_notify_parent_set()
8192     */
8193    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8194    /**
8195     * @brief Set the orientation
8196     *
8197     * @param obj The notify object
8198     * @param orient The new orientation
8199     *
8200     * Sets the position in which the notify will appear in its parent.
8201     *
8202     * @see @ref Elm_Notify_Orient for possible values.
8203     */
8204    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
8205    /**
8206     * @brief Return the orientation
8207     * @param obj The notify object
8208     * @return The orientation of the notification
8209     *
8210     * @see elm_notify_orient_set()
8211     * @see Elm_Notify_Orient
8212     */
8213    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8214    /**
8215     * @brief Set the time interval after which the notify window is going to be
8216     * hidden.
8217     *
8218     * @param obj The notify object
8219     * @param time The timeout in seconds
8220     *
8221     * This function sets a timeout and starts the timer controlling when the
8222     * notify is hidden. Since calling evas_object_show() on a notify restarts
8223     * the timer controlling when the notify is hidden, setting this before the
8224     * notify is shown will in effect mean starting the timer when the notify is
8225     * shown.
8226     *
8227     * @note Set a value <= 0.0 to disable a running timer.
8228     *
8229     * @note If the value > 0.0 and the notify is previously visible, the
8230     * timer will be started with this value, canceling any running timer.
8231     */
8232    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
8233    /**
8234     * @brief Return the timeout value (in seconds)
8235     * @param obj the notify object
8236     *
8237     * @see elm_notify_timeout_set()
8238     */
8239    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8240    /**
8241     * @brief Sets whether events should be passed to by a click outside
8242     * its area.
8243     *
8244     * @param obj The notify object
8245     * @param repeats EINA_TRUE Events are repeats, else no
8246     *
8247     * When true if the user clicks outside the window the events will be caught
8248     * by the others widgets, else the events are blocked.
8249     *
8250     * @note The default value is EINA_TRUE.
8251     */
8252    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8253    /**
8254     * @brief Return true if events are repeat below the notify object
8255     * @param obj the notify object
8256     *
8257     * @see elm_notify_repeat_events_set()
8258     */
8259    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8260    /**
8261     * @}
8262     */
8263
8264    /**
8265     * @defgroup Hover Hover
8266     *
8267     * @image html img/widget/hover/preview-00.png
8268     * @image latex img/widget/hover/preview-00.eps
8269     *
8270     * A Hover object will hover over its @p parent object at the @p target
8271     * location. Anything in the background will be given a darker coloring to
8272     * indicate that the hover object is on top (at the default theme). When the
8273     * hover is clicked it is dismissed(hidden), if the contents of the hover are
8274     * clicked that @b doesn't cause the hover to be dismissed.
8275     *
8276     * @note The hover object will take up the entire space of @p target
8277     * object.
8278     *
8279     * Elementary has the following styles for the hover widget:
8280     * @li default
8281     * @li popout
8282     * @li menu
8283     * @li hoversel_vertical
8284     *
8285     * The following are the available position for content:
8286     * @li left
8287     * @li top-left
8288     * @li top
8289     * @li top-right
8290     * @li right
8291     * @li bottom-right
8292     * @li bottom
8293     * @li bottom-left
8294     * @li middle
8295     * @li smart
8296     *
8297     * Signals that you can add callbacks for are:
8298     * @li "clicked" - the user clicked the empty space in the hover to dismiss
8299     * @li "smart,changed" - a content object placed under the "smart"
8300     *                   policy was replaced to a new slot direction.
8301     *
8302     * See @ref tutorial_hover for more information.
8303     *
8304     * @{
8305     */
8306    typedef enum _Elm_Hover_Axis
8307      {
8308         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8309         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8310         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8311         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8312      } Elm_Hover_Axis;
8313    /**
8314     * @brief Adds a hover object to @p parent
8315     *
8316     * @param parent The parent object
8317     * @return The hover object or NULL if one could not be created
8318     */
8319    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8320    /**
8321     * @brief Sets the target object for the hover.
8322     *
8323     * @param obj The hover object
8324     * @param target The object to center the hover onto. The hover
8325     *
8326     * This function will cause the hover to be centered on the target object.
8327     */
8328    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8329    /**
8330     * @brief Gets the target object for the hover.
8331     *
8332     * @param obj The hover object
8333     * @param parent The object to locate the hover over.
8334     *
8335     * @see elm_hover_target_set()
8336     */
8337    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8338    /**
8339     * @brief Sets the parent object for the hover.
8340     *
8341     * @param obj The hover object
8342     * @param parent The object to locate the hover over.
8343     *
8344     * This function will cause the hover to take up the entire space that the
8345     * parent object fills.
8346     */
8347    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8348    /**
8349     * @brief Gets the parent object for the hover.
8350     *
8351     * @param obj The hover object
8352     * @return The parent object to locate the hover over.
8353     *
8354     * @see elm_hover_parent_set()
8355     */
8356    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8357    /**
8358     * @brief Sets the content of the hover object and the direction in which it
8359     * will pop out.
8360     *
8361     * @param obj The hover object
8362     * @param swallow The direction that the object will be displayed
8363     * at. Accepted values are "left", "top-left", "top", "top-right",
8364     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8365     * "smart".
8366     * @param content The content to place at @p swallow
8367     *
8368     * Once the content object is set for a given direction, a previously
8369     * set one (on the same direction) will be deleted. If you want to
8370     * keep that old content object, use the elm_hover_content_unset()
8371     * function.
8372     *
8373     * All directions may have contents at the same time, except for
8374     * "smart". This is a special placement hint and its use case
8375     * independs of the calculations coming from
8376     * elm_hover_best_content_location_get(). Its use is for cases when
8377     * one desires only one hover content, but with a dinamic special
8378     * placement within the hover area. The content's geometry, whenever
8379     * it changes, will be used to decide on a best location not
8380     * extrapolating the hover's parent object view to show it in (still
8381     * being the hover's target determinant of its medium part -- move and
8382     * resize it to simulate finger sizes, for example). If one of the
8383     * directions other than "smart" are used, a previously content set
8384     * using it will be deleted, and vice-versa.
8385     */
8386    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8387    /**
8388     * @brief Get the content of the hover object, in a given direction.
8389     *
8390     * Return the content object which was set for this widget in the
8391     * @p swallow direction.
8392     *
8393     * @param obj The hover object
8394     * @param swallow The direction that the object was display at.
8395     * @return The content that was being used
8396     *
8397     * @see elm_hover_content_set()
8398     */
8399    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8400    /**
8401     * @brief Unset the content of the hover object, in a given direction.
8402     *
8403     * Unparent and return the content object set at @p swallow direction.
8404     *
8405     * @param obj The hover object
8406     * @param swallow The direction that the object was display at.
8407     * @return The content that was being used.
8408     *
8409     * @see elm_hover_content_set()
8410     */
8411    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8412    /**
8413     * @brief Returns the best swallow location for content in the hover.
8414     *
8415     * @param obj The hover object
8416     * @param pref_axis The preferred orientation axis for the hover object to use
8417     * @return The edje location to place content into the hover or @c
8418     *         NULL, on errors.
8419     *
8420     * Best is defined here as the location at which there is the most available
8421     * space.
8422     *
8423     * @p pref_axis may be one of
8424     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8425     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8426     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8427     * - @c ELM_HOVER_AXIS_BOTH -- both
8428     *
8429     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8430     * nescessarily be along the horizontal axis("left" or "right"). If
8431     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8432     * be along the vertical axis("top" or "bottom"). Chossing
8433     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8434     * returned position may be in either axis.
8435     *
8436     * @see elm_hover_content_set()
8437     */
8438    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8439    /**
8440     * @}
8441     */
8442
8443    /* entry */
8444    /**
8445     * @defgroup Entry Entry
8446     *
8447     * @image html img/widget/entry/preview-00.png
8448     * @image latex img/widget/entry/preview-00.eps width=\textwidth
8449     * @image html img/widget/entry/preview-01.png
8450     * @image latex img/widget/entry/preview-01.eps width=\textwidth
8451     * @image html img/widget/entry/preview-02.png
8452     * @image latex img/widget/entry/preview-02.eps width=\textwidth
8453     * @image html img/widget/entry/preview-03.png
8454     * @image latex img/widget/entry/preview-03.eps width=\textwidth
8455     *
8456     * An entry is a convenience widget which shows a box that the user can
8457     * enter text into. Entries by default don't scroll, so they grow to
8458     * accomodate the entire text, resizing the parent window as needed. This
8459     * can be changed with the elm_entry_scrollable_set() function.
8460     *
8461     * They can also be single line or multi line (the default) and when set
8462     * to multi line mode they support text wrapping in any of the modes
8463     * indicated by #Elm_Wrap_Type.
8464     *
8465     * Other features include password mode, filtering of inserted text with
8466     * elm_entry_text_filter_append() and related functions, inline "items" and
8467     * formatted markup text.
8468     *
8469     * @section entry-markup Formatted text
8470     *
8471     * The markup tags supported by the Entry are defined by the theme, but
8472     * even when writing new themes or extensions it's a good idea to stick to
8473     * a sane default, to maintain coherency and avoid application breakages.
8474     * Currently defined by the default theme are the following tags:
8475     * @li \<br\>: Inserts a line break.
8476     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8477     * breaks.
8478     * @li \<tab\>: Inserts a tab.
8479     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8480     * enclosed text.
8481     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8482     * @li \<link\>...\</link\>: Underlines the enclosed text.
8483     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8484     *
8485     * @section entry-special Special markups
8486     *
8487     * Besides those used to format text, entries support two special markup
8488     * tags used to insert clickable portions of text or items inlined within
8489     * the text.
8490     *
8491     * @subsection entry-anchors Anchors
8492     *
8493     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8494     * \</a\> tags and an event will be generated when this text is clicked,
8495     * like this:
8496     *
8497     * @code
8498     * This text is outside <a href=anc-01>but this one is an anchor</a>
8499     * @endcode
8500     *
8501     * The @c href attribute in the opening tag gives the name that will be
8502     * used to identify the anchor and it can be any valid utf8 string.
8503     *
8504     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8505     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8506     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8507     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8508     * an anchor.
8509     *
8510     * @subsection entry-items Items
8511     *
8512     * Inlined in the text, any other @c Evas_Object can be inserted by using
8513     * \<item\> tags this way:
8514     *
8515     * @code
8516     * <item size=16x16 vsize=full href=emoticon/haha></item>
8517     * @endcode
8518     *
8519     * Just like with anchors, the @c href identifies each item, but these need,
8520     * in addition, to indicate their size, which is done using any one of
8521     * @c size, @c absize or @c relsize attributes. These attributes take their
8522     * value in the WxH format, where W is the width and H the height of the
8523     * item.
8524     *
8525     * @li absize: Absolute pixel size for the item. Whatever value is set will
8526     * be the item's size regardless of any scale value the object may have
8527     * been set to. The final line height will be adjusted to fit larger items.
8528     * @li size: Similar to @c absize, but it's adjusted to the scale value set
8529     * for the object.
8530     * @li relsize: Size is adjusted for the item to fit within the current
8531     * line height.
8532     *
8533     * Besides their size, items are specificed a @c vsize value that affects
8534     * how their final size and position are calculated. The possible values
8535     * are:
8536     * @li ascent: Item will be placed within the line's baseline and its
8537     * ascent. That is, the height between the line where all characters are
8538     * positioned and the highest point in the line. For @c size and @c absize
8539     * items, the descent value will be added to the total line height to make
8540     * them fit. @c relsize items will be adjusted to fit within this space.
8541     * @li full: Items will be placed between the descent and ascent, or the
8542     * lowest point in the line and its highest.
8543     *
8544     * The next image shows different configurations of items and how they
8545     * are the previously mentioned options affect their sizes. In all cases,
8546     * the green line indicates the ascent, blue for the baseline and red for
8547     * the descent.
8548     *
8549     * @image html entry_item.png
8550     * @image latex entry_item.eps width=\textwidth
8551     *
8552     * And another one to show how size differs from absize. In the first one,
8553     * the scale value is set to 1.0, while the second one is using one of 2.0.
8554     *
8555     * @image html entry_item_scale.png
8556     * @image latex entry_item_scale.eps width=\textwidth
8557     *
8558     * After the size for an item is calculated, the entry will request an
8559     * object to place in its space. For this, the functions set with
8560     * elm_entry_item_provider_append() and related functions will be called
8561     * in order until one of them returns a @c non-NULL value. If no providers
8562     * are available, or all of them return @c NULL, then the entry falls back
8563     * to one of the internal defaults, provided the name matches with one of
8564     * them.
8565     *
8566     * All of the following are currently supported:
8567     *
8568     * - emoticon/angry
8569     * - emoticon/angry-shout
8570     * - emoticon/crazy-laugh
8571     * - emoticon/evil-laugh
8572     * - emoticon/evil
8573     * - emoticon/goggle-smile
8574     * - emoticon/grumpy
8575     * - emoticon/grumpy-smile
8576     * - emoticon/guilty
8577     * - emoticon/guilty-smile
8578     * - emoticon/haha
8579     * - emoticon/half-smile
8580     * - emoticon/happy-panting
8581     * - emoticon/happy
8582     * - emoticon/indifferent
8583     * - emoticon/kiss
8584     * - emoticon/knowing-grin
8585     * - emoticon/laugh
8586     * - emoticon/little-bit-sorry
8587     * - emoticon/love-lots
8588     * - emoticon/love
8589     * - emoticon/minimal-smile
8590     * - emoticon/not-happy
8591     * - emoticon/not-impressed
8592     * - emoticon/omg
8593     * - emoticon/opensmile
8594     * - emoticon/smile
8595     * - emoticon/sorry
8596     * - emoticon/squint-laugh
8597     * - emoticon/surprised
8598     * - emoticon/suspicious
8599     * - emoticon/tongue-dangling
8600     * - emoticon/tongue-poke
8601     * - emoticon/uh
8602     * - emoticon/unhappy
8603     * - emoticon/very-sorry
8604     * - emoticon/what
8605     * - emoticon/wink
8606     * - emoticon/worried
8607     * - emoticon/wtf
8608     *
8609     * Alternatively, an item may reference an image by its path, using
8610     * the URI form @c file:///path/to/an/image.png and the entry will then
8611     * use that image for the item.
8612     *
8613     * @section entry-files Loading and saving files
8614     *
8615     * Entries have convinience functions to load text from a file and save
8616     * changes back to it after a short delay. The automatic saving is enabled
8617     * by default, but can be disabled with elm_entry_autosave_set() and files
8618     * can be loaded directly as plain text or have any markup in them
8619     * recognized. See elm_entry_file_set() for more details.
8620     *
8621     * @section entry-signals Emitted signals
8622     *
8623     * This widget emits the following signals:
8624     *
8625     * @li "changed": The text within the entry was changed.
8626     * @li "changed,user": The text within the entry was changed because of user interaction.
8627     * @li "activated": The enter key was pressed on a single line entry.
8628     * @li "press": A mouse button has been pressed on the entry.
8629     * @li "longpressed": A mouse button has been pressed and held for a couple
8630     * seconds.
8631     * @li "clicked": The entry has been clicked (mouse press and release).
8632     * @li "clicked,double": The entry has been double clicked.
8633     * @li "clicked,triple": The entry has been triple clicked.
8634     * @li "focused": The entry has received focus.
8635     * @li "unfocused": The entry has lost focus.
8636     * @li "selection,paste": A paste of the clipboard contents was requested.
8637     * @li "selection,copy": A copy of the selected text into the clipboard was
8638     * requested.
8639     * @li "selection,cut": A cut of the selected text into the clipboard was
8640     * requested.
8641     * @li "selection,start": A selection has begun and no previous selection
8642     * existed.
8643     * @li "selection,changed": The current selection has changed.
8644     * @li "selection,cleared": The current selection has been cleared.
8645     * @li "cursor,changed": The cursor has changed position.
8646     * @li "anchor,clicked": An anchor has been clicked. The event_info
8647     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8648     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8649     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8650     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8651     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8652     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8653     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8654     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8655     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8656     * @li "preedit,changed": The preedit string has changed.
8657     *
8658     * @section entry-examples
8659     *
8660     * An overview of the Entry API can be seen in @ref entry_example_01
8661     *
8662     * @{
8663     */
8664    /**
8665     * @typedef Elm_Entry_Anchor_Info
8666     *
8667     * The info sent in the callback for the "anchor,clicked" signals emitted
8668     * by entries.
8669     */
8670    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8671    /**
8672     * @struct _Elm_Entry_Anchor_Info
8673     *
8674     * The info sent in the callback for the "anchor,clicked" signals emitted
8675     * by entries.
8676     */
8677    struct _Elm_Entry_Anchor_Info
8678      {
8679         const char *name; /**< The name of the anchor, as stated in its href */
8680         int         button; /**< The mouse button used to click on it */
8681         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
8682                     y, /**< Anchor geometry, relative to canvas */
8683                     w, /**< Anchor geometry, relative to canvas */
8684                     h; /**< Anchor geometry, relative to canvas */
8685      };
8686    /**
8687     * @typedef Elm_Entry_Filter_Cb
8688     * This callback type is used by entry filters to modify text.
8689     * @param data The data specified as the last param when adding the filter
8690     * @param entry The entry object
8691     * @param text A pointer to the location of the text being filtered. This data can be modified,
8692     * but any additional allocations must be managed by the user.
8693     * @see elm_entry_text_filter_append
8694     * @see elm_entry_text_filter_prepend
8695     */
8696    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8697
8698    /**
8699     * This adds an entry to @p parent object.
8700     *
8701     * By default, entries are:
8702     * @li not scrolled
8703     * @li multi-line
8704     * @li word wrapped
8705     * @li autosave is enabled
8706     *
8707     * @param parent The parent object
8708     * @return The new object or NULL if it cannot be created
8709     */
8710    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8711    /**
8712     * Sets the entry to single line mode.
8713     *
8714     * In single line mode, entries don't ever wrap when the text reaches the
8715     * edge, and instead they keep growing horizontally. Pressing the @c Enter
8716     * key will generate an @c "activate" event instead of adding a new line.
8717     *
8718     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8719     * and pressing enter will break the text into a different line
8720     * without generating any events.
8721     *
8722     * @param obj The entry object
8723     * @param single_line If true, the text in the entry
8724     * will be on a single line.
8725     */
8726    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8727    /**
8728     * Gets whether the entry is set to be single line.
8729     *
8730     * @param obj The entry object
8731     * @return single_line If true, the text in the entry is set to display
8732     * on a single line.
8733     *
8734     * @see elm_entry_single_line_set()
8735     */
8736    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8737    /**
8738     * Sets the entry to password mode.
8739     *
8740     * In password mode, entries are implicitly single line and the display of
8741     * any text in them is replaced with asterisks (*).
8742     *
8743     * @param obj The entry object
8744     * @param password If true, password mode is enabled.
8745     */
8746    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8747    /**
8748     * Gets whether the entry is set to password mode.
8749     *
8750     * @param obj The entry object
8751     * @return If true, the entry is set to display all characters
8752     * as asterisks (*).
8753     *
8754     * @see elm_entry_password_set()
8755     */
8756    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8757    /**
8758     * This sets the text displayed within the entry to @p entry.
8759     *
8760     * @param obj The entry object
8761     * @param entry The text to be displayed
8762     *
8763     * @deprecated Use elm_object_text_set() instead.
8764     */
8765    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8766    /**
8767     * This returns the text currently shown in object @p entry.
8768     * See also elm_entry_entry_set().
8769     *
8770     * @param obj The entry object
8771     * @return The currently displayed text or NULL on failure
8772     *
8773     * @deprecated Use elm_object_text_get() instead.
8774     */
8775    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8776    /**
8777     * Appends @p entry to the text of the entry.
8778     *
8779     * Adds the text in @p entry to the end of any text already present in the
8780     * widget.
8781     *
8782     * The appended text is subject to any filters set for the widget.
8783     *
8784     * @param obj The entry object
8785     * @param entry The text to be displayed
8786     *
8787     * @see elm_entry_text_filter_append()
8788     */
8789    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8790    /**
8791     * Gets whether the entry is empty.
8792     *
8793     * Empty means no text at all. If there are any markup tags, like an item
8794     * tag for which no provider finds anything, and no text is displayed, this
8795     * function still returns EINA_FALSE.
8796     *
8797     * @param obj The entry object
8798     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8799     */
8800    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8801    /**
8802     * Gets any selected text within the entry.
8803     *
8804     * If there's any selected text in the entry, this function returns it as
8805     * a string in markup format. NULL is returned if no selection exists or
8806     * if an error occurred.
8807     *
8808     * The returned value points to an internal string and should not be freed
8809     * or modified in any way. If the @p entry object is deleted or its
8810     * contents are changed, the returned pointer should be considered invalid.
8811     *
8812     * @param obj The entry object
8813     * @return The selected text within the entry or NULL on failure
8814     */
8815    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8816    /**
8817     * Inserts the given text into the entry at the current cursor position.
8818     *
8819     * This inserts text at the cursor position as if it was typed
8820     * by the user (note that this also allows markup which a user
8821     * can't just "type" as it would be converted to escaped text, so this
8822     * call can be used to insert things like emoticon items or bold push/pop
8823     * tags, other font and color change tags etc.)
8824     *
8825     * If any selection exists, it will be replaced by the inserted text.
8826     *
8827     * The inserted text is subject to any filters set for the widget.
8828     *
8829     * @param obj The entry object
8830     * @param entry The text to insert
8831     *
8832     * @see elm_entry_text_filter_append()
8833     */
8834    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8835    /**
8836     * Set the line wrap type to use on multi-line entries.
8837     *
8838     * Sets the wrap type used by the entry to any of the specified in
8839     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8840     * line (without inserting a line break or paragraph separator) when it
8841     * reaches the far edge of the widget.
8842     *
8843     * Note that this only makes sense for multi-line entries. A widget set
8844     * to be single line will never wrap.
8845     *
8846     * @param obj The entry object
8847     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8848     */
8849    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8850    /**
8851     * Gets the wrap mode the entry was set to use.
8852     *
8853     * @param obj The entry object
8854     * @return Wrap type
8855     *
8856     * @see also elm_entry_line_wrap_set()
8857     */
8858    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8859    /**
8860     * Sets if the entry is to be editable or not.
8861     *
8862     * By default, entries are editable and when focused, any text input by the
8863     * user will be inserted at the current cursor position. But calling this
8864     * function with @p editable as EINA_FALSE will prevent the user from
8865     * inputting text into the entry.
8866     *
8867     * The only way to change the text of a non-editable entry is to use
8868     * elm_object_text_set(), elm_entry_entry_insert() and other related
8869     * functions.
8870     *
8871     * @param obj The entry object
8872     * @param editable If EINA_TRUE, user input will be inserted in the entry,
8873     * if not, the entry is read-only and no user input is allowed.
8874     */
8875    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8876    /**
8877     * Gets whether the entry is editable or not.
8878     *
8879     * @param obj The entry object
8880     * @return If true, the entry is editable by the user.
8881     * If false, it is not editable by the user
8882     *
8883     * @see elm_entry_editable_set()
8884     */
8885    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8886    /**
8887     * This drops any existing text selection within the entry.
8888     *
8889     * @param obj The entry object
8890     */
8891    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8892    /**
8893     * This selects all text within the entry.
8894     *
8895     * @param obj The entry object
8896     */
8897    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8898    /**
8899     * This moves the cursor one place to the right within the entry.
8900     *
8901     * @param obj The entry object
8902     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8903     */
8904    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8905    /**
8906     * This moves the cursor one place to the left within the entry.
8907     *
8908     * @param obj The entry object
8909     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8910     */
8911    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8912    /**
8913     * This moves the cursor one line up within the entry.
8914     *
8915     * @param obj The entry object
8916     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8917     */
8918    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8919    /**
8920     * This moves the cursor one line down within the entry.
8921     *
8922     * @param obj The entry object
8923     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8924     */
8925    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8926    /**
8927     * This moves the cursor to the beginning of the entry.
8928     *
8929     * @param obj The entry object
8930     */
8931    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8932    /**
8933     * This moves the cursor to the end of the entry.
8934     *
8935     * @param obj The entry object
8936     */
8937    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8938    /**
8939     * This moves the cursor to the beginning of the current line.
8940     *
8941     * @param obj The entry object
8942     */
8943    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8944    /**
8945     * This moves the cursor to the end of the current line.
8946     *
8947     * @param obj The entry object
8948     */
8949    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8950    /**
8951     * This begins a selection within the entry as though
8952     * the user were holding down the mouse button to make a selection.
8953     *
8954     * @param obj The entry object
8955     */
8956    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8957    /**
8958     * This ends a selection within the entry as though
8959     * the user had just released the mouse button while making a selection.
8960     *
8961     * @param obj The entry object
8962     */
8963    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8964    /**
8965     * Gets whether a format node exists at the current cursor position.
8966     *
8967     * A format node is anything that defines how the text is rendered. It can
8968     * be a visible format node, such as a line break or a paragraph separator,
8969     * or an invisible one, such as bold begin or end tag.
8970     * This function returns whether any format node exists at the current
8971     * cursor position.
8972     *
8973     * @param obj The entry object
8974     * @return EINA_TRUE if the current cursor position contains a format node,
8975     * EINA_FALSE otherwise.
8976     *
8977     * @see elm_entry_cursor_is_visible_format_get()
8978     */
8979    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8980    /**
8981     * Gets if the current cursor position holds a visible format node.
8982     *
8983     * @param obj The entry object
8984     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8985     * if it's an invisible one or no format exists.
8986     *
8987     * @see elm_entry_cursor_is_format_get()
8988     */
8989    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8990    /**
8991     * Gets the character pointed by the cursor at its current position.
8992     *
8993     * This function returns a string with the utf8 character stored at the
8994     * current cursor position.
8995     * Only the text is returned, any format that may exist will not be part
8996     * of the return value.
8997     *
8998     * @param obj The entry object
8999     * @return The text pointed by the cursors.
9000     */
9001    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9002    /**
9003     * This function returns the geometry of the cursor.
9004     *
9005     * It's useful if you want to draw something on the cursor (or where it is),
9006     * or for example in the case of scrolled entry where you want to show the
9007     * cursor.
9008     *
9009     * @param obj The entry object
9010     * @param x returned geometry
9011     * @param y returned geometry
9012     * @param w returned geometry
9013     * @param h returned geometry
9014     * @return EINA_TRUE upon success, EINA_FALSE upon failure
9015     */
9016    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);
9017    /**
9018     * Sets the cursor position in the entry to the given value
9019     *
9020     * The value in @p pos is the index of the character position within the
9021     * contents of the string as returned by elm_entry_cursor_pos_get().
9022     *
9023     * @param obj The entry object
9024     * @param pos The position of the cursor
9025     */
9026    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
9027    /**
9028     * Retrieves the current position of the cursor in the entry
9029     *
9030     * @param obj The entry object
9031     * @return The cursor position
9032     */
9033    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9034    /**
9035     * This executes a "cut" action on the selected text in the entry.
9036     *
9037     * @param obj The entry object
9038     */
9039    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
9040    /**
9041     * This executes a "copy" action on the selected text in the entry.
9042     *
9043     * @param obj The entry object
9044     */
9045    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
9046    /**
9047     * This executes a "paste" action in the entry.
9048     *
9049     * @param obj The entry object
9050     */
9051    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
9052    /**
9053     * This clears and frees the items in a entry's contextual (longpress)
9054     * menu.
9055     *
9056     * @param obj The entry object
9057     *
9058     * @see elm_entry_context_menu_item_add()
9059     */
9060    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9061    /**
9062     * This adds an item to the entry's contextual menu.
9063     *
9064     * A longpress on an entry will make the contextual menu show up, if this
9065     * hasn't been disabled with elm_entry_context_menu_disabled_set().
9066     * By default, this menu provides a few options like enabling selection mode,
9067     * which is useful on embedded devices that need to be explicit about it,
9068     * and when a selection exists it also shows the copy and cut actions.
9069     *
9070     * With this function, developers can add other options to this menu to
9071     * perform any action they deem necessary.
9072     *
9073     * @param obj The entry object
9074     * @param label The item's text label
9075     * @param icon_file The item's icon file
9076     * @param icon_type The item's icon type
9077     * @param func The callback to execute when the item is clicked
9078     * @param data The data to associate with the item for related functions
9079     */
9080    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);
9081    /**
9082     * This disables the entry's contextual (longpress) menu.
9083     *
9084     * @param obj The entry object
9085     * @param disabled If true, the menu is disabled
9086     */
9087    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9088    /**
9089     * This returns whether the entry's contextual (longpress) menu is
9090     * disabled.
9091     *
9092     * @param obj The entry object
9093     * @return If true, the menu is disabled
9094     */
9095    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9096    /**
9097     * This appends a custom item provider to the list for that entry
9098     *
9099     * This appends the given callback. The list is walked from beginning to end
9100     * with each function called given the item href string in the text. If the
9101     * function returns an object handle other than NULL (it should create an
9102     * object to do this), then this object is used to replace that item. If
9103     * not the next provider is called until one provides an item object, or the
9104     * default provider in entry does.
9105     *
9106     * @param obj The entry object
9107     * @param func The function called to provide the item object
9108     * @param data The data passed to @p func
9109     *
9110     * @see @ref entry-items
9111     */
9112    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);
9113    /**
9114     * This prepends a custom item provider to the list for that entry
9115     *
9116     * This prepends the given callback. See elm_entry_item_provider_append() for
9117     * more information
9118     *
9119     * @param obj The entry object
9120     * @param func The function called to provide the item object
9121     * @param data The data passed to @p func
9122     */
9123    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);
9124    /**
9125     * This removes a custom item provider to the list for that entry
9126     *
9127     * This removes the given callback. See elm_entry_item_provider_append() for
9128     * more information
9129     *
9130     * @param obj The entry object
9131     * @param func The function called to provide the item object
9132     * @param data The data passed to @p func
9133     */
9134    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);
9135    /**
9136     * Append a filter function for text inserted in the entry
9137     *
9138     * Append the given callback to the list. This functions will be called
9139     * whenever any text is inserted into the entry, with the text to be inserted
9140     * as a parameter. The callback function is free to alter the text in any way
9141     * it wants, but it must remember to free the given pointer and update it.
9142     * If the new text is to be discarded, the function can free it and set its
9143     * text parameter to NULL. This will also prevent any following filters from
9144     * being called.
9145     *
9146     * @param obj The entry object
9147     * @param func The function to use as text filter
9148     * @param data User data to pass to @p func
9149     */
9150    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9151    /**
9152     * Prepend a filter function for text insdrted in the entry
9153     *
9154     * Prepend the given callback to the list. See elm_entry_text_filter_append()
9155     * for more information
9156     *
9157     * @param obj The entry object
9158     * @param func The function to use as text filter
9159     * @param data User data to pass to @p func
9160     */
9161    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9162    /**
9163     * Remove a filter from the list
9164     *
9165     * Removes the given callback from the filter list. See
9166     * elm_entry_text_filter_append() for more information.
9167     *
9168     * @param obj The entry object
9169     * @param func The filter function to remove
9170     * @param data The user data passed when adding the function
9171     */
9172    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9173    /**
9174     * This converts a markup (HTML-like) string into UTF-8.
9175     *
9176     * The returned string is a malloc'ed buffer and it should be freed when
9177     * not needed anymore.
9178     *
9179     * @param s The string (in markup) to be converted
9180     * @return The converted string (in UTF-8). It should be freed.
9181     */
9182    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9183    /**
9184     * This converts a UTF-8 string into markup (HTML-like).
9185     *
9186     * The returned string is a malloc'ed buffer and it should be freed when
9187     * not needed anymore.
9188     *
9189     * @param s The string (in UTF-8) to be converted
9190     * @return The converted string (in markup). It should be freed.
9191     */
9192    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9193    /**
9194     * This sets the file (and implicitly loads it) for the text to display and
9195     * then edit. All changes are written back to the file after a short delay if
9196     * the entry object is set to autosave (which is the default).
9197     *
9198     * If the entry had any other file set previously, any changes made to it
9199     * will be saved if the autosave feature is enabled, otherwise, the file
9200     * will be silently discarded and any non-saved changes will be lost.
9201     *
9202     * @param obj The entry object
9203     * @param file The path to the file to load and save
9204     * @param format The file format
9205     */
9206    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
9207    /**
9208     * Gets the file being edited by the entry.
9209     *
9210     * This function can be used to retrieve any file set on the entry for
9211     * edition, along with the format used to load and save it.
9212     *
9213     * @param obj The entry object
9214     * @param file The path to the file to load and save
9215     * @param format The file format
9216     */
9217    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
9218    /**
9219     * This function writes any changes made to the file set with
9220     * elm_entry_file_set()
9221     *
9222     * @param obj The entry object
9223     */
9224    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
9225    /**
9226     * This sets the entry object to 'autosave' the loaded text file or not.
9227     *
9228     * @param obj The entry object
9229     * @param autosave Autosave the loaded file or not
9230     *
9231     * @see elm_entry_file_set()
9232     */
9233    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
9234    /**
9235     * This gets the entry object's 'autosave' status.
9236     *
9237     * @param obj The entry object
9238     * @return Autosave the loaded file or not
9239     *
9240     * @see elm_entry_file_set()
9241     */
9242    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9243    /**
9244     * Control pasting of text and images for the widget.
9245     *
9246     * Normally the entry allows both text and images to be pasted.  By setting
9247     * textonly to be true, this prevents images from being pasted.
9248     *
9249     * Note this only changes the behaviour of text.
9250     *
9251     * @param obj The entry object
9252     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9253     * text+image+other.
9254     */
9255    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9256    /**
9257     * Getting elm_entry text paste/drop mode.
9258     *
9259     * In textonly mode, only text may be pasted or dropped into the widget.
9260     *
9261     * @param obj The entry object
9262     * @return If the widget only accepts text from pastes.
9263     */
9264    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9265    /**
9266     * Enable or disable scrolling in entry
9267     *
9268     * Normally the entry is not scrollable unless you enable it with this call.
9269     *
9270     * @param obj The entry object
9271     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9272     */
9273    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9274    /**
9275     * Get the scrollable state of the entry
9276     *
9277     * Normally the entry is not scrollable. This gets the scrollable state
9278     * of the entry. See elm_entry_scrollable_set() for more information.
9279     *
9280     * @param obj The entry object
9281     * @return The scrollable state
9282     */
9283    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
9284    /**
9285     * This sets a widget to be displayed to the left of a scrolled entry.
9286     *
9287     * @param obj The scrolled entry object
9288     * @param icon The widget to display on the left side of the scrolled
9289     * entry.
9290     *
9291     * @note A previously set widget will be destroyed.
9292     * @note If the object being set does not have minimum size hints set,
9293     * it won't get properly displayed.
9294     *
9295     * @see elm_entry_end_set()
9296     */
9297    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9298    /**
9299     * Gets the leftmost widget of the scrolled entry. This object is
9300     * owned by the scrolled entry and should not be modified.
9301     *
9302     * @param obj The scrolled entry object
9303     * @return the left widget inside the scroller
9304     */
9305    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9306    /**
9307     * Unset the leftmost widget of the scrolled entry, unparenting and
9308     * returning it.
9309     *
9310     * @param obj The scrolled entry object
9311     * @return the previously set icon sub-object of this entry, on
9312     * success.
9313     *
9314     * @see elm_entry_icon_set()
9315     */
9316    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9317    /**
9318     * Sets the visibility of the left-side widget of the scrolled entry,
9319     * set by elm_entry_icon_set().
9320     *
9321     * @param obj The scrolled entry object
9322     * @param setting EINA_TRUE if the object should be displayed,
9323     * EINA_FALSE if not.
9324     */
9325    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9326    /**
9327     * This sets a widget to be displayed to the end of a scrolled entry.
9328     *
9329     * @param obj The scrolled entry object
9330     * @param end The widget to display on the right side of the scrolled
9331     * entry.
9332     *
9333     * @note A previously set widget will be destroyed.
9334     * @note If the object being set does not have minimum size hints set,
9335     * it won't get properly displayed.
9336     *
9337     * @see elm_entry_icon_set
9338     */
9339    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9340    /**
9341     * Gets the endmost widget of the scrolled entry. This object is owned
9342     * by the scrolled entry and should not be modified.
9343     *
9344     * @param obj The scrolled entry object
9345     * @return the right widget inside the scroller
9346     */
9347    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9348    /**
9349     * Unset the endmost widget of the scrolled entry, unparenting and
9350     * returning it.
9351     *
9352     * @param obj The scrolled entry object
9353     * @return the previously set icon sub-object of this entry, on
9354     * success.
9355     *
9356     * @see elm_entry_icon_set()
9357     */
9358    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9359    /**
9360     * Sets the visibility of the end widget of the scrolled entry, set by
9361     * elm_entry_end_set().
9362     *
9363     * @param obj The scrolled entry object
9364     * @param setting EINA_TRUE if the object should be displayed,
9365     * EINA_FALSE if not.
9366     */
9367    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9368    /**
9369     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9370     * them).
9371     *
9372     * Setting an entry to single-line mode with elm_entry_single_line_set()
9373     * will automatically disable the display of scrollbars when the entry
9374     * moves inside its scroller.
9375     *
9376     * @param obj The scrolled entry object
9377     * @param h The horizontal scrollbar policy to apply
9378     * @param v The vertical scrollbar policy to apply
9379     */
9380    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9381    /**
9382     * This enables/disables bouncing within the entry.
9383     *
9384     * This function sets whether the entry will bounce when scrolling reaches
9385     * the end of the contained entry.
9386     *
9387     * @param obj The scrolled entry object
9388     * @param h The horizontal bounce state
9389     * @param v The vertical bounce state
9390     */
9391    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9392    /**
9393     * Get the bounce mode
9394     *
9395     * @param obj The Entry object
9396     * @param h_bounce Allow bounce horizontally
9397     * @param v_bounce Allow bounce vertically
9398     */
9399    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9400
9401    /* pre-made filters for entries */
9402    /**
9403     * @typedef Elm_Entry_Filter_Limit_Size
9404     *
9405     * Data for the elm_entry_filter_limit_size() entry filter.
9406     */
9407    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9408    /**
9409     * @struct _Elm_Entry_Filter_Limit_Size
9410     *
9411     * Data for the elm_entry_filter_limit_size() entry filter.
9412     */
9413    struct _Elm_Entry_Filter_Limit_Size
9414      {
9415         int max_char_count; /**< The maximum number of characters allowed. */
9416         int max_byte_count; /**< The maximum number of bytes allowed*/
9417      };
9418    /**
9419     * Filter inserted text based on user defined character and byte limits
9420     *
9421     * Add this filter to an entry to limit the characters that it will accept
9422     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9423     * The funtion works on the UTF-8 representation of the string, converting
9424     * it from the set markup, thus not accounting for any format in it.
9425     *
9426     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9427     * it as data when setting the filter. In it, it's possible to set limits
9428     * by character count or bytes (any of them is disabled if 0), and both can
9429     * be set at the same time. In that case, it first checks for characters,
9430     * then bytes.
9431     *
9432     * The function will cut the inserted text in order to allow only the first
9433     * number of characters that are still allowed. The cut is made in
9434     * characters, even when limiting by bytes, in order to always contain
9435     * valid ones and avoid half unicode characters making it in.
9436     *
9437     * This filter, like any others, does not apply when setting the entry text
9438     * directly with elm_object_text_set() (or the deprecated
9439     * elm_entry_entry_set()).
9440     */
9441    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9442    /**
9443     * @typedef Elm_Entry_Filter_Accept_Set
9444     *
9445     * Data for the elm_entry_filter_accept_set() entry filter.
9446     */
9447    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9448    /**
9449     * @struct _Elm_Entry_Filter_Accept_Set
9450     *
9451     * Data for the elm_entry_filter_accept_set() entry filter.
9452     */
9453    struct _Elm_Entry_Filter_Accept_Set
9454      {
9455         const char *accepted; /**< Set of characters accepted in the entry. */
9456         const char *rejected; /**< Set of characters rejected from the entry. */
9457      };
9458    /**
9459     * Filter inserted text based on accepted or rejected sets of characters
9460     *
9461     * Add this filter to an entry to restrict the set of accepted characters
9462     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9463     * This structure contains both accepted and rejected sets, but they are
9464     * mutually exclusive.
9465     *
9466     * The @c accepted set takes preference, so if it is set, the filter will
9467     * only work based on the accepted characters, ignoring anything in the
9468     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9469     *
9470     * In both cases, the function filters by matching utf8 characters to the
9471     * raw markup text, so it can be used to remove formatting tags.
9472     *
9473     * This filter, like any others, does not apply when setting the entry text
9474     * directly with elm_object_text_set() (or the deprecated
9475     * elm_entry_entry_set()).
9476     */
9477    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9478    /**
9479     * @}
9480     */
9481
9482    /* composite widgets - these basically put together basic widgets above
9483     * in convenient packages that do more than basic stuff */
9484
9485    /* anchorview */
9486    /**
9487     * @defgroup Anchorview Anchorview
9488     *
9489     * @image html img/widget/anchorview/preview-00.png
9490     * @image latex img/widget/anchorview/preview-00.eps
9491     *
9492     * Anchorview is for displaying text that contains markup with anchors
9493     * like <c>\<a href=1234\>something\</\></c> in it.
9494     *
9495     * Besides being styled differently, the anchorview widget provides the
9496     * necessary functionality so that clicking on these anchors brings up a
9497     * popup with user defined content such as "call", "add to contacts" or
9498     * "open web page". This popup is provided using the @ref Hover widget.
9499     *
9500     * This widget is very similar to @ref Anchorblock, so refer to that
9501     * widget for an example. The only difference Anchorview has is that the
9502     * widget is already provided with scrolling functionality, so if the
9503     * text set to it is too large to fit in the given space, it will scroll,
9504     * whereas the @ref Anchorblock widget will keep growing to ensure all the
9505     * text can be displayed.
9506     *
9507     * This widget emits the following signals:
9508     * @li "anchor,clicked": will be called when an anchor is clicked. The
9509     * @p event_info parameter on the callback will be a pointer of type
9510     * ::Elm_Entry_Anchorview_Info.
9511     *
9512     * See @ref Anchorblock for an example on how to use both of them.
9513     *
9514     * @see Anchorblock
9515     * @see Entry
9516     * @see Hover
9517     *
9518     * @{
9519     */
9520    /**
9521     * @typedef Elm_Entry_Anchorview_Info
9522     *
9523     * The info sent in the callback for "anchor,clicked" signals emitted by
9524     * the Anchorview widget.
9525     */
9526    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9527    /**
9528     * @struct _Elm_Entry_Anchorview_Info
9529     *
9530     * The info sent in the callback for "anchor,clicked" signals emitted by
9531     * the Anchorview widget.
9532     */
9533    struct _Elm_Entry_Anchorview_Info
9534      {
9535         const char     *name; /**< Name of the anchor, as indicated in its href
9536                                    attribute */
9537         int             button; /**< The mouse button used to click on it */
9538         Evas_Object    *hover; /**< The hover object to use for the popup */
9539         struct {
9540              Evas_Coord    x, y, w, h;
9541         } anchor, /**< Geometry selection of text used as anchor */
9542           hover_parent; /**< Geometry of the object used as parent by the
9543                              hover */
9544         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
9545                                              for content on the left side of
9546                                              the hover. Before calling the
9547                                              callback, the widget will make the
9548                                              necessary calculations to check
9549                                              which sides are fit to be set with
9550                                              content, based on the position the
9551                                              hover is activated and its distance
9552                                              to the edges of its parent object
9553                                              */
9554         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
9555                                               the right side of the hover.
9556                                               See @ref hover_left */
9557         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
9558                                             of the hover. See @ref hover_left */
9559         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
9560                                                below the hover. See @ref
9561                                                hover_left */
9562      };
9563    /**
9564     * Add a new Anchorview object
9565     *
9566     * @param parent The parent object
9567     * @return The new object or NULL if it cannot be created
9568     */
9569    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9570    /**
9571     * Set the text to show in the anchorview
9572     *
9573     * Sets the text of the anchorview to @p text. This text can include markup
9574     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9575     * text that will be specially styled and react to click events, ended with
9576     * either of \</a\> or \</\>. When clicked, the anchor will emit an
9577     * "anchor,clicked" signal that you can attach a callback to with
9578     * evas_object_smart_callback_add(). The name of the anchor given in the
9579     * event info struct will be the one set in the href attribute, in this
9580     * case, anchorname.
9581     *
9582     * Other markup can be used to style the text in different ways, but it's
9583     * up to the style defined in the theme which tags do what.
9584     * @deprecated use elm_object_text_set() instead.
9585     */
9586    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9587    /**
9588     * Get the markup text set for the anchorview
9589     *
9590     * Retrieves the text set on the anchorview, with markup tags included.
9591     *
9592     * @param obj The anchorview object
9593     * @return The markup text set or @c NULL if nothing was set or an error
9594     * occurred
9595     * @deprecated use elm_object_text_set() instead.
9596     */
9597    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9598    /**
9599     * Set the parent of the hover popup
9600     *
9601     * Sets the parent object to use by the hover created by the anchorview
9602     * when an anchor is clicked. See @ref Hover for more details on this.
9603     * If no parent is set, the same anchorview object will be used.
9604     *
9605     * @param obj The anchorview object
9606     * @param parent The object to use as parent for the hover
9607     */
9608    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9609    /**
9610     * Get the parent of the hover popup
9611     *
9612     * Get the object used as parent for the hover created by the anchorview
9613     * widget. See @ref Hover for more details on this.
9614     *
9615     * @param obj The anchorview object
9616     * @return The object used as parent for the hover, NULL if none is set.
9617     */
9618    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9619    /**
9620     * Set the style that the hover should use
9621     *
9622     * When creating the popup hover, anchorview will request that it's
9623     * themed according to @p style.
9624     *
9625     * @param obj The anchorview object
9626     * @param style The style to use for the underlying hover
9627     *
9628     * @see elm_object_style_set()
9629     */
9630    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9631    /**
9632     * Get the style that the hover should use
9633     *
9634     * Get the style the hover created by anchorview will use.
9635     *
9636     * @param obj The anchorview object
9637     * @return The style to use by the hover. NULL means the default is used.
9638     *
9639     * @see elm_object_style_set()
9640     */
9641    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9642    /**
9643     * Ends the hover popup in the anchorview
9644     *
9645     * When an anchor is clicked, the anchorview widget will create a hover
9646     * object to use as a popup with user provided content. This function
9647     * terminates this popup, returning the anchorview to its normal state.
9648     *
9649     * @param obj The anchorview object
9650     */
9651    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9652    /**
9653     * Set bouncing behaviour when the scrolled content reaches an edge
9654     *
9655     * Tell the internal scroller object whether it should bounce or not
9656     * when it reaches the respective edges for each axis.
9657     *
9658     * @param obj The anchorview object
9659     * @param h_bounce Whether to bounce or not in the horizontal axis
9660     * @param v_bounce Whether to bounce or not in the vertical axis
9661     *
9662     * @see elm_scroller_bounce_set()
9663     */
9664    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9665    /**
9666     * Get the set bouncing behaviour of the internal scroller
9667     *
9668     * Get whether the internal scroller should bounce when the edge of each
9669     * axis is reached scrolling.
9670     *
9671     * @param obj The anchorview object
9672     * @param h_bounce Pointer where to store the bounce state of the horizontal
9673     *                 axis
9674     * @param v_bounce Pointer where to store the bounce state of the vertical
9675     *                 axis
9676     *
9677     * @see elm_scroller_bounce_get()
9678     */
9679    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9680    /**
9681     * Appends a custom item provider to the given anchorview
9682     *
9683     * Appends the given function to the list of items providers. This list is
9684     * called, one function at a time, with the given @p data pointer, the
9685     * anchorview object and, in the @p item parameter, the item name as
9686     * referenced in its href string. Following functions in the list will be
9687     * called in order until one of them returns something different to NULL,
9688     * which should be an Evas_Object which will be used in place of the item
9689     * element.
9690     *
9691     * Items in the markup text take the form \<item relsize=16x16 vsize=full
9692     * href=item/name\>\</item\>
9693     *
9694     * @param obj The anchorview object
9695     * @param func The function to add to the list of providers
9696     * @param data User data that will be passed to the callback function
9697     *
9698     * @see elm_entry_item_provider_append()
9699     */
9700    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);
9701    /**
9702     * Prepend a custom item provider to the given anchorview
9703     *
9704     * Like elm_anchorview_item_provider_append(), but it adds the function
9705     * @p func to the beginning of the list, instead of the end.
9706     *
9707     * @param obj The anchorview object
9708     * @param func The function to add to the list of providers
9709     * @param data User data that will be passed to the callback function
9710     */
9711    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);
9712    /**
9713     * Remove a custom item provider from the list of the given anchorview
9714     *
9715     * Removes the function and data pairing that matches @p func and @p data.
9716     * That is, unless the same function and same user data are given, the
9717     * function will not be removed from the list. This allows us to add the
9718     * same callback several times, with different @p data pointers and be
9719     * able to remove them later without conflicts.
9720     *
9721     * @param obj The anchorview object
9722     * @param func The function to remove from the list
9723     * @param data The data matching the function to remove from the list
9724     */
9725    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);
9726    /**
9727     * @}
9728     */
9729
9730    /* anchorblock */
9731    /**
9732     * @defgroup Anchorblock Anchorblock
9733     *
9734     * @image html img/widget/anchorblock/preview-00.png
9735     * @image latex img/widget/anchorblock/preview-00.eps
9736     *
9737     * Anchorblock is for displaying text that contains markup with anchors
9738     * like <c>\<a href=1234\>something\</\></c> in it.
9739     *
9740     * Besides being styled differently, the anchorblock widget provides the
9741     * necessary functionality so that clicking on these anchors brings up a
9742     * popup with user defined content such as "call", "add to contacts" or
9743     * "open web page". This popup is provided using the @ref Hover widget.
9744     *
9745     * This widget emits the following signals:
9746     * @li "anchor,clicked": will be called when an anchor is clicked. The
9747     * @p event_info parameter on the callback will be a pointer of type
9748     * ::Elm_Entry_Anchorblock_Info.
9749     *
9750     * @see Anchorview
9751     * @see Entry
9752     * @see Hover
9753     *
9754     * Since examples are usually better than plain words, we might as well
9755     * try @ref tutorial_anchorblock_example "one".
9756     */
9757    /**
9758     * @addtogroup Anchorblock
9759     * @{
9760     */
9761    /**
9762     * @typedef Elm_Entry_Anchorblock_Info
9763     *
9764     * The info sent in the callback for "anchor,clicked" signals emitted by
9765     * the Anchorblock widget.
9766     */
9767    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9768    /**
9769     * @struct _Elm_Entry_Anchorblock_Info
9770     *
9771     * The info sent in the callback for "anchor,clicked" signals emitted by
9772     * the Anchorblock widget.
9773     */
9774    struct _Elm_Entry_Anchorblock_Info
9775      {
9776         const char     *name; /**< Name of the anchor, as indicated in its href
9777                                    attribute */
9778         int             button; /**< The mouse button used to click on it */
9779         Evas_Object    *hover; /**< The hover object to use for the popup */
9780         struct {
9781              Evas_Coord    x, y, w, h;
9782         } anchor, /**< Geometry selection of text used as anchor */
9783           hover_parent; /**< Geometry of the object used as parent by the
9784                              hover */
9785         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
9786                                              for content on the left side of
9787                                              the hover. Before calling the
9788                                              callback, the widget will make the
9789                                              necessary calculations to check
9790                                              which sides are fit to be set with
9791                                              content, based on the position the
9792                                              hover is activated and its distance
9793                                              to the edges of its parent object
9794                                              */
9795         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
9796                                               the right side of the hover.
9797                                               See @ref hover_left */
9798         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
9799                                             of the hover. See @ref hover_left */
9800         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
9801                                                below the hover. See @ref
9802                                                hover_left */
9803      };
9804    /**
9805     * Add a new Anchorblock object
9806     *
9807     * @param parent The parent object
9808     * @return The new object or NULL if it cannot be created
9809     */
9810    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9811    /**
9812     * Set the text to show in the anchorblock
9813     *
9814     * Sets the text of the anchorblock to @p text. This text can include markup
9815     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9816     * of text that will be specially styled and react to click events, ended
9817     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9818     * "anchor,clicked" signal that you can attach a callback to with
9819     * evas_object_smart_callback_add(). The name of the anchor given in the
9820     * event info struct will be the one set in the href attribute, in this
9821     * case, anchorname.
9822     *
9823     * Other markup can be used to style the text in different ways, but it's
9824     * up to the style defined in the theme which tags do what.
9825     * @deprecated use elm_object_text_set() instead.
9826     */
9827    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9828    /**
9829     * Get the markup text set for the anchorblock
9830     *
9831     * Retrieves the text set on the anchorblock, with markup tags included.
9832     *
9833     * @param obj The anchorblock object
9834     * @return The markup text set or @c NULL if nothing was set or an error
9835     * occurred
9836     * @deprecated use elm_object_text_set() instead.
9837     */
9838    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9839    /**
9840     * Set the parent of the hover popup
9841     *
9842     * Sets the parent object to use by the hover created by the anchorblock
9843     * when an anchor is clicked. See @ref Hover for more details on this.
9844     *
9845     * @param obj The anchorblock object
9846     * @param parent The object to use as parent for the hover
9847     */
9848    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9849    /**
9850     * Get the parent of the hover popup
9851     *
9852     * Get the object used as parent for the hover created by the anchorblock
9853     * widget. See @ref Hover for more details on this.
9854     * If no parent is set, the same anchorblock object will be used.
9855     *
9856     * @param obj The anchorblock object
9857     * @return The object used as parent for the hover, NULL if none is set.
9858     */
9859    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9860    /**
9861     * Set the style that the hover should use
9862     *
9863     * When creating the popup hover, anchorblock will request that it's
9864     * themed according to @p style.
9865     *
9866     * @param obj The anchorblock object
9867     * @param style The style to use for the underlying hover
9868     *
9869     * @see elm_object_style_set()
9870     */
9871    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9872    /**
9873     * Get the style that the hover should use
9874     *
9875     * Get the style the hover created by anchorblock will use.
9876     *
9877     * @param obj The anchorblock object
9878     * @return The style to use by the hover. NULL means the default is used.
9879     *
9880     * @see elm_object_style_set()
9881     */
9882    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9883    /**
9884     * Ends the hover popup in the anchorblock
9885     *
9886     * When an anchor is clicked, the anchorblock widget will create a hover
9887     * object to use as a popup with user provided content. This function
9888     * terminates this popup, returning the anchorblock to its normal state.
9889     *
9890     * @param obj The anchorblock object
9891     */
9892    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9893    /**
9894     * Appends a custom item provider to the given anchorblock
9895     *
9896     * Appends the given function to the list of items providers. This list is
9897     * called, one function at a time, with the given @p data pointer, the
9898     * anchorblock object and, in the @p item parameter, the item name as
9899     * referenced in its href string. Following functions in the list will be
9900     * called in order until one of them returns something different to NULL,
9901     * which should be an Evas_Object which will be used in place of the item
9902     * element.
9903     *
9904     * Items in the markup text take the form \<item relsize=16x16 vsize=full
9905     * href=item/name\>\</item\>
9906     *
9907     * @param obj The anchorblock object
9908     * @param func The function to add to the list of providers
9909     * @param data User data that will be passed to the callback function
9910     *
9911     * @see elm_entry_item_provider_append()
9912     */
9913    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);
9914    /**
9915     * Prepend a custom item provider to the given anchorblock
9916     *
9917     * Like elm_anchorblock_item_provider_append(), but it adds the function
9918     * @p func to the beginning of the list, instead of the end.
9919     *
9920     * @param obj The anchorblock object
9921     * @param func The function to add to the list of providers
9922     * @param data User data that will be passed to the callback function
9923     */
9924    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);
9925    /**
9926     * Remove a custom item provider from the list of the given anchorblock
9927     *
9928     * Removes the function and data pairing that matches @p func and @p data.
9929     * That is, unless the same function and same user data are given, the
9930     * function will not be removed from the list. This allows us to add the
9931     * same callback several times, with different @p data pointers and be
9932     * able to remove them later without conflicts.
9933     *
9934     * @param obj The anchorblock object
9935     * @param func The function to remove from the list
9936     * @param data The data matching the function to remove from the list
9937     */
9938    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);
9939    /**
9940     * @}
9941     */
9942
9943    /**
9944     * @defgroup Bubble Bubble
9945     *
9946     * @image html img/widget/bubble/preview-00.png
9947     * @image latex img/widget/bubble/preview-00.eps
9948     * @image html img/widget/bubble/preview-01.png
9949     * @image latex img/widget/bubble/preview-01.eps
9950     * @image html img/widget/bubble/preview-02.png
9951     * @image latex img/widget/bubble/preview-02.eps
9952     *
9953     * @brief The Bubble is a widget to show text similarly to how speech is
9954     * represented in comics.
9955     *
9956     * The bubble widget contains 5 important visual elements:
9957     * @li The frame is a rectangle with rounded rectangles and an "arrow".
9958     * @li The @p icon is an image to which the frame's arrow points to.
9959     * @li The @p label is a text which appears to the right of the icon if the
9960     * corner is "top_left" or "bottom_left" and is right aligned to the frame
9961     * otherwise.
9962     * @li The @p info is a text which appears to the right of the label. Info's
9963     * font is of a ligther color than label.
9964     * @li The @p content is an evas object that is shown inside the frame.
9965     *
9966     * The position of the arrow, icon, label and info depends on which corner is
9967     * selected. The four available corners are:
9968     * @li "top_left" - Default
9969     * @li "top_right"
9970     * @li "bottom_left"
9971     * @li "bottom_right"
9972     *
9973     * Signals that you can add callbacks for are:
9974     * @li "clicked" - This is called when a user has clicked the bubble.
9975     *
9976     * For an example of using a buble see @ref bubble_01_example_page "this".
9977     *
9978     * @{
9979     */
9980    /**
9981     * Add a new bubble to the parent
9982     *
9983     * @param parent The parent object
9984     * @return The new object or NULL if it cannot be created
9985     *
9986     * This function adds a text bubble to the given parent evas object.
9987     */
9988    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9989    /**
9990     * Set the label of the bubble
9991     *
9992     * @param obj The bubble object
9993     * @param label The string to set in the label
9994     *
9995     * This function sets the title of the bubble. Where this appears depends on
9996     * the selected corner.
9997     * @deprecated use elm_object_text_set() instead.
9998     */
9999    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10000    /**
10001     * Get the label of the bubble
10002     *
10003     * @param obj The bubble object
10004     * @return The string of set in the label
10005     *
10006     * This function gets the title of the bubble.
10007     * @deprecated use elm_object_text_get() instead.
10008     */
10009    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10010    /**
10011     * Set the info of the bubble
10012     *
10013     * @param obj The bubble object
10014     * @param info The given info about the bubble
10015     *
10016     * This function sets the info of the bubble. Where this appears depends on
10017     * the selected corner.
10018     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
10019     */
10020    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
10021    /**
10022     * Get the info of the bubble
10023     *
10024     * @param obj The bubble object
10025     *
10026     * @return The "info" string of the bubble
10027     *
10028     * This function gets the info text.
10029     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
10030     */
10031    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10032    /**
10033     * Set the content to be shown in the bubble
10034     *
10035     * Once the content object is set, a previously set one will be deleted.
10036     * If you want to keep the old content object, use the
10037     * elm_bubble_content_unset() function.
10038     *
10039     * @param obj The bubble object
10040     * @param content The given content of the bubble
10041     *
10042     * This function sets the content shown on the middle of the bubble.
10043     */
10044    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10045    /**
10046     * Get the content shown in the bubble
10047     *
10048     * Return the content object which is set for this widget.
10049     *
10050     * @param obj The bubble object
10051     * @return The content that is being used
10052     */
10053    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10054    /**
10055     * Unset the content shown in the bubble
10056     *
10057     * Unparent and return the content object which was set for this widget.
10058     *
10059     * @param obj The bubble object
10060     * @return The content that was being used
10061     */
10062    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10063    /**
10064     * Set the icon of the bubble
10065     *
10066     * Once the icon object is set, a previously set one will be deleted.
10067     * If you want to keep the old content object, use the
10068     * elm_icon_content_unset() function.
10069     *
10070     * @param obj The bubble object
10071     * @param icon The given icon for the bubble
10072     */
10073    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10074    /**
10075     * Get the icon of the bubble
10076     *
10077     * @param obj The bubble object
10078     * @return The icon for the bubble
10079     *
10080     * This function gets the icon shown on the top left of bubble.
10081     */
10082    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10083    /**
10084     * Unset the icon of the bubble
10085     *
10086     * Unparent and return the icon object which was set for this widget.
10087     *
10088     * @param obj The bubble object
10089     * @return The icon that was being used
10090     */
10091    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10092    /**
10093     * Set the corner of the bubble
10094     *
10095     * @param obj The bubble object.
10096     * @param corner The given corner for the bubble.
10097     *
10098     * This function sets the corner of the bubble. The corner will be used to
10099     * determine where the arrow in the frame points to and where label, icon and
10100     * info arre shown.
10101     *
10102     * Possible values for corner are:
10103     * @li "top_left" - Default
10104     * @li "top_right"
10105     * @li "bottom_left"
10106     * @li "bottom_right"
10107     */
10108    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
10109    /**
10110     * Get the corner of the bubble
10111     *
10112     * @param obj The bubble object.
10113     * @return The given corner for the bubble.
10114     *
10115     * This function gets the selected corner of the bubble.
10116     */
10117    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10118    /**
10119     * @}
10120     */
10121
10122    /* photo */
10123    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10124    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
10125    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
10126    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
10127    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
10128    /* smart callbacks called:
10129     * "clicked" - the user clicked the icon
10130     * "drag,start" - Someone started dragging the image out of the object
10131     * "drag,end" - Dragged item was dropped (somewhere)
10132     */
10133
10134    /* gesture layer */
10135    /**
10136     * @defgroup Elm_Gesture_Layer Gesture Layer
10137     * Gesture Layer Usage:
10138     *
10139     * Use Gesture Layer to detect gestures.
10140     * The advantage is that you don't have to implement
10141     * gesture detection, just set callbacks of gesture state.
10142     * By using gesture layer we make standard interface.
10143     *
10144     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
10145     * with a parent object parameter.
10146     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
10147     * call. Usually with same object as target (2nd parameter).
10148     *
10149     * Now you need to tell gesture layer what gestures you follow.
10150     * This is done with @ref elm_gesture_layer_cb_set call.
10151     * By setting the callback you actually saying to gesture layer:
10152     * I would like to know when the gesture @ref Elm_Gesture_Types
10153     * switches to state @ref Elm_Gesture_State.
10154     *
10155     * Next, you need to implement the actual action that follows the input
10156     * in your callback.
10157     *
10158     * Note that if you like to stop being reported about a gesture, just set
10159     * all callbacks referring this gesture to NULL.
10160     * (again with @ref elm_gesture_layer_cb_set)
10161     *
10162     * The information reported by gesture layer to your callback is depending
10163     * on @ref Elm_Gesture_Types:
10164     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
10165     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
10166     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
10167     *
10168     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
10169     * @ref ELM_GESTURE_MOMENTUM.
10170     *
10171     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
10172     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
10173     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
10174     * Note that we consider a flick as a line-gesture that should be completed
10175     * in flick-time-limit as defined in @ref Config.
10176     *
10177     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
10178     *
10179     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
10180     * */
10181
10182    /**
10183     * @enum _Elm_Gesture_Types
10184     * Enum of supported gesture types.
10185     * @ingroup Elm_Gesture_Layer
10186     */
10187    enum _Elm_Gesture_Types
10188      {
10189         ELM_GESTURE_FIRST = 0,
10190
10191         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
10192         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
10193         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
10194         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
10195
10196         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
10197
10198         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
10199         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
10200
10201         ELM_GESTURE_ZOOM, /**< Zoom */
10202         ELM_GESTURE_ROTATE, /**< Rotate */
10203
10204         ELM_GESTURE_LAST
10205      };
10206
10207    /**
10208     * @typedef Elm_Gesture_Types
10209     * gesture types enum
10210     * @ingroup Elm_Gesture_Layer
10211     */
10212    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
10213
10214    /**
10215     * @enum _Elm_Gesture_State
10216     * Enum of gesture states.
10217     * @ingroup Elm_Gesture_Layer
10218     */
10219    enum _Elm_Gesture_State
10220      {
10221         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
10222         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
10223         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
10224         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
10225         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
10226      };
10227
10228    /**
10229     * @typedef Elm_Gesture_State
10230     * gesture states enum
10231     * @ingroup Elm_Gesture_Layer
10232     */
10233    typedef enum _Elm_Gesture_State Elm_Gesture_State;
10234
10235    /**
10236     * @struct _Elm_Gesture_Taps_Info
10237     * Struct holds taps info for user
10238     * @ingroup Elm_Gesture_Layer
10239     */
10240    struct _Elm_Gesture_Taps_Info
10241      {
10242         Evas_Coord x, y;         /**< Holds center point between fingers */
10243         unsigned int n;          /**< Number of fingers tapped           */
10244         unsigned int timestamp;  /**< event timestamp       */
10245      };
10246
10247    /**
10248     * @typedef Elm_Gesture_Taps_Info
10249     * holds taps info for user
10250     * @ingroup Elm_Gesture_Layer
10251     */
10252    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
10253
10254    /**
10255     * @struct _Elm_Gesture_Momentum_Info
10256     * Struct holds momentum info for user
10257     * x1 and y1 are not necessarily in sync
10258     * x1 holds x value of x direction starting point
10259     * and same holds for y1.
10260     * This is noticeable when doing V-shape movement
10261     * @ingroup Elm_Gesture_Layer
10262     */
10263    struct _Elm_Gesture_Momentum_Info
10264      {  /* Report line ends, timestamps, and momentum computed        */
10265         Evas_Coord x1; /**< Final-swipe direction starting point on X */
10266         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10267         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
10268         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
10269
10270         unsigned int tx; /**< Timestamp of start of final x-swipe */
10271         unsigned int ty; /**< Timestamp of start of final y-swipe */
10272
10273         Evas_Coord mx; /**< Momentum on X */
10274         Evas_Coord my; /**< Momentum on Y */
10275      };
10276
10277    /**
10278     * @typedef Elm_Gesture_Momentum_Info
10279     * holds momentum info for user
10280     * @ingroup Elm_Gesture_Layer
10281     */
10282     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10283
10284    /**
10285     * @struct _Elm_Gesture_Line_Info
10286     * Struct holds line info for user
10287     * @ingroup Elm_Gesture_Layer
10288     */
10289    struct _Elm_Gesture_Line_Info
10290      {  /* Report line ends, timestamps, and momentum computed      */
10291         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10292         unsigned int n;            /**< Number of fingers (lines)   */
10293         /* FIXME should be radians, bot degrees */
10294         double angle;              /**< Angle (direction) of lines  */
10295      };
10296
10297    /**
10298     * @typedef Elm_Gesture_Line_Info
10299     * Holds line info for user
10300     * @ingroup Elm_Gesture_Layer
10301     */
10302     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10303
10304    /**
10305     * @struct _Elm_Gesture_Zoom_Info
10306     * Struct holds zoom info for user
10307     * @ingroup Elm_Gesture_Layer
10308     */
10309    struct _Elm_Gesture_Zoom_Info
10310      {
10311         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
10312         Evas_Coord radius; /**< Holds radius between fingers reported to user */
10313         double zoom;            /**< Zoom value: 1.0 means no zoom             */
10314         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10315      };
10316
10317    /**
10318     * @typedef Elm_Gesture_Zoom_Info
10319     * Holds zoom info for user
10320     * @ingroup Elm_Gesture_Layer
10321     */
10322    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10323
10324    /**
10325     * @struct _Elm_Gesture_Rotate_Info
10326     * Struct holds rotation info for user
10327     * @ingroup Elm_Gesture_Layer
10328     */
10329    struct _Elm_Gesture_Rotate_Info
10330      {
10331         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
10332         Evas_Coord radius; /**< Holds radius between fingers reported to user */
10333         double base_angle; /**< Holds start-angle */
10334         double angle;      /**< Rotation value: 0.0 means no rotation         */
10335         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10336      };
10337
10338    /**
10339     * @typedef Elm_Gesture_Rotate_Info
10340     * Holds rotation info for user
10341     * @ingroup Elm_Gesture_Layer
10342     */
10343    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10344
10345    /**
10346     * @typedef Elm_Gesture_Event_Cb
10347     * User callback used to stream gesture info from gesture layer
10348     * @param data user data
10349     * @param event_info gesture report info
10350     * Returns a flag field to be applied on the causing event.
10351     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10352     * upon the event, in an irreversible way.
10353     *
10354     * @ingroup Elm_Gesture_Layer
10355     */
10356    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10357
10358    /**
10359     * Use function to set callbacks to be notified about
10360     * change of state of gesture.
10361     * When a user registers a callback with this function
10362     * this means this gesture has to be tested.
10363     *
10364     * When ALL callbacks for a gesture are set to NULL
10365     * it means user isn't interested in gesture-state
10366     * and it will not be tested.
10367     *
10368     * @param obj Pointer to gesture-layer.
10369     * @param idx The gesture you would like to track its state.
10370     * @param cb callback function pointer.
10371     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10372     * @param data user info to be sent to callback (usually, Smart Data)
10373     *
10374     * @ingroup Elm_Gesture_Layer
10375     */
10376    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);
10377
10378    /**
10379     * Call this function to get repeat-events settings.
10380     *
10381     * @param obj Pointer to gesture-layer.
10382     *
10383     * @return repeat events settings.
10384     * @see elm_gesture_layer_hold_events_set()
10385     * @ingroup Elm_Gesture_Layer
10386     */
10387    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10388
10389    /**
10390     * This function called in order to make gesture-layer repeat events.
10391     * Set this of you like to get the raw events only if gestures were not detected.
10392     * Clear this if you like gesture layer to fwd events as testing gestures.
10393     *
10394     * @param obj Pointer to gesture-layer.
10395     * @param r Repeat: TRUE/FALSE
10396     *
10397     * @ingroup Elm_Gesture_Layer
10398     */
10399    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10400
10401    /**
10402     * This function sets step-value for zoom action.
10403     * Set step to any positive value.
10404     * Cancel step setting by setting to 0.0
10405     *
10406     * @param obj Pointer to gesture-layer.
10407     * @param s new zoom step value.
10408     *
10409     * @ingroup Elm_Gesture_Layer
10410     */
10411    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10412
10413    /**
10414     * This function sets step-value for rotate action.
10415     * Set step to any positive value.
10416     * Cancel step setting by setting to 0.0
10417     *
10418     * @param obj Pointer to gesture-layer.
10419     * @param s new roatate step value.
10420     *
10421     * @ingroup Elm_Gesture_Layer
10422     */
10423    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10424
10425    /**
10426     * This function called to attach gesture-layer to an Evas_Object.
10427     * @param obj Pointer to gesture-layer.
10428     * @param t Pointer to underlying object (AKA Target)
10429     *
10430     * @return TRUE, FALSE on success, failure.
10431     *
10432     * @ingroup Elm_Gesture_Layer
10433     */
10434    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10435
10436    /**
10437     * Call this function to construct a new gesture-layer object.
10438     * This does not activate the gesture layer. You have to
10439     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10440     *
10441     * @param parent the parent object.
10442     *
10443     * @return Pointer to new gesture-layer object.
10444     *
10445     * @ingroup Elm_Gesture_Layer
10446     */
10447    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10448
10449    /**
10450     * @defgroup Thumb Thumb
10451     *
10452     * @image html img/widget/thumb/preview-00.png
10453     * @image latex img/widget/thumb/preview-00.eps
10454     *
10455     * A thumb object is used for displaying the thumbnail of an image or video.
10456     * You must have compiled Elementary with Ethumb_Client support and the DBus
10457     * service must be present and auto-activated in order to have thumbnails to
10458     * be generated.
10459     *
10460     * Once the thumbnail object becomes visible, it will check if there is a
10461     * previously generated thumbnail image for the file set on it. If not, it
10462     * will start generating this thumbnail.
10463     *
10464     * Different config settings will cause different thumbnails to be generated
10465     * even on the same file.
10466     *
10467     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10468     * Ethumb documentation to change this path, and to see other configuration
10469     * options.
10470     *
10471     * Signals that you can add callbacks for are:
10472     *
10473     * - "clicked" - This is called when a user has clicked the thumb without dragging
10474     *             around.
10475     * - "clicked,double" - This is called when a user has double-clicked the thumb.
10476     * - "press" - This is called when a user has pressed down the thumb.
10477     * - "generate,start" - The thumbnail generation started.
10478     * - "generate,stop" - The generation process stopped.
10479     * - "generate,error" - The generation failed.
10480     * - "load,error" - The thumbnail image loading failed.
10481     *
10482     * available styles:
10483     * - default
10484     * - noframe
10485     *
10486     * An example of use of thumbnail:
10487     *
10488     * - @ref thumb_example_01
10489     */
10490
10491    /**
10492     * @addtogroup Thumb
10493     * @{
10494     */
10495
10496    /**
10497     * @enum _Elm_Thumb_Animation_Setting
10498     * @typedef Elm_Thumb_Animation_Setting
10499     *
10500     * Used to set if a video thumbnail is animating or not.
10501     *
10502     * @ingroup Thumb
10503     */
10504    typedef enum _Elm_Thumb_Animation_Setting
10505      {
10506         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10507         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
10508         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
10509         ELM_THUMB_ANIMATION_LAST
10510      } Elm_Thumb_Animation_Setting;
10511
10512    /**
10513     * Add a new thumb object to the parent.
10514     *
10515     * @param parent The parent object.
10516     * @return The new object or NULL if it cannot be created.
10517     *
10518     * @see elm_thumb_file_set()
10519     * @see elm_thumb_ethumb_client_get()
10520     *
10521     * @ingroup Thumb
10522     */
10523    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10524    /**
10525     * Reload thumbnail if it was generated before.
10526     *
10527     * @param obj The thumb object to reload
10528     *
10529     * This is useful if the ethumb client configuration changed, like its
10530     * size, aspect or any other property one set in the handle returned
10531     * by elm_thumb_ethumb_client_get().
10532     *
10533     * If the options didn't change, the thumbnail won't be generated again, but
10534     * the old one will still be used.
10535     *
10536     * @see elm_thumb_file_set()
10537     *
10538     * @ingroup Thumb
10539     */
10540    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10541    /**
10542     * Set the file that will be used as thumbnail.
10543     *
10544     * @param obj The thumb object.
10545     * @param file The path to file that will be used as thumb.
10546     * @param key The key used in case of an EET file.
10547     *
10548     * The file can be an image or a video (in that case, acceptable extensions are:
10549     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10550     * function elm_thumb_animate().
10551     *
10552     * @see elm_thumb_file_get()
10553     * @see elm_thumb_reload()
10554     * @see elm_thumb_animate()
10555     *
10556     * @ingroup Thumb
10557     */
10558    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10559    /**
10560     * Get the image or video path and key used to generate the thumbnail.
10561     *
10562     * @param obj The thumb object.
10563     * @param file Pointer to filename.
10564     * @param key Pointer to key.
10565     *
10566     * @see elm_thumb_file_set()
10567     * @see elm_thumb_path_get()
10568     *
10569     * @ingroup Thumb
10570     */
10571    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10572    /**
10573     * Get the path and key to the image or video generated by ethumb.
10574     *
10575     * One just need to make sure that the thumbnail was generated before getting
10576     * its path; otherwise, the path will be NULL. One way to do that is by asking
10577     * for the path when/after the "generate,stop" smart callback is called.
10578     *
10579     * @param obj The thumb object.
10580     * @param file Pointer to thumb path.
10581     * @param key Pointer to thumb key.
10582     *
10583     * @see elm_thumb_file_get()
10584     *
10585     * @ingroup Thumb
10586     */
10587    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10588    /**
10589     * Set the animation state for the thumb object. If its content is an animated
10590     * video, you may start/stop the animation or tell it to play continuously and
10591     * looping.
10592     *
10593     * @param obj The thumb object.
10594     * @param setting The animation setting.
10595     *
10596     * @see elm_thumb_file_set()
10597     *
10598     * @ingroup Thumb
10599     */
10600    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10601    /**
10602     * Get the animation state for the thumb object.
10603     *
10604     * @param obj The thumb object.
10605     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10606     * on errors.
10607     *
10608     * @see elm_thumb_animate_set()
10609     *
10610     * @ingroup Thumb
10611     */
10612    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10613    /**
10614     * Get the ethumb_client handle so custom configuration can be made.
10615     *
10616     * @return Ethumb_Client instance or NULL.
10617     *
10618     * This must be called before the objects are created to be sure no object is
10619     * visible and no generation started.
10620     *
10621     * Example of usage:
10622     *
10623     * @code
10624     * #include <Elementary.h>
10625     * #ifndef ELM_LIB_QUICKLAUNCH
10626     * EAPI int
10627     * elm_main(int argc, char **argv)
10628     * {
10629     *    Ethumb_Client *client;
10630     *
10631     *    elm_need_ethumb();
10632     *
10633     *    // ... your code
10634     *
10635     *    client = elm_thumb_ethumb_client_get();
10636     *    if (!client)
10637     *      {
10638     *         ERR("could not get ethumb_client");
10639     *         return 1;
10640     *      }
10641     *    ethumb_client_size_set(client, 100, 100);
10642     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
10643     *    // ... your code
10644     *
10645     *    // Create elm_thumb objects here
10646     *
10647     *    elm_run();
10648     *    elm_shutdown();
10649     *    return 0;
10650     * }
10651     * #endif
10652     * ELM_MAIN()
10653     * @endcode
10654     *
10655     * @note There's only one client handle for Ethumb, so once a configuration
10656     * change is done to it, any other request for thumbnails (for any thumbnail
10657     * object) will use that configuration. Thus, this configuration is global.
10658     *
10659     * @ingroup Thumb
10660     */
10661    EAPI void                        *elm_thumb_ethumb_client_get(void);
10662    /**
10663     * Get the ethumb_client connection state.
10664     *
10665     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10666     * otherwise.
10667     */
10668    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
10669    /**
10670     * Make the thumbnail 'editable'.
10671     *
10672     * @param obj Thumb object.
10673     * @param set Turn on or off editability. Default is @c EINA_FALSE.
10674     *
10675     * This means the thumbnail is a valid drag target for drag and drop, and can be
10676     * cut or pasted too.
10677     *
10678     * @see elm_thumb_editable_get()
10679     *
10680     * @ingroup Thumb
10681     */
10682    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10683    /**
10684     * Make the thumbnail 'editable'.
10685     *
10686     * @param obj Thumb object.
10687     * @return Editability.
10688     *
10689     * This means the thumbnail is a valid drag target for drag and drop, and can be
10690     * cut or pasted too.
10691     *
10692     * @see elm_thumb_editable_set()
10693     *
10694     * @ingroup Thumb
10695     */
10696    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10697
10698    /**
10699     * @}
10700     */
10701
10702    /**
10703     * @defgroup Hoversel Hoversel
10704     *
10705     * @image html img/widget/hoversel/preview-00.png
10706     * @image latex img/widget/hoversel/preview-00.eps
10707     *
10708     * A hoversel is a button that pops up a list of items (automatically
10709     * choosing the direction to display) that have a label and, optionally, an
10710     * icon to select from. It is a convenience widget to avoid the need to do
10711     * all the piecing together yourself. It is intended for a small number of
10712     * items in the hoversel menu (no more than 8), though is capable of many
10713     * more.
10714     *
10715     * Signals that you can add callbacks for are:
10716     * "clicked" - the user clicked the hoversel button and popped up the sel
10717     * "selected" - an item in the hoversel list is selected. event_info is the item
10718     * "dismissed" - the hover is dismissed
10719     *
10720     * See @ref tutorial_hoversel for an example.
10721     * @{
10722     */
10723    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10724    /**
10725     * @brief Add a new Hoversel object
10726     *
10727     * @param parent The parent object
10728     * @return The new object or NULL if it cannot be created
10729     */
10730    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10731    /**
10732     * @brief This sets the hoversel to expand horizontally.
10733     *
10734     * @param obj The hoversel object
10735     * @param horizontal If true, the hover will expand horizontally to the
10736     * right.
10737     *
10738     * @note The initial button will display horizontally regardless of this
10739     * setting.
10740     */
10741    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10742    /**
10743     * @brief This returns whether the hoversel is set to expand horizontally.
10744     *
10745     * @param obj The hoversel object
10746     * @return If true, the hover will expand horizontally to the right.
10747     *
10748     * @see elm_hoversel_horizontal_set()
10749     */
10750    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10751    /**
10752     * @brief Set the Hover parent
10753     *
10754     * @param obj The hoversel object
10755     * @param parent The parent to use
10756     *
10757     * Sets the hover parent object, the area that will be darkened when the
10758     * hoversel is clicked. Should probably be the window that the hoversel is
10759     * in. See @ref Hover objects for more information.
10760     */
10761    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10762    /**
10763     * @brief Get the Hover parent
10764     *
10765     * @param obj The hoversel object
10766     * @return The used parent
10767     *
10768     * Gets the hover parent object.
10769     *
10770     * @see elm_hoversel_hover_parent_set()
10771     */
10772    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10773    /**
10774     * @brief Set the hoversel button label
10775     *
10776     * @param obj The hoversel object
10777     * @param label The label text.
10778     *
10779     * This sets the label of the button that is always visible (before it is
10780     * clicked and expanded).
10781     *
10782     * @deprecated elm_object_text_set()
10783     */
10784    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10785    /**
10786     * @brief Get the hoversel button label
10787     *
10788     * @param obj The hoversel object
10789     * @return The label text.
10790     *
10791     * @deprecated elm_object_text_get()
10792     */
10793    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10794    /**
10795     * @brief Set the icon of the hoversel button
10796     *
10797     * @param obj The hoversel object
10798     * @param icon The icon object
10799     *
10800     * Sets the icon of the button that is always visible (before it is clicked
10801     * and expanded).  Once the icon object is set, a previously set one will be
10802     * deleted, if you want to keep that old content object, use the
10803     * elm_hoversel_icon_unset() function.
10804     *
10805     * @see elm_button_icon_set()
10806     */
10807    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10808    /**
10809     * @brief Get the icon of the hoversel button
10810     *
10811     * @param obj The hoversel object
10812     * @return The icon object
10813     *
10814     * Get the icon of the button that is always visible (before it is clicked
10815     * and expanded). Also see elm_button_icon_get().
10816     *
10817     * @see elm_hoversel_icon_set()
10818     */
10819    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10820    /**
10821     * @brief Get and unparent the icon of the hoversel button
10822     *
10823     * @param obj The hoversel object
10824     * @return The icon object that was being used
10825     *
10826     * Unparent and return the icon of the button that is always visible
10827     * (before it is clicked and expanded).
10828     *
10829     * @see elm_hoversel_icon_set()
10830     * @see elm_button_icon_unset()
10831     */
10832    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10833    /**
10834     * @brief This triggers the hoversel popup from code, the same as if the user
10835     * had clicked the button.
10836     *
10837     * @param obj The hoversel object
10838     */
10839    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10840    /**
10841     * @brief This dismisses the hoversel popup as if the user had clicked
10842     * outside the hover.
10843     *
10844     * @param obj The hoversel object
10845     */
10846    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10847    /**
10848     * @brief Returns whether the hoversel is expanded.
10849     *
10850     * @param obj The hoversel object
10851     * @return  This will return EINA_TRUE if the hoversel is expanded or
10852     * EINA_FALSE if it is not expanded.
10853     */
10854    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10855    /**
10856     * @brief This will remove all the children items from the hoversel.
10857     *
10858     * @param obj The hoversel object
10859     *
10860     * @warning Should @b not be called while the hoversel is active; use
10861     * elm_hoversel_expanded_get() to check first.
10862     *
10863     * @see elm_hoversel_item_del_cb_set()
10864     * @see elm_hoversel_item_del()
10865     */
10866    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10867    /**
10868     * @brief Get the list of items within the given hoversel.
10869     *
10870     * @param obj The hoversel object
10871     * @return Returns a list of Elm_Hoversel_Item*
10872     *
10873     * @see elm_hoversel_item_add()
10874     */
10875    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10876    /**
10877     * @brief Add an item to the hoversel button
10878     *
10879     * @param obj The hoversel object
10880     * @param label The text label to use for the item (NULL if not desired)
10881     * @param icon_file An image file path on disk to use for the icon or standard
10882     * icon name (NULL if not desired)
10883     * @param icon_type The icon type if relevant
10884     * @param func Convenience function to call when this item is selected
10885     * @param data Data to pass to item-related functions
10886     * @return A handle to the item added.
10887     *
10888     * This adds an item to the hoversel to show when it is clicked. Note: if you
10889     * need to use an icon from an edje file then use
10890     * elm_hoversel_item_icon_set() right after the this function, and set
10891     * icon_file to NULL here.
10892     *
10893     * For more information on what @p icon_file and @p icon_type are see the
10894     * @ref Icon "icon documentation".
10895     */
10896    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);
10897    /**
10898     * @brief Delete an item from the hoversel
10899     *
10900     * @param item The item to delete
10901     *
10902     * This deletes the item from the hoversel (should not be called while the
10903     * hoversel is active; use elm_hoversel_expanded_get() to check first).
10904     *
10905     * @see elm_hoversel_item_add()
10906     * @see elm_hoversel_item_del_cb_set()
10907     */
10908    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10909    /**
10910     * @brief Set the function to be called when an item from the hoversel is
10911     * freed.
10912     *
10913     * @param item The item to set the callback on
10914     * @param func The function called
10915     *
10916     * That function will receive these parameters:
10917     * @li void *item_data
10918     * @li Evas_Object *the_item_object
10919     * @li Elm_Hoversel_Item *the_object_struct
10920     *
10921     * @see elm_hoversel_item_add()
10922     */
10923    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10924    /**
10925     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10926     * that will be passed to associated function callbacks.
10927     *
10928     * @param item The item to get the data from
10929     * @return The data pointer set with elm_hoversel_item_add()
10930     *
10931     * @see elm_hoversel_item_add()
10932     */
10933    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10934    /**
10935     * @brief This returns the label text of the given hoversel item.
10936     *
10937     * @param item The item to get the label
10938     * @return The label text of the hoversel item
10939     *
10940     * @see elm_hoversel_item_add()
10941     */
10942    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10943    /**
10944     * @brief This sets the icon for the given hoversel item.
10945     *
10946     * @param item The item to set the icon
10947     * @param icon_file An image file path on disk to use for the icon or standard
10948     * icon name
10949     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10950     * to NULL if the icon is not an edje file
10951     * @param icon_type The icon type
10952     *
10953     * The icon can be loaded from the standard set, from an image file, or from
10954     * an edje file.
10955     *
10956     * @see elm_hoversel_item_add()
10957     */
10958    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);
10959    /**
10960     * @brief Get the icon object of the hoversel item
10961     *
10962     * @param item The item to get the icon from
10963     * @param icon_file The image file path on disk used for the icon or standard
10964     * icon name
10965     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10966     * if the icon is not an edje file
10967     * @param icon_type The icon type
10968     *
10969     * @see elm_hoversel_item_icon_set()
10970     * @see elm_hoversel_item_add()
10971     */
10972    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);
10973    /**
10974     * @}
10975     */
10976
10977    /**
10978     * @defgroup Toolbar Toolbar
10979     * @ingroup Elementary
10980     *
10981     * @image html img/widget/toolbar/preview-00.png
10982     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10983     *
10984     * @image html img/toolbar.png
10985     * @image latex img/toolbar.eps width=\textwidth
10986     *
10987     * A toolbar is a widget that displays a list of items inside
10988     * a box. It can be scrollable, show a menu with items that don't fit
10989     * to toolbar size or even crop them.
10990     *
10991     * Only one item can be selected at a time.
10992     *
10993     * Items can have multiple states, or show menus when selected by the user.
10994     *
10995     * Smart callbacks one can listen to:
10996     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10997     *
10998     * Available styles for it:
10999     * - @c "default"
11000     * - @c "transparent" - no background or shadow, just show the content
11001     *
11002     * List of examples:
11003     * @li @ref toolbar_example_01
11004     * @li @ref toolbar_example_02
11005     * @li @ref toolbar_example_03
11006     */
11007
11008    /**
11009     * @addtogroup Toolbar
11010     * @{
11011     */
11012
11013    /**
11014     * @enum _Elm_Toolbar_Shrink_Mode
11015     * @typedef Elm_Toolbar_Shrink_Mode
11016     *
11017     * Set toolbar's items display behavior, it can be scrollabel,
11018     * show a menu with exceeding items, or simply hide them.
11019     *
11020     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
11021     * from elm config.
11022     *
11023     * Values <b> don't </b> work as bitmask, only one can be choosen.
11024     *
11025     * @see elm_toolbar_mode_shrink_set()
11026     * @see elm_toolbar_mode_shrink_get()
11027     *
11028     * @ingroup Toolbar
11029     */
11030    typedef enum _Elm_Toolbar_Shrink_Mode
11031      {
11032         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
11033         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
11034         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
11035         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
11036      } Elm_Toolbar_Shrink_Mode;
11037
11038    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(). */
11039
11040    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(). */
11041
11042    /**
11043     * Add a new toolbar widget to the given parent Elementary
11044     * (container) object.
11045     *
11046     * @param parent The parent object.
11047     * @return a new toolbar widget handle or @c NULL, on errors.
11048     *
11049     * This function inserts a new toolbar widget on the canvas.
11050     *
11051     * @ingroup Toolbar
11052     */
11053    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11054
11055    /**
11056     * Set the icon size, in pixels, to be used by toolbar items.
11057     *
11058     * @param obj The toolbar object
11059     * @param icon_size The icon size in pixels
11060     *
11061     * @note Default value is @c 32. It reads value from elm config.
11062     *
11063     * @see elm_toolbar_icon_size_get()
11064     *
11065     * @ingroup Toolbar
11066     */
11067    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
11068
11069    /**
11070     * Get the icon size, in pixels, to be used by toolbar items.
11071     *
11072     * @param obj The toolbar object.
11073     * @return The icon size in pixels.
11074     *
11075     * @see elm_toolbar_icon_size_set() for details.
11076     *
11077     * @ingroup Toolbar
11078     */
11079    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11080
11081    /**
11082     * Sets icon lookup order, for toolbar items' icons.
11083     *
11084     * @param obj The toolbar object.
11085     * @param order The icon lookup order.
11086     *
11087     * Icons added before calling this function will not be affected.
11088     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
11089     *
11090     * @see elm_toolbar_icon_order_lookup_get()
11091     *
11092     * @ingroup Toolbar
11093     */
11094    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
11095
11096    /**
11097     * Gets the icon lookup order.
11098     *
11099     * @param obj The toolbar object.
11100     * @return The icon lookup order.
11101     *
11102     * @see elm_toolbar_icon_order_lookup_set() for details.
11103     *
11104     * @ingroup Toolbar
11105     */
11106    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11107
11108    /**
11109     * Set whether the toolbar items' should be selected by the user or not.
11110     *
11111     * @param obj The toolbar object.
11112     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
11113     * enable it.
11114     *
11115     * This will turn off the ability to select items entirely and they will
11116     * neither appear selected nor emit selected signals. The clicked
11117     * callback function will still be called.
11118     *
11119     * Selection is enabled by default.
11120     *
11121     * @see elm_toolbar_no_select_mode_get().
11122     *
11123     * @ingroup Toolbar
11124     */
11125    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
11126
11127    /**
11128     * Set whether the toolbar items' should be selected by the user or not.
11129     *
11130     * @param obj The toolbar object.
11131     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
11132     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
11133     *
11134     * @see elm_toolbar_no_select_mode_set() for details.
11135     *
11136     * @ingroup Toolbar
11137     */
11138    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11139
11140    /**
11141     * Append item to the toolbar.
11142     *
11143     * @param obj The toolbar object.
11144     * @param icon A string with icon name or the absolute path of an image file.
11145     * @param label The label of the item.
11146     * @param func The function to call when the item is clicked.
11147     * @param data The data to associate with the item for related callbacks.
11148     * @return The created item or @c NULL upon failure.
11149     *
11150     * A new item will be created and appended to the toolbar, i.e., will
11151     * be set as @b last item.
11152     *
11153     * Items created with this method can be deleted with
11154     * elm_toolbar_item_del().
11155     *
11156     * Associated @p data can be properly freed when item is deleted if a
11157     * callback function is set with elm_toolbar_item_del_cb_set().
11158     *
11159     * If a function is passed as argument, it will be called everytime this item
11160     * is selected, i.e., the user clicks over an unselected item.
11161     * If such function isn't needed, just passing
11162     * @c NULL as @p func is enough. The same should be done for @p data.
11163     *
11164     * Toolbar will load icon image from fdo or current theme.
11165     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11166     * If an absolute path is provided it will load it direct from a file.
11167     *
11168     * @see elm_toolbar_item_icon_set()
11169     * @see elm_toolbar_item_del()
11170     * @see elm_toolbar_item_del_cb_set()
11171     *
11172     * @ingroup Toolbar
11173     */
11174    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);
11175
11176    /**
11177     * Prepend item to the toolbar.
11178     *
11179     * @param obj The toolbar object.
11180     * @param icon A string with icon name or the absolute path of an image file.
11181     * @param label The label of the item.
11182     * @param func The function to call when the item is clicked.
11183     * @param data The data to associate with the item for related callbacks.
11184     * @return The created item or @c NULL upon failure.
11185     *
11186     * A new item will be created and prepended to the toolbar, i.e., will
11187     * be set as @b first item.
11188     *
11189     * Items created with this method can be deleted with
11190     * elm_toolbar_item_del().
11191     *
11192     * Associated @p data can be properly freed when item is deleted if a
11193     * callback function is set with elm_toolbar_item_del_cb_set().
11194     *
11195     * If a function is passed as argument, it will be called everytime this item
11196     * is selected, i.e., the user clicks over an unselected item.
11197     * If such function isn't needed, just passing
11198     * @c NULL as @p func is enough. The same should be done for @p data.
11199     *
11200     * Toolbar will load icon image from fdo or current theme.
11201     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11202     * If an absolute path is provided it will load it direct from a file.
11203     *
11204     * @see elm_toolbar_item_icon_set()
11205     * @see elm_toolbar_item_del()
11206     * @see elm_toolbar_item_del_cb_set()
11207     *
11208     * @ingroup Toolbar
11209     */
11210    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);
11211
11212    /**
11213     * Insert a new item into the toolbar object before item @p before.
11214     *
11215     * @param obj The toolbar object.
11216     * @param before The toolbar item to insert before.
11217     * @param icon A string with icon name or the absolute path of an image file.
11218     * @param label The label of the item.
11219     * @param func The function to call when the item is clicked.
11220     * @param data The data to associate with the item for related callbacks.
11221     * @return The created item or @c NULL upon failure.
11222     *
11223     * A new item will be created and added to the toolbar. Its position in
11224     * this toolbar will be just before item @p before.
11225     *
11226     * Items created with this method can be deleted with
11227     * elm_toolbar_item_del().
11228     *
11229     * Associated @p data can be properly freed when item is deleted if a
11230     * callback function is set with elm_toolbar_item_del_cb_set().
11231     *
11232     * If a function is passed as argument, it will be called everytime this item
11233     * is selected, i.e., the user clicks over an unselected item.
11234     * If such function isn't needed, just passing
11235     * @c NULL as @p func is enough. The same should be done for @p data.
11236     *
11237     * Toolbar will load icon image from fdo or current theme.
11238     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11239     * If an absolute path is provided it will load it direct from a file.
11240     *
11241     * @see elm_toolbar_item_icon_set()
11242     * @see elm_toolbar_item_del()
11243     * @see elm_toolbar_item_del_cb_set()
11244     *
11245     * @ingroup Toolbar
11246     */
11247    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);
11248
11249    /**
11250     * Insert a new item into the toolbar object after item @p after.
11251     *
11252     * @param obj The toolbar object.
11253     * @param before The toolbar item to insert before.
11254     * @param icon A string with icon name or the absolute path of an image file.
11255     * @param label The label of the item.
11256     * @param func The function to call when the item is clicked.
11257     * @param data The data to associate with the item for related callbacks.
11258     * @return The created item or @c NULL upon failure.
11259     *
11260     * A new item will be created and added to the toolbar. Its position in
11261     * this toolbar will be just after item @p after.
11262     *
11263     * Items created with this method can be deleted with
11264     * elm_toolbar_item_del().
11265     *
11266     * Associated @p data can be properly freed when item is deleted if a
11267     * callback function is set with elm_toolbar_item_del_cb_set().
11268     *
11269     * If a function is passed as argument, it will be called everytime this item
11270     * is selected, i.e., the user clicks over an unselected item.
11271     * If such function isn't needed, just passing
11272     * @c NULL as @p func is enough. The same should be done for @p data.
11273     *
11274     * Toolbar will load icon image from fdo or current theme.
11275     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11276     * If an absolute path is provided it will load it direct from a file.
11277     *
11278     * @see elm_toolbar_item_icon_set()
11279     * @see elm_toolbar_item_del()
11280     * @see elm_toolbar_item_del_cb_set()
11281     *
11282     * @ingroup Toolbar
11283     */
11284    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);
11285
11286    /**
11287     * Get the first item in the given toolbar widget's list of
11288     * items.
11289     *
11290     * @param obj The toolbar object
11291     * @return The first item or @c NULL, if it has no items (and on
11292     * errors)
11293     *
11294     * @see elm_toolbar_item_append()
11295     * @see elm_toolbar_last_item_get()
11296     *
11297     * @ingroup Toolbar
11298     */
11299    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11300
11301    /**
11302     * Get the last item in the given toolbar widget's list of
11303     * items.
11304     *
11305     * @param obj The toolbar object
11306     * @return The last item or @c NULL, if it has no items (and on
11307     * errors)
11308     *
11309     * @see elm_toolbar_item_prepend()
11310     * @see elm_toolbar_first_item_get()
11311     *
11312     * @ingroup Toolbar
11313     */
11314    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11315
11316    /**
11317     * Get the item after @p item in toolbar.
11318     *
11319     * @param item The toolbar item.
11320     * @return The item after @p item, or @c NULL if none or on failure.
11321     *
11322     * @note If it is the last item, @c NULL will be returned.
11323     *
11324     * @see elm_toolbar_item_append()
11325     *
11326     * @ingroup Toolbar
11327     */
11328    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11329
11330    /**
11331     * Get the item before @p item in toolbar.
11332     *
11333     * @param item The toolbar item.
11334     * @return The item before @p item, or @c NULL if none or on failure.
11335     *
11336     * @note If it is the first item, @c NULL will be returned.
11337     *
11338     * @see elm_toolbar_item_prepend()
11339     *
11340     * @ingroup Toolbar
11341     */
11342    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11343
11344    /**
11345     * Get the toolbar object from an item.
11346     *
11347     * @param item The item.
11348     * @return The toolbar object.
11349     *
11350     * This returns the toolbar object itself that an item belongs to.
11351     *
11352     * @ingroup Toolbar
11353     */
11354    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11355
11356    /**
11357     * Set the priority of a toolbar item.
11358     *
11359     * @param item The toolbar item.
11360     * @param priority The item priority. The default is zero.
11361     *
11362     * This is used only when the toolbar shrink mode is set to
11363     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11364     * When space is less than required, items with low priority
11365     * will be removed from the toolbar and added to a dynamically-created menu,
11366     * while items with higher priority will remain on the toolbar,
11367     * with the same order they were added.
11368     *
11369     * @see elm_toolbar_item_priority_get()
11370     *
11371     * @ingroup Toolbar
11372     */
11373    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11374
11375    /**
11376     * Get the priority of a toolbar item.
11377     *
11378     * @param item The toolbar item.
11379     * @return The @p item priority, or @c 0 on failure.
11380     *
11381     * @see elm_toolbar_item_priority_set() for details.
11382     *
11383     * @ingroup Toolbar
11384     */
11385    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11386
11387    /**
11388     * Get the label of item.
11389     *
11390     * @param item The item of toolbar.
11391     * @return The label of item.
11392     *
11393     * The return value is a pointer to the label associated to @p item when
11394     * it was created, with function elm_toolbar_item_append() or similar,
11395     * or later,
11396     * with function elm_toolbar_item_label_set. If no label
11397     * was passed as argument, it will return @c NULL.
11398     *
11399     * @see elm_toolbar_item_label_set() for more details.
11400     * @see elm_toolbar_item_append()
11401     *
11402     * @ingroup Toolbar
11403     */
11404    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11405
11406    /**
11407     * Set the label of item.
11408     *
11409     * @param item The item of toolbar.
11410     * @param text The label of item.
11411     *
11412     * The label to be displayed by the item.
11413     * Label will be placed at icons bottom (if set).
11414     *
11415     * If a label was passed as argument on item creation, with function
11416     * elm_toolbar_item_append() or similar, it will be already
11417     * displayed by the item.
11418     *
11419     * @see elm_toolbar_item_label_get()
11420     * @see elm_toolbar_item_append()
11421     *
11422     * @ingroup Toolbar
11423     */
11424    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11425
11426    /**
11427     * Return the data associated with a given toolbar widget item.
11428     *
11429     * @param item The toolbar widget item handle.
11430     * @return The data associated with @p item.
11431     *
11432     * @see elm_toolbar_item_data_set()
11433     *
11434     * @ingroup Toolbar
11435     */
11436    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11437
11438    /**
11439     * Set the data associated with a given toolbar widget item.
11440     *
11441     * @param item The toolbar widget item handle.
11442     * @param data The new data pointer to set to @p item.
11443     *
11444     * This sets new item data on @p item.
11445     *
11446     * @warning The old data pointer won't be touched by this function, so
11447     * the user had better to free that old data himself/herself.
11448     *
11449     * @ingroup Toolbar
11450     */
11451    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11452
11453    /**
11454     * Returns a pointer to a toolbar item by its label.
11455     *
11456     * @param obj The toolbar object.
11457     * @param label The label of the item to find.
11458     *
11459     * @return The pointer to the toolbar item matching @p label or @c NULL
11460     * on failure.
11461     *
11462     * @ingroup Toolbar
11463     */
11464    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11465
11466    /*
11467     * Get whether the @p item is selected or not.
11468     *
11469     * @param item The toolbar item.
11470     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11471     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11472     *
11473     * @see elm_toolbar_selected_item_set() for details.
11474     * @see elm_toolbar_item_selected_get()
11475     *
11476     * @ingroup Toolbar
11477     */
11478    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11479
11480    /**
11481     * Set the selected state of an item.
11482     *
11483     * @param item The toolbar item
11484     * @param selected The selected state
11485     *
11486     * This sets the selected state of the given item @p it.
11487     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11488     *
11489     * If a new item is selected the previosly selected will be unselected.
11490     * Previoulsy selected item can be get with function
11491     * elm_toolbar_selected_item_get().
11492     *
11493     * Selected items will be highlighted.
11494     *
11495     * @see elm_toolbar_item_selected_get()
11496     * @see elm_toolbar_selected_item_get()
11497     *
11498     * @ingroup Toolbar
11499     */
11500    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11501
11502    /**
11503     * Get the selected item.
11504     *
11505     * @param obj The toolbar object.
11506     * @return The selected toolbar item.
11507     *
11508     * The selected item can be unselected with function
11509     * elm_toolbar_item_selected_set().
11510     *
11511     * The selected item always will be highlighted on toolbar.
11512     *
11513     * @see elm_toolbar_selected_items_get()
11514     *
11515     * @ingroup Toolbar
11516     */
11517    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11518
11519    /**
11520     * Set the icon associated with @p item.
11521     *
11522     * @param obj The parent of this item.
11523     * @param item The toolbar item.
11524     * @param icon A string with icon name or the absolute path of an image file.
11525     *
11526     * Toolbar will load icon image from fdo or current theme.
11527     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11528     * If an absolute path is provided it will load it direct from a file.
11529     *
11530     * @see elm_toolbar_icon_order_lookup_set()
11531     * @see elm_toolbar_icon_order_lookup_get()
11532     *
11533     * @ingroup Toolbar
11534     */
11535    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11536
11537    /**
11538     * Get the string used to set the icon of @p item.
11539     *
11540     * @param item The toolbar item.
11541     * @return The string associated with the icon object.
11542     *
11543     * @see elm_toolbar_item_icon_set() for details.
11544     *
11545     * @ingroup Toolbar
11546     */
11547    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11548
11549    /**
11550     * Delete them item from the toolbar.
11551     *
11552     * @param item The item of toolbar to be deleted.
11553     *
11554     * @see elm_toolbar_item_append()
11555     * @see elm_toolbar_item_del_cb_set()
11556     *
11557     * @ingroup Toolbar
11558     */
11559    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11560
11561    /**
11562     * Set the function called when a toolbar item is freed.
11563     *
11564     * @param item The item to set the callback on.
11565     * @param func The function called.
11566     *
11567     * If there is a @p func, then it will be called prior item's memory release.
11568     * That will be called with the following arguments:
11569     * @li item's data;
11570     * @li item's Evas object;
11571     * @li item itself;
11572     *
11573     * This way, a data associated to a toolbar item could be properly freed.
11574     *
11575     * @ingroup Toolbar
11576     */
11577    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11578
11579    /**
11580     * Get a value whether toolbar item is disabled or not.
11581     *
11582     * @param item The item.
11583     * @return The disabled state.
11584     *
11585     * @see elm_toolbar_item_disabled_set() for more details.
11586     *
11587     * @ingroup Toolbar
11588     */
11589    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11590
11591    /**
11592     * Sets the disabled/enabled state of a toolbar item.
11593     *
11594     * @param item The item.
11595     * @param disabled The disabled state.
11596     *
11597     * A disabled item cannot be selected or unselected. It will also
11598     * change its appearance (generally greyed out). This sets the
11599     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11600     * enabled).
11601     *
11602     * @ingroup Toolbar
11603     */
11604    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11605
11606    /**
11607     * Set or unset item as a separator.
11608     *
11609     * @param item The toolbar item.
11610     * @param setting @c EINA_TRUE to set item @p item as separator or
11611     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11612     *
11613     * Items aren't set as separator by default.
11614     *
11615     * If set as separator it will display separator theme, so won't display
11616     * icons or label.
11617     *
11618     * @see elm_toolbar_item_separator_get()
11619     *
11620     * @ingroup Toolbar
11621     */
11622    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11623
11624    /**
11625     * Get a value whether item is a separator or not.
11626     *
11627     * @param item The toolbar item.
11628     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11629     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11630     *
11631     * @see elm_toolbar_item_separator_set() for details.
11632     *
11633     * @ingroup Toolbar
11634     */
11635    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11636
11637    /**
11638     * Set the shrink state of toolbar @p obj.
11639     *
11640     * @param obj The toolbar object.
11641     * @param shrink_mode Toolbar's items display behavior.
11642     *
11643     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11644     * but will enforce a minimun size so all the items will fit, won't scroll
11645     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11646     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11647     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11648     *
11649     * @ingroup Toolbar
11650     */
11651    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11652
11653    /**
11654     * Get the shrink mode of toolbar @p obj.
11655     *
11656     * @param obj The toolbar object.
11657     * @return Toolbar's items display behavior.
11658     *
11659     * @see elm_toolbar_mode_shrink_set() for details.
11660     *
11661     * @ingroup Toolbar
11662     */
11663    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11664
11665    /**
11666     * Enable/disable homogenous mode.
11667     *
11668     * @param obj The toolbar object
11669     * @param homogeneous Assume the items within the toolbar are of the
11670     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11671     *
11672     * This will enable the homogeneous mode where items are of the same size.
11673     * @see elm_toolbar_homogeneous_get()
11674     *
11675     * @ingroup Toolbar
11676     */
11677    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11678
11679    /**
11680     * Get whether the homogenous mode is enabled.
11681     *
11682     * @param obj The toolbar object.
11683     * @return Assume the items within the toolbar are of the same height
11684     * and width (EINA_TRUE = on, EINA_FALSE = off).
11685     *
11686     * @see elm_toolbar_homogeneous_set()
11687     *
11688     * @ingroup Toolbar
11689     */
11690    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11691
11692    /**
11693     * Enable/disable homogenous mode.
11694     *
11695     * @param obj The toolbar object
11696     * @param homogeneous Assume the items within the toolbar are of the
11697     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11698     *
11699     * This will enable the homogeneous mode where items are of the same size.
11700     * @see elm_toolbar_homogeneous_get()
11701     *
11702     * @deprecated use elm_toolbar_homogeneous_set() instead.
11703     *
11704     * @ingroup Toolbar
11705     */
11706    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11707
11708    /**
11709     * Get whether the homogenous mode is enabled.
11710     *
11711     * @param obj The toolbar object.
11712     * @return Assume the items within the toolbar are of the same height
11713     * and width (EINA_TRUE = on, EINA_FALSE = off).
11714     *
11715     * @see elm_toolbar_homogeneous_set()
11716     * @deprecated use elm_toolbar_homogeneous_get() instead.
11717     *
11718     * @ingroup Toolbar
11719     */
11720    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11721
11722    /**
11723     * Set the parent object of the toolbar items' menus.
11724     *
11725     * @param obj The toolbar object.
11726     * @param parent The parent of the menu objects.
11727     *
11728     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11729     *
11730     * For more details about setting the parent for toolbar menus, see
11731     * elm_menu_parent_set().
11732     *
11733     * @see elm_menu_parent_set() for details.
11734     * @see elm_toolbar_item_menu_set() for details.
11735     *
11736     * @ingroup Toolbar
11737     */
11738    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11739
11740    /**
11741     * Get the parent object of the toolbar items' menus.
11742     *
11743     * @param obj The toolbar object.
11744     * @return The parent of the menu objects.
11745     *
11746     * @see elm_toolbar_menu_parent_set() for details.
11747     *
11748     * @ingroup Toolbar
11749     */
11750    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11751
11752    /**
11753     * Set the alignment of the items.
11754     *
11755     * @param obj The toolbar object.
11756     * @param align The new alignment, a float between <tt> 0.0 </tt>
11757     * and <tt> 1.0 </tt>.
11758     *
11759     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11760     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11761     * items.
11762     *
11763     * Centered items by default.
11764     *
11765     * @see elm_toolbar_align_get()
11766     *
11767     * @ingroup Toolbar
11768     */
11769    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11770
11771    /**
11772     * Get the alignment of the items.
11773     *
11774     * @param obj The toolbar object.
11775     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11776     * <tt> 1.0 </tt>.
11777     *
11778     * @see elm_toolbar_align_set() for details.
11779     *
11780     * @ingroup Toolbar
11781     */
11782    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11783
11784    /**
11785     * Set whether the toolbar item opens a menu.
11786     *
11787     * @param item The toolbar item.
11788     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11789     *
11790     * A toolbar item can be set to be a menu, using this function.
11791     *
11792     * Once it is set to be a menu, it can be manipulated through the
11793     * menu-like function elm_toolbar_menu_parent_set() and the other
11794     * elm_menu functions, using the Evas_Object @c menu returned by
11795     * elm_toolbar_item_menu_get().
11796     *
11797     * So, items to be displayed in this item's menu should be added with
11798     * elm_menu_item_add().
11799     *
11800     * The following code exemplifies the most basic usage:
11801     * @code
11802     * tb = elm_toolbar_add(win)
11803     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11804     * elm_toolbar_item_menu_set(item, EINA_TRUE);
11805     * elm_toolbar_menu_parent_set(tb, win);
11806     * menu = elm_toolbar_item_menu_get(item);
11807     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11808     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11809     * NULL);
11810     * @endcode
11811     *
11812     * @see elm_toolbar_item_menu_get()
11813     *
11814     * @ingroup Toolbar
11815     */
11816    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11817
11818    /**
11819     * Get toolbar item's menu.
11820     *
11821     * @param item The toolbar item.
11822     * @return Item's menu object or @c NULL on failure.
11823     *
11824     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11825     * this function will set it.
11826     *
11827     * @see elm_toolbar_item_menu_set() for details.
11828     *
11829     * @ingroup Toolbar
11830     */
11831    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11832
11833    /**
11834     * Add a new state to @p item.
11835     *
11836     * @param item The item.
11837     * @param icon A string with icon name or the absolute path of an image file.
11838     * @param label The label of the new state.
11839     * @param func The function to call when the item is clicked when this
11840     * state is selected.
11841     * @param data The data to associate with the state.
11842     * @return The toolbar item state, or @c NULL upon failure.
11843     *
11844     * Toolbar will load icon image from fdo or current theme.
11845     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11846     * If an absolute path is provided it will load it direct from a file.
11847     *
11848     * States created with this function can be removed with
11849     * elm_toolbar_item_state_del().
11850     *
11851     * @see elm_toolbar_item_state_del()
11852     * @see elm_toolbar_item_state_sel()
11853     * @see elm_toolbar_item_state_get()
11854     *
11855     * @ingroup Toolbar
11856     */
11857    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);
11858
11859    /**
11860     * Delete a previoulsy added state to @p item.
11861     *
11862     * @param item The toolbar item.
11863     * @param state The state to be deleted.
11864     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11865     *
11866     * @see elm_toolbar_item_state_add()
11867     */
11868    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11869
11870    /**
11871     * Set @p state as the current state of @p it.
11872     *
11873     * @param it The item.
11874     * @param state The state to use.
11875     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11876     *
11877     * If @p state is @c NULL, it won't select any state and the default item's
11878     * icon and label will be used. It's the same behaviour than
11879     * elm_toolbar_item_state_unser().
11880     *
11881     * @see elm_toolbar_item_state_unset()
11882     *
11883     * @ingroup Toolbar
11884     */
11885    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11886
11887    /**
11888     * Unset the state of @p it.
11889     *
11890     * @param it The item.
11891     *
11892     * The default icon and label from this item will be displayed.
11893     *
11894     * @see elm_toolbar_item_state_set() for more details.
11895     *
11896     * @ingroup Toolbar
11897     */
11898    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11899
11900    /**
11901     * Get the current state of @p it.
11902     *
11903     * @param item The item.
11904     * @return The selected state or @c NULL if none is selected or on failure.
11905     *
11906     * @see elm_toolbar_item_state_set() for details.
11907     * @see elm_toolbar_item_state_unset()
11908     * @see elm_toolbar_item_state_add()
11909     *
11910     * @ingroup Toolbar
11911     */
11912    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11913
11914    /**
11915     * Get the state after selected state in toolbar's @p item.
11916     *
11917     * @param it The toolbar item to change state.
11918     * @return The state after current state, or @c NULL on failure.
11919     *
11920     * If last state is selected, this function will return first state.
11921     *
11922     * @see elm_toolbar_item_state_set()
11923     * @see elm_toolbar_item_state_add()
11924     *
11925     * @ingroup Toolbar
11926     */
11927    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11928
11929    /**
11930     * Get the state before selected state in toolbar's @p item.
11931     *
11932     * @param it The toolbar item to change state.
11933     * @return The state before current state, or @c NULL on failure.
11934     *
11935     * If first state is selected, this function will return last state.
11936     *
11937     * @see elm_toolbar_item_state_set()
11938     * @see elm_toolbar_item_state_add()
11939     *
11940     * @ingroup Toolbar
11941     */
11942    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11943
11944    /**
11945     * Set the text to be shown in a given toolbar item's tooltips.
11946     *
11947     * @param item Target item.
11948     * @param text The text to set in the content.
11949     *
11950     * Setup the text as tooltip to object. The item can have only one tooltip,
11951     * so any previous tooltip data - set with this function or
11952     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11953     *
11954     * @see elm_object_tooltip_text_set() for more details.
11955     *
11956     * @ingroup Toolbar
11957     */
11958    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11959
11960    /**
11961     * Set the content to be shown in the tooltip item.
11962     *
11963     * Setup the tooltip to item. The item can have only one tooltip,
11964     * so any previous tooltip data is removed. @p func(with @p data) will
11965     * be called every time that need show the tooltip and it should
11966     * return a valid Evas_Object. This object is then managed fully by
11967     * tooltip system and is deleted when the tooltip is gone.
11968     *
11969     * @param item the toolbar item being attached a tooltip.
11970     * @param func the function used to create the tooltip contents.
11971     * @param data what to provide to @a func as callback data/context.
11972     * @param del_cb called when data is not needed anymore, either when
11973     *        another callback replaces @a func, the tooltip is unset with
11974     *        elm_toolbar_item_tooltip_unset() or the owner @a item
11975     *        dies. This callback receives as the first parameter the
11976     *        given @a data, and @c event_info is the item.
11977     *
11978     * @see elm_object_tooltip_content_cb_set() for more details.
11979     *
11980     * @ingroup Toolbar
11981     */
11982    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);
11983
11984    /**
11985     * Unset tooltip from item.
11986     *
11987     * @param item toolbar item to remove previously set tooltip.
11988     *
11989     * Remove tooltip from item. The callback provided as del_cb to
11990     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11991     * it is not used anymore.
11992     *
11993     * @see elm_object_tooltip_unset() for more details.
11994     * @see elm_toolbar_item_tooltip_content_cb_set()
11995     *
11996     * @ingroup Toolbar
11997     */
11998    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11999
12000    /**
12001     * Sets a different style for this item tooltip.
12002     *
12003     * @note before you set a style you should define a tooltip with
12004     *       elm_toolbar_item_tooltip_content_cb_set() or
12005     *       elm_toolbar_item_tooltip_text_set()
12006     *
12007     * @param item toolbar item with tooltip already set.
12008     * @param style the theme style to use (default, transparent, ...)
12009     *
12010     * @see elm_object_tooltip_style_set() for more details.
12011     *
12012     * @ingroup Toolbar
12013     */
12014    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
12015
12016    /**
12017     * Get the style for this item tooltip.
12018     *
12019     * @param item toolbar item with tooltip already set.
12020     * @return style the theme style in use, defaults to "default". If the
12021     *         object does not have a tooltip set, then NULL is returned.
12022     *
12023     * @see elm_object_tooltip_style_get() for more details.
12024     * @see elm_toolbar_item_tooltip_style_set()
12025     *
12026     * @ingroup Toolbar
12027     */
12028    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12029
12030    /**
12031     * Set the type of mouse pointer/cursor decoration to be shown,
12032     * when the mouse pointer is over the given toolbar widget item
12033     *
12034     * @param item toolbar item to customize cursor on
12035     * @param cursor the cursor type's name
12036     *
12037     * This function works analogously as elm_object_cursor_set(), but
12038     * here the cursor's changing area is restricted to the item's
12039     * area, and not the whole widget's. Note that that item cursors
12040     * have precedence over widget cursors, so that a mouse over an
12041     * item with custom cursor set will always show @b that cursor.
12042     *
12043     * If this function is called twice for an object, a previously set
12044     * cursor will be unset on the second call.
12045     *
12046     * @see elm_object_cursor_set()
12047     * @see elm_toolbar_item_cursor_get()
12048     * @see elm_toolbar_item_cursor_unset()
12049     *
12050     * @ingroup Toolbar
12051     */
12052    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
12053
12054    /*
12055     * Get the type of mouse pointer/cursor decoration set to be shown,
12056     * when the mouse pointer is over the given toolbar widget item
12057     *
12058     * @param item toolbar item with custom cursor set
12059     * @return the cursor type's name or @c NULL, if no custom cursors
12060     * were set to @p item (and on errors)
12061     *
12062     * @see elm_object_cursor_get()
12063     * @see elm_toolbar_item_cursor_set()
12064     * @see elm_toolbar_item_cursor_unset()
12065     *
12066     * @ingroup Toolbar
12067     */
12068    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12069
12070    /**
12071     * Unset any custom mouse pointer/cursor decoration set to be
12072     * shown, when the mouse pointer is over the given toolbar widget
12073     * item, thus making it show the @b default cursor again.
12074     *
12075     * @param item a toolbar item
12076     *
12077     * Use this call to undo any custom settings on this item's cursor
12078     * decoration, bringing it back to defaults (no custom style set).
12079     *
12080     * @see elm_object_cursor_unset()
12081     * @see elm_toolbar_item_cursor_set()
12082     *
12083     * @ingroup Toolbar
12084     */
12085    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12086
12087    /**
12088     * Set a different @b style for a given custom cursor set for a
12089     * toolbar item.
12090     *
12091     * @param item toolbar item with custom cursor set
12092     * @param style the <b>theme style</b> to use (e.g. @c "default",
12093     * @c "transparent", etc)
12094     *
12095     * This function only makes sense when one is using custom mouse
12096     * cursor decorations <b>defined in a theme file</b>, which can have,
12097     * given a cursor name/type, <b>alternate styles</b> on it. It
12098     * works analogously as elm_object_cursor_style_set(), but here
12099     * applyed only to toolbar item objects.
12100     *
12101     * @warning Before you set a cursor style you should have definen a
12102     *       custom cursor previously on the item, with
12103     *       elm_toolbar_item_cursor_set()
12104     *
12105     * @see elm_toolbar_item_cursor_engine_only_set()
12106     * @see elm_toolbar_item_cursor_style_get()
12107     *
12108     * @ingroup Toolbar
12109     */
12110    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
12111
12112    /**
12113     * Get the current @b style set for a given toolbar item's custom
12114     * cursor
12115     *
12116     * @param item toolbar item with custom cursor set.
12117     * @return style the cursor style in use. If the object does not
12118     *         have a cursor set, then @c NULL is returned.
12119     *
12120     * @see elm_toolbar_item_cursor_style_set() for more details
12121     *
12122     * @ingroup Toolbar
12123     */
12124    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12125
12126    /**
12127     * Set if the (custom)cursor for a given toolbar item should be
12128     * searched in its theme, also, or should only rely on the
12129     * rendering engine.
12130     *
12131     * @param item item with custom (custom) cursor already set on
12132     * @param engine_only Use @c EINA_TRUE to have cursors looked for
12133     * only on those provided by the rendering engine, @c EINA_FALSE to
12134     * have them searched on the widget's theme, as well.
12135     *
12136     * @note This call is of use only if you've set a custom cursor
12137     * for toolbar items, with elm_toolbar_item_cursor_set().
12138     *
12139     * @note By default, cursors will only be looked for between those
12140     * provided by the rendering engine.
12141     *
12142     * @ingroup Toolbar
12143     */
12144    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12145
12146    /**
12147     * Get if the (custom) cursor for a given toolbar item is being
12148     * searched in its theme, also, or is only relying on the rendering
12149     * engine.
12150     *
12151     * @param item a toolbar item
12152     * @return @c EINA_TRUE, if cursors are being looked for only on
12153     * those provided by the rendering engine, @c EINA_FALSE if they
12154     * are being searched on the widget's theme, as well.
12155     *
12156     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
12157     *
12158     * @ingroup Toolbar
12159     */
12160    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12161
12162    /**
12163     * Change a toolbar's orientation
12164     * @param obj The toolbar object
12165     * @param vertical If @c EINA_TRUE, the toolbar is vertical
12166     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
12167     * @ingroup Toolbar
12168     */
12169    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
12170
12171    /**
12172     * Get a toolbar's orientation
12173     * @param obj The toolbar object
12174     * @return If @c EINA_TRUE, the toolbar is vertical
12175     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
12176     * @ingroup Toolbar
12177     */
12178    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12179
12180    /**
12181     * @}
12182     */
12183
12184    /* tooltip */
12185    EAPI double       elm_tooltip_delay_get(void);
12186    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
12187    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
12188    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
12189    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
12190    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);
12191    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12192    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12193    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12194    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
12195    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12196    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12197    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12198    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12199    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12200    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12201    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
12202    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
12203
12204    /* cursors */
12205    EAPI int          elm_cursor_engine_only_get(void);
12206    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
12207
12208    /**
12209     * @defgroup Menu Menu
12210     *
12211     * @image html img/widget/menu/preview-00.png
12212     * @image latex img/widget/menu/preview-00.eps
12213     *
12214     * A menu is a list of items displayed above its parent. When the menu is
12215     * showing its parent is darkened. Each item can have a sub-menu. The menu
12216     * object can be used to display a menu on a right click event, in a toolbar,
12217     * anywhere.
12218     *
12219     * Signals that you can add callbacks for are:
12220     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
12221     *             event_info is NULL.
12222     *
12223     * @see @ref tutorial_menu
12224     * @{
12225     */
12226    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
12227    /**
12228     * @brief Add a new menu to the parent
12229     *
12230     * @param parent The parent object.
12231     * @return The new object or NULL if it cannot be created.
12232     */
12233    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12234    /**
12235     * @brief Set the parent for the given menu widget
12236     *
12237     * @param obj The menu object.
12238     * @param parent The new parent.
12239     */
12240    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12241    /**
12242     * @brief Get the parent for the given menu widget
12243     *
12244     * @param obj The menu object.
12245     * @return The parent.
12246     *
12247     * @see elm_menu_parent_set()
12248     */
12249    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12250    /**
12251     * @brief Move the menu to a new position
12252     *
12253     * @param obj The menu object.
12254     * @param x The new position.
12255     * @param y The new position.
12256     *
12257     * Sets the top-left position of the menu to (@p x,@p y).
12258     *
12259     * @note @p x and @p y coordinates are relative to parent.
12260     */
12261    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12262    /**
12263     * @brief Close a opened menu
12264     *
12265     * @param obj the menu object
12266     * @return void
12267     *
12268     * Hides the menu and all it's sub-menus.
12269     */
12270    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12271    /**
12272     * @brief Returns a list of @p item's items.
12273     *
12274     * @param obj The menu object
12275     * @return An Eina_List* of @p item's items
12276     */
12277    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12278    /**
12279     * @brief Get the Evas_Object of an Elm_Menu_Item
12280     *
12281     * @param item The menu item object.
12282     * @return The edje object containing the swallowed content
12283     *
12284     * @warning Don't manipulate this object!
12285     */
12286    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12287    /**
12288     * @brief Add an item at the end of the given menu widget
12289     *
12290     * @param obj The menu object.
12291     * @param parent The parent menu item (optional)
12292     * @param icon A icon display on the item. The icon will be destryed by the menu.
12293     * @param label The label of the item.
12294     * @param func Function called when the user select the item.
12295     * @param data Data sent by the callback.
12296     * @return Returns the new item.
12297     */
12298    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);
12299    /**
12300     * @brief Add an object swallowed in an item at the end of the given menu
12301     * widget
12302     *
12303     * @param obj The menu object.
12304     * @param parent The parent menu item (optional)
12305     * @param subobj The object to swallow
12306     * @param func Function called when the user select the item.
12307     * @param data Data sent by the callback.
12308     * @return Returns the new item.
12309     *
12310     * Add an evas object as an item to the menu.
12311     */
12312    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);
12313    /**
12314     * @brief Set the label of a menu item
12315     *
12316     * @param item The menu item object.
12317     * @param label The label to set for @p item
12318     *
12319     * @warning Don't use this funcion on items created with
12320     * elm_menu_item_add_object() or elm_menu_item_separator_add().
12321     */
12322    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12323    /**
12324     * @brief Get the label of a menu item
12325     *
12326     * @param item The menu item object.
12327     * @return The label of @p item
12328     */
12329    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12330    /**
12331     * @brief Set the icon of a menu item to the standard icon with name @p icon
12332     *
12333     * @param item The menu item object.
12334     * @param icon The icon object to set for the content of @p item
12335     *
12336     * Once this icon is set, any previously set icon will be deleted.
12337     */
12338    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12339    /**
12340     * @brief Get the string representation from the icon of a menu item
12341     *
12342     * @param item The menu item object.
12343     * @return The string representation of @p item's icon or NULL
12344     *
12345     * @see elm_menu_item_object_icon_name_set()
12346     */
12347    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12348    /**
12349     * @brief Set the content object of a menu item
12350     *
12351     * @param item The menu item object
12352     * @param The content object or NULL
12353     * @return EINA_TRUE on success, else EINA_FALSE
12354     *
12355     * Use this function to change the object swallowed by a menu item, deleting
12356     * any previously swallowed object.
12357     */
12358    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12359    /**
12360     * @brief Get the content object of a menu item
12361     *
12362     * @param item The menu item object
12363     * @return The content object or NULL
12364     * @note If @p item was added with elm_menu_item_add_object, this
12365     * function will return the object passed, else it will return the
12366     * icon object.
12367     *
12368     * @see elm_menu_item_object_content_set()
12369     */
12370    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12371    /**
12372     * @brief Set the selected state of @p item.
12373     *
12374     * @param item The menu item object.
12375     * @param selected The selected/unselected state of the item
12376     */
12377    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12378    /**
12379     * @brief Get the selected state of @p item.
12380     *
12381     * @param item The menu item object.
12382     * @return The selected/unselected state of the item
12383     *
12384     * @see elm_menu_item_selected_set()
12385     */
12386    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12387    /**
12388     * @brief Set the disabled state of @p item.
12389     *
12390     * @param item The menu item object.
12391     * @param disabled The enabled/disabled state of the item
12392     */
12393    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12394    /**
12395     * @brief Get the disabled state of @p item.
12396     *
12397     * @param item The menu item object.
12398     * @return The enabled/disabled state of the item
12399     *
12400     * @see elm_menu_item_disabled_set()
12401     */
12402    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12403    /**
12404     * @brief Add a separator item to menu @p obj under @p parent.
12405     *
12406     * @param obj The menu object
12407     * @param parent The item to add the separator under
12408     * @return The created item or NULL on failure
12409     *
12410     * This is item is a @ref Separator.
12411     */
12412    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12413    /**
12414     * @brief Returns whether @p item is a separator.
12415     *
12416     * @param item The item to check
12417     * @return If true, @p item is a separator
12418     *
12419     * @see elm_menu_item_separator_add()
12420     */
12421    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12422    /**
12423     * @brief Deletes an item from the menu.
12424     *
12425     * @param item The item to delete.
12426     *
12427     * @see elm_menu_item_add()
12428     */
12429    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12430    /**
12431     * @brief Set the function called when a menu item is deleted.
12432     *
12433     * @param item The item to set the callback on
12434     * @param func The function called
12435     *
12436     * @see elm_menu_item_add()
12437     * @see elm_menu_item_del()
12438     */
12439    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12440    /**
12441     * @brief Returns the data associated with menu item @p item.
12442     *
12443     * @param item The item
12444     * @return The data associated with @p item or NULL if none was set.
12445     *
12446     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12447     */
12448    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12449    /**
12450     * @brief Sets the data to be associated with menu item @p item.
12451     *
12452     * @param item The item
12453     * @param data The data to be associated with @p item
12454     */
12455    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12456    /**
12457     * @brief Returns a list of @p item's subitems.
12458     *
12459     * @param item The item
12460     * @return An Eina_List* of @p item's subitems
12461     *
12462     * @see elm_menu_add()
12463     */
12464    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12465    /**
12466     * @brief Get the position of a menu item
12467     *
12468     * @param item The menu item
12469     * @return The item's index
12470     *
12471     * This function returns the index position of a menu item in a menu.
12472     * For a sub-menu, this number is relative to the first item in the sub-menu.
12473     *
12474     * @note Index values begin with 0
12475     */
12476    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12477    /**
12478     * @brief @brief Return a menu item's owner menu
12479     *
12480     * @param item The menu item
12481     * @return The menu object owning @p item, or NULL on failure
12482     *
12483     * Use this function to get the menu object owning an item.
12484     */
12485    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12486    /**
12487     * @brief Get the selected item in the menu
12488     *
12489     * @param obj The menu object
12490     * @return The selected item, or NULL if none
12491     *
12492     * @see elm_menu_item_selected_get()
12493     * @see elm_menu_item_selected_set()
12494     */
12495    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12496    /**
12497     * @brief Get the last item in the menu
12498     *
12499     * @param obj The menu object
12500     * @return The last item, or NULL if none
12501     */
12502    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12503    /**
12504     * @brief Get the first item in the menu
12505     *
12506     * @param obj The menu object
12507     * @return The first item, or NULL if none
12508     */
12509    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12510    /**
12511     * @brief Get the next item in the menu.
12512     *
12513     * @param item The menu item object.
12514     * @return The item after it, or NULL if none
12515     */
12516    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12517    /**
12518     * @brief Get the previous item in the menu.
12519     *
12520     * @param item The menu item object.
12521     * @return The item before it, or NULL if none
12522     */
12523    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12524    /**
12525     * @}
12526     */
12527
12528    /**
12529     * @defgroup List List
12530     * @ingroup Elementary
12531     *
12532     * @image html img/widget/list/preview-00.png
12533     * @image latex img/widget/list/preview-00.eps width=\textwidth
12534     *
12535     * @image html img/list.png
12536     * @image latex img/list.eps width=\textwidth
12537     *
12538     * A list widget is a container whose children are displayed vertically or
12539     * horizontally, in order, and can be selected.
12540     * The list can accept only one or multiple items selection. Also has many
12541     * modes of items displaying.
12542     *
12543     * A list is a very simple type of list widget.  For more robust
12544     * lists, @ref Genlist should probably be used.
12545     *
12546     * Smart callbacks one can listen to:
12547     * - @c "activated" - The user has double-clicked or pressed
12548     *   (enter|return|spacebar) on an item. The @c event_info parameter
12549     *   is the item that was activated.
12550     * - @c "clicked,double" - The user has double-clicked an item.
12551     *   The @c event_info parameter is the item that was double-clicked.
12552     * - "selected" - when the user selected an item
12553     * - "unselected" - when the user unselected an item
12554     * - "longpressed" - an item in the list is long-pressed
12555     * - "scroll,edge,top" - the list is scrolled until the top edge
12556     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12557     * - "scroll,edge,left" - the list is scrolled until the left edge
12558     * - "scroll,edge,right" - the list is scrolled until the right edge
12559     *
12560     * Available styles for it:
12561     * - @c "default"
12562     *
12563     * List of examples:
12564     * @li @ref list_example_01
12565     * @li @ref list_example_02
12566     * @li @ref list_example_03
12567     */
12568
12569    /**
12570     * @addtogroup List
12571     * @{
12572     */
12573
12574    /**
12575     * @enum _Elm_List_Mode
12576     * @typedef Elm_List_Mode
12577     *
12578     * Set list's resize behavior, transverse axis scroll and
12579     * items cropping. See each mode's description for more details.
12580     *
12581     * @note Default value is #ELM_LIST_SCROLL.
12582     *
12583     * Values <b> don't </b> work as bitmask, only one can be choosen.
12584     *
12585     * @see elm_list_mode_set()
12586     * @see elm_list_mode_get()
12587     *
12588     * @ingroup List
12589     */
12590    typedef enum _Elm_List_Mode
12591      {
12592         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. */
12593         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). */
12594         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. */
12595         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. */
12596         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12597      } Elm_List_Mode;
12598
12599    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().  */
12600
12601    /**
12602     * Add a new list widget to the given parent Elementary
12603     * (container) object.
12604     *
12605     * @param parent The parent object.
12606     * @return a new list widget handle or @c NULL, on errors.
12607     *
12608     * This function inserts a new list widget on the canvas.
12609     *
12610     * @ingroup List
12611     */
12612    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12613
12614    /**
12615     * Starts the list.
12616     *
12617     * @param obj The list object
12618     *
12619     * @note Call before running show() on the list object.
12620     * @warning If not called, it won't display the list properly.
12621     *
12622     * @code
12623     * li = elm_list_add(win);
12624     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12625     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12626     * elm_list_go(li);
12627     * evas_object_show(li);
12628     * @endcode
12629     *
12630     * @ingroup List
12631     */
12632    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12633
12634    /**
12635     * Enable or disable multiple items selection on the list object.
12636     *
12637     * @param obj The list object
12638     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12639     * disable it.
12640     *
12641     * Disabled by default. If disabled, the user can select a single item of
12642     * the list each time. Selected items are highlighted on list.
12643     * If enabled, many items can be selected.
12644     *
12645     * If a selected item is selected again, it will be unselected.
12646     *
12647     * @see elm_list_multi_select_get()
12648     *
12649     * @ingroup List
12650     */
12651    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12652
12653    /**
12654     * Get a value whether multiple items selection is enabled or not.
12655     *
12656     * @see elm_list_multi_select_set() for details.
12657     *
12658     * @param obj The list object.
12659     * @return @c EINA_TRUE means multiple items selection is enabled.
12660     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12661     * @c EINA_FALSE is returned.
12662     *
12663     * @ingroup List
12664     */
12665    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12666
12667    /**
12668     * Set which mode to use for the list object.
12669     *
12670     * @param obj The list object
12671     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12672     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12673     *
12674     * Set list's resize behavior, transverse axis scroll and
12675     * items cropping. See each mode's description for more details.
12676     *
12677     * @note Default value is #ELM_LIST_SCROLL.
12678     *
12679     * Only one can be set, if a previous one was set, it will be changed
12680     * by the new mode set. Bitmask won't work as well.
12681     *
12682     * @see elm_list_mode_get()
12683     *
12684     * @ingroup List
12685     */
12686    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12687
12688    /**
12689     * Get the mode the list is at.
12690     *
12691     * @param obj The list object
12692     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12693     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12694     *
12695     * @note see elm_list_mode_set() for more information.
12696     *
12697     * @ingroup List
12698     */
12699    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12700
12701    /**
12702     * Enable or disable horizontal mode on the list object.
12703     *
12704     * @param obj The list object.
12705     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12706     * disable it, i.e., to enable vertical mode.
12707     *
12708     * @note Vertical mode is set by default.
12709     *
12710     * On horizontal mode items are displayed on list from left to right,
12711     * instead of from top to bottom. Also, the list will scroll horizontally.
12712     * Each item will presents left icon on top and right icon, or end, at
12713     * the bottom.
12714     *
12715     * @see elm_list_horizontal_get()
12716     *
12717     * @ingroup List
12718     */
12719    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12720
12721    /**
12722     * Get a value whether horizontal mode is enabled or not.
12723     *
12724     * @param obj The list object.
12725     * @return @c EINA_TRUE means horizontal mode selection is enabled.
12726     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12727     * @c EINA_FALSE is returned.
12728     *
12729     * @see elm_list_horizontal_set() for details.
12730     *
12731     * @ingroup List
12732     */
12733    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12734
12735    /**
12736     * Enable or disable always select mode on the list object.
12737     *
12738     * @param obj The list object
12739     * @param always_select @c EINA_TRUE to enable always select mode or
12740     * @c EINA_FALSE to disable it.
12741     *
12742     * @note Always select mode is disabled by default.
12743     *
12744     * Default behavior of list items is to only call its callback function
12745     * the first time it's pressed, i.e., when it is selected. If a selected
12746     * item is pressed again, and multi-select is disabled, it won't call
12747     * this function (if multi-select is enabled it will unselect the item).
12748     *
12749     * If always select is enabled, it will call the callback function
12750     * everytime a item is pressed, so it will call when the item is selected,
12751     * and again when a selected item is pressed.
12752     *
12753     * @see elm_list_always_select_mode_get()
12754     * @see elm_list_multi_select_set()
12755     *
12756     * @ingroup List
12757     */
12758    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12759
12760    /**
12761     * Get a value whether always select mode is enabled or not, meaning that
12762     * an item will always call its callback function, even if already selected.
12763     *
12764     * @param obj The list object
12765     * @return @c EINA_TRUE means horizontal mode selection is enabled.
12766     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12767     * @c EINA_FALSE is returned.
12768     *
12769     * @see elm_list_always_select_mode_set() for details.
12770     *
12771     * @ingroup List
12772     */
12773    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12774
12775    /**
12776     * Set bouncing behaviour when the scrolled content reaches an edge.
12777     *
12778     * Tell the internal scroller object whether it should bounce or not
12779     * when it reaches the respective edges for each axis.
12780     *
12781     * @param obj The list object
12782     * @param h_bounce Whether to bounce or not in the horizontal axis.
12783     * @param v_bounce Whether to bounce or not in the vertical axis.
12784     *
12785     * @see elm_scroller_bounce_set()
12786     *
12787     * @ingroup List
12788     */
12789    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12790
12791    /**
12792     * Get the bouncing behaviour of the internal scroller.
12793     *
12794     * Get whether the internal scroller should bounce when the edge of each
12795     * axis is reached scrolling.
12796     *
12797     * @param obj The list object.
12798     * @param h_bounce Pointer where to store the bounce state of the horizontal
12799     * axis.
12800     * @param v_bounce Pointer where to store the bounce state of the vertical
12801     * axis.
12802     *
12803     * @see elm_scroller_bounce_get()
12804     * @see elm_list_bounce_set()
12805     *
12806     * @ingroup List
12807     */
12808    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12809
12810    /**
12811     * Set the scrollbar policy.
12812     *
12813     * @param obj The list object
12814     * @param policy_h Horizontal scrollbar policy.
12815     * @param policy_v Vertical scrollbar policy.
12816     *
12817     * This sets the scrollbar visibility policy for the given scroller.
12818     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12819     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12820     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12821     * This applies respectively for the horizontal and vertical scrollbars.
12822     *
12823     * The both are disabled by default, i.e., are set to
12824     * #ELM_SCROLLER_POLICY_OFF.
12825     *
12826     * @ingroup List
12827     */
12828    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12829
12830    /**
12831     * Get the scrollbar policy.
12832     *
12833     * @see elm_list_scroller_policy_get() for details.
12834     *
12835     * @param obj The list object.
12836     * @param policy_h Pointer where to store horizontal scrollbar policy.
12837     * @param policy_v Pointer where to store vertical scrollbar policy.
12838     *
12839     * @ingroup List
12840     */
12841    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);
12842
12843    /**
12844     * Append a new item to the list object.
12845     *
12846     * @param obj The list object.
12847     * @param label The label of the list item.
12848     * @param icon The icon object to use for the left side of the item. An
12849     * icon can be any Evas object, but usually it is an icon created
12850     * with elm_icon_add().
12851     * @param end The icon object to use for the right side of the item. An
12852     * icon can be any Evas object.
12853     * @param func The function to call when the item is clicked.
12854     * @param data The data to associate with the item for related callbacks.
12855     *
12856     * @return The created item or @c NULL upon failure.
12857     *
12858     * A new item will be created and appended to the list, i.e., will
12859     * be set as @b last item.
12860     *
12861     * Items created with this method can be deleted with
12862     * elm_list_item_del().
12863     *
12864     * Associated @p data can be properly freed when item is deleted if a
12865     * callback function is set with elm_list_item_del_cb_set().
12866     *
12867     * If a function is passed as argument, it will be called everytime this item
12868     * is selected, i.e., the user clicks over an unselected item.
12869     * If always select is enabled it will call this function every time
12870     * user clicks over an item (already selected or not).
12871     * If such function isn't needed, just passing
12872     * @c NULL as @p func is enough. The same should be done for @p data.
12873     *
12874     * Simple example (with no function callback or data associated):
12875     * @code
12876     * li = elm_list_add(win);
12877     * ic = elm_icon_add(win);
12878     * elm_icon_file_set(ic, "path/to/image", NULL);
12879     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12880     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12881     * elm_list_go(li);
12882     * evas_object_show(li);
12883     * @endcode
12884     *
12885     * @see elm_list_always_select_mode_set()
12886     * @see elm_list_item_del()
12887     * @see elm_list_item_del_cb_set()
12888     * @see elm_list_clear()
12889     * @see elm_icon_add()
12890     *
12891     * @ingroup List
12892     */
12893    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);
12894
12895    /**
12896     * Prepend a new item to the list object.
12897     *
12898     * @param obj The list object.
12899     * @param label The label of the list item.
12900     * @param icon The icon object to use for the left side of the item. An
12901     * icon can be any Evas object, but usually it is an icon created
12902     * with elm_icon_add().
12903     * @param end The icon object to use for the right side of the item. An
12904     * icon can be any Evas object.
12905     * @param func The function to call when the item is clicked.
12906     * @param data The data to associate with the item for related callbacks.
12907     *
12908     * @return The created item or @c NULL upon failure.
12909     *
12910     * A new item will be created and prepended to the list, i.e., will
12911     * be set as @b first item.
12912     *
12913     * Items created with this method can be deleted with
12914     * elm_list_item_del().
12915     *
12916     * Associated @p data can be properly freed when item is deleted if a
12917     * callback function is set with elm_list_item_del_cb_set().
12918     *
12919     * If a function is passed as argument, it will be called everytime this item
12920     * is selected, i.e., the user clicks over an unselected item.
12921     * If always select is enabled it will call this function every time
12922     * user clicks over an item (already selected or not).
12923     * If such function isn't needed, just passing
12924     * @c NULL as @p func is enough. The same should be done for @p data.
12925     *
12926     * @see elm_list_item_append() for a simple code example.
12927     * @see elm_list_always_select_mode_set()
12928     * @see elm_list_item_del()
12929     * @see elm_list_item_del_cb_set()
12930     * @see elm_list_clear()
12931     * @see elm_icon_add()
12932     *
12933     * @ingroup List
12934     */
12935    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);
12936
12937    /**
12938     * Insert a new item into the list object before item @p before.
12939     *
12940     * @param obj The list object.
12941     * @param before The list item to insert before.
12942     * @param label The label of the list item.
12943     * @param icon The icon object to use for the left side of the item. An
12944     * icon can be any Evas object, but usually it is an icon created
12945     * with elm_icon_add().
12946     * @param end The icon object to use for the right side of the item. An
12947     * icon can be any Evas object.
12948     * @param func The function to call when the item is clicked.
12949     * @param data The data to associate with the item for related callbacks.
12950     *
12951     * @return The created item or @c NULL upon failure.
12952     *
12953     * A new item will be created and added to the list. Its position in
12954     * this list will be just before item @p before.
12955     *
12956     * Items created with this method can be deleted with
12957     * elm_list_item_del().
12958     *
12959     * Associated @p data can be properly freed when item is deleted if a
12960     * callback function is set with elm_list_item_del_cb_set().
12961     *
12962     * If a function is passed as argument, it will be called everytime this item
12963     * is selected, i.e., the user clicks over an unselected item.
12964     * If always select is enabled it will call this function every time
12965     * user clicks over an item (already selected or not).
12966     * If such function isn't needed, just passing
12967     * @c NULL as @p func is enough. The same should be done for @p data.
12968     *
12969     * @see elm_list_item_append() for a simple code example.
12970     * @see elm_list_always_select_mode_set()
12971     * @see elm_list_item_del()
12972     * @see elm_list_item_del_cb_set()
12973     * @see elm_list_clear()
12974     * @see elm_icon_add()
12975     *
12976     * @ingroup List
12977     */
12978    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);
12979
12980    /**
12981     * Insert a new item into the list object after item @p after.
12982     *
12983     * @param obj The list object.
12984     * @param after The list item to insert after.
12985     * @param label The label of the list item.
12986     * @param icon The icon object to use for the left side of the item. An
12987     * icon can be any Evas object, but usually it is an icon created
12988     * with elm_icon_add().
12989     * @param end The icon object to use for the right side of the item. An
12990     * icon can be any Evas object.
12991     * @param func The function to call when the item is clicked.
12992     * @param data The data to associate with the item for related callbacks.
12993     *
12994     * @return The created item or @c NULL upon failure.
12995     *
12996     * A new item will be created and added to the list. Its position in
12997     * this list will be just after item @p after.
12998     *
12999     * Items created with this method can be deleted with
13000     * elm_list_item_del().
13001     *
13002     * Associated @p data can be properly freed when item is deleted if a
13003     * callback function is set with elm_list_item_del_cb_set().
13004     *
13005     * If a function is passed as argument, it will be called everytime this item
13006     * is selected, i.e., the user clicks over an unselected item.
13007     * If always select is enabled it will call this function every time
13008     * user clicks over an item (already selected or not).
13009     * If such function isn't needed, just passing
13010     * @c NULL as @p func is enough. The same should be done for @p data.
13011     *
13012     * @see elm_list_item_append() for a simple code example.
13013     * @see elm_list_always_select_mode_set()
13014     * @see elm_list_item_del()
13015     * @see elm_list_item_del_cb_set()
13016     * @see elm_list_clear()
13017     * @see elm_icon_add()
13018     *
13019     * @ingroup List
13020     */
13021    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);
13022
13023    /**
13024     * Insert a new item into the sorted list object.
13025     *
13026     * @param obj The list object.
13027     * @param label The label of the list item.
13028     * @param icon The icon object to use for the left side of the item. An
13029     * icon can be any Evas object, but usually it is an icon created
13030     * with elm_icon_add().
13031     * @param end The icon object to use for the right side of the item. An
13032     * icon can be any Evas object.
13033     * @param func The function to call when the item is clicked.
13034     * @param data The data to associate with the item for related callbacks.
13035     * @param cmp_func The comparing function to be used to sort list
13036     * items <b>by #Elm_List_Item item handles</b>. This function will
13037     * receive two items and compare them, returning a non-negative integer
13038     * if the second item should be place after the first, or negative value
13039     * if should be placed before.
13040     *
13041     * @return The created item or @c NULL upon failure.
13042     *
13043     * @note This function inserts values into a list object assuming it was
13044     * sorted and the result will be sorted.
13045     *
13046     * A new item will be created and added to the list. Its position in
13047     * this list will be found comparing the new item with previously inserted
13048     * items using function @p cmp_func.
13049     *
13050     * Items created with this method can be deleted with
13051     * elm_list_item_del().
13052     *
13053     * Associated @p data can be properly freed when item is deleted if a
13054     * callback function is set with elm_list_item_del_cb_set().
13055     *
13056     * If a function is passed as argument, it will be called everytime this item
13057     * is selected, i.e., the user clicks over an unselected item.
13058     * If always select is enabled it will call this function every time
13059     * user clicks over an item (already selected or not).
13060     * If such function isn't needed, just passing
13061     * @c NULL as @p func is enough. The same should be done for @p data.
13062     *
13063     * @see elm_list_item_append() for a simple code example.
13064     * @see elm_list_always_select_mode_set()
13065     * @see elm_list_item_del()
13066     * @see elm_list_item_del_cb_set()
13067     * @see elm_list_clear()
13068     * @see elm_icon_add()
13069     *
13070     * @ingroup List
13071     */
13072    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);
13073
13074    /**
13075     * Remove all list's items.
13076     *
13077     * @param obj The list object
13078     *
13079     * @see elm_list_item_del()
13080     * @see elm_list_item_append()
13081     *
13082     * @ingroup List
13083     */
13084    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13085
13086    /**
13087     * Get a list of all the list items.
13088     *
13089     * @param obj The list object
13090     * @return An @c Eina_List of list items, #Elm_List_Item,
13091     * or @c NULL on failure.
13092     *
13093     * @see elm_list_item_append()
13094     * @see elm_list_item_del()
13095     * @see elm_list_clear()
13096     *
13097     * @ingroup List
13098     */
13099    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13100
13101    /**
13102     * Get the selected item.
13103     *
13104     * @param obj The list object.
13105     * @return The selected list item.
13106     *
13107     * The selected item can be unselected with function
13108     * elm_list_item_selected_set().
13109     *
13110     * The selected item always will be highlighted on list.
13111     *
13112     * @see elm_list_selected_items_get()
13113     *
13114     * @ingroup List
13115     */
13116    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13117
13118    /**
13119     * Return a list of the currently selected list items.
13120     *
13121     * @param obj The list object.
13122     * @return An @c Eina_List of list items, #Elm_List_Item,
13123     * or @c NULL on failure.
13124     *
13125     * Multiple items can be selected if multi select is enabled. It can be
13126     * done with elm_list_multi_select_set().
13127     *
13128     * @see elm_list_selected_item_get()
13129     * @see elm_list_multi_select_set()
13130     *
13131     * @ingroup List
13132     */
13133    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13134
13135    /**
13136     * Set the selected state of an item.
13137     *
13138     * @param item The list item
13139     * @param selected The selected state
13140     *
13141     * This sets the selected state of the given item @p it.
13142     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13143     *
13144     * If a new item is selected the previosly selected will be unselected,
13145     * unless multiple selection is enabled with elm_list_multi_select_set().
13146     * Previoulsy selected item can be get with function
13147     * elm_list_selected_item_get().
13148     *
13149     * Selected items will be highlighted.
13150     *
13151     * @see elm_list_item_selected_get()
13152     * @see elm_list_selected_item_get()
13153     * @see elm_list_multi_select_set()
13154     *
13155     * @ingroup List
13156     */
13157    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13158
13159    /*
13160     * Get whether the @p item is selected or not.
13161     *
13162     * @param item The list item.
13163     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13164     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13165     *
13166     * @see elm_list_selected_item_set() for details.
13167     * @see elm_list_item_selected_get()
13168     *
13169     * @ingroup List
13170     */
13171    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13172
13173    /**
13174     * Set or unset item as a separator.
13175     *
13176     * @param it The list item.
13177     * @param setting @c EINA_TRUE to set item @p it as separator or
13178     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13179     *
13180     * Items aren't set as separator by default.
13181     *
13182     * If set as separator it will display separator theme, so won't display
13183     * icons or label.
13184     *
13185     * @see elm_list_item_separator_get()
13186     *
13187     * @ingroup List
13188     */
13189    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
13190
13191    /**
13192     * Get a value whether item is a separator or not.
13193     *
13194     * @see elm_list_item_separator_set() for details.
13195     *
13196     * @param it The list item.
13197     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13198     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13199     *
13200     * @ingroup List
13201     */
13202    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13203
13204    /**
13205     * Show @p item in the list view.
13206     *
13207     * @param item The list item to be shown.
13208     *
13209     * It won't animate list until item is visible. If such behavior is wanted,
13210     * use elm_list_bring_in() intead.
13211     *
13212     * @ingroup List
13213     */
13214    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13215
13216    /**
13217     * Bring in the given item to list view.
13218     *
13219     * @param item The item.
13220     *
13221     * This causes list to jump to the given item @p item and show it
13222     * (by scrolling), if it is not fully visible.
13223     *
13224     * This may use animation to do so and take a period of time.
13225     *
13226     * If animation isn't wanted, elm_list_item_show() can be used.
13227     *
13228     * @ingroup List
13229     */
13230    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13231
13232    /**
13233     * Delete them item from the list.
13234     *
13235     * @param item The item of list to be deleted.
13236     *
13237     * If deleting all list items is required, elm_list_clear()
13238     * should be used instead of getting items list and deleting each one.
13239     *
13240     * @see elm_list_clear()
13241     * @see elm_list_item_append()
13242     * @see elm_list_item_del_cb_set()
13243     *
13244     * @ingroup List
13245     */
13246    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13247
13248    /**
13249     * Set the function called when a list item is freed.
13250     *
13251     * @param item The item to set the callback on
13252     * @param func The function called
13253     *
13254     * If there is a @p func, then it will be called prior item's memory release.
13255     * That will be called with the following arguments:
13256     * @li item's data;
13257     * @li item's Evas object;
13258     * @li item itself;
13259     *
13260     * This way, a data associated to a list item could be properly freed.
13261     *
13262     * @ingroup List
13263     */
13264    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13265
13266    /**
13267     * Get the data associated to the item.
13268     *
13269     * @param item The list item
13270     * @return The data associated to @p item
13271     *
13272     * The return value is a pointer to data associated to @p item when it was
13273     * created, with function elm_list_item_append() or similar. If no data
13274     * was passed as argument, it will return @c NULL.
13275     *
13276     * @see elm_list_item_append()
13277     *
13278     * @ingroup List
13279     */
13280    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13281
13282    /**
13283     * Get the left side icon associated to the item.
13284     *
13285     * @param item The list item
13286     * @return The left side icon associated to @p item
13287     *
13288     * The return value is a pointer to the icon associated to @p item when
13289     * it was
13290     * created, with function elm_list_item_append() or similar, or later
13291     * with function elm_list_item_icon_set(). If no icon
13292     * was passed as argument, it will return @c NULL.
13293     *
13294     * @see elm_list_item_append()
13295     * @see elm_list_item_icon_set()
13296     *
13297     * @ingroup List
13298     */
13299    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13300
13301    /**
13302     * Set the left side icon associated to the item.
13303     *
13304     * @param item The list item
13305     * @param icon The left side icon object to associate with @p item
13306     *
13307     * The icon object to use at left side of the item. An
13308     * icon can be any Evas object, but usually it is an icon created
13309     * with elm_icon_add().
13310     *
13311     * Once the icon object is set, a previously set one will be deleted.
13312     * @warning Setting the same icon for two items will cause the icon to
13313     * dissapear from the first item.
13314     *
13315     * If an icon was passed as argument on item creation, with function
13316     * elm_list_item_append() or similar, it will be already
13317     * associated to the item.
13318     *
13319     * @see elm_list_item_append()
13320     * @see elm_list_item_icon_get()
13321     *
13322     * @ingroup List
13323     */
13324    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13325
13326    /**
13327     * Get the right side icon associated to the item.
13328     *
13329     * @param item The list item
13330     * @return The right side icon associated to @p item
13331     *
13332     * The return value is a pointer to the icon associated to @p item when
13333     * it was
13334     * created, with function elm_list_item_append() or similar, or later
13335     * with function elm_list_item_icon_set(). If no icon
13336     * was passed as argument, it will return @c NULL.
13337     *
13338     * @see elm_list_item_append()
13339     * @see elm_list_item_icon_set()
13340     *
13341     * @ingroup List
13342     */
13343    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13344
13345    /**
13346     * Set the right side icon associated to the item.
13347     *
13348     * @param item The list item
13349     * @param end The right side icon object to associate with @p item
13350     *
13351     * The icon object to use at right side of the item. An
13352     * icon can be any Evas object, but usually it is an icon created
13353     * with elm_icon_add().
13354     *
13355     * Once the icon object is set, a previously set one will be deleted.
13356     * @warning Setting the same icon for two items will cause the icon to
13357     * dissapear from the first item.
13358     *
13359     * If an icon was passed as argument on item creation, with function
13360     * elm_list_item_append() or similar, it will be already
13361     * associated to the item.
13362     *
13363     * @see elm_list_item_append()
13364     * @see elm_list_item_end_get()
13365     *
13366     * @ingroup List
13367     */
13368    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13369
13370    /**
13371     * Gets the base object of the item.
13372     *
13373     * @param item The list item
13374     * @return The base object associated with @p item
13375     *
13376     * Base object is the @c Evas_Object that represents that item.
13377     *
13378     * @ingroup List
13379     */
13380    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13381
13382    /**
13383     * Get the label of item.
13384     *
13385     * @param item The item of list.
13386     * @return The label of item.
13387     *
13388     * The return value is a pointer to the label associated to @p item when
13389     * it was created, with function elm_list_item_append(), or later
13390     * with function elm_list_item_label_set. If no label
13391     * was passed as argument, it will return @c NULL.
13392     *
13393     * @see elm_list_item_label_set() for more details.
13394     * @see elm_list_item_append()
13395     *
13396     * @ingroup List
13397     */
13398    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13399
13400    /**
13401     * Set the label of item.
13402     *
13403     * @param item The item of list.
13404     * @param text The label of item.
13405     *
13406     * The label to be displayed by the item.
13407     * Label will be placed between left and right side icons (if set).
13408     *
13409     * If a label was passed as argument on item creation, with function
13410     * elm_list_item_append() or similar, it will be already
13411     * displayed by the item.
13412     *
13413     * @see elm_list_item_label_get()
13414     * @see elm_list_item_append()
13415     *
13416     * @ingroup List
13417     */
13418    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13419
13420
13421    /**
13422     * Get the item before @p it in list.
13423     *
13424     * @param it The list item.
13425     * @return The item before @p it, or @c NULL if none or on failure.
13426     *
13427     * @note If it is the first item, @c NULL will be returned.
13428     *
13429     * @see elm_list_item_append()
13430     * @see elm_list_items_get()
13431     *
13432     * @ingroup List
13433     */
13434    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13435
13436    /**
13437     * Get the item after @p it in list.
13438     *
13439     * @param it The list item.
13440     * @return The item after @p it, or @c NULL if none or on failure.
13441     *
13442     * @note If it is the last item, @c NULL will be returned.
13443     *
13444     * @see elm_list_item_append()
13445     * @see elm_list_items_get()
13446     *
13447     * @ingroup List
13448     */
13449    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13450
13451    /**
13452     * Sets the disabled/enabled state of a list item.
13453     *
13454     * @param it The item.
13455     * @param disabled The disabled state.
13456     *
13457     * A disabled item cannot be selected or unselected. It will also
13458     * change its appearance (generally greyed out). This sets the
13459     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13460     * enabled).
13461     *
13462     * @ingroup List
13463     */
13464    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13465
13466    /**
13467     * Get a value whether list item is disabled or not.
13468     *
13469     * @param it The item.
13470     * @return The disabled state.
13471     *
13472     * @see elm_list_item_disabled_set() for more details.
13473     *
13474     * @ingroup List
13475     */
13476    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13477
13478    /**
13479     * Set the text to be shown in a given list item's tooltips.
13480     *
13481     * @param item Target item.
13482     * @param text The text to set in the content.
13483     *
13484     * Setup the text as tooltip to object. The item can have only one tooltip,
13485     * so any previous tooltip data - set with this function or
13486     * elm_list_item_tooltip_content_cb_set() - is removed.
13487     *
13488     * @see elm_object_tooltip_text_set() for more details.
13489     *
13490     * @ingroup List
13491     */
13492    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13493
13494
13495    /**
13496     * @brief Disable size restrictions on an object's tooltip
13497     * @param item The tooltip's anchor object
13498     * @param disable If EINA_TRUE, size restrictions are disabled
13499     * @return EINA_FALSE on failure, EINA_TRUE on success
13500     *
13501     * This function allows a tooltip to expand beyond its parant window's canvas.
13502     * It will instead be limited only by the size of the display.
13503     */
13504    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13505    /**
13506     * @brief Retrieve size restriction state of an object's tooltip
13507     * @param obj The tooltip's anchor object
13508     * @return If EINA_TRUE, size restrictions are disabled
13509     *
13510     * This function returns whether a tooltip is allowed to expand beyond
13511     * its parant window's canvas.
13512     * It will instead be limited only by the size of the display.
13513     */
13514    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13515
13516    /**
13517     * Set the content to be shown in the tooltip item.
13518     *
13519     * Setup the tooltip to item. The item can have only one tooltip,
13520     * so any previous tooltip data is removed. @p func(with @p data) will
13521     * be called every time that need show the tooltip and it should
13522     * return a valid Evas_Object. This object is then managed fully by
13523     * tooltip system and is deleted when the tooltip is gone.
13524     *
13525     * @param item the list item being attached a tooltip.
13526     * @param func the function used to create the tooltip contents.
13527     * @param data what to provide to @a func as callback data/context.
13528     * @param del_cb called when data is not needed anymore, either when
13529     *        another callback replaces @a func, the tooltip is unset with
13530     *        elm_list_item_tooltip_unset() or the owner @a item
13531     *        dies. This callback receives as the first parameter the
13532     *        given @a data, and @c event_info is the item.
13533     *
13534     * @see elm_object_tooltip_content_cb_set() for more details.
13535     *
13536     * @ingroup List
13537     */
13538    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);
13539
13540    /**
13541     * Unset tooltip from item.
13542     *
13543     * @param item list item to remove previously set tooltip.
13544     *
13545     * Remove tooltip from item. The callback provided as del_cb to
13546     * elm_list_item_tooltip_content_cb_set() will be called to notify
13547     * it is not used anymore.
13548     *
13549     * @see elm_object_tooltip_unset() for more details.
13550     * @see elm_list_item_tooltip_content_cb_set()
13551     *
13552     * @ingroup List
13553     */
13554    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13555
13556    /**
13557     * Sets a different style for this item tooltip.
13558     *
13559     * @note before you set a style you should define a tooltip with
13560     *       elm_list_item_tooltip_content_cb_set() or
13561     *       elm_list_item_tooltip_text_set()
13562     *
13563     * @param item list item with tooltip already set.
13564     * @param style the theme style to use (default, transparent, ...)
13565     *
13566     * @see elm_object_tooltip_style_set() for more details.
13567     *
13568     * @ingroup List
13569     */
13570    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13571
13572    /**
13573     * Get the style for this item tooltip.
13574     *
13575     * @param item list item with tooltip already set.
13576     * @return style the theme style in use, defaults to "default". If the
13577     *         object does not have a tooltip set, then NULL is returned.
13578     *
13579     * @see elm_object_tooltip_style_get() for more details.
13580     * @see elm_list_item_tooltip_style_set()
13581     *
13582     * @ingroup List
13583     */
13584    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13585
13586    /**
13587     * Set the type of mouse pointer/cursor decoration to be shown,
13588     * when the mouse pointer is over the given list widget item
13589     *
13590     * @param item list item to customize cursor on
13591     * @param cursor the cursor type's name
13592     *
13593     * This function works analogously as elm_object_cursor_set(), but
13594     * here the cursor's changing area is restricted to the item's
13595     * area, and not the whole widget's. Note that that item cursors
13596     * have precedence over widget cursors, so that a mouse over an
13597     * item with custom cursor set will always show @b that cursor.
13598     *
13599     * If this function is called twice for an object, a previously set
13600     * cursor will be unset on the second call.
13601     *
13602     * @see elm_object_cursor_set()
13603     * @see elm_list_item_cursor_get()
13604     * @see elm_list_item_cursor_unset()
13605     *
13606     * @ingroup List
13607     */
13608    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13609
13610    /*
13611     * Get the type of mouse pointer/cursor decoration set to be shown,
13612     * when the mouse pointer is over the given list widget item
13613     *
13614     * @param item list item with custom cursor set
13615     * @return the cursor type's name or @c NULL, if no custom cursors
13616     * were set to @p item (and on errors)
13617     *
13618     * @see elm_object_cursor_get()
13619     * @see elm_list_item_cursor_set()
13620     * @see elm_list_item_cursor_unset()
13621     *
13622     * @ingroup List
13623     */
13624    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13625
13626    /**
13627     * Unset any custom mouse pointer/cursor decoration set to be
13628     * shown, when the mouse pointer is over the given list widget
13629     * item, thus making it show the @b default cursor again.
13630     *
13631     * @param item a list item
13632     *
13633     * Use this call to undo any custom settings on this item's cursor
13634     * decoration, bringing it back to defaults (no custom style set).
13635     *
13636     * @see elm_object_cursor_unset()
13637     * @see elm_list_item_cursor_set()
13638     *
13639     * @ingroup List
13640     */
13641    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13642
13643    /**
13644     * Set a different @b style for a given custom cursor set for a
13645     * list item.
13646     *
13647     * @param item list item with custom cursor set
13648     * @param style the <b>theme style</b> to use (e.g. @c "default",
13649     * @c "transparent", etc)
13650     *
13651     * This function only makes sense when one is using custom mouse
13652     * cursor decorations <b>defined in a theme file</b>, which can have,
13653     * given a cursor name/type, <b>alternate styles</b> on it. It
13654     * works analogously as elm_object_cursor_style_set(), but here
13655     * applyed only to list item objects.
13656     *
13657     * @warning Before you set a cursor style you should have definen a
13658     *       custom cursor previously on the item, with
13659     *       elm_list_item_cursor_set()
13660     *
13661     * @see elm_list_item_cursor_engine_only_set()
13662     * @see elm_list_item_cursor_style_get()
13663     *
13664     * @ingroup List
13665     */
13666    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13667
13668    /**
13669     * Get the current @b style set for a given list item's custom
13670     * cursor
13671     *
13672     * @param item list item with custom cursor set.
13673     * @return style the cursor style in use. If the object does not
13674     *         have a cursor set, then @c NULL is returned.
13675     *
13676     * @see elm_list_item_cursor_style_set() for more details
13677     *
13678     * @ingroup List
13679     */
13680    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13681
13682    /**
13683     * Set if the (custom)cursor for a given list item should be
13684     * searched in its theme, also, or should only rely on the
13685     * rendering engine.
13686     *
13687     * @param item item with custom (custom) cursor already set on
13688     * @param engine_only Use @c EINA_TRUE to have cursors looked for
13689     * only on those provided by the rendering engine, @c EINA_FALSE to
13690     * have them searched on the widget's theme, as well.
13691     *
13692     * @note This call is of use only if you've set a custom cursor
13693     * for list items, with elm_list_item_cursor_set().
13694     *
13695     * @note By default, cursors will only be looked for between those
13696     * provided by the rendering engine.
13697     *
13698     * @ingroup List
13699     */
13700    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13701
13702    /**
13703     * Get if the (custom) cursor for a given list item is being
13704     * searched in its theme, also, or is only relying on the rendering
13705     * engine.
13706     *
13707     * @param item a list item
13708     * @return @c EINA_TRUE, if cursors are being looked for only on
13709     * those provided by the rendering engine, @c EINA_FALSE if they
13710     * are being searched on the widget's theme, as well.
13711     *
13712     * @see elm_list_item_cursor_engine_only_set(), for more details
13713     *
13714     * @ingroup List
13715     */
13716    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13717
13718    /**
13719     * @}
13720     */
13721
13722    /**
13723     * @defgroup Slider Slider
13724     * @ingroup Elementary
13725     *
13726     * @image html img/widget/slider/preview-00.png
13727     * @image latex img/widget/slider/preview-00.eps width=\textwidth
13728     *
13729     * The slider adds a dragable “slider” widget for selecting the value of
13730     * something within a range.
13731     *
13732     * A slider can be horizontal or vertical. It can contain an Icon and has a
13733     * primary label as well as a units label (that is formatted with floating
13734     * point values and thus accepts a printf-style format string, like
13735     * “%1.2f units”. There is also an indicator string that may be somewhere
13736     * else (like on the slider itself) that also accepts a format string like
13737     * units. Label, Icon Unit and Indicator strings/objects are optional.
13738     *
13739     * A slider may be inverted which means values invert, with high vales being
13740     * on the left or top and low values on the right or bottom (as opposed to
13741     * normally being low on the left or top and high on the bottom and right).
13742     *
13743     * The slider should have its minimum and maximum values set by the
13744     * application with  elm_slider_min_max_set() and value should also be set by
13745     * the application before use with  elm_slider_value_set(). The span of the
13746     * slider is its length (horizontally or vertically). This will be scaled by
13747     * the object or applications scaling factor. At any point code can query the
13748     * slider for its value with elm_slider_value_get().
13749     *
13750     * Smart callbacks one can listen to:
13751     * - "changed" - Whenever the slider value is changed by the user.
13752     * - "slider,drag,start" - dragging the slider indicator around has started.
13753     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13754     * - "delay,changed" - A short time after the value is changed by the user.
13755     * This will be called only when the user stops dragging for
13756     * a very short period or when they release their
13757     * finger/mouse, so it avoids possibly expensive reactions to
13758     * the value change.
13759     *
13760     * Available styles for it:
13761     * - @c "default"
13762     *
13763     * Here is an example on its usage:
13764     * @li @ref slider_example
13765     */
13766
13767    /**
13768     * @addtogroup Slider
13769     * @{
13770     */
13771
13772    /**
13773     * Add a new slider widget to the given parent Elementary
13774     * (container) object.
13775     *
13776     * @param parent The parent object.
13777     * @return a new slider widget handle or @c NULL, on errors.
13778     *
13779     * This function inserts a new slider widget on the canvas.
13780     *
13781     * @ingroup Slider
13782     */
13783    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13784
13785    /**
13786     * Set the label of a given slider widget
13787     *
13788     * @param obj The progress bar object
13789     * @param label The text label string, in UTF-8
13790     *
13791     * @ingroup Slider
13792     * @deprecated use elm_object_text_set() instead.
13793     */
13794    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13795
13796    /**
13797     * Get the label of a given slider widget
13798     *
13799     * @param obj The progressbar object
13800     * @return The text label string, in UTF-8
13801     *
13802     * @ingroup Slider
13803     * @deprecated use elm_object_text_get() instead.
13804     */
13805    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13806
13807    /**
13808     * Set the icon object of the slider object.
13809     *
13810     * @param obj The slider object.
13811     * @param icon The icon object.
13812     *
13813     * On horizontal mode, icon is placed at left, and on vertical mode,
13814     * placed at top.
13815     *
13816     * @note Once the icon object is set, a previously set one will be deleted.
13817     * If you want to keep that old content object, use the
13818     * elm_slider_icon_unset() function.
13819     *
13820     * @warning If the object being set does not have minimum size hints set,
13821     * it won't get properly displayed.
13822     *
13823     * @ingroup Slider
13824     */
13825    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13826
13827    /**
13828     * Unset an icon set on a given slider widget.
13829     *
13830     * @param obj The slider object.
13831     * @return The icon object that was being used, if any was set, or
13832     * @c NULL, otherwise (and on errors).
13833     *
13834     * On horizontal mode, icon is placed at left, and on vertical mode,
13835     * placed at top.
13836     *
13837     * This call will unparent and return the icon object which was set
13838     * for this widget, previously, on success.
13839     *
13840     * @see elm_slider_icon_set() for more details
13841     * @see elm_slider_icon_get()
13842     *
13843     * @ingroup Slider
13844     */
13845    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13846
13847    /**
13848     * Retrieve the icon object set for a given slider widget.
13849     *
13850     * @param obj The slider object.
13851     * @return The icon object's handle, if @p obj had one set, or @c NULL,
13852     * otherwise (and on errors).
13853     *
13854     * On horizontal mode, icon is placed at left, and on vertical mode,
13855     * placed at top.
13856     *
13857     * @see elm_slider_icon_set() for more details
13858     * @see elm_slider_icon_unset()
13859     *
13860     * @ingroup Slider
13861     */
13862    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13863
13864    /**
13865     * Set the end object of the slider object.
13866     *
13867     * @param obj The slider object.
13868     * @param end The end object.
13869     *
13870     * On horizontal mode, end is placed at left, and on vertical mode,
13871     * placed at bottom.
13872     *
13873     * @note Once the icon object is set, a previously set one will be deleted.
13874     * If you want to keep that old content object, use the
13875     * elm_slider_end_unset() function.
13876     *
13877     * @warning If the object being set does not have minimum size hints set,
13878     * it won't get properly displayed.
13879     *
13880     * @ingroup Slider
13881     */
13882    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13883
13884    /**
13885     * Unset an end object set on a given slider widget.
13886     *
13887     * @param obj The slider object.
13888     * @return The end object that was being used, if any was set, or
13889     * @c NULL, otherwise (and on errors).
13890     *
13891     * On horizontal mode, end is placed at left, and on vertical mode,
13892     * placed at bottom.
13893     *
13894     * This call will unparent and return the icon object which was set
13895     * for this widget, previously, on success.
13896     *
13897     * @see elm_slider_end_set() for more details.
13898     * @see elm_slider_end_get()
13899     *
13900     * @ingroup Slider
13901     */
13902    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13903
13904    /**
13905     * Retrieve the end object set for a given slider widget.
13906     *
13907     * @param obj The slider object.
13908     * @return The end object's handle, if @p obj had one set, or @c NULL,
13909     * otherwise (and on errors).
13910     *
13911     * On horizontal mode, icon is placed at right, and on vertical mode,
13912     * placed at bottom.
13913     *
13914     * @see elm_slider_end_set() for more details.
13915     * @see elm_slider_end_unset()
13916     *
13917     * @ingroup Slider
13918     */
13919    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13920
13921    /**
13922     * Set the (exact) length of the bar region of a given slider widget.
13923     *
13924     * @param obj The slider object.
13925     * @param size The length of the slider's bar region.
13926     *
13927     * This sets the minimum width (when in horizontal mode) or height
13928     * (when in vertical mode) of the actual bar area of the slider
13929     * @p obj. This in turn affects the object's minimum size. Use
13930     * this when you're not setting other size hints expanding on the
13931     * given direction (like weight and alignment hints) and you would
13932     * like it to have a specific size.
13933     *
13934     * @note Icon, end, label, indicator and unit text around @p obj
13935     * will require their
13936     * own space, which will make @p obj to require more the @p size,
13937     * actually.
13938     *
13939     * @see elm_slider_span_size_get()
13940     *
13941     * @ingroup Slider
13942     */
13943    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13944
13945    /**
13946     * Get the length set for the bar region of a given slider widget
13947     *
13948     * @param obj The slider object.
13949     * @return The length of the slider's bar region.
13950     *
13951     * If that size was not set previously, with
13952     * elm_slider_span_size_set(), this call will return @c 0.
13953     *
13954     * @ingroup Slider
13955     */
13956    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13957
13958    /**
13959     * Set the format string for the unit label.
13960     *
13961     * @param obj The slider object.
13962     * @param format The format string for the unit display.
13963     *
13964     * Unit label is displayed all the time, if set, after slider's bar.
13965     * In horizontal mode, at right and in vertical mode, at bottom.
13966     *
13967     * If @c NULL, unit label won't be visible. If not it sets the format
13968     * string for the label text. To the label text is provided a floating point
13969     * value, so the label text can display up to 1 floating point value.
13970     * Note that this is optional.
13971     *
13972     * Use a format string such as "%1.2f meters" for example, and it will
13973     * display values like: "3.14 meters" for a value equal to 3.14159.
13974     *
13975     * Default is unit label disabled.
13976     *
13977     * @see elm_slider_indicator_format_get()
13978     *
13979     * @ingroup Slider
13980     */
13981    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13982
13983    /**
13984     * Get the unit label format of the slider.
13985     *
13986     * @param obj The slider object.
13987     * @return The unit label format string in UTF-8.
13988     *
13989     * Unit label is displayed all the time, if set, after slider's bar.
13990     * In horizontal mode, at right and in vertical mode, at bottom.
13991     *
13992     * @see elm_slider_unit_format_set() for more
13993     * information on how this works.
13994     *
13995     * @ingroup Slider
13996     */
13997    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13998
13999    /**
14000     * Set the format string for the indicator label.
14001     *
14002     * @param obj The slider object.
14003     * @param indicator The format string for the indicator display.
14004     *
14005     * The slider may display its value somewhere else then unit label,
14006     * for example, above the slider knob that is dragged around. This function
14007     * sets the format string used for this.
14008     *
14009     * If @c NULL, indicator label won't be visible. If not it sets the format
14010     * string for the label text. To the label text is provided a floating point
14011     * value, so the label text can display up to 1 floating point value.
14012     * Note that this is optional.
14013     *
14014     * Use a format string such as "%1.2f meters" for example, and it will
14015     * display values like: "3.14 meters" for a value equal to 3.14159.
14016     *
14017     * Default is indicator label disabled.
14018     *
14019     * @see elm_slider_indicator_format_get()
14020     *
14021     * @ingroup Slider
14022     */
14023    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
14024
14025    /**
14026     * Get the indicator label format of the slider.
14027     *
14028     * @param obj The slider object.
14029     * @return The indicator label format string in UTF-8.
14030     *
14031     * The slider may display its value somewhere else then unit label,
14032     * for example, above the slider knob that is dragged around. This function
14033     * gets the format string used for this.
14034     *
14035     * @see elm_slider_indicator_format_set() for more
14036     * information on how this works.
14037     *
14038     * @ingroup Slider
14039     */
14040    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14041
14042    /**
14043     * Set the format function pointer for the indicator label
14044     *
14045     * @param obj The slider object.
14046     * @param func The indicator format function.
14047     * @param free_func The freeing function for the format string.
14048     *
14049     * Set the callback function to format the indicator string.
14050     *
14051     * @see elm_slider_indicator_format_set() for more info on how this works.
14052     *
14053     * @ingroup Slider
14054     */
14055   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);
14056
14057   /**
14058    * Set the format function pointer for the units label
14059    *
14060    * @param obj The slider object.
14061    * @param func The units format function.
14062    * @param free_func The freeing function for the format string.
14063    *
14064    * Set the callback function to format the indicator string.
14065    *
14066    * @see elm_slider_units_format_set() for more info on how this works.
14067    *
14068    * @ingroup Slider
14069    */
14070   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);
14071
14072   /**
14073    * Set the orientation of a given slider widget.
14074    *
14075    * @param obj The slider object.
14076    * @param horizontal Use @c EINA_TRUE to make @p obj to be
14077    * @b horizontal, @c EINA_FALSE to make it @b vertical.
14078    *
14079    * Use this function to change how your slider is to be
14080    * disposed: vertically or horizontally.
14081    *
14082    * By default it's displayed horizontally.
14083    *
14084    * @see elm_slider_horizontal_get()
14085    *
14086    * @ingroup Slider
14087    */
14088    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14089
14090    /**
14091     * Retrieve the orientation of a given slider widget
14092     *
14093     * @param obj The slider object.
14094     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
14095     * @c EINA_FALSE if it's @b vertical (and on errors).
14096     *
14097     * @see elm_slider_horizontal_set() for more details.
14098     *
14099     * @ingroup Slider
14100     */
14101    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14102
14103    /**
14104     * Set the minimum and maximum values for the slider.
14105     *
14106     * @param obj The slider object.
14107     * @param min The minimum value.
14108     * @param max The maximum value.
14109     *
14110     * Define the allowed range of values to be selected by the user.
14111     *
14112     * If actual value is less than @p min, it will be updated to @p min. If it
14113     * is bigger then @p max, will be updated to @p max. Actual value can be
14114     * get with elm_slider_value_get().
14115     *
14116     * By default, min is equal to 0.0, and max is equal to 1.0.
14117     *
14118     * @warning Maximum must be greater than minimum, otherwise behavior
14119     * is undefined.
14120     *
14121     * @see elm_slider_min_max_get()
14122     *
14123     * @ingroup Slider
14124     */
14125    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
14126
14127    /**
14128     * Get the minimum and maximum values of the slider.
14129     *
14130     * @param obj The slider object.
14131     * @param min Pointer where to store the minimum value.
14132     * @param max Pointer where to store the maximum value.
14133     *
14134     * @note If only one value is needed, the other pointer can be passed
14135     * as @c NULL.
14136     *
14137     * @see elm_slider_min_max_set() for details.
14138     *
14139     * @ingroup Slider
14140     */
14141    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
14142
14143    /**
14144     * Set the value the slider displays.
14145     *
14146     * @param obj The slider object.
14147     * @param val The value to be displayed.
14148     *
14149     * Value will be presented on the unit label following format specified with
14150     * elm_slider_unit_format_set() and on indicator with
14151     * elm_slider_indicator_format_set().
14152     *
14153     * @warning The value must to be between min and max values. This values
14154     * are set by elm_slider_min_max_set().
14155     *
14156     * @see elm_slider_value_get()
14157     * @see elm_slider_unit_format_set()
14158     * @see elm_slider_indicator_format_set()
14159     * @see elm_slider_min_max_set()
14160     *
14161     * @ingroup Slider
14162     */
14163    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
14164
14165    /**
14166     * Get the value displayed by the spinner.
14167     *
14168     * @param obj The spinner object.
14169     * @return The value displayed.
14170     *
14171     * @see elm_spinner_value_set() for details.
14172     *
14173     * @ingroup Slider
14174     */
14175    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14176
14177    /**
14178     * Invert a given slider widget's displaying values order
14179     *
14180     * @param obj The slider object.
14181     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
14182     * @c EINA_FALSE to bring it back to default, non-inverted values.
14183     *
14184     * A slider may be @b inverted, in which state it gets its
14185     * values inverted, with high vales being on the left or top and
14186     * low values on the right or bottom, as opposed to normally have
14187     * the low values on the former and high values on the latter,
14188     * respectively, for horizontal and vertical modes.
14189     *
14190     * @see elm_slider_inverted_get()
14191     *
14192     * @ingroup Slider
14193     */
14194    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
14195
14196    /**
14197     * Get whether a given slider widget's displaying values are
14198     * inverted or not.
14199     *
14200     * @param obj The slider object.
14201     * @return @c EINA_TRUE, if @p obj has inverted values,
14202     * @c EINA_FALSE otherwise (and on errors).
14203     *
14204     * @see elm_slider_inverted_set() for more details.
14205     *
14206     * @ingroup Slider
14207     */
14208    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14209
14210    /**
14211     * Set whether to enlarge slider indicator (augmented knob) or not.
14212     *
14213     * @param obj The slider object.
14214     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
14215     * let the knob always at default size.
14216     *
14217     * By default, indicator will be bigger while dragged by the user.
14218     *
14219     * @warning It won't display values set with
14220     * elm_slider_indicator_format_set() if you disable indicator.
14221     *
14222     * @ingroup Slider
14223     */
14224    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
14225
14226    /**
14227     * Get whether a given slider widget's enlarging indicator or not.
14228     *
14229     * @param obj The slider object.
14230     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
14231     * @c EINA_FALSE otherwise (and on errors).
14232     *
14233     * @see elm_slider_indicator_show_set() for details.
14234     *
14235     * @ingroup Slider
14236     */
14237    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14238
14239    /**
14240     * @}
14241     */
14242
14243    /**
14244     * @addtogroup Actionslider Actionslider
14245     *
14246     * @image html img/widget/actionslider/preview-00.png
14247     * @image latex img/widget/actionslider/preview-00.eps
14248     *
14249     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
14250     * properties. The indicator is the element the user drags to choose a label.
14251     * When the position is set with magnet, when released the indicator will be
14252     * moved to it if it's nearest the magnetized position.
14253     *
14254     * @note By default all positions are set as enabled.
14255     *
14256     * Signals that you can add callbacks for are:
14257     *
14258     * "selected" - when user selects an enabled position (the label is passed
14259     *              as event info)".
14260     * @n
14261     * "pos_changed" - when the indicator reaches any of the positions("left",
14262     *                 "right" or "center").
14263     *
14264     * See an example of actionslider usage @ref actionslider_example_page "here"
14265     * @{
14266     */
14267    typedef enum _Elm_Actionslider_Pos
14268      {
14269         ELM_ACTIONSLIDER_NONE = 0,
14270         ELM_ACTIONSLIDER_LEFT = 1 << 0,
14271         ELM_ACTIONSLIDER_CENTER = 1 << 1,
14272         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14273         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14274      } Elm_Actionslider_Pos;
14275
14276    /**
14277     * Add a new actionslider to the parent.
14278     *
14279     * @param parent The parent object
14280     * @return The new actionslider object or NULL if it cannot be created
14281     */
14282    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14283    /**
14284     * Set actionslider labels.
14285     *
14286     * @param obj The actionslider object
14287     * @param left_label The label to be set on the left.
14288     * @param center_label The label to be set on the center.
14289     * @param right_label The label to be set on the right.
14290     * @deprecated use elm_object_text_set() instead.
14291     */
14292    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);
14293    /**
14294     * Get actionslider labels.
14295     *
14296     * @param obj The actionslider object
14297     * @param left_label A char** to place the left_label of @p obj into.
14298     * @param center_label A char** to place the center_label of @p obj into.
14299     * @param right_label A char** to place the right_label of @p obj into.
14300     * @deprecated use elm_object_text_set() instead.
14301     */
14302    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);
14303    /**
14304     * Get actionslider selected label.
14305     *
14306     * @param obj The actionslider object
14307     * @return The selected label
14308     */
14309    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14310    /**
14311     * Set actionslider indicator position.
14312     *
14313     * @param obj The actionslider object.
14314     * @param pos The position of the indicator.
14315     */
14316    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14317    /**
14318     * Get actionslider indicator position.
14319     *
14320     * @param obj The actionslider object.
14321     * @return The position of the indicator.
14322     */
14323    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14324    /**
14325     * Set actionslider magnet position. To make multiple positions magnets @c or
14326     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14327     *
14328     * @param obj The actionslider object.
14329     * @param pos Bit mask indicating the magnet positions.
14330     */
14331    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14332    /**
14333     * Get actionslider magnet position.
14334     *
14335     * @param obj The actionslider object.
14336     * @return The positions with magnet property.
14337     */
14338    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14339    /**
14340     * Set actionslider enabled position. To set multiple positions as enabled @c or
14341     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14342     *
14343     * @note All the positions are enabled by default.
14344     *
14345     * @param obj The actionslider object.
14346     * @param pos Bit mask indicating the enabled positions.
14347     */
14348    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14349    /**
14350     * Get actionslider enabled position.
14351     *
14352     * @param obj The actionslider object.
14353     * @return The enabled positions.
14354     */
14355    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14356    /**
14357     * Set the label used on the indicator.
14358     *
14359     * @param obj The actionslider object
14360     * @param label The label to be set on the indicator.
14361     * @deprecated use elm_object_text_set() instead.
14362     */
14363    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14364    /**
14365     * Get the label used on the indicator object.
14366     *
14367     * @param obj The actionslider object
14368     * @return The indicator label
14369     * @deprecated use elm_object_text_get() instead.
14370     */
14371    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14372    /**
14373     * @}
14374     */
14375
14376    /**
14377     * @defgroup Genlist Genlist
14378     *
14379     * @image html img/widget/genlist/preview-00.png
14380     * @image latex img/widget/genlist/preview-00.eps
14381     * @image html img/genlist.png
14382     * @image latex img/genlist.eps
14383     *
14384     * This widget aims to have more expansive list than the simple list in
14385     * Elementary that could have more flexible items and allow many more entries
14386     * while still being fast and low on memory usage. At the same time it was
14387     * also made to be able to do tree structures. But the price to pay is more
14388     * complexity when it comes to usage. If all you want is a simple list with
14389     * icons and a single label, use the normal @ref List object.
14390     *
14391     * Genlist has a fairly large API, mostly because it's relatively complex,
14392     * trying to be both expansive, powerful and efficient. First we will begin
14393     * an overview on the theory behind genlist.
14394     *
14395     * @section Genlist_Item_Class Genlist item classes - creating items
14396     *
14397     * In order to have the ability to add and delete items on the fly, genlist
14398     * implements a class (callback) system where the application provides a
14399     * structure with information about that type of item (genlist may contain
14400     * multiple different items with different classes, states and styles).
14401     * Genlist will call the functions in this struct (methods) when an item is
14402     * "realized" (i.e., created dynamically, while the user is scrolling the
14403     * grid). All objects will simply be deleted when no longer needed with
14404     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14405     * following members:
14406     * - @c item_style - This is a constant string and simply defines the name
14407     *   of the item style. It @b must be specified and the default should be @c
14408     *   "default".
14409     * - @c mode_item_style - This is a constant string and simply defines the
14410     *   name of the style that will be used for mode animations. It can be left
14411     *   as @c NULL if you don't plan to use Genlist mode. See
14412     *   elm_genlist_item_mode_set() for more info.
14413     *
14414     * - @c func - A struct with pointers to functions that will be called when
14415     *   an item is going to be actually created. All of them receive a @c data
14416     *   parameter that will point to the same data passed to
14417     *   elm_genlist_item_append() and related item creation functions, and a @c
14418     *   obj parameter that points to the genlist object itself.
14419     *
14420     * The function pointers inside @c func are @c label_get, @c icon_get, @c
14421     * state_get and @c del. The 3 first functions also receive a @c part
14422     * parameter described below. A brief description of these functions follows:
14423     *
14424     * - @c label_get - The @c part parameter is the name string of one of the
14425     *   existing text parts in the Edje group implementing the item's theme.
14426     *   This function @b must return a strdup'()ed string, as the caller will
14427     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
14428     * - @c icon_get - The @c part parameter is the name string of one of the
14429     *   existing (icon) swallow parts in the Edje group implementing the item's
14430     *   theme. It must return @c NULL, when no icon is desired, or a valid
14431     *   object handle, otherwise.  The object will be deleted by the genlist on
14432     *   its deletion or when the item is "unrealized".  See
14433     *   #Elm_Genlist_Item_Icon_Get_Cb.
14434     * - @c func.state_get - The @c part parameter is the name string of one of
14435     *   the state parts in the Edje group implementing the item's theme. Return
14436     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14437     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14438     *   and @c "elm" as "emission" and "source" arguments, respectively, when
14439     *   the state is true (the default is false), where @c XXX is the name of
14440     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
14441     * - @c func.del - This is intended for use when genlist items are deleted,
14442     *   so any data attached to the item (e.g. its data parameter on creation)
14443     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
14444     *
14445     * available item styles:
14446     * - default
14447     * - default_style - The text part is a textblock
14448     *
14449     * @image html img/widget/genlist/preview-04.png
14450     * @image latex img/widget/genlist/preview-04.eps
14451     *
14452     * - double_label
14453     *
14454     * @image html img/widget/genlist/preview-01.png
14455     * @image latex img/widget/genlist/preview-01.eps
14456     *
14457     * - icon_top_text_bottom
14458     *
14459     * @image html img/widget/genlist/preview-02.png
14460     * @image latex img/widget/genlist/preview-02.eps
14461     *
14462     * - group_index
14463     *
14464     * @image html img/widget/genlist/preview-03.png
14465     * @image latex img/widget/genlist/preview-03.eps
14466     *
14467     * @section Genlist_Items Structure of items
14468     *
14469     * An item in a genlist can have 0 or more text labels (they can be regular
14470     * text or textblock Evas objects - that's up to the style to determine), 0
14471     * or more icons (which are simply objects swallowed into the genlist item's
14472     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14473     * behavior left to the user to define. The Edje part names for each of
14474     * these properties will be looked up, in the theme file for the genlist,
14475     * under the Edje (string) data items named @c "labels", @c "icons" and @c
14476     * "states", respectively. For each of those properties, if more than one
14477     * part is provided, they must have names listed separated by spaces in the
14478     * data fields. For the default genlist item theme, we have @b one label
14479     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14480     * "elm.swallow.end") and @b no state parts.
14481     *
14482     * A genlist item may be at one of several styles. Elementary provides one
14483     * by default - "default", but this can be extended by system or application
14484     * custom themes/overlays/extensions (see @ref Theme "themes" for more
14485     * details).
14486     *
14487     * @section Genlist_Manipulation Editing and Navigating
14488     *
14489     * Items can be added by several calls. All of them return a @ref
14490     * Elm_Genlist_Item handle that is an internal member inside the genlist.
14491     * They all take a data parameter that is meant to be used for a handle to
14492     * the applications internal data (eg the struct with the original item
14493     * data). The parent parameter is the parent genlist item this belongs to if
14494     * it is a tree or an indexed group, and NULL if there is no parent. The
14495     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14496     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14497     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14498     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
14499     * is set then this item is group index item that is displayed at the top
14500     * until the next group comes. The func parameter is a convenience callback
14501     * that is called when the item is selected and the data parameter will be
14502     * the func_data parameter, obj be the genlist object and event_info will be
14503     * the genlist item.
14504     *
14505     * elm_genlist_item_append() adds an item to the end of the list, or if
14506     * there is a parent, to the end of all the child items of the parent.
14507     * elm_genlist_item_prepend() is the same but adds to the beginning of
14508     * the list or children list. elm_genlist_item_insert_before() inserts at
14509     * item before another item and elm_genlist_item_insert_after() inserts after
14510     * the indicated item.
14511     *
14512     * The application can clear the list with elm_genlist_clear() which deletes
14513     * all the items in the list and elm_genlist_item_del() will delete a specific
14514     * item. elm_genlist_item_subitems_clear() will clear all items that are
14515     * children of the indicated parent item.
14516     *
14517     * To help inspect list items you can jump to the item at the top of the list
14518     * with elm_genlist_first_item_get() which will return the item pointer, and
14519     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14520     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14521     * and previous items respectively relative to the indicated item. Using
14522     * these calls you can walk the entire item list/tree. Note that as a tree
14523     * the items are flattened in the list, so elm_genlist_item_parent_get() will
14524     * let you know which item is the parent (and thus know how to skip them if
14525     * wanted).
14526     *
14527     * @section Genlist_Muti_Selection Multi-selection
14528     *
14529     * If the application wants multiple items to be able to be selected,
14530     * elm_genlist_multi_select_set() can enable this. If the list is
14531     * single-selection only (the default), then elm_genlist_selected_item_get()
14532     * will return the selected item, if any, or NULL I none is selected. If the
14533     * list is multi-select then elm_genlist_selected_items_get() will return a
14534     * list (that is only valid as long as no items are modified (added, deleted,
14535     * selected or unselected)).
14536     *
14537     * @section Genlist_Usage_Hints Usage hints
14538     *
14539     * There are also convenience functions. elm_genlist_item_genlist_get() will
14540     * return the genlist object the item belongs to. elm_genlist_item_show()
14541     * will make the scroller scroll to show that specific item so its visible.
14542     * elm_genlist_item_data_get() returns the data pointer set by the item
14543     * creation functions.
14544     *
14545     * If an item changes (state of boolean changes, label or icons change),
14546     * then use elm_genlist_item_update() to have genlist update the item with
14547     * the new state. Genlist will re-realize the item thus call the functions
14548     * in the _Elm_Genlist_Item_Class for that item.
14549     *
14550     * To programmatically (un)select an item use elm_genlist_item_selected_set().
14551     * To get its selected state use elm_genlist_item_selected_get(). Similarly
14552     * to expand/contract an item and get its expanded state, use
14553     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14554     * again to make an item disabled (unable to be selected and appear
14555     * differently) use elm_genlist_item_disabled_set() to set this and
14556     * elm_genlist_item_disabled_get() to get the disabled state.
14557     *
14558     * In general to indicate how the genlist should expand items horizontally to
14559     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
14560     * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14561     * mode means that if items are too wide to fit, the scroller will scroll
14562     * horizontally. Otherwise items are expanded to fill the width of the
14563     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14564     * to the viewport width and limited to that size. This can be combined with
14565     * a different style that uses edjes' ellipsis feature (cutting text off like
14566     * this: "tex...").
14567     *
14568     * Items will only call their selection func and callback when first becoming
14569     * selected. Any further clicks will do nothing, unless you enable always
14570     * select with elm_genlist_always_select_mode_set(). This means even if
14571     * selected, every click will make the selected callbacks be called.
14572     * elm_genlist_no_select_mode_set() will turn off the ability to select
14573     * items entirely and they will neither appear selected nor call selected
14574     * callback functions.
14575     *
14576     * Remember that you can create new styles and add your own theme augmentation
14577     * per application with elm_theme_extension_add(). If you absolutely must
14578     * have a specific style that overrides any theme the user or system sets up
14579     * you can use elm_theme_overlay_add() to add such a file.
14580     *
14581     * @section Genlist_Implementation Implementation
14582     *
14583     * Evas tracks every object you create. Every time it processes an event
14584     * (mouse move, down, up etc.) it needs to walk through objects and find out
14585     * what event that affects. Even worse every time it renders display updates,
14586     * in order to just calculate what to re-draw, it needs to walk through many
14587     * many many objects. Thus, the more objects you keep active, the more
14588     * overhead Evas has in just doing its work. It is advisable to keep your
14589     * active objects to the minimum working set you need. Also remember that
14590     * object creation and deletion carries an overhead, so there is a
14591     * middle-ground, which is not easily determined. But don't keep massive lists
14592     * of objects you can't see or use. Genlist does this with list objects. It
14593     * creates and destroys them dynamically as you scroll around. It groups them
14594     * into blocks so it can determine the visibility etc. of a whole block at
14595     * once as opposed to having to walk the whole list. This 2-level list allows
14596     * for very large numbers of items to be in the list (tests have used up to
14597     * 2,000,000 items). Also genlist employs a queue for adding items. As items
14598     * may be different sizes, every item added needs to be calculated as to its
14599     * size and thus this presents a lot of overhead on populating the list, this
14600     * genlist employs a queue. Any item added is queued and spooled off over
14601     * time, actually appearing some time later, so if your list has many members
14602     * you may find it takes a while for them to all appear, with your process
14603     * consuming a lot of CPU while it is busy spooling.
14604     *
14605     * Genlist also implements a tree structure, but it does so with callbacks to
14606     * the application, with the application filling in tree structures when
14607     * requested (allowing for efficient building of a very deep tree that could
14608     * even be used for file-management). See the above smart signal callbacks for
14609     * details.
14610     *
14611     * @section Genlist_Smart_Events Genlist smart events
14612     *
14613     * Signals that you can add callbacks for are:
14614     * - @c "activated" - The user has double-clicked or pressed
14615     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
14616     *   item that was activated.
14617     * - @c "clicked,double" - The user has double-clicked an item.  The @c
14618     *   event_info parameter is the item that was double-clicked.
14619     * - @c "selected" - This is called when a user has made an item selected.
14620     *   The event_info parameter is the genlist item that was selected.
14621     * - @c "unselected" - This is called when a user has made an item
14622     *   unselected. The event_info parameter is the genlist item that was
14623     *   unselected.
14624     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14625     *   called and the item is now meant to be expanded. The event_info
14626     *   parameter is the genlist item that was indicated to expand.  It is the
14627     *   job of this callback to then fill in the child items.
14628     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14629     *   called and the item is now meant to be contracted. The event_info
14630     *   parameter is the genlist item that was indicated to contract. It is the
14631     *   job of this callback to then delete the child items.
14632     * - @c "expand,request" - This is called when a user has indicated they want
14633     *   to expand a tree branch item. The callback should decide if the item can
14634     *   expand (has any children) and then call elm_genlist_item_expanded_set()
14635     *   appropriately to set the state. The event_info parameter is the genlist
14636     *   item that was indicated to expand.
14637     * - @c "contract,request" - This is called when a user has indicated they
14638     *   want to contract a tree branch item. The callback should decide if the
14639     *   item can contract (has any children) and then call
14640     *   elm_genlist_item_expanded_set() appropriately to set the state. The
14641     *   event_info parameter is the genlist item that was indicated to contract.
14642     * - @c "realized" - This is called when the item in the list is created as a
14643     *   real evas object. event_info parameter is the genlist item that was
14644     *   created. The object may be deleted at any time, so it is up to the
14645     *   caller to not use the object pointer from elm_genlist_item_object_get()
14646     *   in a way where it may point to freed objects.
14647     * - @c "unrealized" - This is called just before an item is unrealized.
14648     *   After this call icon objects provided will be deleted and the item
14649     *   object itself delete or be put into a floating cache.
14650     * - @c "drag,start,up" - This is called when the item in the list has been
14651     *   dragged (not scrolled) up.
14652     * - @c "drag,start,down" - This is called when the item in the list has been
14653     *   dragged (not scrolled) down.
14654     * - @c "drag,start,left" - This is called when the item in the list has been
14655     *   dragged (not scrolled) left.
14656     * - @c "drag,start,right" - This is called when the item in the list has
14657     *   been dragged (not scrolled) right.
14658     * - @c "drag,stop" - This is called when the item in the list has stopped
14659     *   being dragged.
14660     * - @c "drag" - This is called when the item in the list is being dragged.
14661     * - @c "longpressed" - This is called when the item is pressed for a certain
14662     *   amount of time. By default it's 1 second.
14663     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14664     *   the top edge.
14665     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14666     *   until the bottom edge.
14667     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14668     *   until the left edge.
14669     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14670     *   until the right edge.
14671     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14672     *   swiped left.
14673     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14674     *   swiped right.
14675     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14676     *   swiped up.
14677     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14678     *   swiped down.
14679     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14680     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
14681     *   multi-touch pinched in.
14682     * - @c "swipe" - This is called when the genlist is swiped.
14683     *
14684     * @section Genlist_Examples Examples
14685     *
14686     * Here is a list of examples that use the genlist, trying to show some of
14687     * its capabilities:
14688     * - @ref genlist_example_01
14689     * - @ref genlist_example_02
14690     * - @ref genlist_example_03
14691     * - @ref genlist_example_04
14692     * - @ref genlist_example_05
14693     */
14694
14695    /**
14696     * @addtogroup Genlist
14697     * @{
14698     */
14699
14700    /**
14701     * @enum _Elm_Genlist_Item_Flags
14702     * @typedef Elm_Genlist_Item_Flags
14703     *
14704     * Defines if the item is of any special type (has subitems or it's the
14705     * index of a group), or is just a simple item.
14706     *
14707     * @ingroup Genlist
14708     */
14709    typedef enum _Elm_Genlist_Item_Flags
14710      {
14711         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14712         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14713         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14714      } Elm_Genlist_Item_Flags;
14715    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
14716    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14717    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14718    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14719    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. */
14720    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. */
14721    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14722    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
14723
14724    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
14725    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
14726    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
14727    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
14728
14729    /**
14730     * @struct _Elm_Genlist_Item_Class
14731     *
14732     * Genlist item class definition structs.
14733     *
14734     * This struct contains the style and fetching functions that will define the
14735     * contents of each item.
14736     *
14737     * @see @ref Genlist_Item_Class
14738     */
14739    struct _Elm_Genlist_Item_Class
14740      {
14741         const char                *item_style; /**< style of this class. */
14742         struct
14743           {
14744              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
14745              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
14746              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
14747              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
14748              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
14749           } func;
14750         const char                *mode_item_style;
14751      };
14752
14753    /**
14754     * Add a new genlist widget to the given parent Elementary
14755     * (container) object
14756     *
14757     * @param parent The parent object
14758     * @return a new genlist widget handle or @c NULL, on errors
14759     *
14760     * This function inserts a new genlist widget on the canvas.
14761     *
14762     * @see elm_genlist_item_append()
14763     * @see elm_genlist_item_del()
14764     * @see elm_genlist_clear()
14765     *
14766     * @ingroup Genlist
14767     */
14768    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14769    /**
14770     * Remove all items from a given genlist widget.
14771     *
14772     * @param obj The genlist object
14773     *
14774     * This removes (and deletes) all items in @p obj, leaving it empty.
14775     *
14776     * @see elm_genlist_item_del(), to remove just one item.
14777     *
14778     * @ingroup Genlist
14779     */
14780    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14781    /**
14782     * Enable or disable multi-selection in the genlist
14783     *
14784     * @param obj The genlist object
14785     * @param multi Multi-select enable/disable. Default is disabled.
14786     *
14787     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14788     * the list. This allows more than 1 item to be selected. To retrieve the list
14789     * of selected items, use elm_genlist_selected_items_get().
14790     *
14791     * @see elm_genlist_selected_items_get()
14792     * @see elm_genlist_multi_select_get()
14793     *
14794     * @ingroup Genlist
14795     */
14796    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14797    /**
14798     * Gets if multi-selection in genlist is enabled or disabled.
14799     *
14800     * @param obj The genlist object
14801     * @return Multi-select enabled/disabled
14802     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14803     *
14804     * @see elm_genlist_multi_select_set()
14805     *
14806     * @ingroup Genlist
14807     */
14808    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14809    /**
14810     * This sets the horizontal stretching mode.
14811     *
14812     * @param obj The genlist object
14813     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14814     *
14815     * This sets the mode used for sizing items horizontally. Valid modes
14816     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14817     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14818     * the scroller will scroll horizontally. Otherwise items are expanded
14819     * to fill the width of the viewport of the scroller. If it is
14820     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14821     * limited to that size.
14822     *
14823     * @see elm_genlist_horizontal_get()
14824     *
14825     * @ingroup Genlist
14826     */
14827    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14828    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14829    /**
14830     * Gets the horizontal stretching mode.
14831     *
14832     * @param obj The genlist object
14833     * @return The mode to use
14834     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14835     *
14836     * @see elm_genlist_horizontal_set()
14837     *
14838     * @ingroup Genlist
14839     */
14840    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14841    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14842    /**
14843     * Set the always select mode.
14844     *
14845     * @param obj The genlist object
14846     * @param always_select The always select mode (@c EINA_TRUE = on, @c
14847     * EINA_FALSE = off). Default is @c EINA_FALSE.
14848     *
14849     * Items will only call their selection func and callback when first
14850     * becoming selected. Any further clicks will do nothing, unless you
14851     * enable always select with elm_genlist_always_select_mode_set().
14852     * This means that, even if selected, every click will make the selected
14853     * callbacks be called.
14854     *
14855     * @see elm_genlist_always_select_mode_get()
14856     *
14857     * @ingroup Genlist
14858     */
14859    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14860    /**
14861     * Get the always select mode.
14862     *
14863     * @param obj The genlist object
14864     * @return The always select mode
14865     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14866     *
14867     * @see elm_genlist_always_select_mode_set()
14868     *
14869     * @ingroup Genlist
14870     */
14871    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14872    /**
14873     * Enable/disable the no select mode.
14874     *
14875     * @param obj The genlist object
14876     * @param no_select The no select mode
14877     * (EINA_TRUE = on, EINA_FALSE = off)
14878     *
14879     * This will turn off the ability to select items entirely and they
14880     * will neither appear selected nor call selected callback functions.
14881     *
14882     * @see elm_genlist_no_select_mode_get()
14883     *
14884     * @ingroup Genlist
14885     */
14886    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14887    /**
14888     * Gets whether the no select mode is enabled.
14889     *
14890     * @param obj The genlist object
14891     * @return The no select mode
14892     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14893     *
14894     * @see elm_genlist_no_select_mode_set()
14895     *
14896     * @ingroup Genlist
14897     */
14898    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14899    /**
14900     * Enable/disable compress mode.
14901     *
14902     * @param obj The genlist object
14903     * @param compress The compress mode
14904     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14905     *
14906     * This will enable the compress mode where items are "compressed"
14907     * horizontally to fit the genlist scrollable viewport width. This is
14908     * special for genlist.  Do not rely on
14909     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
14910     * work as genlist needs to handle it specially.
14911     *
14912     * @see elm_genlist_compress_mode_get()
14913     *
14914     * @ingroup Genlist
14915     */
14916    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14917    /**
14918     * Get whether the compress mode is enabled.
14919     *
14920     * @param obj The genlist object
14921     * @return The compress mode
14922     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14923     *
14924     * @see elm_genlist_compress_mode_set()
14925     *
14926     * @ingroup Genlist
14927     */
14928    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14929    /**
14930     * Enable/disable height-for-width mode.
14931     *
14932     * @param obj The genlist object
14933     * @param setting The height-for-width mode (@c EINA_TRUE = on,
14934     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14935     *
14936     * With height-for-width mode the item width will be fixed (restricted
14937     * to a minimum of) to the list width when calculating its size in
14938     * order to allow the height to be calculated based on it. This allows,
14939     * for instance, text block to wrap lines if the Edje part is
14940     * configured with "text.min: 0 1".
14941     *
14942     * @note This mode will make list resize slower as it will have to
14943     *       recalculate every item height again whenever the list width
14944     *       changes!
14945     *
14946     * @note When height-for-width mode is enabled, it also enables
14947     *       compress mode (see elm_genlist_compress_mode_set()) and
14948     *       disables homogeneous (see elm_genlist_homogeneous_set()).
14949     *
14950     * @ingroup Genlist
14951     */
14952    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14953    /**
14954     * Get whether the height-for-width mode is enabled.
14955     *
14956     * @param obj The genlist object
14957     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14958     * off)
14959     *
14960     * @ingroup Genlist
14961     */
14962    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14963    /**
14964     * Enable/disable horizontal and vertical bouncing effect.
14965     *
14966     * @param obj The genlist object
14967     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14968     * EINA_FALSE = off). Default is @c EINA_FALSE.
14969     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14970     * EINA_FALSE = off). Default is @c EINA_TRUE.
14971     *
14972     * This will enable or disable the scroller bouncing effect for the
14973     * genlist. See elm_scroller_bounce_set() for details.
14974     *
14975     * @see elm_scroller_bounce_set()
14976     * @see elm_genlist_bounce_get()
14977     *
14978     * @ingroup Genlist
14979     */
14980    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14981    /**
14982     * Get whether the horizontal and vertical bouncing effect is enabled.
14983     *
14984     * @param obj The genlist object
14985     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14986     * option is set.
14987     * @param v_bounce Pointer to a bool to receive if the bounce vertically
14988     * option is set.
14989     *
14990     * @see elm_genlist_bounce_set()
14991     *
14992     * @ingroup Genlist
14993     */
14994    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14995    /**
14996     * Enable/disable homogenous mode.
14997     *
14998     * @param obj The genlist object
14999     * @param homogeneous Assume the items within the genlist are of the
15000     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
15001     * EINA_FALSE.
15002     *
15003     * This will enable the homogeneous mode where items are of the same
15004     * height and width so that genlist may do the lazy-loading at its
15005     * maximum (which increases the performance for scrolling the list). This
15006     * implies 'compressed' mode.
15007     *
15008     * @see elm_genlist_compress_mode_set()
15009     * @see elm_genlist_homogeneous_get()
15010     *
15011     * @ingroup Genlist
15012     */
15013    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15014    /**
15015     * Get whether the homogenous mode is enabled.
15016     *
15017     * @param obj The genlist object
15018     * @return Assume the items within the genlist are of the same height
15019     * and width (EINA_TRUE = on, EINA_FALSE = off)
15020     *
15021     * @see elm_genlist_homogeneous_set()
15022     *
15023     * @ingroup Genlist
15024     */
15025    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15026    /**
15027     * Set the maximum number of items within an item block
15028     *
15029     * @param obj The genlist object
15030     * @param n   Maximum number of items within an item block. Default is 32.
15031     *
15032     * This will configure the block count to tune to the target with
15033     * particular performance matrix.
15034     *
15035     * A block of objects will be used to reduce the number of operations due to
15036     * many objects in the screen. It can determine the visibility, or if the
15037     * object has changed, it theme needs to be updated, etc. doing this kind of
15038     * calculation to the entire block, instead of per object.
15039     *
15040     * The default value for the block count is enough for most lists, so unless
15041     * you know you will have a lot of objects visible in the screen at the same
15042     * time, don't try to change this.
15043     *
15044     * @see elm_genlist_block_count_get()
15045     * @see @ref Genlist_Implementation
15046     *
15047     * @ingroup Genlist
15048     */
15049    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
15050    /**
15051     * Get the maximum number of items within an item block
15052     *
15053     * @param obj The genlist object
15054     * @return Maximum number of items within an item block
15055     *
15056     * @see elm_genlist_block_count_set()
15057     *
15058     * @ingroup Genlist
15059     */
15060    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15061    /**
15062     * Set the timeout in seconds for the longpress event.
15063     *
15064     * @param obj The genlist object
15065     * @param timeout timeout in seconds. Default is 1.
15066     *
15067     * This option will change how long it takes to send an event "longpressed"
15068     * after the mouse down signal is sent to the list. If this event occurs, no
15069     * "clicked" event will be sent.
15070     *
15071     * @see elm_genlist_longpress_timeout_set()
15072     *
15073     * @ingroup Genlist
15074     */
15075    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
15076    /**
15077     * Get the timeout in seconds for the longpress event.
15078     *
15079     * @param obj The genlist object
15080     * @return timeout in seconds
15081     *
15082     * @see elm_genlist_longpress_timeout_get()
15083     *
15084     * @ingroup Genlist
15085     */
15086    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15087    /**
15088     * Append a new item in a given genlist widget.
15089     *
15090     * @param obj The genlist object
15091     * @param itc The item class for the item
15092     * @param data The item data
15093     * @param parent The parent item, or NULL if none
15094     * @param flags Item flags
15095     * @param func Convenience function called when the item is selected
15096     * @param func_data Data passed to @p func above.
15097     * @return A handle to the item added or @c NULL if not possible
15098     *
15099     * This adds the given item to the end of the list or the end of
15100     * the children list if the @p parent is given.
15101     *
15102     * @see elm_genlist_item_prepend()
15103     * @see elm_genlist_item_insert_before()
15104     * @see elm_genlist_item_insert_after()
15105     * @see elm_genlist_item_del()
15106     *
15107     * @ingroup Genlist
15108     */
15109    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);
15110    /**
15111     * Prepend a new item in a given genlist widget.
15112     *
15113     * @param obj The genlist object
15114     * @param itc The item class for the item
15115     * @param data The item data
15116     * @param parent The parent item, or NULL if none
15117     * @param flags Item flags
15118     * @param func Convenience function called when the item is selected
15119     * @param func_data Data passed to @p func above.
15120     * @return A handle to the item added or NULL if not possible
15121     *
15122     * This adds an item to the beginning of the list or beginning of the
15123     * children of the parent if given.
15124     *
15125     * @see elm_genlist_item_append()
15126     * @see elm_genlist_item_insert_before()
15127     * @see elm_genlist_item_insert_after()
15128     * @see elm_genlist_item_del()
15129     *
15130     * @ingroup Genlist
15131     */
15132    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);
15133    /**
15134     * Insert an item before another in a genlist widget
15135     *
15136     * @param obj The genlist object
15137     * @param itc The item class for the item
15138     * @param data The item data
15139     * @param before The item to place this new one before.
15140     * @param flags Item flags
15141     * @param func Convenience function called when the item is selected
15142     * @param func_data Data passed to @p func above.
15143     * @return A handle to the item added or @c NULL if not possible
15144     *
15145     * This inserts an item before another in the list. It will be in the
15146     * same tree level or group as the item it is inserted before.
15147     *
15148     * @see elm_genlist_item_append()
15149     * @see elm_genlist_item_prepend()
15150     * @see elm_genlist_item_insert_after()
15151     * @see elm_genlist_item_del()
15152     *
15153     * @ingroup Genlist
15154     */
15155    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);
15156    /**
15157     * Insert an item after another in a genlist widget
15158     *
15159     * @param obj The genlist object
15160     * @param itc The item class for the item
15161     * @param data The item data
15162     * @param after The item to place this new one after.
15163     * @param flags Item flags
15164     * @param func Convenience function called when the item is selected
15165     * @param func_data Data passed to @p func above.
15166     * @return A handle to the item added or @c NULL if not possible
15167     *
15168     * This inserts an item after another in the list. It will be in the
15169     * same tree level or group as the item it is inserted after.
15170     *
15171     * @see elm_genlist_item_append()
15172     * @see elm_genlist_item_prepend()
15173     * @see elm_genlist_item_insert_before()
15174     * @see elm_genlist_item_del()
15175     *
15176     * @ingroup Genlist
15177     */
15178    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);
15179    /**
15180     * Insert a new item into the sorted genlist object
15181     *
15182     * @param obj The genlist object
15183     * @param itc The item class for the item
15184     * @param data The item data
15185     * @param parent The parent item, or NULL if none
15186     * @param flags Item flags
15187     * @param comp The function called for the sort
15188     * @param func Convenience function called when item selected
15189     * @param func_data Data passed to @p func above.
15190     * @return A handle to the item added or NULL if not possible
15191     *
15192     * @ingroup Genlist
15193     */
15194    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);
15195    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);
15196    /* operations to retrieve existing items */
15197    /**
15198     * Get the selectd item in the genlist.
15199     *
15200     * @param obj The genlist object
15201     * @return The selected item, or NULL if none is selected.
15202     *
15203     * This gets the selected item in the list (if multi-selection is enabled, only
15204     * the item that was first selected in the list is returned - which is not very
15205     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
15206     * used).
15207     *
15208     * If no item is selected, NULL is returned.
15209     *
15210     * @see elm_genlist_selected_items_get()
15211     *
15212     * @ingroup Genlist
15213     */
15214    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15215    /**
15216     * Get a list of selected items in the genlist.
15217     *
15218     * @param obj The genlist object
15219     * @return The list of selected items, or NULL if none are selected.
15220     *
15221     * It returns a list of the selected items. This list pointer is only valid so
15222     * long as the selection doesn't change (no items are selected or unselected, or
15223     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
15224     * pointers. The order of the items in this list is the order which they were
15225     * selected, i.e. the first item in this list is the first item that was
15226     * selected, and so on.
15227     *
15228     * @note If not in multi-select mode, consider using function
15229     * elm_genlist_selected_item_get() instead.
15230     *
15231     * @see elm_genlist_multi_select_set()
15232     * @see elm_genlist_selected_item_get()
15233     *
15234     * @ingroup Genlist
15235     */
15236    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15237    /**
15238     * Get a list of realized items in genlist
15239     *
15240     * @param obj The genlist object
15241     * @return The list of realized items, nor NULL if none are realized.
15242     *
15243     * This returns a list of the realized items in the genlist. The list
15244     * contains Elm_Genlist_Item pointers. The list must be freed by the
15245     * caller when done with eina_list_free(). The item pointers in the
15246     * list are only valid so long as those items are not deleted or the
15247     * genlist is not deleted.
15248     *
15249     * @see elm_genlist_realized_items_update()
15250     *
15251     * @ingroup Genlist
15252     */
15253    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15254    /**
15255     * Get the item that is at the x, y canvas coords.
15256     *
15257     * @param obj The gelinst object.
15258     * @param x The input x coordinate
15259     * @param y The input y coordinate
15260     * @param posret The position relative to the item returned here
15261     * @return The item at the coordinates or NULL if none
15262     *
15263     * This returns the item at the given coordinates (which are canvas
15264     * relative, not object-relative). If an item is at that coordinate,
15265     * that item handle is returned, and if @p posret is not NULL, the
15266     * integer pointed to is set to a value of -1, 0 or 1, depending if
15267     * the coordinate is on the upper portion of that item (-1), on the
15268     * middle section (0) or on the lower part (1). If NULL is returned as
15269     * an item (no item found there), then posret may indicate -1 or 1
15270     * based if the coordinate is above or below all items respectively in
15271     * the genlist.
15272     *
15273     * @ingroup Genlist
15274     */
15275    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);
15276    /**
15277     * Get the first item in the genlist
15278     *
15279     * This returns the first item in the list.
15280     *
15281     * @param obj The genlist object
15282     * @return The first item, or NULL if none
15283     *
15284     * @ingroup Genlist
15285     */
15286    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15287    /**
15288     * Get the last item in the genlist
15289     *
15290     * This returns the last item in the list.
15291     *
15292     * @return The last item, or NULL if none
15293     *
15294     * @ingroup Genlist
15295     */
15296    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15297    /**
15298     * Set the scrollbar policy
15299     *
15300     * @param obj The genlist object
15301     * @param policy_h Horizontal scrollbar policy.
15302     * @param policy_v Vertical scrollbar policy.
15303     *
15304     * This sets the scrollbar visibility policy for the given genlist
15305     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15306     * made visible if it is needed, and otherwise kept hidden.
15307     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15308     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15309     * respectively for the horizontal and vertical scrollbars. Default is
15310     * #ELM_SMART_SCROLLER_POLICY_AUTO
15311     *
15312     * @see elm_genlist_scroller_policy_get()
15313     *
15314     * @ingroup Genlist
15315     */
15316    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15317    /**
15318     * Get the scrollbar policy
15319     *
15320     * @param obj The genlist object
15321     * @param policy_h Pointer to store the horizontal scrollbar policy.
15322     * @param policy_v Pointer to store the vertical scrollbar policy.
15323     *
15324     * @see elm_genlist_scroller_policy_set()
15325     *
15326     * @ingroup Genlist
15327     */
15328    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);
15329    /**
15330     * Get the @b next item in a genlist widget's internal list of items,
15331     * given a handle to one of those items.
15332     *
15333     * @param item The genlist item to fetch next from
15334     * @return The item after @p item, or @c NULL if there's none (and
15335     * on errors)
15336     *
15337     * This returns the item placed after the @p item, on the container
15338     * genlist.
15339     *
15340     * @see elm_genlist_item_prev_get()
15341     *
15342     * @ingroup Genlist
15343     */
15344    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15345    /**
15346     * Get the @b previous item in a genlist widget's internal list of items,
15347     * given a handle to one of those items.
15348     *
15349     * @param item The genlist item to fetch previous from
15350     * @return The item before @p item, or @c NULL if there's none (and
15351     * on errors)
15352     *
15353     * This returns the item placed before the @p item, on the container
15354     * genlist.
15355     *
15356     * @see elm_genlist_item_next_get()
15357     *
15358     * @ingroup Genlist
15359     */
15360    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15361    /**
15362     * Get the genlist object's handle which contains a given genlist
15363     * item
15364     *
15365     * @param item The item to fetch the container from
15366     * @return The genlist (parent) object
15367     *
15368     * This returns the genlist object itself that an item belongs to.
15369     *
15370     * @ingroup Genlist
15371     */
15372    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15373    /**
15374     * Get the parent item of the given item
15375     *
15376     * @param it The item
15377     * @return The parent of the item or @c NULL if it has no parent.
15378     *
15379     * This returns the item that was specified as parent of the item @p it on
15380     * elm_genlist_item_append() and insertion related functions.
15381     *
15382     * @ingroup Genlist
15383     */
15384    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15385    /**
15386     * Remove all sub-items (children) of the given item
15387     *
15388     * @param it The item
15389     *
15390     * This removes all items that are children (and their descendants) of the
15391     * given item @p it.
15392     *
15393     * @see elm_genlist_clear()
15394     * @see elm_genlist_item_del()
15395     *
15396     * @ingroup Genlist
15397     */
15398    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15399    /**
15400     * Set whether a given genlist item is selected or not
15401     *
15402     * @param it The item
15403     * @param selected Use @c EINA_TRUE, to make it selected, @c
15404     * EINA_FALSE to make it unselected
15405     *
15406     * This sets the selected state of an item. If multi selection is
15407     * not enabled on the containing genlist and @p selected is @c
15408     * EINA_TRUE, any other previously selected items will get
15409     * unselected in favor of this new one.
15410     *
15411     * @see elm_genlist_item_selected_get()
15412     *
15413     * @ingroup Genlist
15414     */
15415    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15416    /**
15417     * Get whether a given genlist item is selected or not
15418     *
15419     * @param it The item
15420     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15421     *
15422     * @see elm_genlist_item_selected_set() for more details
15423     *
15424     * @ingroup Genlist
15425     */
15426    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15427    /**
15428     * Sets the expanded state of an item.
15429     *
15430     * @param it The item
15431     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15432     *
15433     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15434     * expanded or not.
15435     *
15436     * The theme will respond to this change visually, and a signal "expanded" or
15437     * "contracted" will be sent from the genlist with a pointer to the item that
15438     * has been expanded/contracted.
15439     *
15440     * Calling this function won't show or hide any child of this item (if it is
15441     * a parent). You must manually delete and create them on the callbacks fo
15442     * the "expanded" or "contracted" signals.
15443     *
15444     * @see elm_genlist_item_expanded_get()
15445     *
15446     * @ingroup Genlist
15447     */
15448    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15449    /**
15450     * Get the expanded state of an item
15451     *
15452     * @param it The item
15453     * @return The expanded state
15454     *
15455     * This gets the expanded state of an item.
15456     *
15457     * @see elm_genlist_item_expanded_set()
15458     *
15459     * @ingroup Genlist
15460     */
15461    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15462    /**
15463     * Get the depth of expanded item
15464     *
15465     * @param it The genlist item object
15466     * @return The depth of expanded item
15467     *
15468     * @ingroup Genlist
15469     */
15470    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15471    /**
15472     * Set whether a given genlist item is disabled or not.
15473     *
15474     * @param it The item
15475     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15476     * to enable it back.
15477     *
15478     * A disabled item cannot be selected or unselected. It will also
15479     * change its appearance, to signal the user it's disabled.
15480     *
15481     * @see elm_genlist_item_disabled_get()
15482     *
15483     * @ingroup Genlist
15484     */
15485    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15486    /**
15487     * Get whether a given genlist item is disabled or not.
15488     *
15489     * @param it The item
15490     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15491     * (and on errors).
15492     *
15493     * @see elm_genlist_item_disabled_set() for more details
15494     *
15495     * @ingroup Genlist
15496     */
15497    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15498    /**
15499     * Sets the display only state of an item.
15500     *
15501     * @param it The item
15502     * @param display_only @c EINA_TRUE if the item is display only, @c
15503     * EINA_FALSE otherwise.
15504     *
15505     * A display only item cannot be selected or unselected. It is for
15506     * display only and not selecting or otherwise clicking, dragging
15507     * etc. by the user, thus finger size rules will not be applied to
15508     * this item.
15509     *
15510     * It's good to set group index items to display only state.
15511     *
15512     * @see elm_genlist_item_display_only_get()
15513     *
15514     * @ingroup Genlist
15515     */
15516    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15517    /**
15518     * Get the display only state of an item
15519     *
15520     * @param it The item
15521     * @return @c EINA_TRUE if the item is display only, @c
15522     * EINA_FALSE otherwise.
15523     *
15524     * @see elm_genlist_item_display_only_set()
15525     *
15526     * @ingroup Genlist
15527     */
15528    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15529    /**
15530     * Show the portion of a genlist's internal list containing a given
15531     * item, immediately.
15532     *
15533     * @param it The item to display
15534     *
15535     * This causes genlist to jump to the given item @p it and show it (by
15536     * immediately scrolling to that position), if it is not fully visible.
15537     *
15538     * @see elm_genlist_item_bring_in()
15539     * @see elm_genlist_item_top_show()
15540     * @see elm_genlist_item_middle_show()
15541     *
15542     * @ingroup Genlist
15543     */
15544    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15545    /**
15546     * Animatedly bring in, to the visible are of a genlist, a given
15547     * item on it.
15548     *
15549     * @param it The item to display
15550     *
15551     * This causes genlist to jump to the given item @p it and show it (by
15552     * animatedly scrolling), if it is not fully visible. This may use animation
15553     * to do so and take a period of time
15554     *
15555     * @see elm_genlist_item_show()
15556     * @see elm_genlist_item_top_bring_in()
15557     * @see elm_genlist_item_middle_bring_in()
15558     *
15559     * @ingroup Genlist
15560     */
15561    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15562    /**
15563     * Show the portion of a genlist's internal list containing a given
15564     * item, immediately.
15565     *
15566     * @param it The item to display
15567     *
15568     * This causes genlist to jump to the given item @p it and show it (by
15569     * immediately scrolling to that position), if it is not fully visible.
15570     *
15571     * The item will be positioned at the top of the genlist viewport.
15572     *
15573     * @see elm_genlist_item_show()
15574     * @see elm_genlist_item_top_bring_in()
15575     *
15576     * @ingroup Genlist
15577     */
15578    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15579    /**
15580     * Animatedly bring in, to the visible are of a genlist, a given
15581     * item on it.
15582     *
15583     * @param it The item
15584     *
15585     * This causes genlist to jump to the given item @p it and show it (by
15586     * animatedly scrolling), if it is not fully visible. This may use animation
15587     * to do so and take a period of time
15588     *
15589     * The item will be positioned at the top of the genlist viewport.
15590     *
15591     * @see elm_genlist_item_bring_in()
15592     * @see elm_genlist_item_top_show()
15593     *
15594     * @ingroup Genlist
15595     */
15596    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15597    /**
15598     * Show the portion of a genlist's internal list containing a given
15599     * item, immediately.
15600     *
15601     * @param it The item to display
15602     *
15603     * This causes genlist to jump to the given item @p it and show it (by
15604     * immediately scrolling to that position), if it is not fully visible.
15605     *
15606     * The item will be positioned at the middle of the genlist viewport.
15607     *
15608     * @see elm_genlist_item_show()
15609     * @see elm_genlist_item_middle_bring_in()
15610     *
15611     * @ingroup Genlist
15612     */
15613    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15614    /**
15615     * Animatedly bring in, to the visible are of a genlist, a given
15616     * item on it.
15617     *
15618     * @param it The item
15619     *
15620     * This causes genlist to jump to the given item @p it and show it (by
15621     * animatedly scrolling), if it is not fully visible. This may use animation
15622     * to do so and take a period of time
15623     *
15624     * The item will be positioned at the middle of the genlist viewport.
15625     *
15626     * @see elm_genlist_item_bring_in()
15627     * @see elm_genlist_item_middle_show()
15628     *
15629     * @ingroup Genlist
15630     */
15631    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15632    /**
15633     * Remove a genlist item from the its parent, deleting it.
15634     *
15635     * @param item The item to be removed.
15636     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15637     *
15638     * @see elm_genlist_clear(), to remove all items in a genlist at
15639     * once.
15640     *
15641     * @ingroup Genlist
15642     */
15643    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15644    /**
15645     * Return the data associated to a given genlist item
15646     *
15647     * @param item The genlist item.
15648     * @return the data associated to this item.
15649     *
15650     * This returns the @c data value passed on the
15651     * elm_genlist_item_append() and related item addition calls.
15652     *
15653     * @see elm_genlist_item_append()
15654     * @see elm_genlist_item_data_set()
15655     *
15656     * @ingroup Genlist
15657     */
15658    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15659    /**
15660     * Set the data associated to a given genlist item
15661     *
15662     * @param item The genlist item
15663     * @param data The new data pointer to set on it
15664     *
15665     * This @b overrides the @c data value passed on the
15666     * elm_genlist_item_append() and related item addition calls. This
15667     * function @b won't call elm_genlist_item_update() automatically,
15668     * so you'd issue it afterwards if you want to hove the item
15669     * updated to reflect the that new data.
15670     *
15671     * @see elm_genlist_item_data_get()
15672     *
15673     * @ingroup Genlist
15674     */
15675    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15676    /**
15677     * Tells genlist to "orphan" icons fetchs by the item class
15678     *
15679     * @param it The item
15680     *
15681     * This instructs genlist to release references to icons in the item,
15682     * meaning that they will no longer be managed by genlist and are
15683     * floating "orphans" that can be re-used elsewhere if the user wants
15684     * to.
15685     *
15686     * @ingroup Genlist
15687     */
15688    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15689    /**
15690     * Get the real Evas object created to implement the view of a
15691     * given genlist item
15692     *
15693     * @param item The genlist item.
15694     * @return the Evas object implementing this item's view.
15695     *
15696     * This returns the actual Evas object used to implement the
15697     * specified genlist item's view. This may be @c NULL, as it may
15698     * not have been created or may have been deleted, at any time, by
15699     * the genlist. <b>Do not modify this object</b> (move, resize,
15700     * show, hide, etc.), as the genlist is controlling it. This
15701     * function is for querying, emitting custom signals or hooking
15702     * lower level callbacks for events on that object. Do not delete
15703     * this object under any circumstances.
15704     *
15705     * @see elm_genlist_item_data_get()
15706     *
15707     * @ingroup Genlist
15708     */
15709    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15710    /**
15711     * Update the contents of an item
15712     *
15713     * @param it The item
15714     *
15715     * This updates an item by calling all the item class functions again
15716     * to get the icons, labels and states. Use this when the original
15717     * item data has changed and the changes are desired to be reflected.
15718     *
15719     * Use elm_genlist_realized_items_update() to update all already realized
15720     * items.
15721     *
15722     * @see elm_genlist_realized_items_update()
15723     *
15724     * @ingroup Genlist
15725     */
15726    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15727    /**
15728     * Update the item class of an item
15729     *
15730     * @param it The item
15731     * @param itc The item class for the item
15732     *
15733     * This sets another class fo the item, changing the way that it is
15734     * displayed. After changing the item class, elm_genlist_item_update() is
15735     * called on the item @p it.
15736     *
15737     * @ingroup Genlist
15738     */
15739    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15740    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15741    /**
15742     * Set the text to be shown in a given genlist item's tooltips.
15743     *
15744     * @param item The genlist item
15745     * @param text The text to set in the content
15746     *
15747     * This call will setup the text to be used as tooltip to that item
15748     * (analogous to elm_object_tooltip_text_set(), but being item
15749     * tooltips with higher precedence than object tooltips). It can
15750     * have only one tooltip at a time, so any previous tooltip data
15751     * will get removed.
15752     *
15753     * In order to set an icon or something else as a tooltip, look at
15754     * elm_genlist_item_tooltip_content_cb_set().
15755     *
15756     * @ingroup Genlist
15757     */
15758    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15759    /**
15760     * Set the content to be shown in a given genlist item's tooltips
15761     *
15762     * @param item The genlist item.
15763     * @param func The function returning the tooltip contents.
15764     * @param data What to provide to @a func as callback data/context.
15765     * @param del_cb Called when data is not needed anymore, either when
15766     *        another callback replaces @p func, the tooltip is unset with
15767     *        elm_genlist_item_tooltip_unset() or the owner @p item
15768     *        dies. This callback receives as its first parameter the
15769     *        given @p data, being @c event_info the item handle.
15770     *
15771     * This call will setup the tooltip's contents to @p item
15772     * (analogous to elm_object_tooltip_content_cb_set(), but being
15773     * item tooltips with higher precedence than object tooltips). It
15774     * can have only one tooltip at a time, so any previous tooltip
15775     * content will get removed. @p func (with @p data) will be called
15776     * every time Elementary needs to show the tooltip and it should
15777     * return a valid Evas object, which will be fully managed by the
15778     * tooltip system, getting deleted when the tooltip is gone.
15779     *
15780     * In order to set just a text as a tooltip, look at
15781     * elm_genlist_item_tooltip_text_set().
15782     *
15783     * @ingroup Genlist
15784     */
15785    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);
15786    /**
15787     * Unset a tooltip from a given genlist item
15788     *
15789     * @param item genlist item to remove a previously set tooltip from.
15790     *
15791     * This call removes any tooltip set on @p item. The callback
15792     * provided as @c del_cb to
15793     * elm_genlist_item_tooltip_content_cb_set() will be called to
15794     * notify it is not used anymore (and have resources cleaned, if
15795     * need be).
15796     *
15797     * @see elm_genlist_item_tooltip_content_cb_set()
15798     *
15799     * @ingroup Genlist
15800     */
15801    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15802    /**
15803     * Set a different @b style for a given genlist item's tooltip.
15804     *
15805     * @param item genlist item with tooltip set
15806     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15807     * "default", @c "transparent", etc)
15808     *
15809     * Tooltips can have <b>alternate styles</b> to be displayed on,
15810     * which are defined by the theme set on Elementary. This function
15811     * works analogously as elm_object_tooltip_style_set(), but here
15812     * applied only to genlist item objects. The default style for
15813     * tooltips is @c "default".
15814     *
15815     * @note before you set a style you should define a tooltip with
15816     *       elm_genlist_item_tooltip_content_cb_set() or
15817     *       elm_genlist_item_tooltip_text_set()
15818     *
15819     * @see elm_genlist_item_tooltip_style_get()
15820     *
15821     * @ingroup Genlist
15822     */
15823    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15824    /**
15825     * Get the style set a given genlist item's tooltip.
15826     *
15827     * @param item genlist item with tooltip already set on.
15828     * @return style the theme style in use, which defaults to
15829     *         "default". If the object does not have a tooltip set,
15830     *         then @c NULL is returned.
15831     *
15832     * @see elm_genlist_item_tooltip_style_set() for more details
15833     *
15834     * @ingroup Genlist
15835     */
15836    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15837    /**
15838     * @brief Disable size restrictions on an object's tooltip
15839     * @param item The tooltip's anchor object
15840     * @param disable If EINA_TRUE, size restrictions are disabled
15841     * @return EINA_FALSE on failure, EINA_TRUE on success
15842     *
15843     * This function allows a tooltip to expand beyond its parant window's canvas.
15844     * It will instead be limited only by the size of the display.
15845     */
15846    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15847    /**
15848     * @brief Retrieve size restriction state of an object's tooltip
15849     * @param item The tooltip's anchor object
15850     * @return If EINA_TRUE, size restrictions are disabled
15851     *
15852     * This function returns whether a tooltip is allowed to expand beyond
15853     * its parant window's canvas.
15854     * It will instead be limited only by the size of the display.
15855     */
15856    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15857    /**
15858     * Set the type of mouse pointer/cursor decoration to be shown,
15859     * when the mouse pointer is over the given genlist widget item
15860     *
15861     * @param item genlist item to customize cursor on
15862     * @param cursor the cursor type's name
15863     *
15864     * This function works analogously as elm_object_cursor_set(), but
15865     * here the cursor's changing area is restricted to the item's
15866     * area, and not the whole widget's. Note that that item cursors
15867     * have precedence over widget cursors, so that a mouse over @p
15868     * item will always show cursor @p type.
15869     *
15870     * If this function is called twice for an object, a previously set
15871     * cursor will be unset on the second call.
15872     *
15873     * @see elm_object_cursor_set()
15874     * @see elm_genlist_item_cursor_get()
15875     * @see elm_genlist_item_cursor_unset()
15876     *
15877     * @ingroup Genlist
15878     */
15879    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15880    /**
15881     * Get the type of mouse pointer/cursor decoration set to be shown,
15882     * when the mouse pointer is over the given genlist widget item
15883     *
15884     * @param item genlist item with custom cursor set
15885     * @return the cursor type's name or @c NULL, if no custom cursors
15886     * were set to @p item (and on errors)
15887     *
15888     * @see elm_object_cursor_get()
15889     * @see elm_genlist_item_cursor_set() for more details
15890     * @see elm_genlist_item_cursor_unset()
15891     *
15892     * @ingroup Genlist
15893     */
15894    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15895    /**
15896     * Unset any custom mouse pointer/cursor decoration set to be
15897     * shown, when the mouse pointer is over the given genlist widget
15898     * item, thus making it show the @b default cursor again.
15899     *
15900     * @param item a genlist item
15901     *
15902     * Use this call to undo any custom settings on this item's cursor
15903     * decoration, bringing it back to defaults (no custom style set).
15904     *
15905     * @see elm_object_cursor_unset()
15906     * @see elm_genlist_item_cursor_set() for more details
15907     *
15908     * @ingroup Genlist
15909     */
15910    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15911    /**
15912     * Set a different @b style for a given custom cursor set for a
15913     * genlist item.
15914     *
15915     * @param item genlist item with custom cursor set
15916     * @param style the <b>theme style</b> to use (e.g. @c "default",
15917     * @c "transparent", etc)
15918     *
15919     * This function only makes sense when one is using custom mouse
15920     * cursor decorations <b>defined in a theme file</b> , which can
15921     * have, given a cursor name/type, <b>alternate styles</b> on
15922     * it. It works analogously as elm_object_cursor_style_set(), but
15923     * here applied only to genlist item objects.
15924     *
15925     * @warning Before you set a cursor style you should have defined a
15926     *       custom cursor previously on the item, with
15927     *       elm_genlist_item_cursor_set()
15928     *
15929     * @see elm_genlist_item_cursor_engine_only_set()
15930     * @see elm_genlist_item_cursor_style_get()
15931     *
15932     * @ingroup Genlist
15933     */
15934    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15935    /**
15936     * Get the current @b style set for a given genlist item's custom
15937     * cursor
15938     *
15939     * @param item genlist item with custom cursor set.
15940     * @return style the cursor style in use. If the object does not
15941     *         have a cursor set, then @c NULL is returned.
15942     *
15943     * @see elm_genlist_item_cursor_style_set() for more details
15944     *
15945     * @ingroup Genlist
15946     */
15947    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15948    /**
15949     * Set if the (custom) cursor for a given genlist item should be
15950     * searched in its theme, also, or should only rely on the
15951     * rendering engine.
15952     *
15953     * @param item item with custom (custom) cursor already set on
15954     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15955     * only on those provided by the rendering engine, @c EINA_FALSE to
15956     * have them searched on the widget's theme, as well.
15957     *
15958     * @note This call is of use only if you've set a custom cursor
15959     * for genlist items, with elm_genlist_item_cursor_set().
15960     *
15961     * @note By default, cursors will only be looked for between those
15962     * provided by the rendering engine.
15963     *
15964     * @ingroup Genlist
15965     */
15966    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15967    /**
15968     * Get if the (custom) cursor for a given genlist item is being
15969     * searched in its theme, also, or is only relying on the rendering
15970     * engine.
15971     *
15972     * @param item a genlist item
15973     * @return @c EINA_TRUE, if cursors are being looked for only on
15974     * those provided by the rendering engine, @c EINA_FALSE if they
15975     * are being searched on the widget's theme, as well.
15976     *
15977     * @see elm_genlist_item_cursor_engine_only_set(), for more details
15978     *
15979     * @ingroup Genlist
15980     */
15981    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15982    /**
15983     * Update the contents of all realized items.
15984     *
15985     * @param obj The genlist object.
15986     *
15987     * This updates all realized items by calling all the item class functions again
15988     * to get the icons, labels and states. Use this when the original
15989     * item data has changed and the changes are desired to be reflected.
15990     *
15991     * To update just one item, use elm_genlist_item_update().
15992     *
15993     * @see elm_genlist_realized_items_get()
15994     * @see elm_genlist_item_update()
15995     *
15996     * @ingroup Genlist
15997     */
15998    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15999    /**
16000     * Activate a genlist mode on an item
16001     *
16002     * @param item The genlist item
16003     * @param mode Mode name
16004     * @param mode_set Boolean to define set or unset mode.
16005     *
16006     * A genlist mode is a different way of selecting an item. Once a mode is
16007     * activated on an item, any other selected item is immediately unselected.
16008     * This feature provides an easy way of implementing a new kind of animation
16009     * for selecting an item, without having to entirely rewrite the item style
16010     * theme. However, the elm_genlist_selected_* API can't be used to get what
16011     * item is activate for a mode.
16012     *
16013     * The current item style will still be used, but applying a genlist mode to
16014     * an item will select it using a different kind of animation.
16015     *
16016     * The current active item for a mode can be found by
16017     * elm_genlist_mode_item_get().
16018     *
16019     * The characteristics of genlist mode are:
16020     * - Only one mode can be active at any time, and for only one item.
16021     * - Genlist handles deactivating other items when one item is activated.
16022     * - A mode is defined in the genlist theme (edc), and more modes can easily
16023     *   be added.
16024     * - A mode style and the genlist item style are different things. They
16025     *   can be combined to provide a default style to the item, with some kind
16026     *   of animation for that item when the mode is activated.
16027     *
16028     * When a mode is activated on an item, a new view for that item is created.
16029     * The theme of this mode defines the animation that will be used to transit
16030     * the item from the old view to the new view. This second (new) view will be
16031     * active for that item while the mode is active on the item, and will be
16032     * destroyed after the mode is totally deactivated from that item.
16033     *
16034     * @see elm_genlist_mode_get()
16035     * @see elm_genlist_mode_item_get()
16036     *
16037     * @ingroup Genlist
16038     */
16039    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
16040    /**
16041     * Get the last (or current) genlist mode used.
16042     *
16043     * @param obj The genlist object
16044     *
16045     * This function just returns the name of the last used genlist mode. It will
16046     * be the current mode if it's still active.
16047     *
16048     * @see elm_genlist_item_mode_set()
16049     * @see elm_genlist_mode_item_get()
16050     *
16051     * @ingroup Genlist
16052     */
16053    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16054    /**
16055     * Get active genlist mode item
16056     *
16057     * @param obj The genlist object
16058     * @return The active item for that current mode. Or @c NULL if no item is
16059     * activated with any mode.
16060     *
16061     * This function returns the item that was activated with a mode, by the
16062     * function elm_genlist_item_mode_set().
16063     *
16064     * @see elm_genlist_item_mode_set()
16065     * @see elm_genlist_mode_get()
16066     *
16067     * @ingroup Genlist
16068     */
16069    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16070    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
16071    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16072
16073    /**
16074     * @}
16075     */
16076
16077    /**
16078     * @defgroup Check Check
16079     *
16080     * @image html img/widget/check/preview-00.png
16081     * @image latex img/widget/check/preview-00.eps
16082     * @image html img/widget/check/preview-01.png
16083     * @image latex img/widget/check/preview-01.eps
16084     * @image html img/widget/check/preview-02.png
16085     * @image latex img/widget/check/preview-02.eps
16086     *
16087     * @brief The check widget allows for toggling a value between true and
16088     * false.
16089     *
16090     * Check objects are a lot like radio objects in layout and functionality
16091     * except they do not work as a group, but independently and only toggle the
16092     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
16093     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
16094     * returns the current state. For convenience, like the radio objects, you
16095     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
16096     * for it to modify.
16097     *
16098     * Signals that you can add callbacks for are:
16099     * "changed" - This is called whenever the user changes the state of one of
16100     *             the check object(event_info is NULL).
16101     *
16102     * @ref tutorial_check should give you a firm grasp of how to use this widget.
16103     * @{
16104     */
16105    /**
16106     * @brief Add a new Check object
16107     *
16108     * @param parent The parent object
16109     * @return The new object or NULL if it cannot be created
16110     */
16111    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16112    /**
16113     * @brief Set the text label of the check object
16114     *
16115     * @param obj The check object
16116     * @param label The text label string in UTF-8
16117     *
16118     * @deprecated use elm_object_text_set() instead.
16119     */
16120    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16121    /**
16122     * @brief Get the text label of the check object
16123     *
16124     * @param obj The check object
16125     * @return The text label string in UTF-8
16126     *
16127     * @deprecated use elm_object_text_get() instead.
16128     */
16129    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16130    /**
16131     * @brief Set the icon object of the check object
16132     *
16133     * @param obj The check object
16134     * @param icon The icon object
16135     *
16136     * Once the icon object is set, a previously set one will be deleted.
16137     * If you want to keep that old content object, use the
16138     * elm_check_icon_unset() function.
16139     */
16140    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16141    /**
16142     * @brief Get the icon object of the check object
16143     *
16144     * @param obj The check object
16145     * @return The icon object
16146     */
16147    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16148    /**
16149     * @brief Unset the icon used for the check object
16150     *
16151     * @param obj The check object
16152     * @return The icon object that was being used
16153     *
16154     * Unparent and return the icon object which was set for this widget.
16155     */
16156    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16157    /**
16158     * @brief Set the on/off state of the check object
16159     *
16160     * @param obj The check object
16161     * @param state The state to use (1 == on, 0 == off)
16162     *
16163     * This sets the state of the check. If set
16164     * with elm_check_state_pointer_set() the state of that variable is also
16165     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
16166     */
16167    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
16168    /**
16169     * @brief Get the state of the check object
16170     *
16171     * @param obj The check object
16172     * @return The boolean state
16173     */
16174    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16175    /**
16176     * @brief Set a convenience pointer to a boolean to change
16177     *
16178     * @param obj The check object
16179     * @param statep Pointer to the boolean to modify
16180     *
16181     * This sets a pointer to a boolean, that, in addition to the check objects
16182     * state will also be modified directly. To stop setting the object pointed
16183     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
16184     * then when this is called, the check objects state will also be modified to
16185     * reflect the value of the boolean @p statep points to, just like calling
16186     * elm_check_state_set().
16187     */
16188    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
16189    /**
16190     * @}
16191     */
16192
16193    /**
16194     * @defgroup Radio Radio
16195     *
16196     * @image html img/widget/radio/preview-00.png
16197     * @image latex img/widget/radio/preview-00.eps
16198     *
16199     * @brief Radio is a widget that allows for 1 or more options to be displayed
16200     * and have the user choose only 1 of them.
16201     *
16202     * A radio object contains an indicator, an optional Label and an optional
16203     * icon object. While it's possible to have a group of only one radio they,
16204     * are normally used in groups of 2 or more. To add a radio to a group use
16205     * elm_radio_group_add(). The radio object(s) will select from one of a set
16206     * of integer values, so any value they are configuring needs to be mapped to
16207     * a set of integers. To configure what value that radio object represents,
16208     * use  elm_radio_state_value_set() to set the integer it represents. To set
16209     * the value the whole group(which one is currently selected) is to indicate
16210     * use elm_radio_value_set() on any group member, and to get the groups value
16211     * use elm_radio_value_get(). For convenience the radio objects are also able
16212     * to directly set an integer(int) to the value that is selected. To specify
16213     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
16214     * The radio objects will modify this directly. That implies the pointer must
16215     * point to valid memory for as long as the radio objects exist.
16216     *
16217     * Signals that you can add callbacks for are:
16218     * @li changed - This is called whenever the user changes the state of one of
16219     * the radio objects within the group of radio objects that work together.
16220     *
16221     * @ref tutorial_radio show most of this API in action.
16222     * @{
16223     */
16224    /**
16225     * @brief Add a new radio to the parent
16226     *
16227     * @param parent The parent object
16228     * @return The new object or NULL if it cannot be created
16229     */
16230    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16231    /**
16232     * @brief Set the text label of the radio object
16233     *
16234     * @param obj The radio object
16235     * @param label The text label string in UTF-8
16236     *
16237     * @deprecated use elm_object_text_set() instead.
16238     */
16239    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16240    /**
16241     * @brief Get the text label of the radio object
16242     *
16243     * @param obj The radio object
16244     * @return The text label string in UTF-8
16245     *
16246     * @deprecated use elm_object_text_set() instead.
16247     */
16248    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16249    /**
16250     * @brief Set the icon object of the radio object
16251     *
16252     * @param obj The radio object
16253     * @param icon The icon object
16254     *
16255     * Once the icon object is set, a previously set one will be deleted. If you
16256     * want to keep that old content object, use the elm_radio_icon_unset()
16257     * function.
16258     */
16259    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16260    /**
16261     * @brief Get the icon object of the radio object
16262     *
16263     * @param obj The radio object
16264     * @return The icon object
16265     *
16266     * @see elm_radio_icon_set()
16267     */
16268    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16269    /**
16270     * @brief Unset the icon used for the radio object
16271     *
16272     * @param obj The radio object
16273     * @return The icon object that was being used
16274     *
16275     * Unparent and return the icon object which was set for this widget.
16276     *
16277     * @see elm_radio_icon_set()
16278     */
16279    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16280    /**
16281     * @brief Add this radio to a group of other radio objects
16282     *
16283     * @param obj The radio object
16284     * @param group Any object whose group the @p obj is to join.
16285     *
16286     * Radio objects work in groups. Each member should have a different integer
16287     * value assigned. In order to have them work as a group, they need to know
16288     * about each other. This adds the given radio object to the group of which
16289     * the group object indicated is a member.
16290     */
16291    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
16292    /**
16293     * @brief Set the integer value that this radio object represents
16294     *
16295     * @param obj The radio object
16296     * @param value The value to use if this radio object is selected
16297     *
16298     * This sets the value of the radio.
16299     */
16300    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16301    /**
16302     * @brief Get the integer value that this radio object represents
16303     *
16304     * @param obj The radio object
16305     * @return The value used if this radio object is selected
16306     *
16307     * This gets the value of the radio.
16308     *
16309     * @see elm_radio_value_set()
16310     */
16311    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16312    /**
16313     * @brief Set the value of the radio.
16314     *
16315     * @param obj The radio object
16316     * @param value The value to use for the group
16317     *
16318     * This sets the value of the radio group and will also set the value if
16319     * pointed to, to the value supplied, but will not call any callbacks.
16320     */
16321    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16322    /**
16323     * @brief Get the state of the radio object
16324     *
16325     * @param obj The radio object
16326     * @return The integer state
16327     */
16328    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16329    /**
16330     * @brief Set a convenience pointer to a integer to change
16331     *
16332     * @param obj The radio object
16333     * @param valuep Pointer to the integer to modify
16334     *
16335     * This sets a pointer to a integer, that, in addition to the radio objects
16336     * state will also be modified directly. To stop setting the object pointed
16337     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
16338     * when this is called, the radio objects state will also be modified to
16339     * reflect the value of the integer valuep points to, just like calling
16340     * elm_radio_value_set().
16341     */
16342    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16343    /**
16344     * @}
16345     */
16346
16347    /**
16348     * @defgroup Pager Pager
16349     *
16350     * @image html img/widget/pager/preview-00.png
16351     * @image latex img/widget/pager/preview-00.eps
16352     *
16353     * @brief Widget that allows flipping between 1 or more “pages” of objects.
16354     *
16355     * The flipping between “pages” of objects is animated. All content in pager
16356     * is kept in a stack, the last content to be added will be on the top of the
16357     * stack(be visible).
16358     *
16359     * Objects can be pushed or popped from the stack or deleted as normal.
16360     * Pushes and pops will animate (and a pop will delete the object once the
16361     * animation is finished). Any object already in the pager can be promoted to
16362     * the top(from its current stacking position) through the use of
16363     * elm_pager_content_promote(). Objects are pushed to the top with
16364     * elm_pager_content_push() and when the top item is no longer wanted, simply
16365     * pop it with elm_pager_content_pop() and it will also be deleted. If an
16366     * object is no longer needed and is not the top item, just delete it as
16367     * normal. You can query which objects are the top and bottom with
16368     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16369     *
16370     * Signals that you can add callbacks for are:
16371     * "hide,finished" - when the previous page is hided
16372     *
16373     * This widget has the following styles available:
16374     * @li default
16375     * @li fade
16376     * @li fade_translucide
16377     * @li fade_invisible
16378     * @note This styles affect only the flipping animations, the appearance when
16379     * not animating is unaffected by styles.
16380     *
16381     * @ref tutorial_pager gives a good overview of the usage of the API.
16382     * @{
16383     */
16384    /**
16385     * Add a new pager to the parent
16386     *
16387     * @param parent The parent object
16388     * @return The new object or NULL if it cannot be created
16389     *
16390     * @ingroup Pager
16391     */
16392    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16393    /**
16394     * @brief Push an object to the top of the pager stack (and show it).
16395     *
16396     * @param obj The pager object
16397     * @param content The object to push
16398     *
16399     * The object pushed becomes a child of the pager, it will be controlled and
16400     * deleted when the pager is deleted.
16401     *
16402     * @note If the content is already in the stack use
16403     * elm_pager_content_promote().
16404     * @warning Using this function on @p content already in the stack results in
16405     * undefined behavior.
16406     */
16407    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16408    /**
16409     * @brief Pop the object that is on top of the stack
16410     *
16411     * @param obj The pager object
16412     *
16413     * This pops the object that is on the top(visible) of the pager, makes it
16414     * disappear, then deletes the object. The object that was underneath it on
16415     * the stack will become visible.
16416     */
16417    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16418    /**
16419     * @brief Moves an object already in the pager stack to the top of the stack.
16420     *
16421     * @param obj The pager object
16422     * @param content The object to promote
16423     *
16424     * This will take the @p content and move it to the top of the stack as
16425     * if it had been pushed there.
16426     *
16427     * @note If the content isn't already in the stack use
16428     * elm_pager_content_push().
16429     * @warning Using this function on @p content not already in the stack
16430     * results in undefined behavior.
16431     */
16432    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16433    /**
16434     * @brief Return the object at the bottom of the pager stack
16435     *
16436     * @param obj The pager object
16437     * @return The bottom object or NULL if none
16438     */
16439    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16440    /**
16441     * @brief  Return the object at the top of the pager stack
16442     *
16443     * @param obj The pager object
16444     * @return The top object or NULL if none
16445     */
16446    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16447    /**
16448     * @}
16449     */
16450
16451    /**
16452     * @defgroup Slideshow Slideshow
16453     *
16454     * @image html img/widget/slideshow/preview-00.png
16455     * @image latex img/widget/slideshow/preview-00.eps
16456     *
16457     * This widget, as the name indicates, is a pre-made image
16458     * slideshow panel, with API functions acting on (child) image
16459     * items presentation. Between those actions, are:
16460     * - advance to next/previous image
16461     * - select the style of image transition animation
16462     * - set the exhibition time for each image
16463     * - start/stop the slideshow
16464     *
16465     * The transition animations are defined in the widget's theme,
16466     * consequently new animations can be added without having to
16467     * update the widget's code.
16468     *
16469     * @section Slideshow_Items Slideshow items
16470     *
16471     * For slideshow items, just like for @ref Genlist "genlist" ones,
16472     * the user defines a @b classes, specifying functions that will be
16473     * called on the item's creation and deletion times.
16474     *
16475     * The #Elm_Slideshow_Item_Class structure contains the following
16476     * members:
16477     *
16478     * - @c func.get - When an item is displayed, this function is
16479     *   called, and it's where one should create the item object, de
16480     *   facto. For example, the object can be a pure Evas image object
16481     *   or an Elementary @ref Photocam "photocam" widget. See
16482     *   #SlideshowItemGetFunc.
16483     * - @c func.del - When an item is no more displayed, this function
16484     *   is called, where the user must delete any data associated to
16485     *   the item. See #SlideshowItemDelFunc.
16486     *
16487     * @section Slideshow_Caching Slideshow caching
16488     *
16489     * The slideshow provides facilities to have items adjacent to the
16490     * one being displayed <b>already "realized"</b> (i.e. loaded) for
16491     * you, so that the system does not have to decode image data
16492     * anymore at the time it has to actually switch images on its
16493     * viewport. The user is able to set the numbers of items to be
16494     * cached @b before and @b after the current item, in the widget's
16495     * item list.
16496     *
16497     * Smart events one can add callbacks for are:
16498     *
16499     * - @c "changed" - when the slideshow switches its view to a new
16500     *   item
16501     *
16502     * List of examples for the slideshow widget:
16503     * @li @ref slideshow_example
16504     */
16505
16506    /**
16507     * @addtogroup Slideshow
16508     * @{
16509     */
16510
16511    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16512    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16513    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
16514    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16515    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16516
16517    /**
16518     * @struct _Elm_Slideshow_Item_Class
16519     *
16520     * Slideshow item class definition. See @ref Slideshow_Items for
16521     * field details.
16522     */
16523    struct _Elm_Slideshow_Item_Class
16524      {
16525         struct _Elm_Slideshow_Item_Class_Func
16526           {
16527              SlideshowItemGetFunc get;
16528              SlideshowItemDelFunc del;
16529           } func;
16530      }; /**< #Elm_Slideshow_Item_Class member definitions */
16531
16532    /**
16533     * Add a new slideshow widget to the given parent Elementary
16534     * (container) object
16535     *
16536     * @param parent The parent object
16537     * @return A new slideshow widget handle or @c NULL, on errors
16538     *
16539     * This function inserts a new slideshow widget on the canvas.
16540     *
16541     * @ingroup Slideshow
16542     */
16543    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16544
16545    /**
16546     * Add (append) a new item in a given slideshow widget.
16547     *
16548     * @param obj The slideshow object
16549     * @param itc The item class for the item
16550     * @param data The item's data
16551     * @return A handle to the item added or @c NULL, on errors
16552     *
16553     * Add a new item to @p obj's internal list of items, appending it.
16554     * The item's class must contain the function really fetching the
16555     * image object to show for this item, which could be an Evas image
16556     * object or an Elementary photo, for example. The @p data
16557     * parameter is going to be passed to both class functions of the
16558     * item.
16559     *
16560     * @see #Elm_Slideshow_Item_Class
16561     * @see elm_slideshow_item_sorted_insert()
16562     *
16563     * @ingroup Slideshow
16564     */
16565    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16566
16567    /**
16568     * Insert a new item into the given slideshow widget, using the @p func
16569     * function to sort items (by item handles).
16570     *
16571     * @param obj The slideshow object
16572     * @param itc The item class for the item
16573     * @param data The item's data
16574     * @param func The comparing function to be used to sort slideshow
16575     * items <b>by #Elm_Slideshow_Item item handles</b>
16576     * @return Returns The slideshow item handle, on success, or
16577     * @c NULL, on errors
16578     *
16579     * Add a new item to @p obj's internal list of items, in a position
16580     * determined by the @p func comparing function. The item's class
16581     * must contain the function really fetching the image object to
16582     * show for this item, which could be an Evas image object or an
16583     * Elementary photo, for example. The @p data parameter is going to
16584     * be passed to both class functions of the item.
16585     *
16586     * @see #Elm_Slideshow_Item_Class
16587     * @see elm_slideshow_item_add()
16588     *
16589     * @ingroup Slideshow
16590     */
16591    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);
16592
16593    /**
16594     * Display a given slideshow widget's item, programmatically.
16595     *
16596     * @param obj The slideshow object
16597     * @param item The item to display on @p obj's viewport
16598     *
16599     * The change between the current item and @p item will use the
16600     * transition @p obj is set to use (@see
16601     * elm_slideshow_transition_set()).
16602     *
16603     * @ingroup Slideshow
16604     */
16605    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16606
16607    /**
16608     * Slide to the @b next item, in a given slideshow widget
16609     *
16610     * @param obj The slideshow object
16611     *
16612     * The sliding animation @p obj is set to use will be the
16613     * transition effect used, after this call is issued.
16614     *
16615     * @note If the end of the slideshow's internal list of items is
16616     * reached, it'll wrap around to the list's beginning, again.
16617     *
16618     * @ingroup Slideshow
16619     */
16620    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16621
16622    /**
16623     * Slide to the @b previous item, in a given slideshow widget
16624     *
16625     * @param obj The slideshow object
16626     *
16627     * The sliding animation @p obj is set to use will be the
16628     * transition effect used, after this call is issued.
16629     *
16630     * @note If the beginning of the slideshow's internal list of items
16631     * is reached, it'll wrap around to the list's end, again.
16632     *
16633     * @ingroup Slideshow
16634     */
16635    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16636
16637    /**
16638     * Returns the list of sliding transition/effect names available, for a
16639     * given slideshow widget.
16640     *
16641     * @param obj The slideshow object
16642     * @return The list of transitions (list of @b stringshared strings
16643     * as data)
16644     *
16645     * The transitions, which come from @p obj's theme, must be an EDC
16646     * data item named @c "transitions" on the theme file, with (prefix)
16647     * names of EDC programs actually implementing them.
16648     *
16649     * The available transitions for slideshows on the default theme are:
16650     * - @c "fade" - the current item fades out, while the new one
16651     *   fades in to the slideshow's viewport.
16652     * - @c "black_fade" - the current item fades to black, and just
16653     *   then, the new item will fade in.
16654     * - @c "horizontal" - the current item slides horizontally, until
16655     *   it gets out of the slideshow's viewport, while the new item
16656     *   comes from the left to take its place.
16657     * - @c "vertical" - the current item slides vertically, until it
16658     *   gets out of the slideshow's viewport, while the new item comes
16659     *   from the bottom to take its place.
16660     * - @c "square" - the new item starts to appear from the middle of
16661     *   the current one, but with a tiny size, growing until its
16662     *   target (full) size and covering the old one.
16663     *
16664     * @warning The stringshared strings get no new references
16665     * exclusive to the user grabbing the list, here, so if you'd like
16666     * to use them out of this call's context, you'd better @c
16667     * eina_stringshare_ref() them.
16668     *
16669     * @see elm_slideshow_transition_set()
16670     *
16671     * @ingroup Slideshow
16672     */
16673    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16674
16675    /**
16676     * Set the current slide transition/effect in use for a given
16677     * slideshow widget
16678     *
16679     * @param obj The slideshow object
16680     * @param transition The new transition's name string
16681     *
16682     * If @p transition is implemented in @p obj's theme (i.e., is
16683     * contained in the list returned by
16684     * elm_slideshow_transitions_get()), this new sliding effect will
16685     * be used on the widget.
16686     *
16687     * @see elm_slideshow_transitions_get() for more details
16688     *
16689     * @ingroup Slideshow
16690     */
16691    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16692
16693    /**
16694     * Get the current slide transition/effect in use for a given
16695     * slideshow widget
16696     *
16697     * @param obj The slideshow object
16698     * @return The current transition's name
16699     *
16700     * @see elm_slideshow_transition_set() for more details
16701     *
16702     * @ingroup Slideshow
16703     */
16704    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16705
16706    /**
16707     * Set the interval between each image transition on a given
16708     * slideshow widget, <b>and start the slideshow, itself</b>
16709     *
16710     * @param obj The slideshow object
16711     * @param timeout The new displaying timeout for images
16712     *
16713     * After this call, the slideshow widget will start cycling its
16714     * view, sequentially and automatically, with the images of the
16715     * items it has. The time between each new image displayed is going
16716     * to be @p timeout, in @b seconds. If a different timeout was set
16717     * previously and an slideshow was in progress, it will continue
16718     * with the new time between transitions, after this call.
16719     *
16720     * @note A value less than or equal to 0 on @p timeout will disable
16721     * the widget's internal timer, thus halting any slideshow which
16722     * could be happening on @p obj.
16723     *
16724     * @see elm_slideshow_timeout_get()
16725     *
16726     * @ingroup Slideshow
16727     */
16728    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16729
16730    /**
16731     * Get the interval set for image transitions on a given slideshow
16732     * widget.
16733     *
16734     * @param obj The slideshow object
16735     * @return Returns the timeout set on it
16736     *
16737     * @see elm_slideshow_timeout_set() for more details
16738     *
16739     * @ingroup Slideshow
16740     */
16741    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16742
16743    /**
16744     * Set if, after a slideshow is started, for a given slideshow
16745     * widget, its items should be displayed cyclically or not.
16746     *
16747     * @param obj The slideshow object
16748     * @param loop Use @c EINA_TRUE to make it cycle through items or
16749     * @c EINA_FALSE for it to stop at the end of @p obj's internal
16750     * list of items
16751     *
16752     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16753     * ignore what is set by this functions, i.e., they'll @b always
16754     * cycle through items. This affects only the "automatic"
16755     * slideshow, as set by elm_slideshow_timeout_set().
16756     *
16757     * @see elm_slideshow_loop_get()
16758     *
16759     * @ingroup Slideshow
16760     */
16761    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16762
16763    /**
16764     * Get if, after a slideshow is started, for a given slideshow
16765     * widget, its items are to be displayed cyclically or not.
16766     *
16767     * @param obj The slideshow object
16768     * @return @c EINA_TRUE, if the items in @p obj will be cycled
16769     * through or @c EINA_FALSE, otherwise
16770     *
16771     * @see elm_slideshow_loop_set() for more details
16772     *
16773     * @ingroup Slideshow
16774     */
16775    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16776
16777    /**
16778     * Remove all items from a given slideshow widget
16779     *
16780     * @param obj The slideshow object
16781     *
16782     * This removes (and deletes) all items in @p obj, leaving it
16783     * empty.
16784     *
16785     * @see elm_slideshow_item_del(), to remove just one item.
16786     *
16787     * @ingroup Slideshow
16788     */
16789    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16790
16791    /**
16792     * Get the internal list of items in a given slideshow widget.
16793     *
16794     * @param obj The slideshow object
16795     * @return The list of items (#Elm_Slideshow_Item as data) or
16796     * @c NULL on errors.
16797     *
16798     * This list is @b not to be modified in any way and must not be
16799     * freed. Use the list members with functions like
16800     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16801     *
16802     * @warning This list is only valid until @p obj object's internal
16803     * items list is changed. It should be fetched again with another
16804     * call to this function when changes happen.
16805     *
16806     * @ingroup Slideshow
16807     */
16808    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16809
16810    /**
16811     * Delete a given item from a slideshow widget.
16812     *
16813     * @param item The slideshow item
16814     *
16815     * @ingroup Slideshow
16816     */
16817    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16818
16819    /**
16820     * Return the data associated with a given slideshow item
16821     *
16822     * @param item The slideshow item
16823     * @return Returns the data associated to this item
16824     *
16825     * @ingroup Slideshow
16826     */
16827    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16828
16829    /**
16830     * Returns the currently displayed item, in a given slideshow widget
16831     *
16832     * @param obj The slideshow object
16833     * @return A handle to the item being displayed in @p obj or
16834     * @c NULL, if none is (and on errors)
16835     *
16836     * @ingroup Slideshow
16837     */
16838    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16839
16840    /**
16841     * Get the real Evas object created to implement the view of a
16842     * given slideshow item
16843     *
16844     * @param item The slideshow item.
16845     * @return the Evas object implementing this item's view.
16846     *
16847     * This returns the actual Evas object used to implement the
16848     * specified slideshow item's view. This may be @c NULL, as it may
16849     * not have been created or may have been deleted, at any time, by
16850     * the slideshow. <b>Do not modify this object</b> (move, resize,
16851     * show, hide, etc.), as the slideshow is controlling it. This
16852     * function is for querying, emitting custom signals or hooking
16853     * lower level callbacks for events on that object. Do not delete
16854     * this object under any circumstances.
16855     *
16856     * @see elm_slideshow_item_data_get()
16857     *
16858     * @ingroup Slideshow
16859     */
16860    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16861
16862    /**
16863     * Get the the item, in a given slideshow widget, placed at
16864     * position @p nth, in its internal items list
16865     *
16866     * @param obj The slideshow object
16867     * @param nth The number of the item to grab a handle to (0 being
16868     * the first)
16869     * @return The item stored in @p obj at position @p nth or @c NULL,
16870     * if there's no item with that index (and on errors)
16871     *
16872     * @ingroup Slideshow
16873     */
16874    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16875
16876    /**
16877     * Set the current slide layout in use for a given slideshow widget
16878     *
16879     * @param obj The slideshow object
16880     * @param layout The new layout's name string
16881     *
16882     * If @p layout is implemented in @p obj's theme (i.e., is contained
16883     * in the list returned by elm_slideshow_layouts_get()), this new
16884     * images layout will be used on the widget.
16885     *
16886     * @see elm_slideshow_layouts_get() for more details
16887     *
16888     * @ingroup Slideshow
16889     */
16890    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16891
16892    /**
16893     * Get the current slide layout in use for a given slideshow widget
16894     *
16895     * @param obj The slideshow object
16896     * @return The current layout's name
16897     *
16898     * @see elm_slideshow_layout_set() for more details
16899     *
16900     * @ingroup Slideshow
16901     */
16902    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16903
16904    /**
16905     * Returns the list of @b layout names available, for a given
16906     * slideshow widget.
16907     *
16908     * @param obj The slideshow object
16909     * @return The list of layouts (list of @b stringshared strings
16910     * as data)
16911     *
16912     * Slideshow layouts will change how the widget is to dispose each
16913     * image item in its viewport, with regard to cropping, scaling,
16914     * etc.
16915     *
16916     * The layouts, which come from @p obj's theme, must be an EDC
16917     * data item name @c "layouts" on the theme file, with (prefix)
16918     * names of EDC programs actually implementing them.
16919     *
16920     * The available layouts for slideshows on the default theme are:
16921     * - @c "fullscreen" - item images with original aspect, scaled to
16922     *   touch top and down slideshow borders or, if the image's heigh
16923     *   is not enough, left and right slideshow borders.
16924     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16925     *   one, but always leaving 10% of the slideshow's dimensions of
16926     *   distance between the item image's borders and the slideshow
16927     *   borders, for each axis.
16928     *
16929     * @warning The stringshared strings get no new references
16930     * exclusive to the user grabbing the list, here, so if you'd like
16931     * to use them out of this call's context, you'd better @c
16932     * eina_stringshare_ref() them.
16933     *
16934     * @see elm_slideshow_layout_set()
16935     *
16936     * @ingroup Slideshow
16937     */
16938    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16939
16940    /**
16941     * Set the number of items to cache, on a given slideshow widget,
16942     * <b>before the current item</b>
16943     *
16944     * @param obj The slideshow object
16945     * @param count Number of items to cache before the current one
16946     *
16947     * The default value for this property is @c 2. See
16948     * @ref Slideshow_Caching "slideshow caching" for more details.
16949     *
16950     * @see elm_slideshow_cache_before_get()
16951     *
16952     * @ingroup Slideshow
16953     */
16954    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16955
16956    /**
16957     * Retrieve the number of items to cache, on a given slideshow widget,
16958     * <b>before the current item</b>
16959     *
16960     * @param obj The slideshow object
16961     * @return The number of items set to be cached before the current one
16962     *
16963     * @see elm_slideshow_cache_before_set() for more details
16964     *
16965     * @ingroup Slideshow
16966     */
16967    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16968
16969    /**
16970     * Set the number of items to cache, on a given slideshow widget,
16971     * <b>after the current item</b>
16972     *
16973     * @param obj The slideshow object
16974     * @param count Number of items to cache after the current one
16975     *
16976     * The default value for this property is @c 2. See
16977     * @ref Slideshow_Caching "slideshow caching" for more details.
16978     *
16979     * @see elm_slideshow_cache_after_get()
16980     *
16981     * @ingroup Slideshow
16982     */
16983    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16984
16985    /**
16986     * Retrieve the number of items to cache, on a given slideshow widget,
16987     * <b>after the current item</b>
16988     *
16989     * @param obj The slideshow object
16990     * @return The number of items set to be cached after the current one
16991     *
16992     * @see elm_slideshow_cache_after_set() for more details
16993     *
16994     * @ingroup Slideshow
16995     */
16996    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16997
16998    /**
16999     * Get the number of items stored in a given slideshow widget
17000     *
17001     * @param obj The slideshow object
17002     * @return The number of items on @p obj, at the moment of this call
17003     *
17004     * @ingroup Slideshow
17005     */
17006    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17007
17008    /**
17009     * @}
17010     */
17011
17012    /**
17013     * @defgroup Fileselector File Selector
17014     *
17015     * @image html img/widget/fileselector/preview-00.png
17016     * @image latex img/widget/fileselector/preview-00.eps
17017     *
17018     * A file selector is a widget that allows a user to navigate
17019     * through a file system, reporting file selections back via its
17020     * API.
17021     *
17022     * It contains shortcut buttons for home directory (@c ~) and to
17023     * jump one directory upwards (..), as well as cancel/ok buttons to
17024     * confirm/cancel a given selection. After either one of those two
17025     * former actions, the file selector will issue its @c "done" smart
17026     * callback.
17027     *
17028     * There's a text entry on it, too, showing the name of the current
17029     * selection. There's the possibility of making it editable, so it
17030     * is useful on file saving dialogs on applications, where one
17031     * gives a file name to save contents to, in a given directory in
17032     * the system. This custom file name will be reported on the @c
17033     * "done" smart callback (explained in sequence).
17034     *
17035     * Finally, it has a view to display file system items into in two
17036     * possible forms:
17037     * - list
17038     * - grid
17039     *
17040     * If Elementary is built with support of the Ethumb thumbnailing
17041     * library, the second form of view will display preview thumbnails
17042     * of files which it supports.
17043     *
17044     * Smart callbacks one can register to:
17045     *
17046     * - @c "selected" - the user has clicked on a file (when not in
17047     *      folders-only mode) or directory (when in folders-only mode)
17048     * - @c "directory,open" - the list has been populated with new
17049     *      content (@c event_info is a pointer to the directory's
17050     *      path, a @b stringshared string)
17051     * - @c "done" - the user has clicked on the "ok" or "cancel"
17052     *      buttons (@c event_info is a pointer to the selection's
17053     *      path, a @b stringshared string)
17054     *
17055     * Here is an example on its usage:
17056     * @li @ref fileselector_example
17057     */
17058
17059    /**
17060     * @addtogroup Fileselector
17061     * @{
17062     */
17063
17064    /**
17065     * Defines how a file selector widget is to layout its contents
17066     * (file system entries).
17067     */
17068    typedef enum _Elm_Fileselector_Mode
17069      {
17070         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
17071         ELM_FILESELECTOR_GRID, /**< layout as a grid */
17072         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
17073      } Elm_Fileselector_Mode;
17074
17075    /**
17076     * Add a new file selector widget to the given parent Elementary
17077     * (container) object
17078     *
17079     * @param parent The parent object
17080     * @return a new file selector widget handle or @c NULL, on errors
17081     *
17082     * This function inserts a new file selector widget on the canvas.
17083     *
17084     * @ingroup Fileselector
17085     */
17086    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17087
17088    /**
17089     * Enable/disable the file name entry box where the user can type
17090     * in a name for a file, in a given file selector widget
17091     *
17092     * @param obj The file selector object
17093     * @param is_save @c EINA_TRUE to make the file selector a "saving
17094     * dialog", @c EINA_FALSE otherwise
17095     *
17096     * Having the entry editable is useful on file saving dialogs on
17097     * applications, where one gives a file name to save contents to,
17098     * in a given directory in the system. This custom file name will
17099     * be reported on the @c "done" smart callback.
17100     *
17101     * @see elm_fileselector_is_save_get()
17102     *
17103     * @ingroup Fileselector
17104     */
17105    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
17106
17107    /**
17108     * Get whether the given file selector is in "saving dialog" mode
17109     *
17110     * @param obj The file selector object
17111     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
17112     * mode, @c EINA_FALSE otherwise (and on errors)
17113     *
17114     * @see elm_fileselector_is_save_set() for more details
17115     *
17116     * @ingroup Fileselector
17117     */
17118    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17119
17120    /**
17121     * Enable/disable folder-only view for a given file selector widget
17122     *
17123     * @param obj The file selector object
17124     * @param only @c EINA_TRUE to make @p obj only display
17125     * directories, @c EINA_FALSE to make files to be displayed in it
17126     * too
17127     *
17128     * If enabled, the widget's view will only display folder items,
17129     * naturally.
17130     *
17131     * @see elm_fileselector_folder_only_get()
17132     *
17133     * @ingroup Fileselector
17134     */
17135    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
17136
17137    /**
17138     * Get whether folder-only view is set for a given file selector
17139     * widget
17140     *
17141     * @param obj The file selector object
17142     * @return only @c EINA_TRUE if @p obj is only displaying
17143     * directories, @c EINA_FALSE if files are being displayed in it
17144     * too (and on errors)
17145     *
17146     * @see elm_fileselector_folder_only_get()
17147     *
17148     * @ingroup Fileselector
17149     */
17150    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17151
17152    /**
17153     * Enable/disable the "ok" and "cancel" buttons on a given file
17154     * selector widget
17155     *
17156     * @param obj The file selector object
17157     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
17158     *
17159     * @note A file selector without those buttons will never emit the
17160     * @c "done" smart event, and is only usable if one is just hooking
17161     * to the other two events.
17162     *
17163     * @see elm_fileselector_buttons_ok_cancel_get()
17164     *
17165     * @ingroup Fileselector
17166     */
17167    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
17168
17169    /**
17170     * Get whether the "ok" and "cancel" buttons on a given file
17171     * selector widget are being shown.
17172     *
17173     * @param obj The file selector object
17174     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
17175     * otherwise (and on errors)
17176     *
17177     * @see elm_fileselector_buttons_ok_cancel_set() for more details
17178     *
17179     * @ingroup Fileselector
17180     */
17181    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17182
17183    /**
17184     * Enable/disable a tree view in the given file selector widget,
17185     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
17186     *
17187     * @param obj The file selector object
17188     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
17189     * disable
17190     *
17191     * In a tree view, arrows are created on the sides of directories,
17192     * allowing them to expand in place.
17193     *
17194     * @note If it's in other mode, the changes made by this function
17195     * will only be visible when one switches back to "list" mode.
17196     *
17197     * @see elm_fileselector_expandable_get()
17198     *
17199     * @ingroup Fileselector
17200     */
17201    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
17202
17203    /**
17204     * Get whether tree view is enabled for the given file selector
17205     * widget
17206     *
17207     * @param obj The file selector object
17208     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
17209     * otherwise (and or errors)
17210     *
17211     * @see elm_fileselector_expandable_set() for more details
17212     *
17213     * @ingroup Fileselector
17214     */
17215    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17216
17217    /**
17218     * Set, programmatically, the @b directory that a given file
17219     * selector widget will display contents from
17220     *
17221     * @param obj The file selector object
17222     * @param path The path to display in @p obj
17223     *
17224     * This will change the @b directory that @p obj is displaying. It
17225     * will also clear the text entry area on the @p obj object, which
17226     * displays select files' names.
17227     *
17228     * @see elm_fileselector_path_get()
17229     *
17230     * @ingroup Fileselector
17231     */
17232    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17233
17234    /**
17235     * Get the parent directory's path that a given file selector
17236     * widget is displaying
17237     *
17238     * @param obj The file selector object
17239     * @return The (full) path of the directory the file selector is
17240     * displaying, a @b stringshared string
17241     *
17242     * @see elm_fileselector_path_set()
17243     *
17244     * @ingroup Fileselector
17245     */
17246    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17247
17248    /**
17249     * Set, programmatically, the currently selected file/directory in
17250     * the given file selector widget
17251     *
17252     * @param obj The file selector object
17253     * @param path The (full) path to a file or directory
17254     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
17255     * latter case occurs if the directory or file pointed to do not
17256     * exist.
17257     *
17258     * @see elm_fileselector_selected_get()
17259     *
17260     * @ingroup Fileselector
17261     */
17262    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17263
17264    /**
17265     * Get the currently selected item's (full) path, in the given file
17266     * selector widget
17267     *
17268     * @param obj The file selector object
17269     * @return The absolute path of the selected item, a @b
17270     * stringshared string
17271     *
17272     * @note Custom editions on @p obj object's text entry, if made,
17273     * will appear on the return string of this function, naturally.
17274     *
17275     * @see elm_fileselector_selected_set() for more details
17276     *
17277     * @ingroup Fileselector
17278     */
17279    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17280
17281    /**
17282     * Set the mode in which a given file selector widget will display
17283     * (layout) file system entries in its view
17284     *
17285     * @param obj The file selector object
17286     * @param mode The mode of the fileselector, being it one of
17287     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
17288     * first one, naturally, will display the files in a list. The
17289     * latter will make the widget to display its entries in a grid
17290     * form.
17291     *
17292     * @note By using elm_fileselector_expandable_set(), the user may
17293     * trigger a tree view for that list.
17294     *
17295     * @note If Elementary is built with support of the Ethumb
17296     * thumbnailing library, the second form of view will display
17297     * preview thumbnails of files which it supports. You must have
17298     * elm_need_ethumb() called in your Elementary for thumbnailing to
17299     * work, though.
17300     *
17301     * @see elm_fileselector_expandable_set().
17302     * @see elm_fileselector_mode_get().
17303     *
17304     * @ingroup Fileselector
17305     */
17306    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
17307
17308    /**
17309     * Get the mode in which a given file selector widget is displaying
17310     * (layouting) file system entries in its view
17311     *
17312     * @param obj The fileselector object
17313     * @return The mode in which the fileselector is at
17314     *
17315     * @see elm_fileselector_mode_set() for more details
17316     *
17317     * @ingroup Fileselector
17318     */
17319    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17320
17321    /**
17322     * @}
17323     */
17324
17325    /**
17326     * @defgroup Progressbar Progress bar
17327     *
17328     * The progress bar is a widget for visually representing the
17329     * progress status of a given job/task.
17330     *
17331     * A progress bar may be horizontal or vertical. It may display an
17332     * icon besides it, as well as primary and @b units labels. The
17333     * former is meant to label the widget as a whole, while the
17334     * latter, which is formatted with floating point values (and thus
17335     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
17336     * units"</c>), is meant to label the widget's <b>progress
17337     * value</b>. Label, icon and unit strings/objects are @b optional
17338     * for progress bars.
17339     *
17340     * A progress bar may be @b inverted, in which state it gets its
17341     * values inverted, with high values being on the left or top and
17342     * low values on the right or bottom, as opposed to normally have
17343     * the low values on the former and high values on the latter,
17344     * respectively, for horizontal and vertical modes.
17345     *
17346     * The @b span of the progress, as set by
17347     * elm_progressbar_span_size_set(), is its length (horizontally or
17348     * vertically), unless one puts size hints on the widget to expand
17349     * on desired directions, by any container. That length will be
17350     * scaled by the object or applications scaling factor. At any
17351     * point code can query the progress bar for its value with
17352     * elm_progressbar_value_get().
17353     *
17354     * Available widget styles for progress bars:
17355     * - @c "default"
17356     * - @c "wheel" (simple style, no text, no progression, only
17357     *      "pulse" effect is available)
17358     *
17359     * Here is an example on its usage:
17360     * @li @ref progressbar_example
17361     */
17362
17363    /**
17364     * Add a new progress bar widget to the given parent Elementary
17365     * (container) object
17366     *
17367     * @param parent The parent object
17368     * @return a new progress bar widget handle or @c NULL, on errors
17369     *
17370     * This function inserts a new progress bar widget on the canvas.
17371     *
17372     * @ingroup Progressbar
17373     */
17374    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17375
17376    /**
17377     * Set whether a given progress bar widget is at "pulsing mode" or
17378     * not.
17379     *
17380     * @param obj The progress bar object
17381     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17382     * @c EINA_FALSE to put it back to its default one
17383     *
17384     * By default, progress bars will display values from the low to
17385     * high value boundaries. There are, though, contexts in which the
17386     * state of progression of a given task is @b unknown.  For those,
17387     * one can set a progress bar widget to a "pulsing state", to give
17388     * the user an idea that some computation is being held, but
17389     * without exact progress values. In the default theme it will
17390     * animate its bar with the contents filling in constantly and back
17391     * to non-filled, in a loop. To start and stop this pulsing
17392     * animation, one has to explicitly call elm_progressbar_pulse().
17393     *
17394     * @see elm_progressbar_pulse_get()
17395     * @see elm_progressbar_pulse()
17396     *
17397     * @ingroup Progressbar
17398     */
17399    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17400
17401    /**
17402     * Get whether a given progress bar widget is at "pulsing mode" or
17403     * not.
17404     *
17405     * @param obj The progress bar object
17406     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17407     * if it's in the default one (and on errors)
17408     *
17409     * @ingroup Progressbar
17410     */
17411    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17412
17413    /**
17414     * Start/stop a given progress bar "pulsing" animation, if its
17415     * under that mode
17416     *
17417     * @param obj The progress bar object
17418     * @param state @c EINA_TRUE, to @b start the pulsing animation,
17419     * @c EINA_FALSE to @b stop it
17420     *
17421     * @note This call won't do anything if @p obj is not under "pulsing mode".
17422     *
17423     * @see elm_progressbar_pulse_set() for more details.
17424     *
17425     * @ingroup Progressbar
17426     */
17427    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17428
17429    /**
17430     * Set the progress value (in percentage) on a given progress bar
17431     * widget
17432     *
17433     * @param obj The progress bar object
17434     * @param val The progress value (@b must be between @c 0.0 and @c
17435     * 1.0)
17436     *
17437     * Use this call to set progress bar levels.
17438     *
17439     * @note If you passes a value out of the specified range for @p
17440     * val, it will be interpreted as the @b closest of the @b boundary
17441     * values in the range.
17442     *
17443     * @ingroup Progressbar
17444     */
17445    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17446
17447    /**
17448     * Get the progress value (in percentage) on a given progress bar
17449     * widget
17450     *
17451     * @param obj The progress bar object
17452     * @return The value of the progressbar
17453     *
17454     * @see elm_progressbar_value_set() for more details
17455     *
17456     * @ingroup Progressbar
17457     */
17458    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17459
17460    /**
17461     * Set the label of a given progress bar widget
17462     *
17463     * @param obj The progress bar object
17464     * @param label The text label string, in UTF-8
17465     *
17466     * @ingroup Progressbar
17467     * @deprecated use elm_object_text_set() instead.
17468     */
17469    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17470
17471    /**
17472     * Get the label of a given progress bar widget
17473     *
17474     * @param obj The progressbar object
17475     * @return The text label string, in UTF-8
17476     *
17477     * @ingroup Progressbar
17478     * @deprecated use elm_object_text_set() instead.
17479     */
17480    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17481
17482    /**
17483     * Set the icon object of a given progress bar widget
17484     *
17485     * @param obj The progress bar object
17486     * @param icon The icon object
17487     *
17488     * Use this call to decorate @p obj with an icon next to it.
17489     *
17490     * @note Once the icon object is set, a previously set one will be
17491     * deleted. If you want to keep that old content object, use the
17492     * elm_progressbar_icon_unset() function.
17493     *
17494     * @see elm_progressbar_icon_get()
17495     *
17496     * @ingroup Progressbar
17497     */
17498    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17499
17500    /**
17501     * Retrieve the icon object set for a given progress bar widget
17502     *
17503     * @param obj The progress bar object
17504     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17505     * otherwise (and on errors)
17506     *
17507     * @see elm_progressbar_icon_set() for more details
17508     *
17509     * @ingroup Progressbar
17510     */
17511    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17512
17513    /**
17514     * Unset an icon set on a given progress bar widget
17515     *
17516     * @param obj The progress bar object
17517     * @return The icon object that was being used, if any was set, or
17518     * @c NULL, otherwise (and on errors)
17519     *
17520     * This call will unparent and return the icon object which was set
17521     * for this widget, previously, on success.
17522     *
17523     * @see elm_progressbar_icon_set() for more details
17524     *
17525     * @ingroup Progressbar
17526     */
17527    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17528
17529    /**
17530     * Set the (exact) length of the bar region of a given progress bar
17531     * widget
17532     *
17533     * @param obj The progress bar object
17534     * @param size The length of the progress bar's bar region
17535     *
17536     * This sets the minimum width (when in horizontal mode) or height
17537     * (when in vertical mode) of the actual bar area of the progress
17538     * bar @p obj. This in turn affects the object's minimum size. Use
17539     * this when you're not setting other size hints expanding on the
17540     * given direction (like weight and alignment hints) and you would
17541     * like it to have a specific size.
17542     *
17543     * @note Icon, label and unit text around @p obj will require their
17544     * own space, which will make @p obj to require more the @p size,
17545     * actually.
17546     *
17547     * @see elm_progressbar_span_size_get()
17548     *
17549     * @ingroup Progressbar
17550     */
17551    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17552
17553    /**
17554     * Get the length set for the bar region of a given progress bar
17555     * widget
17556     *
17557     * @param obj The progress bar object
17558     * @return The length of the progress bar's bar region
17559     *
17560     * If that size was not set previously, with
17561     * elm_progressbar_span_size_set(), this call will return @c 0.
17562     *
17563     * @ingroup Progressbar
17564     */
17565    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17566
17567    /**
17568     * Set the format string for a given progress bar widget's units
17569     * label
17570     *
17571     * @param obj The progress bar object
17572     * @param format The format string for @p obj's units label
17573     *
17574     * If @c NULL is passed on @p format, it will make @p obj's units
17575     * area to be hidden completely. If not, it'll set the <b>format
17576     * string</b> for the units label's @b text. The units label is
17577     * provided a floating point value, so the units text is up display
17578     * at most one floating point falue. Note that the units label is
17579     * optional. Use a format string such as "%1.2f meters" for
17580     * example.
17581     *
17582     * @note The default format string for a progress bar is an integer
17583     * percentage, as in @c "%.0f %%".
17584     *
17585     * @see elm_progressbar_unit_format_get()
17586     *
17587     * @ingroup Progressbar
17588     */
17589    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17590
17591    /**
17592     * Retrieve the format string set for a given progress bar widget's
17593     * units label
17594     *
17595     * @param obj The progress bar object
17596     * @return The format set string for @p obj's units label or
17597     * @c NULL, if none was set (and on errors)
17598     *
17599     * @see elm_progressbar_unit_format_set() for more details
17600     *
17601     * @ingroup Progressbar
17602     */
17603    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17604
17605    /**
17606     * Set the orientation of a given progress bar widget
17607     *
17608     * @param obj The progress bar object
17609     * @param horizontal Use @c EINA_TRUE to make @p obj to be
17610     * @b horizontal, @c EINA_FALSE to make it @b vertical
17611     *
17612     * Use this function to change how your progress bar is to be
17613     * disposed: vertically or horizontally.
17614     *
17615     * @see elm_progressbar_horizontal_get()
17616     *
17617     * @ingroup Progressbar
17618     */
17619    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17620
17621    /**
17622     * Retrieve the orientation of a given progress bar widget
17623     *
17624     * @param obj The progress bar object
17625     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17626     * @c EINA_FALSE if it's @b vertical (and on errors)
17627     *
17628     * @see elm_progressbar_horizontal_set() for more details
17629     *
17630     * @ingroup Progressbar
17631     */
17632    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17633
17634    /**
17635     * Invert a given progress bar widget's displaying values order
17636     *
17637     * @param obj The progress bar object
17638     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17639     * @c EINA_FALSE to bring it back to default, non-inverted values.
17640     *
17641     * A progress bar may be @b inverted, in which state it gets its
17642     * values inverted, with high values being on the left or top and
17643     * low values on the right or bottom, as opposed to normally have
17644     * the low values on the former and high values on the latter,
17645     * respectively, for horizontal and vertical modes.
17646     *
17647     * @see elm_progressbar_inverted_get()
17648     *
17649     * @ingroup Progressbar
17650     */
17651    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17652
17653    /**
17654     * Get whether a given progress bar widget's displaying values are
17655     * inverted or not
17656     *
17657     * @param obj The progress bar object
17658     * @return @c EINA_TRUE, if @p obj has inverted values,
17659     * @c EINA_FALSE otherwise (and on errors)
17660     *
17661     * @see elm_progressbar_inverted_set() for more details
17662     *
17663     * @ingroup Progressbar
17664     */
17665    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17666
17667    /**
17668     * @defgroup Separator Separator
17669     *
17670     * @brief Separator is a very thin object used to separate other objects.
17671     *
17672     * A separator can be vertical or horizontal.
17673     *
17674     * @ref tutorial_separator is a good example of how to use a separator.
17675     * @{
17676     */
17677    /**
17678     * @brief Add a separator object to @p parent
17679     *
17680     * @param parent The parent object
17681     *
17682     * @return The separator object, or NULL upon failure
17683     */
17684    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17685    /**
17686     * @brief Set the horizontal mode of a separator object
17687     *
17688     * @param obj The separator object
17689     * @param horizontal If true, the separator is horizontal
17690     */
17691    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17692    /**
17693     * @brief Get the horizontal mode of a separator object
17694     *
17695     * @param obj The separator object
17696     * @return If true, the separator is horizontal
17697     *
17698     * @see elm_separator_horizontal_set()
17699     */
17700    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17701    /**
17702     * @}
17703     */
17704
17705    /**
17706     * @defgroup Spinner Spinner
17707     * @ingroup Elementary
17708     *
17709     * @image html img/widget/spinner/preview-00.png
17710     * @image latex img/widget/spinner/preview-00.eps
17711     *
17712     * A spinner is a widget which allows the user to increase or decrease
17713     * numeric values using arrow buttons, or edit values directly, clicking
17714     * over it and typing the new value.
17715     *
17716     * By default the spinner will not wrap and has a label
17717     * of "%.0f" (just showing the integer value of the double).
17718     *
17719     * A spinner has a label that is formatted with floating
17720     * point values and thus accepts a printf-style format string, like
17721     * “%1.2f units”.
17722     *
17723     * It also allows specific values to be replaced by pre-defined labels.
17724     *
17725     * Smart callbacks one can register to:
17726     *
17727     * - "changed" - Whenever the spinner value is changed.
17728     * - "delay,changed" - A short time after the value is changed by the user.
17729     *    This will be called only when the user stops dragging for a very short
17730     *    period or when they release their finger/mouse, so it avoids possibly
17731     *    expensive reactions to the value change.
17732     *
17733     * Available styles for it:
17734     * - @c "default";
17735     * - @c "vertical": up/down buttons at the right side and text left aligned.
17736     *
17737     * Here is an example on its usage:
17738     * @ref spinner_example
17739     */
17740
17741    /**
17742     * @addtogroup Spinner
17743     * @{
17744     */
17745
17746    /**
17747     * Add a new spinner widget to the given parent Elementary
17748     * (container) object.
17749     *
17750     * @param parent The parent object.
17751     * @return a new spinner widget handle or @c NULL, on errors.
17752     *
17753     * This function inserts a new spinner widget on the canvas.
17754     *
17755     * @ingroup Spinner
17756     *
17757     */
17758    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17759
17760    /**
17761     * Set the format string of the displayed label.
17762     *
17763     * @param obj The spinner object.
17764     * @param fmt The format string for the label display.
17765     *
17766     * If @c NULL, this sets the format to "%.0f". If not it sets the format
17767     * string for the label text. The label text is provided a floating point
17768     * value, so the label text can display up to 1 floating point value.
17769     * Note that this is optional.
17770     *
17771     * Use a format string such as "%1.2f meters" for example, and it will
17772     * display values like: "3.14 meters" for a value equal to 3.14159.
17773     *
17774     * Default is "%0.f".
17775     *
17776     * @see elm_spinner_label_format_get()
17777     *
17778     * @ingroup Spinner
17779     */
17780    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17781
17782    /**
17783     * Get the label format of the spinner.
17784     *
17785     * @param obj The spinner object.
17786     * @return The text label format string in UTF-8.
17787     *
17788     * @see elm_spinner_label_format_set() for details.
17789     *
17790     * @ingroup Spinner
17791     */
17792    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17793
17794    /**
17795     * Set the minimum and maximum values for the spinner.
17796     *
17797     * @param obj The spinner object.
17798     * @param min The minimum value.
17799     * @param max The maximum value.
17800     *
17801     * Define the allowed range of values to be selected by the user.
17802     *
17803     * If actual value is less than @p min, it will be updated to @p min. If it
17804     * is bigger then @p max, will be updated to @p max. Actual value can be
17805     * get with elm_spinner_value_get().
17806     *
17807     * By default, min is equal to 0, and max is equal to 100.
17808     *
17809     * @warning Maximum must be greater than minimum.
17810     *
17811     * @see elm_spinner_min_max_get()
17812     *
17813     * @ingroup Spinner
17814     */
17815    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17816
17817    /**
17818     * Get the minimum and maximum values of the spinner.
17819     *
17820     * @param obj The spinner object.
17821     * @param min Pointer where to store the minimum value.
17822     * @param max Pointer where to store the maximum value.
17823     *
17824     * @note If only one value is needed, the other pointer can be passed
17825     * as @c NULL.
17826     *
17827     * @see elm_spinner_min_max_set() for details.
17828     *
17829     * @ingroup Spinner
17830     */
17831    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17832
17833    /**
17834     * Set the step used to increment or decrement the spinner value.
17835     *
17836     * @param obj The spinner object.
17837     * @param step The step value.
17838     *
17839     * This value will be incremented or decremented to the displayed value.
17840     * It will be incremented while the user keep right or top arrow pressed,
17841     * and will be decremented while the user keep left or bottom arrow pressed.
17842     *
17843     * The interval to increment / decrement can be set with
17844     * elm_spinner_interval_set().
17845     *
17846     * By default step value is equal to 1.
17847     *
17848     * @see elm_spinner_step_get()
17849     *
17850     * @ingroup Spinner
17851     */
17852    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17853
17854    /**
17855     * Get the step used to increment or decrement the spinner value.
17856     *
17857     * @param obj The spinner object.
17858     * @return The step value.
17859     *
17860     * @see elm_spinner_step_get() for more details.
17861     *
17862     * @ingroup Spinner
17863     */
17864    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17865
17866    /**
17867     * Set the value the spinner displays.
17868     *
17869     * @param obj The spinner object.
17870     * @param val The value to be displayed.
17871     *
17872     * Value will be presented on the label following format specified with
17873     * elm_spinner_format_set().
17874     *
17875     * @warning The value must to be between min and max values. This values
17876     * are set by elm_spinner_min_max_set().
17877     *
17878     * @see elm_spinner_value_get().
17879     * @see elm_spinner_format_set().
17880     * @see elm_spinner_min_max_set().
17881     *
17882     * @ingroup Spinner
17883     */
17884    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17885
17886    /**
17887     * Get the value displayed by the spinner.
17888     *
17889     * @param obj The spinner object.
17890     * @return The value displayed.
17891     *
17892     * @see elm_spinner_value_set() for details.
17893     *
17894     * @ingroup Spinner
17895     */
17896    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17897
17898    /**
17899     * Set whether the spinner should wrap when it reaches its
17900     * minimum or maximum value.
17901     *
17902     * @param obj The spinner object.
17903     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17904     * disable it.
17905     *
17906     * Disabled by default. If disabled, when the user tries to increment the
17907     * value,
17908     * but displayed value plus step value is bigger than maximum value,
17909     * the spinner
17910     * won't allow it. The same happens when the user tries to decrement it,
17911     * but the value less step is less than minimum value.
17912     *
17913     * When wrap is enabled, in such situations it will allow these changes,
17914     * but will get the value that would be less than minimum and subtracts
17915     * from maximum. Or add the value that would be more than maximum to
17916     * the minimum.
17917     *
17918     * E.g.:
17919     * @li min value = 10
17920     * @li max value = 50
17921     * @li step value = 20
17922     * @li displayed value = 20
17923     *
17924     * When the user decrement value (using left or bottom arrow), it will
17925     * displays @c 40, because max - (min - (displayed - step)) is
17926     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17927     *
17928     * @see elm_spinner_wrap_get().
17929     *
17930     * @ingroup Spinner
17931     */
17932    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17933
17934    /**
17935     * Get whether the spinner should wrap when it reaches its
17936     * minimum or maximum value.
17937     *
17938     * @param obj The spinner object
17939     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17940     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17941     *
17942     * @see elm_spinner_wrap_set() for details.
17943     *
17944     * @ingroup Spinner
17945     */
17946    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17947
17948    /**
17949     * Set whether the spinner can be directly edited by the user or not.
17950     *
17951     * @param obj The spinner object.
17952     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17953     * don't allow users to edit it directly.
17954     *
17955     * Spinner objects can have edition @b disabled, in which state they will
17956     * be changed only by arrows.
17957     * Useful for contexts
17958     * where you don't want your users to interact with it writting the value.
17959     * Specially
17960     * when using special values, the user can see real value instead
17961     * of special label on edition.
17962     *
17963     * It's enabled by default.
17964     *
17965     * @see elm_spinner_editable_get()
17966     *
17967     * @ingroup Spinner
17968     */
17969    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17970
17971    /**
17972     * Get whether the spinner can be directly edited by the user or not.
17973     *
17974     * @param obj The spinner object.
17975     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17976     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17977     *
17978     * @see elm_spinner_editable_set() for details.
17979     *
17980     * @ingroup Spinner
17981     */
17982    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17983
17984    /**
17985     * Set a special string to display in the place of the numerical value.
17986     *
17987     * @param obj The spinner object.
17988     * @param value The value to be replaced.
17989     * @param label The label to be used.
17990     *
17991     * It's useful for cases when a user should select an item that is
17992     * better indicated by a label than a value. For example, weekdays or months.
17993     *
17994     * E.g.:
17995     * @code
17996     * sp = elm_spinner_add(win);
17997     * elm_spinner_min_max_set(sp, 1, 3);
17998     * elm_spinner_special_value_add(sp, 1, "January");
17999     * elm_spinner_special_value_add(sp, 2, "February");
18000     * elm_spinner_special_value_add(sp, 3, "March");
18001     * evas_object_show(sp);
18002     * @endcode
18003     *
18004     * @ingroup Spinner
18005     */
18006    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
18007
18008    /**
18009     * Set the interval on time updates for an user mouse button hold
18010     * on spinner widgets' arrows.
18011     *
18012     * @param obj The spinner object.
18013     * @param interval The (first) interval value in seconds.
18014     *
18015     * This interval value is @b decreased while the user holds the
18016     * mouse pointer either incrementing or decrementing spinner's value.
18017     *
18018     * This helps the user to get to a given value distant from the
18019     * current one easier/faster, as it will start to change quicker and
18020     * quicker on mouse button holds.
18021     *
18022     * The calculation for the next change interval value, starting from
18023     * the one set with this call, is the previous interval divided by
18024     * @c 1.05, so it decreases a little bit.
18025     *
18026     * The default starting interval value for automatic changes is
18027     * @c 0.85 seconds.
18028     *
18029     * @see elm_spinner_interval_get()
18030     *
18031     * @ingroup Spinner
18032     */
18033    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
18034
18035    /**
18036     * Get the interval on time updates for an user mouse button hold
18037     * on spinner widgets' arrows.
18038     *
18039     * @param obj The spinner object.
18040     * @return The (first) interval value, in seconds, set on it.
18041     *
18042     * @see elm_spinner_interval_set() for more details.
18043     *
18044     * @ingroup Spinner
18045     */
18046    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18047
18048    /**
18049     * @}
18050     */
18051
18052    /**
18053     * @defgroup Index Index
18054     *
18055     * @image html img/widget/index/preview-00.png
18056     * @image latex img/widget/index/preview-00.eps
18057     *
18058     * An index widget gives you an index for fast access to whichever
18059     * group of other UI items one might have. It's a list of text
18060     * items (usually letters, for alphabetically ordered access).
18061     *
18062     * Index widgets are by default hidden and just appear when the
18063     * user clicks over it's reserved area in the canvas. In its
18064     * default theme, it's an area one @ref Fingers "finger" wide on
18065     * the right side of the index widget's container.
18066     *
18067     * When items on the index are selected, smart callbacks get
18068     * called, so that its user can make other container objects to
18069     * show a given area or child object depending on the index item
18070     * selected. You'd probably be using an index together with @ref
18071     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
18072     * "general grids".
18073     *
18074     * Smart events one  can add callbacks for are:
18075     * - @c "changed" - When the selected index item changes. @c
18076     *      event_info is the selected item's data pointer.
18077     * - @c "delay,changed" - When the selected index item changes, but
18078     *      after a small idling period. @c event_info is the selected
18079     *      item's data pointer.
18080     * - @c "selected" - When the user releases a mouse button and
18081     *      selects an item. @c event_info is the selected item's data
18082     *      pointer.
18083     * - @c "level,up" - when the user moves a finger from the first
18084     *      level to the second level
18085     * - @c "level,down" - when the user moves a finger from the second
18086     *      level to the first level
18087     *
18088     * The @c "delay,changed" event is so that it'll wait a small time
18089     * before actually reporting those events and, moreover, just the
18090     * last event happening on those time frames will actually be
18091     * reported.
18092     *
18093     * Here are some examples on its usage:
18094     * @li @ref index_example_01
18095     * @li @ref index_example_02
18096     */
18097
18098    /**
18099     * @addtogroup Index
18100     * @{
18101     */
18102
18103    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
18104
18105    /**
18106     * Add a new index widget to the given parent Elementary
18107     * (container) object
18108     *
18109     * @param parent The parent object
18110     * @return a new index widget handle or @c NULL, on errors
18111     *
18112     * This function inserts a new index widget on the canvas.
18113     *
18114     * @ingroup Index
18115     */
18116    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18117
18118    /**
18119     * Set whether a given index widget is or not visible,
18120     * programatically.
18121     *
18122     * @param obj The index object
18123     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
18124     *
18125     * Not to be confused with visible as in @c evas_object_show() --
18126     * visible with regard to the widget's auto hiding feature.
18127     *
18128     * @see elm_index_active_get()
18129     *
18130     * @ingroup Index
18131     */
18132    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
18133
18134    /**
18135     * Get whether a given index widget is currently visible or not.
18136     *
18137     * @param obj The index object
18138     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
18139     *
18140     * @see elm_index_active_set() for more details
18141     *
18142     * @ingroup Index
18143     */
18144    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18145
18146    /**
18147     * Set the items level for a given index widget.
18148     *
18149     * @param obj The index object.
18150     * @param level @c 0 or @c 1, the currently implemented levels.
18151     *
18152     * @see elm_index_item_level_get()
18153     *
18154     * @ingroup Index
18155     */
18156    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18157
18158    /**
18159     * Get the items level set for a given index widget.
18160     *
18161     * @param obj The index object.
18162     * @return @c 0 or @c 1, which are the levels @p obj might be at.
18163     *
18164     * @see elm_index_item_level_set() for more information
18165     *
18166     * @ingroup Index
18167     */
18168    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18169
18170    /**
18171     * Returns the last selected item's data, for a given index widget.
18172     *
18173     * @param obj The index object.
18174     * @return The item @b data associated to the last selected item on
18175     * @p obj (or @c NULL, on errors).
18176     *
18177     * @warning The returned value is @b not an #Elm_Index_Item item
18178     * handle, but the data associated to it (see the @c item parameter
18179     * in elm_index_item_append(), as an example).
18180     *
18181     * @ingroup Index
18182     */
18183    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18184
18185    /**
18186     * Append a new item on a given index widget.
18187     *
18188     * @param obj The index object.
18189     * @param letter Letter under which the item should be indexed
18190     * @param item The item data to set for the index's item
18191     *
18192     * Despite the most common usage of the @p letter argument is for
18193     * single char strings, one could use arbitrary strings as index
18194     * entries.
18195     *
18196     * @c item will be the pointer returned back on @c "changed", @c
18197     * "delay,changed" and @c "selected" smart events.
18198     *
18199     * @ingroup Index
18200     */
18201    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18202
18203    /**
18204     * Prepend a new item on a given index widget.
18205     *
18206     * @param obj The index object.
18207     * @param letter Letter under which the item should be indexed
18208     * @param item The item data to set for the index's item
18209     *
18210     * Despite the most common usage of the @p letter argument is for
18211     * single char strings, one could use arbitrary strings as index
18212     * entries.
18213     *
18214     * @c item will be the pointer returned back on @c "changed", @c
18215     * "delay,changed" and @c "selected" smart events.
18216     *
18217     * @ingroup Index
18218     */
18219    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18220
18221    /**
18222     * Append a new item, on a given index widget, <b>after the item
18223     * having @p relative as data</b>.
18224     *
18225     * @param obj The index object.
18226     * @param letter Letter under which the item should be indexed
18227     * @param item The item data to set for the index's item
18228     * @param relative The item data of the index item to be the
18229     * predecessor of this new one
18230     *
18231     * Despite the most common usage of the @p letter argument is for
18232     * single char strings, one could use arbitrary strings as index
18233     * entries.
18234     *
18235     * @c item will be the pointer returned back on @c "changed", @c
18236     * "delay,changed" and @c "selected" smart events.
18237     *
18238     * @note If @p relative is @c NULL or if it's not found to be data
18239     * set on any previous item on @p obj, this function will behave as
18240     * elm_index_item_append().
18241     *
18242     * @ingroup Index
18243     */
18244    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18245
18246    /**
18247     * Prepend a new item, on a given index widget, <b>after the item
18248     * having @p relative as data</b>.
18249     *
18250     * @param obj The index object.
18251     * @param letter Letter under which the item should be indexed
18252     * @param item The item data to set for the index's item
18253     * @param relative The item data of the index item to be the
18254     * successor of this new one
18255     *
18256     * Despite the most common usage of the @p letter argument is for
18257     * single char strings, one could use arbitrary strings as index
18258     * entries.
18259     *
18260     * @c item will be the pointer returned back on @c "changed", @c
18261     * "delay,changed" and @c "selected" smart events.
18262     *
18263     * @note If @p relative is @c NULL or if it's not found to be data
18264     * set on any previous item on @p obj, this function will behave as
18265     * elm_index_item_prepend().
18266     *
18267     * @ingroup Index
18268     */
18269    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18270
18271    /**
18272     * Insert a new item into the given index widget, using @p cmp_func
18273     * function to sort items (by item handles).
18274     *
18275     * @param obj The index object.
18276     * @param letter Letter under which the item should be indexed
18277     * @param item The item data to set for the index's item
18278     * @param cmp_func The comparing function to be used to sort index
18279     * items <b>by #Elm_Index_Item item handles</b>
18280     * @param cmp_data_func A @b fallback function to be called for the
18281     * sorting of index items <b>by item data</b>). It will be used
18282     * when @p cmp_func returns @c 0 (equality), which means an index
18283     * item with provided item data already exists. To decide which
18284     * data item should be pointed to by the index item in question, @p
18285     * cmp_data_func will be used. If @p cmp_data_func returns a
18286     * non-negative value, the previous index item data will be
18287     * replaced by the given @p item pointer. If the previous data need
18288     * to be freed, it should be done by the @p cmp_data_func function,
18289     * because all references to it will be lost. If this function is
18290     * not provided (@c NULL is given), index items will be @b
18291     * duplicated, if @p cmp_func returns @c 0.
18292     *
18293     * Despite the most common usage of the @p letter argument is for
18294     * single char strings, one could use arbitrary strings as index
18295     * entries.
18296     *
18297     * @c item will be the pointer returned back on @c "changed", @c
18298     * "delay,changed" and @c "selected" smart events.
18299     *
18300     * @ingroup Index
18301     */
18302    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);
18303
18304    /**
18305     * Remove an item from a given index widget, <b>to be referenced by
18306     * it's data value</b>.
18307     *
18308     * @param obj The index object
18309     * @param item The item's data pointer for the item to be removed
18310     * from @p obj
18311     *
18312     * If a deletion callback is set, via elm_index_item_del_cb_set(),
18313     * that callback function will be called by this one.
18314     *
18315     * @warning The item to be removed from @p obj will be found via
18316     * its item data pointer, and not by an #Elm_Index_Item handle.
18317     *
18318     * @ingroup Index
18319     */
18320    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18321
18322    /**
18323     * Find a given index widget's item, <b>using item data</b>.
18324     *
18325     * @param obj The index object
18326     * @param item The item data pointed to by the desired index item
18327     * @return The index item handle, if found, or @c NULL otherwise
18328     *
18329     * @ingroup Index
18330     */
18331    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18332
18333    /**
18334     * Removes @b all items from a given index widget.
18335     *
18336     * @param obj The index object.
18337     *
18338     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
18339     * that callback function will be called for each item in @p obj.
18340     *
18341     * @ingroup Index
18342     */
18343    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18344
18345    /**
18346     * Go to a given items level on a index widget
18347     *
18348     * @param obj The index object
18349     * @param level The index level (one of @c 0 or @c 1)
18350     *
18351     * @ingroup Index
18352     */
18353    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18354
18355    /**
18356     * Return the data associated with a given index widget item
18357     *
18358     * @param it The index widget item handle
18359     * @return The data associated with @p it
18360     *
18361     * @see elm_index_item_data_set()
18362     *
18363     * @ingroup Index
18364     */
18365    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18366
18367    /**
18368     * Set the data associated with a given index widget item
18369     *
18370     * @param it The index widget item handle
18371     * @param data The new data pointer to set to @p it
18372     *
18373     * This sets new item data on @p it.
18374     *
18375     * @warning The old data pointer won't be touched by this function, so
18376     * the user had better to free that old data himself/herself.
18377     *
18378     * @ingroup Index
18379     */
18380    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18381
18382    /**
18383     * Set the function to be called when a given index widget item is freed.
18384     *
18385     * @param it The item to set the callback on
18386     * @param func The function to call on the item's deletion
18387     *
18388     * When called, @p func will have both @c data and @c event_info
18389     * arguments with the @p it item's data value and, naturally, the
18390     * @c obj argument with a handle to the parent index widget.
18391     *
18392     * @ingroup Index
18393     */
18394    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18395
18396    /**
18397     * Get the letter (string) set on a given index widget item.
18398     *
18399     * @param it The index item handle
18400     * @return The letter string set on @p it
18401     *
18402     * @ingroup Index
18403     */
18404    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18405
18406    /**
18407     * @}
18408     */
18409
18410    /**
18411     * @defgroup Photocam Photocam
18412     *
18413     * @image html img/widget/photocam/preview-00.png
18414     * @image latex img/widget/photocam/preview-00.eps
18415     *
18416     * This is a widget specifically for displaying high-resolution digital
18417     * camera photos giving speedy feedback (fast load), low memory footprint
18418     * and zooming and panning as well as fitting logic. It is entirely focused
18419     * on jpeg images, and takes advantage of properties of the jpeg format (via
18420     * evas loader features in the jpeg loader).
18421     *
18422     * Signals that you can add callbacks for are:
18423     * @li "clicked" - This is called when a user has clicked the photo without
18424     *                 dragging around.
18425     * @li "press" - This is called when a user has pressed down on the photo.
18426     * @li "longpressed" - This is called when a user has pressed down on the
18427     *                     photo for a long time without dragging around.
18428     * @li "clicked,double" - This is called when a user has double-clicked the
18429     *                        photo.
18430     * @li "load" - Photo load begins.
18431     * @li "loaded" - This is called when the image file load is complete for the
18432     *                first view (low resolution blurry version).
18433     * @li "load,detail" - Photo detailed data load begins.
18434     * @li "loaded,detail" - This is called when the image file load is complete
18435     *                      for the detailed image data (full resolution needed).
18436     * @li "zoom,start" - Zoom animation started.
18437     * @li "zoom,stop" - Zoom animation stopped.
18438     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18439     * @li "scroll" - the content has been scrolled (moved)
18440     * @li "scroll,anim,start" - scrolling animation has started
18441     * @li "scroll,anim,stop" - scrolling animation has stopped
18442     * @li "scroll,drag,start" - dragging the contents around has started
18443     * @li "scroll,drag,stop" - dragging the contents around has stopped
18444     *
18445     * @ref tutorial_photocam shows the API in action.
18446     * @{
18447     */
18448    /**
18449     * @brief Types of zoom available.
18450     */
18451    typedef enum _Elm_Photocam_Zoom_Mode
18452      {
18453         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18454         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18455         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18456         ELM_PHOTOCAM_ZOOM_MODE_LAST
18457      } Elm_Photocam_Zoom_Mode;
18458    /**
18459     * @brief Add a new Photocam object
18460     *
18461     * @param parent The parent object
18462     * @return The new object or NULL if it cannot be created
18463     */
18464    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18465    /**
18466     * @brief Set the photo file to be shown
18467     *
18468     * @param obj The photocam object
18469     * @param file The photo file
18470     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18471     *
18472     * This sets (and shows) the specified file (with a relative or absolute
18473     * path) and will return a load error (same error that
18474     * evas_object_image_load_error_get() will return). The image will change and
18475     * adjust its size at this point and begin a background load process for this
18476     * photo that at some time in the future will be displayed at the full
18477     * quality needed.
18478     */
18479    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18480    /**
18481     * @brief Returns the path of the current image file
18482     *
18483     * @param obj The photocam object
18484     * @return Returns the path
18485     *
18486     * @see elm_photocam_file_set()
18487     */
18488    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18489    /**
18490     * @brief Set the zoom level of the photo
18491     *
18492     * @param obj The photocam object
18493     * @param zoom The zoom level to set
18494     *
18495     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18496     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18497     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18498     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18499     * 16, 32, etc.).
18500     */
18501    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18502    /**
18503     * @brief Get the zoom level of the photo
18504     *
18505     * @param obj The photocam object
18506     * @return The current zoom level
18507     *
18508     * This returns the current zoom level of the photocam object. Note that if
18509     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18510     * (which is the default), the zoom level may be changed at any time by the
18511     * photocam object itself to account for photo size and photocam viewpoer
18512     * size.
18513     *
18514     * @see elm_photocam_zoom_set()
18515     * @see elm_photocam_zoom_mode_set()
18516     */
18517    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18518    /**
18519     * @brief Set the zoom mode
18520     *
18521     * @param obj The photocam object
18522     * @param mode The desired mode
18523     *
18524     * This sets the zoom mode to manual or one of several automatic levels.
18525     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18526     * elm_photocam_zoom_set() and will stay at that level until changed by code
18527     * or until zoom mode is changed. This is the default mode. The Automatic
18528     * modes will allow the photocam object to automatically adjust zoom mode
18529     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18530     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18531     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18532     * pixels within the frame are left unfilled.
18533     */
18534    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18535    /**
18536     * @brief Get the zoom mode
18537     *
18538     * @param obj The photocam object
18539     * @return The current zoom mode
18540     *
18541     * This gets the current zoom mode of the photocam object.
18542     *
18543     * @see elm_photocam_zoom_mode_set()
18544     */
18545    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18546    /**
18547     * @brief Get the current image pixel width and height
18548     *
18549     * @param obj The photocam object
18550     * @param w A pointer to the width return
18551     * @param h A pointer to the height return
18552     *
18553     * This gets the current photo pixel width and height (for the original).
18554     * The size will be returned in the integers @p w and @p h that are pointed
18555     * to.
18556     */
18557    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18558    /**
18559     * @brief Get the area of the image that is currently shown
18560     *
18561     * @param obj
18562     * @param x A pointer to the X-coordinate of region
18563     * @param y A pointer to the Y-coordinate of region
18564     * @param w A pointer to the width
18565     * @param h A pointer to the height
18566     *
18567     * @see elm_photocam_image_region_show()
18568     * @see elm_photocam_image_region_bring_in()
18569     */
18570    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18571    /**
18572     * @brief Set the viewed portion of the image
18573     *
18574     * @param obj The photocam object
18575     * @param x X-coordinate of region in image original pixels
18576     * @param y Y-coordinate of region in image original pixels
18577     * @param w Width of region in image original pixels
18578     * @param h Height of region in image original pixels
18579     *
18580     * This shows the region of the image without using animation.
18581     */
18582    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18583    /**
18584     * @brief Bring in the viewed portion of the image
18585     *
18586     * @param obj The photocam object
18587     * @param x X-coordinate of region in image original pixels
18588     * @param y Y-coordinate of region in image original pixels
18589     * @param w Width of region in image original pixels
18590     * @param h Height of region in image original pixels
18591     *
18592     * This shows the region of the image using animation.
18593     */
18594    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18595    /**
18596     * @brief Set the paused state for photocam
18597     *
18598     * @param obj The photocam object
18599     * @param paused The pause state to set
18600     *
18601     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18602     * photocam. The default is off. This will stop zooming using animation on
18603     * zoom levels changes and change instantly. This will stop any existing
18604     * animations that are running.
18605     */
18606    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18607    /**
18608     * @brief Get the paused state for photocam
18609     *
18610     * @param obj The photocam object
18611     * @return The current paused state
18612     *
18613     * This gets the current paused state for the photocam object.
18614     *
18615     * @see elm_photocam_paused_set()
18616     */
18617    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18618    /**
18619     * @brief Get the internal low-res image used for photocam
18620     *
18621     * @param obj The photocam object
18622     * @return The internal image object handle, or NULL if none exists
18623     *
18624     * This gets the internal image object inside photocam. Do not modify it. It
18625     * is for inspection only, and hooking callbacks to. Nothing else. It may be
18626     * deleted at any time as well.
18627     */
18628    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18629    /**
18630     * @brief Set the photocam scrolling bouncing.
18631     *
18632     * @param obj The photocam object
18633     * @param h_bounce bouncing for horizontal
18634     * @param v_bounce bouncing for vertical
18635     */
18636    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18637    /**
18638     * @brief Get the photocam scrolling bouncing.
18639     *
18640     * @param obj The photocam object
18641     * @param h_bounce bouncing for horizontal
18642     * @param v_bounce bouncing for vertical
18643     *
18644     * @see elm_photocam_bounce_set()
18645     */
18646    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18647    /**
18648     * @}
18649     */
18650
18651    /**
18652     * @defgroup Map Map
18653     * @ingroup Elementary
18654     *
18655     * @image html img/widget/map/preview-00.png
18656     * @image latex img/widget/map/preview-00.eps
18657     *
18658     * This is a widget specifically for displaying a map. It uses basically
18659     * OpenStreetMap provider http://www.openstreetmap.org/,
18660     * but custom providers can be added.
18661     *
18662     * It supports some basic but yet nice features:
18663     * @li zoom and scroll
18664     * @li markers with content to be displayed when user clicks over it
18665     * @li group of markers
18666     * @li routes
18667     *
18668     * Smart callbacks one can listen to:
18669     *
18670     * - "clicked" - This is called when a user has clicked the map without
18671     *   dragging around.
18672     * - "press" - This is called when a user has pressed down on the map.
18673     * - "longpressed" - This is called when a user has pressed down on the map
18674     *   for a long time without dragging around.
18675     * - "clicked,double" - This is called when a user has double-clicked
18676     *   the map.
18677     * - "load,detail" - Map detailed data load begins.
18678     * - "loaded,detail" - This is called when all currently visible parts of
18679     *   the map are loaded.
18680     * - "zoom,start" - Zoom animation started.
18681     * - "zoom,stop" - Zoom animation stopped.
18682     * - "zoom,change" - Zoom changed when using an auto zoom mode.
18683     * - "scroll" - the content has been scrolled (moved).
18684     * - "scroll,anim,start" - scrolling animation has started.
18685     * - "scroll,anim,stop" - scrolling animation has stopped.
18686     * - "scroll,drag,start" - dragging the contents around has started.
18687     * - "scroll,drag,stop" - dragging the contents around has stopped.
18688     * - "downloaded" - This is called when all currently required map images
18689     *   are downloaded.
18690     * - "route,load" - This is called when route request begins.
18691     * - "route,loaded" - This is called when route request ends.
18692     * - "name,load" - This is called when name request begins.
18693     * - "name,loaded- This is called when name request ends.
18694     *
18695     * Available style for map widget:
18696     * - @c "default"
18697     *
18698     * Available style for markers:
18699     * - @c "radio"
18700     * - @c "radio2"
18701     * - @c "empty"
18702     *
18703     * Available style for marker bubble:
18704     * - @c "default"
18705     *
18706     * List of examples:
18707     * @li @ref map_example_01
18708     * @li @ref map_example_02
18709     * @li @ref map_example_03
18710     */
18711
18712    /**
18713     * @addtogroup Map
18714     * @{
18715     */
18716
18717    /**
18718     * @enum _Elm_Map_Zoom_Mode
18719     * @typedef Elm_Map_Zoom_Mode
18720     *
18721     * Set map's zoom behavior. It can be set to manual or automatic.
18722     *
18723     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18724     *
18725     * Values <b> don't </b> work as bitmask, only one can be choosen.
18726     *
18727     * @note Valid sizes are 2^zoom, consequently the map may be smaller
18728     * than the scroller view.
18729     *
18730     * @see elm_map_zoom_mode_set()
18731     * @see elm_map_zoom_mode_get()
18732     *
18733     * @ingroup Map
18734     */
18735    typedef enum _Elm_Map_Zoom_Mode
18736      {
18737         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18738         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18739         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18740         ELM_MAP_ZOOM_MODE_LAST
18741      } Elm_Map_Zoom_Mode;
18742
18743    /**
18744     * @enum _Elm_Map_Route_Sources
18745     * @typedef Elm_Map_Route_Sources
18746     *
18747     * Set route service to be used. By default used source is
18748     * #ELM_MAP_ROUTE_SOURCE_YOURS.
18749     *
18750     * @see elm_map_route_source_set()
18751     * @see elm_map_route_source_get()
18752     *
18753     * @ingroup Map
18754     */
18755    typedef enum _Elm_Map_Route_Sources
18756      {
18757         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18758         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. */
18759         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18760         ELM_MAP_ROUTE_SOURCE_LAST
18761      } Elm_Map_Route_Sources;
18762
18763    typedef enum _Elm_Map_Name_Sources
18764      {
18765         ELM_MAP_NAME_SOURCE_NOMINATIM,
18766         ELM_MAP_NAME_SOURCE_LAST
18767      } Elm_Map_Name_Sources;
18768
18769    /**
18770     * @enum _Elm_Map_Route_Type
18771     * @typedef Elm_Map_Route_Type
18772     *
18773     * Set type of transport used on route.
18774     *
18775     * @see elm_map_route_add()
18776     *
18777     * @ingroup Map
18778     */
18779    typedef enum _Elm_Map_Route_Type
18780      {
18781         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18782         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18783         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18784         ELM_MAP_ROUTE_TYPE_LAST
18785      } Elm_Map_Route_Type;
18786
18787    /**
18788     * @enum _Elm_Map_Route_Method
18789     * @typedef Elm_Map_Route_Method
18790     *
18791     * Set the routing method, what should be priorized, time or distance.
18792     *
18793     * @see elm_map_route_add()
18794     *
18795     * @ingroup Map
18796     */
18797    typedef enum _Elm_Map_Route_Method
18798      {
18799         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18800         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18801         ELM_MAP_ROUTE_METHOD_LAST
18802      } Elm_Map_Route_Method;
18803
18804    typedef enum _Elm_Map_Name_Method
18805      {
18806         ELM_MAP_NAME_METHOD_SEARCH,
18807         ELM_MAP_NAME_METHOD_REVERSE,
18808         ELM_MAP_NAME_METHOD_LAST
18809      } Elm_Map_Name_Method;
18810
18811    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(). */
18812    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(). */
18813    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(). */
18814    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(). */
18815    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
18816    typedef struct _Elm_Map_Track           Elm_Map_Track;
18817
18818    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. */
18819    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18820    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18821    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18822
18823    typedef char        *(*ElmMapModuleSourceFunc) (void);
18824    typedef int          (*ElmMapModuleZoomMinFunc) (void);
18825    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
18826    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18827    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
18828    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18829    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18830    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18831    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18832
18833    /**
18834     * Add a new map widget to the given parent Elementary (container) object.
18835     *
18836     * @param parent The parent object.
18837     * @return a new map widget handle or @c NULL, on errors.
18838     *
18839     * This function inserts a new map widget on the canvas.
18840     *
18841     * @ingroup Map
18842     */
18843    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18844
18845    /**
18846     * Set the zoom level of the map.
18847     *
18848     * @param obj The map object.
18849     * @param zoom The zoom level to set.
18850     *
18851     * This sets the zoom level.
18852     *
18853     * It will respect limits defined by elm_map_source_zoom_min_set() and
18854     * elm_map_source_zoom_max_set().
18855     *
18856     * By default these values are 0 (world map) and 18 (maximum zoom).
18857     *
18858     * This function should be used when zoom mode is set to
18859     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18860     * with elm_map_zoom_mode_set().
18861     *
18862     * @see elm_map_zoom_mode_set().
18863     * @see elm_map_zoom_get().
18864     *
18865     * @ingroup Map
18866     */
18867    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18868
18869    /**
18870     * Get the zoom level of the map.
18871     *
18872     * @param obj The map object.
18873     * @return The current zoom level.
18874     *
18875     * This returns the current zoom level of the map object.
18876     *
18877     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18878     * (which is the default), the zoom level may be changed at any time by the
18879     * map object itself to account for map size and map viewport size.
18880     *
18881     * @see elm_map_zoom_set() for details.
18882     *
18883     * @ingroup Map
18884     */
18885    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18886
18887    /**
18888     * Set the zoom mode used by the map object.
18889     *
18890     * @param obj The map object.
18891     * @param mode The zoom mode of the map, being it one of
18892     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18893     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18894     *
18895     * This sets the zoom mode to manual or one of the automatic levels.
18896     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18897     * elm_map_zoom_set() and will stay at that level until changed by code
18898     * or until zoom mode is changed. This is the default mode.
18899     *
18900     * The Automatic modes will allow the map object to automatically
18901     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18902     * adjust zoom so the map fits inside the scroll frame with no pixels
18903     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18904     * ensure no pixels within the frame are left unfilled. Do not forget that
18905     * the valid sizes are 2^zoom, consequently the map may be smaller than
18906     * the scroller view.
18907     *
18908     * @see elm_map_zoom_set()
18909     *
18910     * @ingroup Map
18911     */
18912    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18913
18914    /**
18915     * Get the zoom mode used by the map object.
18916     *
18917     * @param obj The map object.
18918     * @return The zoom mode of the map, being it one of
18919     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18920     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18921     *
18922     * This function returns the current zoom mode used by the map object.
18923     *
18924     * @see elm_map_zoom_mode_set() for more details.
18925     *
18926     * @ingroup Map
18927     */
18928    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18929
18930    /**
18931     * Get the current coordinates of the map.
18932     *
18933     * @param obj The map object.
18934     * @param lon Pointer where to store longitude.
18935     * @param lat Pointer where to store latitude.
18936     *
18937     * This gets the current center coordinates of the map object. It can be
18938     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18939     *
18940     * @see elm_map_geo_region_bring_in()
18941     * @see elm_map_geo_region_show()
18942     *
18943     * @ingroup Map
18944     */
18945    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18946
18947    /**
18948     * Animatedly bring in given coordinates to the center of the map.
18949     *
18950     * @param obj The map object.
18951     * @param lon Longitude to center at.
18952     * @param lat Latitude to center at.
18953     *
18954     * This causes map to jump to the given @p lat and @p lon coordinates
18955     * and show it (by scrolling) in the center of the viewport, if it is not
18956     * already centered. This will use animation to do so and take a period
18957     * of time to complete.
18958     *
18959     * @see elm_map_geo_region_show() for a function to avoid animation.
18960     * @see elm_map_geo_region_get()
18961     *
18962     * @ingroup Map
18963     */
18964    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18965
18966    /**
18967     * Show the given coordinates at the center of the map, @b immediately.
18968     *
18969     * @param obj The map object.
18970     * @param lon Longitude to center at.
18971     * @param lat Latitude to center at.
18972     *
18973     * This causes map to @b redraw its viewport's contents to the
18974     * region contining the given @p lat and @p lon, that will be moved to the
18975     * center of the map.
18976     *
18977     * @see elm_map_geo_region_bring_in() for a function to move with animation.
18978     * @see elm_map_geo_region_get()
18979     *
18980     * @ingroup Map
18981     */
18982    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18983
18984    /**
18985     * Pause or unpause the map.
18986     *
18987     * @param obj The map object.
18988     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18989     * to unpause it.
18990     *
18991     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18992     * for map.
18993     *
18994     * The default is off.
18995     *
18996     * This will stop zooming using animation, changing zoom levels will
18997     * change instantly. This will stop any existing animations that are running.
18998     *
18999     * @see elm_map_paused_get()
19000     *
19001     * @ingroup Map
19002     */
19003    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
19004
19005    /**
19006     * Get a value whether map is paused or not.
19007     *
19008     * @param obj The map object.
19009     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
19010     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
19011     *
19012     * This gets the current paused state for the map object.
19013     *
19014     * @see elm_map_paused_set() for details.
19015     *
19016     * @ingroup Map
19017     */
19018    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19019
19020    /**
19021     * Set to show markers during zoom level changes or not.
19022     *
19023     * @param obj The map object.
19024     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
19025     * to show them.
19026     *
19027     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
19028     * for map.
19029     *
19030     * The default is off.
19031     *
19032     * This will stop zooming using animation, changing zoom levels will
19033     * change instantly. This will stop any existing animations that are running.
19034     *
19035     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
19036     * for the markers.
19037     *
19038     * The default  is off.
19039     *
19040     * Enabling it will force the map to stop displaying the markers during
19041     * zoom level changes. Set to on if you have a large number of markers.
19042     *
19043     * @see elm_map_paused_markers_get()
19044     *
19045     * @ingroup Map
19046     */
19047    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
19048
19049    /**
19050     * Get a value whether markers will be displayed on zoom level changes or not
19051     *
19052     * @param obj The map object.
19053     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
19054     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
19055     *
19056     * This gets the current markers paused state for the map object.
19057     *
19058     * @see elm_map_paused_markers_set() for details.
19059     *
19060     * @ingroup Map
19061     */
19062    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19063
19064    /**
19065     * Get the information of downloading status.
19066     *
19067     * @param obj The map object.
19068     * @param try_num Pointer where to store number of tiles being downloaded.
19069     * @param finish_num Pointer where to store number of tiles successfully
19070     * downloaded.
19071     *
19072     * This gets the current downloading status for the map object, the number
19073     * of tiles being downloaded and the number of tiles already downloaded.
19074     *
19075     * @ingroup Map
19076     */
19077    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
19078
19079    /**
19080     * Convert a pixel coordinate (x,y) into a geographic coordinate
19081     * (longitude, latitude).
19082     *
19083     * @param obj The map object.
19084     * @param x the coordinate.
19085     * @param y the coordinate.
19086     * @param size the size in pixels of the map.
19087     * The map is a square and generally his size is : pow(2.0, zoom)*256.
19088     * @param lon Pointer where to store the longitude that correspond to x.
19089     * @param lat Pointer where to store the latitude that correspond to y.
19090     *
19091     * @note Origin pixel point is the top left corner of the viewport.
19092     * Map zoom and size are taken on account.
19093     *
19094     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
19095     *
19096     * @ingroup Map
19097     */
19098    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);
19099
19100    /**
19101     * Convert a geographic coordinate (longitude, latitude) into a pixel
19102     * coordinate (x, y).
19103     *
19104     * @param obj The map object.
19105     * @param lon the longitude.
19106     * @param lat the latitude.
19107     * @param size the size in pixels of the map. The map is a square
19108     * and generally his size is : pow(2.0, zoom)*256.
19109     * @param x Pointer where to store the horizontal pixel coordinate that
19110     * correspond to the longitude.
19111     * @param y Pointer where to store the vertical pixel coordinate that
19112     * correspond to the latitude.
19113     *
19114     * @note Origin pixel point is the top left corner of the viewport.
19115     * Map zoom and size are taken on account.
19116     *
19117     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
19118     *
19119     * @ingroup Map
19120     */
19121    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);
19122
19123    /**
19124     * Convert a geographic coordinate (longitude, latitude) into a name
19125     * (address).
19126     *
19127     * @param obj The map object.
19128     * @param lon the longitude.
19129     * @param lat the latitude.
19130     * @return name A #Elm_Map_Name handle for this coordinate.
19131     *
19132     * To get the string for this address, elm_map_name_address_get()
19133     * should be used.
19134     *
19135     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
19136     *
19137     * @ingroup Map
19138     */
19139    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
19140
19141    /**
19142     * Convert a name (address) into a geographic coordinate
19143     * (longitude, latitude).
19144     *
19145     * @param obj The map object.
19146     * @param name The address.
19147     * @return name A #Elm_Map_Name handle for this address.
19148     *
19149     * To get the longitude and latitude, elm_map_name_region_get()
19150     * should be used.
19151     *
19152     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
19153     *
19154     * @ingroup Map
19155     */
19156    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
19157
19158    /**
19159     * Convert a pixel coordinate into a rotated pixel coordinate.
19160     *
19161     * @param obj The map object.
19162     * @param x horizontal coordinate of the point to rotate.
19163     * @param y vertical coordinate of the point to rotate.
19164     * @param cx rotation's center horizontal position.
19165     * @param cy rotation's center vertical position.
19166     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
19167     * @param xx Pointer where to store rotated x.
19168     * @param yy Pointer where to store rotated y.
19169     *
19170     * @ingroup Map
19171     */
19172    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);
19173
19174    /**
19175     * Add a new marker to the map object.
19176     *
19177     * @param obj The map object.
19178     * @param lon The longitude of the marker.
19179     * @param lat The latitude of the marker.
19180     * @param clas The class, to use when marker @b isn't grouped to others.
19181     * @param clas_group The class group, to use when marker is grouped to others
19182     * @param data The data passed to the callbacks.
19183     *
19184     * @return The created marker or @c NULL upon failure.
19185     *
19186     * A marker will be created and shown in a specific point of the map, defined
19187     * by @p lon and @p lat.
19188     *
19189     * It will be displayed using style defined by @p class when this marker
19190     * is displayed alone (not grouped). A new class can be created with
19191     * elm_map_marker_class_new().
19192     *
19193     * If the marker is grouped to other markers, it will be displayed with
19194     * style defined by @p class_group. Markers with the same group are grouped
19195     * if they are close. A new group class can be created with
19196     * elm_map_marker_group_class_new().
19197     *
19198     * Markers created with this method can be deleted with
19199     * elm_map_marker_remove().
19200     *
19201     * A marker can have associated content to be displayed by a bubble,
19202     * when a user click over it, as well as an icon. These objects will
19203     * be fetch using class' callback functions.
19204     *
19205     * @see elm_map_marker_class_new()
19206     * @see elm_map_marker_group_class_new()
19207     * @see elm_map_marker_remove()
19208     *
19209     * @ingroup Map
19210     */
19211    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);
19212
19213    /**
19214     * Set the maximum numbers of markers' content to be displayed in a group.
19215     *
19216     * @param obj The map object.
19217     * @param max The maximum numbers of items displayed in a bubble.
19218     *
19219     * A bubble will be displayed when the user clicks over the group,
19220     * and will place the content of markers that belong to this group
19221     * inside it.
19222     *
19223     * A group can have a long list of markers, consequently the creation
19224     * of the content of the bubble can be very slow.
19225     *
19226     * In order to avoid this, a maximum number of items is displayed
19227     * in a bubble.
19228     *
19229     * By default this number is 30.
19230     *
19231     * Marker with the same group class are grouped if they are close.
19232     *
19233     * @see elm_map_marker_add()
19234     *
19235     * @ingroup Map
19236     */
19237    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
19238
19239    /**
19240     * Remove a marker from the map.
19241     *
19242     * @param marker The marker to remove.
19243     *
19244     * @see elm_map_marker_add()
19245     *
19246     * @ingroup Map
19247     */
19248    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19249
19250    /**
19251     * Get the current coordinates of the marker.
19252     *
19253     * @param marker marker.
19254     * @param lat Pointer where to store the marker's latitude.
19255     * @param lon Pointer where to store the marker's longitude.
19256     *
19257     * These values are set when adding markers, with function
19258     * elm_map_marker_add().
19259     *
19260     * @see elm_map_marker_add()
19261     *
19262     * @ingroup Map
19263     */
19264    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
19265
19266    /**
19267     * Animatedly bring in given marker to the center of the map.
19268     *
19269     * @param marker The marker to center at.
19270     *
19271     * This causes map to jump to the given @p marker's coordinates
19272     * and show it (by scrolling) in the center of the viewport, if it is not
19273     * already centered. This will use animation to do so and take a period
19274     * of time to complete.
19275     *
19276     * @see elm_map_marker_show() for a function to avoid animation.
19277     * @see elm_map_marker_region_get()
19278     *
19279     * @ingroup Map
19280     */
19281    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19282
19283    /**
19284     * Show the given marker at the center of the map, @b immediately.
19285     *
19286     * @param marker The marker to center at.
19287     *
19288     * This causes map to @b redraw its viewport's contents to the
19289     * region contining the given @p marker's coordinates, that will be
19290     * moved to the center of the map.
19291     *
19292     * @see elm_map_marker_bring_in() for a function to move with animation.
19293     * @see elm_map_markers_list_show() if more than one marker need to be
19294     * displayed.
19295     * @see elm_map_marker_region_get()
19296     *
19297     * @ingroup Map
19298     */
19299    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19300
19301    /**
19302     * Move and zoom the map to display a list of markers.
19303     *
19304     * @param markers A list of #Elm_Map_Marker handles.
19305     *
19306     * The map will be centered on the center point of the markers in the list.
19307     * Then the map will be zoomed in order to fit the markers using the maximum
19308     * zoom which allows display of all the markers.
19309     *
19310     * @warning All the markers should belong to the same map object.
19311     *
19312     * @see elm_map_marker_show() to show a single marker.
19313     * @see elm_map_marker_bring_in()
19314     *
19315     * @ingroup Map
19316     */
19317    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
19318
19319    /**
19320     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
19321     *
19322     * @param marker The marker wich content should be returned.
19323     * @return Return the evas object if it exists, else @c NULL.
19324     *
19325     * To set callback function #ElmMapMarkerGetFunc for the marker class,
19326     * elm_map_marker_class_get_cb_set() should be used.
19327     *
19328     * This content is what will be inside the bubble that will be displayed
19329     * when an user clicks over the marker.
19330     *
19331     * This returns the actual Evas object used to be placed inside
19332     * the bubble. This may be @c NULL, as it may
19333     * not have been created or may have been deleted, at any time, by
19334     * the map. <b>Do not modify this object</b> (move, resize,
19335     * show, hide, etc.), as the map is controlling it. This
19336     * function is for querying, emitting custom signals or hooking
19337     * lower level callbacks for events on that object. Do not delete
19338     * this object under any circumstances.
19339     *
19340     * @ingroup Map
19341     */
19342    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19343
19344    /**
19345     * Update the marker
19346     *
19347     * @param marker The marker to be updated.
19348     *
19349     * If a content is set to this marker, it will call function to delete it,
19350     * #ElmMapMarkerDelFunc, and then will fetch the content again with
19351     * #ElmMapMarkerGetFunc.
19352     *
19353     * These functions are set for the marker class with
19354     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19355     *
19356     * @ingroup Map
19357     */
19358    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19359
19360    /**
19361     * Close all the bubbles opened by the user.
19362     *
19363     * @param obj The map object.
19364     *
19365     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19366     * when the user clicks on a marker.
19367     *
19368     * This functions is set for the marker class with
19369     * elm_map_marker_class_get_cb_set().
19370     *
19371     * @ingroup Map
19372     */
19373    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19374
19375    /**
19376     * Create a new group class.
19377     *
19378     * @param obj The map object.
19379     * @return Returns the new group class.
19380     *
19381     * Each marker must be associated to a group class. Markers in the same
19382     * group are grouped if they are close.
19383     *
19384     * The group class defines the style of the marker when a marker is grouped
19385     * to others markers. When it is alone, another class will be used.
19386     *
19387     * A group class will need to be provided when creating a marker with
19388     * elm_map_marker_add().
19389     *
19390     * Some properties and functions can be set by class, as:
19391     * - style, with elm_map_group_class_style_set()
19392     * - data - to be associated to the group class. It can be set using
19393     *   elm_map_group_class_data_set().
19394     * - min zoom to display markers, set with
19395     *   elm_map_group_class_zoom_displayed_set().
19396     * - max zoom to group markers, set using
19397     *   elm_map_group_class_zoom_grouped_set().
19398     * - visibility - set if markers will be visible or not, set with
19399     *   elm_map_group_class_hide_set().
19400     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19401     *   It can be set using elm_map_group_class_icon_cb_set().
19402     *
19403     * @see elm_map_marker_add()
19404     * @see elm_map_group_class_style_set()
19405     * @see elm_map_group_class_data_set()
19406     * @see elm_map_group_class_zoom_displayed_set()
19407     * @see elm_map_group_class_zoom_grouped_set()
19408     * @see elm_map_group_class_hide_set()
19409     * @see elm_map_group_class_icon_cb_set()
19410     *
19411     * @ingroup Map
19412     */
19413    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19414
19415    /**
19416     * Set the marker's style of a group class.
19417     *
19418     * @param clas The group class.
19419     * @param style The style to be used by markers.
19420     *
19421     * Each marker must be associated to a group class, and will use the style
19422     * defined by such class when grouped to other markers.
19423     *
19424     * The following styles are provided by default theme:
19425     * @li @c radio - blue circle
19426     * @li @c radio2 - green circle
19427     * @li @c empty
19428     *
19429     * @see elm_map_group_class_new() for more details.
19430     * @see elm_map_marker_add()
19431     *
19432     * @ingroup Map
19433     */
19434    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19435
19436    /**
19437     * Set the icon callback function of a group class.
19438     *
19439     * @param clas The group class.
19440     * @param icon_get The callback function that will return the icon.
19441     *
19442     * Each marker must be associated to a group class, and it can display a
19443     * custom icon. The function @p icon_get must return this icon.
19444     *
19445     * @see elm_map_group_class_new() for more details.
19446     * @see elm_map_marker_add()
19447     *
19448     * @ingroup Map
19449     */
19450    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19451
19452    /**
19453     * Set the data associated to the group class.
19454     *
19455     * @param clas The group class.
19456     * @param data The new user data.
19457     *
19458     * This data will be passed for callback functions, like icon get callback,
19459     * that can be set with elm_map_group_class_icon_cb_set().
19460     *
19461     * If a data was previously set, the object will lose the pointer for it,
19462     * so if needs to be freed, you must do it yourself.
19463     *
19464     * @see elm_map_group_class_new() for more details.
19465     * @see elm_map_group_class_icon_cb_set()
19466     * @see elm_map_marker_add()
19467     *
19468     * @ingroup Map
19469     */
19470    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19471
19472    /**
19473     * Set the minimum zoom from where the markers are displayed.
19474     *
19475     * @param clas The group class.
19476     * @param zoom The minimum zoom.
19477     *
19478     * Markers only will be displayed when the map is displayed at @p zoom
19479     * or bigger.
19480     *
19481     * @see elm_map_group_class_new() for more details.
19482     * @see elm_map_marker_add()
19483     *
19484     * @ingroup Map
19485     */
19486    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19487
19488    /**
19489     * Set the zoom from where the markers are no more grouped.
19490     *
19491     * @param clas The group class.
19492     * @param zoom The maximum zoom.
19493     *
19494     * Markers only will be grouped when the map is displayed at
19495     * less than @p zoom.
19496     *
19497     * @see elm_map_group_class_new() for more details.
19498     * @see elm_map_marker_add()
19499     *
19500     * @ingroup Map
19501     */
19502    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19503
19504    /**
19505     * Set if the markers associated to the group class @clas are hidden or not.
19506     *
19507     * @param clas The group class.
19508     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19509     * to show them.
19510     *
19511     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19512     * is to show them.
19513     *
19514     * @ingroup Map
19515     */
19516    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19517
19518    /**
19519     * Create a new marker class.
19520     *
19521     * @param obj The map object.
19522     * @return Returns the new group class.
19523     *
19524     * Each marker must be associated to a class.
19525     *
19526     * The marker class defines the style of the marker when a marker is
19527     * displayed alone, i.e., not grouped to to others markers. When grouped
19528     * it will use group class style.
19529     *
19530     * A marker class will need to be provided when creating a marker with
19531     * elm_map_marker_add().
19532     *
19533     * Some properties and functions can be set by class, as:
19534     * - style, with elm_map_marker_class_style_set()
19535     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19536     *   It can be set using elm_map_marker_class_icon_cb_set().
19537     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19538     *   Set using elm_map_marker_class_get_cb_set().
19539     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19540     *   Set using elm_map_marker_class_del_cb_set().
19541     *
19542     * @see elm_map_marker_add()
19543     * @see elm_map_marker_class_style_set()
19544     * @see elm_map_marker_class_icon_cb_set()
19545     * @see elm_map_marker_class_get_cb_set()
19546     * @see elm_map_marker_class_del_cb_set()
19547     *
19548     * @ingroup Map
19549     */
19550    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19551
19552    /**
19553     * Set the marker's style of a marker class.
19554     *
19555     * @param clas The marker class.
19556     * @param style The style to be used by markers.
19557     *
19558     * Each marker must be associated to a marker class, and will use the style
19559     * defined by such class when alone, i.e., @b not grouped to other markers.
19560     *
19561     * The following styles are provided by default theme:
19562     * @li @c radio
19563     * @li @c radio2
19564     * @li @c empty
19565     *
19566     * @see elm_map_marker_class_new() for more details.
19567     * @see elm_map_marker_add()
19568     *
19569     * @ingroup Map
19570     */
19571    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19572
19573    /**
19574     * Set the icon callback function of a marker class.
19575     *
19576     * @param clas The marker class.
19577     * @param icon_get The callback function that will return the icon.
19578     *
19579     * Each marker must be associated to a marker class, and it can display a
19580     * custom icon. The function @p icon_get must return this icon.
19581     *
19582     * @see elm_map_marker_class_new() for more details.
19583     * @see elm_map_marker_add()
19584     *
19585     * @ingroup Map
19586     */
19587    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19588
19589    /**
19590     * Set the bubble content callback function of a marker class.
19591     *
19592     * @param clas The marker class.
19593     * @param get The callback function that will return the content.
19594     *
19595     * Each marker must be associated to a marker class, and it can display a
19596     * a content on a bubble that opens when the user click over the marker.
19597     * The function @p get must return this content object.
19598     *
19599     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19600     * can be used.
19601     *
19602     * @see elm_map_marker_class_new() for more details.
19603     * @see elm_map_marker_class_del_cb_set()
19604     * @see elm_map_marker_add()
19605     *
19606     * @ingroup Map
19607     */
19608    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19609
19610    /**
19611     * Set the callback function used to delete bubble content of a marker class.
19612     *
19613     * @param clas The marker class.
19614     * @param del The callback function that will delete the content.
19615     *
19616     * Each marker must be associated to a marker class, and it can display a
19617     * a content on a bubble that opens when the user click over the marker.
19618     * The function to return such content can be set with
19619     * elm_map_marker_class_get_cb_set().
19620     *
19621     * If this content must be freed, a callback function need to be
19622     * set for that task with this function.
19623     *
19624     * If this callback is defined it will have to delete (or not) the
19625     * object inside, but if the callback is not defined the object will be
19626     * destroyed with evas_object_del().
19627     *
19628     * @see elm_map_marker_class_new() for more details.
19629     * @see elm_map_marker_class_get_cb_set()
19630     * @see elm_map_marker_add()
19631     *
19632     * @ingroup Map
19633     */
19634    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19635
19636    /**
19637     * Get the list of available sources.
19638     *
19639     * @param obj The map object.
19640     * @return The source names list.
19641     *
19642     * It will provide a list with all available sources, that can be set as
19643     * current source with elm_map_source_name_set(), or get with
19644     * elm_map_source_name_get().
19645     *
19646     * Available sources:
19647     * @li "Mapnik"
19648     * @li "Osmarender"
19649     * @li "CycleMap"
19650     * @li "Maplint"
19651     *
19652     * @see elm_map_source_name_set() for more details.
19653     * @see elm_map_source_name_get()
19654     *
19655     * @ingroup Map
19656     */
19657    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19658
19659    /**
19660     * Set the source of the map.
19661     *
19662     * @param obj The map object.
19663     * @param source The source to be used.
19664     *
19665     * Map widget retrieves images that composes the map from a web service.
19666     * This web service can be set with this method.
19667     *
19668     * A different service can return a different maps with different
19669     * information and it can use different zoom values.
19670     *
19671     * The @p source_name need to match one of the names provided by
19672     * elm_map_source_names_get().
19673     *
19674     * The current source can be get using elm_map_source_name_get().
19675     *
19676     * @see elm_map_source_names_get()
19677     * @see elm_map_source_name_get()
19678     *
19679     *
19680     * @ingroup Map
19681     */
19682    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19683
19684    /**
19685     * Get the name of currently used source.
19686     *
19687     * @param obj The map object.
19688     * @return Returns the name of the source in use.
19689     *
19690     * @see elm_map_source_name_set() for more details.
19691     *
19692     * @ingroup Map
19693     */
19694    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19695
19696    /**
19697     * Set the source of the route service to be used by the map.
19698     *
19699     * @param obj The map object.
19700     * @param source The route service to be used, being it one of
19701     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19702     * and #ELM_MAP_ROUTE_SOURCE_ORS.
19703     *
19704     * Each one has its own algorithm, so the route retrieved may
19705     * differ depending on the source route. Now, only the default is working.
19706     *
19707     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19708     * http://www.yournavigation.org/.
19709     *
19710     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19711     * assumptions. Its routing core is based on Contraction Hierarchies.
19712     *
19713     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19714     *
19715     * @see elm_map_route_source_get().
19716     *
19717     * @ingroup Map
19718     */
19719    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19720
19721    /**
19722     * Get the current route source.
19723     *
19724     * @param obj The map object.
19725     * @return The source of the route service used by the map.
19726     *
19727     * @see elm_map_route_source_set() for details.
19728     *
19729     * @ingroup Map
19730     */
19731    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19732
19733    /**
19734     * Set the minimum zoom of the source.
19735     *
19736     * @param obj The map object.
19737     * @param zoom New minimum zoom value to be used.
19738     *
19739     * By default, it's 0.
19740     *
19741     * @ingroup Map
19742     */
19743    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19744
19745    /**
19746     * Get the minimum zoom of the source.
19747     *
19748     * @param obj The map object.
19749     * @return Returns the minimum zoom of the source.
19750     *
19751     * @see elm_map_source_zoom_min_set() for details.
19752     *
19753     * @ingroup Map
19754     */
19755    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19756
19757    /**
19758     * Set the maximum zoom of the source.
19759     *
19760     * @param obj The map object.
19761     * @param zoom New maximum zoom value to be used.
19762     *
19763     * By default, it's 18.
19764     *
19765     * @ingroup Map
19766     */
19767    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19768
19769    /**
19770     * Get the maximum zoom of the source.
19771     *
19772     * @param obj The map object.
19773     * @return Returns the maximum zoom of the source.
19774     *
19775     * @see elm_map_source_zoom_min_set() for details.
19776     *
19777     * @ingroup Map
19778     */
19779    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19780
19781    /**
19782     * Set the user agent used by the map object to access routing services.
19783     *
19784     * @param obj The map object.
19785     * @param user_agent The user agent to be used by the map.
19786     *
19787     * User agent is a client application implementing a network protocol used
19788     * in communications within a client–server distributed computing system
19789     *
19790     * The @p user_agent identification string will transmitted in a header
19791     * field @c User-Agent.
19792     *
19793     * @see elm_map_user_agent_get()
19794     *
19795     * @ingroup Map
19796     */
19797    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19798
19799    /**
19800     * Get the user agent used by the map object.
19801     *
19802     * @param obj The map object.
19803     * @return The user agent identification string used by the map.
19804     *
19805     * @see elm_map_user_agent_set() for details.
19806     *
19807     * @ingroup Map
19808     */
19809    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19810
19811    /**
19812     * Add a new route to the map object.
19813     *
19814     * @param obj The map object.
19815     * @param type The type of transport to be considered when tracing a route.
19816     * @param method The routing method, what should be priorized.
19817     * @param flon The start longitude.
19818     * @param flat The start latitude.
19819     * @param tlon The destination longitude.
19820     * @param tlat The destination latitude.
19821     *
19822     * @return The created route or @c NULL upon failure.
19823     *
19824     * A route will be traced by point on coordinates (@p flat, @p flon)
19825     * to point on coordinates (@p tlat, @p tlon), using the route service
19826     * set with elm_map_route_source_set().
19827     *
19828     * It will take @p type on consideration to define the route,
19829     * depending if the user will be walking or driving, the route may vary.
19830     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19831     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19832     *
19833     * Another parameter is what the route should priorize, the minor distance
19834     * or the less time to be spend on the route. So @p method should be one
19835     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19836     *
19837     * Routes created with this method can be deleted with
19838     * elm_map_route_remove(), colored with elm_map_route_color_set(),
19839     * and distance can be get with elm_map_route_distance_get().
19840     *
19841     * @see elm_map_route_remove()
19842     * @see elm_map_route_color_set()
19843     * @see elm_map_route_distance_get()
19844     * @see elm_map_route_source_set()
19845     *
19846     * @ingroup Map
19847     */
19848    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);
19849
19850    /**
19851     * Remove a route from the map.
19852     *
19853     * @param route The route to remove.
19854     *
19855     * @see elm_map_route_add()
19856     *
19857     * @ingroup Map
19858     */
19859    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19860
19861    /**
19862     * Set the route color.
19863     *
19864     * @param route The route object.
19865     * @param r Red channel value, from 0 to 255.
19866     * @param g Green channel value, from 0 to 255.
19867     * @param b Blue channel value, from 0 to 255.
19868     * @param a Alpha channel value, from 0 to 255.
19869     *
19870     * It uses an additive color model, so each color channel represents
19871     * how much of each primary colors must to be used. 0 represents
19872     * ausence of this color, so if all of the three are set to 0,
19873     * the color will be black.
19874     *
19875     * These component values should be integers in the range 0 to 255,
19876     * (single 8-bit byte).
19877     *
19878     * This sets the color used for the route. By default, it is set to
19879     * solid red (r = 255, g = 0, b = 0, a = 255).
19880     *
19881     * For alpha channel, 0 represents completely transparent, and 255, opaque.
19882     *
19883     * @see elm_map_route_color_get()
19884     *
19885     * @ingroup Map
19886     */
19887    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19888
19889    /**
19890     * Get the route color.
19891     *
19892     * @param route The route object.
19893     * @param r Pointer where to store the red channel value.
19894     * @param g Pointer where to store the green channel value.
19895     * @param b Pointer where to store the blue channel value.
19896     * @param a Pointer where to store the alpha channel value.
19897     *
19898     * @see elm_map_route_color_set() for details.
19899     *
19900     * @ingroup Map
19901     */
19902    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19903
19904    /**
19905     * Get the route distance in kilometers.
19906     *
19907     * @param route The route object.
19908     * @return The distance of route (unit : km).
19909     *
19910     * @ingroup Map
19911     */
19912    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19913
19914    /**
19915     * Get the information of route nodes.
19916     *
19917     * @param route The route object.
19918     * @return Returns a string with the nodes of route.
19919     *
19920     * @ingroup Map
19921     */
19922    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19923
19924    /**
19925     * Get the information of route waypoint.
19926     *
19927     * @param route the route object.
19928     * @return Returns a string with information about waypoint of route.
19929     *
19930     * @ingroup Map
19931     */
19932    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19933
19934    /**
19935     * Get the address of the name.
19936     *
19937     * @param name The name handle.
19938     * @return Returns the address string of @p name.
19939     *
19940     * This gets the coordinates of the @p name, created with one of the
19941     * conversion functions.
19942     *
19943     * @see elm_map_utils_convert_name_into_coord()
19944     * @see elm_map_utils_convert_coord_into_name()
19945     *
19946     * @ingroup Map
19947     */
19948    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19949
19950    /**
19951     * Get the current coordinates of the name.
19952     *
19953     * @param name The name handle.
19954     * @param lat Pointer where to store the latitude.
19955     * @param lon Pointer where to store The longitude.
19956     *
19957     * This gets the coordinates of the @p name, created with one of the
19958     * conversion functions.
19959     *
19960     * @see elm_map_utils_convert_name_into_coord()
19961     * @see elm_map_utils_convert_coord_into_name()
19962     *
19963     * @ingroup Map
19964     */
19965    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19966
19967    /**
19968     * Remove a name from the map.
19969     *
19970     * @param name The name to remove.
19971     *
19972     * Basically the struct handled by @p name will be freed, so convertions
19973     * between address and coordinates will be lost.
19974     *
19975     * @see elm_map_utils_convert_name_into_coord()
19976     * @see elm_map_utils_convert_coord_into_name()
19977     *
19978     * @ingroup Map
19979     */
19980    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19981
19982    /**
19983     * Rotate the map.
19984     *
19985     * @param obj The map object.
19986     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19987     * @param cx Rotation's center horizontal position.
19988     * @param cy Rotation's center vertical position.
19989     *
19990     * @see elm_map_rotate_get()
19991     *
19992     * @ingroup Map
19993     */
19994    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19995
19996    /**
19997     * Get the rotate degree of the map
19998     *
19999     * @param obj The map object
20000     * @param degree Pointer where to store degrees from 0.0 to 360.0
20001     * to rotate arount Z axis.
20002     * @param cx Pointer where to store rotation's center horizontal position.
20003     * @param cy Pointer where to store rotation's center vertical position.
20004     *
20005     * @see elm_map_rotate_set() to set map rotation.
20006     *
20007     * @ingroup Map
20008     */
20009    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);
20010
20011    /**
20012     * Enable or disable mouse wheel to be used to zoom in / out the map.
20013     *
20014     * @param obj The map object.
20015     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
20016     * to enable it.
20017     *
20018     * Mouse wheel can be used for the user to zoom in or zoom out the map.
20019     *
20020     * It's disabled by default.
20021     *
20022     * @see elm_map_wheel_disabled_get()
20023     *
20024     * @ingroup Map
20025     */
20026    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20027
20028    /**
20029     * Get a value whether mouse wheel is enabled or not.
20030     *
20031     * @param obj The map object.
20032     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
20033     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20034     *
20035     * Mouse wheel can be used for the user to zoom in or zoom out the map.
20036     *
20037     * @see elm_map_wheel_disabled_set() for details.
20038     *
20039     * @ingroup Map
20040     */
20041    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20042
20043 #ifdef ELM_EMAP
20044    /**
20045     * Add a track on the map
20046     *
20047     * @param obj The map object.
20048     * @param emap The emap route object.
20049     * @return The route object. This is an elm object of type Route.
20050     *
20051     * @see elm_route_add() for details.
20052     *
20053     * @ingroup Map
20054     */
20055    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
20056 #endif
20057
20058    /**
20059     * Remove a track from the map
20060     *
20061     * @param obj The map object.
20062     * @param route The track to remove.
20063     *
20064     * @ingroup Map
20065     */
20066    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
20067
20068    /**
20069     * @}
20070     */
20071
20072    /* Route */
20073    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
20074 #ifdef ELM_EMAP
20075    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
20076 #endif
20077    EAPI double elm_route_lon_min_get(Evas_Object *obj);
20078    EAPI double elm_route_lat_min_get(Evas_Object *obj);
20079    EAPI double elm_route_lon_max_get(Evas_Object *obj);
20080    EAPI double elm_route_lat_max_get(Evas_Object *obj);
20081
20082
20083    /**
20084     * @defgroup Panel Panel
20085     *
20086     * @image html img/widget/panel/preview-00.png
20087     * @image latex img/widget/panel/preview-00.eps
20088     *
20089     * @brief A panel is a type of animated container that contains subobjects.
20090     * It can be expanded or contracted by clicking the button on it's edge.
20091     *
20092     * Orientations are as follows:
20093     * @li ELM_PANEL_ORIENT_TOP
20094     * @li ELM_PANEL_ORIENT_LEFT
20095     * @li ELM_PANEL_ORIENT_RIGHT
20096     *
20097     * @ref tutorial_panel shows one way to use this widget.
20098     * @{
20099     */
20100    typedef enum _Elm_Panel_Orient
20101      {
20102         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
20103         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
20104         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
20105         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
20106      } Elm_Panel_Orient;
20107    /**
20108     * @brief Adds a panel object
20109     *
20110     * @param parent The parent object
20111     *
20112     * @return The panel object, or NULL on failure
20113     */
20114    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20115    /**
20116     * @brief Sets the orientation of the panel
20117     *
20118     * @param parent The parent object
20119     * @param orient The panel orientation. Can be one of the following:
20120     * @li ELM_PANEL_ORIENT_TOP
20121     * @li ELM_PANEL_ORIENT_LEFT
20122     * @li ELM_PANEL_ORIENT_RIGHT
20123     *
20124     * Sets from where the panel will (dis)appear.
20125     */
20126    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
20127    /**
20128     * @brief Get the orientation of the panel.
20129     *
20130     * @param obj The panel object
20131     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
20132     */
20133    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20134    /**
20135     * @brief Set the content of the panel.
20136     *
20137     * @param obj The panel object
20138     * @param content The panel content
20139     *
20140     * Once the content object is set, a previously set one will be deleted.
20141     * If you want to keep that old content object, use the
20142     * elm_panel_content_unset() function.
20143     */
20144    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20145    /**
20146     * @brief Get the content of the panel.
20147     *
20148     * @param obj The panel object
20149     * @return The content that is being used
20150     *
20151     * Return the content object which is set for this widget.
20152     *
20153     * @see elm_panel_content_set()
20154     */
20155    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20156    /**
20157     * @brief Unset the content of the panel.
20158     *
20159     * @param obj The panel object
20160     * @return The content that was being used
20161     *
20162     * Unparent and return the content object which was set for this widget.
20163     *
20164     * @see elm_panel_content_set()
20165     */
20166    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20167    /**
20168     * @brief Set the state of the panel.
20169     *
20170     * @param obj The panel object
20171     * @param hidden If true, the panel will run the animation to contract
20172     */
20173    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
20174    /**
20175     * @brief Get the state of the panel.
20176     *
20177     * @param obj The panel object
20178     * @param hidden If true, the panel is in the "hide" state
20179     */
20180    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20181    /**
20182     * @brief Toggle the hidden state of the panel from code
20183     *
20184     * @param obj The panel object
20185     */
20186    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
20187    /**
20188     * @}
20189     */
20190
20191    /**
20192     * @defgroup Panes Panes
20193     * @ingroup Elementary
20194     *
20195     * @image html img/widget/panes/preview-00.png
20196     * @image latex img/widget/panes/preview-00.eps width=\textwidth
20197     *
20198     * @image html img/panes.png
20199     * @image latex img/panes.eps width=\textwidth
20200     *
20201     * The panes adds a dragable bar between two contents. When dragged
20202     * this bar will resize contents size.
20203     *
20204     * Panes can be displayed vertically or horizontally, and contents
20205     * size proportion can be customized (homogeneous by default).
20206     *
20207     * Smart callbacks one can listen to:
20208     * - "press" - The panes has been pressed (button wasn't released yet).
20209     * - "unpressed" - The panes was released after being pressed.
20210     * - "clicked" - The panes has been clicked>
20211     * - "clicked,double" - The panes has been double clicked
20212     *
20213     * Available styles for it:
20214     * - @c "default"
20215     *
20216     * Here is an example on its usage:
20217     * @li @ref panes_example
20218     */
20219
20220    /**
20221     * @addtogroup Panes
20222     * @{
20223     */
20224
20225    /**
20226     * Add a new panes widget to the given parent Elementary
20227     * (container) object.
20228     *
20229     * @param parent The parent object.
20230     * @return a new panes widget handle or @c NULL, on errors.
20231     *
20232     * This function inserts a new panes widget on the canvas.
20233     *
20234     * @ingroup Panes
20235     */
20236    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20237
20238    /**
20239     * Set the left content of the panes widget.
20240     *
20241     * @param obj The panes object.
20242     * @param content The new left content object.
20243     *
20244     * Once the content object is set, a previously set one will be deleted.
20245     * If you want to keep that old content object, use the
20246     * elm_panes_content_left_unset() function.
20247     *
20248     * If panes is displayed vertically, left content will be displayed at
20249     * top.
20250     *
20251     * @see elm_panes_content_left_get()
20252     * @see elm_panes_content_right_set() to set content on the other side.
20253     *
20254     * @ingroup Panes
20255     */
20256    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20257
20258    /**
20259     * Set the right content of the panes widget.
20260     *
20261     * @param obj The panes object.
20262     * @param content The new right content object.
20263     *
20264     * Once the content object is set, a previously set one will be deleted.
20265     * If you want to keep that old content object, use the
20266     * elm_panes_content_right_unset() function.
20267     *
20268     * If panes is displayed vertically, left content will be displayed at
20269     * bottom.
20270     *
20271     * @see elm_panes_content_right_get()
20272     * @see elm_panes_content_left_set() to set content on the other side.
20273     *
20274     * @ingroup Panes
20275     */
20276    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20277
20278    /**
20279     * Get the left content of the panes.
20280     *
20281     * @param obj The panes object.
20282     * @return The left content object that is being used.
20283     *
20284     * Return the left content object which is set for this widget.
20285     *
20286     * @see elm_panes_content_left_set() for details.
20287     *
20288     * @ingroup Panes
20289     */
20290    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20291
20292    /**
20293     * Get the right content of the panes.
20294     *
20295     * @param obj The panes object
20296     * @return The right content object that is being used
20297     *
20298     * Return the right content object which is set for this widget.
20299     *
20300     * @see elm_panes_content_right_set() for details.
20301     *
20302     * @ingroup Panes
20303     */
20304    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20305
20306    /**
20307     * Unset the left content used for the panes.
20308     *
20309     * @param obj The panes object.
20310     * @return The left content object that was being used.
20311     *
20312     * Unparent and return the left content object which was set for this widget.
20313     *
20314     * @see elm_panes_content_left_set() for details.
20315     * @see elm_panes_content_left_get().
20316     *
20317     * @ingroup Panes
20318     */
20319    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20320
20321    /**
20322     * Unset the right content used for the panes.
20323     *
20324     * @param obj The panes object.
20325     * @return The right content object that was being used.
20326     *
20327     * Unparent and return the right content object which was set for this
20328     * widget.
20329     *
20330     * @see elm_panes_content_right_set() for details.
20331     * @see elm_panes_content_right_get().
20332     *
20333     * @ingroup Panes
20334     */
20335    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20336
20337    /**
20338     * Get the size proportion of panes widget's left side.
20339     *
20340     * @param obj The panes object.
20341     * @return float value between 0.0 and 1.0 representing size proportion
20342     * of left side.
20343     *
20344     * @see elm_panes_content_left_size_set() for more details.
20345     *
20346     * @ingroup Panes
20347     */
20348    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20349
20350    /**
20351     * Set the size proportion of panes widget's left side.
20352     *
20353     * @param obj The panes object.
20354     * @param size Value between 0.0 and 1.0 representing size proportion
20355     * of left side.
20356     *
20357     * By default it's homogeneous, i.e., both sides have the same size.
20358     *
20359     * If something different is required, it can be set with this function.
20360     * For example, if the left content should be displayed over
20361     * 75% of the panes size, @p size should be passed as @c 0.75.
20362     * This way, right content will be resized to 25% of panes size.
20363     *
20364     * If displayed vertically, left content is displayed at top, and
20365     * right content at bottom.
20366     *
20367     * @note This proportion will change when user drags the panes bar.
20368     *
20369     * @see elm_panes_content_left_size_get()
20370     *
20371     * @ingroup Panes
20372     */
20373    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20374
20375   /**
20376    * Set the orientation of a given panes widget.
20377    *
20378    * @param obj The panes object.
20379    * @param horizontal Use @c EINA_TRUE to make @p obj to be
20380    * @b horizontal, @c EINA_FALSE to make it @b vertical.
20381    *
20382    * Use this function to change how your panes is to be
20383    * disposed: vertically or horizontally.
20384    *
20385    * By default it's displayed horizontally.
20386    *
20387    * @see elm_panes_horizontal_get()
20388    *
20389    * @ingroup Panes
20390    */
20391    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20392
20393    /**
20394     * Retrieve the orientation of a given panes widget.
20395     *
20396     * @param obj The panes object.
20397     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20398     * @c EINA_FALSE if it's @b vertical (and on errors).
20399     *
20400     * @see elm_panes_horizontal_set() for more details.
20401     *
20402     * @ingroup Panes
20403     */
20404    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20405
20406    /**
20407     * @}
20408     */
20409
20410    /**
20411     * @defgroup Flip Flip
20412     *
20413     * @image html img/widget/flip/preview-00.png
20414     * @image latex img/widget/flip/preview-00.eps
20415     *
20416     * This widget holds 2 content objects(Evas_Object): one on the front and one
20417     * on the back. It allows you to flip from front to back and vice-versa using
20418     * various animations.
20419     *
20420     * If either the front or back contents are not set the flip will treat that
20421     * as transparent. So if you wore to set the front content but not the back,
20422     * and then call elm_flip_go() you would see whatever is below the flip.
20423     *
20424     * For a list of supported animations see elm_flip_go().
20425     *
20426     * Signals that you can add callbacks for are:
20427     * "animate,begin" - when a flip animation was started
20428     * "animate,done" - when a flip animation is finished
20429     *
20430     * @ref tutorial_flip show how to use most of the API.
20431     *
20432     * @{
20433     */
20434    typedef enum _Elm_Flip_Mode
20435      {
20436         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20437         ELM_FLIP_ROTATE_X_CENTER_AXIS,
20438         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20439         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20440         ELM_FLIP_CUBE_LEFT,
20441         ELM_FLIP_CUBE_RIGHT,
20442         ELM_FLIP_CUBE_UP,
20443         ELM_FLIP_CUBE_DOWN,
20444         ELM_FLIP_PAGE_LEFT,
20445         ELM_FLIP_PAGE_RIGHT,
20446         ELM_FLIP_PAGE_UP,
20447         ELM_FLIP_PAGE_DOWN
20448      } Elm_Flip_Mode;
20449    typedef enum _Elm_Flip_Interaction
20450      {
20451         ELM_FLIP_INTERACTION_NONE,
20452         ELM_FLIP_INTERACTION_ROTATE,
20453         ELM_FLIP_INTERACTION_CUBE,
20454         ELM_FLIP_INTERACTION_PAGE
20455      } Elm_Flip_Interaction;
20456    typedef enum _Elm_Flip_Direction
20457      {
20458         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20459         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20460         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20461         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20462      } Elm_Flip_Direction;
20463    /**
20464     * @brief Add a new flip to the parent
20465     *
20466     * @param parent The parent object
20467     * @return The new object or NULL if it cannot be created
20468     */
20469    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20470    /**
20471     * @brief Set the front content of the flip widget.
20472     *
20473     * @param obj The flip object
20474     * @param content The new front content object
20475     *
20476     * Once the content object is set, a previously set one will be deleted.
20477     * If you want to keep that old content object, use the
20478     * elm_flip_content_front_unset() function.
20479     */
20480    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20481    /**
20482     * @brief Set the back content of the flip widget.
20483     *
20484     * @param obj The flip object
20485     * @param content The new back content object
20486     *
20487     * Once the content object is set, a previously set one will be deleted.
20488     * If you want to keep that old content object, use the
20489     * elm_flip_content_back_unset() function.
20490     */
20491    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20492    /**
20493     * @brief Get the front content used for the flip
20494     *
20495     * @param obj The flip object
20496     * @return The front content object that is being used
20497     *
20498     * Return the front content object which is set for this widget.
20499     */
20500    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20501    /**
20502     * @brief Get the back content used for the flip
20503     *
20504     * @param obj The flip object
20505     * @return The back content object that is being used
20506     *
20507     * Return the back content object which is set for this widget.
20508     */
20509    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20510    /**
20511     * @brief Unset the front content used for the flip
20512     *
20513     * @param obj The flip object
20514     * @return The front content object that was being used
20515     *
20516     * Unparent and return the front content object which was set for this widget.
20517     */
20518    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20519    /**
20520     * @brief Unset the back content used for the flip
20521     *
20522     * @param obj The flip object
20523     * @return The back content object that was being used
20524     *
20525     * Unparent and return the back content object which was set for this widget.
20526     */
20527    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20528    /**
20529     * @brief Get flip front visibility state
20530     *
20531     * @param obj The flip objct
20532     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20533     * showing.
20534     */
20535    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20536    /**
20537     * @brief Set flip perspective
20538     *
20539     * @param obj The flip object
20540     * @param foc The coordinate to set the focus on
20541     * @param x The X coordinate
20542     * @param y The Y coordinate
20543     *
20544     * @warning This function currently does nothing.
20545     */
20546    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20547    /**
20548     * @brief Runs the flip animation
20549     *
20550     * @param obj The flip object
20551     * @param mode The mode type
20552     *
20553     * Flips the front and back contents using the @p mode animation. This
20554     * efectively hides the currently visible content and shows the hidden one.
20555     *
20556     * There a number of possible animations to use for the flipping:
20557     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20558     * around a horizontal axis in the middle of its height, the other content
20559     * is shown as the other side of the flip.
20560     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20561     * around a vertical axis in the middle of its width, the other content is
20562     * shown as the other side of the flip.
20563     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20564     * around a diagonal axis in the middle of its width, the other content is
20565     * shown as the other side of the flip.
20566     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20567     * around a diagonal axis in the middle of its height, the other content is
20568     * shown as the other side of the flip.
20569     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20570     * as if the flip was a cube, the other content is show as the right face of
20571     * the cube.
20572     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20573     * right as if the flip was a cube, the other content is show as the left
20574     * face of the cube.
20575     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20576     * flip was a cube, the other content is show as the bottom face of the cube.
20577     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20578     * the flip was a cube, the other content is show as the upper face of the
20579     * cube.
20580     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20581     * if the flip was a book, the other content is shown as the page below that.
20582     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20583     * as if the flip was a book, the other content is shown as the page below
20584     * that.
20585     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20586     * flip was a book, the other content is shown as the page below that.
20587     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20588     * flip was a book, the other content is shown as the page below that.
20589     *
20590     * @image html elm_flip.png
20591     * @image latex elm_flip.eps width=\textwidth
20592     */
20593    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20594    /**
20595     * @brief Set the interactive flip mode
20596     *
20597     * @param obj The flip object
20598     * @param mode The interactive flip mode to use
20599     *
20600     * This sets if the flip should be interactive (allow user to click and
20601     * drag a side of the flip to reveal the back page and cause it to flip).
20602     * By default a flip is not interactive. You may also need to set which
20603     * sides of the flip are "active" for flipping and how much space they use
20604     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20605     * and elm_flip_interacton_direction_hitsize_set()
20606     *
20607     * The four avilable mode of interaction are:
20608     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20609     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20610     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20611     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20612     *
20613     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20614     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20615     * happen, those can only be acheived with elm_flip_go();
20616     */
20617    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20618    /**
20619     * @brief Get the interactive flip mode
20620     *
20621     * @param obj The flip object
20622     * @return The interactive flip mode
20623     *
20624     * Returns the interactive flip mode set by elm_flip_interaction_set()
20625     */
20626    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20627    /**
20628     * @brief Set which directions of the flip respond to interactive flip
20629     *
20630     * @param obj The flip object
20631     * @param dir The direction to change
20632     * @param enabled If that direction is enabled or not
20633     *
20634     * By default all directions are disabled, so you may want to enable the
20635     * desired directions for flipping if you need interactive flipping. You must
20636     * call this function once for each direction that should be enabled.
20637     *
20638     * @see elm_flip_interaction_set()
20639     */
20640    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20641    /**
20642     * @brief Get the enabled state of that flip direction
20643     *
20644     * @param obj The flip object
20645     * @param dir The direction to check
20646     * @return If that direction is enabled or not
20647     *
20648     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20649     *
20650     * @see elm_flip_interaction_set()
20651     */
20652    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20653    /**
20654     * @brief Set the amount of the flip that is sensitive to interactive flip
20655     *
20656     * @param obj The flip object
20657     * @param dir The direction to modify
20658     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20659     *
20660     * Set the amount of the flip that is sensitive to interactive flip, with 0
20661     * representing no area in the flip and 1 representing the entire flip. There
20662     * is however a consideration to be made in that the area will never be
20663     * smaller than the finger size set(as set in your Elementary configuration).
20664     *
20665     * @see elm_flip_interaction_set()
20666     */
20667    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20668    /**
20669     * @brief Get the amount of the flip that is sensitive to interactive flip
20670     *
20671     * @param obj The flip object
20672     * @param dir The direction to check
20673     * @return The size set for that direction
20674     *
20675     * Returns the amount os sensitive area set by
20676     * elm_flip_interacton_direction_hitsize_set().
20677     */
20678    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20679    /**
20680     * @}
20681     */
20682
20683    /* scrolledentry */
20684    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20685    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20686    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20687    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20688    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20689    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20690    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20691    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20692    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20693    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20694    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20695    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20696    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20697    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20698    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20699    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20700    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20701    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20702    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20703    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20704    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20705    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20706    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20707    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20708    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20709    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20710    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20711    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20712    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20713    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20714    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20715    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20716    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20717    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20718    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20719    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);
20720    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20721    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20722    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);
20723    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20724    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);
20725    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20726    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20727    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20728    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20729    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20730    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20731    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20732    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20733    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);
20734    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);
20735    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);
20736    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);
20737    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);
20738    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);
20739    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20740    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20741    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20742    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20743    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20744    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20745    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20746
20747    /**
20748     * @defgroup Conformant Conformant
20749     * @ingroup Elementary
20750     *
20751     * @image html img/widget/conformant/preview-00.png
20752     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20753     *
20754     * @image html img/conformant.png
20755     * @image latex img/conformant.eps width=\textwidth
20756     *
20757     * The aim is to provide a widget that can be used in elementary apps to
20758     * account for space taken up by the indicator, virtual keypad & softkey
20759     * windows when running the illume2 module of E17.
20760     *
20761     * So conformant content will be sized and positioned considering the
20762     * space required for such stuff, and when they popup, as a keyboard
20763     * shows when an entry is selected, conformant content won't change.
20764     *
20765     * Available styles for it:
20766     * - @c "default"
20767     *
20768     * See how to use this widget in this example:
20769     * @ref conformant_example
20770     */
20771
20772    /**
20773     * @addtogroup Conformant
20774     * @{
20775     */
20776
20777    /**
20778     * Add a new conformant widget to the given parent Elementary
20779     * (container) object.
20780     *
20781     * @param parent The parent object.
20782     * @return A new conformant widget handle or @c NULL, on errors.
20783     *
20784     * This function inserts a new conformant widget on the canvas.
20785     *
20786     * @ingroup Conformant
20787     */
20788    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20789
20790    /**
20791     * Set the content of the conformant widget.
20792     *
20793     * @param obj The conformant object.
20794     * @param content The content to be displayed by the conformant.
20795     *
20796     * Content will be sized and positioned considering the space required
20797     * to display a virtual keyboard. So it won't fill all the conformant
20798     * size. This way is possible to be sure that content won't resize
20799     * or be re-positioned after the keyboard is displayed.
20800     *
20801     * Once the content object is set, a previously set one will be deleted.
20802     * If you want to keep that old content object, use the
20803     * elm_conformat_content_unset() function.
20804     *
20805     * @see elm_conformant_content_unset()
20806     * @see elm_conformant_content_get()
20807     *
20808     * @ingroup Conformant
20809     */
20810    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20811
20812    /**
20813     * Get the content of the conformant widget.
20814     *
20815     * @param obj The conformant object.
20816     * @return The content that is being used.
20817     *
20818     * Return the content object which is set for this widget.
20819     * It won't be unparent from conformant. For that, use
20820     * elm_conformant_content_unset().
20821     *
20822     * @see elm_conformant_content_set() for more details.
20823     * @see elm_conformant_content_unset()
20824     *
20825     * @ingroup Conformant
20826     */
20827    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20828
20829    /**
20830     * Unset the content of the conformant widget.
20831     *
20832     * @param obj The conformant object.
20833     * @return The content that was being used.
20834     *
20835     * Unparent and return the content object which was set for this widget.
20836     *
20837     * @see elm_conformant_content_set() for more details.
20838     *
20839     * @ingroup Conformant
20840     */
20841    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20842
20843    /**
20844     * Returns the Evas_Object that represents the content area.
20845     *
20846     * @param obj The conformant object.
20847     * @return The content area of the widget.
20848     *
20849     * @ingroup Conformant
20850     */
20851    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20852
20853    /**
20854     * @}
20855     */
20856
20857    /**
20858     * @defgroup Mapbuf Mapbuf
20859     * @ingroup Elementary
20860     *
20861     * @image html img/widget/mapbuf/preview-00.png
20862     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20863     *
20864     * This holds one content object and uses an Evas Map of transformation
20865     * points to be later used with this content. So the content will be
20866     * moved, resized, etc as a single image. So it will improve performance
20867     * when you have a complex interafce, with a lot of elements, and will
20868     * need to resize or move it frequently (the content object and its
20869     * children).
20870     *
20871     * See how to use this widget in this example:
20872     * @ref mapbuf_example
20873     */
20874
20875    /**
20876     * @addtogroup Mapbuf
20877     * @{
20878     */
20879
20880    /**
20881     * Add a new mapbuf widget to the given parent Elementary
20882     * (container) object.
20883     *
20884     * @param parent The parent object.
20885     * @return A new mapbuf widget handle or @c NULL, on errors.
20886     *
20887     * This function inserts a new mapbuf widget on the canvas.
20888     *
20889     * @ingroup Mapbuf
20890     */
20891    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20892
20893    /**
20894     * Set the content of the mapbuf.
20895     *
20896     * @param obj The mapbuf object.
20897     * @param content The content that will be filled in this mapbuf object.
20898     *
20899     * Once the content object is set, a previously set one will be deleted.
20900     * If you want to keep that old content object, use the
20901     * elm_mapbuf_content_unset() function.
20902     *
20903     * To enable map, elm_mapbuf_enabled_set() should be used.
20904     *
20905     * @ingroup Mapbuf
20906     */
20907    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20908
20909    /**
20910     * Get the content of the mapbuf.
20911     *
20912     * @param obj The mapbuf object.
20913     * @return The content that is being used.
20914     *
20915     * Return the content object which is set for this widget.
20916     *
20917     * @see elm_mapbuf_content_set() for details.
20918     *
20919     * @ingroup Mapbuf
20920     */
20921    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20922
20923    /**
20924     * Unset the content of the mapbuf.
20925     *
20926     * @param obj The mapbuf object.
20927     * @return The content that was being used.
20928     *
20929     * Unparent and return the content object which was set for this widget.
20930     *
20931     * @see elm_mapbuf_content_set() for details.
20932     *
20933     * @ingroup Mapbuf
20934     */
20935    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20936
20937    /**
20938     * Enable or disable the map.
20939     *
20940     * @param obj The mapbuf object.
20941     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20942     *
20943     * This enables the map that is set or disables it. On enable, the object
20944     * geometry will be saved, and the new geometry will change (position and
20945     * size) to reflect the map geometry set.
20946     *
20947     * Also, when enabled, alpha and smooth states will be used, so if the
20948     * content isn't solid, alpha should be enabled, for example, otherwise
20949     * a black retangle will fill the content.
20950     *
20951     * When disabled, the stored map will be freed and geometry prior to
20952     * enabling the map will be restored.
20953     *
20954     * It's disabled by default.
20955     *
20956     * @see elm_mapbuf_alpha_set()
20957     * @see elm_mapbuf_smooth_set()
20958     *
20959     * @ingroup Mapbuf
20960     */
20961    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20962
20963    /**
20964     * Get a value whether map is enabled or not.
20965     *
20966     * @param obj The mapbuf object.
20967     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20968     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20969     *
20970     * @see elm_mapbuf_enabled_set() for details.
20971     *
20972     * @ingroup Mapbuf
20973     */
20974    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20975
20976    /**
20977     * Enable or disable smooth map rendering.
20978     *
20979     * @param obj The mapbuf object.
20980     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20981     * to disable it.
20982     *
20983     * This sets smoothing for map rendering. If the object is a type that has
20984     * its own smoothing settings, then both the smooth settings for this object
20985     * and the map must be turned off.
20986     *
20987     * By default smooth maps are enabled.
20988     *
20989     * @ingroup Mapbuf
20990     */
20991    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20992
20993    /**
20994     * Get a value whether smooth map rendering is enabled or not.
20995     *
20996     * @param obj The mapbuf object.
20997     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20998     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20999     *
21000     * @see elm_mapbuf_smooth_set() for details.
21001     *
21002     * @ingroup Mapbuf
21003     */
21004    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21005
21006    /**
21007     * Set or unset alpha flag for map rendering.
21008     *
21009     * @param obj The mapbuf object.
21010     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
21011     * to disable it.
21012     *
21013     * This sets alpha flag for map rendering. If the object is a type that has
21014     * its own alpha settings, then this will take precedence. Only image objects
21015     * have this currently. It stops alpha blending of the map area, and is
21016     * useful if you know the object and/or all sub-objects is 100% solid.
21017     *
21018     * Alpha is enabled by default.
21019     *
21020     * @ingroup Mapbuf
21021     */
21022    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
21023
21024    /**
21025     * Get a value whether alpha blending is enabled or not.
21026     *
21027     * @param obj The mapbuf object.
21028     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
21029     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21030     *
21031     * @see elm_mapbuf_alpha_set() for details.
21032     *
21033     * @ingroup Mapbuf
21034     */
21035    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21036
21037    /**
21038     * @}
21039     */
21040
21041    /**
21042     * @defgroup Flipselector Flip Selector
21043     *
21044     * @image html img/widget/flipselector/preview-00.png
21045     * @image latex img/widget/flipselector/preview-00.eps
21046     *
21047     * A flip selector is a widget to show a set of @b text items, one
21048     * at a time, with the same sheet switching style as the @ref Clock
21049     * "clock" widget, when one changes the current displaying sheet
21050     * (thus, the "flip" in the name).
21051     *
21052     * User clicks to flip sheets which are @b held for some time will
21053     * make the flip selector to flip continuosly and automatically for
21054     * the user. The interval between flips will keep growing in time,
21055     * so that it helps the user to reach an item which is distant from
21056     * the current selection.
21057     *
21058     * Smart callbacks one can register to:
21059     * - @c "selected" - when the widget's selected text item is changed
21060     * - @c "overflowed" - when the widget's current selection is changed
21061     *   from the first item in its list to the last
21062     * - @c "underflowed" - when the widget's current selection is changed
21063     *   from the last item in its list to the first
21064     *
21065     * Available styles for it:
21066     * - @c "default"
21067     *
21068     * Here is an example on its usage:
21069     * @li @ref flipselector_example
21070     */
21071
21072    /**
21073     * @addtogroup Flipselector
21074     * @{
21075     */
21076
21077    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
21078
21079    /**
21080     * Add a new flip selector widget to the given parent Elementary
21081     * (container) widget
21082     *
21083     * @param parent The parent object
21084     * @return a new flip selector widget handle or @c NULL, on errors
21085     *
21086     * This function inserts a new flip selector widget on the canvas.
21087     *
21088     * @ingroup Flipselector
21089     */
21090    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21091
21092    /**
21093     * Programmatically select the next item of a flip selector widget
21094     *
21095     * @param obj The flipselector object
21096     *
21097     * @note The selection will be animated. Also, if it reaches the
21098     * end of its list of member items, it will continue with the first
21099     * one onwards.
21100     *
21101     * @ingroup Flipselector
21102     */
21103    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21104
21105    /**
21106     * Programmatically select the previous item of a flip selector
21107     * widget
21108     *
21109     * @param obj The flipselector object
21110     *
21111     * @note The selection will be animated.  Also, if it reaches the
21112     * beginning of its list of member items, it will continue with the
21113     * last one backwards.
21114     *
21115     * @ingroup Flipselector
21116     */
21117    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
21118
21119    /**
21120     * Append a (text) item to a flip selector widget
21121     *
21122     * @param obj The flipselector object
21123     * @param label The (text) label of the new item
21124     * @param func Convenience callback function to take place when
21125     * item is selected
21126     * @param data Data passed to @p func, above
21127     * @return A handle to the item added or @c NULL, on errors
21128     *
21129     * The widget's list of labels to show will be appended with the
21130     * given value. If the user wishes so, a callback function pointer
21131     * can be passed, which will get called when this same item is
21132     * selected.
21133     *
21134     * @note The current selection @b won't be modified by appending an
21135     * element to the list.
21136     *
21137     * @note The maximum length of the text label is going to be
21138     * determined <b>by the widget's theme</b>. Strings larger than
21139     * that value are going to be @b truncated.
21140     *
21141     * @ingroup Flipselector
21142     */
21143    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21144
21145    /**
21146     * Prepend a (text) item to a flip selector widget
21147     *
21148     * @param obj The flipselector object
21149     * @param label The (text) label of the new item
21150     * @param func Convenience callback function to take place when
21151     * item is selected
21152     * @param data Data passed to @p func, above
21153     * @return A handle to the item added or @c NULL, on errors
21154     *
21155     * The widget's list of labels to show will be prepended with the
21156     * given value. If the user wishes so, a callback function pointer
21157     * can be passed, which will get called when this same item is
21158     * selected.
21159     *
21160     * @note The current selection @b won't be modified by prepending
21161     * an element to the list.
21162     *
21163     * @note The maximum length of the text label is going to be
21164     * determined <b>by the widget's theme</b>. Strings larger than
21165     * that value are going to be @b truncated.
21166     *
21167     * @ingroup Flipselector
21168     */
21169    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21170
21171    /**
21172     * Get the internal list of items in a given flip selector widget.
21173     *
21174     * @param obj The flipselector object
21175     * @return The list of items (#Elm_Flipselector_Item as data) or
21176     * @c NULL on errors.
21177     *
21178     * This list is @b not to be modified in any way and must not be
21179     * freed. Use the list members with functions like
21180     * elm_flipselector_item_label_set(),
21181     * elm_flipselector_item_label_get(),
21182     * elm_flipselector_item_del(),
21183     * elm_flipselector_item_selected_get(),
21184     * elm_flipselector_item_selected_set().
21185     *
21186     * @warning This list is only valid until @p obj object's internal
21187     * items list is changed. It should be fetched again with another
21188     * call to this function when changes happen.
21189     *
21190     * @ingroup Flipselector
21191     */
21192    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21193
21194    /**
21195     * Get the first item in the given flip selector widget's list of
21196     * items.
21197     *
21198     * @param obj The flipselector object
21199     * @return The first item or @c NULL, if it has no items (and on
21200     * errors)
21201     *
21202     * @see elm_flipselector_item_append()
21203     * @see elm_flipselector_last_item_get()
21204     *
21205     * @ingroup Flipselector
21206     */
21207    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21208
21209    /**
21210     * Get the last item in the given flip selector widget's list of
21211     * items.
21212     *
21213     * @param obj The flipselector object
21214     * @return The last item or @c NULL, if it has no items (and on
21215     * errors)
21216     *
21217     * @see elm_flipselector_item_prepend()
21218     * @see elm_flipselector_first_item_get()
21219     *
21220     * @ingroup Flipselector
21221     */
21222    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21223
21224    /**
21225     * Get the currently selected item in a flip selector widget.
21226     *
21227     * @param obj The flipselector object
21228     * @return The selected item or @c NULL, if the widget has no items
21229     * (and on erros)
21230     *
21231     * @ingroup Flipselector
21232     */
21233    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21234
21235    /**
21236     * Set whether a given flip selector widget's item should be the
21237     * currently selected one.
21238     *
21239     * @param item The flip selector item
21240     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
21241     *
21242     * This sets whether @p item is or not the selected (thus, under
21243     * display) one. If @p item is different than one under display,
21244     * the latter will be unselected. If the @p item is set to be
21245     * unselected, on the other hand, the @b first item in the widget's
21246     * internal members list will be the new selected one.
21247     *
21248     * @see elm_flipselector_item_selected_get()
21249     *
21250     * @ingroup Flipselector
21251     */
21252    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
21253
21254    /**
21255     * Get whether a given flip selector widget's item is the currently
21256     * selected one.
21257     *
21258     * @param item The flip selector item
21259     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
21260     * (or on errors).
21261     *
21262     * @see elm_flipselector_item_selected_set()
21263     *
21264     * @ingroup Flipselector
21265     */
21266    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21267
21268    /**
21269     * Delete a given item from a flip selector widget.
21270     *
21271     * @param item The item to delete
21272     *
21273     * @ingroup Flipselector
21274     */
21275    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21276
21277    /**
21278     * Get the label of a given flip selector widget's item.
21279     *
21280     * @param item The item to get label from
21281     * @return The text label of @p item or @c NULL, on errors
21282     *
21283     * @see elm_flipselector_item_label_set()
21284     *
21285     * @ingroup Flipselector
21286     */
21287    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21288
21289    /**
21290     * Set the label of a given flip selector widget's item.
21291     *
21292     * @param item The item to set label on
21293     * @param label The text label string, in UTF-8 encoding
21294     *
21295     * @see elm_flipselector_item_label_get()
21296     *
21297     * @ingroup Flipselector
21298     */
21299    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
21300
21301    /**
21302     * Gets the item before @p item in a flip selector widget's
21303     * internal list of items.
21304     *
21305     * @param item The item to fetch previous from
21306     * @return The item before the @p item, in its parent's list. If
21307     *         there is no previous item for @p item or there's an
21308     *         error, @c NULL is returned.
21309     *
21310     * @see elm_flipselector_item_next_get()
21311     *
21312     * @ingroup Flipselector
21313     */
21314    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21315
21316    /**
21317     * Gets the item after @p item in a flip selector widget's
21318     * internal list of items.
21319     *
21320     * @param item The item to fetch next from
21321     * @return The item after the @p item, in its parent's list. If
21322     *         there is no next item for @p item or there's an
21323     *         error, @c NULL is returned.
21324     *
21325     * @see elm_flipselector_item_next_get()
21326     *
21327     * @ingroup Flipselector
21328     */
21329    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21330
21331    /**
21332     * Set the interval on time updates for an user mouse button hold
21333     * on a flip selector widget.
21334     *
21335     * @param obj The flip selector object
21336     * @param interval The (first) interval value in seconds
21337     *
21338     * This interval value is @b decreased while the user holds the
21339     * mouse pointer either flipping up or flipping doww a given flip
21340     * selector.
21341     *
21342     * This helps the user to get to a given item distant from the
21343     * current one easier/faster, as it will start to flip quicker and
21344     * quicker on mouse button holds.
21345     *
21346     * The calculation for the next flip interval value, starting from
21347     * the one set with this call, is the previous interval divided by
21348     * 1.05, so it decreases a little bit.
21349     *
21350     * The default starting interval value for automatic flips is
21351     * @b 0.85 seconds.
21352     *
21353     * @see elm_flipselector_interval_get()
21354     *
21355     * @ingroup Flipselector
21356     */
21357    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21358
21359    /**
21360     * Get the interval on time updates for an user mouse button hold
21361     * on a flip selector widget.
21362     *
21363     * @param obj The flip selector object
21364     * @return The (first) interval value, in seconds, set on it
21365     *
21366     * @see elm_flipselector_interval_set() for more details
21367     *
21368     * @ingroup Flipselector
21369     */
21370    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21371
21372    /**
21373     * @addtogroup Calendar
21374     * @{
21375     */
21376
21377    /**
21378     * @enum _Elm_Calendar_Mark_Repeat
21379     * @typedef Elm_Calendar_Mark_Repeat
21380     *
21381     * Event periodicity, used to define if a mark should be repeated
21382     * @b beyond event's day. It's set when a mark is added.
21383     *
21384     * So, for a mark added to 13th May with periodicity set to WEEKLY,
21385     * there will be marks every week after this date. Marks will be displayed
21386     * at 13th, 20th, 27th, 3rd June ...
21387     *
21388     * Values don't work as bitmask, only one can be choosen.
21389     *
21390     * @see elm_calendar_mark_add()
21391     *
21392     * @ingroup Calendar
21393     */
21394    typedef enum _Elm_Calendar_Mark_Repeat
21395      {
21396         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21397         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21398         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21399         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*/
21400         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. */
21401      } Elm_Calendar_Mark_Repeat;
21402
21403    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(). */
21404
21405    /**
21406     * Add a new calendar widget to the given parent Elementary
21407     * (container) object.
21408     *
21409     * @param parent The parent object.
21410     * @return a new calendar widget handle or @c NULL, on errors.
21411     *
21412     * This function inserts a new calendar widget on the canvas.
21413     *
21414     * @ref calendar_example_01
21415     *
21416     * @ingroup Calendar
21417     */
21418    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21419
21420    /**
21421     * Get weekdays names displayed by the calendar.
21422     *
21423     * @param obj The calendar object.
21424     * @return Array of seven strings to be used as weekday names.
21425     *
21426     * By default, weekdays abbreviations get from system are displayed:
21427     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21428     * The first string is related to Sunday, the second to Monday...
21429     *
21430     * @see elm_calendar_weekdays_name_set()
21431     *
21432     * @ref calendar_example_05
21433     *
21434     * @ingroup Calendar
21435     */
21436    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21437
21438    /**
21439     * Set weekdays names to be displayed by the calendar.
21440     *
21441     * @param obj The calendar object.
21442     * @param weekdays Array of seven strings to be used as weekday names.
21443     * @warning It must have 7 elements, or it will access invalid memory.
21444     * @warning The strings must be NULL terminated ('@\0').
21445     *
21446     * By default, weekdays abbreviations get from system are displayed:
21447     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21448     *
21449     * The first string should be related to Sunday, the second to Monday...
21450     *
21451     * The usage should be like this:
21452     * @code
21453     *   const char *weekdays[] =
21454     *   {
21455     *      "Sunday", "Monday", "Tuesday", "Wednesday",
21456     *      "Thursday", "Friday", "Saturday"
21457     *   };
21458     *   elm_calendar_weekdays_names_set(calendar, weekdays);
21459     * @endcode
21460     *
21461     * @see elm_calendar_weekdays_name_get()
21462     *
21463     * @ref calendar_example_02
21464     *
21465     * @ingroup Calendar
21466     */
21467    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21468
21469    /**
21470     * Set the minimum and maximum values for the year
21471     *
21472     * @param obj The calendar object
21473     * @param min The minimum year, greater than 1901;
21474     * @param max The maximum year;
21475     *
21476     * Maximum must be greater than minimum, except if you don't wan't to set
21477     * maximum year.
21478     * Default values are 1902 and -1.
21479     *
21480     * If the maximum year is a negative value, it will be limited depending
21481     * on the platform architecture (year 2037 for 32 bits);
21482     *
21483     * @see elm_calendar_min_max_year_get()
21484     *
21485     * @ref calendar_example_03
21486     *
21487     * @ingroup Calendar
21488     */
21489    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21490
21491    /**
21492     * Get the minimum and maximum values for the year
21493     *
21494     * @param obj The calendar object.
21495     * @param min The minimum year.
21496     * @param max The maximum year.
21497     *
21498     * Default values are 1902 and -1.
21499     *
21500     * @see elm_calendar_min_max_year_get() for more details.
21501     *
21502     * @ref calendar_example_05
21503     *
21504     * @ingroup Calendar
21505     */
21506    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21507
21508    /**
21509     * Enable or disable day selection
21510     *
21511     * @param obj The calendar object.
21512     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21513     * disable it.
21514     *
21515     * Enabled by default. If disabled, the user still can select months,
21516     * but not days. Selected days are highlighted on calendar.
21517     * It should be used if you won't need such selection for the widget usage.
21518     *
21519     * When a day is selected, or month is changed, smart callbacks for
21520     * signal "changed" will be called.
21521     *
21522     * @see elm_calendar_day_selection_enable_get()
21523     *
21524     * @ref calendar_example_04
21525     *
21526     * @ingroup Calendar
21527     */
21528    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21529
21530    /**
21531     * Get a value whether day selection is enabled or not.
21532     *
21533     * @see elm_calendar_day_selection_enable_set() for details.
21534     *
21535     * @param obj The calendar object.
21536     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21537     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21538     *
21539     * @ref calendar_example_05
21540     *
21541     * @ingroup Calendar
21542     */
21543    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21544
21545
21546    /**
21547     * Set selected date to be highlighted on calendar.
21548     *
21549     * @param obj The calendar object.
21550     * @param selected_time A @b tm struct to represent the selected date.
21551     *
21552     * Set the selected date, changing the displayed month if needed.
21553     * Selected date changes when the user goes to next/previous month or
21554     * select a day pressing over it on calendar.
21555     *
21556     * @see elm_calendar_selected_time_get()
21557     *
21558     * @ref calendar_example_04
21559     *
21560     * @ingroup Calendar
21561     */
21562    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21563
21564    /**
21565     * Get selected date.
21566     *
21567     * @param obj The calendar object
21568     * @param selected_time A @b tm struct to point to selected date
21569     * @return EINA_FALSE means an error ocurred and returned time shouldn't
21570     * be considered.
21571     *
21572     * Get date selected by the user or set by function
21573     * elm_calendar_selected_time_set().
21574     * Selected date changes when the user goes to next/previous month or
21575     * select a day pressing over it on calendar.
21576     *
21577     * @see elm_calendar_selected_time_get()
21578     *
21579     * @ref calendar_example_05
21580     *
21581     * @ingroup Calendar
21582     */
21583    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21584
21585    /**
21586     * Set a function to format the string that will be used to display
21587     * month and year;
21588     *
21589     * @param obj The calendar object
21590     * @param format_function Function to set the month-year string given
21591     * the selected date
21592     *
21593     * By default it uses strftime with "%B %Y" format string.
21594     * It should allocate the memory that will be used by the string,
21595     * that will be freed by the widget after usage.
21596     * A pointer to the string and a pointer to the time struct will be provided.
21597     *
21598     * Example:
21599     * @code
21600     * static char *
21601     * _format_month_year(struct tm *selected_time)
21602     * {
21603     *    char buf[32];
21604     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21605     *    return strdup(buf);
21606     * }
21607     *
21608     * elm_calendar_format_function_set(calendar, _format_month_year);
21609     * @endcode
21610     *
21611     * @ref calendar_example_02
21612     *
21613     * @ingroup Calendar
21614     */
21615    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21616
21617    /**
21618     * Add a new mark to the calendar
21619     *
21620     * @param obj The calendar object
21621     * @param mark_type A string used to define the type of mark. It will be
21622     * emitted to the theme, that should display a related modification on these
21623     * days representation.
21624     * @param mark_time A time struct to represent the date of inclusion of the
21625     * mark. For marks that repeats it will just be displayed after the inclusion
21626     * date in the calendar.
21627     * @param repeat Repeat the event following this periodicity. Can be a unique
21628     * mark (that don't repeat), daily, weekly, monthly or annually.
21629     * @return The created mark or @p NULL upon failure.
21630     *
21631     * Add a mark that will be drawn in the calendar respecting the insertion
21632     * time and periodicity. It will emit the type as signal to the widget theme.
21633     * Default theme supports "holiday" and "checked", but it can be extended.
21634     *
21635     * It won't immediately update the calendar, drawing the marks.
21636     * For this, call elm_calendar_marks_draw(). However, when user selects
21637     * next or previous month calendar forces marks drawn.
21638     *
21639     * Marks created with this method can be deleted with
21640     * elm_calendar_mark_del().
21641     *
21642     * Example
21643     * @code
21644     * struct tm selected_time;
21645     * time_t current_time;
21646     *
21647     * current_time = time(NULL) + 5 * 84600;
21648     * localtime_r(&current_time, &selected_time);
21649     * elm_calendar_mark_add(cal, "holiday", selected_time,
21650     *     ELM_CALENDAR_ANNUALLY);
21651     *
21652     * current_time = time(NULL) + 1 * 84600;
21653     * localtime_r(&current_time, &selected_time);
21654     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21655     *
21656     * elm_calendar_marks_draw(cal);
21657     * @endcode
21658     *
21659     * @see elm_calendar_marks_draw()
21660     * @see elm_calendar_mark_del()
21661     *
21662     * @ref calendar_example_06
21663     *
21664     * @ingroup Calendar
21665     */
21666    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);
21667
21668    /**
21669     * Delete mark from the calendar.
21670     *
21671     * @param mark The mark to be deleted.
21672     *
21673     * If deleting all calendar marks is required, elm_calendar_marks_clear()
21674     * should be used instead of getting marks list and deleting each one.
21675     *
21676     * @see elm_calendar_mark_add()
21677     *
21678     * @ref calendar_example_06
21679     *
21680     * @ingroup Calendar
21681     */
21682    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21683
21684    /**
21685     * Remove all calendar's marks
21686     *
21687     * @param obj The calendar object.
21688     *
21689     * @see elm_calendar_mark_add()
21690     * @see elm_calendar_mark_del()
21691     *
21692     * @ingroup Calendar
21693     */
21694    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21695
21696
21697    /**
21698     * Get a list of all the calendar marks.
21699     *
21700     * @param obj The calendar object.
21701     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21702     *
21703     * @see elm_calendar_mark_add()
21704     * @see elm_calendar_mark_del()
21705     * @see elm_calendar_marks_clear()
21706     *
21707     * @ingroup Calendar
21708     */
21709    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21710
21711    /**
21712     * Draw calendar marks.
21713     *
21714     * @param obj The calendar object.
21715     *
21716     * Should be used after adding, removing or clearing marks.
21717     * It will go through the entire marks list updating the calendar.
21718     * If lots of marks will be added, add all the marks and then call
21719     * this function.
21720     *
21721     * When the month is changed, i.e. user selects next or previous month,
21722     * marks will be drawed.
21723     *
21724     * @see elm_calendar_mark_add()
21725     * @see elm_calendar_mark_del()
21726     * @see elm_calendar_marks_clear()
21727     *
21728     * @ref calendar_example_06
21729     *
21730     * @ingroup Calendar
21731     */
21732    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21733
21734    /**
21735     * Set a day text color to the same that represents Saturdays.
21736     *
21737     * @param obj The calendar object.
21738     * @param pos The text position. Position is the cell counter, from left
21739     * to right, up to down. It starts on 0 and ends on 41.
21740     *
21741     * @deprecated use elm_calendar_mark_add() instead like:
21742     *
21743     * @code
21744     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21745     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21746     * @endcode
21747     *
21748     * @see elm_calendar_mark_add()
21749     *
21750     * @ingroup Calendar
21751     */
21752    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21753
21754    /**
21755     * Set a day text color to the same that represents Sundays.
21756     *
21757     * @param obj The calendar object.
21758     * @param pos The text position. Position is the cell counter, from left
21759     * to right, up to down. It starts on 0 and ends on 41.
21760
21761     * @deprecated use elm_calendar_mark_add() instead like:
21762     *
21763     * @code
21764     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21765     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21766     * @endcode
21767     *
21768     * @see elm_calendar_mark_add()
21769     *
21770     * @ingroup Calendar
21771     */
21772    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21773
21774    /**
21775     * Set a day text color to the same that represents Weekdays.
21776     *
21777     * @param obj The calendar object
21778     * @param pos The text position. Position is the cell counter, from left
21779     * to right, up to down. It starts on 0 and ends on 41.
21780     *
21781     * @deprecated use elm_calendar_mark_add() instead like:
21782     *
21783     * @code
21784     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21785     *
21786     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21787     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21788     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21789     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21790     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21791     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21792     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21793     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21794     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21795     * @endcode
21796     *
21797     * @see elm_calendar_mark_add()
21798     *
21799     * @ingroup Calendar
21800     */
21801    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21802
21803    /**
21804     * Set the interval on time updates for an user mouse button hold
21805     * on calendar widgets' month selection.
21806     *
21807     * @param obj The calendar object
21808     * @param interval The (first) interval value in seconds
21809     *
21810     * This interval value is @b decreased while the user holds the
21811     * mouse pointer either selecting next or previous month.
21812     *
21813     * This helps the user to get to a given month distant from the
21814     * current one easier/faster, as it will start to change quicker and
21815     * quicker on mouse button holds.
21816     *
21817     * The calculation for the next change interval value, starting from
21818     * the one set with this call, is the previous interval divided by
21819     * 1.05, so it decreases a little bit.
21820     *
21821     * The default starting interval value for automatic changes is
21822     * @b 0.85 seconds.
21823     *
21824     * @see elm_calendar_interval_get()
21825     *
21826     * @ingroup Calendar
21827     */
21828    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21829
21830    /**
21831     * Get the interval on time updates for an user mouse button hold
21832     * on calendar widgets' month selection.
21833     *
21834     * @param obj The calendar object
21835     * @return The (first) interval value, in seconds, set on it
21836     *
21837     * @see elm_calendar_interval_set() for more details
21838     *
21839     * @ingroup Calendar
21840     */
21841    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21842
21843    /**
21844     * @}
21845     */
21846
21847    /**
21848     * @defgroup Diskselector Diskselector
21849     * @ingroup Elementary
21850     *
21851     * @image html img/widget/diskselector/preview-00.png
21852     * @image latex img/widget/diskselector/preview-00.eps
21853     *
21854     * A diskselector is a kind of list widget. It scrolls horizontally,
21855     * and can contain label and icon objects. Three items are displayed
21856     * with the selected one in the middle.
21857     *
21858     * It can act like a circular list with round mode and labels can be
21859     * reduced for a defined length for side items.
21860     *
21861     * Smart callbacks one can listen to:
21862     * - "selected" - when item is selected, i.e. scroller stops.
21863     *
21864     * Available styles for it:
21865     * - @c "default"
21866     *
21867     * List of examples:
21868     * @li @ref diskselector_example_01
21869     * @li @ref diskselector_example_02
21870     */
21871
21872    /**
21873     * @addtogroup Diskselector
21874     * @{
21875     */
21876
21877    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(). */
21878
21879    /**
21880     * Add a new diskselector widget to the given parent Elementary
21881     * (container) object.
21882     *
21883     * @param parent The parent object.
21884     * @return a new diskselector widget handle or @c NULL, on errors.
21885     *
21886     * This function inserts a new diskselector widget on the canvas.
21887     *
21888     * @ingroup Diskselector
21889     */
21890    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21891
21892    /**
21893     * Enable or disable round mode.
21894     *
21895     * @param obj The diskselector object.
21896     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21897     * disable it.
21898     *
21899     * Disabled by default. If round mode is enabled the items list will
21900     * work like a circle list, so when the user reaches the last item,
21901     * the first one will popup.
21902     *
21903     * @see elm_diskselector_round_get()
21904     *
21905     * @ingroup Diskselector
21906     */
21907    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21908
21909    /**
21910     * Get a value whether round mode is enabled or not.
21911     *
21912     * @see elm_diskselector_round_set() for details.
21913     *
21914     * @param obj The diskselector object.
21915     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21916     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21917     *
21918     * @ingroup Diskselector
21919     */
21920    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21921
21922    /**
21923     * Get the side labels max length.
21924     *
21925     * @deprecated use elm_diskselector_side_label_length_get() instead:
21926     *
21927     * @param obj The diskselector object.
21928     * @return The max length defined for side labels, or 0 if not a valid
21929     * diskselector.
21930     *
21931     * @ingroup Diskselector
21932     */
21933    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21934
21935    /**
21936     * Set the side labels max length.
21937     *
21938     * @deprecated use elm_diskselector_side_label_length_set() instead:
21939     *
21940     * @param obj The diskselector object.
21941     * @param len The max length defined for side labels.
21942     *
21943     * @ingroup Diskselector
21944     */
21945    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21946
21947    /**
21948     * Get the side labels max length.
21949     *
21950     * @see elm_diskselector_side_label_length_set() for details.
21951     *
21952     * @param obj The diskselector object.
21953     * @return The max length defined for side labels, or 0 if not a valid
21954     * diskselector.
21955     *
21956     * @ingroup Diskselector
21957     */
21958    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21959
21960    /**
21961     * Set the side labels max length.
21962     *
21963     * @param obj The diskselector object.
21964     * @param len The max length defined for side labels.
21965     *
21966     * Length is the number of characters of items' label that will be
21967     * visible when it's set on side positions. It will just crop
21968     * the string after defined size. E.g.:
21969     *
21970     * An item with label "January" would be displayed on side position as
21971     * "Jan" if max length is set to 3, or "Janu", if this property
21972     * is set to 4.
21973     *
21974     * When it's selected, the entire label will be displayed, except for
21975     * width restrictions. In this case label will be cropped and "..."
21976     * will be concatenated.
21977     *
21978     * Default side label max length is 3.
21979     *
21980     * This property will be applyed over all items, included before or
21981     * later this function call.
21982     *
21983     * @ingroup Diskselector
21984     */
21985    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21986
21987    /**
21988     * Set the number of items to be displayed.
21989     *
21990     * @param obj The diskselector object.
21991     * @param num The number of items the diskselector will display.
21992     *
21993     * Default value is 3, and also it's the minimun. If @p num is less
21994     * than 3, it will be set to 3.
21995     *
21996     * Also, it can be set on theme, using data item @c display_item_num
21997     * on group "elm/diskselector/item/X", where X is style set.
21998     * E.g.:
21999     *
22000     * group { name: "elm/diskselector/item/X";
22001     * data {
22002     *     item: "display_item_num" "5";
22003     *     }
22004     *
22005     * @ingroup Diskselector
22006     */
22007    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
22008
22009    /**
22010     * Set bouncing behaviour when the scrolled content reaches an edge.
22011     *
22012     * Tell the internal scroller object whether it should bounce or not
22013     * when it reaches the respective edges for each axis.
22014     *
22015     * @param obj The diskselector object.
22016     * @param h_bounce Whether to bounce or not in the horizontal axis.
22017     * @param v_bounce Whether to bounce or not in the vertical axis.
22018     *
22019     * @see elm_scroller_bounce_set()
22020     *
22021     * @ingroup Diskselector
22022     */
22023    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22024
22025    /**
22026     * Get the bouncing behaviour of the internal scroller.
22027     *
22028     * Get whether the internal scroller should bounce when the edge of each
22029     * axis is reached scrolling.
22030     *
22031     * @param obj The diskselector object.
22032     * @param h_bounce Pointer where to store the bounce state of the horizontal
22033     * axis.
22034     * @param v_bounce Pointer where to store the bounce state of the vertical
22035     * axis.
22036     *
22037     * @see elm_scroller_bounce_get()
22038     * @see elm_diskselector_bounce_set()
22039     *
22040     * @ingroup Diskselector
22041     */
22042    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22043
22044    /**
22045     * Get the scrollbar policy.
22046     *
22047     * @see elm_diskselector_scroller_policy_get() for details.
22048     *
22049     * @param obj The diskselector object.
22050     * @param policy_h Pointer where to store horizontal scrollbar policy.
22051     * @param policy_v Pointer where to store vertical scrollbar policy.
22052     *
22053     * @ingroup Diskselector
22054     */
22055    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);
22056
22057    /**
22058     * Set the scrollbar policy.
22059     *
22060     * @param obj The diskselector object.
22061     * @param policy_h Horizontal scrollbar policy.
22062     * @param policy_v Vertical scrollbar policy.
22063     *
22064     * This sets the scrollbar visibility policy for the given scroller.
22065     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
22066     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
22067     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
22068     * This applies respectively for the horizontal and vertical scrollbars.
22069     *
22070     * The both are disabled by default, i.e., are set to
22071     * #ELM_SCROLLER_POLICY_OFF.
22072     *
22073     * @ingroup Diskselector
22074     */
22075    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
22076
22077    /**
22078     * Remove all diskselector's items.
22079     *
22080     * @param obj The diskselector object.
22081     *
22082     * @see elm_diskselector_item_del()
22083     * @see elm_diskselector_item_append()
22084     *
22085     * @ingroup Diskselector
22086     */
22087    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22088
22089    /**
22090     * Get a list of all the diskselector items.
22091     *
22092     * @param obj The diskselector object.
22093     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22094     * or @c NULL on failure.
22095     *
22096     * @see elm_diskselector_item_append()
22097     * @see elm_diskselector_item_del()
22098     * @see elm_diskselector_clear()
22099     *
22100     * @ingroup Diskselector
22101     */
22102    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22103
22104    /**
22105     * Appends a new item to the diskselector object.
22106     *
22107     * @param obj The diskselector object.
22108     * @param label The label of the diskselector item.
22109     * @param icon The icon object to use at left side of the item. An
22110     * icon can be any Evas object, but usually it is an icon created
22111     * with elm_icon_add().
22112     * @param func The function to call when the item is selected.
22113     * @param data The data to associate with the item for related callbacks.
22114     *
22115     * @return The created item or @c NULL upon failure.
22116     *
22117     * A new item will be created and appended to the diskselector, i.e., will
22118     * be set as last item. Also, if there is no selected item, it will
22119     * be selected. This will always happens for the first appended item.
22120     *
22121     * If no icon is set, label will be centered on item position, otherwise
22122     * the icon will be placed at left of the label, that will be shifted
22123     * to the right.
22124     *
22125     * Items created with this method can be deleted with
22126     * elm_diskselector_item_del().
22127     *
22128     * Associated @p data can be properly freed when item is deleted if a
22129     * callback function is set with elm_diskselector_item_del_cb_set().
22130     *
22131     * If a function is passed as argument, it will be called everytime this item
22132     * is selected, i.e., the user stops the diskselector with this
22133     * item on center position. If such function isn't needed, just passing
22134     * @c NULL as @p func is enough. The same should be done for @p data.
22135     *
22136     * Simple example (with no function callback or data associated):
22137     * @code
22138     * disk = elm_diskselector_add(win);
22139     * ic = elm_icon_add(win);
22140     * elm_icon_file_set(ic, "path/to/image", NULL);
22141     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22142     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22143     * @endcode
22144     *
22145     * @see elm_diskselector_item_del()
22146     * @see elm_diskselector_item_del_cb_set()
22147     * @see elm_diskselector_clear()
22148     * @see elm_icon_add()
22149     *
22150     * @ingroup Diskselector
22151     */
22152    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);
22153
22154
22155    /**
22156     * Delete them item from the diskselector.
22157     *
22158     * @param it The item of diskselector to be deleted.
22159     *
22160     * If deleting all diskselector items is required, elm_diskselector_clear()
22161     * should be used instead of getting items list and deleting each one.
22162     *
22163     * @see elm_diskselector_clear()
22164     * @see elm_diskselector_item_append()
22165     * @see elm_diskselector_item_del_cb_set()
22166     *
22167     * @ingroup Diskselector
22168     */
22169    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22170
22171    /**
22172     * Set the function called when a diskselector item is freed.
22173     *
22174     * @param it The item to set the callback on
22175     * @param func The function called
22176     *
22177     * If there is a @p func, then it will be called prior item's memory release.
22178     * That will be called with the following arguments:
22179     * @li item's data;
22180     * @li item's Evas object;
22181     * @li item itself;
22182     *
22183     * This way, a data associated to a diskselector item could be properly
22184     * freed.
22185     *
22186     * @ingroup Diskselector
22187     */
22188    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22189
22190    /**
22191     * Get the data associated to the item.
22192     *
22193     * @param it The diskselector item
22194     * @return The data associated to @p it
22195     *
22196     * The return value is a pointer to data associated to @p item when it was
22197     * created, with function elm_diskselector_item_append(). If no data
22198     * was passed as argument, it will return @c NULL.
22199     *
22200     * @see elm_diskselector_item_append()
22201     *
22202     * @ingroup Diskselector
22203     */
22204    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22205
22206    /**
22207     * Set the icon associated to the item.
22208     *
22209     * @param it The diskselector item
22210     * @param icon The icon object to associate with @p it
22211     *
22212     * The icon object to use at left side of the item. An
22213     * icon can be any Evas object, but usually it is an icon created
22214     * with elm_icon_add().
22215     *
22216     * Once the icon object is set, a previously set one will be deleted.
22217     * @warning Setting the same icon for two items will cause the icon to
22218     * dissapear from the first item.
22219     *
22220     * If an icon was passed as argument on item creation, with function
22221     * elm_diskselector_item_append(), it will be already
22222     * associated to the item.
22223     *
22224     * @see elm_diskselector_item_append()
22225     * @see elm_diskselector_item_icon_get()
22226     *
22227     * @ingroup Diskselector
22228     */
22229    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22230
22231    /**
22232     * Get the icon associated to the item.
22233     *
22234     * @param it The diskselector item
22235     * @return The icon associated to @p it
22236     *
22237     * The return value is a pointer to the icon associated to @p item when it was
22238     * created, with function elm_diskselector_item_append(), or later
22239     * with function elm_diskselector_item_icon_set. If no icon
22240     * was passed as argument, it will return @c NULL.
22241     *
22242     * @see elm_diskselector_item_append()
22243     * @see elm_diskselector_item_icon_set()
22244     *
22245     * @ingroup Diskselector
22246     */
22247    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22248
22249    /**
22250     * Set the label of item.
22251     *
22252     * @param it The item of diskselector.
22253     * @param label The label of item.
22254     *
22255     * The label to be displayed by the item.
22256     *
22257     * If no icon is set, label will be centered on item position, otherwise
22258     * the icon will be placed at left of the label, that will be shifted
22259     * to the right.
22260     *
22261     * An item with label "January" would be displayed on side position as
22262     * "Jan" if max length is set to 3 with function
22263     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22264     * is set to 4.
22265     *
22266     * When this @p item is selected, the entire label will be displayed,
22267     * except for width restrictions.
22268     * In this case label will be cropped and "..." will be concatenated,
22269     * but only for display purposes. It will keep the entire string, so
22270     * if diskselector is resized the remaining characters will be displayed.
22271     *
22272     * If a label was passed as argument on item creation, with function
22273     * elm_diskselector_item_append(), it will be already
22274     * displayed by the item.
22275     *
22276     * @see elm_diskselector_side_label_lenght_set()
22277     * @see elm_diskselector_item_label_get()
22278     * @see elm_diskselector_item_append()
22279     *
22280     * @ingroup Diskselector
22281     */
22282    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22283
22284    /**
22285     * Get the label of item.
22286     *
22287     * @param it The item of diskselector.
22288     * @return The label of item.
22289     *
22290     * The return value is a pointer to the label associated to @p item when it was
22291     * created, with function elm_diskselector_item_append(), or later
22292     * with function elm_diskselector_item_label_set. If no label
22293     * was passed as argument, it will return @c NULL.
22294     *
22295     * @see elm_diskselector_item_label_set() for more details.
22296     * @see elm_diskselector_item_append()
22297     *
22298     * @ingroup Diskselector
22299     */
22300    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22301
22302    /**
22303     * Get the selected item.
22304     *
22305     * @param obj The diskselector object.
22306     * @return The selected diskselector item.
22307     *
22308     * The selected item can be unselected with function
22309     * elm_diskselector_item_selected_set(), and the first item of
22310     * diskselector will be selected.
22311     *
22312     * The selected item always will be centered on diskselector, with
22313     * full label displayed, i.e., max lenght set to side labels won't
22314     * apply on the selected item. More details on
22315     * elm_diskselector_side_label_length_set().
22316     *
22317     * @ingroup Diskselector
22318     */
22319    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22320
22321    /**
22322     * Set the selected state of an item.
22323     *
22324     * @param it The diskselector item
22325     * @param selected The selected state
22326     *
22327     * This sets the selected state of the given item @p it.
22328     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22329     *
22330     * If a new item is selected the previosly selected will be unselected.
22331     * Previoulsy selected item can be get with function
22332     * elm_diskselector_selected_item_get().
22333     *
22334     * If the item @p it is unselected, the first item of diskselector will
22335     * be selected.
22336     *
22337     * Selected items will be visible on center position of diskselector.
22338     * So if it was on another position before selected, or was invisible,
22339     * diskselector will animate items until the selected item reaches center
22340     * position.
22341     *
22342     * @see elm_diskselector_item_selected_get()
22343     * @see elm_diskselector_selected_item_get()
22344     *
22345     * @ingroup Diskselector
22346     */
22347    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22348
22349    /*
22350     * Get whether the @p item is selected or not.
22351     *
22352     * @param it The diskselector item.
22353     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22354     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22355     *
22356     * @see elm_diskselector_selected_item_set() for details.
22357     * @see elm_diskselector_item_selected_get()
22358     *
22359     * @ingroup Diskselector
22360     */
22361    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22362
22363    /**
22364     * Get the first item of the diskselector.
22365     *
22366     * @param obj The diskselector object.
22367     * @return The first item, or @c NULL if none.
22368     *
22369     * The list of items follows append order. So it will return the first
22370     * item appended to the widget that wasn't deleted.
22371     *
22372     * @see elm_diskselector_item_append()
22373     * @see elm_diskselector_items_get()
22374     *
22375     * @ingroup Diskselector
22376     */
22377    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22378
22379    /**
22380     * Get the last item of the diskselector.
22381     *
22382     * @param obj The diskselector object.
22383     * @return The last item, or @c NULL if none.
22384     *
22385     * The list of items follows append order. So it will return last first
22386     * item appended to the widget that wasn't deleted.
22387     *
22388     * @see elm_diskselector_item_append()
22389     * @see elm_diskselector_items_get()
22390     *
22391     * @ingroup Diskselector
22392     */
22393    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22394
22395    /**
22396     * Get the item before @p item in diskselector.
22397     *
22398     * @param it The diskselector item.
22399     * @return The item before @p item, or @c NULL if none or on failure.
22400     *
22401     * The list of items follows append order. So it will return item appended
22402     * just before @p item and that wasn't deleted.
22403     *
22404     * If it is the first item, @c NULL will be returned.
22405     * First item can be get by elm_diskselector_first_item_get().
22406     *
22407     * @see elm_diskselector_item_append()
22408     * @see elm_diskselector_items_get()
22409     *
22410     * @ingroup Diskselector
22411     */
22412    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22413
22414    /**
22415     * Get the item after @p item in diskselector.
22416     *
22417     * @param it The diskselector item.
22418     * @return The item after @p item, or @c NULL if none or on failure.
22419     *
22420     * The list of items follows append order. So it will return item appended
22421     * just after @p item and that wasn't deleted.
22422     *
22423     * If it is the last item, @c NULL will be returned.
22424     * Last item can be get by elm_diskselector_last_item_get().
22425     *
22426     * @see elm_diskselector_item_append()
22427     * @see elm_diskselector_items_get()
22428     *
22429     * @ingroup Diskselector
22430     */
22431    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22432
22433    /**
22434     * Set the text to be shown in the diskselector item.
22435     *
22436     * @param item Target item
22437     * @param text The text to set in the content
22438     *
22439     * Setup the text as tooltip to object. The item can have only one tooltip,
22440     * so any previous tooltip data is removed.
22441     *
22442     * @see elm_object_tooltip_text_set() for more details.
22443     *
22444     * @ingroup Diskselector
22445     */
22446    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22447
22448    /**
22449     * Set the content to be shown in the tooltip item.
22450     *
22451     * Setup the tooltip to item. The item can have only one tooltip,
22452     * so any previous tooltip data is removed. @p func(with @p data) will
22453     * be called every time that need show the tooltip and it should
22454     * return a valid Evas_Object. This object is then managed fully by
22455     * tooltip system and is deleted when the tooltip is gone.
22456     *
22457     * @param item the diskselector item being attached a tooltip.
22458     * @param func the function used to create the tooltip contents.
22459     * @param data what to provide to @a func as callback data/context.
22460     * @param del_cb called when data is not needed anymore, either when
22461     *        another callback replaces @p func, the tooltip is unset with
22462     *        elm_diskselector_item_tooltip_unset() or the owner @a item
22463     *        dies. This callback receives as the first parameter the
22464     *        given @a data, and @c event_info is the item.
22465     *
22466     * @see elm_object_tooltip_content_cb_set() for more details.
22467     *
22468     * @ingroup Diskselector
22469     */
22470    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);
22471
22472    /**
22473     * Unset tooltip from item.
22474     *
22475     * @param item diskselector item to remove previously set tooltip.
22476     *
22477     * Remove tooltip from item. The callback provided as del_cb to
22478     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22479     * it is not used anymore.
22480     *
22481     * @see elm_object_tooltip_unset() for more details.
22482     * @see elm_diskselector_item_tooltip_content_cb_set()
22483     *
22484     * @ingroup Diskselector
22485     */
22486    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22487
22488
22489    /**
22490     * Sets a different style for this item tooltip.
22491     *
22492     * @note before you set a style you should define a tooltip with
22493     *       elm_diskselector_item_tooltip_content_cb_set() or
22494     *       elm_diskselector_item_tooltip_text_set()
22495     *
22496     * @param item diskselector item with tooltip already set.
22497     * @param style the theme style to use (default, transparent, ...)
22498     *
22499     * @see elm_object_tooltip_style_set() for more details.
22500     *
22501     * @ingroup Diskselector
22502     */
22503    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22504
22505    /**
22506     * Get the style for this item tooltip.
22507     *
22508     * @param item diskselector item with tooltip already set.
22509     * @return style the theme style in use, defaults to "default". If the
22510     *         object does not have a tooltip set, then NULL is returned.
22511     *
22512     * @see elm_object_tooltip_style_get() for more details.
22513     * @see elm_diskselector_item_tooltip_style_set()
22514     *
22515     * @ingroup Diskselector
22516     */
22517    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22518
22519    /**
22520     * Set the cursor to be shown when mouse is over the diskselector item
22521     *
22522     * @param item Target item
22523     * @param cursor the cursor name to be used.
22524     *
22525     * @see elm_object_cursor_set() for more details.
22526     *
22527     * @ingroup Diskselector
22528     */
22529    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22530
22531    /**
22532     * Get the cursor to be shown when mouse is over the diskselector item
22533     *
22534     * @param item diskselector item with cursor already set.
22535     * @return the cursor name.
22536     *
22537     * @see elm_object_cursor_get() for more details.
22538     * @see elm_diskselector_cursor_set()
22539     *
22540     * @ingroup Diskselector
22541     */
22542    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22543
22544
22545    /**
22546     * Unset the cursor to be shown when mouse is over the diskselector item
22547     *
22548     * @param item Target item
22549     *
22550     * @see elm_object_cursor_unset() for more details.
22551     * @see elm_diskselector_cursor_set()
22552     *
22553     * @ingroup Diskselector
22554     */
22555    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22556
22557    /**
22558     * Sets a different style for this item cursor.
22559     *
22560     * @note before you set a style you should define a cursor with
22561     *       elm_diskselector_item_cursor_set()
22562     *
22563     * @param item diskselector item with cursor already set.
22564     * @param style the theme style to use (default, transparent, ...)
22565     *
22566     * @see elm_object_cursor_style_set() for more details.
22567     *
22568     * @ingroup Diskselector
22569     */
22570    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22571
22572
22573    /**
22574     * Get the style for this item cursor.
22575     *
22576     * @param item diskselector item with cursor already set.
22577     * @return style the theme style in use, defaults to "default". If the
22578     *         object does not have a cursor set, then @c NULL is returned.
22579     *
22580     * @see elm_object_cursor_style_get() for more details.
22581     * @see elm_diskselector_item_cursor_style_set()
22582     *
22583     * @ingroup Diskselector
22584     */
22585    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22586
22587
22588    /**
22589     * Set if the cursor set should be searched on the theme or should use
22590     * the provided by the engine, only.
22591     *
22592     * @note before you set if should look on theme you should define a cursor
22593     * with elm_diskselector_item_cursor_set().
22594     * By default it will only look for cursors provided by the engine.
22595     *
22596     * @param item widget item with cursor already set.
22597     * @param engine_only boolean to define if cursors set with
22598     * elm_diskselector_item_cursor_set() should be searched only
22599     * between cursors provided by the engine or searched on widget's
22600     * theme as well.
22601     *
22602     * @see elm_object_cursor_engine_only_set() for more details.
22603     *
22604     * @ingroup Diskselector
22605     */
22606    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22607
22608    /**
22609     * Get the cursor engine only usage for this item cursor.
22610     *
22611     * @param item widget item with cursor already set.
22612     * @return engine_only boolean to define it cursors should be looked only
22613     * between the provided by the engine or searched on widget's theme as well.
22614     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22615     *
22616     * @see elm_object_cursor_engine_only_get() for more details.
22617     * @see elm_diskselector_item_cursor_engine_only_set()
22618     *
22619     * @ingroup Diskselector
22620     */
22621    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22622
22623    /**
22624     * @}
22625     */
22626
22627    /**
22628     * @defgroup Colorselector Colorselector
22629     *
22630     * @{
22631     *
22632     * @image html img/widget/colorselector/preview-00.png
22633     * @image latex img/widget/colorselector/preview-00.eps
22634     *
22635     * @brief Widget for user to select a color.
22636     *
22637     * Signals that you can add callbacks for are:
22638     * "changed" - When the color value changes(event_info is NULL).
22639     *
22640     * See @ref tutorial_colorselector.
22641     */
22642    /**
22643     * @brief Add a new colorselector to the parent
22644     *
22645     * @param parent The parent object
22646     * @return The new object or NULL if it cannot be created
22647     *
22648     * @ingroup Colorselector
22649     */
22650    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22651    /**
22652     * Set a color for the colorselector
22653     *
22654     * @param obj   Colorselector object
22655     * @param r     r-value of color
22656     * @param g     g-value of color
22657     * @param b     b-value of color
22658     * @param a     a-value of color
22659     *
22660     * @ingroup Colorselector
22661     */
22662    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22663    /**
22664     * Get a color from the colorselector
22665     *
22666     * @param obj   Colorselector object
22667     * @param r     integer pointer for r-value of color
22668     * @param g     integer pointer for g-value of color
22669     * @param b     integer pointer for b-value of color
22670     * @param a     integer pointer for a-value of color
22671     *
22672     * @ingroup Colorselector
22673     */
22674    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22675    /**
22676     * @}
22677     */
22678
22679    /**
22680     * @defgroup Ctxpopup Ctxpopup
22681     *
22682     * @image html img/widget/ctxpopup/preview-00.png
22683     * @image latex img/widget/ctxpopup/preview-00.eps
22684     *
22685     * @brief Context popup widet.
22686     *
22687     * A ctxpopup is a widget that, when shown, pops up a list of items.
22688     * It automatically chooses an area inside its parent object's view
22689     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22690     * optimally fit into it. In the default theme, it will also point an
22691     * arrow to it's top left position at the time one shows it. Ctxpopup
22692     * items have a label and/or an icon. It is intended for a small
22693     * number of items (hence the use of list, not genlist).
22694     *
22695     * @note Ctxpopup is a especialization of @ref Hover.
22696     *
22697     * Signals that you can add callbacks for are:
22698     * "dismissed" - the ctxpopup was dismissed
22699     *
22700     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22701     * @{
22702     */
22703    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22704
22705    typedef enum _Elm_Ctxpopup_Direction
22706      {
22707         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22708                                           area */
22709         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22710                                            the clicked area */
22711         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22712                                           the clicked area */
22713         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22714                                         area */
22715      } Elm_Ctxpopup_Direction;
22716
22717    /**
22718     * @brief Add a new Ctxpopup object to the parent.
22719     *
22720     * @param parent Parent object
22721     * @return New object or @c NULL, if it cannot be created
22722     */
22723    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22724    /**
22725     * @brief Set the Ctxpopup's parent
22726     *
22727     * @param obj The ctxpopup object
22728     * @param area The parent to use
22729     *
22730     * Set the parent object.
22731     *
22732     * @note elm_ctxpopup_add() will automatically call this function
22733     * with its @c parent argument.
22734     *
22735     * @see elm_ctxpopup_add()
22736     * @see elm_hover_parent_set()
22737     */
22738    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22739    /**
22740     * @brief Get the Ctxpopup's parent
22741     *
22742     * @param obj The ctxpopup object
22743     *
22744     * @see elm_ctxpopup_hover_parent_set() for more information
22745     */
22746    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22747    /**
22748     * @brief Clear all items in the given ctxpopup object.
22749     *
22750     * @param obj Ctxpopup object
22751     */
22752    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22753    /**
22754     * @brief Change the ctxpopup's orientation to horizontal or vertical.
22755     *
22756     * @param obj Ctxpopup object
22757     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22758     */
22759    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22760    /**
22761     * @brief Get the value of current ctxpopup object's orientation.
22762     *
22763     * @param obj Ctxpopup object
22764     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22765     *
22766     * @see elm_ctxpopup_horizontal_set()
22767     */
22768    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22769    /**
22770     * @brief Add a new item to a ctxpopup object.
22771     *
22772     * @param obj Ctxpopup object
22773     * @param icon Icon to be set on new item
22774     * @param label The Label of the new item
22775     * @param func Convenience function called when item selected
22776     * @param data Data passed to @p func
22777     * @return A handle to the item added or @c NULL, on errors
22778     *
22779     * @warning Ctxpopup can't hold both an item list and a content at the same
22780     * time. When an item is added, any previous content will be removed.
22781     *
22782     * @see elm_ctxpopup_content_set()
22783     */
22784    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);
22785    /**
22786     * @brief Delete the given item in a ctxpopup object.
22787     *
22788     * @param item Ctxpopup item to be deleted
22789     *
22790     * @see elm_ctxpopup_item_append()
22791     */
22792    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22793    /**
22794     * @brief Set the ctxpopup item's state as disabled or enabled.
22795     *
22796     * @param item Ctxpopup item to be enabled/disabled
22797     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22798     *
22799     * When disabled the item is greyed out to indicate it's state.
22800     */
22801    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22802    /**
22803     * @brief Get the ctxpopup item's disabled/enabled state.
22804     *
22805     * @param item Ctxpopup item to be enabled/disabled
22806     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22807     *
22808     * @see elm_ctxpopup_item_disabled_set()
22809     */
22810    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22811    /**
22812     * @brief Get the icon object for the given ctxpopup item.
22813     *
22814     * @param item Ctxpopup item
22815     * @return icon object or @c NULL, if the item does not have icon or an error
22816     * occurred
22817     *
22818     * @see elm_ctxpopup_item_append()
22819     * @see elm_ctxpopup_item_icon_set()
22820     */
22821    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22822    /**
22823     * @brief Sets the side icon associated with the ctxpopup item
22824     *
22825     * @param item Ctxpopup item
22826     * @param icon Icon object to be set
22827     *
22828     * Once the icon object is set, a previously set one will be deleted.
22829     * @warning Setting the same icon for two items will cause the icon to
22830     * dissapear from the first item.
22831     *
22832     * @see elm_ctxpopup_item_append()
22833     */
22834    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22835    /**
22836     * @brief Get the label for the given ctxpopup item.
22837     *
22838     * @param item Ctxpopup item
22839     * @return label string or @c NULL, if the item does not have label or an
22840     * error occured
22841     *
22842     * @see elm_ctxpopup_item_append()
22843     * @see elm_ctxpopup_item_label_set()
22844     */
22845    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22846    /**
22847     * @brief (Re)set the label on the given ctxpopup item.
22848     *
22849     * @param item Ctxpopup item
22850     * @param label String to set as label
22851     */
22852    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22853    /**
22854     * @brief Set an elm widget as the content of the ctxpopup.
22855     *
22856     * @param obj Ctxpopup object
22857     * @param content Content to be swallowed
22858     *
22859     * If the content object is already set, a previous one will bedeleted. If
22860     * you want to keep that old content object, use the
22861     * elm_ctxpopup_content_unset() function.
22862     *
22863     * @deprecated use elm_object_content_set()
22864     *
22865     * @warning Ctxpopup can't hold both a item list and a content at the same
22866     * time. When a content is set, any previous items will be removed.
22867     */
22868    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22869    /**
22870     * @brief Unset the ctxpopup content
22871     *
22872     * @param obj Ctxpopup object
22873     * @return The content that was being used
22874     *
22875     * Unparent and return the content object which was set for this widget.
22876     *
22877     * @deprecated use elm_object_content_unset()
22878     *
22879     * @see elm_ctxpopup_content_set()
22880     */
22881    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22882    /**
22883     * @brief Set the direction priority of a ctxpopup.
22884     *
22885     * @param obj Ctxpopup object
22886     * @param first 1st priority of direction
22887     * @param second 2nd priority of direction
22888     * @param third 3th priority of direction
22889     * @param fourth 4th priority of direction
22890     *
22891     * This functions gives a chance to user to set the priority of ctxpopup
22892     * showing direction. This doesn't guarantee the ctxpopup will appear in the
22893     * requested direction.
22894     *
22895     * @see Elm_Ctxpopup_Direction
22896     */
22897    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);
22898    /**
22899     * @brief Get the direction priority of a ctxpopup.
22900     *
22901     * @param obj Ctxpopup object
22902     * @param first 1st priority of direction to be returned
22903     * @param second 2nd priority of direction to be returned
22904     * @param third 3th priority of direction to be returned
22905     * @param fourth 4th priority of direction to be returned
22906     *
22907     * @see elm_ctxpopup_direction_priority_set() for more information.
22908     */
22909    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);
22910    /**
22911     * @}
22912     */
22913
22914    /* transit */
22915    /**
22916     *
22917     * @defgroup Transit Transit
22918     * @ingroup Elementary
22919     *
22920     * Transit is designed to apply various animated transition effects to @c
22921     * Evas_Object, such like translation, rotation, etc. For using these
22922     * effects, create an @ref Elm_Transit and add the desired transition effects.
22923     *
22924     * Once the effects are added into transit, they will be automatically
22925     * managed (their callback will be called until the duration is ended, and
22926     * they will be deleted on completion).
22927     *
22928     * Example:
22929     * @code
22930     * Elm_Transit *trans = elm_transit_add();
22931     * elm_transit_object_add(trans, obj);
22932     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22933     * elm_transit_duration_set(transit, 1);
22934     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22935     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22936     * elm_transit_repeat_times_set(transit, 3);
22937     * @endcode
22938     *
22939     * Some transition effects are used to change the properties of objects. They
22940     * are:
22941     * @li @ref elm_transit_effect_translation_add
22942     * @li @ref elm_transit_effect_color_add
22943     * @li @ref elm_transit_effect_rotation_add
22944     * @li @ref elm_transit_effect_wipe_add
22945     * @li @ref elm_transit_effect_zoom_add
22946     * @li @ref elm_transit_effect_resizing_add
22947     *
22948     * Other transition effects are used to make one object disappear and another
22949     * object appear on its old place. These effects are:
22950     *
22951     * @li @ref elm_transit_effect_flip_add
22952     * @li @ref elm_transit_effect_resizable_flip_add
22953     * @li @ref elm_transit_effect_fade_add
22954     * @li @ref elm_transit_effect_blend_add
22955     *
22956     * It's also possible to make a transition chain with @ref
22957     * elm_transit_chain_transit_add.
22958     *
22959     * @warning We strongly recommend to use elm_transit just when edje can not do
22960     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22961     * animations can be manipulated inside the theme.
22962     *
22963     * List of examples:
22964     * @li @ref transit_example_01_explained
22965     * @li @ref transit_example_02_explained
22966     * @li @ref transit_example_03_c
22967     * @li @ref transit_example_04_c
22968     *
22969     * @{
22970     */
22971
22972    /**
22973     * @enum Elm_Transit_Tween_Mode
22974     *
22975     * The type of acceleration used in the transition.
22976     */
22977    typedef enum
22978      {
22979         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22980         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22981                                              over time, then decrease again
22982                                              and stop slowly */
22983         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22984                                              speed over time */
22985         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22986                                             over time */
22987      } Elm_Transit_Tween_Mode;
22988
22989    /**
22990     * @enum Elm_Transit_Effect_Flip_Axis
22991     *
22992     * The axis where flip effect should be applied.
22993     */
22994    typedef enum
22995      {
22996         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22997         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22998      } Elm_Transit_Effect_Flip_Axis;
22999    /**
23000     * @enum Elm_Transit_Effect_Wipe_Dir
23001     *
23002     * The direction where the wipe effect should occur.
23003     */
23004    typedef enum
23005      {
23006         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
23007         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
23008         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
23009         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
23010      } Elm_Transit_Effect_Wipe_Dir;
23011    /** @enum Elm_Transit_Effect_Wipe_Type
23012     *
23013     * Whether the wipe effect should show or hide the object.
23014     */
23015    typedef enum
23016      {
23017         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
23018                                              animation */
23019         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
23020                                             animation */
23021      } Elm_Transit_Effect_Wipe_Type;
23022
23023    /**
23024     * @typedef Elm_Transit
23025     *
23026     * The Transit created with elm_transit_add(). This type has the information
23027     * about the objects which the transition will be applied, and the
23028     * transition effects that will be used. It also contains info about
23029     * duration, number of repetitions, auto-reverse, etc.
23030     */
23031    typedef struct _Elm_Transit Elm_Transit;
23032    typedef void Elm_Transit_Effect;
23033    /**
23034     * @typedef Elm_Transit_Effect_Transition_Cb
23035     *
23036     * Transition callback called for this effect on each transition iteration.
23037     */
23038    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
23039    /**
23040     * Elm_Transit_Effect_End_Cb
23041     *
23042     * Transition callback called for this effect when the transition is over.
23043     */
23044    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
23045
23046    /**
23047     * Elm_Transit_Del_Cb
23048     *
23049     * A callback called when the transit is deleted.
23050     */
23051    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
23052
23053    /**
23054     * Add new transit.
23055     *
23056     * @note Is not necessary to delete the transit object, it will be deleted at
23057     * the end of its operation.
23058     * @note The transit will start playing when the program enter in the main loop, is not
23059     * necessary to give a start to the transit.
23060     *
23061     * @return The transit object.
23062     *
23063     * @ingroup Transit
23064     */
23065    EAPI Elm_Transit                *elm_transit_add(void);
23066
23067    /**
23068     * Stops the animation and delete the @p transit object.
23069     *
23070     * Call this function if you wants to stop the animation before the duration
23071     * time. Make sure the @p transit object is still alive with
23072     * elm_transit_del_cb_set() function.
23073     * All added effects will be deleted, calling its repective data_free_cb
23074     * functions. The function setted by elm_transit_del_cb_set() will be called.
23075     *
23076     * @see elm_transit_del_cb_set()
23077     *
23078     * @param transit The transit object to be deleted.
23079     *
23080     * @ingroup Transit
23081     * @warning Just call this function if you are sure the transit is alive.
23082     */
23083    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23084
23085    /**
23086     * Add a new effect to the transit.
23087     *
23088     * @note The cb function and the data are the key to the effect. If you try to
23089     * add an already added effect, nothing is done.
23090     * @note After the first addition of an effect in @p transit, if its
23091     * effect list become empty again, the @p transit will be killed by
23092     * elm_transit_del(transit) function.
23093     *
23094     * Exemple:
23095     * @code
23096     * Elm_Transit *transit = elm_transit_add();
23097     * elm_transit_effect_add(transit,
23098     *                        elm_transit_effect_blend_op,
23099     *                        elm_transit_effect_blend_context_new(),
23100     *                        elm_transit_effect_blend_context_free);
23101     * @endcode
23102     *
23103     * @param transit The transit object.
23104     * @param transition_cb The operation function. It is called when the
23105     * animation begins, it is the function that actually performs the animation.
23106     * It is called with the @p data, @p transit and the time progression of the
23107     * animation (a double value between 0.0 and 1.0).
23108     * @param effect The context data of the effect.
23109     * @param end_cb The function to free the context data, it will be called
23110     * at the end of the effect, it must finalize the animation and free the
23111     * @p data.
23112     *
23113     * @ingroup Transit
23114     * @warning The transit free the context data at the and of the transition with
23115     * the data_free_cb function, do not use the context data in another transit.
23116     */
23117    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);
23118
23119    /**
23120     * Delete an added effect.
23121     *
23122     * This function will remove the effect from the @p transit, calling the
23123     * data_free_cb to free the @p data.
23124     *
23125     * @see elm_transit_effect_add()
23126     *
23127     * @note If the effect is not found, nothing is done.
23128     * @note If the effect list become empty, this function will call
23129     * elm_transit_del(transit), that is, it will kill the @p transit.
23130     *
23131     * @param transit The transit object.
23132     * @param transition_cb The operation function.
23133     * @param effect The context data of the effect.
23134     *
23135     * @ingroup Transit
23136     */
23137    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);
23138
23139    /**
23140     * Add new object to apply the effects.
23141     *
23142     * @note After the first addition of an object in @p transit, if its
23143     * object list become empty again, the @p transit will be killed by
23144     * elm_transit_del(transit) function.
23145     * @note If the @p obj belongs to another transit, the @p obj will be
23146     * removed from it and it will only belong to the @p transit. If the old
23147     * transit stays without objects, it will die.
23148     * @note When you add an object into the @p transit, its state from
23149     * evas_object_pass_events_get(obj) is saved, and it is applied when the
23150     * transit ends, if you change this state whith evas_object_pass_events_set()
23151     * after add the object, this state will change again when @p transit stops to
23152     * run.
23153     *
23154     * @param transit The transit object.
23155     * @param obj Object to be animated.
23156     *
23157     * @ingroup Transit
23158     * @warning It is not allowed to add a new object after transit begins to go.
23159     */
23160    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23161
23162    /**
23163     * Removes an added object from the transit.
23164     *
23165     * @note If the @p obj is not in the @p transit, nothing is done.
23166     * @note If the list become empty, this function will call
23167     * elm_transit_del(transit), that is, it will kill the @p transit.
23168     *
23169     * @param transit The transit object.
23170     * @param obj Object to be removed from @p transit.
23171     *
23172     * @ingroup Transit
23173     * @warning It is not allowed to remove objects after transit begins to go.
23174     */
23175    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23176
23177    /**
23178     * Get the objects of the transit.
23179     *
23180     * @param transit The transit object.
23181     * @return a Eina_List with the objects from the transit.
23182     *
23183     * @ingroup Transit
23184     */
23185    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23186
23187    /**
23188     * Enable/disable keeping up the objects states.
23189     * If it is not kept, the objects states will be reset when transition ends.
23190     *
23191     * @note @p transit can not be NULL.
23192     * @note One state includes geometry, color, map data.
23193     *
23194     * @param transit The transit object.
23195     * @param state_keep Keeping or Non Keeping.
23196     *
23197     * @ingroup Transit
23198     */
23199    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23200
23201    /**
23202     * Get a value whether the objects states will be reset or not.
23203     *
23204     * @note @p transit can not be NULL
23205     *
23206     * @see elm_transit_objects_final_state_keep_set()
23207     *
23208     * @param transit The transit object.
23209     * @return EINA_TRUE means the states of the objects will be reset.
23210     * If @p transit is NULL, EINA_FALSE is returned
23211     *
23212     * @ingroup Transit
23213     */
23214    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23215
23216    /**
23217     * Set the event enabled when transit is operating.
23218     *
23219     * If @p enabled is EINA_TRUE, the objects of the transit will receives
23220     * events from mouse and keyboard during the animation.
23221     * @note When you add an object with elm_transit_object_add(), its state from
23222     * evas_object_pass_events_get(obj) is saved, and it is applied when the
23223     * transit ends, if you change this state with evas_object_pass_events_set()
23224     * after adding the object, this state will change again when @p transit stops
23225     * to run.
23226     *
23227     * @param transit The transit object.
23228     * @param enabled Events are received when enabled is @c EINA_TRUE, and
23229     * ignored otherwise.
23230     *
23231     * @ingroup Transit
23232     */
23233    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23234
23235    /**
23236     * Get the value of event enabled status.
23237     *
23238     * @see elm_transit_event_enabled_set()
23239     *
23240     * @param transit The Transit object
23241     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23242     * EINA_FALSE is returned
23243     *
23244     * @ingroup Transit
23245     */
23246    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23247
23248    /**
23249     * Set the user-callback function when the transit is deleted.
23250     *
23251     * @note Using this function twice will overwrite the first function setted.
23252     * @note the @p transit object will be deleted after call @p cb function.
23253     *
23254     * @param transit The transit object.
23255     * @param cb Callback function pointer. This function will be called before
23256     * the deletion of the transit.
23257     * @param data Callback funtion user data. It is the @p op parameter.
23258     *
23259     * @ingroup Transit
23260     */
23261    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23262
23263    /**
23264     * Set reverse effect automatically.
23265     *
23266     * If auto reverse is setted, after running the effects with the progress
23267     * parameter from 0 to 1, it will call the effecs again with the progress
23268     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23269     * where the duration was setted with the function elm_transit_add and
23270     * the repeat with the function elm_transit_repeat_times_set().
23271     *
23272     * @param transit The transit object.
23273     * @param reverse EINA_TRUE means the auto_reverse is on.
23274     *
23275     * @ingroup Transit
23276     */
23277    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23278
23279    /**
23280     * Get if the auto reverse is on.
23281     *
23282     * @see elm_transit_auto_reverse_set()
23283     *
23284     * @param transit The transit object.
23285     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23286     * EINA_FALSE is returned
23287     *
23288     * @ingroup Transit
23289     */
23290    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23291
23292    /**
23293     * Set the transit repeat count. Effect will be repeated by repeat count.
23294     *
23295     * This function sets the number of repetition the transit will run after
23296     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23297     * If the @p repeat is a negative number, it will repeat infinite times.
23298     *
23299     * @note If this function is called during the transit execution, the transit
23300     * will run @p repeat times, ignoring the times it already performed.
23301     *
23302     * @param transit The transit object
23303     * @param repeat Repeat count
23304     *
23305     * @ingroup Transit
23306     */
23307    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23308
23309    /**
23310     * Get the transit repeat count.
23311     *
23312     * @see elm_transit_repeat_times_set()
23313     *
23314     * @param transit The Transit object.
23315     * @return The repeat count. If @p transit is NULL
23316     * 0 is returned
23317     *
23318     * @ingroup Transit
23319     */
23320    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23321
23322    /**
23323     * Set the transit animation acceleration type.
23324     *
23325     * This function sets the tween mode of the transit that can be:
23326     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23327     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23328     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23329     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23330     *
23331     * @param transit The transit object.
23332     * @param tween_mode The tween type.
23333     *
23334     * @ingroup Transit
23335     */
23336    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23337
23338    /**
23339     * Get the transit animation acceleration type.
23340     *
23341     * @note @p transit can not be NULL
23342     *
23343     * @param transit The transit object.
23344     * @return The tween type. If @p transit is NULL
23345     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23346     *
23347     * @ingroup Transit
23348     */
23349    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23350
23351    /**
23352     * Set the transit animation time
23353     *
23354     * @note @p transit can not be NULL
23355     *
23356     * @param transit The transit object.
23357     * @param duration The animation time.
23358     *
23359     * @ingroup Transit
23360     */
23361    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23362
23363    /**
23364     * Get the transit animation time
23365     *
23366     * @note @p transit can not be NULL
23367     *
23368     * @param transit The transit object.
23369     *
23370     * @return The transit animation time.
23371     *
23372     * @ingroup Transit
23373     */
23374    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23375
23376    /**
23377     * Starts the transition.
23378     * Once this API is called, the transit begins to measure the time.
23379     *
23380     * @note @p transit can not be NULL
23381     *
23382     * @param transit The transit object.
23383     *
23384     * @ingroup Transit
23385     */
23386    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23387
23388    /**
23389     * Pause/Resume the transition.
23390     *
23391     * If you call elm_transit_go again, the transit will be started from the
23392     * beginning, and will be unpaused.
23393     *
23394     * @note @p transit can not be NULL
23395     *
23396     * @param transit The transit object.
23397     * @param paused Whether the transition should be paused or not.
23398     *
23399     * @ingroup Transit
23400     */
23401    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23402
23403    /**
23404     * Get the value of paused status.
23405     *
23406     * @see elm_transit_paused_set()
23407     *
23408     * @note @p transit can not be NULL
23409     *
23410     * @param transit The transit object.
23411     * @return EINA_TRUE means transition is paused. If @p transit is NULL
23412     * EINA_FALSE is returned
23413     *
23414     * @ingroup Transit
23415     */
23416    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23417
23418    /**
23419     * Get the time progression of the animation (a double value between 0.0 and 1.0).
23420     *
23421     * The value returned is a fraction (current time / total time). It
23422     * represents the progression position relative to the total.
23423     *
23424     * @note @p transit can not be NULL
23425     *
23426     * @param transit The transit object.
23427     *
23428     * @return The time progression value. If @p transit is NULL
23429     * 0 is returned
23430     *
23431     * @ingroup Transit
23432     */
23433    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23434
23435    /**
23436     * Makes the chain relationship between two transits.
23437     *
23438     * @note @p transit can not be NULL. Transit would have multiple chain transits.
23439     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23440     *
23441     * @param transit The transit object.
23442     * @param chain_transit The chain transit object. This transit will be operated
23443     *        after transit is done.
23444     *
23445     * This function adds @p chain_transit transition to a chain after the @p
23446     * transit, and will be started as soon as @p transit ends. See @ref
23447     * transit_example_02_explained for a full example.
23448     *
23449     * @ingroup Transit
23450     */
23451    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23452
23453    /**
23454     * Cut off the chain relationship between two transits.
23455     *
23456     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23457     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23458     *
23459     * @param transit The transit object.
23460     * @param chain_transit The chain transit object.
23461     *
23462     * This function remove the @p chain_transit transition from the @p transit.
23463     *
23464     * @ingroup Transit
23465     */
23466    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23467
23468    /**
23469     * Get the current chain transit list.
23470     *
23471     * @note @p transit can not be NULL.
23472     *
23473     * @param transit The transit object.
23474     * @return chain transit list.
23475     *
23476     * @ingroup Transit
23477     */
23478    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
23479
23480    /**
23481     * Add the Resizing Effect to Elm_Transit.
23482     *
23483     * @note This API is one of the facades. It creates resizing effect context
23484     * and add it's required APIs to elm_transit_effect_add.
23485     *
23486     * @see elm_transit_effect_add()
23487     *
23488     * @param transit Transit object.
23489     * @param from_w Object width size when effect begins.
23490     * @param from_h Object height size when effect begins.
23491     * @param to_w Object width size when effect ends.
23492     * @param to_h Object height size when effect ends.
23493     * @return Resizing effect context data.
23494     *
23495     * @ingroup Transit
23496     */
23497    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);
23498
23499    /**
23500     * Add the Translation Effect to Elm_Transit.
23501     *
23502     * @note This API is one of the facades. It creates translation effect context
23503     * and add it's required APIs to elm_transit_effect_add.
23504     *
23505     * @see elm_transit_effect_add()
23506     *
23507     * @param transit Transit object.
23508     * @param from_dx X Position variation when effect begins.
23509     * @param from_dy Y Position variation when effect begins.
23510     * @param to_dx X Position variation when effect ends.
23511     * @param to_dy Y Position variation when effect ends.
23512     * @return Translation effect context data.
23513     *
23514     * @ingroup Transit
23515     * @warning It is highly recommended just create a transit with this effect when
23516     * the window that the objects of the transit belongs has already been created.
23517     * This is because this effect needs the geometry information about the objects,
23518     * and if the window was not created yet, it can get a wrong information.
23519     */
23520    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);
23521
23522    /**
23523     * Add the Zoom Effect to Elm_Transit.
23524     *
23525     * @note This API is one of the facades. It creates zoom effect context
23526     * and add it's required APIs to elm_transit_effect_add.
23527     *
23528     * @see elm_transit_effect_add()
23529     *
23530     * @param transit Transit object.
23531     * @param from_rate Scale rate when effect begins (1 is current rate).
23532     * @param to_rate Scale rate when effect ends.
23533     * @return Zoom effect context data.
23534     *
23535     * @ingroup Transit
23536     * @warning It is highly recommended just create a transit with this effect when
23537     * the window that the objects of the transit belongs has already been created.
23538     * This is because this effect needs the geometry information about the objects,
23539     * and if the window was not created yet, it can get a wrong information.
23540     */
23541    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23542
23543    /**
23544     * Add the Flip Effect to Elm_Transit.
23545     *
23546     * @note This API is one of the facades. It creates flip effect context
23547     * and add it's required APIs to elm_transit_effect_add.
23548     * @note This effect is applied to each pair of objects in the order they are listed
23549     * in the transit list of objects. The first object in the pair will be the
23550     * "front" object and the second will be the "back" object.
23551     *
23552     * @see elm_transit_effect_add()
23553     *
23554     * @param transit Transit object.
23555     * @param axis Flipping Axis(X or Y).
23556     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23557     * @return Flip effect context data.
23558     *
23559     * @ingroup Transit
23560     * @warning It is highly recommended just create a transit with this effect when
23561     * the window that the objects of the transit belongs has already been created.
23562     * This is because this effect needs the geometry information about the objects,
23563     * and if the window was not created yet, it can get a wrong information.
23564     */
23565    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23566
23567    /**
23568     * Add the Resizable Flip Effect to Elm_Transit.
23569     *
23570     * @note This API is one of the facades. It creates resizable flip effect context
23571     * and add it's required APIs to elm_transit_effect_add.
23572     * @note This effect is applied to each pair of objects in the order they are listed
23573     * in the transit list of objects. The first object in the pair will be the
23574     * "front" object and the second will be the "back" object.
23575     *
23576     * @see elm_transit_effect_add()
23577     *
23578     * @param transit Transit object.
23579     * @param axis Flipping Axis(X or Y).
23580     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23581     * @return Resizable flip effect context data.
23582     *
23583     * @ingroup Transit
23584     * @warning It is highly recommended just create a transit with this effect when
23585     * the window that the objects of the transit belongs has already been created.
23586     * This is because this effect needs the geometry information about the objects,
23587     * and if the window was not created yet, it can get a wrong information.
23588     */
23589    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23590
23591    /**
23592     * Add the Wipe Effect to Elm_Transit.
23593     *
23594     * @note This API is one of the facades. It creates wipe effect context
23595     * and add it's required APIs to elm_transit_effect_add.
23596     *
23597     * @see elm_transit_effect_add()
23598     *
23599     * @param transit Transit object.
23600     * @param type Wipe type. Hide or show.
23601     * @param dir Wipe Direction.
23602     * @return Wipe effect context data.
23603     *
23604     * @ingroup Transit
23605     * @warning It is highly recommended just create a transit with this effect when
23606     * the window that the objects of the transit belongs has already been created.
23607     * This is because this effect needs the geometry information about the objects,
23608     * and if the window was not created yet, it can get a wrong information.
23609     */
23610    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23611
23612    /**
23613     * Add the Color Effect to Elm_Transit.
23614     *
23615     * @note This API is one of the facades. It creates color effect context
23616     * and add it's required APIs to elm_transit_effect_add.
23617     *
23618     * @see elm_transit_effect_add()
23619     *
23620     * @param transit        Transit object.
23621     * @param  from_r        RGB R when effect begins.
23622     * @param  from_g        RGB G when effect begins.
23623     * @param  from_b        RGB B when effect begins.
23624     * @param  from_a        RGB A when effect begins.
23625     * @param  to_r          RGB R when effect ends.
23626     * @param  to_g          RGB G when effect ends.
23627     * @param  to_b          RGB B when effect ends.
23628     * @param  to_a          RGB A when effect ends.
23629     * @return               Color effect context data.
23630     *
23631     * @ingroup Transit
23632     */
23633    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);
23634
23635    /**
23636     * Add the Fade Effect to Elm_Transit.
23637     *
23638     * @note This API is one of the facades. It creates fade effect context
23639     * and add it's required APIs to elm_transit_effect_add.
23640     * @note This effect is applied to each pair of objects in the order they are listed
23641     * in the transit list of objects. The first object in the pair will be the
23642     * "before" object and the second will be the "after" object.
23643     *
23644     * @see elm_transit_effect_add()
23645     *
23646     * @param transit Transit object.
23647     * @return Fade effect context data.
23648     *
23649     * @ingroup Transit
23650     * @warning It is highly recommended just create a transit with this effect when
23651     * the window that the objects of the transit belongs has already been created.
23652     * This is because this effect needs the color information about the objects,
23653     * and if the window was not created yet, it can get a wrong information.
23654     */
23655    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23656
23657    /**
23658     * Add the Blend Effect to Elm_Transit.
23659     *
23660     * @note This API is one of the facades. It creates blend effect context
23661     * and add it's required APIs to elm_transit_effect_add.
23662     * @note This effect is applied to each pair of objects in the order they are listed
23663     * in the transit list of objects. The first object in the pair will be the
23664     * "before" object and the second will be the "after" object.
23665     *
23666     * @see elm_transit_effect_add()
23667     *
23668     * @param transit Transit object.
23669     * @return Blend effect context data.
23670     *
23671     * @ingroup Transit
23672     * @warning It is highly recommended just create a transit with this effect when
23673     * the window that the objects of the transit belongs has already been created.
23674     * This is because this effect needs the color information about the objects,
23675     * and if the window was not created yet, it can get a wrong information.
23676     */
23677    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23678
23679    /**
23680     * Add the Rotation Effect to Elm_Transit.
23681     *
23682     * @note This API is one of the facades. It creates rotation effect context
23683     * and add it's required APIs to elm_transit_effect_add.
23684     *
23685     * @see elm_transit_effect_add()
23686     *
23687     * @param transit Transit object.
23688     * @param from_degree Degree when effect begins.
23689     * @param to_degree Degree when effect is ends.
23690     * @return Rotation effect context data.
23691     *
23692     * @ingroup Transit
23693     * @warning It is highly recommended just create a transit with this effect when
23694     * the window that the objects of the transit belongs has already been created.
23695     * This is because this effect needs the geometry information about the objects,
23696     * and if the window was not created yet, it can get a wrong information.
23697     */
23698    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23699
23700    /**
23701     * Add the ImageAnimation Effect to Elm_Transit.
23702     *
23703     * @note This API is one of the facades. It creates image animation effect context
23704     * and add it's required APIs to elm_transit_effect_add.
23705     * The @p images parameter is a list images paths. This list and
23706     * its contents will be deleted at the end of the effect by
23707     * elm_transit_effect_image_animation_context_free() function.
23708     *
23709     * Example:
23710     * @code
23711     * char buf[PATH_MAX];
23712     * Eina_List *images = NULL;
23713     * Elm_Transit *transi = elm_transit_add();
23714     *
23715     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23716     * images = eina_list_append(images, eina_stringshare_add(buf));
23717     *
23718     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23719     * images = eina_list_append(images, eina_stringshare_add(buf));
23720     * elm_transit_effect_image_animation_add(transi, images);
23721     *
23722     * @endcode
23723     *
23724     * @see elm_transit_effect_add()
23725     *
23726     * @param transit Transit object.
23727     * @param images Eina_List of images file paths. This list and
23728     * its contents will be deleted at the end of the effect by
23729     * elm_transit_effect_image_animation_context_free() function.
23730     * @return Image Animation effect context data.
23731     *
23732     * @ingroup Transit
23733     */
23734    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23735    /**
23736     * @}
23737     */
23738
23739   typedef struct _Elm_Store                      Elm_Store;
23740   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
23741   typedef struct _Elm_Store_Item                 Elm_Store_Item;
23742   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
23743   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
23744   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23745   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
23746   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
23747   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
23748   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
23749   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
23750
23751   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23752   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23753   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23754   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23755
23756   typedef enum
23757     {
23758        ELM_STORE_ITEM_MAPPING_NONE = 0,
23759        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23760        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23761        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23762        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23763        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23764        // can add more here as needed by common apps
23765        ELM_STORE_ITEM_MAPPING_LAST
23766     } Elm_Store_Item_Mapping_Type;
23767
23768   struct _Elm_Store_Item_Mapping_Icon
23769     {
23770        // FIXME: allow edje file icons
23771        int                   w, h;
23772        Elm_Icon_Lookup_Order lookup_order;
23773        Eina_Bool             standard_name : 1;
23774        Eina_Bool             no_scale : 1;
23775        Eina_Bool             smooth : 1;
23776        Eina_Bool             scale_up : 1;
23777        Eina_Bool             scale_down : 1;
23778     };
23779
23780   struct _Elm_Store_Item_Mapping_Empty
23781     {
23782        Eina_Bool             dummy;
23783     };
23784
23785   struct _Elm_Store_Item_Mapping_Photo
23786     {
23787        int                   size;
23788     };
23789
23790   struct _Elm_Store_Item_Mapping_Custom
23791     {
23792        Elm_Store_Item_Mapping_Cb func;
23793     };
23794
23795   struct _Elm_Store_Item_Mapping
23796     {
23797        Elm_Store_Item_Mapping_Type     type;
23798        const char                     *part;
23799        int                             offset;
23800        union
23801          {
23802             Elm_Store_Item_Mapping_Empty  empty;
23803             Elm_Store_Item_Mapping_Icon   icon;
23804             Elm_Store_Item_Mapping_Photo  photo;
23805             Elm_Store_Item_Mapping_Custom custom;
23806             // add more types here
23807          } details;
23808     };
23809
23810   struct _Elm_Store_Item_Info
23811     {
23812       Elm_Genlist_Item_Class       *item_class;
23813       const Elm_Store_Item_Mapping *mapping;
23814       void                         *data;
23815       char                         *sort_id;
23816     };
23817
23818   struct _Elm_Store_Item_Info_Filesystem
23819     {
23820       Elm_Store_Item_Info  base;
23821       char                *path;
23822     };
23823
23824 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23825 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23826
23827   EAPI void                    elm_store_free(Elm_Store *st);
23828
23829   EAPI Elm_Store              *elm_store_filesystem_new(void);
23830   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23831   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23832   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23833
23834   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23835
23836   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23837   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23838   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23839   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23840   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23841   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23842
23843   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23844   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23845   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23846   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23847   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23848   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23849   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23850
23851    /**
23852     * @defgroup SegmentControl SegmentControl
23853     * @ingroup Elementary
23854     *
23855     * @image html img/widget/segment_control/preview-00.png
23856     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23857     *
23858     * @image html img/segment_control.png
23859     * @image latex img/segment_control.eps width=\textwidth
23860     *
23861     * Segment control widget is a horizontal control made of multiple segment
23862     * items, each segment item functioning similar to discrete two state button.
23863     * A segment control groups the items together and provides compact
23864     * single button with multiple equal size segments.
23865     *
23866     * Segment item size is determined by base widget
23867     * size and the number of items added.
23868     * Only one segment item can be at selected state. A segment item can display
23869     * combination of Text and any Evas_Object like Images or other widget.
23870     *
23871     * Smart callbacks one can listen to:
23872     * - "changed" - When the user clicks on a segment item which is not
23873     *   previously selected and get selected. The event_info parameter is the
23874     *   segment item index.
23875     *
23876     * Available styles for it:
23877     * - @c "default"
23878     *
23879     * Here is an example on its usage:
23880     * @li @ref segment_control_example
23881     */
23882
23883    /**
23884     * @addtogroup SegmentControl
23885     * @{
23886     */
23887
23888    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23889
23890    /**
23891     * Add a new segment control widget to the given parent Elementary
23892     * (container) object.
23893     *
23894     * @param parent The parent object.
23895     * @return a new segment control widget handle or @c NULL, on errors.
23896     *
23897     * This function inserts a new segment control widget on the canvas.
23898     *
23899     * @ingroup SegmentControl
23900     */
23901    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23902
23903    /**
23904     * Append a new item to the segment control object.
23905     *
23906     * @param obj The segment control object.
23907     * @param icon The icon object to use for the left side of the item. An
23908     * icon can be any Evas object, but usually it is an icon created
23909     * with elm_icon_add().
23910     * @param label The label of the item.
23911     *        Note that, NULL is different from empty string "".
23912     * @return The created item or @c NULL upon failure.
23913     *
23914     * A new item will be created and appended to the segment control, i.e., will
23915     * be set as @b last item.
23916     *
23917     * If it should be inserted at another position,
23918     * elm_segment_control_item_insert_at() should be used instead.
23919     *
23920     * Items created with this function can be deleted with function
23921     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23922     *
23923     * @note @p label set to @c NULL is different from empty string "".
23924     * If an item
23925     * only has icon, it will be displayed bigger and centered. If it has
23926     * icon and label, even that an empty string, icon will be smaller and
23927     * positioned at left.
23928     *
23929     * Simple example:
23930     * @code
23931     * sc = elm_segment_control_add(win);
23932     * ic = elm_icon_add(win);
23933     * elm_icon_file_set(ic, "path/to/image", NULL);
23934     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23935     * elm_segment_control_item_add(sc, ic, "label");
23936     * evas_object_show(sc);
23937     * @endcode
23938     *
23939     * @see elm_segment_control_item_insert_at()
23940     * @see elm_segment_control_item_del()
23941     *
23942     * @ingroup SegmentControl
23943     */
23944    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23945
23946    /**
23947     * Insert a new item to the segment control object at specified position.
23948     *
23949     * @param obj The segment control object.
23950     * @param icon The icon object to use for the left side of the item. An
23951     * icon can be any Evas object, but usually it is an icon created
23952     * with elm_icon_add().
23953     * @param label The label of the item.
23954     * @param index Item position. Value should be between 0 and items count.
23955     * @return The created item or @c NULL upon failure.
23956
23957     * Index values must be between @c 0, when item will be prepended to
23958     * segment control, and items count, that can be get with
23959     * elm_segment_control_item_count_get(), case when item will be appended
23960     * to segment control, just like elm_segment_control_item_add().
23961     *
23962     * Items created with this function can be deleted with function
23963     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23964     *
23965     * @note @p label set to @c NULL is different from empty string "".
23966     * If an item
23967     * only has icon, it will be displayed bigger and centered. If it has
23968     * icon and label, even that an empty string, icon will be smaller and
23969     * positioned at left.
23970     *
23971     * @see elm_segment_control_item_add()
23972     * @see elm_segment_control_count_get()
23973     * @see elm_segment_control_item_del()
23974     *
23975     * @ingroup SegmentControl
23976     */
23977    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);
23978
23979    /**
23980     * Remove a segment control item from its parent, deleting it.
23981     *
23982     * @param it The item to be removed.
23983     *
23984     * Items can be added with elm_segment_control_item_add() or
23985     * elm_segment_control_item_insert_at().
23986     *
23987     * @ingroup SegmentControl
23988     */
23989    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23990
23991    /**
23992     * Remove a segment control item at given index from its parent,
23993     * deleting it.
23994     *
23995     * @param obj The segment control object.
23996     * @param index The position of the segment control item to be deleted.
23997     *
23998     * Items can be added with elm_segment_control_item_add() or
23999     * elm_segment_control_item_insert_at().
24000     *
24001     * @ingroup SegmentControl
24002     */
24003    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24004
24005    /**
24006     * Get the Segment items count from segment control.
24007     *
24008     * @param obj The segment control object.
24009     * @return Segment items count.
24010     *
24011     * It will just return the number of items added to segment control @p obj.
24012     *
24013     * @ingroup SegmentControl
24014     */
24015    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24016
24017    /**
24018     * Get the item placed at specified index.
24019     *
24020     * @param obj The segment control object.
24021     * @param index The index of the segment item.
24022     * @return The segment control item or @c NULL on failure.
24023     *
24024     * Index is the position of an item in segment control widget. Its
24025     * range is from @c 0 to <tt> count - 1 </tt>.
24026     * Count is the number of items, that can be get with
24027     * elm_segment_control_item_count_get().
24028     *
24029     * @ingroup SegmentControl
24030     */
24031    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24032
24033    /**
24034     * Get the label of item.
24035     *
24036     * @param obj The segment control object.
24037     * @param index The index of the segment item.
24038     * @return The label of the item at @p index.
24039     *
24040     * The return value is a pointer to the label associated to the item when
24041     * it was created, with function elm_segment_control_item_add(), or later
24042     * with function elm_segment_control_item_label_set. If no label
24043     * was passed as argument, it will return @c NULL.
24044     *
24045     * @see elm_segment_control_item_label_set() for more details.
24046     * @see elm_segment_control_item_add()
24047     *
24048     * @ingroup SegmentControl
24049     */
24050    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24051
24052    /**
24053     * Set the label of item.
24054     *
24055     * @param it The item of segment control.
24056     * @param text The label of item.
24057     *
24058     * The label to be displayed by the item.
24059     * Label will be at right of the icon (if set).
24060     *
24061     * If a label was passed as argument on item creation, with function
24062     * elm_control_segment_item_add(), it will be already
24063     * displayed by the item.
24064     *
24065     * @see elm_segment_control_item_label_get()
24066     * @see elm_segment_control_item_add()
24067     *
24068     * @ingroup SegmentControl
24069     */
24070    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
24071
24072    /**
24073     * Get the icon associated to the item.
24074     *
24075     * @param obj The segment control object.
24076     * @param index The index of the segment item.
24077     * @return The left side icon associated to the item at @p index.
24078     *
24079     * The return value is a pointer to the icon associated to the item when
24080     * it was created, with function elm_segment_control_item_add(), or later
24081     * with function elm_segment_control_item_icon_set(). If no icon
24082     * was passed as argument, it will return @c NULL.
24083     *
24084     * @see elm_segment_control_item_add()
24085     * @see elm_segment_control_item_icon_set()
24086     *
24087     * @ingroup SegmentControl
24088     */
24089    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24090
24091    /**
24092     * Set the icon associated to the item.
24093     *
24094     * @param it The segment control item.
24095     * @param icon The icon object to associate with @p it.
24096     *
24097     * The icon object to use at left side of the item. An
24098     * icon can be any Evas object, but usually it is an icon created
24099     * with elm_icon_add().
24100     *
24101     * Once the icon object is set, a previously set one will be deleted.
24102     * @warning Setting the same icon for two items will cause the icon to
24103     * dissapear from the first item.
24104     *
24105     * If an icon was passed as argument on item creation, with function
24106     * elm_segment_control_item_add(), it will be already
24107     * associated to the item.
24108     *
24109     * @see elm_segment_control_item_add()
24110     * @see elm_segment_control_item_icon_get()
24111     *
24112     * @ingroup SegmentControl
24113     */
24114    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24115
24116    /**
24117     * Get the index of an item.
24118     *
24119     * @param it The segment control item.
24120     * @return The position of item in segment control widget.
24121     *
24122     * Index is the position of an item in segment control widget. Its
24123     * range is from @c 0 to <tt> count - 1 </tt>.
24124     * Count is the number of items, that can be get with
24125     * elm_segment_control_item_count_get().
24126     *
24127     * @ingroup SegmentControl
24128     */
24129    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24130
24131    /**
24132     * Get the base object of the item.
24133     *
24134     * @param it The segment control item.
24135     * @return The base object associated with @p it.
24136     *
24137     * Base object is the @c Evas_Object that represents that item.
24138     *
24139     * @ingroup SegmentControl
24140     */
24141    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24142
24143    /**
24144     * Get the selected item.
24145     *
24146     * @param obj The segment control object.
24147     * @return The selected item or @c NULL if none of segment items is
24148     * selected.
24149     *
24150     * The selected item can be unselected with function
24151     * elm_segment_control_item_selected_set().
24152     *
24153     * The selected item always will be highlighted on segment control.
24154     *
24155     * @ingroup SegmentControl
24156     */
24157    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24158
24159    /**
24160     * Set the selected state of an item.
24161     *
24162     * @param it The segment control item
24163     * @param select The selected state
24164     *
24165     * This sets the selected state of the given item @p it.
24166     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24167     *
24168     * If a new item is selected the previosly selected will be unselected.
24169     * Previoulsy selected item can be get with function
24170     * elm_segment_control_item_selected_get().
24171     *
24172     * The selected item always will be highlighted on segment control.
24173     *
24174     * @see elm_segment_control_item_selected_get()
24175     *
24176     * @ingroup SegmentControl
24177     */
24178    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24179
24180    /**
24181     * @}
24182     */
24183
24184
24185    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24186    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
24187    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24188    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24189    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24190    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24191    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24192    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24193
24194
24195    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
24196    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
24197    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
24198    
24199    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24200    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24201    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24202    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24203    EAPI void elm_video_play(Evas_Object *video);
24204    EAPI void elm_video_pause(Evas_Object *video);
24205    EAPI void elm_video_stop(Evas_Object *video);
24206    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24207    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24208    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24209    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24210    EAPI double elm_video_audio_level_get(Evas_Object *video);
24211    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24212    EAPI double elm_video_play_position_get(Evas_Object *video);
24213    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24214    EAPI double elm_video_play_length_get(Evas_Object *video);
24215    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24216    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24217    EAPI const char *elm_video_title_get(Evas_Object *video);
24218
24219    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24220    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24221
24222   /* naviframe */
24223    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24224    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);
24225    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24226    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24227    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24228    EAPI void                elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24229    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24230    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24231    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24232    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24233    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24234    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24235    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24236    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24237    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24238
24239 #ifdef __cplusplus
24240 }
24241 #endif
24242
24243 #endif