461d6dc4aabc34ebdd27019593721136b12e19ba
[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 @PACKAGE_VERSION@
15 @author Carsten Haitzler <raster@@rasterman.com>
16 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
17 @author Cedric Bail <cedric.bail@@free.fr>
18 @author Vincent Torri <vtorri@@univ-evry.fr>
19 @author Daniel Kolesa <quaker66@@gmail.com>
20 @author Jaime Thomas <avi.thomas@@gmail.com>
21 @author Swisscom - http://www.swisscom.ch/
22 @author Christopher Michael <devilhorns@@comcast.net>
23 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
24 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
25 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
26 @author Brian Wang <brian.wang.0721@@gmail.com>
27 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
28 @author Samsung Electronics <tbd>
29 @author Samsung SAIT <tbd>
30 @author Brett Nash <nash@@nash.id.au>
31 @author Bruno Dilly <bdilly@@profusion.mobi>
32 @author Rafael Fonseca <rfonseca@@profusion.mobi>
33 @author Chuneon Park <hermet@@hermet.pe.kr>
34 @author Woohyun Jung <wh0705.jung@@samsung.com>
35 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
36 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
37 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
38 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
39 @author Gustavo Lima Chaves <glima@@profusion.mobi>
40 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
41 @author Tiago Falcão <tiago@@profusion.mobi>
42 @author Otavio Pontes <otavio@@profusion.mobi>
43 @author Viktor Kojouharov <vkojouharov@@gmail.com>
44 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
45 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
46 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
47 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
48 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
49 @author Jihoon Kim <jihoon48.kim@@samsung.com>
50 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
51 @author Tom Hacohen <tom@@stosb.com>
52 @author Aharon Hillel <a.hillel@@partner.samsung.com>
53 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
54 @author Shinwoo Kim <kimcinoo@@gmail.com>
55 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
56 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
57 @date 2008-2011
58
59 @section intro What is Elementary?
60
61 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
62 applications (yet). Small simple ones with simple needs.
63
64 It is meant to make the programmers work almost brainless but give them lots
65 of flexibility.
66
67 License: LGPL v2 (see COPYING in the base of Elementary's source). This
68 applies to all files in the source here.
69
70 Acknowledgements: There is a lot that goes into making a widget set, and
71 they don't happen out of nothing. It's like trying to make everyone
72 everywhere happy, regardless of age, gender, race or nationality - and
73 that is really tough. So thanks to people and organisations behind this,
74 aslisted in the Authors section above.
75
76 @verbatim
77 Pants
78 @endverbatim
79 */
80
81 #ifndef ELEMENTARY_H
82 #define ELEMENTARY_H
83
84 /**
85  * @file Elementary.h
86  * @brief Elementary's API
87  *
88  * Elementary API.
89  */
90
91 @ELM_UNIX_DEF@ ELM_UNIX
92 @ELM_WIN32_DEF@ ELM_WIN32
93 @ELM_WINCE_DEF@ ELM_WINCE
94 @ELM_EDBUS_DEF@ ELM_EDBUS
95 @ELM_EFREET_DEF@ ELM_EFREET
96 @ELM_ETHUMB_DEF@ ELM_ETHUMB
97 @ELM_EMAP_DEF@ ELM_EMAP
98 @ELM_DEBUG_DEF@ ELM_DEBUG
99 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
100 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
101
102 /* Standard headers for standard system calls etc. */
103 #include <stdio.h>
104 #include <stdlib.h>
105 #include <unistd.h>
106 #include <string.h>
107 #include <sys/types.h>
108 #include <sys/stat.h>
109 #include <sys/time.h>
110 #include <sys/param.h>
111 #include <dlfcn.h>
112 #include <math.h>
113 #include <fnmatch.h>
114 #include <limits.h>
115 #include <ctype.h>
116 #include <time.h>
117 #include <dirent.h>
118 #include <pwd.h>
119 #include <errno.h>
120
121 #ifdef ELM_UNIX
122 # include <locale.h>
123 # ifdef ELM_LIBINTL_H
124 #  include <libintl.h>
125 # endif
126 # include <signal.h>
127 # include <grp.h>
128 # include <glob.h>
129 #endif
130
131 #ifdef ELM_ALLOCA_H
132 # include <alloca.h>
133 #endif
134
135 #if defined (ELM_WIN32) || defined (ELM_WINCE)
136 # include <malloc.h>
137 # ifndef alloca
138 #  define alloca _alloca
139 # endif
140 #endif
141
142
143 /* EFL headers */
144 #include <Eina.h>
145 #include <Eet.h>
146 #include <Evas.h>
147 #include <Evas_GL.h>
148 #include <Ecore.h>
149 #include <Ecore_Evas.h>
150 #include <Ecore_File.h>
151 #include <Ecore_IMF.h>
152 #include <Ecore_Con.h>
153 #include <Edje.h>
154
155 #ifdef ELM_EDBUS
156 # include <E_DBus.h>
157 #endif
158
159 #ifdef ELM_EFREET
160 # include <Efreet.h>
161 # include <Efreet_Mime.h>
162 # include <Efreet_Trash.h>
163 #endif
164
165 #ifdef ELM_ETHUMB
166 # include <Ethumb_Client.h>
167 #endif
168
169 #ifdef ELM_EMAP
170 # include <EMap.h>
171 #endif
172
173 #ifdef EAPI
174 # undef EAPI
175 #endif
176
177 #ifdef _WIN32
178 # ifdef ELEMENTARY_BUILD
179 #  ifdef DLL_EXPORT
180 #   define EAPI __declspec(dllexport)
181 #  else
182 #   define EAPI
183 #  endif /* ! DLL_EXPORT */
184 # else
185 #  define EAPI __declspec(dllimport)
186 # endif /* ! EFL_EVAS_BUILD */
187 #else
188 # ifdef __GNUC__
189 #  if __GNUC__ >= 4
190 #   define EAPI __attribute__ ((visibility("default")))
191 #  else
192 #   define EAPI
193 #  endif
194 # else
195 #  define EAPI
196 # endif
197 #endif /* ! _WIN32 */
198
199
200 /* allow usage from c++ */
201 #ifdef __cplusplus
202 extern "C" {
203 #endif
204
205 #define ELM_VERSION_MAJOR @VMAJ@
206 #define ELM_VERSION_MINOR @VMIN@
207
208    typedef struct _Elm_Version
209      {
210         int major;
211         int minor;
212         int micro;
213         int revision;
214      } Elm_Version;
215
216    EAPI extern Elm_Version *elm_version;
217
218 /* handy macros */
219 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
220 #define ELM_PI 3.14159265358979323846
221
222    /**
223     * @defgroup General General
224     *
225     * @brief General Elementary API. Functions that don't relate to
226     * Elementary objects specifically.
227     *
228     * Here are documented functions which init/shutdown the library,
229     * that apply to generic Elementary objects, that deal with
230     * configuration, et cetera.
231     *
232     * @ref general_functions_example_page "This" example contemplates
233     * some of these functions.
234     */
235
236    /**
237     * @addtogroup General
238     * @{
239     */
240
241   /**
242    * Defines couple of standard Evas_Object layers to be used
243    * with evas_object_layer_set().
244    *
245    * @note whenever extending with new values, try to keep some padding
246    *       to siblings so there is room for further extensions.
247    */
248   typedef enum _Elm_Object_Layer
249     {
250        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
251        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
252        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
253        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
254        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
255        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
256     } Elm_Object_Layer;
257
258 /**************************************************************************/
259    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
260
261    /**
262     * Emitted when any Elementary's policy value is changed.
263     */
264    EAPI extern int ELM_EVENT_POLICY_CHANGED;
265
266    /**
267     * @typedef Elm_Event_Policy_Changed
268     *
269     * Data on the event when an Elementary policy has changed
270     */
271     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
272
273    /**
274     * @struct _Elm_Event_Policy_Changed
275     *
276     * Data on the event when an Elementary policy has changed
277     */
278     struct _Elm_Event_Policy_Changed
279      {
280         unsigned int policy; /**< the policy identifier */
281         int          new_value; /**< value the policy had before the change */
282         int          old_value; /**< new value the policy got */
283     };
284
285    /**
286     * Policy identifiers.
287     */
288     typedef enum _Elm_Policy
289     {
290         ELM_POLICY_QUIT, /**< under which circunstances the application
291                           * should quit automatically. @see
292                           * Elm_Policy_Quit.
293                           */
294         ELM_POLICY_LAST
295     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
296  */
297
298    typedef enum _Elm_Policy_Quit
299      {
300         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
301                                    * automatically */
302         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
303                                             * application's last
304                                             * window is closed */
305      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
306
307    typedef enum _Elm_Focus_Direction
308      {
309         ELM_FOCUS_PREVIOUS,
310         ELM_FOCUS_NEXT
311      } Elm_Focus_Direction;
312
313    typedef enum _Elm_Text_Format
314      {
315         ELM_TEXT_FORMAT_PLAIN_UTF8,
316         ELM_TEXT_FORMAT_MARKUP_UTF8
317      } Elm_Text_Format;
318
319    /**
320     * Line wrapping types.
321     */
322    typedef enum _Elm_Wrap_Type
323      {
324         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
325         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
326         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
327         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
328         ELM_WRAP_LAST
329      } Elm_Wrap_Type;
330
331
332    /**
333     * Called back when a widget's tooltip is activated and needs content.
334     * @param data user-data given to elm_object_tooltip_content_cb_set()
335     * @param obj owner widget.
336     * @param tooltip The tooltip object (affix content to this!)
337     */
338    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
339
340    /**
341     * Called back when a widget's item tooltip is activated and needs content.
342     * @param data user-data given to elm_object_tooltip_content_cb_set()
343     * @param obj owner widget.
344     * @param tooltip The tooltip object (affix content to this!)
345     * @param item context dependent item. As an example, if tooltip was
346     *        set on Elm_List_Item, then it is of this type.
347     */
348    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
349
350    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
351
352 #ifndef ELM_LIB_QUICKLAUNCH
353 #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 */
354 #else
355 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
356 #endif
357
358 /**************************************************************************/
359    /* General calls */
360
361    /**
362     * Initialize Elementary
363     *
364     * @param[in] argc System's argument count value
365     * @param[in] argv System's pointer to array of argument strings
366     * @return The init counter value.
367     *
368     * This function initializes Elementary and increments a counter of
369     * the number of calls to it. It returs the new counter's value.
370     *
371     * @warning This call is exported only for use by the @c ELM_MAIN()
372     * macro. There is no need to use this if you use this macro (which
373     * is highly advisable). An elm_main() should contain the entry
374     * point code for your application, having the same prototype as
375     * elm_init(), and @b not being static (putting the @c EAPI symbol
376     * in front of its type declaration is advisable). The @c
377     * ELM_MAIN() call should be placed just after it.
378     *
379     * Example:
380     * @dontinclude bg_example_01.c
381     * @skip static void
382     * @until ELM_MAIN
383     *
384     * See the full @ref bg_example_01_c "example".
385     *
386     * @see elm_shutdown().
387     * @ingroup General
388     */
389    EAPI int          elm_init(int argc, char **argv);
390
391    /**
392     * Shut down Elementary
393     *
394     * @return The init counter value.
395     *
396     * This should be called at the end of your application, just
397     * before it ceases to do any more processing. This will clean up
398     * any permanent resources your application may have allocated via
399     * Elementary that would otherwise persist.
400     *
401     * @see elm_init() for an example
402     *
403     * @ingroup General
404     */
405    EAPI int          elm_shutdown(void);
406
407    /**
408     * Run Elementary's main loop
409     *
410     * This call should be issued just after all initialization is
411     * completed. This function will not return until elm_exit() is
412     * called. It will keep looping, running the main
413     * (event/processing) loop for Elementary.
414     *
415     * @see elm_init() for an example
416     *
417     * @ingroup General
418     */
419    EAPI void         elm_run(void);
420
421    /**
422     * Exit Elementary's main loop
423     *
424     * If this call is issued, it will flag the main loop to cease
425     * processing and return back to its parent function (usually your
426     * elm_main() function).
427     *
428     * @see elm_init() for an example. There, just after a request to
429     * close the window comes, the main loop will be left.
430     *
431     * @note By using the #ELM_POLICY_QUIT on your Elementary
432     * applications, you'll this function called automatically for you.
433     *
434     * @ingroup General
435     */
436    EAPI void         elm_exit(void);
437
438    /**
439     * Provide information in order to make Elementary determine the @b
440     * run time location of the software in question, so other data files
441     * such as images, sound files, executable utilities, libraries,
442     * modules and locale files can be found.
443     *
444     * @param mainfunc This is your application's main function name,
445     *        whose binary's location is to be found. Providing @c NULL
446     *        will make Elementary not to use it
447     * @param dom This will be used as the application's "domain", in the
448     *        form of a prefix to any environment variables that may
449     *        override prefix detection and the directory name, inside the
450     *        standard share or data directories, where the software's
451     *        data files will be looked for.
452     * @param checkfile This is an (optional) magic file's path to check
453     *        for existence (and it must be located in the data directory,
454     *        under the share directory provided above). Its presence will
455     *        help determine the prefix found was correct. Pass @c NULL if
456     *        the check is not to be done.
457     *
458     * This function allows one to re-locate the application somewhere
459     * else after compilation, if the developer wishes for easier
460     * distribution of pre-compiled binaries.
461     *
462     * The prefix system is designed to locate where the given software is
463     * installed (under a common path prefix) at run time and then report
464     * specific locations of this prefix and common directories inside
465     * this prefix like the binary, library, data and locale directories,
466     * through the @c elm_app_*_get() family of functions.
467     *
468     * Call elm_app_info_set() early on before you change working
469     * directory or anything about @c argv[0], so it gets accurate
470     * information.
471     *
472     * It will then try and trace back which file @p mainfunc comes from,
473     * if provided, to determine the application's prefix directory.
474     *
475     * The @p dom parameter provides a string prefix to prepend before
476     * environment variables, allowing a fallback to @b specific
477     * environment variables to locate the software. You would most
478     * probably provide a lowercase string there, because it will also
479     * serve as directory domain, explained next. For environment
480     * variables purposes, this string is made uppercase. For example if
481     * @c "myapp" is provided as the prefix, then the program would expect
482     * @c "MYAPP_PREFIX" as a master environment variable to specify the
483     * exact install prefix for the software, or more specific environment
484     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
485     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
486     * the user or scripts before launching. If not provided (@c NULL),
487     * environment variables will not be used to override compiled-in
488     * defaults or auto detections.
489     *
490     * The @p dom string also provides a subdirectory inside the system
491     * shared data directory for data files. For example, if the system
492     * directory is @c /usr/local/share, then this directory name is
493     * appended, creating @c /usr/local/share/myapp, if it @p was @c
494     * "myapp". It is expected the application installs data files in
495     * this directory.
496     *
497     * The @p checkfile is a file name or path of something inside the
498     * share or data directory to be used to test that the prefix
499     * detection worked. For example, your app will install a wallpaper
500     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
501     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
502     * checkfile string.
503     *
504     * @see elm_app_compile_bin_dir_set()
505     * @see elm_app_compile_lib_dir_set()
506     * @see elm_app_compile_data_dir_set()
507     * @see elm_app_compile_locale_set()
508     * @see elm_app_prefix_dir_get()
509     * @see elm_app_bin_dir_get()
510     * @see elm_app_lib_dir_get()
511     * @see elm_app_data_dir_get()
512     * @see elm_app_locale_dir_get()
513     */
514    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
515
516    /**
517     * Provide information on the @b fallback application's binaries
518     * directory, on scenarios where they get overriden by
519     * elm_app_info_set().
520     *
521     * @param dir The path to the default binaries directory (compile time
522     * one)
523     *
524     * @note Elementary will as well use this path to determine actual
525     * names of binaries' directory paths, maybe changing it to be @c
526     * something/local/bin instead of @c something/bin, only, for
527     * example.
528     *
529     * @warning You should call this function @b before
530     * elm_app_info_set().
531     */
532    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
533
534    /**
535     * Provide information on the @b fallback application's libraries
536     * directory, on scenarios where they get overriden by
537     * elm_app_info_set().
538     *
539     * @param dir The path to the default libraries directory (compile
540     * time one)
541     *
542     * @note Elementary will as well use this path to determine actual
543     * names of libraries' directory paths, maybe changing it to be @c
544     * something/lib32 or @c something/lib64 instead of @c something/lib,
545     * only, for example.
546     *
547     * @warning You should call this function @b before
548     * elm_app_info_set().
549     */
550    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
551
552    /**
553     * Provide information on the @b fallback application's data
554     * directory, on scenarios where they get overriden by
555     * elm_app_info_set().
556     *
557     * @param dir The path to the default data directory (compile time
558     * one)
559     *
560     * @note Elementary will as well use this path to determine actual
561     * names of data directory paths, maybe changing it to be @c
562     * something/local/share instead of @c something/share, only, for
563     * example.
564     *
565     * @warning You should call this function @b before
566     * elm_app_info_set().
567     */
568    EAPI void         elm_app_compile_data_dir_set(const char *dir);
569
570    /**
571     * Provide information on the @b fallback application's locale
572     * directory, on scenarios where they get overriden by
573     * elm_app_info_set().
574     *
575     * @param dir The path to the default locale directory (compile time
576     * one)
577     *
578     * @warning You should call this function @b before
579     * elm_app_info_set().
580     */
581    EAPI void         elm_app_compile_locale_set(const char *dir);
582
583    /**
584     * Retrieve the application's run time prefix directory, as set by
585     * elm_app_info_set() and the way (environment) the application was
586     * run from.
587     *
588     * @return The directory prefix the application is actually using
589     */
590    EAPI const char  *elm_app_prefix_dir_get(void);
591
592    /**
593     * Retrieve the application's run time binaries prefix directory, as
594     * set by elm_app_info_set() and the way (environment) the application
595     * was run from.
596     *
597     * @return The binaries directory prefix the application is actually
598     * using
599     */
600    EAPI const char  *elm_app_bin_dir_get(void);
601
602    /**
603     * Retrieve the application's run time libraries prefix directory, as
604     * set by elm_app_info_set() and the way (environment) the application
605     * was run from.
606     *
607     * @return The libraries directory prefix the application is actually
608     * using
609     */
610    EAPI const char  *elm_app_lib_dir_get(void);
611
612    /**
613     * Retrieve the application's run time data prefix directory, as
614     * set by elm_app_info_set() and the way (environment) the application
615     * was run from.
616     *
617     * @return The data directory prefix the application is actually
618     * using
619     */
620    EAPI const char  *elm_app_data_dir_get(void);
621
622    /**
623     * Retrieve the application's run time locale prefix directory, as
624     * set by elm_app_info_set() and the way (environment) the application
625     * was run from.
626     *
627     * @return The locale directory prefix the application is actually
628     * using
629     */
630    EAPI const char  *elm_app_locale_dir_get(void);
631
632    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
633    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
634    EAPI int          elm_quicklaunch_init(int argc, char **argv);
635    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
636    EAPI int          elm_quicklaunch_sub_shutdown(void);
637    EAPI int          elm_quicklaunch_shutdown(void);
638    EAPI void         elm_quicklaunch_seed(void);
639    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
640    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
641    EAPI void         elm_quicklaunch_cleanup(void);
642    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
643    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
644
645    EAPI Eina_Bool    elm_need_efreet(void);
646    EAPI Eina_Bool    elm_need_e_dbus(void);
647    EAPI Eina_Bool    elm_need_ethumb(void);
648
649    /**
650     * Set a new policy's value (for a given policy group/identifier).
651     *
652     * @param policy policy identifier, as in @ref Elm_Policy.
653     * @param value policy value, which depends on the identifier
654     *
655     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
656     *
657     * Elementary policies define applications' behavior,
658     * somehow. These behaviors are divided in policy groups (see
659     * #Elm_Policy enumeration). This call will emit the Ecore event
660     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
661     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
662     * then.
663     *
664     * @note Currently, we have only one policy identifier/group
665     * (#ELM_POLICY_QUIT), which has two possible values.
666     *
667     * @ingroup General
668     */
669    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
670
671    /**
672     * Gets the policy value set for given policy identifier.
673     *
674     * @param policy policy identifier, as in #Elm_Policy.
675     * @return The currently set policy value, for that
676     * identifier. Will be @c 0 if @p policy passed is invalid.
677     *
678     * @ingroup General
679     */
680    EAPI int          elm_policy_get(unsigned int policy);
681
682    /**
683     * Set a label of an object
684     *
685     * @param obj The Elementary object
686     * @param item The label id to set (NULL for the default label)
687     * @param label The new text of the label
688     *
689     * @note Elementary objects may have many labels (e.g. Action Slider)
690     *
691     * @ingroup General
692     */
693    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *item, const char *label);
694
695 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
696
697    /**
698     * Get a label of an object
699     *
700     * @param obj The Elementary object
701     * @param item The label id to get (NULL for the default label)
702     * @return text of the label or
703     *         NULL for any error
704     *
705     * @note Elementary objects may have many labels (e.g. Action Slider)
706     *
707     * @ingroup General
708     */
709    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *item);
710
711 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
712
713    /**
714     * Set a content of an object
715     *
716     * @param obj The Elementary object
717     * @param item The content id to set (NULL for the default content)
718     * @param content The new content of the object 
719     *
720     * @note Elementary objects may have many contents
721     *
722     * @ingroup General
723     */
724    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *item, Evas_Object *content);
725
726 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
727
728    /**
729     * Get a content of an object
730     *
731     * @param obj The Elementary object
732     * @param item The content id to get (NULL for the default content)
733     * @return content of the object or
734     *         NULL for any error
735     *
736     * @note Elementary objects may have many contents
737     *
738     * @ingroup General
739     */
740    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *item);
741
742 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
743
744    /**
745     * Unset a content of an object
746     *
747     * @param obj The Elementary object
748     * @param item The content id to unset (NULL for the default content)
749     *
750     * @note Elementary objects may have many contents
751     *
752     * @ingroup General
753     */
754    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *item);
755
756 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
757
758    /**
759     * @}
760     */
761
762    EAPI void         elm_all_flush(void);
763    EAPI int          elm_cache_flush_interval_get(void);
764    EAPI void         elm_cache_flush_interval_set(int size);
765    EAPI void         elm_cache_flush_interval_all_set(int size);
766    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
767    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
768    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
769    EAPI int          elm_font_cache_get(void);
770    EAPI void         elm_font_cache_set(int size);
771    EAPI void         elm_font_cache_all_set(int size);
772    EAPI int          elm_image_cache_get(void);
773    EAPI void         elm_image_cache_set(int size);
774    EAPI void         elm_image_cache_all_set(int size);
775    EAPI int          elm_edje_file_cache_get(void);
776    EAPI void         elm_edje_file_cache_set(int size);
777    EAPI void         elm_edje_file_cache_all_set(int size);
778    EAPI int          elm_edje_collection_cache_get(void);
779    EAPI void         elm_edje_collection_cache_set(int size);
780    EAPI void         elm_edje_collection_cache_all_set(int size);
781
782    /**
783     * @defgroup Scaling Selective Widget Scaling
784     *
785     * Different widgets can be scaled independently. These functions
786     * allow you to manipulate this scaling on a per-widget basis. The
787     * object and all its children get their scaling factors multiplied
788     * by the scale factor set. This is multiplicative, in that if a
789     * child also has a scale size set it is in turn multiplied by its
790     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
791     * double size, @c 0.5 is half, etc.
792     *
793     * @ref general_functions_example_page "This" example contemplates
794     * some of these functions.
795     */
796
797    /**
798     * Set the scaling factor for a given Elementary object
799     *
800     * @param obj The Elementary to operate on
801     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
802     * no scaling)
803     *
804     * @ingroup Scaling
805     */
806    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
807
808    /**
809     * Get the scaling factor for a given Elementary object
810     *
811     * @param obj The object
812     * @return The scaling factor set by elm_object_scale_set()
813     *
814     * @ingroup Scaling
815     */
816    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
817    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
818    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
819    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
820    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
821    /**
822     * Set the style to use by a widget
823     *
824     * Sets the style name that will define the appearance of a widget. Styles
825     * vary from widget to widget and may also be defined by other themes
826     * by means of extensions and overlays.
827     *
828     * @param obj The Elementary widget to style
829     * @param style The style name to use
830     *
831     * @see elm_theme_extension_add()
832     * @see elm_theme_overlay_add()
833     *
834     * @ingroup Theme
835     */
836    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
837    /**
838     * Get the style used by the widget
839     *
840     * This gets the style being used for that widget. Note that the string
841     * pointer is only valid as longas the object is valid and the style doesn't
842     * change.
843     *
844     * @param obj The Elementary widget to query for its style
845     * @return The style name used
846     *
847     * @see elm_object_style_set()
848     *
849     * @ingroup Theme
850     */
851    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
852
853    /**
854     * @defgroup Styles Styles
855     *
856     * Widgets can have different styles of look. These generic API's
857     * set styles of widgets, if they support them (and if the theme(s)
858     * do).
859     *
860     * @ref general_functions_example_page "This" example contemplates
861     * some of these functions.
862     */
863
864    /**
865     * Set the disabled state of an Elementary object.
866     *
867     * @param obj The Elementary object to operate on
868     * @param disabled The state to put in in: @c EINA_TRUE for
869     *        disabled, @c EINA_FALSE for enabled
870     *
871     * Elementary objects can be @b disabled, in which state they won't
872     * receive input and, in general, will be themed differently from
873     * their normal state, usually greyed out. Useful for contexts
874     * where you don't want your users to interact with some of the
875     * parts of you interface.
876     *
877     * This sets the state for the widget, either disabling it or
878     * enabling it back.
879     *
880     * @ingroup Styles
881     */
882    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
883
884    /**
885     * Get the disabled state of an Elementary object.
886     *
887     * @param obj The Elementary object to operate on
888     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
889     *            if it's enabled (or on errors)
890     *
891     * This gets the state of the widget, which might be enabled or disabled.
892     *
893     * @ingroup Styles
894     */
895    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
896
897    /**
898     * @defgroup WidgetNavigation Widget Tree Navigation.
899     *
900     * How to check if an Evas Object is an Elementary widget? How to
901     * get the first elementary widget that is parent of the given
902     * object?  These are all covered in widget tree navigation.
903     *
904     * @ref general_functions_example_page "This" example contemplates
905     * some of these functions.
906     */
907
908    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
909
910    /**
911     * Get the first parent of the given object that is an Elementary
912     * widget.
913     *
914     * @param obj the Elementary object to query parent from.
915     * @return the parent object that is an Elementary widget, or @c
916     *         NULL, if it was not found.
917     *
918     * Use this to query for an object's parent widget.
919     *
920     * @note Most of Elementary users wouldn't be mixing non-Elementary
921     * smart objects in the objects tree of an application, as this is
922     * an advanced usage of Elementary with Evas. So, except for the
923     * application's window, which is the root of that tree, all other
924     * objects would have valid Elementary widget parents.
925     *
926     * @ingroup WidgetNavigation
927     */
928    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
929    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
930    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
931
932    EAPI double       elm_scale_get(void);
933    EAPI void         elm_scale_set(double scale);
934    EAPI void         elm_scale_all_set(double scale);
935
936    EAPI Eina_Bool    elm_mirrored_get(void);
937    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
938
939    EAPI Eina_Bool    elm_config_save(void);
940    EAPI void         elm_config_reload(void);
941
942    EAPI const char  *elm_profile_current_get(void);
943    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
944    EAPI void         elm_profile_dir_free(const char *p_dir);
945    EAPI Eina_List   *elm_profile_list_get(void);
946    EAPI void         elm_profile_list_free(Eina_List *l);
947    EAPI void         elm_profile_set(const char *profile);
948    EAPI void         elm_profile_all_set(const char *profile);
949
950    EAPI const char  *elm_engine_current_get(void);
951    EAPI void         elm_engine_set(const char *engine);
952
953   typedef struct _Elm_Text_Class
954     {
955        const char *name;
956        const char *desc;
957     } Elm_Text_Class;
958
959   typedef struct _Elm_Font_Overlay
960     {
961        const char     *text_class;
962        const char     *font;
963        Evas_Font_Size  size;
964     } Elm_Font_Overlay;
965
966   typedef struct _Elm_Font_Properties
967     {
968        const char *name;
969        Eina_List  *styles;
970     } Elm_Font_Properties;
971
972    EAPI const Eina_List     *elm_text_classes_list_get(void);
973    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
974
975    EAPI const Eina_List     *elm_font_overlay_list_get(void);
976    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
977    EAPI void                 elm_font_overlay_unset(const char *text_class);
978    EAPI void                 elm_font_overlay_apply(void);
979    EAPI void                 elm_font_overlay_all_apply(void);
980
981    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
982    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
983    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
984    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
985    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
986    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
987
988    /**
989     * @defgroup Fingers Fingers
990     *
991     * Elementary is designed to be finger-friendly for touchscreens,
992     * and so in addition to scaling for display resolution, it can
993     * also scale based on finger "resolution" (or size). You can then
994     * customize the granularity of the areas meant to receive clicks
995     * on touchscreens.
996     *
997     * Different profiles may have pre-set values for finger sizes.
998     *
999     * @ref general_functions_example_page "This" example contemplates
1000     * some of these functions.
1001     */
1002
1003    /**
1004     * Get the configured "finger size"
1005     *
1006     * @return The finger size
1007     *
1008     * This gets the globally configured finger size, <b>in pixels</b>
1009     *
1010     * @ingroup Fingers
1011     */
1012    EAPI Evas_Coord       elm_finger_size_get(void);
1013    EAPI void             elm_finger_size_set(Evas_Coord size);
1014    EAPI void             elm_finger_size_all_set(Evas_Coord size);
1015
1016    /**
1017     * @defgroup Focus Focus
1018     *
1019     * An Elementary application has, at all times, one (and only one)
1020     * @b focused object. This is what determines where the input
1021     * events go to within the application's window. Also, focused
1022     * objects can be decorated differently, in order to signal to the
1023     * user where the input is, at a given moment.
1024     *
1025     * Elementary applications also have the concept of <b>focus
1026     * chain</b>: one can cycle through all the windows' focusable
1027     * objects by input (tab key) or programmatically. The default
1028     * focus chain for an application is the one define by the order in
1029     * which the widgets where added in code. One will cycle through
1030     * top level widgets, and, for each one containg sub-objects, cycle
1031     * through them all, before returning to the level
1032     * above. Elementary also allows one to set @b custom focus chains
1033     * for their applications.
1034     *
1035     * Besides the focused decoration a widget may exhibit, when it
1036     * gets focus, Elementary has a @b global focus highlight object
1037     * that can be enabled for a window. If one chooses to do so, this
1038     * extra highlight effect will surround the current focused object,
1039     * too.
1040     *
1041     * @note Some Elementary widgets are @b unfocusable, after
1042     * creation, by their very nature: they are not meant to be
1043     * interacted with input events, but are there just for visual
1044     * purposes.
1045     *
1046     * @ref general_functions_example_page "This" example contemplates
1047     * some of these functions.
1048     */
1049
1050    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
1051    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
1052    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
1053    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
1054
1055    /**
1056     * Get the whether an Elementary object has the focus or not.
1057     *
1058     * @param obj The Elementary object to get the information from
1059     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1060     *            not (and on errors).
1061     *
1062     * @see elm_object_focus()
1063     *
1064     * @ingroup Focus
1065     */
1066    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1067
1068    /**
1069     * Make a given Elementary object the focused one.
1070     *
1071     * @param obj The Elementary object to make focused.
1072     *
1073     * @note This object, if it can handle focus, will take the focus
1074     * away from the one who had it previously and will, for now on, be
1075     * the one receiving input events.
1076     *
1077     * @see elm_object_focus_get()
1078     *
1079     * @ingroup Focus
1080     */
1081    EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1082
1083    /**
1084     * Remove the focus from an Elementary object
1085     *
1086     * @param obj The Elementary to take focus from
1087     *
1088     * This removes the focus from @p obj, passing it back to the
1089     * previous element in the focus chain list.
1090     *
1091     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1092     *
1093     * @ingroup Focus
1094     */
1095    EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1096
1097    /**
1098     * Set the ability for an Element object to be focused
1099     *
1100     * @param obj The Elementary object to operate on
1101     * @param enable @c EINA_TRUE if the object can be focused, @c
1102     *        EINA_FALSE if not (and on errors)
1103     *
1104     * This sets whether the object @p obj is able to take focus or
1105     * not. Unfocusable objects do nothing when programmatically
1106     * focused, being the nearest focusable parent object the one
1107     * really getting focus. Also, when they receive mouse input, they
1108     * will get the event, but not take away the focus from where it
1109     * was previously.
1110     *
1111     * @ingroup Focus
1112     */
1113    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1114
1115    /**
1116     * Get whether an Elementary object is focusable or not
1117     *
1118     * @param obj The Elementary object to operate on
1119     * @return @c EINA_TRUE if the object is allowed to be focused, @c
1120     *             EINA_FALSE if not (and on errors)
1121     *
1122     * @note Objects which are meant to be interacted with by input
1123     * events are created able to be focused, by default. All the
1124     * others are not.
1125     *
1126     * @ingroup Focus
1127     */
1128    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1129
1130    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1131    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1132    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1133    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1134    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1135    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1136    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1137
1138    /**
1139     * Make the elementary object and its children to be unfocusable (or focusable).
1140     *
1141     * @param obj The Elementary object to operate on
1142     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1143     *        @c EINA_FALSE for focusable.
1144     *
1145     * This sets whether the object @p obj and its children objects
1146     * are able to take focus or not. If the tree is set as unfocusable,
1147     * newest focused object which is not in this tree will get focus.
1148     * This API can be helpful for an object to be deleted.
1149     * When an object will be deleted soon, it and its children may not
1150     * want to get focus (by focus reverting or by other focus controls).
1151     * Then, just use this API before deleting.
1152     *
1153     * @see elm_object_tree_unfocusable_get()
1154     *
1155     * @ingroup Focus
1156     */
1157    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1158
1159    /**
1160     * Get whether an Elementary object and its children are unfocusable or not.
1161     *
1162     * @param obj The Elementary object to get the information from
1163     * @return @c EINA_TRUE, if the tree is unfocussable,
1164     *         @c EINA_FALSE if not (and on errors).
1165     *
1166     * @see elm_object_tree_unfocusable_set()
1167     *
1168     * @ingroup Focus
1169     */
1170    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1171
1172    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
1173    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1174    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1175    EAPI double           elm_scroll_bounce_friction_get(void);
1176    EAPI void             elm_scroll_bounce_friction_set(double friction);
1177    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
1178    EAPI double           elm_scroll_page_scroll_friction_get(void);
1179    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
1180    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
1181    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
1182    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
1183    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
1184    EAPI double           elm_scroll_zoom_friction_get(void);
1185    EAPI void             elm_scroll_zoom_friction_set(double friction);
1186    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
1187    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
1188    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1189    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1190    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
1191    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1192    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1193    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
1194    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1195    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1196    EAPI double           elm_scroll_thumbscroll_friction_get(void);
1197    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
1198    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
1199    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
1200    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
1201    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
1202
1203    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1204    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1205    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1206    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1207    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1208    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1209    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1210    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1211
1212    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1213    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);
1214    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);
1215
1216    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1217    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1218
1219    /**
1220     * Adjust size of an element for finger usage.
1221     *
1222     * @param times_w How many fingers should fit horizontally
1223     * @param w Pointer to the width size to adjust
1224     * @param times_h How many fingers should fit vertically
1225     * @param h Pointer to the height size to adjust
1226     *
1227     * This takes width and height sizes (in pixels) as input and a
1228     * size multiple (which is how many fingers you want to place
1229     * within the area, being "finger" the size set by
1230     * elm_finger_size_set()), and adjusts the size to be large enough
1231     * to accommodate the resulting size -- if it doesn't already
1232     * accommodate it. On return the @p w and @p h sizes pointed to by
1233     * these parameters will be modified, on those conditions.
1234     *
1235     * @note This is kind of a low level Elementary call, most useful
1236     * on size evaluation times for widgets. An external user wouldn't
1237     * be calling, most of the time.
1238     *
1239     * @ingroup Fingers
1240     */
1241    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1242
1243    EAPI double           elm_longpress_timeout_get(void);
1244    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
1245
1246    /* debug
1247     * don't use it unless you are sure
1248     */
1249    EAPI void             elm_object_tree_dump(const Evas_Object *top);
1250    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1251
1252
1253    /* theme */
1254    /**
1255     * @defgroup Theme Theme
1256     *
1257     * Elementary uses Edje to theme its widgets, naturally. But for the most
1258     * part this is hidden behind a simpler interface that lets the user set
1259     * extensions and choose the style of widgets in a much easier way.
1260     *
1261     * Instead of thinking in terms of paths to Edje files and their groups
1262     * each time you want to change the appearance of a widget, Elementary
1263     * works so you can add any theme file with extensions or replace the
1264     * main theme at one point in the application, and then just set the style
1265     * of widgets with elm_object_style_set() and related functions. Elementary
1266     * will then look in its list of themes for a matching group and apply it,
1267     * and when the theme changes midway through the application, all widgets
1268     * will be updated accordingly.
1269     *
1270     * There are three concepts you need to know to understand how Elementary
1271     * theming works: default theme, extensions and overlays.
1272     *
1273     * Default theme, obviously enough, is the one that provides the default
1274     * look of all widgets. End users can change the theme used by Elementary
1275     * by setting the @c ELM_THEME environment variable before running an
1276     * application, or globally for all programs using the @c elementary_config
1277     * utility. Applications can change the default theme using elm_theme_set(),
1278     * but this can go against the user wishes, so it's not an adviced practice.
1279     *
1280     * Ideally, applications should find everything they need in the already
1281     * provided theme, but there may be occasions when that's not enough and
1282     * custom styles are required to correctly express the idea. For this
1283     * cases, Elementary has extensions.
1284     *
1285     * Extensions allow the application developer to write styles of its own
1286     * to apply to some widgets. This requires knowledge of how each widget
1287     * is themed, as extensions will always replace the entire group used by
1288     * the widget, so important signals and parts need to be there for the
1289     * object to behave properly (see documentation of Edje for details).
1290     * Once the theme for the extension is done, the application needs to add
1291     * it to the list of themes Elementary will look into, using
1292     * elm_theme_extension_add(), and set the style of the desired widgets as
1293     * he would normally with elm_object_style_set().
1294     *
1295     * Overlays, on the other hand, can replace the look of all widgets by
1296     * overriding the default style. Like extensions, it's up to the application
1297     * developer to write the theme for the widgets it wants, the difference
1298     * being that when looking for the theme, Elementary will check first the
1299     * list of overlays, then the set theme and lastly the list of extensions,
1300     * so with overlays it's possible to replace the default view and every
1301     * widget will be affected. This is very much alike to setting the whole
1302     * theme for the application and will probably clash with the end user
1303     * options, not to mention the risk of ending up with not matching styles
1304     * across the program. Unless there's a very special reason to use them,
1305     * overlays should be avoided for the resons exposed before.
1306     *
1307     * All these theme lists are handled by ::Elm_Theme instances. Elementary
1308     * keeps one default internally and every function that receives one of
1309     * these can be called with NULL to refer to this default (except for
1310     * elm_theme_free()). It's possible to create a new instance of a
1311     * ::Elm_Theme to set other theme for a specific widget (and all of its
1312     * children), but this is as discouraged, if not even more so, than using
1313     * overlays. Don't use this unless you really know what you are doing.
1314     *
1315     * But to be less negative about things, you can look at the following
1316     * examples:
1317     * @li @ref theme_example_01 "Using extensions"
1318     * @li @ref theme_example_02 "Using overlays"
1319     *
1320     * @{
1321     */
1322    /**
1323     * @typedef Elm_Theme
1324     *
1325     * Opaque handler for the list of themes Elementary looks for when
1326     * rendering widgets.
1327     *
1328     * Stay out of this unless you really know what you are doing. For most
1329     * cases, sticking to the default is all a developer needs.
1330     */
1331    typedef struct _Elm_Theme Elm_Theme;
1332
1333    /**
1334     * Create a new specific theme
1335     *
1336     * This creates an empty specific theme that only uses the default theme. A
1337     * specific theme has its own private set of extensions and overlays too
1338     * (which are empty by default). Specific themes do not fall back to themes
1339     * of parent objects. They are not intended for this use. Use styles, overlays
1340     * and extensions when needed, but avoid specific themes unless there is no
1341     * other way (example: you want to have a preview of a new theme you are
1342     * selecting in a "theme selector" window. The preview is inside a scroller
1343     * and should display what the theme you selected will look like, but not
1344     * actually apply it yet. The child of the scroller will have a specific
1345     * theme set to show this preview before the user decides to apply it to all
1346     * applications).
1347     */
1348    EAPI Elm_Theme       *elm_theme_new(void);
1349    /**
1350     * Free a specific theme
1351     *
1352     * @param th The theme to free
1353     *
1354     * This frees a theme created with elm_theme_new().
1355     */
1356    EAPI void             elm_theme_free(Elm_Theme *th);
1357    /**
1358     * Copy the theme fom the source to the destination theme
1359     *
1360     * @param th The source theme to copy from
1361     * @param thdst The destination theme to copy data to
1362     *
1363     * This makes a one-time static copy of all the theme config, extensions
1364     * and overlays from @p th to @p thdst. If @p th references a theme, then
1365     * @p thdst is also set to reference it, with all the theme settings,
1366     * overlays and extensions that @p th had.
1367     */
1368    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1369    /**
1370     * Tell the source theme to reference the ref theme
1371     *
1372     * @param th The theme that will do the referencing
1373     * @param thref The theme that is the reference source
1374     *
1375     * This clears @p th to be empty and then sets it to refer to @p thref
1376     * so @p th acts as an override to @p thref, but where its overrides
1377     * don't apply, it will fall through to @pthref for configuration.
1378     */
1379    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1380    /**
1381     * Return the theme referred to
1382     *
1383     * @param th The theme to get the reference from
1384     * @return The referenced theme handle
1385     *
1386     * This gets the theme set as the reference theme by elm_theme_ref_set().
1387     * If no theme is set as a reference, NULL is returned.
1388     */
1389    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
1390    /**
1391     * Return the default theme
1392     *
1393     * @return The default theme handle
1394     *
1395     * This returns the internal default theme setup handle that all widgets
1396     * use implicitly unless a specific theme is set. This is also often use
1397     * as a shorthand of NULL.
1398     */
1399    EAPI Elm_Theme       *elm_theme_default_get(void);
1400    /**
1401     * Prepends a theme overlay to the list of overlays
1402     *
1403     * @param th The theme to add to, or if NULL, the default theme
1404     * @param item The Edje file path to be used
1405     *
1406     * Use this if your application needs to provide some custom overlay theme
1407     * (An Edje file that replaces some default styles of widgets) where adding
1408     * new styles, or changing system theme configuration is not possible. Do
1409     * NOT use this instead of a proper system theme configuration. Use proper
1410     * configuration files, profiles, environment variables etc. to set a theme
1411     * so that the theme can be altered by simple confiugration by a user. Using
1412     * this call to achieve that effect is abusing the API and will create lots
1413     * of trouble.
1414     *
1415     * @see elm_theme_extension_add()
1416     */
1417    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
1418    /**
1419     * Delete a theme overlay from the list of overlays
1420     *
1421     * @param th The theme to delete from, or if NULL, the default theme
1422     * @param item The name of the theme overlay
1423     *
1424     * @see elm_theme_overlay_add()
1425     */
1426    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
1427    /**
1428     * Appends a theme extension to the list of extensions.
1429     *
1430     * @param th The theme to add to, or if NULL, the default theme
1431     * @param item The Edje file path to be used
1432     *
1433     * This is intended when an application needs more styles of widgets or new
1434     * widget themes that the default does not provide (or may not provide). The
1435     * application has "extended" usage by coming up with new custom style names
1436     * for widgets for specific uses, but as these are not "standard", they are
1437     * not guaranteed to be provided by a default theme. This means the
1438     * application is required to provide these extra elements itself in specific
1439     * Edje files. This call adds one of those Edje files to the theme search
1440     * path to be search after the default theme. The use of this call is
1441     * encouraged when default styles do not meet the needs of the application.
1442     * Use this call instead of elm_theme_overlay_add() for almost all cases.
1443     *
1444     * @see elm_object_style_set()
1445     */
1446    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
1447    /**
1448     * Deletes a theme extension from the list of extensions.
1449     *
1450     * @param th The theme to delete from, or if NULL, the default theme
1451     * @param item The name of the theme extension
1452     *
1453     * @see elm_theme_extension_add()
1454     */
1455    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
1456    /**
1457     * Set the theme search order for the given theme
1458     *
1459     * @param th The theme to set the search order, or if NULL, the default theme
1460     * @param theme Theme search string
1461     *
1462     * This sets the search string for the theme in path-notation from first
1463     * theme to search, to last, delimited by the : character. Example:
1464     *
1465     * "shiny:/path/to/file.edj:default"
1466     *
1467     * See the ELM_THEME environment variable for more information.
1468     *
1469     * @see elm_theme_get()
1470     * @see elm_theme_list_get()
1471     */
1472    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
1473    /**
1474     * Return the theme search order
1475     *
1476     * @param th The theme to get the search order, or if NULL, the default theme
1477     * @return The internal search order path
1478     *
1479     * This function returns a colon separated string of theme elements as
1480     * returned by elm_theme_list_get().
1481     *
1482     * @see elm_theme_set()
1483     * @see elm_theme_list_get()
1484     */
1485    EAPI const char      *elm_theme_get(Elm_Theme *th);
1486    /**
1487     * Return a list of theme elements to be used in a theme.
1488     *
1489     * @param th Theme to get the list of theme elements from.
1490     * @return The internal list of theme elements
1491     *
1492     * This returns the internal list of theme elements (will only be valid as
1493     * long as the theme is not modified by elm_theme_set() or theme is not
1494     * freed by elm_theme_free(). This is a list of strings which must not be
1495     * altered as they are also internal. If @p th is NULL, then the default
1496     * theme element list is returned.
1497     *
1498     * A theme element can consist of a full or relative path to a .edj file,
1499     * or a name, without extension, for a theme to be searched in the known
1500     * theme paths for Elemementary.
1501     *
1502     * @see elm_theme_set()
1503     * @see elm_theme_get()
1504     */
1505    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1506    /**
1507     * Return the full patrh for a theme element
1508     *
1509     * @param f The theme element name
1510     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1511     * @return The full path to the file found.
1512     *
1513     * This returns a string you should free with free() on success, NULL on
1514     * failure. This will search for the given theme element, and if it is a
1515     * full or relative path element or a simple searchable name. The returned
1516     * path is the full path to the file, if searched, and the file exists, or it
1517     * is simply the full path given in the element or a resolved path if
1518     * relative to home. The @p in_search_path boolean pointed to is set to
1519     * EINA_TRUE if the file was a searchable file andis in the search path,
1520     * and EINA_FALSE otherwise.
1521     */
1522    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1523    /**
1524     * Flush the current theme.
1525     *
1526     * @param th Theme to flush
1527     *
1528     * This flushes caches that let elementary know where to find theme elements
1529     * in the given theme. If @p th is NULL, then the default theme is flushed.
1530     * Call this function if source theme data has changed in such a way as to
1531     * make any caches Elementary kept invalid.
1532     */
1533    EAPI void             elm_theme_flush(Elm_Theme *th);
1534    /**
1535     * This flushes all themes (default and specific ones).
1536     *
1537     * This will flush all themes in the current application context, by calling
1538     * elm_theme_flush() on each of them.
1539     */
1540    EAPI void             elm_theme_full_flush(void);
1541    /**
1542     * Set the theme for all elementary using applications on the current display
1543     *
1544     * @param theme The name of the theme to use. Format same as the ELM_THEME
1545     * environment variable.
1546     */
1547    EAPI void             elm_theme_all_set(const char *theme);
1548    /**
1549     * Return a list of theme elements in the theme search path
1550     *
1551     * @return A list of strings that are the theme element names.
1552     *
1553     * This lists all available theme files in the standard Elementary search path
1554     * for theme elements, and returns them in alphabetical order as theme
1555     * element names in a list of strings. Free this with
1556     * elm_theme_name_available_list_free() when you are done with the list.
1557     */
1558    EAPI Eina_List       *elm_theme_name_available_list_new(void);
1559    /**
1560     * Free the list returned by elm_theme_name_available_list_new()
1561     *
1562     * This frees the list of themes returned by
1563     * elm_theme_name_available_list_new(). Once freed the list should no longer
1564     * be used. a new list mys be created.
1565     */
1566    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
1567    /**
1568     * Set a specific theme to be used for this object and its children
1569     *
1570     * @param obj The object to set the theme on
1571     * @param th The theme to set
1572     *
1573     * This sets a specific theme that will be used for the given object and any
1574     * child objects it has. If @p th is NULL then the theme to be used is
1575     * cleared and the object will inherit its theme from its parent (which
1576     * ultimately will use the default theme if no specific themes are set).
1577     *
1578     * Use special themes with great care as this will annoy users and make
1579     * configuration difficult. Avoid any custom themes at all if it can be
1580     * helped.
1581     */
1582    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1583    /**
1584     * Get the specific theme to be used
1585     *
1586     * @param obj The object to get the specific theme from
1587     * @return The specifc theme set.
1588     *
1589     * This will return a specific theme set, or NULL if no specific theme is
1590     * set on that object. It will not return inherited themes from parents, only
1591     * the specific theme set for that specific object. See elm_object_theme_set()
1592     * for more information.
1593     */
1594    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1595    /**
1596     * @}
1597     */
1598
1599    /* win */
1600    typedef enum _Elm_Win_Type
1601      {
1602         ELM_WIN_BASIC,
1603         ELM_WIN_DIALOG_BASIC,
1604         ELM_WIN_DESKTOP,
1605         ELM_WIN_DOCK,
1606         ELM_WIN_TOOLBAR,
1607         ELM_WIN_MENU,
1608         ELM_WIN_UTILITY,
1609         ELM_WIN_SPLASH,
1610         ELM_WIN_DROPDOWN_MENU,
1611         ELM_WIN_POPUP_MENU,
1612         ELM_WIN_TOOLTIP,
1613         ELM_WIN_NOTIFICATION,
1614         ELM_WIN_COMBO,
1615         ELM_WIN_DND,
1616         ELM_WIN_INLINED_IMAGE,
1617      } Elm_Win_Type;
1618
1619    typedef enum _Elm_Win_Keyboard_Mode
1620      {
1621         ELM_WIN_KEYBOARD_UNKNOWN,
1622         ELM_WIN_KEYBOARD_OFF,
1623         ELM_WIN_KEYBOARD_ON,
1624         ELM_WIN_KEYBOARD_ALPHA,
1625         ELM_WIN_KEYBOARD_NUMERIC,
1626         ELM_WIN_KEYBOARD_PIN,
1627         ELM_WIN_KEYBOARD_PHONE_NUMBER,
1628         ELM_WIN_KEYBOARD_HEX,
1629         ELM_WIN_KEYBOARD_TERMINAL,
1630         ELM_WIN_KEYBOARD_PASSWORD,
1631         ELM_WIN_KEYBOARD_IP,
1632         ELM_WIN_KEYBOARD_HOST,
1633         ELM_WIN_KEYBOARD_FILE,
1634         ELM_WIN_KEYBOARD_URL,
1635         ELM_WIN_KEYBOARD_KEYPAD,
1636         ELM_WIN_KEYBOARD_J2ME
1637      } Elm_Win_Keyboard_Mode;
1638
1639    typedef enum _Elm_Illume_Command
1640      {
1641         ELM_ILLUME_COMMAND_FOCUS_BACK,
1642         ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1643         ELM_ILLUME_COMMAND_FOCUS_HOME,
1644         ELM_ILLUME_COMMAND_CLOSE
1645      } Elm_Illume_Command;
1646
1647    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1648    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1649    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1650    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1651    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1652    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1653    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1654    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1655    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1656    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1657    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1658    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1659    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1660    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1661    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1662    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1663    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1664    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1665    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1666    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1667    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1668    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1669    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1670    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1671    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1672    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1673    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1674    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1675    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1676    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1677    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1678    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1679    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1680    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1681    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1682    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1683    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1684    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1685    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1686    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1687    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1688    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1689    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1690    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1691    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1692    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1693    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1694    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1695    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1696    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1697    /*...
1698     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1699     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1700     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1701     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1702     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1703     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1704     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1705     *
1706     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1707     * (blank mouse, private mouse obj, defaultmouse)
1708     *
1709     */
1710    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1711    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1712    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1713    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1714
1715    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1716
1717    /**
1718     * @defgroup Inwin Inwin
1719     *
1720     * @image html img/widget/inwin/preview-00.png
1721     * @image latex img/widget/inwin/preview-00.eps
1722     * @image html img/widget/inwin/preview-01.png
1723     * @image latex img/widget/inwin/preview-01.eps
1724     * @image html img/widget/inwin/preview-02.png
1725     * @image latex img/widget/inwin/preview-02.eps
1726     *
1727     * An inwin is a window inside a window that is useful for a quick popup.
1728     * It does not hover.
1729     *
1730     * It works by creating an object that will occupy the entire window, so it
1731     * must be created using an @ref Win "elm_win" as parent only. The inwin
1732     * object can be hidden or restacked below every other object if it's
1733     * needed to show what's behind it without destroying it. If this is done,
1734     * the elm_win_inwin_activate() function can be used to bring it back to
1735     * full visibility again.
1736     *
1737     * There are three styles available in the default theme. These are:
1738     * @li default: The inwin is sized to take over most of the window it's
1739     * placed in.
1740     * @li minimal: The size of the inwin will be the minimum necessary to show
1741     * its contents.
1742     * @li minimal_vertical: Horizontally, the inwin takes as much space as
1743     * possible, but it's sized vertically the most it needs to fit its\
1744     * contents.
1745     *
1746     * Some examples of Inwin can be found in the following:
1747     * @li @ref inwin_example_01
1748     *
1749     * @{
1750     */
1751    /**
1752     * Adds an inwin to the current window
1753     *
1754     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
1755     * Never call this function with anything other than the top-most window
1756     * as its parameter, unless you are fond of undefined behavior.
1757     *
1758     * After creating the object, the widget will set itself as resize object
1759     * for the window with elm_win_resize_object_add(), so when shown it will
1760     * appear to cover almost the entire window (how much of it depends on its
1761     * content and the style used). It must not be added into other container
1762     * objects and it needs not be moved or resized manually.
1763     *
1764     * @param parent The parent object
1765     * @return The new object or NULL if it cannot be created
1766     */
1767    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1768    /**
1769     * Activates an inwin object, ensuring its visibility
1770     *
1771     * This function will make sure that the inwin @p obj is completely visible
1772     * by calling evas_object_show() and evas_object_raise() on it, to bring it
1773     * to the front. It also sets the keyboard focus to it, which will be passed
1774     * onto its content.
1775     *
1776     * The object's theme will also receive the signal "elm,action,show" with
1777     * source "elm".
1778     *
1779     * @param obj The inwin to activate
1780     */
1781    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1782    /**
1783     * Set the content of an inwin object.
1784     *
1785     * Once the content object is set, a previously set one will be deleted.
1786     * If you want to keep that old content object, use the
1787     * elm_win_inwin_content_unset() function.
1788     *
1789     * @param obj The inwin object
1790     * @param content The object to set as content
1791     */
1792    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1793    /**
1794     * Get the content of an inwin object.
1795     *
1796     * Return the content object which is set for this widget.
1797     *
1798     * The returned object is valid as long as the inwin is still alive and no
1799     * other content is set on it. Deleting the object will notify the inwin
1800     * about it and this one will be left empty.
1801     *
1802     * If you need to remove an inwin's content to be reused somewhere else,
1803     * see elm_win_inwin_content_unset().
1804     *
1805     * @param obj The inwin object
1806     * @return The content that is being used
1807     */
1808    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1809    /**
1810     * Unset the content of an inwin object.
1811     *
1812     * Unparent and return the content object which was set for this widget.
1813     *
1814     * @param obj The inwin object
1815     * @return The content that was being used
1816     */
1817    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1818    /**
1819     * @}
1820     */
1821    /* X specific calls - won't work on non-x engines (return 0) */
1822    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1823    /* smart callbacks called:
1824     * "delete,request" - the user requested to delete the window
1825     * "focus,in" - window got focus
1826     * "focus,out" - window lost focus
1827     * "moved" - window that holds the canvas was moved
1828     */
1829
1830    /**
1831     * @defgroup Bg Bg
1832     *
1833     * @image html img/icon/bg/preview-00.png
1834     * @image latex img/icon/bg/preview-00.png
1835     *
1836     * @brief Background object, used for setting a solid color, image or Edje
1837     * group as background to a window or any container object.
1838     *
1839     * The bg object is used for setting a solid background to a window or
1840     * packing into any container object. It works just like an image, but has
1841     * some properties useful to a background, like setting it to tiled,
1842     * centered, scaled or stretched.
1843     *
1844     * Here is some sample code using it:
1845     * @li @ref bg_01_example_page
1846     * @li @ref bg_02_example_page
1847     * @li @ref bg_03_example_page
1848     */
1849
1850    /* bg */
1851    typedef enum _Elm_Bg_Option
1852      {
1853         ELM_BG_OPTION_CENTER,  /**< center the background */
1854         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
1855         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1856         ELM_BG_OPTION_TILE     /**< tile background at its original size */
1857      } Elm_Bg_Option;
1858
1859    /**
1860     * Add a new background to the parent
1861     *
1862     * @param parent The parent object
1863     * @return The new object or NULL if it cannot be created
1864     *
1865     * @ingroup Bg
1866     */
1867    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1868
1869    /**
1870     * Set the file (image or edje) used for the background
1871     *
1872     * @param obj The bg object
1873     * @param file The file path
1874     * @param group Optional key (group in Edje) within the file
1875     *
1876     * This sets the image file used in the background object. The image (or edje)
1877     * will be stretched (retaining aspect if its an image file) to completely fill
1878     * the bg object. This may mean some parts are not visible.
1879     *
1880     * @note  Once the image of @p obj is set, a previously set one will be deleted,
1881     * even if @p file is NULL.
1882     *
1883     * @ingroup Bg
1884     */
1885    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1886
1887    /**
1888     * Get the file (image or edje) used for the background
1889     *
1890     * @param obj The bg object
1891     * @param file The file path
1892     * @param group Optional key (group in Edje) within the file
1893     *
1894     * @ingroup Bg
1895     */
1896    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1897
1898    /**
1899     * Set the option used for the background image
1900     *
1901     * @param obj The bg object
1902     * @param option The desired background option (TILE, SCALE)
1903     *
1904     * This sets the option used for manipulating the display of the background
1905     * image. The image can be tiled or scaled.
1906     *
1907     * @ingroup Bg
1908     */
1909    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1910
1911    /**
1912     * Get the option used for the background image
1913     *
1914     * @param obj The bg object
1915     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1916     *
1917     * @ingroup Bg
1918     */
1919    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1920    /**
1921     * Set the option used for the background color
1922     *
1923     * @param obj The bg object
1924     * @param r
1925     * @param g
1926     * @param b
1927     *
1928     * This sets the color used for the background rectangle. Its range goes
1929     * from 0 to 255.
1930     *
1931     * @ingroup Bg
1932     */
1933    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1934    /**
1935     * Get the option used for the background color
1936     *
1937     * @param obj The bg object
1938     * @param r
1939     * @param g
1940     * @param b
1941     *
1942     * @ingroup Bg
1943     */
1944    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1945
1946    /**
1947     * Set the overlay object used for the background object.
1948     *
1949     * @param obj The bg object
1950     * @param overlay The overlay object
1951     *
1952     * This provides a way for elm_bg to have an 'overlay' that will be on top
1953     * of the bg. Once the over object is set, a previously set one will be
1954     * deleted, even if you set the new one to NULL. If you want to keep that
1955     * old content object, use the elm_bg_overlay_unset() function.
1956     *
1957     * @ingroup Bg
1958     */
1959
1960    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1961
1962    /**
1963     * Get the overlay object used for the background object.
1964     *
1965     * @param obj The bg object
1966     * @return The content that is being used
1967     *
1968     * Return the content object which is set for this widget
1969     *
1970     * @ingroup Bg
1971     */
1972    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1973
1974    /**
1975     * Get the overlay object used for the background object.
1976     *
1977     * @param obj The bg object
1978     * @return The content that was being used
1979     *
1980     * Unparent and return the overlay object which was set for this widget
1981     *
1982     * @ingroup Bg
1983     */
1984    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1985
1986    /**
1987     * Set the size of the pixmap representation of the image.
1988     *
1989     * This option just makes sense if an image is going to be set in the bg.
1990     *
1991     * @param obj The bg object
1992     * @param w The new width of the image pixmap representation.
1993     * @param h The new height of the image pixmap representation.
1994     *
1995     * This function sets a new size for pixmap representation of the given bg
1996     * image. It allows the image to be loaded already in the specified size,
1997     * reducing the memory usage and load time when loading a big image with load
1998     * size set to a smaller size.
1999     *
2000     * NOTE: this is just a hint, the real size of the pixmap may differ
2001     * depending on the type of image being loaded, being bigger than requested.
2002     *
2003     * @ingroup Bg
2004     */
2005    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2006    /* smart callbacks called:
2007     */
2008
2009    /**
2010     * @defgroup Icon Icon
2011     *
2012     * @image html img/icon/button/preview-00.png
2013     * @image latex img/icon/button/preview-00.png
2014     *
2015     * An object that provides standard icon images (delete, edit, arrows, etc.)
2016     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2017     *
2018     * The icon image requested can be in the elementary theme, or in the
2019     * freedesktop.org paths. It's possible to set the order of preference from
2020     * where the image will be used.
2021     *
2022     * This API is very similar to @ref Image, but with ready to use images.
2023     *
2024     * Default images provided by the theme are described below.
2025     *
2026     * The first list contains icons that were first intended to be used in
2027     * toolbars, but can be used in many other places too:
2028     * @li home
2029     * @li close
2030     * @li apps
2031     * @li arrow_up
2032     * @li arrow_down
2033     * @li arrow_left
2034     * @li arrow_right
2035     * @li chat
2036     * @li clock
2037     * @li delete
2038     * @li edit
2039     * @li refresh
2040     * @li folder
2041     * @li file
2042     *
2043     * Now some icons that were designed to be used in menus (but again, you can
2044     * use them anywhere else):
2045     * @li menu/home
2046     * @li menu/close
2047     * @li menu/apps
2048     * @li menu/arrow_up
2049     * @li menu/arrow_down
2050     * @li menu/arrow_left
2051     * @li menu/arrow_right
2052     * @li menu/chat
2053     * @li menu/clock
2054     * @li menu/delete
2055     * @li menu/edit
2056     * @li menu/refresh
2057     * @li menu/folder
2058     * @li menu/file
2059     *
2060     * And here we have some media player specific icons:
2061     * @li media_player/forward
2062     * @li media_player/info
2063     * @li media_player/next
2064     * @li media_player/pause
2065     * @li media_player/play
2066     * @li media_player/prev
2067     * @li media_player/rewind
2068     * @li media_player/stop
2069     *
2070     * Signals that you can add callbacks for are:
2071     *
2072     * "clicked" - This is called when a user has clicked the icon
2073     *
2074     * An example of usage for this API follows:
2075     * @li @ref tutorial_icon
2076     */
2077
2078    /**
2079     * @addtogroup Icon
2080     * @{
2081     */
2082
2083    typedef enum _Elm_Icon_Type
2084      {
2085         ELM_ICON_NONE,
2086         ELM_ICON_FILE,
2087         ELM_ICON_STANDARD
2088      } Elm_Icon_Type;
2089    /**
2090     * @enum _Elm_Icon_Lookup_Order
2091     * @typedef Elm_Icon_Lookup_Order
2092     *
2093     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
2094     * theme, FDO paths, or both?
2095     *
2096     * @ingroup Icon
2097     */
2098    typedef enum _Elm_Icon_Lookup_Order
2099      {
2100         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2101         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2102         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
2103         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
2104      } Elm_Icon_Lookup_Order;
2105
2106    /**
2107     * Add a new icon object to the parent.
2108     *
2109     * @param parent The parent object
2110     * @return The new object or NULL if it cannot be created
2111     *
2112     * @see elm_icon_file_set()
2113     *
2114     * @ingroup Icon
2115     */
2116    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2117    /**
2118     * Set the file that will be used as icon.
2119     *
2120     * @param obj The icon object
2121     * @param file The path to file that will be used as icon image
2122     * @param group The group that the icon belongs to in edje file
2123     *
2124     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2125     *
2126     * @note The icon image set by this function can be changed by
2127     * elm_icon_standard_set().
2128     *
2129     * @see elm_icon_file_get()
2130     *
2131     * @ingroup Icon
2132     */
2133    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2134    /**
2135     * Set a location in memory to be used as an icon
2136     *
2137     * @param obj The icon object
2138     * @param img The binary data that will be used as an image
2139     * @param size The size of binary data @p img
2140     * @param format Optional format of @p img to pass to the image loader
2141     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
2142     *
2143     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2144     *
2145     * @note The icon image set by this function can be changed by
2146     * elm_icon_standard_set().
2147     *
2148     * @ingroup Icon
2149     */
2150    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);
2151    /**
2152     * Get the file that will be used as icon.
2153     *
2154     * @param obj The icon object
2155     * @param file The path to file that will be used as icon icon image
2156     * @param group The group that the icon belongs to in edje file
2157     *
2158     * @see elm_icon_file_set()
2159     *
2160     * @ingroup Icon
2161     */
2162    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2163    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2164    /**
2165     * Set the icon by icon standards names.
2166     *
2167     * @param obj The icon object
2168     * @param name The icon name
2169     *
2170     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2171     *
2172     * For example, freedesktop.org defines standard icon names such as "home",
2173     * "network", etc. There can be different icon sets to match those icon
2174     * keys. The @p name given as parameter is one of these "keys", and will be
2175     * used to look in the freedesktop.org paths and elementary theme. One can
2176     * change the lookup order with elm_icon_order_lookup_set().
2177     *
2178     * If name is not found in any of the expected locations and it is the
2179     * absolute path of an image file, this image will be used.
2180     *
2181     * @note The icon image set by this function can be changed by
2182     * elm_icon_file_set().
2183     *
2184     * @see elm_icon_standard_get()
2185     * @see elm_icon_file_set()
2186     *
2187     * @ingroup Icon
2188     */
2189    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2190    /**
2191     * Get the icon name set by icon standard names.
2192     *
2193     * @param obj The icon object
2194     * @return The icon name
2195     *
2196     * If the icon image was set using elm_icon_file_set() instead of
2197     * elm_icon_standard_set(), then this function will return @c NULL.
2198     *
2199     * @see elm_icon_standard_set()
2200     *
2201     * @ingroup Icon
2202     */
2203    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2204    /**
2205     * Set the smooth effect for an icon object.
2206     *
2207     * @param obj The icon object
2208     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2209     * otherwise. Default is @c EINA_TRUE.
2210     *
2211     * Set the scaling algorithm to be used when scaling the icon image. Smooth
2212     * scaling provides a better resulting image, but is slower.
2213     *
2214     * The smooth scaling should be disabled when making animations that change
2215     * the icon size, since they will be faster. Animations that don't require
2216     * resizing of the icon can keep the smooth scaling enabled (even if the icon
2217     * is already scaled, since the scaled icon image will be cached).
2218     *
2219     * @see elm_icon_smooth_get()
2220     *
2221     * @ingroup Icon
2222     */
2223    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2224    /**
2225     * Get the smooth effect for an icon object.
2226     *
2227     * @param obj The icon object
2228     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2229     *
2230     * @see elm_icon_smooth_set()
2231     *
2232     * @ingroup Icon
2233     */
2234    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2235    /**
2236     * Disable scaling of this object.
2237     *
2238     * @param obj The icon object.
2239     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2240     * otherwise. Default is @c EINA_FALSE.
2241     *
2242     * This function disables scaling of the icon object through the function
2243     * elm_object_scale_set(). However, this does not affect the object
2244     * size/resize in any way. For that effect, take a look at
2245     * elm_icon_scale_set().
2246     *
2247     * @see elm_icon_no_scale_get()
2248     * @see elm_icon_scale_set()
2249     * @see elm_object_scale_set()
2250     *
2251     * @ingroup Icon
2252     */
2253    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2254    /**
2255     * Get whether scaling is disabled on the object.
2256     *
2257     * @param obj The icon object
2258     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2259     *
2260     * @see elm_icon_no_scale_set()
2261     *
2262     * @ingroup Icon
2263     */
2264    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2265    /**
2266     * Set if the object is (up/down) resizeable.
2267     *
2268     * @param obj The icon object
2269     * @param scale_up A bool to set if the object is resizeable up. Default is
2270     * @c EINA_TRUE.
2271     * @param scale_down A bool to set if the object is resizeable down. Default
2272     * is @c EINA_TRUE.
2273     *
2274     * This function limits the icon object resize ability. If @p scale_up is set to
2275     * @c EINA_FALSE, the object can't have its height or width resized to a value
2276     * higher than the original icon size. Same is valid for @p scale_down.
2277     *
2278     * @see elm_icon_scale_get()
2279     *
2280     * @ingroup Icon
2281     */
2282    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2283    /**
2284     * Get if the object is (up/down) resizeable.
2285     *
2286     * @param obj The icon object
2287     * @param scale_up A bool to set if the object is resizeable up
2288     * @param scale_down A bool to set if the object is resizeable down
2289     *
2290     * @see elm_icon_scale_set()
2291     *
2292     * @ingroup Icon
2293     */
2294    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2295    /**
2296     * Get the object's image size
2297     *
2298     * @param obj The icon object
2299     * @param w A pointer to store the width in
2300     * @param h A pointer to store the height in
2301     *
2302     * @ingroup Icon
2303     */
2304    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2305    /**
2306     * Set if the icon fill the entire object area.
2307     *
2308     * @param obj The icon object
2309     * @param fill_outside @c EINA_TRUE if the object is filled outside,
2310     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2311     *
2312     * When the icon object is resized to a different aspect ratio from the
2313     * original icon image, the icon image will still keep its aspect. This flag
2314     * tells how the image should fill the object's area. They are: keep the
2315     * entire icon inside the limits of height and width of the object (@p
2316     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
2317     * of the object, and the icon will fill the entire object (@p fill_outside
2318     * is @c EINA_TRUE).
2319     *
2320     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
2321     * retain property to false. Thus, the icon image will always keep its
2322     * original aspect ratio.
2323     *
2324     * @see elm_icon_fill_outside_get()
2325     * @see elm_image_fill_outside_set()
2326     *
2327     * @ingroup Icon
2328     */
2329    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2330    /**
2331     * Get if the object is filled outside.
2332     *
2333     * @param obj The icon object
2334     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2335     *
2336     * @see elm_icon_fill_outside_set()
2337     *
2338     * @ingroup Icon
2339     */
2340    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2341    /**
2342     * Set the prescale size for the icon.
2343     *
2344     * @param obj The icon object
2345     * @param size The prescale size. This value is used for both width and
2346     * height.
2347     *
2348     * This function sets a new size for pixmap representation of the given
2349     * icon. It allows the icon to be loaded already in the specified size,
2350     * reducing the memory usage and load time when loading a big icon with load
2351     * size set to a smaller size.
2352     *
2353     * It's equivalent to the elm_bg_load_size_set() function for bg.
2354     *
2355     * @note this is just a hint, the real size of the pixmap may differ
2356     * depending on the type of icon being loaded, being bigger than requested.
2357     *
2358     * @see elm_icon_prescale_get()
2359     * @see elm_bg_load_size_set()
2360     *
2361     * @ingroup Icon
2362     */
2363    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2364    /**
2365     * Get the prescale size for the icon.
2366     *
2367     * @param obj The icon object
2368     * @return The prescale size
2369     *
2370     * @see elm_icon_prescale_set()
2371     *
2372     * @ingroup Icon
2373     */
2374    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2375    /**
2376     * Sets the icon lookup order used by elm_icon_standard_set().
2377     *
2378     * @param obj The icon object
2379     * @param order The icon lookup order (can be one of
2380     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
2381     * or ELM_ICON_LOOKUP_THEME)
2382     *
2383     * @see elm_icon_order_lookup_get()
2384     * @see Elm_Icon_Lookup_Order
2385     *
2386     * @ingroup Icon
2387     */
2388    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2389    /**
2390     * Gets the icon lookup order.
2391     *
2392     * @param obj The icon object
2393     * @return The icon lookup order
2394     *
2395     * @see elm_icon_order_lookup_set()
2396     * @see Elm_Icon_Lookup_Order
2397     *
2398     * @ingroup Icon
2399     */
2400    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2401
2402    /**
2403     * @}
2404     */
2405
2406    /**
2407     * @defgroup Image Image
2408     *
2409     * @image html img/image/button/preview-00.png
2410     * @image latex img/image/button/preview-00.png
2411     *
2412     * An object that allows one to load an image file to it. It can be used
2413     * anywhere like any other elementary widget.
2414     *
2415     * This widget provides most of the functionality provided from @ref Bg or @ref
2416     * Icon, but with a slightly different API (use the one that fits better your
2417     * needs).
2418     *
2419     * The features not provided by those two other image widgets are:
2420     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
2421     * @li change the object orientation with elm_image_orient_set();
2422     * @li and turning the image editable with elm_image_editable_set().
2423     *
2424     * Signals that you can add callbacks for are:
2425     *
2426     * @li @c "clicked" - This is called when a user has clicked the image
2427     *
2428     * An example of usage for this API follows:
2429     * @li @ref tutorial_image
2430     */
2431
2432    /**
2433     * @addtogroup Image
2434     * @{
2435     */
2436
2437    /**
2438     * @enum _Elm_Image_Orient
2439     * @typedef Elm_Image_Orient
2440     *
2441     * Possible orientation options for elm_image_orient_set().
2442     *
2443     * @image html elm_image_orient_set.png
2444     * @image latex elm_image_orient_set.eps width=\textwidth
2445     *
2446     * @ingroup Image
2447     */
2448    typedef enum _Elm_Image_Orient
2449      {
2450         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
2451         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
2452         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
2453         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
2454         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
2455         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
2456         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
2457         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
2458      } Elm_Image_Orient;
2459
2460    /**
2461     * Add a new image to the parent.
2462     *
2463     * @param parent The parent object
2464     * @return The new object or NULL if it cannot be created
2465     *
2466     * @see elm_image_file_set()
2467     *
2468     * @ingroup Image
2469     */
2470    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2471    /**
2472     * Set the file that will be used as image.
2473     *
2474     * @param obj The image object
2475     * @param file The path to file that will be used as image
2476     * @param group The group that the image belongs in edje file (if it's an
2477     * edje image)
2478     *
2479     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2480     *
2481     * @see elm_image_file_get()
2482     *
2483     * @ingroup Image
2484     */
2485    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2486    /**
2487     * Get the file that will be used as image.
2488     *
2489     * @param obj The image object
2490     * @param file The path to file
2491     * @param group The group that the image belongs in edje file
2492     *
2493     * @see elm_image_file_set()
2494     *
2495     * @ingroup Image
2496     */
2497    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2498    /**
2499     * Set the smooth effect for an image.
2500     *
2501     * @param obj The image object
2502     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2503     * otherwise. Default is @c EINA_TRUE.
2504     *
2505     * Set the scaling algorithm to be used when scaling the image. Smooth
2506     * scaling provides a better resulting image, but is slower.
2507     *
2508     * The smooth scaling should be disabled when making animations that change
2509     * the image size, since it will be faster. Animations that don't require
2510     * resizing of the image can keep the smooth scaling enabled (even if the
2511     * image is already scaled, since the scaled image will be cached).
2512     *
2513     * @see elm_image_smooth_get()
2514     *
2515     * @ingroup Image
2516     */
2517    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2518    /**
2519     * Get the smooth effect for an image.
2520     *
2521     * @param obj The image object
2522     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2523     *
2524     * @see elm_image_smooth_get()
2525     *
2526     * @ingroup Image
2527     */
2528    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2529    /**
2530     * Gets the current size of the image.
2531     *
2532     * @param obj The image object.
2533     * @param w Pointer to store width, or NULL.
2534     * @param h Pointer to store height, or NULL.
2535     *
2536     * This is the real size of the image, not the size of the object.
2537     *
2538     * On error, neither w or h will be written.
2539     *
2540     * @ingroup Image
2541     */
2542    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2543    /**
2544     * Disable scaling of this object.
2545     *
2546     * @param obj The image object.
2547     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2548     * otherwise. Default is @c EINA_FALSE.
2549     *
2550     * This function disables scaling of the elm_image widget through the
2551     * function elm_object_scale_set(). However, this does not affect the widget
2552     * size/resize in any way. For that effect, take a look at
2553     * elm_image_scale_set().
2554     *
2555     * @see elm_image_no_scale_get()
2556     * @see elm_image_scale_set()
2557     * @see elm_object_scale_set()
2558     *
2559     * @ingroup Image
2560     */
2561    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2562    /**
2563     * Get whether scaling is disabled on the object.
2564     *
2565     * @param obj The image object
2566     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2567     *
2568     * @see elm_image_no_scale_set()
2569     *
2570     * @ingroup Image
2571     */
2572    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2573    /**
2574     * Set if the object is (up/down) resizeable.
2575     *
2576     * @param obj The image object
2577     * @param scale_up A bool to set if the object is resizeable up. Default is
2578     * @c EINA_TRUE.
2579     * @param scale_down A bool to set if the object is resizeable down. Default
2580     * is @c EINA_TRUE.
2581     *
2582     * This function limits the image resize ability. If @p scale_up is set to
2583     * @c EINA_FALSE, the object can't have its height or width resized to a value
2584     * higher than the original image size. Same is valid for @p scale_down.
2585     *
2586     * @see elm_image_scale_get()
2587     *
2588     * @ingroup Image
2589     */
2590    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2591    /**
2592     * Get if the object is (up/down) resizeable.
2593     *
2594     * @param obj The image object
2595     * @param scale_up A bool to set if the object is resizeable up
2596     * @param scale_down A bool to set if the object is resizeable down
2597     *
2598     * @see elm_image_scale_set()
2599     *
2600     * @ingroup Image
2601     */
2602    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2603    /**
2604     * Set if the image fill the entire object area when keeping the aspect ratio.
2605     *
2606     * @param obj The image object
2607     * @param fill_outside @c EINA_TRUE if the object is filled outside,
2608     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2609     *
2610     * When the image should keep its aspect ratio even if resized to another
2611     * aspect ratio, there are two possibilities to resize it: keep the entire
2612     * image inside the limits of height and width of the object (@p fill_outside
2613     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
2614     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
2615     *
2616     * @note This option will have no effect if
2617     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
2618     *
2619     * @see elm_image_fill_outside_get()
2620     * @see elm_image_aspect_ratio_retained_set()
2621     *
2622     * @ingroup Image
2623     */
2624    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2625    /**
2626     * Get if the object is filled outside
2627     *
2628     * @param obj The image object
2629     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2630     *
2631     * @see elm_image_fill_outside_set()
2632     *
2633     * @ingroup Image
2634     */
2635    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2636    /**
2637     * Set the prescale size for the image
2638     *
2639     * @param obj The image object
2640     * @param size The prescale size. This value is used for both width and
2641     * height.
2642     *
2643     * This function sets a new size for pixmap representation of the given
2644     * image. It allows the image to be loaded already in the specified size,
2645     * reducing the memory usage and load time when loading a big image with load
2646     * size set to a smaller size.
2647     *
2648     * It's equivalent to the elm_bg_load_size_set() function for bg.
2649     *
2650     * @note this is just a hint, the real size of the pixmap may differ
2651     * depending on the type of image being loaded, being bigger than requested.
2652     *
2653     * @see elm_image_prescale_get()
2654     * @see elm_bg_load_size_set()
2655     *
2656     * @ingroup Image
2657     */
2658    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2659    /**
2660     * Get the prescale size for the image
2661     *
2662     * @param obj The image object
2663     * @return The prescale size
2664     *
2665     * @see elm_image_prescale_set()
2666     *
2667     * @ingroup Image
2668     */
2669    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2670    /**
2671     * Set the image orientation.
2672     *
2673     * @param obj The image object
2674     * @param orient The image orientation
2675     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2676     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2677     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2678     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
2679     *  Default is #ELM_IMAGE_ORIENT_NONE.
2680     *
2681     * This function allows to rotate or flip the given image.
2682     *
2683     * @see elm_image_orient_get()
2684     * @see @ref Elm_Image_Orient
2685     *
2686     * @ingroup Image
2687     */
2688    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2689    /**
2690     * Get the image orientation.
2691     *
2692     * @param obj The image object
2693     * @return The image orientation
2694     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2695     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2696     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2697     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
2698     *
2699     * @see elm_image_orient_set()
2700     * @see @ref Elm_Image_Orient
2701     *
2702     * @ingroup Image
2703     */
2704    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2705    /**
2706     * Make the image 'editable'.
2707     *
2708     * @param obj Image object.
2709     * @param set Turn on or off editability. Default is @c EINA_FALSE.
2710     *
2711     * This means the image is a valid drag target for drag and drop, and can be
2712     * cut or pasted too.
2713     *
2714     * @ingroup Image
2715     */
2716    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2717    /**
2718     * Make the image 'editable'.
2719     *
2720     * @param obj Image object.
2721     * @return Editability.
2722     *
2723     * This means the image is a valid drag target for drag and drop, and can be
2724     * cut or pasted too.
2725     *
2726     * @ingroup Image
2727     */
2728    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2729    /**
2730     * Get the basic Evas_Image object from this object (widget).
2731     *
2732     * @param obj The image object to get the inlined image from
2733     * @return The inlined image object, or NULL if none exists
2734     *
2735     * This function allows one to get the underlying @c Evas_Object of type
2736     * Image from this elementary widget. It can be useful to do things like get
2737     * the pixel data, save the image to a file, etc.
2738     *
2739     * @note Be careful to not manipulate it, as it is under control of
2740     * elementary.
2741     *
2742     * @ingroup Image
2743     */
2744    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2745    /**
2746     * Set whether the original aspect ratio of the image should be kept on resize.
2747     *
2748     * @param obj The image object.
2749     * @param retained @c EINA_TRUE if the image should retain the aspect,
2750     * @c EINA_FALSE otherwise.
2751     *
2752     * The original aspect ratio (width / height) of the image is usually
2753     * distorted to match the object's size. Enabling this option will retain
2754     * this original aspect, and the way that the image is fit into the object's
2755     * area depends on the option set by elm_image_fill_outside_set().
2756     *
2757     * @see elm_image_aspect_ratio_retained_get()
2758     * @see elm_image_fill_outside_set()
2759     *
2760     * @ingroup Image
2761     */
2762    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2763    /**
2764     * Get if the object retains the original aspect ratio.
2765     *
2766     * @param obj The image object.
2767     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
2768     * otherwise.
2769     *
2770     * @ingroup Image
2771     */
2772    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2773
2774    /* smart callbacks called:
2775     * "clicked" - the user clicked the image
2776     */
2777
2778    /**
2779     * @}
2780     */
2781
2782    /* glview */
2783    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
2784
2785    typedef enum _Elm_GLView_Mode
2786      {
2787         ELM_GLVIEW_ALPHA   = 1,
2788         ELM_GLVIEW_DEPTH   = 2,
2789         ELM_GLVIEW_STENCIL = 4
2790      } Elm_GLView_Mode;
2791
2792    /**
2793     * Defines a policy for the glview resizing.
2794     *
2795     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2796     */
2797    typedef enum _Elm_GLView_Resize_Policy
2798      {
2799         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
2800         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
2801      } Elm_GLView_Resize_Policy;
2802
2803    typedef enum _Elm_GLView_Render_Policy
2804      {
2805         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
2806         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
2807      } Elm_GLView_Render_Policy;
2808
2809
2810    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2811    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2812    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2813    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2814    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2815    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2816    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2817    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2818    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2819    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2820    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2821    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2822
2823    /* box */
2824    /**
2825     * @defgroup Box Box
2826     *
2827     * @image html img/widget/box/preview-00.png
2828     * @image latex img/widget/box/preview-00.eps width=\textwidth
2829     *
2830     * @image html img/box.png
2831     * @image latex img/box.eps width=\textwidth
2832     *
2833     * A box arranges objects in a linear fashion, governed by a layout function
2834     * that defines the details of this arrangement.
2835     *
2836     * By default, the box will use an internal function to set the layout to
2837     * a single row, either vertical or horizontal. This layout is affected
2838     * by a number of parameters, such as the homogeneous flag set by
2839     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2840     * elm_box_align_set() and the hints set to each object in the box.
2841     *
2842     * For this default layout, it's possible to change the orientation with
2843     * elm_box_horizontal_set(). The box will start in the vertical orientation,
2844     * placing its elements ordered from top to bottom. When horizontal is set,
2845     * the order will go from left to right. If the box is set to be
2846     * homogeneous, every object in it will be assigned the same space, that
2847     * of the largest object. Padding can be used to set some spacing between
2848     * the cell given to each object. The alignment of the box, set with
2849     * elm_box_align_set(), determines how the bounding box of all the elements
2850     * will be placed within the space given to the box widget itself.
2851     *
2852     * The size hints of each object also affect how they are placed and sized
2853     * within the box. evas_object_size_hint_min_set() will give the minimum
2854     * size the object can have, and the box will use it as the basis for all
2855     * latter calculations. Elementary widgets set their own minimum size as
2856     * needed, so there's rarely any need to use it manually.
2857     *
2858     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2859     * used to tell whether the object will be allocated the minimum size it
2860     * needs or if the space given to it should be expanded. It's important
2861     * to realize that expanding the size given to the object is not the same
2862     * thing as resizing the object. It could very well end being a small
2863     * widget floating in a much larger empty space. If not set, the weight
2864     * for objects will normally be 0.0 for both axis, meaning the widget will
2865     * not be expanded. To take as much space possible, set the weight to
2866     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2867     *
2868     * Besides how much space each object is allocated, it's possible to control
2869     * how the widget will be placed within that space using
2870     * evas_object_size_hint_align_set(). By default, this value will be 0.5
2871     * for both axis, meaning the object will be centered, but any value from
2872     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2873     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2874     * is -1.0, means the object will be resized to fill the entire space it
2875     * was allocated.
2876     *
2877     * In addition, customized functions to define the layout can be set, which
2878     * allow the application developer to organize the objects within the box
2879     * in any number of ways.
2880     *
2881     * The special elm_box_layout_transition() function can be used
2882     * to switch from one layout to another, animating the motion of the
2883     * children of the box.
2884     *
2885     * @note Objects should not be added to box objects using _add() calls.
2886     *
2887     * Some examples on how to use boxes follow:
2888     * @li @ref box_example_01
2889     * @li @ref box_example_02
2890     *
2891     * @{
2892     */
2893    /**
2894     * @typedef Elm_Box_Transition
2895     *
2896     * Opaque handler containing the parameters to perform an animated
2897     * transition of the layout the box uses.
2898     *
2899     * @see elm_box_transition_new()
2900     * @see elm_box_layout_set()
2901     * @see elm_box_layout_transition()
2902     */
2903    typedef struct _Elm_Box_Transition Elm_Box_Transition;
2904
2905    /**
2906     * Add a new box to the parent
2907     *
2908     * By default, the box will be in vertical mode and non-homogeneous.
2909     *
2910     * @param parent The parent object
2911     * @return The new object or NULL if it cannot be created
2912     */
2913    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2914    /**
2915     * Set the horizontal orientation
2916     *
2917     * By default, box object arranges their contents vertically from top to
2918     * bottom.
2919     * By calling this function with @p horizontal as EINA_TRUE, the box will
2920     * become horizontal, arranging contents from left to right.
2921     *
2922     * @note This flag is ignored if a custom layout function is set.
2923     *
2924     * @param obj The box object
2925     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2926     * EINA_FALSE = vertical)
2927     */
2928    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2929    /**
2930     * Get the horizontal orientation
2931     *
2932     * @param obj The box object
2933     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
2934     */
2935    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2936    /**
2937     * Set the box to arrange its children homogeneously
2938     *
2939     * If enabled, homogeneous layout makes all items the same size, according
2940     * to the size of the largest of its children.
2941     *
2942     * @note This flag is ignored if a custom layout function is set.
2943     *
2944     * @param obj The box object
2945     * @param homogeneous The homogeneous flag
2946     */
2947    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2948    /**
2949     * Get whether the box is using homogeneous mode or not
2950     *
2951     * @param obj The box object
2952     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2953     */
2954    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2955    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2956    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2957    /**
2958     * Add an object to the beginning of the pack list
2959     *
2960     * Pack @p subobj into the box @p obj, placing it first in the list of
2961     * children objects. The actual position the object will get on screen
2962     * depends on the layout used. If no custom layout is set, it will be at
2963     * the top or left, depending if the box is vertical or horizontal,
2964     * respectively.
2965     *
2966     * @param obj The box object
2967     * @param subobj The object to add to the box
2968     *
2969     * @see elm_box_pack_end()
2970     * @see elm_box_pack_before()
2971     * @see elm_box_pack_after()
2972     * @see elm_box_unpack()
2973     * @see elm_box_unpack_all()
2974     * @see elm_box_clear()
2975     */
2976    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2977    /**
2978     * Add an object at the end of the pack list
2979     *
2980     * Pack @p subobj into the box @p obj, placing it last in the list of
2981     * children objects. The actual position the object will get on screen
2982     * depends on the layout used. If no custom layout is set, it will be at
2983     * the bottom or right, depending if the box is vertical or horizontal,
2984     * respectively.
2985     *
2986     * @param obj The box object
2987     * @param subobj The object to add to the box
2988     *
2989     * @see elm_box_pack_start()
2990     * @see elm_box_pack_before()
2991     * @see elm_box_pack_after()
2992     * @see elm_box_unpack()
2993     * @see elm_box_unpack_all()
2994     * @see elm_box_clear()
2995     */
2996    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2997    /**
2998     * Adds an object to the box before the indicated object
2999     *
3000     * This will add the @p subobj to the box indicated before the object
3001     * indicated with @p before. If @p before is not already in the box, results
3002     * are undefined. Before means either to the left of the indicated object or
3003     * above it depending on orientation.
3004     *
3005     * @param obj The box object
3006     * @param subobj The object to add to the box
3007     * @param before The object before which to add it
3008     *
3009     * @see elm_box_pack_start()
3010     * @see elm_box_pack_end()
3011     * @see elm_box_pack_after()
3012     * @see elm_box_unpack()
3013     * @see elm_box_unpack_all()
3014     * @see elm_box_clear()
3015     */
3016    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3017    /**
3018     * Adds an object to the box after the indicated object
3019     *
3020     * This will add the @p subobj to the box indicated after the object
3021     * indicated with @p after. If @p after is not already in the box, results
3022     * are undefined. After means either to the right of the indicated object or
3023     * below it depending on orientation.
3024     *
3025     * @param obj The box object
3026     * @param subobj The object to add to the box
3027     * @param after The object after which to add it
3028     *
3029     * @see elm_box_pack_start()
3030     * @see elm_box_pack_end()
3031     * @see elm_box_pack_before()
3032     * @see elm_box_unpack()
3033     * @see elm_box_unpack_all()
3034     * @see elm_box_clear()
3035     */
3036    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3037    /**
3038     * Clear the box of all children
3039     *
3040     * Remove all the elements contained by the box, deleting the respective
3041     * objects.
3042     *
3043     * @param obj The box object
3044     *
3045     * @see elm_box_unpack()
3046     * @see elm_box_unpack_all()
3047     */
3048    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3049    /**
3050     * Unpack a box item
3051     *
3052     * Remove the object given by @p subobj from the box @p obj without
3053     * deleting it.
3054     *
3055     * @param obj The box object
3056     *
3057     * @see elm_box_unpack_all()
3058     * @see elm_box_clear()
3059     */
3060    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3061    /**
3062     * Remove all items from the box, without deleting them
3063     *
3064     * Clear the box from all children, but don't delete the respective objects.
3065     * If no other references of the box children exist, the objects will never
3066     * be deleted, and thus the application will leak the memory. Make sure
3067     * when using this function that you hold a reference to all the objects
3068     * in the box @p obj.
3069     *
3070     * @param obj The box object
3071     *
3072     * @see elm_box_clear()
3073     * @see elm_box_unpack()
3074     */
3075    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3076    /**
3077     * Retrieve a list of the objects packed into the box
3078     *
3079     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3080     * The order of the list corresponds to the packing order the box uses.
3081     *
3082     * You must free this list with eina_list_free() once you are done with it.
3083     *
3084     * @param obj The box object
3085     */
3086    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3087    /**
3088     * Set the space (padding) between the box's elements.
3089     *
3090     * Extra space in pixels that will be added between a box child and its
3091     * neighbors after its containing cell has been calculated. This padding
3092     * is set for all elements in the box, besides any possible padding that
3093     * individual elements may have through their size hints.
3094     *
3095     * @param obj The box object
3096     * @param horizontal The horizontal space between elements
3097     * @param vertical The vertical space between elements
3098     */
3099    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3100    /**
3101     * Get the space (padding) between the box's elements.
3102     *
3103     * @param obj The box object
3104     * @param horizontal The horizontal space between elements
3105     * @param vertical The vertical space between elements
3106     *
3107     * @see elm_box_padding_set()
3108     */
3109    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3110    /**
3111     * Set the alignment of the whole bouding box of contents.
3112     *
3113     * Sets how the bounding box containing all the elements of the box, after
3114     * their sizes and position has been calculated, will be aligned within
3115     * the space given for the whole box widget.
3116     *
3117     * @param obj The box object
3118     * @param horizontal The horizontal alignment of elements
3119     * @param vertical The vertical alignment of elements
3120     */
3121    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3122    /**
3123     * Get the alignment of the whole bouding box of contents.
3124     *
3125     * @param obj The box object
3126     * @param horizontal The horizontal alignment of elements
3127     * @param vertical The vertical alignment of elements
3128     *
3129     * @see elm_box_align_set()
3130     */
3131    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3132
3133    /**
3134     * Set the layout defining function to be used by the box
3135     *
3136     * Whenever anything changes that requires the box in @p obj to recalculate
3137     * the size and position of its elements, the function @p cb will be called
3138     * to determine what the layout of the children will be.
3139     *
3140     * Once a custom function is set, everything about the children layout
3141     * is defined by it. The flags set by elm_box_horizontal_set() and
3142     * elm_box_homogeneous_set() no longer have any meaning, and the values
3143     * given by elm_box_padding_set() and elm_box_align_set() are up to this
3144     * layout function to decide if they are used and how. These last two
3145     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3146     * passed to @p cb. The @c Evas_Object the function receives is not the
3147     * Elementary widget, but the internal Evas Box it uses, so none of the
3148     * functions described here can be used on it.
3149     *
3150     * Any of the layout functions in @c Evas can be used here, as well as the
3151     * special elm_box_layout_transition().
3152     *
3153     * The final @p data argument received by @p cb is the same @p data passed
3154     * here, and the @p free_data function will be called to free it
3155     * whenever the box is destroyed or another layout function is set.
3156     *
3157     * Setting @p cb to NULL will revert back to the default layout function.
3158     *
3159     * @param obj The box object
3160     * @param cb The callback function used for layout
3161     * @param data Data that will be passed to layout function
3162     * @param free_data Function called to free @p data
3163     *
3164     * @see elm_box_layout_transition()
3165     */
3166    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);
3167    /**
3168     * Special layout function that animates the transition from one layout to another
3169     *
3170     * Normally, when switching the layout function for a box, this will be
3171     * reflected immediately on screen on the next render, but it's also
3172     * possible to do this through an animated transition.
3173     *
3174     * This is done by creating an ::Elm_Box_Transition and setting the box
3175     * layout to this function.
3176     *
3177     * For example:
3178     * @code
3179     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3180     *                            evas_object_box_layout_vertical, // start
3181     *                            NULL, // data for initial layout
3182     *                            NULL, // free function for initial data
3183     *                            evas_object_box_layout_horizontal, // end
3184     *                            NULL, // data for final layout
3185     *                            NULL, // free function for final data
3186     *                            anim_end, // will be called when animation ends
3187     *                            NULL); // data for anim_end function\
3188     * elm_box_layout_set(box, elm_box_layout_transition, t,
3189     *                    elm_box_transition_free);
3190     * @endcode
3191     *
3192     * @note This function can only be used with elm_box_layout_set(). Calling
3193     * it directly will not have the expected results.
3194     *
3195     * @see elm_box_transition_new
3196     * @see elm_box_transition_free
3197     * @see elm_box_layout_set
3198     */
3199    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3200    /**
3201     * Create a new ::Elm_Box_Transition to animate the switch of layouts
3202     *
3203     * If you want to animate the change from one layout to another, you need
3204     * to set the layout function of the box to elm_box_layout_transition(),
3205     * passing as user data to it an instance of ::Elm_Box_Transition with the
3206     * necessary information to perform this animation. The free function to
3207     * set for the layout is elm_box_transition_free().
3208     *
3209     * The parameters to create an ::Elm_Box_Transition sum up to how long
3210     * will it be, in seconds, a layout function to describe the initial point,
3211     * another for the final position of the children and one function to be
3212     * called when the whole animation ends. This last function is useful to
3213     * set the definitive layout for the box, usually the same as the end
3214     * layout for the animation, but could be used to start another transition.
3215     *
3216     * @param start_layout The layout function that will be used to start the animation
3217     * @param start_layout_data The data to be passed the @p start_layout function
3218     * @param start_layout_free_data Function to free @p start_layout_data
3219     * @param end_layout The layout function that will be used to end the animation
3220     * @param end_layout_free_data The data to be passed the @p end_layout function
3221     * @param end_layout_free_data Function to free @p end_layout_data
3222     * @param transition_end_cb Callback function called when animation ends
3223     * @param transition_end_data Data to be passed to @p transition_end_cb
3224     * @return An instance of ::Elm_Box_Transition
3225     *
3226     * @see elm_box_transition_new
3227     * @see elm_box_layout_transition
3228     */
3229    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);
3230    /**
3231     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3232     *
3233     * This function is mostly useful as the @c free_data parameter in
3234     * elm_box_layout_set() when elm_box_layout_transition().
3235     *
3236     * @param data The Elm_Box_Transition instance to be freed.
3237     *
3238     * @see elm_box_transition_new
3239     * @see elm_box_layout_transition
3240     */
3241    EAPI void                elm_box_transition_free(void *data);
3242    /**
3243     * @}
3244     */
3245
3246    /* button */
3247    /**
3248     * @defgroup Button Button
3249     *
3250     * @image html img/widget/button/preview-00.png
3251     * @image html img/widget/button/preview-01.png
3252     * @image html img/widget/button/preview-02.png
3253     *
3254     * This is a push-button. Press it and run some function. It can contain
3255     * a simple label and icon object and it also has an autorepeat feature.
3256     *
3257     * This widgets emits the following signals:
3258     * @li "clicked": the user clicked the button (press/release).
3259     * @li "repeated": the user pressed the button without releasing it.
3260     * @li "pressed": button was pressed.
3261     * @li "unpressed": button was released after being pressed.
3262     * In all three cases, the @c event parameter of the callback will be
3263     * @c NULL.
3264     *
3265     * Also, defined in the default theme, the button has the following styles
3266     * available:
3267     * @li default: a normal button.
3268     * @li anchor: Like default, but the button fades away when the mouse is not
3269     * over it, leaving only the text or icon.
3270     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
3271     * continuous look across its options.
3272     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
3273     *
3274     * Follow through a complete example @ref button_example_01 "here".
3275     * @{
3276     */
3277    /**
3278     * Add a new button to the parent's canvas
3279     *
3280     * @param parent The parent object
3281     * @return The new object or NULL if it cannot be created
3282     */
3283    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3284    /**
3285     * Set the label used in the button
3286     *
3287     * The passed @p label can be NULL to clean any existing text in it and
3288     * leave the button as an icon only object.
3289     *
3290     * @param obj The button object
3291     * @param label The text will be written on the button
3292     * @deprecated use elm_object_text_set() instead.
3293     */
3294    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3295    /**
3296     * Get the label set for the button
3297     *
3298     * The string returned is an internal pointer and should not be freed or
3299     * altered. It will also become invalid when the button is destroyed.
3300     * The string returned, if not NULL, is a stringshare, so if you need to
3301     * keep it around even after the button is destroyed, you can use
3302     * eina_stringshare_ref().
3303     *
3304     * @param obj The button object
3305     * @return The text set to the label, or NULL if nothing is set
3306     * @deprecated use elm_object_text_set() instead.
3307     */
3308    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3309    /**
3310     * Set the icon used for the button
3311     *
3312     * Setting a new icon will delete any other that was previously set, making
3313     * any reference to them invalid. If you need to maintain the previous
3314     * object alive, unset it first with elm_button_icon_unset().
3315     *
3316     * @param obj The button object
3317     * @param icon The icon object for the button
3318     */
3319    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3320    /**
3321     * Get the icon used for the button
3322     *
3323     * Return the icon object which is set for this widget. If the button is
3324     * destroyed or another icon is set, the returned object will be deleted
3325     * and any reference to it will be invalid.
3326     *
3327     * @param obj The button object
3328     * @return The icon object that is being used
3329     *
3330     * @see elm_button_icon_unset()
3331     */
3332    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3333    /**
3334     * Remove the icon set without deleting it and return the object
3335     *
3336     * This function drops the reference the button holds of the icon object
3337     * and returns this last object. It is used in case you want to remove any
3338     * icon, or set another one, without deleting the actual object. The button
3339     * will be left without an icon set.
3340     *
3341     * @param obj The button object
3342     * @return The icon object that was being used
3343     */
3344    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3345    /**
3346     * Turn on/off the autorepeat event generated when the button is kept pressed
3347     *
3348     * When off, no autorepeat is performed and buttons emit a normal @c clicked
3349     * signal when they are clicked.
3350     *
3351     * When on, keeping a button pressed will continuously emit a @c repeated
3352     * signal until the button is released. The time it takes until it starts
3353     * emitting the signal is given by
3354     * elm_button_autorepeat_initial_timeout_set(), and the time between each
3355     * new emission by elm_button_autorepeat_gap_timeout_set().
3356     *
3357     * @param obj The button object
3358     * @param on  A bool to turn on/off the event
3359     */
3360    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
3361    /**
3362     * Get whether the autorepeat feature is enabled
3363     *
3364     * @param obj The button object
3365     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
3366     *
3367     * @see elm_button_autorepeat_set()
3368     */
3369    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3370    /**
3371     * Set the initial timeout before the autorepeat event is generated
3372     *
3373     * Sets the timeout, in seconds, since the button is pressed until the
3374     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
3375     * won't be any delay and the even will be fired the moment the button is
3376     * pressed.
3377     *
3378     * @param obj The button object
3379     * @param t   Timeout in seconds
3380     *
3381     * @see elm_button_autorepeat_set()
3382     * @see elm_button_autorepeat_gap_timeout_set()
3383     */
3384    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3385    /**
3386     * Get the initial timeout before the autorepeat event is generated
3387     *
3388     * @param obj The button object
3389     * @return Timeout in seconds
3390     *
3391     * @see elm_button_autorepeat_initial_timeout_set()
3392     */
3393    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3394    /**
3395     * Set the interval between each generated autorepeat event
3396     *
3397     * After the first @c repeated event is fired, all subsequent ones will
3398     * follow after a delay of @p t seconds for each.
3399     *
3400     * @param obj The button object
3401     * @param t   Interval in seconds
3402     *
3403     * @see elm_button_autorepeat_initial_timeout_set()
3404     */
3405    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3406    /**
3407     * Get the interval between each generated autorepeat event
3408     *
3409     * @param obj The button object
3410     * @return Interval in seconds
3411     */
3412    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3413    /**
3414     * @}
3415     */
3416
3417    /**
3418     * @defgroup File_Selector_Button File Selector Button
3419     *
3420     * @image html img/widget/fileselector_button/preview-00.png
3421     * @image html img/widget/fileselector_button/preview-01.png
3422     * @image html img/widget/fileselector_button/preview-02.png
3423     *
3424     * This is a button that, when clicked, creates an Elementary
3425     * window (or inner window) <b> with a @ref Fileselector "file
3426     * selector widget" within</b>. When a file is chosen, the (inner)
3427     * window is closed and the button emits a signal having the
3428     * selected file as it's @c event_info.
3429     *
3430     * This widget encapsulates operations on its internal file
3431     * selector on its own API. There is less control over its file
3432     * selector than that one would have instatiating one directly.
3433     *
3434     * The following styles are available for this button:
3435     * @li @c "default"
3436     * @li @c "anchor"
3437     * @li @c "hoversel_vertical"
3438     * @li @c "hoversel_vertical_entry"
3439     *
3440     * Smart callbacks one can register to:
3441     * - @c "file,chosen" - the user has selected a path, whose string
3442     *   pointer comes as the @c event_info data (a stringshared
3443     *   string)
3444     *
3445     * Here is an example on its usage:
3446     * @li @ref fileselector_button_example
3447     *
3448     * @see @ref File_Selector_Entry for a similar widget.
3449     * @{
3450     */
3451
3452    /**
3453     * Add a new file selector button widget to the given parent
3454     * Elementary (container) object
3455     *
3456     * @param parent The parent object
3457     * @return a new file selector button widget handle or @c NULL, on
3458     * errors
3459     */
3460    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3461
3462    /**
3463     * Set the label for a given file selector button widget
3464     *
3465     * @param obj The file selector button widget
3466     * @param label The text label to be displayed on @p obj
3467     *
3468     * @deprecated use elm_object_text_set() instead.
3469     */
3470    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3471
3472    /**
3473     * Get the label set for a given file selector button widget
3474     *
3475     * @param obj The file selector button widget
3476     * @return The button label
3477     *
3478     * @deprecated use elm_object_text_set() instead.
3479     */
3480    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3481
3482    /**
3483     * Set the icon on a given file selector button widget
3484     *
3485     * @param obj The file selector button widget
3486     * @param icon The icon object for the button
3487     *
3488     * Once the icon object is set, a previously set one will be
3489     * deleted. If you want to keep the latter, use the
3490     * elm_fileselector_button_icon_unset() function.
3491     *
3492     * @see elm_fileselector_button_icon_get()
3493     */
3494    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3495
3496    /**
3497     * Get the icon set for a given file selector button widget
3498     *
3499     * @param obj The file selector button widget
3500     * @return The icon object currently set on @p obj or @c NULL, if
3501     * none is
3502     *
3503     * @see elm_fileselector_button_icon_set()
3504     */
3505    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3506
3507    /**
3508     * Unset the icon used in a given file selector button widget
3509     *
3510     * @param obj The file selector button widget
3511     * @return The icon object that was being used on @p obj or @c
3512     * NULL, on errors
3513     *
3514     * Unparent and return the icon object which was set for this
3515     * widget.
3516     *
3517     * @see elm_fileselector_button_icon_set()
3518     */
3519    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3520
3521    /**
3522     * Set the title for a given file selector button widget's window
3523     *
3524     * @param obj The file selector button widget
3525     * @param title The title string
3526     *
3527     * This will change the window's title, when the file selector pops
3528     * out after a click on the button. Those windows have the default
3529     * (unlocalized) value of @c "Select a file" as titles.
3530     *
3531     * @note It will only take any effect if the file selector
3532     * button widget is @b not under "inwin mode".
3533     *
3534     * @see elm_fileselector_button_window_title_get()
3535     */
3536    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3537
3538    /**
3539     * Get the title set for a given file selector button widget's
3540     * window
3541     *
3542     * @param obj The file selector button widget
3543     * @return Title of the file selector button's window
3544     *
3545     * @see elm_fileselector_button_window_title_get() for more details
3546     */
3547    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3548
3549    /**
3550     * Set the size of a given file selector button widget's window,
3551     * holding the file selector itself.
3552     *
3553     * @param obj The file selector button widget
3554     * @param width The window's width
3555     * @param height The window's height
3556     *
3557     * @note it will only take any effect if the file selector button
3558     * widget is @b not under "inwin mode". The default size for the
3559     * window (when applicable) is 400x400 pixels.
3560     *
3561     * @see elm_fileselector_button_window_size_get()
3562     */
3563    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3564
3565    /**
3566     * Get the size of a given file selector button widget's window,
3567     * holding the file selector itself.
3568     *
3569     * @param obj The file selector button widget
3570     * @param width Pointer into which to store the width value
3571     * @param height Pointer into which to store the height value
3572     *
3573     * @note Use @c NULL pointers on the size values you're not
3574     * interested in: they'll be ignored by the function.
3575     *
3576     * @see elm_fileselector_button_window_size_set(), for more details
3577     */
3578    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3579
3580    /**
3581     * Set the initial file system path for a given file selector
3582     * button widget
3583     *
3584     * @param obj The file selector button widget
3585     * @param path The path string
3586     *
3587     * It must be a <b>directory</b> path, which will have the contents
3588     * displayed initially in the file selector's view, when invoked
3589     * from @p obj. The default initial path is the @c "HOME"
3590     * environment variable's value.
3591     *
3592     * @see elm_fileselector_button_path_get()
3593     */
3594    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3595
3596    /**
3597     * Get the initial file system path set for a given file selector
3598     * button widget
3599     *
3600     * @param obj The file selector button widget
3601     * @return path The path string
3602     *
3603     * @see elm_fileselector_button_path_set() for more details
3604     */
3605    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3606
3607    /**
3608     * Enable/disable a tree view in the given file selector button
3609     * widget's internal file selector
3610     *
3611     * @param obj The file selector button widget
3612     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3613     * disable
3614     *
3615     * This has the same effect as elm_fileselector_expandable_set(),
3616     * but now applied to a file selector button's internal file
3617     * selector.
3618     *
3619     * @note There's no way to put a file selector button's internal
3620     * file selector in "grid mode", as one may do with "pure" file
3621     * selectors.
3622     *
3623     * @see elm_fileselector_expandable_get()
3624     */
3625    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3626
3627    /**
3628     * Get whether tree view is enabled for the given file selector
3629     * button widget's internal file selector
3630     *
3631     * @param obj The file selector button widget
3632     * @return @c EINA_TRUE if @p obj widget's internal file selector
3633     * is in tree view, @c EINA_FALSE otherwise (and or errors)
3634     *
3635     * @see elm_fileselector_expandable_set() for more details
3636     */
3637    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3638
3639    /**
3640     * Set whether a given file selector button widget's internal file
3641     * selector is to display folders only or the directory contents,
3642     * as well.
3643     *
3644     * @param obj The file selector button widget
3645     * @param only @c EINA_TRUE to make @p obj widget's internal file
3646     * selector only display directories, @c EINA_FALSE to make files
3647     * to be displayed in it too
3648     *
3649     * This has the same effect as elm_fileselector_folder_only_set(),
3650     * but now applied to a file selector button's internal file
3651     * selector.
3652     *
3653     * @see elm_fileselector_folder_only_get()
3654     */
3655    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3656
3657    /**
3658     * Get whether a given file selector button widget's internal file
3659     * selector is displaying folders only or the directory contents,
3660     * as well.
3661     *
3662     * @param obj The file selector button widget
3663     * @return @c EINA_TRUE if @p obj widget's internal file
3664     * selector is only displaying directories, @c EINA_FALSE if files
3665     * are being displayed in it too (and on errors)
3666     *
3667     * @see elm_fileselector_button_folder_only_set() for more details
3668     */
3669    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3670
3671    /**
3672     * Enable/disable the file name entry box where the user can type
3673     * in a name for a file, in a given file selector button widget's
3674     * internal file selector.
3675     *
3676     * @param obj The file selector button widget
3677     * @param is_save @c EINA_TRUE to make @p obj widget's internal
3678     * file selector a "saving dialog", @c EINA_FALSE otherwise
3679     *
3680     * This has the same effect as elm_fileselector_is_save_set(),
3681     * but now applied to a file selector button's internal file
3682     * selector.
3683     *
3684     * @see elm_fileselector_is_save_get()
3685     */
3686    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3687
3688    /**
3689     * Get whether the given file selector button widget's internal
3690     * file selector is in "saving dialog" mode
3691     *
3692     * @param obj The file selector button widget
3693     * @return @c EINA_TRUE, if @p obj widget's internal file selector
3694     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
3695     * errors)
3696     *
3697     * @see elm_fileselector_button_is_save_set() for more details
3698     */
3699    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3700
3701    /**
3702     * Set whether a given file selector button widget's internal file
3703     * selector will raise an Elementary "inner window", instead of a
3704     * dedicated Elementary window. By default, it won't.
3705     *
3706     * @param obj The file selector button widget
3707     * @param value @c EINA_TRUE to make it use an inner window, @c
3708     * EINA_TRUE to make it use a dedicated window
3709     *
3710     * @see elm_win_inwin_add() for more information on inner windows
3711     * @see elm_fileselector_button_inwin_mode_get()
3712     */
3713    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3714
3715    /**
3716     * Get whether a given file selector button widget's internal file
3717     * selector will raise an Elementary "inner window", instead of a
3718     * dedicated Elementary window.
3719     *
3720     * @param obj The file selector button widget
3721     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
3722     * if it will use a dedicated window
3723     *
3724     * @see elm_fileselector_button_inwin_mode_set() for more details
3725     */
3726    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3727
3728    /**
3729     * @}
3730     */
3731
3732     /**
3733     * @defgroup File_Selector_Entry File Selector Entry
3734     *
3735     * @image html img/widget/fileselector_entry/preview-00.png
3736     * @image latex img/widget/fileselector_entry/preview-00.eps
3737     *
3738     * This is an entry made to be filled with or display a <b>file
3739     * system path string</b>. Besides the entry itself, the widget has
3740     * a @ref File_Selector_Button "file selector button" on its side,
3741     * which will raise an internal @ref Fileselector "file selector widget",
3742     * when clicked, for path selection aided by file system
3743     * navigation.
3744     *
3745     * This file selector may appear in an Elementary window or in an
3746     * inner window. When a file is chosen from it, the (inner) window
3747     * is closed and the selected file's path string is exposed both as
3748     * an smart event and as the new text on the entry.
3749     *
3750     * This widget encapsulates operations on its internal file
3751     * selector on its own API. There is less control over its file
3752     * selector than that one would have instatiating one directly.
3753     *
3754     * Smart callbacks one can register to:
3755     * - @c "changed" - The text within the entry was changed
3756     * - @c "activated" - The entry has had editing finished and
3757     *   changes are to be "committed"
3758     * - @c "press" - The entry has been clicked
3759     * - @c "longpressed" - The entry has been clicked (and held) for a
3760     *   couple seconds
3761     * - @c "clicked" - The entry has been clicked
3762     * - @c "clicked,double" - The entry has been double clicked
3763     * - @c "focused" - The entry has received focus
3764     * - @c "unfocused" - The entry has lost focus
3765     * - @c "selection,paste" - A paste action has occurred on the
3766     *   entry
3767     * - @c "selection,copy" - A copy action has occurred on the entry
3768     * - @c "selection,cut" - A cut action has occurred on the entry
3769     * - @c "unpressed" - The file selector entry's button was released
3770     *   after being pressed.
3771     * - @c "file,chosen" - The user has selected a path via the file
3772     *   selector entry's internal file selector, whose string pointer
3773     *   comes as the @c event_info data (a stringshared string)
3774     *
3775     * Here is an example on its usage:
3776     * @li @ref fileselector_entry_example
3777     *
3778     * @see @ref File_Selector_Button for a similar widget.
3779     * @{
3780     */
3781
3782    /**
3783     * Add a new file selector entry widget to the given parent
3784     * Elementary (container) object
3785     *
3786     * @param parent The parent object
3787     * @return a new file selector entry widget handle or @c NULL, on
3788     * errors
3789     */
3790    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3791
3792    /**
3793     * Set the label for a given file selector entry widget's button
3794     *
3795     * @param obj The file selector entry widget
3796     * @param label The text label to be displayed on @p obj widget's
3797     * button
3798     *
3799     * @deprecated use elm_object_text_set() instead.
3800     */
3801    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3802
3803    /**
3804     * Get the label set for a given file selector entry widget's button
3805     *
3806     * @param obj The file selector entry widget
3807     * @return The widget button's label
3808     *
3809     * @deprecated use elm_object_text_set() instead.
3810     */
3811    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3812
3813    /**
3814     * Set the icon on a given file selector entry widget's button
3815     *
3816     * @param obj The file selector entry widget
3817     * @param icon The icon object for the entry's button
3818     *
3819     * Once the icon object is set, a previously set one will be
3820     * deleted. If you want to keep the latter, use the
3821     * elm_fileselector_entry_button_icon_unset() function.
3822     *
3823     * @see elm_fileselector_entry_button_icon_get()
3824     */
3825    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3826
3827    /**
3828     * Get the icon set for a given file selector entry widget's button
3829     *
3830     * @param obj The file selector entry widget
3831     * @return The icon object currently set on @p obj widget's button
3832     * or @c NULL, if none is
3833     *
3834     * @see elm_fileselector_entry_button_icon_set()
3835     */
3836    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3837
3838    /**
3839     * Unset the icon used in a given file selector entry widget's
3840     * button
3841     *
3842     * @param obj The file selector entry widget
3843     * @return The icon object that was being used on @p obj widget's
3844     * button or @c NULL, on errors
3845     *
3846     * Unparent and return the icon object which was set for this
3847     * widget's button.
3848     *
3849     * @see elm_fileselector_entry_button_icon_set()
3850     */
3851    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3852
3853    /**
3854     * Set the title for a given file selector entry widget's window
3855     *
3856     * @param obj The file selector entry widget
3857     * @param title The title string
3858     *
3859     * This will change the window's title, when the file selector pops
3860     * out after a click on the entry's button. Those windows have the
3861     * default (unlocalized) value of @c "Select a file" as titles.
3862     *
3863     * @note It will only take any effect if the file selector
3864     * entry widget is @b not under "inwin mode".
3865     *
3866     * @see elm_fileselector_entry_window_title_get()
3867     */
3868    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3869
3870    /**
3871     * Get the title set for a given file selector entry widget's
3872     * window
3873     *
3874     * @param obj The file selector entry widget
3875     * @return Title of the file selector entry's window
3876     *
3877     * @see elm_fileselector_entry_window_title_get() for more details
3878     */
3879    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3880
3881    /**
3882     * Set the size of a given file selector entry widget's window,
3883     * holding the file selector itself.
3884     *
3885     * @param obj The file selector entry widget
3886     * @param width The window's width
3887     * @param height The window's height
3888     *
3889     * @note it will only take any effect if the file selector entry
3890     * widget is @b not under "inwin mode". The default size for the
3891     * window (when applicable) is 400x400 pixels.
3892     *
3893     * @see elm_fileselector_entry_window_size_get()
3894     */
3895    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3896
3897    /**
3898     * Get the size of a given file selector entry widget's window,
3899     * holding the file selector itself.
3900     *
3901     * @param obj The file selector entry widget
3902     * @param width Pointer into which to store the width value
3903     * @param height Pointer into which to store the height value
3904     *
3905     * @note Use @c NULL pointers on the size values you're not
3906     * interested in: they'll be ignored by the function.
3907     *
3908     * @see elm_fileselector_entry_window_size_set(), for more details
3909     */
3910    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3911
3912    /**
3913     * Set the initial file system path and the entry's path string for
3914     * a given file selector entry widget
3915     *
3916     * @param obj The file selector entry widget
3917     * @param path The path string
3918     *
3919     * It must be a <b>directory</b> path, which will have the contents
3920     * displayed initially in the file selector's view, when invoked
3921     * from @p obj. The default initial path is the @c "HOME"
3922     * environment variable's value.
3923     *
3924     * @see elm_fileselector_entry_path_get()
3925     */
3926    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3927
3928    /**
3929     * Get the entry's path string for a given file selector entry
3930     * widget
3931     *
3932     * @param obj The file selector entry widget
3933     * @return path The path string
3934     *
3935     * @see elm_fileselector_entry_path_set() for more details
3936     */
3937    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3938
3939    /**
3940     * Enable/disable a tree view in the given file selector entry
3941     * widget's internal file selector
3942     *
3943     * @param obj The file selector entry widget
3944     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3945     * disable
3946     *
3947     * This has the same effect as elm_fileselector_expandable_set(),
3948     * but now applied to a file selector entry's internal file
3949     * selector.
3950     *
3951     * @note There's no way to put a file selector entry's internal
3952     * file selector in "grid mode", as one may do with "pure" file
3953     * selectors.
3954     *
3955     * @see elm_fileselector_expandable_get()
3956     */
3957    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3958
3959    /**
3960     * Get whether tree view is enabled for the given file selector
3961     * entry widget's internal file selector
3962     *
3963     * @param obj The file selector entry widget
3964     * @return @c EINA_TRUE if @p obj widget's internal file selector
3965     * is in tree view, @c EINA_FALSE otherwise (and or errors)
3966     *
3967     * @see elm_fileselector_expandable_set() for more details
3968     */
3969    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3970
3971    /**
3972     * Set whether a given file selector entry widget's internal file
3973     * selector is to display folders only or the directory contents,
3974     * as well.
3975     *
3976     * @param obj The file selector entry widget
3977     * @param only @c EINA_TRUE to make @p obj widget's internal file
3978     * selector only display directories, @c EINA_FALSE to make files
3979     * to be displayed in it too
3980     *
3981     * This has the same effect as elm_fileselector_folder_only_set(),
3982     * but now applied to a file selector entry's internal file
3983     * selector.
3984     *
3985     * @see elm_fileselector_folder_only_get()
3986     */
3987    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3988
3989    /**
3990     * Get whether a given file selector entry widget's internal file
3991     * selector is displaying folders only or the directory contents,
3992     * as well.
3993     *
3994     * @param obj The file selector entry widget
3995     * @return @c EINA_TRUE if @p obj widget's internal file
3996     * selector is only displaying directories, @c EINA_FALSE if files
3997     * are being displayed in it too (and on errors)
3998     *
3999     * @see elm_fileselector_entry_folder_only_set() for more details
4000     */
4001    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4002
4003    /**
4004     * Enable/disable the file name entry box where the user can type
4005     * in a name for a file, in a given file selector entry widget's
4006     * internal file selector.
4007     *
4008     * @param obj The file selector entry widget
4009     * @param is_save @c EINA_TRUE to make @p obj widget's internal
4010     * file selector a "saving dialog", @c EINA_FALSE otherwise
4011     *
4012     * This has the same effect as elm_fileselector_is_save_set(),
4013     * but now applied to a file selector entry's internal file
4014     * selector.
4015     *
4016     * @see elm_fileselector_is_save_get()
4017     */
4018    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4019
4020    /**
4021     * Get whether the given file selector entry widget's internal
4022     * file selector is in "saving dialog" mode
4023     *
4024     * @param obj The file selector entry widget
4025     * @return @c EINA_TRUE, if @p obj widget's internal file selector
4026     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4027     * errors)
4028     *
4029     * @see elm_fileselector_entry_is_save_set() for more details
4030     */
4031    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4032
4033    /**
4034     * Set whether a given file selector entry widget's internal file
4035     * selector will raise an Elementary "inner window", instead of a
4036     * dedicated Elementary window. By default, it won't.
4037     *
4038     * @param obj The file selector entry widget
4039     * @param value @c EINA_TRUE to make it use an inner window, @c
4040     * EINA_TRUE to make it use a dedicated window
4041     *
4042     * @see elm_win_inwin_add() for more information on inner windows
4043     * @see elm_fileselector_entry_inwin_mode_get()
4044     */
4045    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4046
4047    /**
4048     * Get whether a given file selector entry widget's internal file
4049     * selector will raise an Elementary "inner window", instead of a
4050     * dedicated Elementary window.
4051     *
4052     * @param obj The file selector entry widget
4053     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4054     * if it will use a dedicated window
4055     *
4056     * @see elm_fileselector_entry_inwin_mode_set() for more details
4057     */
4058    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4059
4060    /**
4061     * Set the initial file system path for a given file selector entry
4062     * widget
4063     *
4064     * @param obj The file selector entry widget
4065     * @param path The path string
4066     *
4067     * It must be a <b>directory</b> path, which will have the contents
4068     * displayed initially in the file selector's view, when invoked
4069     * from @p obj. The default initial path is the @c "HOME"
4070     * environment variable's value.
4071     *
4072     * @see elm_fileselector_entry_path_get()
4073     */
4074    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4075
4076    /**
4077     * Get the parent directory's path to the latest file selection on
4078     * a given filer selector entry widget
4079     *
4080     * @param obj The file selector object
4081     * @return The (full) path of the directory of the last selection
4082     * on @p obj widget, a @b stringshared string
4083     *
4084     * @see elm_fileselector_entry_path_set()
4085     */
4086    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4087
4088    /**
4089     * @}
4090     */
4091
4092    /**
4093     * @defgroup Scroller Scroller
4094     *
4095     * A scroller holds a single object and "scrolls it around". This means that
4096     * it allows the user to use a scrollbar (or a finger) to drag the viewable
4097     * region around, allowing to move through a much larger object that is
4098     * contained in the scroller. The scroiller will always have a small minimum
4099     * size by default as it won't be limited by the contents of the scroller.
4100     *
4101     * Signals that you can add callbacks for are:
4102     * @li "edge,left" - the left edge of the content has been reached
4103     * @li "edge,right" - the right edge of the content has been reached
4104     * @li "edge,top" - the top edge of the content has been reached
4105     * @li "edge,bottom" - the bottom edge of the content has been reached
4106     * @li "scroll" - the content has been scrolled (moved)
4107     * @li "scroll,anim,start" - scrolling animation has started
4108     * @li "scroll,anim,stop" - scrolling animation has stopped
4109     * @li "scroll,drag,start" - dragging the contents around has started
4110     * @li "scroll,drag,stop" - dragging the contents around has stopped
4111     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4112     * user intervetion.
4113     *
4114     * @note When Elemementary is in embedded mode the scrollbars will not be
4115     * dragable, they appear merely as indicators of how much has been scrolled.
4116     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4117     * fingerscroll) won't work.
4118     *
4119     * In @ref tutorial_scroller you'll find an example of how to use most of
4120     * this API.
4121     * @{
4122     */
4123    /**
4124     * @brief Type that controls when scrollbars should appear.
4125     *
4126     * @see elm_scroller_policy_set()
4127     */
4128    typedef enum _Elm_Scroller_Policy
4129      {
4130         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4131         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4132         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4133         ELM_SCROLLER_POLICY_LAST
4134      } Elm_Scroller_Policy;
4135    /**
4136     * @brief Add a new scroller to the parent
4137     *
4138     * @param parent The parent object
4139     * @return The new object or NULL if it cannot be created
4140     */
4141    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4142    /**
4143     * @brief Set the content of the scroller widget (the object to be scrolled around).
4144     *
4145     * @param obj The scroller object
4146     * @param content The new content object
4147     *
4148     * Once the content object is set, a previously set one will be deleted.
4149     * If you want to keep that old content object, use the
4150     * elm_scroller_content_unset() function.
4151     */
4152    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4153    /**
4154     * @brief Get the content of the scroller widget
4155     *
4156     * @param obj The slider object
4157     * @return The content that is being used
4158     *
4159     * Return the content object which is set for this widget
4160     *
4161     * @see elm_scroller_content_set()
4162     */
4163    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4164    /**
4165     * @brief Unset the content of the scroller widget
4166     *
4167     * @param obj The slider object
4168     * @return The content that was being used
4169     *
4170     * Unparent and return the content object which was set for this widget
4171     *
4172     * @see elm_scroller_content_set()
4173     */
4174    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4175    /**
4176     * @brief Set custom theme elements for the scroller
4177     *
4178     * @param obj The scroller object
4179     * @param widget The widget name to use (default is "scroller")
4180     * @param base The base name to use (default is "base")
4181     */
4182    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4183    /**
4184     * @brief Make the scroller minimum size limited to the minimum size of the content
4185     *
4186     * @param obj The scroller object
4187     * @param w Enable limiting minimum size horizontally
4188     * @param h Enable limiting minimum size vertically
4189     *
4190     * By default the scroller will be as small as its design allows,
4191     * irrespective of its content. This will make the scroller minimum size the
4192     * right size horizontally and/or vertically to perfectly fit its content in
4193     * that direction.
4194     */
4195    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4196    /**
4197     * @brief Show a specific virtual region within the scroller content object
4198     *
4199     * @param obj The scroller object
4200     * @param x X coordinate of the region
4201     * @param y Y coordinate of the region
4202     * @param w Width of the region
4203     * @param h Height of the region
4204     *
4205     * This will ensure all (or part if it does not fit) of the designated
4206     * region in the virtual content object (0, 0 starting at the top-left of the
4207     * virtual content object) is shown within the scroller.
4208     */
4209    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);
4210    /**
4211     * @brief Set the scrollbar visibility policy
4212     *
4213     * @param obj The scroller object
4214     * @param policy_h Horizontal scrollbar policy
4215     * @param policy_v Vertical scrollbar policy
4216     *
4217     * This sets the scrollbar visibility policy for the given scroller.
4218     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4219     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4220     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4221     * respectively for the horizontal and vertical scrollbars.
4222     */
4223    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4224    /**
4225     * @brief Gets scrollbar visibility policy
4226     *
4227     * @param obj The scroller object
4228     * @param policy_h Horizontal scrollbar policy
4229     * @param policy_v Vertical scrollbar policy
4230     *
4231     * @see elm_scroller_policy_set()
4232     */
4233    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4234    /**
4235     * @brief Get the currently visible content region
4236     *
4237     * @param obj The scroller object
4238     * @param x X coordinate of the region
4239     * @param y Y coordinate of the region
4240     * @param w Width of the region
4241     * @param h Height of the region
4242     *
4243     * This gets the current region in the content object that is visible through
4244     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
4245     * w, @p h values pointed to.
4246     *
4247     * @note All coordinates are relative to the content.
4248     *
4249     * @see elm_scroller_region_show()
4250     */
4251    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);
4252    /**
4253     * @brief Get the size of the content object
4254     *
4255     * @param obj The scroller object
4256     * @param w Width return
4257     * @param h Height return
4258     *
4259     * This gets the size of the content object of the scroller.
4260     */
4261    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
4262    /**
4263     * @brief Set bouncing behavior
4264     *
4265     * @param obj The scroller object
4266     * @param h_bounce Will the scroller bounce horizontally or not
4267     * @param v_bounce Will the scroller bounce vertically or not
4268     *
4269     * When scrolling, the scroller may "bounce" when reaching an edge of the
4270     * content object. This is a visual way to indicate the end has been reached.
4271     * This is enabled by default for both axis. This will set if it is enabled
4272     * for that axis with the boolean parameters for each axis.
4273     */
4274    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4275    /**
4276     * @brief Get the bounce mode
4277     *
4278     * @param obj The Scroller object
4279     * @param h_bounce Allow bounce horizontally
4280     * @param v_bounce Allow bounce vertically
4281     *
4282     * @see elm_scroller_bounce_set()
4283     */
4284    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4285    /**
4286     * @brief Set scroll page size relative to viewport size.
4287     *
4288     * @param obj The scroller object
4289     * @param h_pagerel The horizontal page relative size
4290     * @param v_pagerel The vertical page relative size
4291     *
4292     * The scroller is capable of limiting scrolling by the user to "pages". That
4293     * is to jump by and only show a "whole page" at a time as if the continuous
4294     * area of the scroller content is split into page sized pieces. This sets
4295     * the size of a page relative to the viewport of the scroller. 1.0 is "1
4296     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
4297     * axis. This is mutually exclusive with page size
4298     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
4299     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
4300     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
4301     * the other axis.
4302     */
4303    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
4304    /**
4305     * @brief Set scroll page size.
4306     *
4307     * @param obj The scroller object
4308     * @param h_pagesize The horizontal page size
4309     * @param v_pagesize The vertical page size
4310     *
4311     * This sets the page size to an absolute fixed value, with 0 turning it off
4312     * for that axis.
4313     *
4314     * @see elm_scroller_page_relative_set()
4315     */
4316    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
4317    /**
4318     * @brief Show a specific virtual region within the scroller content object.
4319     *
4320     * @param obj The scroller object
4321     * @param x X coordinate of the region
4322     * @param y Y coordinate of the region
4323     * @param w Width of the region
4324     * @param h Height of the region
4325     *
4326     * This will ensure all (or part if it does not fit) of the designated
4327     * region in the virtual content object (0, 0 starting at the top-left of the
4328     * virtual content object) is shown within the scroller. Unlike
4329     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
4330     * to this location (if configuration in general calls for transitions). It
4331     * may not jump immediately to the new location and make take a while and
4332     * show other content along the way.
4333     *
4334     * @see elm_scroller_region_show()
4335     */
4336    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);
4337    /**
4338     * @brief Set event propagation on a scroller
4339     *
4340     * @param obj The scroller object
4341     * @param propagation If propagation is enabled or not
4342     *
4343     * This enables or disabled event propagation from the scroller content to
4344     * the scroller and its parent. By default event propagation is disabled.
4345     */
4346    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
4347    /**
4348     * @brief Get event propagation for a scroller
4349     *
4350     * @param obj The scroller object
4351     * @return The propagation state
4352     *
4353     * This gets the event propagation for a scroller.
4354     *
4355     * @see elm_scroller_propagate_events_set()
4356     */
4357    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
4358    /**
4359     * @}
4360     */
4361
4362    /**
4363     * @defgroup Label Label
4364     *
4365     * @image html img/widget/label/preview-00.png
4366     * @image latex img/widget/label/preview-00.eps
4367     *
4368     * @brief Widget to display text, with simple html-like markup.
4369     *
4370     * The Label widget @b doesn't allow text to overflow its boundaries, if the
4371     * text doesn't fit the geometry of the label it will be ellipsized or be
4372     * cut. Elementary provides several themes for this widget:
4373     * @li default - No animation
4374     * @li marker - Centers the text in the label and make it bold by default
4375     * @li slide_long - The entire text appears from the right of the screen and
4376     * slides until it disappears in the left of the screen(reappering on the
4377     * right again).
4378     * @li slide_short - The text appears in the left of the label and slides to
4379     * the right to show the overflow. When all of the text has been shown the
4380     * position is reset.
4381     * @li slide_bounce - The text appears in the left of the label and slides to
4382     * the right to show the overflow. When all of the text has been shown the
4383     * animation reverses, moving the text to the left.
4384     *
4385     * Custom themes can of course invent new markup tags and style them any way
4386     * they like.
4387     *
4388     * See @ref tutorial_label for a demonstration of how to use a label widget.
4389     * @{
4390     */
4391    /**
4392     * @brief Add a new label to the parent
4393     *
4394     * @param parent The parent object
4395     * @return The new object or NULL if it cannot be created
4396     */
4397    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4398    /**
4399     * @brief Set the label on the label object
4400     *
4401     * @param obj The label object
4402     * @param label The label will be used on the label object
4403     * @deprecated See elm_object_text_set()
4404     */
4405    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 */
4406    /**
4407     * @brief Get the label used on the label object
4408     *
4409     * @param obj The label object
4410     * @return The string inside the label
4411     * @deprecated See elm_object_text_get()
4412     */
4413    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
4414    /**
4415     * @brief Set the wrapping behavior of the label
4416     *
4417     * @param obj The label object
4418     * @param wrap To wrap text or not
4419     *
4420     * By default no wrapping is done. Possible values for @p wrap are:
4421     * @li ELM_WRAP_NONE - No wrapping
4422     * @li ELM_WRAP_CHAR - wrap between characters
4423     * @li ELM_WRAP_WORD - wrap between words
4424     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
4425     */
4426    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
4427    /**
4428     * @brief Get the wrapping behavior of the label
4429     *
4430     * @param obj The label object
4431     * @return Wrap type
4432     *
4433     * @see elm_label_line_wrap_set()
4434     */
4435    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4436    /**
4437     * @brief Set wrap width of the label
4438     *
4439     * @param obj The label object
4440     * @param w The wrap width in pixels at a minimum where words need to wrap
4441     *
4442     * This function sets the maximum width size hint of the label.
4443     *
4444     * @warning This is only relevant if the label is inside a container.
4445     */
4446    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
4447    /**
4448     * @brief Get wrap width of the label
4449     *
4450     * @param obj The label object
4451     * @return The wrap width in pixels at a minimum where words need to wrap
4452     *
4453     * @see elm_label_wrap_width_set()
4454     */
4455    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4456    /**
4457     * @brief Set wrap height of the label
4458     *
4459     * @param obj The label object
4460     * @param h The wrap height in pixels at a minimum where words need to wrap
4461     *
4462     * This function sets the maximum height size hint of the label.
4463     *
4464     * @warning This is only relevant if the label is inside a container.
4465     */
4466    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
4467    /**
4468     * @brief get wrap width of the label
4469     *
4470     * @param obj The label object
4471     * @return The wrap height in pixels at a minimum where words need to wrap
4472     */
4473    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4474    /**
4475     * @brief Set the font size on the label object.
4476     *
4477     * @param obj The label object
4478     * @param size font size
4479     *
4480     * @warning NEVER use this. It is for hyper-special cases only. use styles
4481     * instead. e.g. "big", "medium", "small" - or better name them by use:
4482     * "title", "footnote", "quote" etc.
4483     */
4484    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
4485    /**
4486     * @brief Set the text color on the label object
4487     *
4488     * @param obj The label object
4489     * @param r Red property background color of The label object
4490     * @param g Green property background color of The label object
4491     * @param b Blue property background color of The label object
4492     * @param a Alpha property background color of The label object
4493     *
4494     * @warning NEVER use this. It is for hyper-special cases only. use styles
4495     * instead. e.g. "big", "medium", "small" - or better name them by use:
4496     * "title", "footnote", "quote" etc.
4497     */
4498    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);
4499    /**
4500     * @brief Set the text align on the label object
4501     *
4502     * @param obj The label object
4503     * @param align align mode ("left", "center", "right")
4504     *
4505     * @warning NEVER use this. It is for hyper-special cases only. use styles
4506     * instead. e.g. "big", "medium", "small" - or better name them by use:
4507     * "title", "footnote", "quote" etc.
4508     */
4509    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
4510    /**
4511     * @brief Set background color of the label
4512     *
4513     * @param obj The label object
4514     * @param r Red property background color of The label object
4515     * @param g Green property background color of The label object
4516     * @param b Blue property background color of The label object
4517     * @param a Alpha property background alpha of The label object
4518     *
4519     * @warning NEVER use this. It is for hyper-special cases only. use styles
4520     * instead. e.g. "big", "medium", "small" - or better name them by use:
4521     * "title", "footnote", "quote" etc.
4522     */
4523    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);
4524    /**
4525     * @brief Set the ellipsis behavior of the label
4526     *
4527     * @param obj The label object
4528     * @param ellipsis To ellipsis text or not
4529     *
4530     * If set to true and the text doesn't fit in the label an ellipsis("...")
4531     * will be shown at the end of the widget.
4532     *
4533     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
4534     * choosen wrap method was ELM_WRAP_WORD.
4535     */
4536    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
4537    /**
4538     * @brief Set the text slide of the label
4539     *
4540     * @param obj The label object
4541     * @param slide To start slide or stop
4542     *
4543     * If set to true the text of the label will slide throught the length of
4544     * label.
4545     *
4546     * @warning This only work with the themes "slide_short", "slide_long" and
4547     * "slide_bounce".
4548     */
4549    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
4550    /**
4551     * @brief Get the text slide mode of the label
4552     *
4553     * @param obj The label object
4554     * @return slide slide mode value
4555     *
4556     * @see elm_label_slide_set()
4557     */
4558    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4559    /**
4560     * @brief Set the slide duration(speed) of the label
4561     *
4562     * @param obj The label object
4563     * @return The duration in seconds in moving text from slide begin position
4564     * to slide end position
4565     */
4566    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
4567    /**
4568     * @brief Get the slide duration(speed) of the label
4569     *
4570     * @param obj The label object
4571     * @return The duration time in moving text from slide begin position to slide end position
4572     *
4573     * @see elm_label_slide_duration_set()
4574     */
4575    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4576    /**
4577     * @}
4578     */
4579
4580    /**
4581     * @defgroup Toggle
4582     *
4583     * @image html img/widget/toggle/preview-00.png
4584     * @image latex img/widget/toggle/preview-00.eps
4585     *
4586     * @brief A toggle is a slider which can be used to toggle between
4587     * two values.  It has two states: on and off.
4588     *
4589     * Signals that you can add callbacks for are:
4590     * @li "changed" - Whenever the toggle value has been changed.  Is not called
4591     *                 until the toggle is released by the cursor (assuming it
4592     *                 has been triggered by the cursor in the first place).
4593     *
4594     * @ref tutorial_toggle show how to use a toggle.
4595     * @{
4596     */
4597    /**
4598     * @brief Add a toggle to @p parent.
4599     *
4600     * @param parent The parent object
4601     *
4602     * @return The toggle object
4603     */
4604    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4605    /**
4606     * @brief Sets the label to be displayed with the toggle.
4607     *
4608     * @param obj The toggle object
4609     * @param label The label to be displayed
4610     *
4611     * @deprecated use elm_object_text_set() instead.
4612     */
4613    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4614    /**
4615     * @brief Gets the label of the toggle
4616     *
4617     * @param obj  toggle object
4618     * @return The label of the toggle
4619     *
4620     * @deprecated use elm_object_text_get() instead.
4621     */
4622    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4623    /**
4624     * @brief Set the icon used for the toggle
4625     *
4626     * @param obj The toggle object
4627     * @param icon The icon object for the button
4628     *
4629     * Once the icon object is set, a previously set one will be deleted
4630     * If you want to keep that old content object, use the
4631     * elm_toggle_icon_unset() function.
4632     */
4633    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4634    /**
4635     * @brief Get the icon used for the toggle
4636     *
4637     * @param obj The toggle object
4638     * @return The icon object that is being used
4639     *
4640     * Return the icon object which is set for this widget.
4641     *
4642     * @see elm_toggle_icon_set()
4643     */
4644    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4645    /**
4646     * @brief Unset the icon used for the toggle
4647     *
4648     * @param obj The toggle object
4649     * @return The icon object that was being used
4650     *
4651     * Unparent and return the icon object which was set for this widget.
4652     *
4653     * @see elm_toggle_icon_set()
4654     */
4655    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4656    /**
4657     * @brief Sets the labels to be associated with the on and off states of the toggle.
4658     *
4659     * @param obj The toggle object
4660     * @param onlabel The label displayed when the toggle is in the "on" state
4661     * @param offlabel The label displayed when the toggle is in the "off" state
4662     */
4663    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
4664    /**
4665     * @brief Gets the labels associated with the on and off states of the toggle.
4666     *
4667     * @param obj The toggle object
4668     * @param onlabel A char** to place the onlabel of @p obj into
4669     * @param offlabel A char** to place the offlabel of @p obj into
4670     */
4671    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
4672    /**
4673     * @brief Sets the state of the toggle to @p state.
4674     *
4675     * @param obj The toggle object
4676     * @param state The state of @p obj
4677     */
4678    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
4679    /**
4680     * @brief Gets the state of the toggle to @p state.
4681     *
4682     * @param obj The toggle object
4683     * @return The state of @p obj
4684     */
4685    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4686    /**
4687     * @brief Sets the state pointer of the toggle to @p statep.
4688     *
4689     * @param obj The toggle object
4690     * @param statep The state pointer of @p obj
4691     */
4692    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
4693    /**
4694     * @}
4695     */
4696
4697    /**
4698     * @defgroup Frame Frame
4699     *
4700     * @image html img/widget/frame/preview-00.png
4701     * @image latex img/widget/frame/preview-00.eps
4702     *
4703     * @brief Frame is a widget that holds some content and has a title.
4704     *
4705     * The default look is a frame with a title, but Frame supports multple
4706     * styles:
4707     * @li default
4708     * @li pad_small
4709     * @li pad_medium
4710     * @li pad_large
4711     * @li pad_huge
4712     * @li outdent_top
4713     * @li outdent_bottom
4714     *
4715     * Of all this styles only default shows the title. Frame emits no signals.
4716     *
4717     * For a detailed example see the @ref tutorial_frame.
4718     *
4719     * @{
4720     */
4721    /**
4722     * @brief Add a new frame to the parent
4723     *
4724     * @param parent The parent object
4725     * @return The new object or NULL if it cannot be created
4726     */
4727    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4728    /**
4729     * @brief Set the frame label
4730     *
4731     * @param obj The frame object
4732     * @param label The label of this frame object
4733     *
4734     * @deprecated use elm_object_text_set() instead.
4735     */
4736    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4737    /**
4738     * @brief Get the frame label
4739     *
4740     * @param obj The frame object
4741     *
4742     * @return The label of this frame objet or NULL if unable to get frame
4743     *
4744     * @deprecated use elm_object_text_get() instead.
4745     */
4746    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4747    /**
4748     * @brief Set the content of the frame widget
4749     *
4750     * Once the content object is set, a previously set one will be deleted.
4751     * If you want to keep that old content object, use the
4752     * elm_frame_content_unset() function.
4753     *
4754     * @param obj The frame object
4755     * @param content The content will be filled in this frame object
4756     */
4757    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4758    /**
4759     * @brief Get the content of the frame widget
4760     *
4761     * Return the content object which is set for this widget
4762     *
4763     * @param obj The frame object
4764     * @return The content that is being used
4765     */
4766    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4767    /**
4768     * @brief Unset the content of the frame widget
4769     *
4770     * Unparent and return the content object which was set for this widget
4771     *
4772     * @param obj The frame object
4773     * @return The content that was being used
4774     */
4775    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4776    /**
4777     * @}
4778     */
4779
4780    /**
4781     * @defgroup Table Table
4782     *
4783     * A container widget to arrange other widgets in a table where items can
4784     * also span multiple columns or rows - even overlap (and then be raised or
4785     * lowered accordingly to adjust stacking if they do overlap).
4786     *
4787     * The followin are examples of how to use a table:
4788     * @li @ref tutorial_table_01
4789     * @li @ref tutorial_table_02
4790     *
4791     * @{
4792     */
4793    /**
4794     * @brief Add a new table to the parent
4795     *
4796     * @param parent The parent object
4797     * @return The new object or NULL if it cannot be created
4798     */
4799    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4800    /**
4801     * @brief Set the homogeneous layout in the table
4802     *
4803     * @param obj The layout object
4804     * @param homogeneous A boolean to set if the layout is homogeneous in the
4805     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
4806     */
4807    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4808    /**
4809     * @brief Get the current table homogeneous mode.
4810     *
4811     * @param obj The table object
4812     * @return A boolean to indicating if the layout is homogeneous in the table
4813     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
4814     */
4815    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4816    /**
4817     * @warning <b>Use elm_table_homogeneous_set() instead</b>
4818     */
4819    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4820    /**
4821     * @warning <b>Use elm_table_homogeneous_get() instead</b>
4822     */
4823    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4824    /**
4825     * @brief Set padding between cells.
4826     *
4827     * @param obj The layout object.
4828     * @param horizontal set the horizontal padding.
4829     * @param vertical set the vertical padding.
4830     *
4831     * Default value is 0.
4832     */
4833    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
4834    /**
4835     * @brief Get padding between cells.
4836     *
4837     * @param obj The layout object.
4838     * @param horizontal set the horizontal padding.
4839     * @param vertical set the vertical padding.
4840     */
4841    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
4842    /**
4843     * @brief Add a subobject on the table with the coordinates passed
4844     *
4845     * @param obj The table object
4846     * @param subobj The subobject to be added to the table
4847     * @param x Row number
4848     * @param y Column number
4849     * @param w rowspan
4850     * @param h colspan
4851     *
4852     * @note All positioning inside the table is relative to rows and columns, so
4853     * a value of 0 for x and y, means the top left cell of the table, and a
4854     * value of 1 for w and h means @p subobj only takes that 1 cell.
4855     */
4856    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4857    /**
4858     * @brief Remove child from table.
4859     *
4860     * @param obj The table object
4861     * @param subobj The subobject
4862     */
4863    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4864    /**
4865     * @brief Faster way to remove all child objects from a table object.
4866     *
4867     * @param obj The table object
4868     * @param clear If true, will delete children, else just remove from table.
4869     */
4870    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
4871    /**
4872     * @brief Set the packing location of an existing child of the table
4873     *
4874     * @param subobj The subobject to be modified in the table
4875     * @param x Row number
4876     * @param y Column number
4877     * @param w rowspan
4878     * @param h colspan
4879     *
4880     * Modifies the position of an object already in the table.
4881     *
4882     * @note All positioning inside the table is relative to rows and columns, so
4883     * a value of 0 for x and y, means the top left cell of the table, and a
4884     * value of 1 for w and h means @p subobj only takes that 1 cell.
4885     */
4886    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4887    /**
4888     * @brief Get the packing location of an existing child of the table
4889     *
4890     * @param subobj The subobject to be modified in the table
4891     * @param x Row number
4892     * @param y Column number
4893     * @param w rowspan
4894     * @param h colspan
4895     *
4896     * @see elm_table_pack_set()
4897     */
4898    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4899    /**
4900     * @}
4901     */
4902
4903    /**
4904     * @defgroup Gengrid Gengrid (Generic grid)
4905     *
4906     * This widget aims to position objects in a grid layout while
4907     * actually creating and rendering only the visible ones, using the
4908     * same idea as the @ref Genlist "genlist": the user defines a @b
4909     * class for each item, specifying functions that will be called at
4910     * object creation, deletion, etc. When those items are selected by
4911     * the user, a callback function is issued. Users may interact with
4912     * a gengrid via the mouse (by clicking on items to select them and
4913     * clicking on the grid's viewport and swiping to pan the whole
4914     * view) or via the keyboard, navigating through item with the
4915     * arrow keys.
4916     *
4917     * @section Gengrid_Layouts Gengrid layouts
4918     *
4919     * Gengrids may layout its items in one of two possible layouts:
4920     * - horizontal or
4921     * - vertical.
4922     *
4923     * When in "horizontal mode", items will be placed in @b columns,
4924     * from top to bottom and, when the space for a column is filled,
4925     * another one is started on the right, thus expanding the grid
4926     * horizontally, making for horizontal scrolling. When in "vertical
4927     * mode" , though, items will be placed in @b rows, from left to
4928     * right and, when the space for a row is filled, another one is
4929     * started below, thus expanding the grid vertically (and making
4930     * for vertical scrolling).
4931     *
4932     * @section Gengrid_Items Gengrid items
4933     *
4934     * An item in a gengrid can have 0 or more text labels (they can be
4935     * regular text or textblock Evas objects - that's up to the style
4936     * to determine), 0 or more icons (which are simply objects
4937     * swallowed into the gengrid item's theming Edje object) and 0 or
4938     * more <b>boolean states</b>, which have the behavior left to the
4939     * user to define. The Edje part names for each of these properties
4940     * will be looked up, in the theme file for the gengrid, under the
4941     * Edje (string) data items named @c "labels", @c "icons" and @c
4942     * "states", respectively. For each of those properties, if more
4943     * than one part is provided, they must have names listed separated
4944     * by spaces in the data fields. For the default gengrid item
4945     * theme, we have @b one label part (@c "elm.text"), @b two icon
4946     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
4947     * no state parts.
4948     *
4949     * A gengrid item may be at one of several styles. Elementary
4950     * provides one by default - "default", but this can be extended by
4951     * system or application custom themes/overlays/extensions (see
4952     * @ref Theme "themes" for more details).
4953     *
4954     * @section Gengrid_Item_Class Gengrid item classes
4955     *
4956     * In order to have the ability to add and delete items on the fly,
4957     * gengrid implements a class (callback) system where the
4958     * application provides a structure with information about that
4959     * type of item (gengrid may contain multiple different items with
4960     * different classes, states and styles). Gengrid will call the
4961     * functions in this struct (methods) when an item is "realized"
4962     * (i.e., created dynamically, while the user is scrolling the
4963     * grid). All objects will simply be deleted when no longer needed
4964     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
4965     * contains the following members:
4966     * - @c item_style - This is a constant string and simply defines
4967     * the name of the item style. It @b must be specified and the
4968     * default should be @c "default".
4969     * - @c func.label_get - This function is called when an item
4970     * object is actually created. The @c data parameter will point to
4971     * the same data passed to elm_gengrid_item_append() and related
4972     * item creation functions. The @c obj parameter is the gengrid
4973     * object itself, while the @c part one is the name string of one
4974     * of the existing text parts in the Edje group implementing the
4975     * item's theme. This function @b must return a strdup'()ed string,
4976     * as the caller will free() it when done. See
4977     * #GridItemLabelGetFunc.
4978     * - @c func.icon_get - This function is called when an item object
4979     * is actually created. The @c data parameter will point to the
4980     * same data passed to elm_gengrid_item_append() and related item
4981     * creation functions. The @c obj parameter is the gengrid object
4982     * itself, while the @c part one is the name string of one of the
4983     * existing (icon) swallow parts in the Edje group implementing the
4984     * item's theme. It must return @c NULL, when no icon is desired,
4985     * or a valid object handle, otherwise. The object will be deleted
4986     * by the gengrid on its deletion or when the item is "unrealized".
4987     * See #GridItemIconGetFunc.
4988     * - @c func.state_get - This function is called when an item
4989     * object is actually created. The @c data parameter will point to
4990     * the same data passed to elm_gengrid_item_append() and related
4991     * item creation functions. The @c obj parameter is the gengrid
4992     * object itself, while the @c part one is the name string of one
4993     * of the state parts in the Edje group implementing the item's
4994     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
4995     * true/on. Gengrids will emit a signal to its theming Edje object
4996     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
4997     * "source" arguments, respectively, when the state is true (the
4998     * default is false), where @c XXX is the name of the (state) part.
4999     * See #GridItemStateGetFunc.
5000     * - @c func.del - This is called when elm_gengrid_item_del() is
5001     * called on an item or elm_gengrid_clear() is called on the
5002     * gengrid. This is intended for use when gengrid items are
5003     * deleted, so any data attached to the item (e.g. its data
5004     * parameter on creation) can be deleted. See #GridItemDelFunc.
5005     *
5006     * @section Gengrid_Usage_Hints Usage hints
5007     *
5008     * If the user wants to have multiple items selected at the same
5009     * time, elm_gengrid_multi_select_set() will permit it. If the
5010     * gengrid is single-selection only (the default), then
5011     * elm_gengrid_select_item_get() will return the selected item or
5012     * @c NULL, if none is selected. If the gengrid is under
5013     * multi-selection, then elm_gengrid_selected_items_get() will
5014     * return a list (that is only valid as long as no items are
5015     * modified (added, deleted, selected or unselected) of child items
5016     * on a gengrid.
5017     *
5018     * If an item changes (internal (boolean) state, label or icon
5019     * changes), then use elm_gengrid_item_update() to have gengrid
5020     * update the item with the new state. A gengrid will re-"realize"
5021     * the item, thus calling the functions in the
5022     * #Elm_Gengrid_Item_Class set for that item.
5023     *
5024     * To programmatically (un)select an item, use
5025     * elm_gengrid_item_selected_set(). To get its selected state use
5026     * elm_gengrid_item_selected_get(). To make an item disabled
5027     * (unable to be selected and appear differently) use
5028     * elm_gengrid_item_disabled_set() to set this and
5029     * elm_gengrid_item_disabled_get() to get the disabled state.
5030     *
5031     * Grid cells will only have their selection smart callbacks called
5032     * when firstly getting selected. Any further clicks will do
5033     * nothing, unless you enable the "always select mode", with
5034     * elm_gengrid_always_select_mode_set(), thus making every click to
5035     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5036     * turn off the ability to select items entirely in the widget and
5037     * they will neither appear selected nor call the selection smart
5038     * callbacks.
5039     *
5040     * Remember that you can create new styles and add your own theme
5041     * augmentation per application with elm_theme_extension_add(). If
5042     * you absolutely must have a specific style that overrides any
5043     * theme the user or system sets up you can use
5044     * elm_theme_overlay_add() to add such a file.
5045     *
5046     * @section Gengrid_Smart_Events Gengrid smart events
5047     *
5048     * Smart events that you can add callbacks for are:
5049     * - @c "activated" - The user has double-clicked or pressed
5050     *   (enter|return|spacebar) on an item. The @c event_info parameter
5051     *   is the gengrid item that was activated.
5052     * - @c "clicked,double" - The user has double-clicked an item.
5053     *   The @c event_info parameter is the gengrid item that was double-clicked.
5054     * - @c "selected" - The user has made an item selected. The
5055     *   @c event_info parameter is the gengrid item that was selected.
5056     * - @c "unselected" - The user has made an item unselected. The
5057     *   @c event_info parameter is the gengrid item that was unselected.
5058     * - @c "realized" - This is called when the item in the gengrid
5059     *   has its implementing Evas object instantiated, de facto. @c
5060     *   event_info is the gengrid item that was created. The object
5061     *   may be deleted at any time, so it is highly advised to the
5062     *   caller @b not to use the object pointer returned from
5063     *   elm_gengrid_item_object_get(), because it may point to freed
5064     *   objects.
5065     * - @c "unrealized" - This is called when the implementing Evas
5066     *   object for this item is deleted. @c event_info is the gengrid
5067     *   item that was deleted.
5068     * - @c "changed" - Called when an item is added, removed, resized
5069     *   or moved and when the gengrid is resized or gets "horizontal"
5070     *   property changes.
5071     * - @c "drag,start,up" - Called when the item in the gengrid has
5072     *   been dragged (not scrolled) up.
5073     * - @c "drag,start,down" - Called when the item in the gengrid has
5074     *   been dragged (not scrolled) down.
5075     * - @c "drag,start,left" - Called when the item in the gengrid has
5076     *   been dragged (not scrolled) left.
5077     * - @c "drag,start,right" - Called when the item in the gengrid has
5078     *   been dragged (not scrolled) right.
5079     * - @c "drag,stop" - Called when the item in the gengrid has
5080     *   stopped being dragged.
5081     * - @c "drag" - Called when the item in the gengrid is being
5082     *   dragged.
5083     * - @c "scroll" - called when the content has been scrolled
5084     *   (moved).
5085     * - @c "scroll,drag,start" - called when dragging the content has
5086     *   started.
5087     * - @c "scroll,drag,stop" - called when dragging the content has
5088     *   stopped.
5089     *
5090     * List of gendrid examples:
5091     * @li @ref gengrid_example
5092     */
5093
5094    /**
5095     * @addtogroup Gengrid
5096     * @{
5097     */
5098
5099    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5100    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5101    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5102    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5103    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5104    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5105    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5106
5107    /**
5108     * @struct _Elm_Gengrid_Item_Class
5109     *
5110     * Gengrid item class definition. See @ref Gengrid_Item_Class for
5111     * field details.
5112     */
5113    struct _Elm_Gengrid_Item_Class
5114      {
5115         const char             *item_style;
5116         struct _Elm_Gengrid_Item_Class_Func
5117           {
5118              GridItemLabelGetFunc  label_get;
5119              GridItemIconGetFunc   icon_get;
5120              GridItemStateGetFunc  state_get;
5121              GridItemDelFunc       del;
5122           } func;
5123      }; /**< #Elm_Gengrid_Item_Class member definitions */
5124
5125    /**
5126     * Add a new gengrid widget to the given parent Elementary
5127     * (container) object
5128     *
5129     * @param parent The parent object
5130     * @return a new gengrid widget handle or @c NULL, on errors
5131     *
5132     * This function inserts a new gengrid widget on the canvas.
5133     *
5134     * @see elm_gengrid_item_size_set()
5135     * @see elm_gengrid_horizontal_set()
5136     * @see elm_gengrid_item_append()
5137     * @see elm_gengrid_item_del()
5138     * @see elm_gengrid_clear()
5139     *
5140     * @ingroup Gengrid
5141     */
5142    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5143
5144    /**
5145     * Set the size for the items of a given gengrid widget
5146     *
5147     * @param obj The gengrid object.
5148     * @param w The items' width.
5149     * @param h The items' height;
5150     *
5151     * A gengrid, after creation, has still no information on the size
5152     * to give to each of its cells. So, you most probably will end up
5153     * with squares one @ref Fingers "finger" wide, the default
5154     * size. Use this function to force a custom size for you items,
5155     * making them as big as you wish.
5156     *
5157     * @see elm_gengrid_item_size_get()
5158     *
5159     * @ingroup Gengrid
5160     */
5161    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5162
5163    /**
5164     * Get the size set for the items of a given gengrid widget
5165     *
5166     * @param obj The gengrid object.
5167     * @param w Pointer to a variable where to store the items' width.
5168     * @param h Pointer to a variable where to store the items' height.
5169     *
5170     * @note Use @c NULL pointers on the size values you're not
5171     * interested in: they'll be ignored by the function.
5172     *
5173     * @see elm_gengrid_item_size_get() for more details
5174     *
5175     * @ingroup Gengrid
5176     */
5177    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5178
5179    /**
5180     * Set the items grid's alignment within a given gengrid widget
5181     *
5182     * @param obj The gengrid object.
5183     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5184     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5185     *
5186     * This sets the alignment of the whole grid of items of a gengrid
5187     * within its given viewport. By default, those values are both
5188     * 0.5, meaning that the gengrid will have its items grid placed
5189     * exactly in the middle of its viewport.
5190     *
5191     * @note If given alignment values are out of the cited ranges,
5192     * they'll be changed to the nearest boundary values on the valid
5193     * ranges.
5194     *
5195     * @see elm_gengrid_align_get()
5196     *
5197     * @ingroup Gengrid
5198     */
5199    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5200
5201    /**
5202     * Get the items grid's alignment values within a given gengrid
5203     * widget
5204     *
5205     * @param obj The gengrid object.
5206     * @param align_x Pointer to a variable where to store the
5207     * horizontal alignment.
5208     * @param align_y Pointer to a variable where to store the vertical
5209     * alignment.
5210     *
5211     * @note Use @c NULL pointers on the alignment values you're not
5212     * interested in: they'll be ignored by the function.
5213     *
5214     * @see elm_gengrid_align_set() for more details
5215     *
5216     * @ingroup Gengrid
5217     */
5218    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5219
5220    /**
5221     * Set whether a given gengrid widget is or not able have items
5222     * @b reordered
5223     *
5224     * @param obj The gengrid object
5225     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5226     * @c EINA_FALSE to turn it off
5227     *
5228     * If a gengrid is set to allow reordering, a click held for more
5229     * than 0.5 over a given item will highlight it specially,
5230     * signalling the gengrid has entered the reordering state. From
5231     * that time on, the user will be able to, while still holding the
5232     * mouse button down, move the item freely in the gengrid's
5233     * viewport, replacing to said item to the locations it goes to.
5234     * The replacements will be animated and, whenever the user
5235     * releases the mouse button, the item being replaced gets a new
5236     * definitive place in the grid.
5237     *
5238     * @see elm_gengrid_reorder_mode_get()
5239     *
5240     * @ingroup Gengrid
5241     */
5242    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5243
5244    /**
5245     * Get whether a given gengrid widget is or not able have items
5246     * @b reordered
5247     *
5248     * @param obj The gengrid object
5249     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
5250     * off
5251     *
5252     * @see elm_gengrid_reorder_mode_set() for more details
5253     *
5254     * @ingroup Gengrid
5255     */
5256    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5257
5258    /**
5259     * Append a new item in a given gengrid widget.
5260     *
5261     * @param obj The gengrid object.
5262     * @param gic The item class for the item.
5263     * @param data The item data.
5264     * @param func Convenience function called when the item is
5265     * selected.
5266     * @param func_data Data to be passed to @p func.
5267     * @return A handle to the item added or @c NULL, on errors.
5268     *
5269     * This adds an item to the beginning of the gengrid.
5270     *
5271     * @see elm_gengrid_item_prepend()
5272     * @see elm_gengrid_item_insert_before()
5273     * @see elm_gengrid_item_insert_after()
5274     * @see elm_gengrid_item_del()
5275     *
5276     * @ingroup Gengrid
5277     */
5278    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);
5279
5280    /**
5281     * Prepend a new item in a given gengrid widget.
5282     *
5283     * @param obj The gengrid object.
5284     * @param gic The item class for the item.
5285     * @param data The item data.
5286     * @param func Convenience function called when the item is
5287     * selected.
5288     * @param func_data Data to be passed to @p func.
5289     * @return A handle to the item added or @c NULL, on errors.
5290     *
5291     * This adds an item to the end of the gengrid.
5292     *
5293     * @see elm_gengrid_item_append()
5294     * @see elm_gengrid_item_insert_before()
5295     * @see elm_gengrid_item_insert_after()
5296     * @see elm_gengrid_item_del()
5297     *
5298     * @ingroup Gengrid
5299     */
5300    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);
5301
5302    /**
5303     * Insert an item before another in a gengrid widget
5304     *
5305     * @param obj The gengrid object.
5306     * @param gic The item class for the item.
5307     * @param data The item data.
5308     * @param relative The item to place this new one before.
5309     * @param func Convenience function called when the item is
5310     * selected.
5311     * @param func_data Data to be passed to @p func.
5312     * @return A handle to the item added or @c NULL, on errors.
5313     *
5314     * This inserts an item before another in the gengrid.
5315     *
5316     * @see elm_gengrid_item_append()
5317     * @see elm_gengrid_item_prepend()
5318     * @see elm_gengrid_item_insert_after()
5319     * @see elm_gengrid_item_del()
5320     *
5321     * @ingroup Gengrid
5322     */
5323    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);
5324
5325    /**
5326     * Insert an item after another in a gengrid widget
5327     *
5328     * @param obj The gengrid object.
5329     * @param gic The item class for the item.
5330     * @param data The item data.
5331     * @param relative The item to place this new one after.
5332     * @param func Convenience function called when the item is
5333     * selected.
5334     * @param func_data Data to be passed to @p func.
5335     * @return A handle to the item added or @c NULL, on errors.
5336     *
5337     * This inserts an item after another in the gengrid.
5338     *
5339     * @see elm_gengrid_item_append()
5340     * @see elm_gengrid_item_prepend()
5341     * @see elm_gengrid_item_insert_after()
5342     * @see elm_gengrid_item_del()
5343     *
5344     * @ingroup Gengrid
5345     */
5346    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);
5347
5348    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);
5349
5350    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);
5351
5352    /**
5353     * Set whether items on a given gengrid widget are to get their
5354     * selection callbacks issued for @b every subsequent selection
5355     * click on them or just for the first click.
5356     *
5357     * @param obj The gengrid object
5358     * @param always_select @c EINA_TRUE to make items "always
5359     * selected", @c EINA_FALSE, otherwise
5360     *
5361     * By default, grid items will only call their selection callback
5362     * function when firstly getting selected, any subsequent further
5363     * clicks will do nothing. With this call, you make those
5364     * subsequent clicks also to issue the selection callbacks.
5365     *
5366     * @note <b>Double clicks</b> will @b always be reported on items.
5367     *
5368     * @see elm_gengrid_always_select_mode_get()
5369     *
5370     * @ingroup Gengrid
5371     */
5372    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5373
5374    /**
5375     * Get whether items on a given gengrid widget have their selection
5376     * callbacks issued for @b every subsequent selection click on them
5377     * or just for the first click.
5378     *
5379     * @param obj The gengrid object.
5380     * @return @c EINA_TRUE if the gengrid items are "always selected",
5381     * @c EINA_FALSE, otherwise
5382     *
5383     * @see elm_gengrid_always_select_mode_set() for more details
5384     *
5385     * @ingroup Gengrid
5386     */
5387    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5388
5389    /**
5390     * Set whether items on a given gengrid widget can be selected or not.
5391     *
5392     * @param obj The gengrid object
5393     * @param no_select @c EINA_TRUE to make items selectable,
5394     * @c EINA_FALSE otherwise
5395     *
5396     * This will make items in @obj selectable or not. In the latter
5397     * case, any user interacion on the gendrid items will neither make
5398     * them appear selected nor them call their selection callback
5399     * functions.
5400     *
5401     * @see elm_gengrid_no_select_mode_get()
5402     *
5403     * @ingroup Gengrid
5404     */
5405    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5406
5407    /**
5408     * Get whether items on a given gengrid widget can be selected or
5409     * not.
5410     *
5411     * @param obj The gengrid object
5412     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
5413     * otherwise
5414     *
5415     * @see elm_gengrid_no_select_mode_set() for more details
5416     *
5417     * @ingroup Gengrid
5418     */
5419    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5420
5421    /**
5422     * Enable or disable multi-selection in a given gengrid widget
5423     *
5424     * @param obj The gengrid object.
5425     * @param multi @c EINA_TRUE, to enable multi-selection,
5426     * @c EINA_FALSE to disable it.
5427     *
5428     * Multi-selection is the ability for one to have @b more than one
5429     * item selected, on a given gengrid, simultaneously. When it is
5430     * enabled, a sequence of clicks on different items will make them
5431     * all selected, progressively. A click on an already selected item
5432     * will unselect it. If interecting via the keyboard,
5433     * multi-selection is enabled while holding the "Shift" key.
5434     *
5435     * @note By default, multi-selection is @b disabled on gengrids
5436     *
5437     * @see elm_gengrid_multi_select_get()
5438     *
5439     * @ingroup Gengrid
5440     */
5441    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5442
5443    /**
5444     * Get whether multi-selection is enabled or disabled for a given
5445     * gengrid widget
5446     *
5447     * @param obj The gengrid object.
5448     * @return @c EINA_TRUE, if multi-selection is enabled, @c
5449     * EINA_FALSE otherwise
5450     *
5451     * @see elm_gengrid_multi_select_set() for more details
5452     *
5453     * @ingroup Gengrid
5454     */
5455    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5456
5457    /**
5458     * Enable or disable bouncing effect for a given gengrid widget
5459     *
5460     * @param obj The gengrid object
5461     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
5462     * @c EINA_FALSE to disable it
5463     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
5464     * @c EINA_FALSE to disable it
5465     *
5466     * The bouncing effect occurs whenever one reaches the gengrid's
5467     * edge's while panning it -- it will scroll past its limits a
5468     * little bit and return to the edge again, in a animated for,
5469     * automatically.
5470     *
5471     * @note By default, gengrids have bouncing enabled on both axis
5472     *
5473     * @see elm_gengrid_bounce_get()
5474     *
5475     * @ingroup Gengrid
5476     */
5477    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5478
5479    /**
5480     * Get whether bouncing effects are enabled or disabled, for a
5481     * given gengrid widget, on each axis
5482     *
5483     * @param obj The gengrid object
5484     * @param h_bounce Pointer to a variable where to store the
5485     * horizontal bouncing flag.
5486     * @param v_bounce Pointer to a variable where to store the
5487     * vertical bouncing flag.
5488     *
5489     * @see elm_gengrid_bounce_set() for more details
5490     *
5491     * @ingroup Gengrid
5492     */
5493    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5494
5495    /**
5496     * Set a given gengrid widget's scrolling page size, relative to
5497     * its viewport size.
5498     *
5499     * @param obj The gengrid object
5500     * @param h_pagerel The horizontal page (relative) size
5501     * @param v_pagerel The vertical page (relative) size
5502     *
5503     * The gengrid's scroller is capable of binding scrolling by the
5504     * user to "pages". It means that, while scrolling and, specially
5505     * after releasing the mouse button, the grid will @b snap to the
5506     * nearest displaying page's area. When page sizes are set, the
5507     * grid's continuous content area is split into (equal) page sized
5508     * pieces.
5509     *
5510     * This function sets the size of a page <b>relatively to the
5511     * viewport dimensions</b> of the gengrid, for each axis. A value
5512     * @c 1.0 means "the exact viewport's size", in that axis, while @c
5513     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
5514     * a viewport". Sane usable values are, than, between @c 0.0 and @c
5515     * 1.0. Values beyond those will make it behave behave
5516     * inconsistently. If you only want one axis to snap to pages, use
5517     * the value @c 0.0 for the other one.
5518     *
5519     * There is a function setting page size values in @b absolute
5520     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
5521     * is mutually exclusive to this one.
5522     *
5523     * @see elm_gengrid_page_relative_get()
5524     *
5525     * @ingroup Gengrid
5526     */
5527    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5528
5529    /**
5530     * Get a given gengrid widget's scrolling page size, relative to
5531     * its viewport size.
5532     *
5533     * @param obj The gengrid object
5534     * @param h_pagerel Pointer to a variable where to store the
5535     * horizontal page (relative) size
5536     * @param v_pagerel Pointer to a variable where to store the
5537     * vertical page (relative) size
5538     *
5539     * @see elm_gengrid_page_relative_set() for more details
5540     *
5541     * @ingroup Gengrid
5542     */
5543    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
5544
5545    /**
5546     * Set a given gengrid widget's scrolling page size
5547     *
5548     * @param obj The gengrid object
5549     * @param h_pagerel The horizontal page size, in pixels
5550     * @param v_pagerel The vertical page size, in pixels
5551     *
5552     * The gengrid's scroller is capable of binding scrolling by the
5553     * user to "pages". It means that, while scrolling and, specially
5554     * after releasing the mouse button, the grid will @b snap to the
5555     * nearest displaying page's area. When page sizes are set, the
5556     * grid's continuous content area is split into (equal) page sized
5557     * pieces.
5558     *
5559     * This function sets the size of a page of the gengrid, in pixels,
5560     * for each axis. Sane usable values are, between @c 0 and the
5561     * dimensions of @p obj, for each axis. Values beyond those will
5562     * make it behave behave inconsistently. If you only want one axis
5563     * to snap to pages, use the value @c 0 for the other one.
5564     *
5565     * There is a function setting page size values in @b relative
5566     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
5567     * use is mutually exclusive to this one.
5568     *
5569     * @ingroup Gengrid
5570     */
5571    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5572
5573    /**
5574     * Set for what direction a given gengrid widget will expand while
5575     * placing its items.
5576     *
5577     * @param obj The gengrid object.
5578     * @param setting @c EINA_TRUE to make the gengrid expand
5579     * horizontally, @c EINA_FALSE to expand vertically.
5580     *
5581     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
5582     * in @b columns, from top to bottom and, when the space for a
5583     * column is filled, another one is started on the right, thus
5584     * expanding the grid horizontally. When in "vertical mode"
5585     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
5586     * to right and, when the space for a row is filled, another one is
5587     * started below, thus expanding the grid vertically.
5588     *
5589     * @see elm_gengrid_horizontal_get()
5590     *
5591     * @ingroup Gengrid
5592     */
5593    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
5594
5595    /**
5596     * Get for what direction a given gengrid widget will expand while
5597     * placing its items.
5598     *
5599     * @param obj The gengrid object.
5600     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
5601     * @c EINA_FALSE if it's set to expand vertically.
5602     *
5603     * @see elm_gengrid_horizontal_set() for more detais
5604     *
5605     * @ingroup Gengrid
5606     */
5607    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5608
5609    /**
5610     * Get the first item in a given gengrid widget
5611     *
5612     * @param obj The gengrid object
5613     * @return The first item's handle or @c NULL, if there are no
5614     * items in @p obj (and on errors)
5615     *
5616     * This returns the first item in the @p obj's internal list of
5617     * items.
5618     *
5619     * @see elm_gengrid_last_item_get()
5620     *
5621     * @ingroup Gengrid
5622     */
5623    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5624
5625    /**
5626     * Get the last item in a given gengrid widget
5627     *
5628     * @param obj The gengrid object
5629     * @return The last item's handle or @c NULL, if there are no
5630     * items in @p obj (and on errors)
5631     *
5632     * This returns the last item in the @p obj's internal list of
5633     * items.
5634     *
5635     * @see elm_gengrid_first_item_get()
5636     *
5637     * @ingroup Gengrid
5638     */
5639    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5640
5641    /**
5642     * Get the @b next item in a gengrid widget's internal list of items,
5643     * given a handle to one of those items.
5644     *
5645     * @param item The gengrid item to fetch next from
5646     * @return The item after @p item, or @c NULL if there's none (and
5647     * on errors)
5648     *
5649     * This returns the item placed after the @p item, on the container
5650     * gengrid.
5651     *
5652     * @see elm_gengrid_item_prev_get()
5653     *
5654     * @ingroup Gengrid
5655     */
5656    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5657
5658    /**
5659     * Get the @b previous item in a gengrid widget's internal list of items,
5660     * given a handle to one of those items.
5661     *
5662     * @param item The gengrid item to fetch previous from
5663     * @return The item before @p item, or @c NULL if there's none (and
5664     * on errors)
5665     *
5666     * This returns the item placed before the @p item, on the container
5667     * gengrid.
5668     *
5669     * @see elm_gengrid_item_next_get()
5670     *
5671     * @ingroup Gengrid
5672     */
5673    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5674
5675    /**
5676     * Get the gengrid object's handle which contains a given gengrid
5677     * item
5678     *
5679     * @param item The item to fetch the container from
5680     * @return The gengrid (parent) object
5681     *
5682     * This returns the gengrid object itself that an item belongs to.
5683     *
5684     * @ingroup Gengrid
5685     */
5686    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5687
5688    /**
5689     * Remove a gengrid item from the its parent, deleting it.
5690     *
5691     * @param item The item to be removed.
5692     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
5693     *
5694     * @see elm_gengrid_clear(), to remove all items in a gengrid at
5695     * once.
5696     *
5697     * @ingroup Gengrid
5698     */
5699    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5700
5701    /**
5702     * Update the contents of a given gengrid item
5703     *
5704     * @param item The gengrid item
5705     *
5706     * This updates an item by calling all the item class functions
5707     * again to get the icons, labels and states. Use this when the
5708     * original item data has changed and you want thta changes to be
5709     * reflected.
5710     *
5711     * @ingroup Gengrid
5712     */
5713    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5714    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5715    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
5716
5717    /**
5718     * Return the data associated to a given gengrid item
5719     *
5720     * @param item The gengrid item.
5721     * @return the data associated to this item.
5722     *
5723     * This returns the @c data value passed on the
5724     * elm_gengrid_item_append() and related item addition calls.
5725     *
5726     * @see elm_gengrid_item_append()
5727     * @see elm_gengrid_item_data_set()
5728     *
5729     * @ingroup Gengrid
5730     */
5731    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5732
5733    /**
5734     * Set the data associated to a given gengrid item
5735     *
5736     * @param item The gengrid item
5737     * @param data The new data pointer to set on it
5738     *
5739     * This @b overrides the @c data value passed on the
5740     * elm_gengrid_item_append() and related item addition calls. This
5741     * function @b won't call elm_gengrid_item_update() automatically,
5742     * so you'd issue it afterwards if you want to hove the item
5743     * updated to reflect the that new data.
5744     *
5745     * @see elm_gengrid_item_data_get()
5746     *
5747     * @ingroup Gengrid
5748     */
5749    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
5750
5751    /**
5752     * Get a given gengrid item's position, relative to the whole
5753     * gengrid's grid area.
5754     *
5755     * @param item The Gengrid item.
5756     * @param x Pointer to variable where to store the item's <b>row
5757     * number</b>.
5758     * @param y Pointer to variable where to store the item's <b>column
5759     * number</b>.
5760     *
5761     * This returns the "logical" position of the item whithin the
5762     * gengrid. For example, @c (0, 1) would stand for first row,
5763     * second column.
5764     *
5765     * @ingroup Gengrid
5766     */
5767    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
5768
5769    /**
5770     * Set whether a given gengrid item is selected or not
5771     *
5772     * @param item The gengrid item
5773     * @param selected Use @c EINA_TRUE, to make it selected, @c
5774     * EINA_FALSE to make it unselected
5775     *
5776     * This sets the selected state of an item. If multi selection is
5777     * not enabled on the containing gengrid and @p selected is @c
5778     * EINA_TRUE, any other previously selected items will get
5779     * unselected in favor of this new one.
5780     *
5781     * @see elm_gengrid_item_selected_get()
5782     *
5783     * @ingroup Gengrid
5784     */
5785    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5786
5787    /**
5788     * Get whether a given gengrid item is selected or not
5789     *
5790     * @param item The gengrid item
5791     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
5792     *
5793     * @see elm_gengrid_item_selected_set() for more details
5794     *
5795     * @ingroup Gengrid
5796     */
5797    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5798
5799    /**
5800     * Get the real Evas object created to implement the view of a
5801     * given gengrid item
5802     *
5803     * @param item The gengrid item.
5804     * @return the Evas object implementing this item's view.
5805     *
5806     * This returns the actual Evas object used to implement the
5807     * specified gengrid item's view. This may be @c NULL, as it may
5808     * not have been created or may have been deleted, at any time, by
5809     * the gengrid. <b>Do not modify this object</b> (move, resize,
5810     * show, hide, etc.), as the gengrid is controlling it. This
5811     * function is for querying, emitting custom signals or hooking
5812     * lower level callbacks for events on that object. Do not delete
5813     * this object under any circumstances.
5814     *
5815     * @see elm_gengrid_item_data_get()
5816     *
5817     * @ingroup Gengrid
5818     */
5819    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5820
5821    /**
5822     * Show the portion of a gengrid's internal grid containing a given
5823     * item, @b immediately.
5824     *
5825     * @param item The item to display
5826     *
5827     * This causes gengrid to @b redraw its viewport's contents to the
5828     * region contining the given @p item item, if it is not fully
5829     * visible.
5830     *
5831     * @see elm_gengrid_item_bring_in()
5832     *
5833     * @ingroup Gengrid
5834     */
5835    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5836
5837    /**
5838     * Animatedly bring in, to the visible are of a gengrid, a given
5839     * item on it.
5840     *
5841     * @param item The gengrid item to display
5842     *
5843     * This causes gengrig to jump to the given @p item item and show
5844     * it (by scrolling), if it is not fully visible. This will use
5845     * animation to do so and take a period of time to complete.
5846     *
5847     * @see elm_gengrid_item_show()
5848     *
5849     * @ingroup Gengrid
5850     */
5851    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5852
5853    /**
5854     * Set whether a given gengrid item is disabled or not.
5855     *
5856     * @param item The gengrid item
5857     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
5858     * to enable it back.
5859     *
5860     * A disabled item cannot be selected or unselected. It will also
5861     * change its appearance, to signal the user it's disabled.
5862     *
5863     * @see elm_gengrid_item_disabled_get()
5864     *
5865     * @ingroup Gengrid
5866     */
5867    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5868
5869    /**
5870     * Get whether a given gengrid item is disabled or not.
5871     *
5872     * @param item The gengrid item
5873     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
5874     * (and on errors).
5875     *
5876     * @see elm_gengrid_item_disabled_set() for more details
5877     *
5878     * @ingroup Gengrid
5879     */
5880    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5881
5882    /**
5883     * Set the text to be shown in a given gengrid item's tooltips.
5884     *
5885     * @param item The gengrid item
5886     * @param text The text to set in the content
5887     *
5888     * This call will setup the text to be used as tooltip to that item
5889     * (analogous to elm_object_tooltip_text_set(), but being item
5890     * tooltips with higher precedence than object tooltips). It can
5891     * have only one tooltip at a time, so any previous tooltip data
5892     * will get removed.
5893     *
5894     * @ingroup Gengrid
5895     */
5896    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
5897
5898    /**
5899     * Set the content to be shown in a given gengrid item's tooltips
5900     *
5901     * @param item The gengrid item.
5902     * @param func The function returning the tooltip contents.
5903     * @param data What to provide to @a func as callback data/context.
5904     * @param del_cb Called when data is not needed anymore, either when
5905     *        another callback replaces @func, the tooltip is unset with
5906     *        elm_gengrid_item_tooltip_unset() or the owner @p item
5907     *        dies. This callback receives as its first parameter the
5908     *        given @p data, being @c event_info the item handle.
5909     *
5910     * This call will setup the tooltip's contents to @p item
5911     * (analogous to elm_object_tooltip_content_cb_set(), but being
5912     * item tooltips with higher precedence than object tooltips). It
5913     * can have only one tooltip at a time, so any previous tooltip
5914     * content will get removed. @p func (with @p data) will be called
5915     * every time Elementary needs to show the tooltip and it should
5916     * return a valid Evas object, which will be fully managed by the
5917     * tooltip system, getting deleted when the tooltip is gone.
5918     *
5919     * @ingroup Gengrid
5920     */
5921    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);
5922
5923    /**
5924     * Unset a tooltip from a given gengrid item
5925     *
5926     * @param item gengrid item to remove a previously set tooltip from.
5927     *
5928     * This call removes any tooltip set on @p item. The callback
5929     * provided as @c del_cb to
5930     * elm_gengrid_item_tooltip_content_cb_set() will be called to
5931     * notify it is not used anymore (and have resources cleaned, if
5932     * need be).
5933     *
5934     * @see elm_gengrid_item_tooltip_content_cb_set()
5935     *
5936     * @ingroup Gengrid
5937     */
5938    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5939
5940    /**
5941     * Set a different @b style for a given gengrid item's tooltip.
5942     *
5943     * @param item gengrid item with tooltip set
5944     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
5945     * "default", @c "transparent", etc)
5946     *
5947     * Tooltips can have <b>alternate styles</b> to be displayed on,
5948     * which are defined by the theme set on Elementary. This function
5949     * works analogously as elm_object_tooltip_style_set(), but here
5950     * applied only to gengrid item objects. The default style for
5951     * tooltips is @c "default".
5952     *
5953     * @note before you set a style you should define a tooltip with
5954     *       elm_gengrid_item_tooltip_content_cb_set() or
5955     *       elm_gengrid_item_tooltip_text_set()
5956     *
5957     * @see elm_gengrid_item_tooltip_style_get()
5958     *
5959     * @ingroup Gengrid
5960     */
5961    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
5962
5963    /**
5964     * Get the style set a given gengrid item's tooltip.
5965     *
5966     * @param item gengrid item with tooltip already set on.
5967     * @return style the theme style in use, which defaults to
5968     *         "default". If the object does not have a tooltip set,
5969     *         then @c NULL is returned.
5970     *
5971     * @see elm_gengrid_item_tooltip_style_set() for more details
5972     *
5973     * @ingroup Gengrid
5974     */
5975    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5976    /**
5977     * @brief Disable size restrictions on an object's tooltip
5978     * @param item The tooltip's anchor object
5979     * @param disable If EINA_TRUE, size restrictions are disabled
5980     * @return EINA_FALSE on failure, EINA_TRUE on success
5981     *
5982     * This function allows a tooltip to expand beyond its parant window's canvas.
5983     * It will instead be limited only by the size of the display.
5984     */
5985    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
5986    /**
5987     * @brief Retrieve size restriction state of an object's tooltip
5988     * @param item The tooltip's anchor object
5989     * @return If EINA_TRUE, size restrictions are disabled
5990     *
5991     * This function returns whether a tooltip is allowed to expand beyond
5992     * its parant window's canvas.
5993     * It will instead be limited only by the size of the display.
5994     */
5995    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
5996    /**
5997     * Set the type of mouse pointer/cursor decoration to be shown,
5998     * when the mouse pointer is over the given gengrid widget item
5999     *
6000     * @param item gengrid item to customize cursor on
6001     * @param cursor the cursor type's name
6002     *
6003     * This function works analogously as elm_object_cursor_set(), but
6004     * here the cursor's changing area is restricted to the item's
6005     * area, and not the whole widget's. Note that that item cursors
6006     * have precedence over widget cursors, so that a mouse over @p
6007     * item will always show cursor @p type.
6008     *
6009     * If this function is called twice for an object, a previously set
6010     * cursor will be unset on the second call.
6011     *
6012     * @see elm_object_cursor_set()
6013     * @see elm_gengrid_item_cursor_get()
6014     * @see elm_gengrid_item_cursor_unset()
6015     *
6016     * @ingroup Gengrid
6017     */
6018    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6019
6020    /**
6021     * Get the type of mouse pointer/cursor decoration set to be shown,
6022     * when the mouse pointer is over the given gengrid widget item
6023     *
6024     * @param item gengrid item with custom cursor set
6025     * @return the cursor type's name or @c NULL, if no custom cursors
6026     * were set to @p item (and on errors)
6027     *
6028     * @see elm_object_cursor_get()
6029     * @see elm_gengrid_item_cursor_set() for more details
6030     * @see elm_gengrid_item_cursor_unset()
6031     *
6032     * @ingroup Gengrid
6033     */
6034    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6035
6036    /**
6037     * Unset any custom mouse pointer/cursor decoration set to be
6038     * shown, when the mouse pointer is over the given gengrid widget
6039     * item, thus making it show the @b default cursor again.
6040     *
6041     * @param item a gengrid item
6042     *
6043     * Use this call to undo any custom settings on this item's cursor
6044     * decoration, bringing it back to defaults (no custom style set).
6045     *
6046     * @see elm_object_cursor_unset()
6047     * @see elm_gengrid_item_cursor_set() for more details
6048     *
6049     * @ingroup Gengrid
6050     */
6051    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6052
6053    /**
6054     * Set a different @b style for a given custom cursor set for a
6055     * gengrid item.
6056     *
6057     * @param item gengrid item with custom cursor set
6058     * @param style the <b>theme style</b> to use (e.g. @c "default",
6059     * @c "transparent", etc)
6060     *
6061     * This function only makes sense when one is using custom mouse
6062     * cursor decorations <b>defined in a theme file</b> , which can
6063     * have, given a cursor name/type, <b>alternate styles</b> on
6064     * it. It works analogously as elm_object_cursor_style_set(), but
6065     * here applied only to gengrid item objects.
6066     *
6067     * @warning Before you set a cursor style you should have defined a
6068     *       custom cursor previously on the item, with
6069     *       elm_gengrid_item_cursor_set()
6070     *
6071     * @see elm_gengrid_item_cursor_engine_only_set()
6072     * @see elm_gengrid_item_cursor_style_get()
6073     *
6074     * @ingroup Gengrid
6075     */
6076    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6077
6078    /**
6079     * Get the current @b style set for a given gengrid item's custom
6080     * cursor
6081     *
6082     * @param item gengrid item with custom cursor set.
6083     * @return style the cursor style in use. If the object does not
6084     *         have a cursor set, then @c NULL is returned.
6085     *
6086     * @see elm_gengrid_item_cursor_style_set() for more details
6087     *
6088     * @ingroup Gengrid
6089     */
6090    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6091
6092    /**
6093     * Set if the (custom) cursor for a given gengrid item should be
6094     * searched in its theme, also, or should only rely on the
6095     * rendering engine.
6096     *
6097     * @param item item with custom (custom) cursor already set on
6098     * @param engine_only Use @c EINA_TRUE to have cursors looked for
6099     * only on those provided by the rendering engine, @c EINA_FALSE to
6100     * have them searched on the widget's theme, as well.
6101     *
6102     * @note This call is of use only if you've set a custom cursor
6103     * for gengrid items, with elm_gengrid_item_cursor_set().
6104     *
6105     * @note By default, cursors will only be looked for between those
6106     * provided by the rendering engine.
6107     *
6108     * @ingroup Gengrid
6109     */
6110    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6111
6112    /**
6113     * Get if the (custom) cursor for a given gengrid item is being
6114     * searched in its theme, also, or is only relying on the rendering
6115     * engine.
6116     *
6117     * @param item a gengrid item
6118     * @return @c EINA_TRUE, if cursors are being looked for only on
6119     * those provided by the rendering engine, @c EINA_FALSE if they
6120     * are being searched on the widget's theme, as well.
6121     *
6122     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6123     *
6124     * @ingroup Gengrid
6125     */
6126    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6127
6128    /**
6129     * Remove all items from a given gengrid widget
6130     *
6131     * @param obj The gengrid object.
6132     *
6133     * This removes (and deletes) all items in @p obj, leaving it
6134     * empty.
6135     *
6136     * @see elm_gengrid_item_del(), to remove just one item.
6137     *
6138     * @ingroup Gengrid
6139     */
6140    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6141
6142    /**
6143     * Get the selected item in a given gengrid widget
6144     *
6145     * @param obj The gengrid object.
6146     * @return The selected item's handleor @c NULL, if none is
6147     * selected at the moment (and on errors)
6148     *
6149     * This returns the selected item in @p obj. If multi selection is
6150     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6151     * the first item in the list is selected, which might not be very
6152     * useful. For that case, see elm_gengrid_selected_items_get().
6153     *
6154     * @ingroup Gengrid
6155     */
6156    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6157
6158    /**
6159     * Get <b>a list</b> of selected items in a given gengrid
6160     *
6161     * @param obj The gengrid object.
6162     * @return The list of selected items or @c NULL, if none is
6163     * selected at the moment (and on errors)
6164     *
6165     * This returns a list of the selected items, in the order that
6166     * they appear in the grid. This list is only valid as long as no
6167     * more items are selected or unselected (or unselected implictly
6168     * by deletion). The list contains #Elm_Gengrid_Item pointers as
6169     * data, naturally.
6170     *
6171     * @see elm_gengrid_selected_item_get()
6172     *
6173     * @ingroup Gengrid
6174     */
6175    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6176
6177    /**
6178     * @}
6179     */
6180
6181    /**
6182     * @defgroup Clock Clock
6183     *
6184     * @image html img/widget/clock/preview-00.png
6185     * @image latex img/widget/clock/preview-00.eps
6186     *
6187     * This is a @b digital clock widget. In its default theme, it has a
6188     * vintage "flipping numbers clock" appearance, which will animate
6189     * sheets of individual algarisms individually as time goes by.
6190     *
6191     * A newly created clock will fetch system's time (already
6192     * considering local time adjustments) to start with, and will tick
6193     * accondingly. It may or may not show seconds.
6194     *
6195     * Clocks have an @b edition mode. When in it, the sheets will
6196     * display extra arrow indications on the top and bottom and the
6197     * user may click on them to raise or lower the time values. After
6198     * it's told to exit edition mode, it will keep ticking with that
6199     * new time set (it keeps the difference from local time).
6200     *
6201     * Also, when under edition mode, user clicks on the cited arrows
6202     * which are @b held for some time will make the clock to flip the
6203     * sheet, thus editing the time, continuosly and automatically for
6204     * the user. The interval between sheet flips will keep growing in
6205     * time, so that it helps the user to reach a time which is distant
6206     * from the one set.
6207     *
6208     * The time display is, by default, in military mode (24h), but an
6209     * am/pm indicator may be optionally shown, too, when it will
6210     * switch to 12h.
6211     *
6212     * Smart callbacks one can register to:
6213     * - "changed" - the clock's user changed the time
6214     *
6215     * Here is an example on its usage:
6216     * @li @ref clock_example
6217     */
6218
6219    /**
6220     * @addtogroup Clock
6221     * @{
6222     */
6223
6224    /**
6225     * Identifiers for which clock digits should be editable, when a
6226     * clock widget is in edition mode. Values may be ORed together to
6227     * make a mask, naturally.
6228     *
6229     * @see elm_clock_edit_set()
6230     * @see elm_clock_digit_edit_set()
6231     */
6232    typedef enum _Elm_Clock_Digedit
6233      {
6234         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6235         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6236         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
6237         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6238         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
6239         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6240         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
6241         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
6242      } Elm_Clock_Digedit;
6243
6244    /**
6245     * Add a new clock widget to the given parent Elementary
6246     * (container) object
6247     *
6248     * @param parent The parent object
6249     * @return a new clock widget handle or @c NULL, on errors
6250     *
6251     * This function inserts a new clock widget on the canvas.
6252     *
6253     * @ingroup Clock
6254     */
6255    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6256
6257    /**
6258     * Set a clock widget's time, programmatically
6259     *
6260     * @param obj The clock widget object
6261     * @param hrs The hours to set
6262     * @param min The minutes to set
6263     * @param sec The secondes to set
6264     *
6265     * This function updates the time that is showed by the clock
6266     * widget.
6267     *
6268     *  Values @b must be set within the following ranges:
6269     * - 0 - 23, for hours
6270     * - 0 - 59, for minutes
6271     * - 0 - 59, for seconds,
6272     *
6273     * even if the clock is not in "military" mode.
6274     *
6275     * @warning The behavior for values set out of those ranges is @b
6276     * indefined.
6277     *
6278     * @ingroup Clock
6279     */
6280    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
6281
6282    /**
6283     * Get a clock widget's time values
6284     *
6285     * @param obj The clock object
6286     * @param[out] hrs Pointer to the variable to get the hours value
6287     * @param[out] min Pointer to the variable to get the minutes value
6288     * @param[out] sec Pointer to the variable to get the seconds value
6289     *
6290     * This function gets the time set for @p obj, returning
6291     * it on the variables passed as the arguments to function
6292     *
6293     * @note Use @c NULL pointers on the time values you're not
6294     * interested in: they'll be ignored by the function.
6295     *
6296     * @ingroup Clock
6297     */
6298    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
6299
6300    /**
6301     * Set whether a given clock widget is under <b>edition mode</b> or
6302     * under (default) displaying-only mode.
6303     *
6304     * @param obj The clock object
6305     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
6306     * put it back to "displaying only" mode
6307     *
6308     * This function makes a clock's time to be editable or not <b>by
6309     * user interaction</b>. When in edition mode, clocks @b stop
6310     * ticking, until one brings them back to canonical mode. The
6311     * elm_clock_digit_edit_set() function will influence which digits
6312     * of the clock will be editable. By default, all of them will be
6313     * (#ELM_CLOCK_NONE).
6314     *
6315     * @note am/pm sheets, if being shown, will @b always be editable
6316     * under edition mode.
6317     *
6318     * @see elm_clock_edit_get()
6319     *
6320     * @ingroup Clock
6321     */
6322    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
6323
6324    /**
6325     * Retrieve whether a given clock widget is under <b>edition
6326     * mode</b> or under (default) displaying-only mode.
6327     *
6328     * @param obj The clock object
6329     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
6330     * otherwise
6331     *
6332     * This function retrieves whether the clock's time can be edited
6333     * or not by user interaction.
6334     *
6335     * @see elm_clock_edit_set() for more details
6336     *
6337     * @ingroup Clock
6338     */
6339    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6340
6341    /**
6342     * Set what digits of the given clock widget should be editable
6343     * when in edition mode.
6344     *
6345     * @param obj The clock object
6346     * @param digedit Bit mask indicating the digits to be editable
6347     * (values in #Elm_Clock_Digedit).
6348     *
6349     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
6350     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
6351     * EINA_FALSE).
6352     *
6353     * @see elm_clock_digit_edit_get()
6354     *
6355     * @ingroup Clock
6356     */
6357    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
6358
6359    /**
6360     * Retrieve what digits of the given clock widget should be
6361     * editable when in edition mode.
6362     *
6363     * @param obj The clock object
6364     * @return Bit mask indicating the digits to be editable
6365     * (values in #Elm_Clock_Digedit).
6366     *
6367     * @see elm_clock_digit_edit_set() for more details
6368     *
6369     * @ingroup Clock
6370     */
6371    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6372
6373    /**
6374     * Set if the given clock widget must show hours in military or
6375     * am/pm mode
6376     *
6377     * @param obj The clock object
6378     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
6379     * to military mode
6380     *
6381     * This function sets if the clock must show hours in military or
6382     * am/pm mode. In some countries like Brazil the military mode
6383     * (00-24h-format) is used, in opposition to the USA, where the
6384     * am/pm mode is more commonly used.
6385     *
6386     * @see elm_clock_show_am_pm_get()
6387     *
6388     * @ingroup Clock
6389     */
6390    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
6391
6392    /**
6393     * Get if the given clock widget shows hours in military or am/pm
6394     * mode
6395     *
6396     * @param obj The clock object
6397     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
6398     * military
6399     *
6400     * This function gets if the clock shows hours in military or am/pm
6401     * mode.
6402     *
6403     * @see elm_clock_show_am_pm_set() for more details
6404     *
6405     * @ingroup Clock
6406     */
6407    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6408
6409    /**
6410     * Set if the given clock widget must show time with seconds or not
6411     *
6412     * @param obj The clock object
6413     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
6414     *
6415     * This function sets if the given clock must show or not elapsed
6416     * seconds. By default, they are @b not shown.
6417     *
6418     * @see elm_clock_show_seconds_get()
6419     *
6420     * @ingroup Clock
6421     */
6422    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
6423
6424    /**
6425     * Get whether the given clock widget is showing time with seconds
6426     * or not
6427     *
6428     * @param obj The clock object
6429     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
6430     *
6431     * This function gets whether @p obj is showing or not the elapsed
6432     * seconds.
6433     *
6434     * @see elm_clock_show_seconds_set()
6435     *
6436     * @ingroup Clock
6437     */
6438    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6439
6440    /**
6441     * Set the interval on time updates for an user mouse button hold
6442     * on clock widgets' time edition.
6443     *
6444     * @param obj The clock object
6445     * @param interval The (first) interval value in seconds
6446     *
6447     * This interval value is @b decreased while the user holds the
6448     * mouse pointer either incrementing or decrementing a given the
6449     * clock digit's value.
6450     *
6451     * This helps the user to get to a given time distant from the
6452     * current one easier/faster, as it will start to flip quicker and
6453     * quicker on mouse button holds.
6454     *
6455     * The calculation for the next flip interval value, starting from
6456     * the one set with this call, is the previous interval divided by
6457     * 1.05, so it decreases a little bit.
6458     *
6459     * The default starting interval value for automatic flips is
6460     * @b 0.85 seconds.
6461     *
6462     * @see elm_clock_interval_get()
6463     *
6464     * @ingroup Clock
6465     */
6466    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6467
6468    /**
6469     * Get the interval on time updates for an user mouse button hold
6470     * on clock widgets' time edition.
6471     *
6472     * @param obj The clock object
6473     * @return The (first) interval value, in seconds, set on it
6474     *
6475     * @see elm_clock_interval_set() for more details
6476     *
6477     * @ingroup Clock
6478     */
6479    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6480
6481    /**
6482     * @}
6483     */
6484
6485    /**
6486     * @defgroup Layout Layout
6487     *
6488     * @image html img/widget/layout/preview-00.png
6489     * @image latex img/widget/layout/preview-00.eps width=\textwidth
6490     *
6491     * @image html img/layout-predefined.png
6492     * @image latex img/layout-predefined.eps width=\textwidth
6493     *
6494     * This is a container widget that takes a standard Edje design file and
6495     * wraps it very thinly in a widget.
6496     *
6497     * An Edje design (theme) file has a very wide range of possibilities to
6498     * describe the behavior of elements added to the Layout. Check out the Edje
6499     * documentation and the EDC reference to get more information about what can
6500     * be done with Edje.
6501     *
6502     * Just like @ref List, @ref Box, and other container widgets, any
6503     * object added to the Layout will become its child, meaning that it will be
6504     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
6505     *
6506     * The Layout widget can contain as many Contents, Boxes or Tables as
6507     * described in its theme file. For instance, objects can be added to
6508     * different Tables by specifying the respective Table part names. The same
6509     * is valid for Content and Box.
6510     *
6511     * The objects added as child of the Layout will behave as described in the
6512     * part description where they were added. There are 3 possible types of
6513     * parts where a child can be added:
6514     *
6515     * @section secContent Content (SWALLOW part)
6516     *
6517     * Only one object can be added to the @c SWALLOW part (but you still can
6518     * have many @c SWALLOW parts and one object on each of them). Use the @c
6519     * elm_layout_content_* set of functions to set, retrieve and unset objects
6520     * as content of the @c SWALLOW. After being set to this part, the object
6521     * size, position, visibility, clipping and other description properties
6522     * will be totally controled by the description of the given part (inside
6523     * the Edje theme file).
6524     *
6525     * One can use @c evas_object_size_hint_* functions on the child to have some
6526     * kind of control over its behavior, but the resulting behavior will still
6527     * depend heavily on the @c SWALLOW part description.
6528     *
6529     * The Edje theme also can change the part description, based on signals or
6530     * scripts running inside the theme. This change can also be animated. All of
6531     * this will affect the child object set as content accordingly. The object
6532     * size will be changed if the part size is changed, it will animate move if
6533     * the part is moving, and so on.
6534     *
6535     * The following picture demonstrates a Layout widget with a child object
6536     * added to its @c SWALLOW:
6537     *
6538     * @image html layout_swallow.png
6539     * @image latex layout_swallow.png width=\textwidth
6540     *
6541     * @section secBox Box (BOX part)
6542     *
6543     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
6544     * allows one to add objects to the box and have them distributed along its
6545     * area, accordingly to the specified @a layout property (now by @a layout we
6546     * mean the chosen layouting design of the Box, not the Layout widget
6547     * itself).
6548     *
6549     * A similar effect for having a box with its position, size and other things
6550     * controled by the Layout theme would be to create an Elementary @ref Box
6551     * widget and add it as a Content in the @c SWALLOW part.
6552     *
6553     * The main difference of using the Layout Box is that its behavior, the box
6554     * properties like layouting format, padding, align, etc. will be all
6555     * controled by the theme. This means, for example, that a signal could be
6556     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
6557     * handled the signal by changing the box padding, or align, or both. Using
6558     * the Elementary @ref Box widget is not necessarily harder or easier, it
6559     * just depends on the circunstances and requirements.
6560     *
6561     * The Layout Box can be used through the @c elm_layout_box_* set of
6562     * functions.
6563     *
6564     * The following picture demonstrates a Layout widget with many child objects
6565     * added to its @c BOX part:
6566     *
6567     * @image html layout_box.png
6568     * @image latex layout_box.png width=\textwidth
6569     *
6570     * @section secTable Table (TABLE part)
6571     *
6572     * Just like the @ref secBox, the Layout Table is very similar to the
6573     * Elementary @ref Table widget. It allows one to add objects to the Table
6574     * specifying the row and column where the object should be added, and any
6575     * column or row span if necessary.
6576     *
6577     * Again, we could have this design by adding a @ref Table widget to the @c
6578     * SWALLOW part using elm_layout_content_set(). The same difference happens
6579     * here when choosing to use the Layout Table (a @c TABLE part) instead of
6580     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
6581     *
6582     * The Layout Table can be used through the @c elm_layout_table_* set of
6583     * functions.
6584     *
6585     * The following picture demonstrates a Layout widget with many child objects
6586     * added to its @c TABLE part:
6587     *
6588     * @image html layout_table.png
6589     * @image latex layout_table.png width=\textwidth
6590     *
6591     * @section secPredef Predefined Layouts
6592     *
6593     * Another interesting thing about the Layout widget is that it offers some
6594     * predefined themes that come with the default Elementary theme. These
6595     * themes can be set by the call elm_layout_theme_set(), and provide some
6596     * basic functionality depending on the theme used.
6597     *
6598     * Most of them already send some signals, some already provide a toolbar or
6599     * back and next buttons.
6600     *
6601     * These are available predefined theme layouts. All of them have class = @c
6602     * layout, group = @c application, and style = one of the following options:
6603     *
6604     * @li @c toolbar-content - application with toolbar and main content area
6605     * @li @c toolbar-content-back - application with toolbar and main content
6606     * area with a back button and title area
6607     * @li @c toolbar-content-back-next - application with toolbar and main
6608     * content area with a back and next buttons and title area
6609     * @li @c content-back - application with a main content area with a back
6610     * button and title area
6611     * @li @c content-back-next - application with a main content area with a
6612     * back and next buttons and title area
6613     * @li @c toolbar-vbox - application with toolbar and main content area as a
6614     * vertical box
6615     * @li @c toolbar-table - application with toolbar and main content area as a
6616     * table
6617     *
6618     * @section secExamples Examples
6619     *
6620     * Some examples of the Layout widget can be found here:
6621     * @li @ref layout_example_01
6622     * @li @ref layout_example_02
6623     * @li @ref layout_example_03
6624     * @li @ref layout_example_edc
6625     *
6626     */
6627
6628    /**
6629     * Add a new layout to the parent
6630     *
6631     * @param parent The parent object
6632     * @return The new object or NULL if it cannot be created
6633     *
6634     * @see elm_layout_file_set()
6635     * @see elm_layout_theme_set()
6636     *
6637     * @ingroup Layout
6638     */
6639    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6640    /**
6641     * Set the file that will be used as layout
6642     *
6643     * @param obj The layout object
6644     * @param file The path to file (edj) that will be used as layout
6645     * @param group The group that the layout belongs in edje file
6646     *
6647     * @return (1 = success, 0 = error)
6648     *
6649     * @ingroup Layout
6650     */
6651    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
6652    /**
6653     * Set the edje group from the elementary theme that will be used as layout
6654     *
6655     * @param obj The layout object
6656     * @param clas the clas of the group
6657     * @param group the group
6658     * @param style the style to used
6659     *
6660     * @return (1 = success, 0 = error)
6661     *
6662     * @ingroup Layout
6663     */
6664    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
6665    /**
6666     * Set the layout content.
6667     *
6668     * @param obj The layout object
6669     * @param swallow The swallow part name in the edje file
6670     * @param content The child that will be added in this layout object
6671     *
6672     * Once the content object is set, a previously set one will be deleted.
6673     * If you want to keep that old content object, use the
6674     * elm_layout_content_unset() function.
6675     *
6676     * @note In an Edje theme, the part used as a content container is called @c
6677     * SWALLOW. This is why the parameter name is called @p swallow, but it is
6678     * expected to be a part name just like the second parameter of
6679     * elm_layout_box_append().
6680     *
6681     * @see elm_layout_box_append()
6682     * @see elm_layout_content_get()
6683     * @see elm_layout_content_unset()
6684     * @see @ref secBox
6685     *
6686     * @ingroup Layout
6687     */
6688    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
6689    /**
6690     * Get the child object in the given content part.
6691     *
6692     * @param obj The layout object
6693     * @param swallow The SWALLOW part to get its content
6694     *
6695     * @return The swallowed object or NULL if none or an error occurred
6696     *
6697     * @see elm_layout_content_set()
6698     *
6699     * @ingroup Layout
6700     */
6701    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6702    /**
6703     * Unset the layout content.
6704     *
6705     * @param obj The layout object
6706     * @param swallow The swallow part name in the edje file
6707     * @return The content that was being used
6708     *
6709     * Unparent and return the content object which was set for this part.
6710     *
6711     * @see elm_layout_content_set()
6712     *
6713     * @ingroup Layout
6714     */
6715    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6716    /**
6717     * Set the text of the given part
6718     *
6719     * @param obj The layout object
6720     * @param part The TEXT part where to set the text
6721     * @param text The text to set
6722     *
6723     * @ingroup Layout
6724     * @deprecated use elm_object_text_* instead.
6725     */
6726    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
6727    /**
6728     * Get the text set in the given part
6729     *
6730     * @param obj The layout object
6731     * @param part The TEXT part to retrieve the text off
6732     *
6733     * @return The text set in @p part
6734     *
6735     * @ingroup Layout
6736     * @deprecated use elm_object_text_* instead.
6737     */
6738    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
6739    /**
6740     * Append child to layout box part.
6741     *
6742     * @param obj the layout object
6743     * @param part the box part to which the object will be appended.
6744     * @param child the child object to append to box.
6745     *
6746     * Once the object is appended, it will become child of the layout. Its
6747     * lifetime will be bound to the layout, whenever the layout dies the child
6748     * will be deleted automatically. One should use elm_layout_box_remove() to
6749     * make this layout forget about the object.
6750     *
6751     * @see elm_layout_box_prepend()
6752     * @see elm_layout_box_insert_before()
6753     * @see elm_layout_box_insert_at()
6754     * @see elm_layout_box_remove()
6755     *
6756     * @ingroup Layout
6757     */
6758    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
6759    /**
6760     * Prepend child to layout box part.
6761     *
6762     * @param obj the layout object
6763     * @param part the box part to prepend.
6764     * @param child the child object to prepend to box.
6765     *
6766     * Once the object is prepended, it will become child of the layout. Its
6767     * lifetime will be bound to the layout, whenever the layout dies the child
6768     * will be deleted automatically. One should use elm_layout_box_remove() to
6769     * make this layout forget about the object.
6770     *
6771     * @see elm_layout_box_append()
6772     * @see elm_layout_box_insert_before()
6773     * @see elm_layout_box_insert_at()
6774     * @see elm_layout_box_remove()
6775     *
6776     * @ingroup Layout
6777     */
6778    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
6779    /**
6780     * Insert child to layout box part before a reference object.
6781     *
6782     * @param obj the layout object
6783     * @param part the box part to insert.
6784     * @param child the child object to insert into box.
6785     * @param reference another reference object to insert before in box.
6786     *
6787     * Once the object is inserted, it will become child of the layout. Its
6788     * lifetime will be bound to the layout, whenever the layout dies the child
6789     * will be deleted automatically. One should use elm_layout_box_remove() to
6790     * make this layout forget about the object.
6791     *
6792     * @see elm_layout_box_append()
6793     * @see elm_layout_box_prepend()
6794     * @see elm_layout_box_insert_before()
6795     * @see elm_layout_box_remove()
6796     *
6797     * @ingroup Layout
6798     */
6799    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
6800    /**
6801     * Insert child to layout box part at a given position.
6802     *
6803     * @param obj the layout object
6804     * @param part the box part to insert.
6805     * @param child the child object to insert into box.
6806     * @param pos the numeric position >=0 to insert the child.
6807     *
6808     * Once the object is inserted, it will become child of the layout. Its
6809     * lifetime will be bound to the layout, whenever the layout dies the child
6810     * will be deleted automatically. One should use elm_layout_box_remove() to
6811     * make this layout forget about the object.
6812     *
6813     * @see elm_layout_box_append()
6814     * @see elm_layout_box_prepend()
6815     * @see elm_layout_box_insert_before()
6816     * @see elm_layout_box_remove()
6817     *
6818     * @ingroup Layout
6819     */
6820    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
6821    /**
6822     * Remove a child of the given part box.
6823     *
6824     * @param obj The layout object
6825     * @param part The box part name to remove child.
6826     * @param child The object to remove from box.
6827     * @return The object that was being used, or NULL if not found.
6828     *
6829     * The object will be removed from the box part and its lifetime will
6830     * not be handled by the layout anymore. This is equivalent to
6831     * elm_layout_content_unset() for box.
6832     *
6833     * @see elm_layout_box_append()
6834     * @see elm_layout_box_remove_all()
6835     *
6836     * @ingroup Layout
6837     */
6838    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
6839    /**
6840     * Remove all child of the given part box.
6841     *
6842     * @param obj The layout object
6843     * @param part The box part name to remove child.
6844     * @param clear If EINA_TRUE, then all objects will be deleted as
6845     *        well, otherwise they will just be removed and will be
6846     *        dangling on the canvas.
6847     *
6848     * The objects will be removed from the box part and their lifetime will
6849     * not be handled by the layout anymore. This is equivalent to
6850     * elm_layout_box_remove() for all box children.
6851     *
6852     * @see elm_layout_box_append()
6853     * @see elm_layout_box_remove()
6854     *
6855     * @ingroup Layout
6856     */
6857    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
6858    /**
6859     * Insert child to layout table part.
6860     *
6861     * @param obj the layout object
6862     * @param part the box part to pack child.
6863     * @param child_obj the child object to pack into table.
6864     * @param col the column to which the child should be added. (>= 0)
6865     * @param row the row to which the child should be added. (>= 0)
6866     * @param colspan how many columns should be used to store this object. (>=
6867     *        1)
6868     * @param rowspan how many rows should be used to store this object. (>= 1)
6869     *
6870     * Once the object is inserted, it will become child of the table. Its
6871     * lifetime will be bound to the layout, and whenever the layout dies the
6872     * child will be deleted automatically. One should use
6873     * elm_layout_table_remove() to make this layout forget about the object.
6874     *
6875     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
6876     * more space than a single cell. For instance, the following code:
6877     * @code
6878     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
6879     * @endcode
6880     *
6881     * Would result in an object being added like the following picture:
6882     *
6883     * @image html layout_colspan.png
6884     * @image latex layout_colspan.eps width=\textwidth
6885     *
6886     * @see elm_layout_table_unpack()
6887     * @see elm_layout_table_clear()
6888     *
6889     * @ingroup Layout
6890     */
6891    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);
6892    /**
6893     * Unpack (remove) a child of the given part table.
6894     *
6895     * @param obj The layout object
6896     * @param part The table part name to remove child.
6897     * @param child_obj The object to remove from table.
6898     * @return The object that was being used, or NULL if not found.
6899     *
6900     * The object will be unpacked from the table part and its lifetime
6901     * will not be handled by the layout anymore. This is equivalent to
6902     * elm_layout_content_unset() for table.
6903     *
6904     * @see elm_layout_table_pack()
6905     * @see elm_layout_table_clear()
6906     *
6907     * @ingroup Layout
6908     */
6909    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
6910    /**
6911     * Remove all child of the given part table.
6912     *
6913     * @param obj The layout object
6914     * @param part The table part name to remove child.
6915     * @param clear If EINA_TRUE, then all objects will be deleted as
6916     *        well, otherwise they will just be removed and will be
6917     *        dangling on the canvas.
6918     *
6919     * The objects will be removed from the table part and their lifetime will
6920     * not be handled by the layout anymore. This is equivalent to
6921     * elm_layout_table_unpack() for all table children.
6922     *
6923     * @see elm_layout_table_pack()
6924     * @see elm_layout_table_unpack()
6925     *
6926     * @ingroup Layout
6927     */
6928    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
6929    /**
6930     * Get the edje layout
6931     *
6932     * @param obj The layout object
6933     *
6934     * @return A Evas_Object with the edje layout settings loaded
6935     * with function elm_layout_file_set
6936     *
6937     * This returns the edje object. It is not expected to be used to then
6938     * swallow objects via edje_object_part_swallow() for example. Use
6939     * elm_layout_content_set() instead so child object handling and sizing is
6940     * done properly.
6941     *
6942     * @note This function should only be used if you really need to call some
6943     * low level Edje function on this edje object. All the common stuff (setting
6944     * text, emitting signals, hooking callbacks to signals, etc.) can be done
6945     * with proper elementary functions.
6946     *
6947     * @see elm_object_signal_callback_add()
6948     * @see elm_object_signal_emit()
6949     * @see elm_object_text_part_set()
6950     * @see elm_layout_content_set()
6951     * @see elm_layout_box_append()
6952     * @see elm_layout_table_pack()
6953     * @see elm_layout_data_get()
6954     *
6955     * @ingroup Layout
6956     */
6957    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6958    /**
6959     * Get the edje data from the given layout
6960     *
6961     * @param obj The layout object
6962     * @param key The data key
6963     *
6964     * @return The edje data string
6965     *
6966     * This function fetches data specified inside the edje theme of this layout.
6967     * This function return NULL if data is not found.
6968     *
6969     * In EDC this comes from a data block within the group block that @p
6970     * obj was loaded from. E.g.
6971     *
6972     * @code
6973     * collections {
6974     *   group {
6975     *     name: "a_group";
6976     *     data {
6977     *       item: "key1" "value1";
6978     *       item: "key2" "value2";
6979     *     }
6980     *   }
6981     * }
6982     * @endcode
6983     *
6984     * @ingroup Layout
6985     */
6986    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
6987    /**
6988     * Eval sizing
6989     *
6990     * @param obj The layout object
6991     *
6992     * Manually forces a sizing re-evaluation. This is useful when the minimum
6993     * size required by the edje theme of this layout has changed. The change on
6994     * the minimum size required by the edje theme is not immediately reported to
6995     * the elementary layout, so one needs to call this function in order to tell
6996     * the widget (layout) that it needs to reevaluate its own size.
6997     *
6998     * The minimum size of the theme is calculated based on minimum size of
6999     * parts, the size of elements inside containers like box and table, etc. All
7000     * of this can change due to state changes, and that's when this function
7001     * should be called.
7002     *
7003     * Also note that a standard signal of "size,eval" "elm" emitted from the
7004     * edje object will cause this to happen too.
7005     *
7006     * @ingroup Layout
7007     */
7008    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7009    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7010    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7011    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7012    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7013    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7014    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);
7015    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7016 /**
7017  * @def elm_layout_icon_set
7018  * Convienience macro to set the icon object in a layout that follows the
7019  * Elementary naming convention for its parts.
7020  *
7021  * @ingroup Layout
7022  */
7023 #define elm_layout_icon_set(_ly, _obj) \
7024   do { \
7025     const char *sig; \
7026     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7027     if ((_obj)) sig = "elm,state,icon,visible"; \
7028     else sig = "elm,state,icon,hidden"; \
7029     elm_object_signal_emit((_ly), sig, "elm"); \
7030   } while (0)
7031
7032 /**
7033  * @def elm_layout_icon_get
7034  * Convienience macro to get the icon object from a layout that follows the
7035  * Elementary naming convention for its parts.
7036  *
7037  * @ingroup Layout
7038  */
7039 #define elm_layout_icon_get(_ly) \
7040   elm_layout_content_get((_ly), "elm.swallow.icon")
7041
7042 /**
7043  * @def elm_layout_end_set
7044  * Convienience macro to set the end object in a layout that follows the
7045  * Elementary naming convention for its parts.
7046  *
7047  * @ingroup Layout
7048  */
7049 #define elm_layout_end_set(_ly, _obj) \
7050   do { \
7051     const char *sig; \
7052     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7053     if ((_obj)) sig = "elm,state,end,visible"; \
7054     else sig = "elm,state,end,hidden"; \
7055     elm_object_signal_emit((_ly), sig, "elm"); \
7056   } while (0)
7057
7058 /**
7059  * @def elm_layout_end_get
7060  * Convienience macro to get the end object in a layout that follows the
7061  * Elementary naming convention for its parts.
7062  *
7063  * @ingroup Layout
7064  */
7065 #define elm_layout_end_get(_ly) \
7066   elm_layout_content_get((_ly), "elm.swallow.end")
7067
7068 /**
7069  * @def elm_layout_label_set
7070  * Convienience macro to set the label in a layout that follows the
7071  * Elementary naming convention for its parts.
7072  *
7073  * @ingroup Layout
7074  * @deprecate use elm_object_text_* instead.
7075  */
7076 #define elm_layout_label_set(_ly, _txt) \
7077   elm_layout_text_set((_ly), "elm.text", (_txt))
7078
7079 /**
7080  * @def elm_layout_label_get
7081  * Convienience macro to get the label in a layout that follows the
7082  * Elementary naming convention for its parts.
7083  *
7084  * @ingroup Layout
7085  * @deprecate use elm_object_text_* instead.
7086  */
7087 #define elm_layout_label_get(_ly) \
7088   elm_layout_text_get((_ly), "elm.text")
7089
7090    /* smart callbacks called:
7091     * "theme,changed" - when elm theme is changed.
7092     */
7093
7094    /**
7095     * @defgroup Notify Notify
7096     *
7097     * @image html img/widget/notify/preview-00.png
7098     * @image latex img/widget/notify/preview-00.eps
7099     *
7100     * Display a container in a particular region of the parent(top, bottom,
7101     * etc.  A timeout can be set to automatically hide the notify. This is so
7102     * that, after an evas_object_show() on a notify object, if a timeout was set
7103     * on it, it will @b automatically get hidden after that time.
7104     *
7105     * Signals that you can add callbacks for are:
7106     * @li "timeout" - when timeout happens on notify and it's hidden
7107     * @li "block,clicked" - when a click outside of the notify happens
7108     *
7109     * @ref tutorial_notify show usage of the API.
7110     *
7111     * @{
7112     */
7113    /**
7114     * @brief Possible orient values for notify.
7115     *
7116     * This values should be used in conjunction to elm_notify_orient_set() to
7117     * set the position in which the notify should appear(relative to its parent)
7118     * and in conjunction with elm_notify_orient_get() to know where the notify
7119     * is appearing.
7120     */
7121    typedef enum _Elm_Notify_Orient
7122      {
7123         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7124         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7125         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7126         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7127         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7128         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7129         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7130         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7131         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7132         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7133      } Elm_Notify_Orient;
7134    /**
7135     * @brief Add a new notify to the parent
7136     *
7137     * @param parent The parent object
7138     * @return The new object or NULL if it cannot be created
7139     */
7140    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7141    /**
7142     * @brief Set the content of the notify widget
7143     *
7144     * @param obj The notify object
7145     * @param content The content will be filled in this notify object
7146     *
7147     * Once the content object is set, a previously set one will be deleted. If
7148     * you want to keep that old content object, use the
7149     * elm_notify_content_unset() function.
7150     */
7151    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7152    /**
7153     * @brief Unset the content of the notify widget
7154     *
7155     * @param obj The notify object
7156     * @return The content that was being used
7157     *
7158     * Unparent and return the content object which was set for this widget
7159     *
7160     * @see elm_notify_content_set()
7161     */
7162    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7163    /**
7164     * @brief Return the content of the notify widget
7165     *
7166     * @param obj The notify object
7167     * @return The content that is being used
7168     *
7169     * @see elm_notify_content_set()
7170     */
7171    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7172    /**
7173     * @brief Set the notify parent
7174     *
7175     * @param obj The notify object
7176     * @param content The new parent
7177     *
7178     * Once the parent object is set, a previously set one will be disconnected
7179     * and replaced.
7180     */
7181    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7182    /**
7183     * @brief Get the notify parent
7184     *
7185     * @param obj The notify object
7186     * @return The parent
7187     *
7188     * @see elm_notify_parent_set()
7189     */
7190    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7191    /**
7192     * @brief Set the orientation
7193     *
7194     * @param obj The notify object
7195     * @param orient The new orientation
7196     *
7197     * Sets the position in which the notify will appear in its parent.
7198     *
7199     * @see @ref Elm_Notify_Orient for possible values.
7200     */
7201    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7202    /**
7203     * @brief Return the orientation
7204     * @param obj The notify object
7205     * @return The orientation of the notification
7206     *
7207     * @see elm_notify_orient_set()
7208     * @see Elm_Notify_Orient
7209     */
7210    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7211    /**
7212     * @brief Set the time interval after which the notify window is going to be
7213     * hidden.
7214     *
7215     * @param obj The notify object
7216     * @param time The timeout in seconds
7217     *
7218     * This function sets a timeout and starts the timer controlling when the
7219     * notify is hidden. Since calling evas_object_show() on a notify restarts
7220     * the timer controlling when the notify is hidden, setting this before the
7221     * notify is shown will in effect mean starting the timer when the notify is
7222     * shown.
7223     *
7224     * @note Set a value <= 0.0 to disable a running timer.
7225     *
7226     * @note If the value > 0.0 and the notify is previously visible, the
7227     * timer will be started with this value, canceling any running timer.
7228     */
7229    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7230    /**
7231     * @brief Return the timeout value (in seconds)
7232     * @param obj the notify object
7233     *
7234     * @see elm_notify_timeout_set()
7235     */
7236    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7237    /**
7238     * @brief Sets whether events should be passed to by a click outside
7239     * its area.
7240     *
7241     * @param obj The notify object
7242     * @param repeats EINA_TRUE Events are repeats, else no
7243     *
7244     * When true if the user clicks outside the window the events will be caught
7245     * by the others widgets, else the events are blocked.
7246     *
7247     * @note The default value is EINA_TRUE.
7248     */
7249    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
7250    /**
7251     * @brief Return true if events are repeat below the notify object
7252     * @param obj the notify object
7253     *
7254     * @see elm_notify_repeat_events_set()
7255     */
7256    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7257    /**
7258     * @}
7259     */
7260
7261    /**
7262     * @defgroup Hover Hover
7263     *
7264     * @image html img/widget/hover/preview-00.png
7265     * @image latex img/widget/hover/preview-00.eps
7266     *
7267     * A Hover object will hover over its @p parent object at the @p target
7268     * location. Anything in the background will be given a darker coloring to
7269     * indicate that the hover object is on top (at the default theme). When the
7270     * hover is clicked it is dismissed(hidden), if the contents of the hover are
7271     * clicked that @b doesn't cause the hover to be dismissed.
7272     *
7273     * @note The hover object will take up the entire space of @p target
7274     * object.
7275     *
7276     * Elementary has the following styles for the hover widget:
7277     * @li default
7278     * @li popout
7279     * @li menu
7280     * @li hoversel_vertical
7281     *
7282     * The following are the available position for content:
7283     * @li left
7284     * @li top-left
7285     * @li top
7286     * @li top-right
7287     * @li right
7288     * @li bottom-right
7289     * @li bottom
7290     * @li bottom-left
7291     * @li middle
7292     * @li smart
7293     *
7294     * Signals that you can add callbacks for are:
7295     * @li "clicked" - the user clicked the empty space in the hover to dismiss
7296     * @li "smart,changed" - a content object placed under the "smart"
7297     *                   policy was replaced to a new slot direction.
7298     *
7299     * See @ref tutorial_hover for more information.
7300     *
7301     * @{
7302     */
7303    typedef enum _Elm_Hover_Axis
7304      {
7305         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
7306         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
7307         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
7308         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
7309      } Elm_Hover_Axis;
7310    /**
7311     * @brief Adds a hover object to @p parent
7312     *
7313     * @param parent The parent object
7314     * @return The hover object or NULL if one could not be created
7315     */
7316    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7317    /**
7318     * @brief Sets the target object for the hover.
7319     *
7320     * @param obj The hover object
7321     * @param target The object to center the hover onto. The hover
7322     *
7323     * This function will cause the hover to be centered on the target object.
7324     */
7325    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
7326    /**
7327     * @brief Gets the target object for the hover.
7328     *
7329     * @param obj The hover object
7330     * @param parent The object to locate the hover over.
7331     *
7332     * @see elm_hover_target_set()
7333     */
7334    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7335    /**
7336     * @brief Sets the parent object for the hover.
7337     *
7338     * @param obj The hover object
7339     * @param parent The object to locate the hover over.
7340     *
7341     * This function will cause the hover to take up the entire space that the
7342     * parent object fills.
7343     */
7344    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7345    /**
7346     * @brief Gets the parent object for the hover.
7347     *
7348     * @param obj The hover object
7349     * @return The parent object to locate the hover over.
7350     *
7351     * @see elm_hover_parent_set()
7352     */
7353    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7354    /**
7355     * @brief Sets the content of the hover object and the direction in which it
7356     * will pop out.
7357     *
7358     * @param obj The hover object
7359     * @param swallow The direction that the object will be displayed
7360     * at. Accepted values are "left", "top-left", "top", "top-right",
7361     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
7362     * "smart".
7363     * @param content The content to place at @p swallow
7364     *
7365     * Once the content object is set for a given direction, a previously
7366     * set one (on the same direction) will be deleted. If you want to
7367     * keep that old content object, use the elm_hover_content_unset()
7368     * function.
7369     *
7370     * All directions may have contents at the same time, except for
7371     * "smart". This is a special placement hint and its use case
7372     * independs of the calculations coming from
7373     * elm_hover_best_content_location_get(). Its use is for cases when
7374     * one desires only one hover content, but with a dinamic special
7375     * placement within the hover area. The content's geometry, whenever
7376     * it changes, will be used to decide on a best location not
7377     * extrapolating the hover's parent object view to show it in (still
7378     * being the hover's target determinant of its medium part -- move and
7379     * resize it to simulate finger sizes, for example). If one of the
7380     * directions other than "smart" are used, a previously content set
7381     * using it will be deleted, and vice-versa.
7382     */
7383    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7384    /**
7385     * @brief Get the content of the hover object, in a given direction.
7386     *
7387     * Return the content object which was set for this widget in the
7388     * @p swallow direction.
7389     *
7390     * @param obj The hover object
7391     * @param swallow The direction that the object was display at.
7392     * @return The content that was being used
7393     *
7394     * @see elm_hover_content_set()
7395     */
7396    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7397    /**
7398     * @brief Unset the content of the hover object, in a given direction.
7399     *
7400     * Unparent and return the content object set at @p swallow direction.
7401     *
7402     * @param obj The hover object
7403     * @param swallow The direction that the object was display at.
7404     * @return The content that was being used.
7405     *
7406     * @see elm_hover_content_set()
7407     */
7408    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7409    /**
7410     * @brief Returns the best swallow location for content in the hover.
7411     *
7412     * @param obj The hover object
7413     * @param pref_axis The preferred orientation axis for the hover object to use
7414     * @return The edje location to place content into the hover or @c
7415     *         NULL, on errors.
7416     *
7417     * Best is defined here as the location at which there is the most available
7418     * space.
7419     *
7420     * @p pref_axis may be one of
7421     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
7422     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
7423     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
7424     * - @c ELM_HOVER_AXIS_BOTH -- both
7425     *
7426     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
7427     * nescessarily be along the horizontal axis("left" or "right"). If
7428     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
7429     * be along the vertical axis("top" or "bottom"). Chossing
7430     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
7431     * returned position may be in either axis.
7432     *
7433     * @see elm_hover_content_set()
7434     */
7435    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
7436    /**
7437     * @}
7438     */
7439
7440    /* entry */
7441    /**
7442     * @defgroup Entry Entry
7443     *
7444     * @image html img/widget/entry/preview-00.png
7445     * @image latex img/widget/entry/preview-00.eps width=\textwidth
7446     * @image html img/widget/entry/preview-01.png
7447     * @image latex img/widget/entry/preview-01.eps width=\textwidth
7448     * @image html img/widget/entry/preview-02.png
7449     * @image latex img/widget/entry/preview-02.eps width=\textwidth
7450     * @image html img/widget/entry/preview-03.png
7451     * @image latex img/widget/entry/preview-03.eps width=\textwidth
7452     *
7453     * An entry is a convenience widget which shows a box that the user can
7454     * enter text into. Entries by default don't scroll, so they grow to
7455     * accomodate the entire text, resizing the parent window as needed. This
7456     * can be changed with the elm_entry_scrollable_set() function.
7457     *
7458     * They can also be single line or multi line (the default) and when set
7459     * to multi line mode they support text wrapping in any of the modes
7460     * indicated by #Elm_Wrap_Type.
7461     *
7462     * Other features include password mode, filtering of inserted text with
7463     * elm_entry_text_filter_append() and related functions, inline "items" and
7464     * formatted markup text.
7465     *
7466     * @section entry-markup Formatted text
7467     *
7468     * The markup tags supported by the Entry are defined by the theme, but
7469     * even when writing new themes or extensions it's a good idea to stick to
7470     * a sane default, to maintain coherency and avoid application breakages.
7471     * Currently defined by the default theme are the following tags:
7472     * @li \<br\>: Inserts a line break.
7473     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
7474     * breaks.
7475     * @li \<tab\>: Inserts a tab.
7476     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
7477     * enclosed text.
7478     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
7479     * @li \<link\>...\</link\>: Underlines the enclosed text.
7480     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
7481     *
7482     * @section entry-special Special markups
7483     *
7484     * Besides those used to format text, entries support two special markup
7485     * tags used to insert clickable portions of text or items inlined within
7486     * the text.
7487     *
7488     * @subsection entry-anchors Anchors
7489     *
7490     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
7491     * \</a\> tags and an event will be generated when this text is clicked,
7492     * like this:
7493     *
7494     * @code
7495     * This text is outside <a href=anc-01>but this one is an anchor</a>
7496     * @endcode
7497     *
7498     * The @c href attribute in the opening tag gives the name that will be
7499     * used to identify the anchor and it can be any valid utf8 string.
7500     *
7501     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
7502     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
7503     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
7504     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
7505     * an anchor.
7506     *
7507     * @subsection entry-items Items
7508     *
7509     * Inlined in the text, any other @c Evas_Object can be inserted by using
7510     * \<item\> tags this way:
7511     *
7512     * @code
7513     * <item size=16x16 vsize=full href=emoticon/haha></item>
7514     * @endcode
7515     *
7516     * Just like with anchors, the @c href identifies each item, but these need,
7517     * in addition, to indicate their size, which is done using any one of
7518     * @c size, @c absize or @c relsize attributes. These attributes take their
7519     * value in the WxH format, where W is the width and H the height of the
7520     * item.
7521     *
7522     * @li absize: Absolute pixel size for the item. Whatever value is set will
7523     * be the item's size regardless of any scale value the object may have
7524     * been set to. The final line height will be adjusted to fit larger items.
7525     * @li size: Similar to @c absize, but it's adjusted to the scale value set
7526     * for the object.
7527     * @li relsize: Size is adjusted for the item to fit within the current
7528     * line height.
7529     *
7530     * Besides their size, items are specificed a @c vsize value that affects
7531     * how their final size and position are calculated. The possible values
7532     * are:
7533     * @li ascent: Item will be placed within the line's baseline and its
7534     * ascent. That is, the height between the line where all characters are
7535     * positioned and the highest point in the line. For @c size and @c absize
7536     * items, the descent value will be added to the total line height to make
7537     * them fit. @c relsize items will be adjusted to fit within this space.
7538     * @li full: Items will be placed between the descent and ascent, or the
7539     * lowest point in the line and its highest.
7540     *
7541     * The next image shows different configurations of items and how they
7542     * are the previously mentioned options affect their sizes. In all cases,
7543     * the green line indicates the ascent, blue for the baseline and red for
7544     * the descent.
7545     *
7546     * @image html entry_item.png
7547     * @image latex entry_item.eps width=\textwidth
7548     *
7549     * And another one to show how size differs from absize. In the first one,
7550     * the scale value is set to 1.0, while the second one is using one of 2.0.
7551     *
7552     * @image html entry_item_scale.png
7553     * @image latex entry_item_scale.eps width=\textwidth
7554     *
7555     * After the size for an item is calculated, the entry will request an
7556     * object to place in its space. For this, the functions set with
7557     * elm_entry_item_provider_append() and related functions will be called
7558     * in order until one of them returns a @c non-NULL value. If no providers
7559     * are available, or all of them return @c NULL, then the entry falls back
7560     * to one of the internal defaults, provided the name matches with one of
7561     * them.
7562     *
7563     * All of the following are currently supported:
7564     *
7565     * - emoticon/angry
7566     * - emoticon/angry-shout
7567     * - emoticon/crazy-laugh
7568     * - emoticon/evil-laugh
7569     * - emoticon/evil
7570     * - emoticon/goggle-smile
7571     * - emoticon/grumpy
7572     * - emoticon/grumpy-smile
7573     * - emoticon/guilty
7574     * - emoticon/guilty-smile
7575     * - emoticon/haha
7576     * - emoticon/half-smile
7577     * - emoticon/happy-panting
7578     * - emoticon/happy
7579     * - emoticon/indifferent
7580     * - emoticon/kiss
7581     * - emoticon/knowing-grin
7582     * - emoticon/laugh
7583     * - emoticon/little-bit-sorry
7584     * - emoticon/love-lots
7585     * - emoticon/love
7586     * - emoticon/minimal-smile
7587     * - emoticon/not-happy
7588     * - emoticon/not-impressed
7589     * - emoticon/omg
7590     * - emoticon/opensmile
7591     * - emoticon/smile
7592     * - emoticon/sorry
7593     * - emoticon/squint-laugh
7594     * - emoticon/surprised
7595     * - emoticon/suspicious
7596     * - emoticon/tongue-dangling
7597     * - emoticon/tongue-poke
7598     * - emoticon/uh
7599     * - emoticon/unhappy
7600     * - emoticon/very-sorry
7601     * - emoticon/what
7602     * - emoticon/wink
7603     * - emoticon/worried
7604     * - emoticon/wtf
7605     *
7606     * Alternatively, an item may reference an image by its path, using
7607     * the URI form @c file:///path/to/an/image.png and the entry will then
7608     * use that image for the item.
7609     *
7610     * @section entry-files Loading and saving files
7611     *
7612     * Entries have convinience functions to load text from a file and save
7613     * changes back to it after a short delay. The automatic saving is enabled
7614     * by default, but can be disabled with elm_entry_autosave_set() and files
7615     * can be loaded directly as plain text or have any markup in them
7616     * recognized. See elm_entry_file_set() for more details.
7617     *
7618     * @section entry-signals Emitted signals
7619     *
7620     * This widget emits the following signals:
7621     *
7622     * @li "changed": The text within the entry was changed.
7623     * @li "activated": The enter key was pressed on a single line entry.
7624     * @li "press": A mouse button has been pressed on the entry.
7625     * @li "longpressed": A mouse button has been pressed and held for a couple
7626     * seconds.
7627     * @li "clicked": The entry has been clicked (mouse press and release).
7628     * @li "clicked,double": The entry has been double clicked.
7629     * @li "clicked,triple": The entry has been triple clicked.
7630     * @li "focused": The entry has received focus.
7631     * @li "unfocused": The entry has lost focus.
7632     * @li "selection,paste": A paste of the clipboard contents was requested.
7633     * @li "selection,copy": A copy of the selected text into the clipboard was
7634     * requested.
7635     * @li "selection,cut": A cut of the selected text into the clipboard was
7636     * requested.
7637     * @li "selection,start": A selection has begun and no previous selection
7638     * existed.
7639     * @li "selection,changed": The current selection has changed.
7640     * @li "selection,cleared": The current selection has been cleared.
7641     * @li "cursor,changed": The cursor has changed position.
7642     * @li "anchor,clicked": An anchor has been clicked. The event_info
7643     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
7644     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
7645     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
7646     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
7647     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
7648     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
7649     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
7650     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
7651     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
7652     * @li "preedit,changed": The preedit string has changed.
7653     *
7654     * @section entry-examples
7655     *
7656     * An overview of the Entry API can be seen in @ref entry_example_01
7657     *
7658     * @{
7659     */
7660    /**
7661     * @typedef Elm_Entry_Anchor_Info
7662     *
7663     * The info sent in the callback for the "anchor,clicked" signals emitted
7664     * by entries.
7665     */
7666    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
7667    /**
7668     * @struct _Elm_Entry_Anchor_Info
7669     *
7670     * The info sent in the callback for the "anchor,clicked" signals emitted
7671     * by entries.
7672     */
7673    struct _Elm_Entry_Anchor_Info
7674      {
7675         const char *name; /**< The name of the anchor, as stated in its href */
7676         int         button; /**< The mouse button used to click on it */
7677         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
7678                     y, /**< Anchor geometry, relative to canvas */
7679                     w, /**< Anchor geometry, relative to canvas */
7680                     h; /**< Anchor geometry, relative to canvas */
7681      };
7682    /**
7683     * @typedef Elm_Entry_Filter_Cb
7684     * This callback type is used by entry filters to modify text.
7685     * @param data The data specified as the last param when adding the filter
7686     * @param entry The entry object
7687     * @param text A pointer to the location of the text being filtered. This data can be modified,
7688     * but any additional allocations must be managed by the user.
7689     * @see elm_entry_text_filter_append
7690     * @see elm_entry_text_filter_prepend
7691     */
7692    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
7693
7694    /**
7695     * This adds an entry to @p parent object.
7696     *
7697     * By default, entries are:
7698     * @li not scrolled
7699     * @li multi-line
7700     * @li word wrapped
7701     * @li autosave is enabled
7702     *
7703     * @param parent The parent object
7704     * @return The new object or NULL if it cannot be created
7705     */
7706    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7707    /**
7708     * Sets the entry to single line mode.
7709     *
7710     * In single line mode, entries don't ever wrap when the text reaches the
7711     * edge, and instead they keep growing horizontally. Pressing the @c Enter
7712     * key will generate an @c "activate" event instead of adding a new line.
7713     *
7714     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
7715     * and pressing enter will break the text into a different line
7716     * without generating any events.
7717     *
7718     * @param obj The entry object
7719     * @param single_line If true, the text in the entry
7720     * will be on a single line.
7721     */
7722    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
7723    /**
7724     * Gets whether the entry is set to be single line.
7725     *
7726     * @param obj The entry object
7727     * @return single_line If true, the text in the entry is set to display
7728     * on a single line.
7729     *
7730     * @see elm_entry_single_line_set()
7731     */
7732    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7733    /**
7734     * Sets the entry to password mode.
7735     *
7736     * In password mode, entries are implicitly single line and the display of
7737     * any text in them is replaced with asterisks (*).
7738     *
7739     * @param obj The entry object
7740     * @param password If true, password mode is enabled.
7741     */
7742    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
7743    /**
7744     * Gets whether the entry is set to password mode.
7745     *
7746     * @param obj The entry object
7747     * @return If true, the entry is set to display all characters
7748     * as asterisks (*).
7749     *
7750     * @see elm_entry_password_set()
7751     */
7752    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7753    /**
7754     * This sets the text displayed within the entry to @p entry.
7755     *
7756     * @param obj The entry object
7757     * @param entry The text to be displayed
7758     *
7759     * @deprecated Use elm_object_text_set() instead.
7760     */
7761    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
7762    /**
7763     * This returns the text currently shown in object @p entry.
7764     * See also elm_entry_entry_set().
7765     *
7766     * @param obj The entry object
7767     * @return The currently displayed text or NULL on failure
7768     *
7769     * @deprecated Use elm_object_text_get() instead.
7770     */
7771    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7772    /**
7773     * Appends @p entry to the text of the entry.
7774     *
7775     * Adds the text in @p entry to the end of any text already present in the
7776     * widget.
7777     *
7778     * The appended text is subject to any filters set for the widget.
7779     *
7780     * @param obj The entry object
7781     * @param entry The text to be displayed
7782     *
7783     * @see elm_entry_text_filter_append()
7784     */
7785    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
7786    /**
7787     * Gets whether the entry is empty.
7788     *
7789     * Empty means no text at all. If there are any markup tags, like an item
7790     * tag for which no provider finds anything, and no text is displayed, this
7791     * function still returns EINA_FALSE.
7792     *
7793     * @param obj The entry object
7794     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
7795     */
7796    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7797    /**
7798     * Gets any selected text within the entry.
7799     *
7800     * If there's any selected text in the entry, this function returns it as
7801     * a string in markup format. NULL is returned if no selection exists or
7802     * if an error occurred.
7803     *
7804     * The returned value points to an internal string and should not be freed
7805     * or modified in any way. If the @p entry object is deleted or its
7806     * contents are changed, the returned pointer should be considered invalid.
7807     *
7808     * @param obj The entry object
7809     * @return The selected text within the entry or NULL on failure
7810     */
7811    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7812    /**
7813     * Inserts the given text into the entry at the current cursor position.
7814     *
7815     * This inserts text at the cursor position as if it was typed
7816     * by the user (note that this also allows markup which a user
7817     * can't just "type" as it would be converted to escaped text, so this
7818     * call can be used to insert things like emoticon items or bold push/pop
7819     * tags, other font and color change tags etc.)
7820     *
7821     * If any selection exists, it will be replaced by the inserted text.
7822     *
7823     * The inserted text is subject to any filters set for the widget.
7824     *
7825     * @param obj The entry object
7826     * @param entry The text to insert
7827     *
7828     * @see elm_entry_text_filter_append()
7829     */
7830    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
7831    /**
7832     * Set the line wrap type to use on multi-line entries.
7833     *
7834     * Sets the wrap type used by the entry to any of the specified in
7835     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
7836     * line (without inserting a line break or paragraph separator) when it
7837     * reaches the far edge of the widget.
7838     *
7839     * Note that this only makes sense for multi-line entries. A widget set
7840     * to be single line will never wrap.
7841     *
7842     * @param obj The entry object
7843     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
7844     */
7845    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7846    /**
7847     * Gets the wrap mode the entry was set to use.
7848     *
7849     * @param obj The entry object
7850     * @return Wrap type
7851     *
7852     * @see also elm_entry_line_wrap_set()
7853     */
7854    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7855    /**
7856     * Sets if the entry is to be editable or not.
7857     *
7858     * By default, entries are editable and when focused, any text input by the
7859     * user will be inserted at the current cursor position. But calling this
7860     * function with @p editable as EINA_FALSE will prevent the user from
7861     * inputting text into the entry.
7862     *
7863     * The only way to change the text of a non-editable entry is to use
7864     * elm_object_text_set(), elm_entry_entry_insert() and other related
7865     * functions.
7866     *
7867     * @param obj The entry object
7868     * @param editable If EINA_TRUE, user input will be inserted in the entry,
7869     * if not, the entry is read-only and no user input is allowed.
7870     */
7871    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
7872    /**
7873     * Gets whether the entry is editable or not.
7874     *
7875     * @param obj The entry object
7876     * @return If true, the entry is editable by the user.
7877     * If false, it is not editable by the user
7878     *
7879     * @see elm_entry_editable_set()
7880     */
7881    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7882    /**
7883     * This drops any existing text selection within the entry.
7884     *
7885     * @param obj The entry object
7886     */
7887    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
7888    /**
7889     * This selects all text within the entry.
7890     *
7891     * @param obj The entry object
7892     */
7893    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
7894    /**
7895     * This moves the cursor one place to the right within the entry.
7896     *
7897     * @param obj The entry object
7898     * @return EINA_TRUE upon success, EINA_FALSE upon failure
7899     */
7900    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
7901    /**
7902     * This moves the cursor one place to the left within the entry.
7903     *
7904     * @param obj The entry object
7905     * @return EINA_TRUE upon success, EINA_FALSE upon failure
7906     */
7907    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
7908    /**
7909     * This moves the cursor one line up within the entry.
7910     *
7911     * @param obj The entry object
7912     * @return EINA_TRUE upon success, EINA_FALSE upon failure
7913     */
7914    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
7915    /**
7916     * This moves the cursor one line down within the entry.
7917     *
7918     * @param obj The entry object
7919     * @return EINA_TRUE upon success, EINA_FALSE upon failure
7920     */
7921    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
7922    /**
7923     * This moves the cursor to the beginning of the entry.
7924     *
7925     * @param obj The entry object
7926     */
7927    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7928    /**
7929     * This moves the cursor to the end of the entry.
7930     *
7931     * @param obj The entry object
7932     */
7933    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7934    /**
7935     * This moves the cursor to the beginning of the current line.
7936     *
7937     * @param obj The entry object
7938     */
7939    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7940    /**
7941     * This moves the cursor to the end of the current line.
7942     *
7943     * @param obj The entry object
7944     */
7945    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7946    /**
7947     * This begins a selection within the entry as though
7948     * the user were holding down the mouse button to make a selection.
7949     *
7950     * @param obj The entry object
7951     */
7952    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
7953    /**
7954     * This ends a selection within the entry as though
7955     * the user had just released the mouse button while making a selection.
7956     *
7957     * @param obj The entry object
7958     */
7959    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
7960    /**
7961     * Gets whether a format node exists at the current cursor position.
7962     *
7963     * A format node is anything that defines how the text is rendered. It can
7964     * be a visible format node, such as a line break or a paragraph separator,
7965     * or an invisible one, such as bold begin or end tag.
7966     * This function returns whether any format node exists at the current
7967     * cursor position.
7968     *
7969     * @param obj The entry object
7970     * @return EINA_TRUE if the current cursor position contains a format node,
7971     * EINA_FALSE otherwise.
7972     *
7973     * @see elm_entry_cursor_is_visible_format_get()
7974     */
7975    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7976    /**
7977     * Gets if the current cursor position holds a visible format node.
7978     *
7979     * @param obj The entry object
7980     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
7981     * if it's an invisible one or no format exists.
7982     *
7983     * @see elm_entry_cursor_is_format_get()
7984     */
7985    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7986    /**
7987     * Gets the character pointed by the cursor at its current position.
7988     *
7989     * This function returns a string with the utf8 character stored at the
7990     * current cursor position.
7991     * Only the text is returned, any format that may exist will not be part
7992     * of the return value.
7993     *
7994     * @param obj The entry object
7995     * @return The text pointed by the cursors.
7996     */
7997    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7998    /**
7999     * This function returns the geometry of the cursor.
8000     *
8001     * It's useful if you want to draw something on the cursor (or where it is),
8002     * or for example in the case of scrolled entry where you want to show the
8003     * cursor.
8004     *
8005     * @param obj The entry object
8006     * @param x returned geometry
8007     * @param y returned geometry
8008     * @param w returned geometry
8009     * @param h returned geometry
8010     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8011     */
8012    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);
8013    /**
8014     * Sets the cursor position in the entry to the given value
8015     *
8016     * The value in @p pos is the index of the character position within the
8017     * contents of the string as returned by elm_entry_cursor_pos_get().
8018     *
8019     * @param obj The entry object
8020     * @param pos The position of the cursor
8021     */
8022    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8023    /**
8024     * Retrieves the current position of the cursor in the entry
8025     *
8026     * @param obj The entry object
8027     * @return The cursor position
8028     */
8029    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8030    /**
8031     * This executes a "cut" action on the selected text in the entry.
8032     *
8033     * @param obj The entry object
8034     */
8035    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8036    /**
8037     * This executes a "copy" action on the selected text in the entry.
8038     *
8039     * @param obj The entry object
8040     */
8041    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8042    /**
8043     * This executes a "paste" action in the entry.
8044     *
8045     * @param obj The entry object
8046     */
8047    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8048    /**
8049     * This clears and frees the items in a entry's contextual (longpress)
8050     * menu.
8051     *
8052     * @param obj The entry object
8053     *
8054     * @see elm_entry_context_menu_item_add()
8055     */
8056    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8057    /**
8058     * This adds an item to the entry's contextual menu.
8059     *
8060     * A longpress on an entry will make the contextual menu show up, if this
8061     * hasn't been disabled with elm_entry_context_menu_disabled_set().
8062     * By default, this menu provides a few options like enabling selection mode,
8063     * which is useful on embedded devices that need to be explicit about it,
8064     * and when a selection exists it also shows the copy and cut actions.
8065     *
8066     * With this function, developers can add other options to this menu to
8067     * perform any action they deem necessary.
8068     *
8069     * @param obj The entry object
8070     * @param label The item's text label
8071     * @param icon_file The item's icon file
8072     * @param icon_type The item's icon type
8073     * @param func The callback to execute when the item is clicked
8074     * @param data The data to associate with the item for related functions
8075     */
8076    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);
8077    /**
8078     * This disables the entry's contextual (longpress) menu.
8079     *
8080     * @param obj The entry object
8081     * @param disabled If true, the menu is disabled
8082     */
8083    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8084    /**
8085     * This returns whether the entry's contextual (longpress) menu is
8086     * disabled.
8087     *
8088     * @param obj The entry object
8089     * @return If true, the menu is disabled
8090     */
8091    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8092    /**
8093     * This appends a custom item provider to the list for that entry
8094     *
8095     * This appends the given callback. The list is walked from beginning to end
8096     * with each function called given the item href string in the text. If the
8097     * function returns an object handle other than NULL (it should create an
8098     * object to do this), then this object is used to replace that item. If
8099     * not the next provider is called until one provides an item object, or the
8100     * default provider in entry does.
8101     *
8102     * @param obj The entry object
8103     * @param func The function called to provide the item object
8104     * @param data The data passed to @p func
8105     *
8106     * @see @ref entry-items
8107     */
8108    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);
8109    /**
8110     * This prepends a custom item provider to the list for that entry
8111     *
8112     * This prepends the given callback. See elm_entry_item_provider_append() for
8113     * more information
8114     *
8115     * @param obj The entry object
8116     * @param func The function called to provide the item object
8117     * @param data The data passed to @p func
8118     */
8119    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);
8120    /**
8121     * This removes a custom item provider to the list for that entry
8122     *
8123     * This removes the given callback. See elm_entry_item_provider_append() for
8124     * more information
8125     *
8126     * @param obj The entry object
8127     * @param func The function called to provide the item object
8128     * @param data The data passed to @p func
8129     */
8130    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);
8131    /**
8132     * Append a filter function for text inserted in the entry
8133     *
8134     * Append the given callback to the list. This functions will be called
8135     * whenever any text is inserted into the entry, with the text to be inserted
8136     * as a parameter. The callback function is free to alter the text in any way
8137     * it wants, but it must remember to free the given pointer and update it.
8138     * If the new text is to be discarded, the function can free it and set its
8139     * text parameter to NULL. This will also prevent any following filters from
8140     * being called.
8141     *
8142     * @param obj The entry object
8143     * @param func The function to use as text filter
8144     * @param data User data to pass to @p func
8145     */
8146    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8147    /**
8148     * Prepend a filter function for text insdrted in the entry
8149     *
8150     * Prepend the given callback to the list. See elm_entry_text_filter_append()
8151     * for more information
8152     *
8153     * @param obj The entry object
8154     * @param func The function to use as text filter
8155     * @param data User data to pass to @p func
8156     */
8157    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8158    /**
8159     * Remove a filter from the list
8160     *
8161     * Removes the given callback from the filter list. See
8162     * elm_entry_text_filter_append() for more information.
8163     *
8164     * @param obj The entry object
8165     * @param func The filter function to remove
8166     * @param data The user data passed when adding the function
8167     */
8168    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8169    /**
8170     * This converts a markup (HTML-like) string into UTF-8.
8171     *
8172     * The returned string is a malloc'ed buffer and it should be freed when
8173     * not needed anymore.
8174     *
8175     * @param s The string (in markup) to be converted
8176     * @return The converted string (in UTF-8). It should be freed.
8177     */
8178    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8179    /**
8180     * This converts a UTF-8 string into markup (HTML-like).
8181     *
8182     * The returned string is a malloc'ed buffer and it should be freed when
8183     * not needed anymore.
8184     *
8185     * @param s The string (in UTF-8) to be converted
8186     * @return The converted string (in markup). It should be freed.
8187     */
8188    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8189    /**
8190     * This sets the file (and implicitly loads it) for the text to display and
8191     * then edit. All changes are written back to the file after a short delay if
8192     * the entry object is set to autosave (which is the default).
8193     *
8194     * If the entry had any other file set previously, any changes made to it
8195     * will be saved if the autosave feature is enabled, otherwise, the file
8196     * will be silently discarded and any non-saved changes will be lost.
8197     *
8198     * @param obj The entry object
8199     * @param file The path to the file to load and save
8200     * @param format The file format
8201     */
8202    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8203    /**
8204     * Gets the file being edited by the entry.
8205     *
8206     * This function can be used to retrieve any file set on the entry for
8207     * edition, along with the format used to load and save it.
8208     *
8209     * @param obj The entry object
8210     * @param file The path to the file to load and save
8211     * @param format The file format
8212     */
8213    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8214    /**
8215     * This function writes any changes made to the file set with
8216     * elm_entry_file_set()
8217     *
8218     * @param obj The entry object
8219     */
8220    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8221    /**
8222     * This sets the entry object to 'autosave' the loaded text file or not.
8223     *
8224     * @param obj The entry object
8225     * @param autosave Autosave the loaded file or not
8226     *
8227     * @see elm_entry_file_set()
8228     */
8229    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8230    /**
8231     * This gets the entry object's 'autosave' status.
8232     *
8233     * @param obj The entry object
8234     * @return Autosave the loaded file or not
8235     *
8236     * @see elm_entry_file_set()
8237     */
8238    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8239    /**
8240     * Control pasting of text and images for the widget.
8241     *
8242     * Normally the entry allows both text and images to be pasted.  By setting
8243     * textonly to be true, this prevents images from being pasted.
8244     *
8245     * Note this only changes the behaviour of text.
8246     *
8247     * @param obj The entry object
8248     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
8249     * text+image+other.
8250     */
8251    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
8252    /**
8253     * Getting elm_entry text paste/drop mode.
8254     *
8255     * In textonly mode, only text may be pasted or dropped into the widget.
8256     *
8257     * @param obj The entry object
8258     * @return If the widget only accepts text from pastes.
8259     */
8260    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8261    /**
8262     * Enable or disable scrolling in entry
8263     *
8264     * Normally the entry is not scrollable unless you enable it with this call.
8265     *
8266     * @param obj The entry object
8267     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
8268     */
8269    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
8270    /**
8271     * Get the scrollable state of the entry
8272     *
8273     * Normally the entry is not scrollable. This gets the scrollable state
8274     * of the entry. See elm_entry_scrollable_set() for more information.
8275     *
8276     * @param obj The entry object
8277     * @return The scrollable state
8278     */
8279    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
8280    /**
8281     * This sets a widget to be displayed to the left of a scrolled entry.
8282     *
8283     * @param obj The scrolled entry object
8284     * @param icon The widget to display on the left side of the scrolled
8285     * entry.
8286     *
8287     * @note A previously set widget will be destroyed.
8288     * @note If the object being set does not have minimum size hints set,
8289     * it won't get properly displayed.
8290     *
8291     * @see elm_entry_end_set()
8292     */
8293    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
8294    /**
8295     * Gets the leftmost widget of the scrolled entry. This object is
8296     * owned by the scrolled entry and should not be modified.
8297     *
8298     * @param obj The scrolled entry object
8299     * @return the left widget inside the scroller
8300     */
8301    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
8302    /**
8303     * Unset the leftmost widget of the scrolled entry, unparenting and
8304     * returning it.
8305     *
8306     * @param obj The scrolled entry object
8307     * @return the previously set icon sub-object of this entry, on
8308     * success.
8309     *
8310     * @see elm_entry_icon_set()
8311     */
8312    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
8313    /**
8314     * Sets the visibility of the left-side widget of the scrolled entry,
8315     * set by @elm_entry_icon_set().
8316     *
8317     * @param obj The scrolled entry object
8318     * @param setting EINA_TRUE if the object should be displayed,
8319     * EINA_FALSE if not.
8320     */
8321    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
8322    /**
8323     * This sets a widget to be displayed to the end of a scrolled entry.
8324     *
8325     * @param obj The scrolled entry object
8326     * @param end The widget to display on the right side of the scrolled
8327     * entry.
8328     *
8329     * @note A previously set widget will be destroyed.
8330     * @note If the object being set does not have minimum size hints set,
8331     * it won't get properly displayed.
8332     *
8333     * @see elm_entry_icon_set
8334     */
8335    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
8336    /**
8337     * Gets the endmost widget of the scrolled entry. This object is owned
8338     * by the scrolled entry and should not be modified.
8339     *
8340     * @param obj The scrolled entry object
8341     * @return the right widget inside the scroller
8342     */
8343    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
8344    /**
8345     * Unset the endmost widget of the scrolled entry, unparenting and
8346     * returning it.
8347     *
8348     * @param obj The scrolled entry object
8349     * @return the previously set icon sub-object of this entry, on
8350     * success.
8351     *
8352     * @see elm_entry_icon_set()
8353     */
8354    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
8355    /**
8356     * Sets the visibility of the end widget of the scrolled entry, set by
8357     * @elm_entry_end_set().
8358     *
8359     * @param obj The scrolled entry object
8360     * @param setting EINA_TRUE if the object should be displayed,
8361     * EINA_FALSE if not.
8362     */
8363    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
8364    /**
8365     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
8366     * them).
8367     *
8368     * Setting an entry to single-line mode with elm_entry_single_line_set()
8369     * will automatically disable the display of scrollbars when the entry
8370     * moves inside its scroller.
8371     *
8372     * @param obj The scrolled entry object
8373     * @param h The horizontal scrollbar policy to apply
8374     * @param v The vertical scrollbar policy to apply
8375     */
8376    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
8377    /**
8378     * This enables/disables bouncing within the entry.
8379     *
8380     * This function sets whether the entry will bounce when scrolling reaches
8381     * the end of the contained entry.
8382     *
8383     * @param obj The scrolled entry object
8384     * @param h The horizontal bounce state
8385     * @param v The vertical bounce state
8386     */
8387    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8388    /**
8389     * Get the bounce mode
8390     *
8391     * @param obj The Entry object
8392     * @param h_bounce Allow bounce horizontally
8393     * @param v_bounce Allow bounce vertically
8394     */
8395    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8396
8397    /* pre-made filters for entries */
8398    /**
8399     * @typedef Elm_Entry_Filter_Limit_Size
8400     *
8401     * Data for the elm_entry_filter_limit_size() entry filter.
8402     */
8403    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
8404    /**
8405     * @struct _Elm_Entry_Filter_Limit_Size
8406     *
8407     * Data for the elm_entry_filter_limit_size() entry filter.
8408     */
8409    struct _Elm_Entry_Filter_Limit_Size
8410      {
8411         int max_char_count; /**< The maximum number of characters allowed. */
8412         int max_byte_count; /**< The maximum number of bytes allowed*/
8413      };
8414    /**
8415     * Filter inserted text based on user defined character and byte limits
8416     *
8417     * Add this filter to an entry to limit the characters that it will accept
8418     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
8419     * The funtion works on the UTF-8 representation of the string, converting
8420     * it from the set markup, thus not accounting for any format in it.
8421     *
8422     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
8423     * it as data when setting the filter. In it, it's possible to set limits
8424     * by character count or bytes (any of them is disabled if 0), and both can
8425     * be set at the same time. In that case, it first checks for characters,
8426     * then bytes.
8427     *
8428     * The function will cut the inserted text in order to allow only the first
8429     * number of characters that are still allowed. The cut is made in
8430     * characters, even when limiting by bytes, in order to always contain
8431     * valid ones and avoid half unicode characters making it in.
8432     *
8433     * This filter, like any others, does not apply when setting the entry text
8434     * directly with elm_object_text_set() (or the deprecated
8435     * elm_entry_entry_set()).
8436     */
8437    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
8438    /**
8439     * @typedef Elm_Entry_Filter_Accept_Set
8440     *
8441     * Data for the elm_entry_filter_accept_set() entry filter.
8442     */
8443    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
8444    /**
8445     * @struct _Elm_Entry_Filter_Accept_Set
8446     *
8447     * Data for the elm_entry_filter_accept_set() entry filter.
8448     */
8449    struct _Elm_Entry_Filter_Accept_Set
8450      {
8451         const char *accepted; /**< Set of characters accepted in the entry. */
8452         const char *rejected; /**< Set of characters rejected from the entry. */
8453      };
8454    /**
8455     * Filter inserted text based on accepted or rejected sets of characters
8456     *
8457     * Add this filter to an entry to restrict the set of accepted characters
8458     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
8459     * This structure contains both accepted and rejected sets, but they are
8460     * mutually exclusive.
8461     *
8462     * The @c accepted set takes preference, so if it is set, the filter will
8463     * only work based on the accepted characters, ignoring anything in the
8464     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
8465     *
8466     * In both cases, the function filters by matching utf8 characters to the
8467     * raw markup text, so it can be used to remove formatting tags.
8468     *
8469     * This filter, like any others, does not apply when setting the entry text
8470     * directly with elm_object_text_set() (or the deprecated
8471     * elm_entry_entry_set()).
8472     */
8473    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
8474    /**
8475     * @}
8476     */
8477
8478    /* composite widgets - these basically put together basic widgets above
8479     * in convenient packages that do more than basic stuff */
8480
8481    /* anchorview */
8482    /**
8483     * @defgroup Anchorview Anchorview
8484     *
8485     * @image html img/widget/anchorview/preview-00.png
8486     * @image latex img/widget/anchorview/preview-00.eps
8487     *
8488     * Anchorview is for displaying text that contains markup with anchors
8489     * like <c>\<a href=1234\>something\</\></c> in it.
8490     *
8491     * Besides being styled differently, the anchorview widget provides the
8492     * necessary functionality so that clicking on these anchors brings up a
8493     * popup with user defined content such as "call", "add to contacts" or
8494     * "open web page". This popup is provided using the @ref Hover widget.
8495     *
8496     * This widget is very similar to @ref Anchorblock, so refer to that
8497     * widget for an example. The only difference Anchorview has is that the
8498     * widget is already provided with scrolling functionality, so if the
8499     * text set to it is too large to fit in the given space, it will scroll,
8500     * whereas the @ref Anchorblock widget will keep growing to ensure all the
8501     * text can be displayed.
8502     *
8503     * This widget emits the following signals:
8504     * @li "anchor,clicked": will be called when an anchor is clicked. The
8505     * @p event_info parameter on the callback will be a pointer of type
8506     * ::Elm_Entry_Anchorview_Info.
8507     *
8508     * See @ref Anchorblock for an example on how to use both of them.
8509     *
8510     * @see Anchorblock
8511     * @see Entry
8512     * @see Hover
8513     *
8514     * @{
8515     */
8516    /**
8517     * @typedef Elm_Entry_Anchorview_Info
8518     *
8519     * The info sent in the callback for "anchor,clicked" signals emitted by
8520     * the Anchorview widget.
8521     */
8522    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
8523    /**
8524     * @struct _Elm_Entry_Anchorview_Info
8525     *
8526     * The info sent in the callback for "anchor,clicked" signals emitted by
8527     * the Anchorview widget.
8528     */
8529    struct _Elm_Entry_Anchorview_Info
8530      {
8531         const char     *name; /**< Name of the anchor, as indicated in its href
8532                                    attribute */
8533         int             button; /**< The mouse button used to click on it */
8534         Evas_Object    *hover; /**< The hover object to use for the popup */
8535         struct {
8536              Evas_Coord    x, y, w, h;
8537         } anchor, /**< Geometry selection of text used as anchor */
8538           hover_parent; /**< Geometry of the object used as parent by the
8539                              hover */
8540         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
8541                                              for content on the left side of
8542                                              the hover. Before calling the
8543                                              callback, the widget will make the
8544                                              necessary calculations to check
8545                                              which sides are fit to be set with
8546                                              content, based on the position the
8547                                              hover is activated and its distance
8548                                              to the edges of its parent object
8549                                              */
8550         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
8551                                               the right side of the hover.
8552                                               See @ref hover_left */
8553         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
8554                                             of the hover. See @ref hover_left */
8555         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
8556                                                below the hover. See @ref
8557                                                hover_left */
8558      };
8559    /**
8560     * Add a new Anchorview object
8561     *
8562     * @param parent The parent object
8563     * @return The new object or NULL if it cannot be created
8564     */
8565    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8566    /**
8567     * Set the text to show in the anchorview
8568     *
8569     * Sets the text of the anchorview to @p text. This text can include markup
8570     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
8571     * text that will be specially styled and react to click events, ended with
8572     * either of \</a\> or \</\>. When clicked, the anchor will emit an
8573     * "anchor,clicked" signal that you can attach a callback to with
8574     * evas_object_smart_callback_add(). The name of the anchor given in the
8575     * event info struct will be the one set in the href attribute, in this
8576     * case, anchorname.
8577     *
8578     * Other markup can be used to style the text in different ways, but it's
8579     * up to the style defined in the theme which tags do what.
8580     * @deprecated use elm_object_text_set() instead.
8581     */
8582    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
8583    /**
8584     * Get the markup text set for the anchorview
8585     *
8586     * Retrieves the text set on the anchorview, with markup tags included.
8587     *
8588     * @param obj The anchorview object
8589     * @return The markup text set or @c NULL if nothing was set or an error
8590     * occurred
8591     * @deprecated use elm_object_text_set() instead.
8592     */
8593    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8594    /**
8595     * Set the parent of the hover popup
8596     *
8597     * Sets the parent object to use by the hover created by the anchorview
8598     * when an anchor is clicked. See @ref Hover for more details on this.
8599     * If no parent is set, the same anchorview object will be used.
8600     *
8601     * @param obj The anchorview object
8602     * @param parent The object to use as parent for the hover
8603     */
8604    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8605    /**
8606     * Get the parent of the hover popup
8607     *
8608     * Get the object used as parent for the hover created by the anchorview
8609     * widget. See @ref Hover for more details on this.
8610     *
8611     * @param obj The anchorview object
8612     * @return The object used as parent for the hover, NULL if none is set.
8613     */
8614    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8615    /**
8616     * Set the style that the hover should use
8617     *
8618     * When creating the popup hover, anchorview will request that it's
8619     * themed according to @p style.
8620     *
8621     * @param obj The anchorview object
8622     * @param style The style to use for the underlying hover
8623     *
8624     * @see elm_object_style_set()
8625     */
8626    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
8627    /**
8628     * Get the style that the hover should use
8629     *
8630     * Get the style the hover created by anchorview will use.
8631     *
8632     * @param obj The anchorview object
8633     * @return The style to use by the hover. NULL means the default is used.
8634     *
8635     * @see elm_object_style_set()
8636     */
8637    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8638    /**
8639     * Ends the hover popup in the anchorview
8640     *
8641     * When an anchor is clicked, the anchorview widget will create a hover
8642     * object to use as a popup with user provided content. This function
8643     * terminates this popup, returning the anchorview to its normal state.
8644     *
8645     * @param obj The anchorview object
8646     */
8647    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8648    /**
8649     * Set bouncing behaviour when the scrolled content reaches an edge
8650     *
8651     * Tell the internal scroller object whether it should bounce or not
8652     * when it reaches the respective edges for each axis.
8653     *
8654     * @param obj The anchorview object
8655     * @param h_bounce Whether to bounce or not in the horizontal axis
8656     * @param v_bounce Whether to bounce or not in the vertical axis
8657     *
8658     * @see elm_scroller_bounce_set()
8659     */
8660    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8661    /**
8662     * Get the set bouncing behaviour of the internal scroller
8663     *
8664     * Get whether the internal scroller should bounce when the edge of each
8665     * axis is reached scrolling.
8666     *
8667     * @param obj The anchorview object
8668     * @param h_bounce Pointer where to store the bounce state of the horizontal
8669     *                 axis
8670     * @param v_bounce Pointer where to store the bounce state of the vertical
8671     *                 axis
8672     *
8673     * @see elm_scroller_bounce_get()
8674     */
8675    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8676    /**
8677     * Appends a custom item provider to the given anchorview
8678     *
8679     * Appends the given function to the list of items providers. This list is
8680     * called, one function at a time, with the given @p data pointer, the
8681     * anchorview object and, in the @p item parameter, the item name as
8682     * referenced in its href string. Following functions in the list will be
8683     * called in order until one of them returns something different to NULL,
8684     * which should be an Evas_Object which will be used in place of the item
8685     * element.
8686     *
8687     * Items in the markup text take the form \<item relsize=16x16 vsize=full
8688     * href=item/name\>\</item\>
8689     *
8690     * @param obj The anchorview object
8691     * @param func The function to add to the list of providers
8692     * @param data User data that will be passed to the callback function
8693     *
8694     * @see elm_entry_item_provider_append()
8695     */
8696    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);
8697    /**
8698     * Prepend a custom item provider to the given anchorview
8699     *
8700     * Like elm_anchorview_item_provider_append(), but it adds the function
8701     * @p func to the beginning of the list, instead of the end.
8702     *
8703     * @param obj The anchorview object
8704     * @param func The function to add to the list of providers
8705     * @param data User data that will be passed to the callback function
8706     */
8707    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);
8708    /**
8709     * Remove a custom item provider from the list of the given anchorview
8710     *
8711     * Removes the function and data pairing that matches @p func and @p data.
8712     * That is, unless the same function and same user data are given, the
8713     * function will not be removed from the list. This allows us to add the
8714     * same callback several times, with different @p data pointers and be
8715     * able to remove them later without conflicts.
8716     *
8717     * @param obj The anchorview object
8718     * @param func The function to remove from the list
8719     * @param data The data matching the function to remove from the list
8720     */
8721    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);
8722    /**
8723     * @}
8724     */
8725
8726    /* anchorblock */
8727    /**
8728     * @defgroup Anchorblock Anchorblock
8729     *
8730     * @image html img/widget/anchorblock/preview-00.png
8731     * @image latex img/widget/anchorblock/preview-00.eps
8732     *
8733     * Anchorblock is for displaying text that contains markup with anchors
8734     * like <c>\<a href=1234\>something\</\></c> in it.
8735     *
8736     * Besides being styled differently, the anchorblock widget provides the
8737     * necessary functionality so that clicking on these anchors brings up a
8738     * popup with user defined content such as "call", "add to contacts" or
8739     * "open web page". This popup is provided using the @ref Hover widget.
8740     *
8741     * This widget emits the following signals:
8742     * @li "anchor,clicked": will be called when an anchor is clicked. The
8743     * @p event_info parameter on the callback will be a pointer of type
8744     * ::Elm_Entry_Anchorblock_Info.
8745     *
8746     * @see Anchorview
8747     * @see Entry
8748     * @see Hover
8749     *
8750     * Since examples are usually better than plain words, we might as well
8751     * try @ref tutorial_anchorblock_example "one".
8752     */
8753    /**
8754     * @addtogroup Anchorblock
8755     * @{
8756     */
8757    /**
8758     * @typedef Elm_Entry_Anchorblock_Info
8759     *
8760     * The info sent in the callback for "anchor,clicked" signals emitted by
8761     * the Anchorblock widget.
8762     */
8763    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
8764    /**
8765     * @struct _Elm_Entry_Anchorblock_Info
8766     *
8767     * The info sent in the callback for "anchor,clicked" signals emitted by
8768     * the Anchorblock widget.
8769     */
8770    struct _Elm_Entry_Anchorblock_Info
8771      {
8772         const char     *name; /**< Name of the anchor, as indicated in its href
8773                                    attribute */
8774         int             button; /**< The mouse button used to click on it */
8775         Evas_Object    *hover; /**< The hover object to use for the popup */
8776         struct {
8777              Evas_Coord    x, y, w, h;
8778         } anchor, /**< Geometry selection of text used as anchor */
8779           hover_parent; /**< Geometry of the object used as parent by the
8780                              hover */
8781         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
8782                                              for content on the left side of
8783                                              the hover. Before calling the
8784                                              callback, the widget will make the
8785                                              necessary calculations to check
8786                                              which sides are fit to be set with
8787                                              content, based on the position the
8788                                              hover is activated and its distance
8789                                              to the edges of its parent object
8790                                              */
8791         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
8792                                               the right side of the hover.
8793                                               See @ref hover_left */
8794         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
8795                                             of the hover. See @ref hover_left */
8796         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
8797                                                below the hover. See @ref
8798                                                hover_left */
8799      };
8800    /**
8801     * Add a new Anchorblock object
8802     *
8803     * @param parent The parent object
8804     * @return The new object or NULL if it cannot be created
8805     */
8806    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8807    /**
8808     * Set the text to show in the anchorblock
8809     *
8810     * Sets the text of the anchorblock to @p text. This text can include markup
8811     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
8812     * of text that will be specially styled and react to click events, ended
8813     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
8814     * "anchor,clicked" signal that you can attach a callback to with
8815     * evas_object_smart_callback_add(). The name of the anchor given in the
8816     * event info struct will be the one set in the href attribute, in this
8817     * case, anchorname.
8818     *
8819     * Other markup can be used to style the text in different ways, but it's
8820     * up to the style defined in the theme which tags do what.
8821     * @deprecated use elm_object_text_set() instead.
8822     */
8823    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
8824    /**
8825     * Get the markup text set for the anchorblock
8826     *
8827     * Retrieves the text set on the anchorblock, with markup tags included.
8828     *
8829     * @param obj The anchorblock object
8830     * @return The markup text set or @c NULL if nothing was set or an error
8831     * occurred
8832     * @deprecated use elm_object_text_set() instead.
8833     */
8834    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8835    /**
8836     * Set the parent of the hover popup
8837     *
8838     * Sets the parent object to use by the hover created by the anchorblock
8839     * when an anchor is clicked. See @ref Hover for more details on this.
8840     *
8841     * @param obj The anchorblock object
8842     * @param parent The object to use as parent for the hover
8843     */
8844    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8845    /**
8846     * Get the parent of the hover popup
8847     *
8848     * Get the object used as parent for the hover created by the anchorblock
8849     * widget. See @ref Hover for more details on this.
8850     * If no parent is set, the same anchorblock object will be used.
8851     *
8852     * @param obj The anchorblock object
8853     * @return The object used as parent for the hover, NULL if none is set.
8854     */
8855    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8856    /**
8857     * Set the style that the hover should use
8858     *
8859     * When creating the popup hover, anchorblock will request that it's
8860     * themed according to @p style.
8861     *
8862     * @param obj The anchorblock object
8863     * @param style The style to use for the underlying hover
8864     *
8865     * @see elm_object_style_set()
8866     */
8867    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
8868    /**
8869     * Get the style that the hover should use
8870     *
8871     * Get the style the hover created by anchorblock will use.
8872     *
8873     * @param obj The anchorblock object
8874     * @return The style to use by the hover. NULL means the default is used.
8875     *
8876     * @see elm_object_style_set()
8877     */
8878    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8879    /**
8880     * Ends the hover popup in the anchorblock
8881     *
8882     * When an anchor is clicked, the anchorblock widget will create a hover
8883     * object to use as a popup with user provided content. This function
8884     * terminates this popup, returning the anchorblock to its normal state.
8885     *
8886     * @param obj The anchorblock object
8887     */
8888    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8889    /**
8890     * Appends a custom item provider to the given anchorblock
8891     *
8892     * Appends the given function to the list of items providers. This list is
8893     * called, one function at a time, with the given @p data pointer, the
8894     * anchorblock object and, in the @p item parameter, the item name as
8895     * referenced in its href string. Following functions in the list will be
8896     * called in order until one of them returns something different to NULL,
8897     * which should be an Evas_Object which will be used in place of the item
8898     * element.
8899     *
8900     * Items in the markup text take the form \<item relsize=16x16 vsize=full
8901     * href=item/name\>\</item\>
8902     *
8903     * @param obj The anchorblock object
8904     * @param func The function to add to the list of providers
8905     * @param data User data that will be passed to the callback function
8906     *
8907     * @see elm_entry_item_provider_append()
8908     */
8909    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);
8910    /**
8911     * Prepend a custom item provider to the given anchorblock
8912     *
8913     * Like elm_anchorblock_item_provider_append(), but it adds the function
8914     * @p func to the beginning of the list, instead of the end.
8915     *
8916     * @param obj The anchorblock object
8917     * @param func The function to add to the list of providers
8918     * @param data User data that will be passed to the callback function
8919     */
8920    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);
8921    /**
8922     * Remove a custom item provider from the list of the given anchorblock
8923     *
8924     * Removes the function and data pairing that matches @p func and @p data.
8925     * That is, unless the same function and same user data are given, the
8926     * function will not be removed from the list. This allows us to add the
8927     * same callback several times, with different @p data pointers and be
8928     * able to remove them later without conflicts.
8929     *
8930     * @param obj The anchorblock object
8931     * @param func The function to remove from the list
8932     * @param data The data matching the function to remove from the list
8933     */
8934    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);
8935    /**
8936     * @}
8937     */
8938
8939    /**
8940     * @defgroup Bubble Bubble
8941     *
8942     * @image html img/widget/bubble/preview-00.png
8943     * @image html img/widget/bubble/preview-01.png
8944     * @image html img/widget/bubble/preview-02.png
8945     *
8946     * @brief The Bubble is a widget to show text similarly to how speech is
8947     * represented in comics.
8948     *
8949     * The bubble widget contains 5 important visual elements:
8950     * @li The frame is a rectangle with rounded rectangles and an "arrow".
8951     * @li The @p icon is an image to which the frame's arrow points to.
8952     * @li The @p label is a text which appears to the right of the icon if the
8953     * corner is "top_left" or "bottom_left" and is right aligned to the frame
8954     * otherwise.
8955     * @li The @p info is a text which appears to the right of the label. Info's
8956     * font is of a ligther color than label.
8957     * @li The @p content is an evas object that is shown inside the frame.
8958     *
8959     * The position of the arrow, icon, label and info depends on which corner is
8960     * selected. The four available corners are:
8961     * @li "top_left" - Default
8962     * @li "top_right"
8963     * @li "bottom_left"
8964     * @li "bottom_right"
8965     *
8966     * Signals that you can add callbacks for are:
8967     * @li "clicked" - This is called when a user has clicked the bubble.
8968     *
8969     * For an example of using a buble see @ref bubble_01_example_page "this".
8970     *
8971     * @{
8972     */
8973    /**
8974     * Add a new bubble to the parent
8975     *
8976     * @param parent The parent object
8977     * @return The new object or NULL if it cannot be created
8978     *
8979     * This function adds a text bubble to the given parent evas object.
8980     */
8981    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8982    /**
8983     * Set the label of the bubble
8984     *
8985     * @param obj The bubble object
8986     * @param label The string to set in the label
8987     *
8988     * This function sets the title of the bubble. Where this appears depends on
8989     * the selected corner.
8990     * @deprecated use elm_object_text_set() instead.
8991     */
8992    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8993    /**
8994     * Get the label of the bubble
8995     *
8996     * @param obj The bubble object
8997     * @return The string of set in the label
8998     *
8999     * This function gets the title of the bubble.
9000     * @deprecated use elm_object_text_set() instead.
9001     */
9002    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9003    /**
9004     * Set the info of the bubble
9005     *
9006     * @param obj The bubble object
9007     * @param info The given info about the bubble
9008     *
9009     * This function sets the info of the bubble. Where this appears depends on
9010     * the selected corner.
9011     * @deprecated use elm_object_text_set() instead.
9012     */
9013    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9014    /**
9015     * Get the info of the bubble
9016     *
9017     * @param obj The bubble object
9018     *
9019     * @return The "info" string of the bubble
9020     *
9021     * This function gets the info text.
9022     * @deprecated use elm_object_text_set() instead.
9023     */
9024    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9025    /**
9026     * Set the content to be shown in the bubble
9027     *
9028     * Once the content object is set, a previously set one will be deleted.
9029     * If you want to keep the old content object, use the
9030     * elm_bubble_content_unset() function.
9031     *
9032     * @param obj The bubble object
9033     * @param content The given content of the bubble
9034     *
9035     * This function sets the content shown on the middle of the bubble.
9036     */
9037    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9038    /**
9039     * Get the content shown in the bubble
9040     *
9041     * Return the content object which is set for this widget.
9042     *
9043     * @param obj The bubble object
9044     * @return The content that is being used
9045     */
9046    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9047    /**
9048     * Unset the content shown in the bubble
9049     *
9050     * Unparent and return the content object which was set for this widget.
9051     *
9052     * @param obj The bubble object
9053     * @return The content that was being used
9054     */
9055    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9056    /**
9057     * Set the icon of the bubble
9058     *
9059     * Once the icon object is set, a previously set one will be deleted.
9060     * If you want to keep the old content object, use the
9061     * elm_icon_content_unset() function.
9062     *
9063     * @param obj The bubble object
9064     * @param icon The given icon for the bubble
9065     */
9066    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9067    /**
9068     * Get the icon of the bubble
9069     *
9070     * @param obj The bubble object
9071     * @return The icon for the bubble
9072     *
9073     * This function gets the icon shown on the top left of bubble.
9074     */
9075    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9076    /**
9077     * Unset the icon of the bubble
9078     *
9079     * Unparent and return the icon object which was set for this widget.
9080     *
9081     * @param obj The bubble object
9082     * @return The icon that was being used
9083     */
9084    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9085    /**
9086     * Set the corner of the bubble
9087     *
9088     * @param obj The bubble object.
9089     * @param corner The given corner for the bubble.
9090     *
9091     * This function sets the corner of the bubble. The corner will be used to
9092     * determine where the arrow in the frame points to and where label, icon and
9093     * info arre shown.
9094     *
9095     * Possible values for corner are:
9096     * @li "top_left" - Default
9097     * @li "top_right"
9098     * @li "bottom_left"
9099     * @li "bottom_right"
9100     */
9101    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9102    /**
9103     * Get the corner of the bubble
9104     *
9105     * @param obj The bubble object.
9106     * @return The given corner for the bubble.
9107     *
9108     * This function gets the selected corner of the bubble.
9109     */
9110    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9111    /**
9112     * @}
9113     */
9114
9115    /* photo */
9116    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9117    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9118    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9119    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9120    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9121    /* smart callbacks called:
9122     * "clicked" - the user clicked the icon
9123     * "drag,start" - Someone started dragging the image out of the object
9124     * "drag,end" - Dragged item was dropped (somewhere)
9125     */
9126
9127    /* gesture layer */
9128    /** @defgroup Elm_Gesture_Layer Gesture Layer */
9129    /**
9130     * @enum _Elm_Gesture_Types
9131     * Enum of supported gesture types.
9132     * @ingroup Elm_Gesture_Layer
9133     */
9134    typedef enum _Elm_Gesture_Types
9135      {
9136         ELM_GESTURE_FIRST = 0,
9137
9138         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9139         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9140         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9141
9142         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9143
9144         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9145         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9146
9147         ELM_GESTURE_ZOOM, /**< Zoom */
9148         ELM_GESTURE_ROTATE, /**< Rotate */
9149
9150         ELM_GESTURE_LAST
9151      } Elm_Gesture_Types;
9152
9153    /**
9154     * @enum _Elm_Gesture_State
9155     * Enum of gesture states.
9156     * @ingroup Elm_Gesture_Layer
9157     */
9158    typedef enum _Elm_Gesture_State
9159      {
9160         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9161         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
9162         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
9163         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
9164         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
9165      } Elm_Gesture_State;
9166
9167    /**
9168     * @struct _Elm_Gesture_Taps_Info
9169     * Struct holds taps info for user
9170     * @ingroup Elm_Gesture_Layer
9171     */
9172    struct _Elm_Gesture_Taps_Info
9173      {
9174         Evas_Coord x, y;         /**< Holds center point between fingers */
9175         unsigned int n;          /**< Number of fingers tapped           */
9176         unsigned int timestamp;  /**< event timestamp       */
9177      };
9178
9179    /**
9180     * @typedef Elm_Gesture_Taps_Info
9181     * holds taps info for user
9182     * @ingroup Elm_Gesture_Layer
9183     */
9184    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
9185
9186    /**
9187     * @struct _Elm_Gesture_Momentum_Info
9188     * Struct holds momentum info for user
9189     * x1 and y1 are not necessarily in sync
9190     * x1 holds x value of x direction starting point
9191     * and same holds for y1.
9192     * This is noticeable when doing V-shape movement
9193     * @ingroup Elm_Gesture_Layer
9194     */
9195    struct _Elm_Gesture_Momentum_Info
9196      {  /* Report line ends, timestamps, and momentum computed        */
9197         Evas_Coord x1; /**< Final-swipe direction starting point on X */
9198         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
9199         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
9200         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
9201
9202         unsigned int tx; /**< Timestamp of start of final x-swipe */
9203         unsigned int ty; /**< Timestamp of start of final y-swipe */
9204
9205         Evas_Coord mx; /**< Momentum on X */
9206         Evas_Coord my; /**< Momentum on Y */
9207      };
9208
9209    /**
9210     * @typedef Elm_Gesture_Momentum_Info
9211     * holds momentum info for user
9212     * @ingroup Elm_Gesture_Layer
9213     */
9214     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
9215
9216    /**
9217     * @struct _Elm_Gesture_Line_Info
9218     * Struct holds line info for user
9219     * @ingroup Elm_Gesture_Layer
9220     */
9221    struct _Elm_Gesture_Line_Info
9222      {  /* Report line ends, timestamps, and momentum computed      */
9223         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
9224         unsigned int n;            /**< Number of fingers (lines)   */
9225         /* FIXME should be radians, bot degrees */
9226         double angle;              /**< Angle (direction) of lines  */
9227      };
9228
9229    /**
9230     * @typedef _Elm_Gesture_Line_Info
9231     * Holds line info for user
9232     * @ingroup Elm_Gesture_Layer
9233     */
9234     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
9235
9236    /**
9237     * @struct _Elm_Gesture_Zoom_Info
9238     * Struct holds zoom info for user
9239     * @ingroup Elm_Gesture_Layer
9240     */
9241    struct _Elm_Gesture_Zoom_Info
9242      {
9243         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
9244         Evas_Coord radius; /**< Holds radius between fingers reported to user */
9245         double zoom;            /**< Zoom value: 1.0 means no zoom             */
9246         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
9247      };
9248
9249    /**
9250     * @typedef Elm_Gesture_Zoom_Info
9251     * Holds zoom info for user
9252     * @ingroup Elm_Gesture_Layer
9253     */
9254    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
9255
9256    /**
9257     * @struct _Elm_Gesture_Rotate_Info
9258     * Struct holds rotation info for user
9259     * @ingroup Elm_Gesture_Layer
9260     */
9261    struct _Elm_Gesture_Rotate_Info
9262      {
9263         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
9264         Evas_Coord radius; /**< Holds radius between fingers reported to user */
9265         double base_angle; /**< Holds start-angle */
9266         double angle;      /**< Rotation value: 0.0 means no rotation         */
9267         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
9268      };
9269
9270    /**
9271     * @typedef Elm_Gesture_Rotate_Info
9272     * Holds rotation info for user
9273     * @ingroup Elm_Gesture_Layer
9274     */
9275    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
9276
9277    /**
9278     * @typedef Elm_Gesture_Event_Cb
9279     * User callback used to stream gesture info from gesture layer
9280     * @param data user data
9281     * @param event_info gesture report info
9282     * Returns a flag field to be applied on the causing event.
9283     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
9284     * upon the event, in an irreversible way.
9285     *
9286     * @ingroup Elm_Gesture_Layer
9287     */
9288    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
9289
9290    /**
9291     * Use function to set callbacks to be notified about
9292     * change of state of gesture.
9293     * When a user registers a callback with this function
9294     * this means this gesture has to be tested.
9295     *
9296     * When ALL callbacks for a gesture are set to NULL
9297     * it means user isn't interested in gesture-state
9298     * and it will not be tested.
9299     *
9300     * @param obj Pointer to gesture-layer.
9301     * @param idx The gesture you would like to track its state.
9302     * @param cb callback function pointer.
9303     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
9304     * @param data user info to be sent to callback (usually, Smart Data)
9305     *
9306     * @ingroup Elm_Gesture_Layer
9307     */
9308    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);
9309
9310    /**
9311     * Call this function to get repeat-events settings.
9312     *
9313     * @param obj Pointer to gesture-layer.
9314     *
9315     * @return repeat events settings.
9316     * @see elm_gesture_layer_hold_events_set()
9317     * @ingroup Elm_Gesture_Layer
9318     */
9319    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
9320
9321    /**
9322     * This function called in order to make gesture-layer repeat events.
9323     * Set this of you like to get the raw events only if gestures were not detected.
9324     * Clear this if you like gesture layer to fwd events as testing gestures.
9325     *
9326     * @param obj Pointer to gesture-layer.
9327     * @param r Repeat: TRUE/FALSE
9328     *
9329     * @ingroup Elm_Gesture_Layer
9330     */
9331    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
9332
9333    /**
9334     * This function sets step-value for zoom action.
9335     * Set step to any positive value.
9336     * Cancel step setting by setting to 0.0
9337     *
9338     * @param obj Pointer to gesture-layer.
9339     * @param s new zoom step value.
9340     *
9341     * @ingroup Elm_Gesture_Layer
9342     */
9343    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
9344
9345    /**
9346     * This function sets step-value for rotate action.
9347     * Set step to any positive value.
9348     * Cancel step setting by setting to 0.0
9349     *
9350     * @param obj Pointer to gesture-layer.
9351     * @param s new roatate step value.
9352     *
9353     * @ingroup Elm_Gesture_Layer
9354     */
9355    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
9356
9357    /**
9358     * This function called to attach gesture-layer to an Evas_Object.
9359     * @param obj Pointer to gesture-layer.
9360     * @param t Pointer to underlying object (AKA Target)
9361     *
9362     * @return TRUE, FALSE on success, failure.
9363     *
9364     * @ingroup Elm_Gesture_Layer
9365     */
9366    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
9367
9368    /**
9369     * Call this function to construct a new gesture-layer object.
9370     * This does not activate the gesture layer. You have to
9371     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
9372     *
9373     * @param parent the parent object.
9374     *
9375     * @return Pointer to new gesture-layer object.
9376     *
9377     * @ingroup Elm_Gesture_Layer
9378     */
9379    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9380
9381    /* thumb */
9382    typedef enum _Elm_Thumb_Animation_Setting
9383      {
9384         ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
9385         ELM_THUMB_ANIMATION_LOOP,      /* Keep playing animation until stop is requested */
9386         ELM_THUMB_ANIMATION_STOP,
9387         ELM_THUMB_ANIMATION_LAST
9388      } Elm_Thumb_Animation_Setting;
9389
9390    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9391    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
9392    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
9393    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
9394    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
9395    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
9396    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9397    EAPI void                        *elm_thumb_ethumb_client_get(void);
9398    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
9399    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9400    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9401    /* available styles:
9402     * default
9403     * noframe
9404     */
9405    /* smart callbacks called:
9406     * "clicked" - This is called when a user has clicked the thumb without dragging around.
9407     * "clicked,double" - This is called when a user has double-clicked the thumb.
9408     * "press" - This is called when a user has pressed down the thumb.
9409     * "generate,start" - The thumbnail generation started.
9410     * "generate,stop" - The generation process stopped.
9411     * "generate,error" - The generation failed.
9412     * "load,error" - The thumbnail image loading failed.
9413     */
9414
9415    /**
9416     * @defgroup Hoversel
9417     *
9418     * @image html img/widget/hoversel/preview-00.png
9419     * @image latex img/widget/hoversel/preview-00.eps
9420     *
9421     * A hoversel is a button that pops up a list of items (automatically
9422     * choosing the direction to display) that have a label and, optionally, an
9423     * icon to select from. It is a convenience widget to avoid the need to do
9424     * all the piecing together yourself. It is intended for a small number of
9425     * items in the hoversel menu (no more than 8), though is capable of many
9426     * more.
9427     *
9428     * Signals that you can add callbacks for are:
9429     * "clicked" - the user clicked the hoversel button and popped up the sel
9430     * "selected" - an item in the hoversel list is selected. event_info is the item
9431     * "dismissed" - the hover is dismissed
9432     *
9433     * See @ref tutorial_hoversel for an example.
9434     * @{
9435     */
9436    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
9437    /**
9438     * @brief Add a new Hoversel object
9439     *
9440     * @param parent The parent object
9441     * @return The new object or NULL if it cannot be created
9442     */
9443    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9444    /**
9445     * @brief This sets the hoversel to expand horizontally.
9446     *
9447     * @param obj The hoversel object
9448     * @param horizontal If true, the hover will expand horizontally to the
9449     * right.
9450     *
9451     * @note The initial button will display horizontally regardless of this
9452     * setting.
9453     */
9454    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
9455    /**
9456     * @brief This returns whether the hoversel is set to expand horizontally.
9457     *
9458     * @param obj The hoversel object
9459     * @return If true, the hover will expand horizontally to the right.
9460     *
9461     * @see elm_hoversel_horizontal_set()
9462     */
9463    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9464    /**
9465     * @brief Set the Hover parent
9466     *
9467     * @param obj The hoversel object
9468     * @param parent The parent to use
9469     *
9470     * Sets the hover parent object, the area that will be darkened when the
9471     * hoversel is clicked. Should probably be the window that the hoversel is
9472     * in. See @ref Hover objects for more information.
9473     */
9474    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9475    /**
9476     * @brief Get the Hover parent
9477     *
9478     * @param obj The hoversel object
9479     * @return The used parent
9480     *
9481     * Gets the hover parent object.
9482     *
9483     * @see elm_hoversel_hover_parent_set()
9484     */
9485    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9486    /**
9487     * @brief Set the hoversel button label
9488     *
9489     * @param obj The hoversel object
9490     * @param label The label text.
9491     *
9492     * This sets the label of the button that is always visible (before it is
9493     * clicked and expanded).
9494     *
9495     * @deprecated elm_object_text_set()
9496     */
9497    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9498    /**
9499     * @brief Get the hoversel button label
9500     *
9501     * @param obj The hoversel object
9502     * @return The label text.
9503     *
9504     * @deprecated elm_object_text_get()
9505     */
9506    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9507    /**
9508     * @brief Set the icon of the hoversel button
9509     *
9510     * @param obj The hoversel object
9511     * @param icon The icon object
9512     *
9513     * Sets the icon of the button that is always visible (before it is clicked
9514     * and expanded).  Once the icon object is set, a previously set one will be
9515     * deleted, if you want to keep that old content object, use the
9516     * elm_hoversel_icon_unset() function.
9517     *
9518     * @see elm_button_icon_set()
9519     */
9520    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9521    /**
9522     * @brief Get the icon of the hoversel button
9523     *
9524     * @param obj The hoversel object
9525     * @return The icon object
9526     *
9527     * Get the icon of the button that is always visible (before it is clicked
9528     * and expanded). Also see elm_button_icon_get().
9529     *
9530     * @see elm_hoversel_icon_set()
9531     */
9532    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9533    /**
9534     * @brief Get and unparent the icon of the hoversel button
9535     *
9536     * @param obj The hoversel object
9537     * @return The icon object that was being used
9538     *
9539     * Unparent and return the icon of the button that is always visible
9540     * (before it is clicked and expanded).
9541     *
9542     * @see elm_hoversel_icon_set()
9543     * @see elm_button_icon_unset()
9544     */
9545    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9546    /**
9547     * @brief This triggers the hoversel popup from code, the same as if the user
9548     * had clicked the button.
9549     *
9550     * @param obj The hoversel object
9551     */
9552    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
9553    /**
9554     * @brief This dismisses the hoversel popup as if the user had clicked
9555     * outside the hover.
9556     *
9557     * @param obj The hoversel object
9558     */
9559    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9560    /**
9561     * @brief Returns whether the hoversel is expanded.
9562     *
9563     * @param obj The hoversel object
9564     * @return  This will return EINA_TRUE if the hoversel is expanded or
9565     * EINA_FALSE if it is not expanded.
9566     */
9567    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9568    /**
9569     * @brief This will remove all the children items from the hoversel.
9570     *
9571     * @param obj The hoversel object
9572     *
9573     * @warning Should @b not be called while the hoversel is active; use
9574     * elm_hoversel_expanded_get() to check first.
9575     *
9576     * @see elm_hoversel_item_del_cb_set()
9577     * @see elm_hoversel_item_del()
9578     */
9579    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9580    /**
9581     * @brief Get the list of items within the given hoversel.
9582     *
9583     * @param obj The hoversel object
9584     * @return Returns a list of Elm_Hoversel_Item*
9585     *
9586     * @see elm_hoversel_item_add()
9587     */
9588    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9589    /**
9590     * @brief Add an item to the hoversel button
9591     *
9592     * @param obj The hoversel object
9593     * @param label The text label to use for the item (NULL if not desired)
9594     * @param icon_file An image file path on disk to use for the icon or standard
9595     * icon name (NULL if not desired)
9596     * @param icon_type The icon type if relevant
9597     * @param func Convenience function to call when this item is selected
9598     * @param data Data to pass to item-related functions
9599     * @return A handle to the item added.
9600     *
9601     * This adds an item to the hoversel to show when it is clicked. Note: if you
9602     * need to use an icon from an edje file then use
9603     * elm_hoversel_item_icon_set() right after the this function, and set
9604     * icon_file to NULL here.
9605     *
9606     * For more information on what @p icon_file and @p icon_type are see the
9607     * @ref Icon "icon documentation".
9608     */
9609    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);
9610    /**
9611     * @brief Delete an item from the hoversel
9612     *
9613     * @param item The item to delete
9614     *
9615     * This deletes the item from the hoversel (should not be called while the
9616     * hoversel is active; use elm_hoversel_expanded_get() to check first).
9617     *
9618     * @see elm_hoversel_item_add()
9619     * @see elm_hoversel_item_del_cb_set()
9620     */
9621    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
9622    /**
9623     * @brief Set the function to be called when an item from the hoversel is
9624     * freed.
9625     *
9626     * @param item The item to set the callback on
9627     * @param func The function called
9628     *
9629     * That function will receive these parameters:
9630     * @li void *item_data
9631     * @li Evas_Object *the_item_object
9632     * @li Elm_Hoversel_Item *the_object_struct
9633     *
9634     * @see elm_hoversel_item_add()
9635     */
9636    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9637    /**
9638     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
9639     * that will be passed to associated function callbacks.
9640     *
9641     * @param item The item to get the data from
9642     * @return The data pointer set with elm_hoversel_item_add()
9643     *
9644     * @see elm_hoversel_item_add()
9645     */
9646    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
9647    /**
9648     * @brief This returns the label text of the given hoversel item.
9649     *
9650     * @param item The item to get the label
9651     * @return The label text of the hoversel item
9652     *
9653     * @see elm_hoversel_item_add()
9654     */
9655    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
9656    /**
9657     * @brief This sets the icon for the given hoversel item.
9658     *
9659     * @param item The item to set the icon
9660     * @param icon_file An image file path on disk to use for the icon or standard
9661     * icon name
9662     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
9663     * to NULL if the icon is not an edje file
9664     * @param icon_type The icon type
9665     *
9666     * The icon can be loaded from the standard set, from an image file, or from
9667     * an edje file.
9668     *
9669     * @see elm_hoversel_item_add()
9670     */
9671    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);
9672    /**
9673     * @brief Get the icon object of the hoversel item
9674     *
9675     * @param item The item to get the icon from
9676     * @param icon_file The image file path on disk used for the icon or standard
9677     * icon name
9678     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
9679     * if the icon is not an edje file
9680     * @param icon_type The icon type
9681     *
9682     * @see elm_hoversel_item_icon_set()
9683     * @see elm_hoversel_item_add()
9684     */
9685    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);
9686    /**
9687     * @}
9688     */
9689
9690    /* toolbar */
9691    typedef enum _Elm_Toolbar_Shrink_Mode
9692      {
9693         ELM_TOOLBAR_SHRINK_NONE,   /**< set toolbar minimun size to fit all the items */
9694         ELM_TOOLBAR_SHRINK_HIDE,   /**< hide excess items */
9695         ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
9696         ELM_TOOLBAR_SHRINK_MENU    /**< inserts a button to pop up a menu with excess items */
9697      } Elm_Toolbar_Shrink_Mode;
9698
9699    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
9700    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
9701
9702    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9703    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
9704    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9705    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
9706    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9707    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
9708    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9709    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);
9710    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);
9711    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);
9712    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);
9713    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9714    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9715    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9716    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9717    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9718    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
9719    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9720    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9721    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9722    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
9723    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9724    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
9725    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9726    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9727    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9728    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9729    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
9730    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9731    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9732    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9733    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9734    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
9735    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9736    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
9737    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9738    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
9739    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9740    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
9741    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9742    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9743    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9744    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
9745    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9746    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
9747    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9748    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);
9749    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
9750    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
9751    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9752    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9753    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9754    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9755    EAPI void                    elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
9756    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);
9757    EAPI void                    elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9758    EAPI void                    elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
9759    EAPI const char             *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9760    EAPI void                    elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9761    EAPI const char             *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9762    EAPI void                    elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9763    EAPI void                    elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
9764    EAPI const char             *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9765    EAPI void                    elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9766    EAPI Eina_Bool               elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9767    /* smart callbacks called:
9768     * "clicked" - when the user clicks on a toolbar item and becomes selected
9769     */
9770    /* available styles:
9771     * default
9772     * transparent (no background or shadow, just show the provided content)
9773     */
9774
9775    /* tooltip */
9776    EAPI double       elm_tooltip_delay_get(void);
9777    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
9778    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
9779    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
9780    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
9781    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);
9782    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9783    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9784    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9785    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
9786    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9787    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9788    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9789    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9790    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9791    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9792    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
9793    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
9794
9795    /* cursors */
9796    EAPI int          elm_cursor_engine_only_get(void);
9797    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
9798
9799    /* menu */
9800    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
9801    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9802    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9803    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9804    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
9805    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
9806    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9807    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9808    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);
9809    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);
9810    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
9811    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9812    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
9813    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9814    EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9815    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9816    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9817    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9818    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9819    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
9820    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9821    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9822    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9823    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9824    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
9825    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9826    EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
9827    EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
9828    EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
9829    EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9830    EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9831
9832    /* smart callbacks called:
9833     * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
9834     */
9835
9836    /**
9837     * @defgroup List List
9838     * @ingroup Elementary
9839     *
9840     * @image html img/widget/list/preview-00.png
9841     * @image latex img/widget/list/preview-00.eps width=\textwidth
9842     *
9843     * @image html img/list.png
9844     * @image latex img/list.eps width=\textwidth
9845     *
9846     * A list widget is a container whose children are displayed vertically or
9847     * horizontally, in order, and can be selected.
9848     * The list can accept only one or multiple items selection. Also has many
9849     * modes of items displaying.
9850     *
9851     * A list is a very simple type of list widget.  For more robust
9852     * lists, @ref Genlist should probably be used.
9853     *
9854     * Smart callbacks one can listen to:
9855     * - @c "activated" - The user has double-clicked or pressed
9856     *   (enter|return|spacebar) on an item. The @c event_info parameter
9857     *   is the item that was activated.
9858     * - @c "clicked,double" - The user has double-clicked an item.
9859     *   The @c event_info parameter is the item that was double-clicked.
9860     * - "selected" - when the user selected an item
9861     * - "unselected" - when the user unselected an item
9862     * - "longpressed" - an item in the list is long-pressed
9863     * - "scroll,edge,top" - the list is scrolled until the top edge
9864     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
9865     * - "scroll,edge,left" - the list is scrolled until the left edge
9866     * - "scroll,edge,right" - the list is scrolled until the right edge
9867     *
9868     * Available styles for it:
9869     * - @c "default"
9870     *
9871     * List of examples:
9872     * @li @ref list_example_01
9873     * @li @ref list_example_02
9874     * @li @ref list_example_03
9875     */
9876
9877    /**
9878     * @addtogroup List
9879     * @{
9880     */
9881
9882    /**
9883     * @enum _Elm_List_Mode
9884     * @typedef Elm_List_Mode
9885     *
9886     * Set list's resize behavior, transverse axis scroll and
9887     * items cropping. See each mode's description for more details.
9888     *
9889     * @note Default value is #ELM_LIST_SCROLL.
9890     *
9891     * Values <b> don't </b> work as bitmaks, only one can be choosen.
9892     *
9893     * @see elm_list_mode_set()
9894     * @see elm_list_mode_get()
9895     *
9896     * @ingroup List
9897     */
9898    typedef enum _Elm_List_Mode
9899      {
9900         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. */
9901         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). */
9902         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. */
9903         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. */
9904         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
9905      } Elm_List_Mode;
9906
9907    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().  */
9908
9909    /**
9910     * Add a new list widget to the given parent Elementary
9911     * (container) object.
9912     *
9913     * @param parent The parent object.
9914     * @return a new list widget handle or @c NULL, on errors.
9915     *
9916     * This function inserts a new list widget on the canvas.
9917     *
9918     * @ingroup List
9919     */
9920    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9921
9922    /**
9923     * Starts the list.
9924     *
9925     * @param obj The list object
9926     *
9927     * @note Call before running show() on the list object.
9928     * @warning If not called, it won't display the list properly.
9929     *
9930     * @code
9931     * li = elm_list_add(win);
9932     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
9933     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
9934     * elm_list_go(li);
9935     * evas_object_show(li);
9936     * @endcode
9937     *
9938     * @ingroup List
9939     */
9940    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
9941
9942    /**
9943     * Enable or disable multiple items selection on the list object.
9944     *
9945     * @param obj The list object
9946     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
9947     * disable it.
9948     *
9949     * Disabled by default. If disabled, the user can select a single item of
9950     * the list each time. Selected items are highlighted on list.
9951     * If enabled, many items can be selected.
9952     *
9953     * If a selected item is selected again, it will be unselected.
9954     *
9955     * @see elm_list_multi_select_get()
9956     *
9957     * @ingroup List
9958     */
9959    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9960
9961    /**
9962     * Get a value whether multiple items selection is enabled or not.
9963     *
9964     * @see elm_list_multi_select_set() for details.
9965     *
9966     * @param obj The list object.
9967     * @return @c EINA_TRUE means multiple items selection is enabled.
9968     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
9969     * @c EINA_FALSE is returned.
9970     *
9971     * @ingroup List
9972     */
9973    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9974
9975    /**
9976     * Set which mode to use for the list object.
9977     *
9978     * @param obj The list object
9979     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
9980     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
9981     *
9982     * Set list's resize behavior, transverse axis scroll and
9983     * items cropping. See each mode's description for more details.
9984     *
9985     * @note Default value is #ELM_LIST_SCROLL.
9986     *
9987     * Only one can be set, if a previous one was set, it will be changed
9988     * by the new mode set. Bitmask won't work as well.
9989     *
9990     * @see elm_list_mode_get()
9991     *
9992     * @ingroup List
9993     */
9994    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
9995
9996    /**
9997     * Get the mode the list is at.
9998     *
9999     * @param obj The list object
10000     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
10001     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
10002     *
10003     * @note see elm_list_mode_set() for more information.
10004     *
10005     * @ingroup List
10006     */
10007    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10008
10009    /**
10010     * Enable or disable horizontal mode on the list object.
10011     *
10012     * @param obj The list object.
10013     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
10014     * disable it, i.e., to enable vertical mode.
10015     *
10016     * @note Vertical mode is set by default.
10017     *
10018     * On horizontal mode items are displayed on list from left to right,
10019     * instead of from top to bottom. Also, the list will scroll horizontally.
10020     * Each item will presents left icon on top and right icon, or end, at
10021     * the bottom.
10022     *
10023     * @see elm_list_horizontal_get()
10024     *
10025     * @ingroup List
10026     */
10027    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10028
10029    /**
10030     * Get a value whether horizontal mode is enabled or not.
10031     *
10032     * @param obj The list object.
10033     * @return @c EINA_TRUE means horizontal mode selection is enabled.
10034     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
10035     * @c EINA_FALSE is returned.
10036     *
10037     * @see elm_list_horizontal_set() for details.
10038     *
10039     * @ingroup List
10040     */
10041    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10042
10043    /**
10044     * Enable or disable always select mode on the list object.
10045     *
10046     * @param obj The list object
10047     * @param always_select @c EINA_TRUE to enable always select mode or
10048     * @c EINA_FALSE to disable it.
10049     *
10050     * @note Always select mode is disabled by default.
10051     *
10052     * Default behavior of list items is to only call its callback function
10053     * the first time it's pressed, i.e., when it is selected. If a selected
10054     * item is pressed again, and multi-select is disabled, it won't call
10055     * this function (if multi-select is enabled it will unselect the item).
10056     *
10057     * If always select is enabled, it will call the callback function
10058     * everytime a item is pressed, so it will call when the item is selected,
10059     * and again when a selected item is pressed.
10060     *
10061     * @see elm_list_always_select_mode_get()
10062     * @see elm_list_multi_select_set()
10063     *
10064     * @ingroup List
10065     */
10066    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
10067
10068    /**
10069     * Get a value whether always select mode is enabled or not, meaning that
10070     * an item will always call its callback function, even if already selected.
10071     *
10072     * @param obj The list object
10073     * @return @c EINA_TRUE means horizontal mode selection is enabled.
10074     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
10075     * @c EINA_FALSE is returned.
10076     *
10077     * @see elm_list_always_select_mode_set() for details.
10078     *
10079     * @ingroup List
10080     */
10081    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10082
10083    /**
10084     * Set bouncing behaviour when the scrolled content reaches an edge.
10085     *
10086     * Tell the internal scroller object whether it should bounce or not
10087     * when it reaches the respective edges for each axis.
10088     *
10089     * @param obj The list object
10090     * @param h_bounce Whether to bounce or not in the horizontal axis.
10091     * @param v_bounce Whether to bounce or not in the vertical axis.
10092     *
10093     * @see elm_scroller_bounce_set()
10094     *
10095     * @ingroup List
10096     */
10097    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
10098
10099    /**
10100     * Get the bouncing behaviour of the internal scroller.
10101     *
10102     * Get whether the internal scroller should bounce when the edge of each
10103     * axis is reached scrolling.
10104     *
10105     * @param obj The list object.
10106     * @param h_bounce Pointer where to store the bounce state of the horizontal
10107     * axis.
10108     * @param v_bounce Pointer where to store the bounce state of the vertical
10109     * axis.
10110     *
10111     * @see elm_scroller_bounce_get()
10112     * @see elm_list_bounce_set()
10113     *
10114     * @ingroup List
10115     */
10116    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
10117
10118    /**
10119     * Set the scrollbar policy.
10120     *
10121     * @param obj The list object
10122     * @param policy_h Horizontal scrollbar policy.
10123     * @param policy_v Vertical scrollbar policy.
10124     *
10125     * This sets the scrollbar visibility policy for the given scroller.
10126     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
10127     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
10128     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
10129     * This applies respectively for the horizontal and vertical scrollbars.
10130     *
10131     * The both are disabled by default, i.e., are set to
10132     * #ELM_SCROLLER_POLICY_OFF.
10133     *
10134     * @ingroup List
10135     */
10136    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
10137
10138    /**
10139     * Get the scrollbar policy.
10140     *
10141     * @see elm_list_scroller_policy_get() for details.
10142     *
10143     * @param obj The list object.
10144     * @param policy_h Pointer where to store horizontal scrollbar policy.
10145     * @param policy_v Pointer where to store vertical scrollbar policy.
10146     *
10147     * @ingroup List
10148     */
10149    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);
10150
10151    /**
10152     * Append a new item to the list object.
10153     *
10154     * @param obj The list object.
10155     * @param label The label of the list item.
10156     * @param icon The icon object to use for the left side of the item. An
10157     * icon can be any Evas object, but usually it is an icon created
10158     * with elm_icon_add().
10159     * @param end The icon object to use for the right side of the item. An
10160     * icon can be any Evas object.
10161     * @param func The function to call when the item is clicked.
10162     * @param data The data to associate with the item for related callbacks.
10163     *
10164     * @return The created item or @c NULL upon failure.
10165     *
10166     * A new item will be created and appended to the list, i.e., will
10167     * be set as @b last item.
10168     *
10169     * Items created with this method can be deleted with
10170     * elm_list_item_del().
10171     *
10172     * Associated @p data can be properly freed when item is deleted if a
10173     * callback function is set with elm_list_item_del_cb_set().
10174     *
10175     * If a function is passed as argument, it will be called everytime this item
10176     * is selected, i.e., the user clicks over an unselected item.
10177     * If always select is enabled it will call this function every time
10178     * user clicks over an item (already selected or not).
10179     * If such function isn't needed, just passing
10180     * @c NULL as @p func is enough. The same should be done for @p data.
10181     *
10182     * Simple example (with no function callback or data associated):
10183     * @code
10184     * li = elm_list_add(win);
10185     * ic = elm_icon_add(win);
10186     * elm_icon_file_set(ic, "path/to/image", NULL);
10187     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
10188     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
10189     * elm_list_go(li);
10190     * evas_object_show(li);
10191     * @endcode
10192     *
10193     * @see elm_list_always_select_mode_set()
10194     * @see elm_list_item_del()
10195     * @see elm_list_item_del_cb_set()
10196     * @see elm_list_clear()
10197     * @see elm_icon_add()
10198     *
10199     * @ingroup List
10200     */
10201    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);
10202
10203    /**
10204     * Prepend a new item to the list object.
10205     *
10206     * @param obj The list object.
10207     * @param label The label of the list item.
10208     * @param icon The icon object to use for the left side of the item. An
10209     * icon can be any Evas object, but usually it is an icon created
10210     * with elm_icon_add().
10211     * @param end The icon object to use for the right side of the item. An
10212     * icon can be any Evas object.
10213     * @param func The function to call when the item is clicked.
10214     * @param data The data to associate with the item for related callbacks.
10215     *
10216     * @return The created item or @c NULL upon failure.
10217     *
10218     * A new item will be created and prepended to the list, i.e., will
10219     * be set as @b first item.
10220     *
10221     * Items created with this method can be deleted with
10222     * elm_list_item_del().
10223     *
10224     * Associated @p data can be properly freed when item is deleted if a
10225     * callback function is set with elm_list_item_del_cb_set().
10226     *
10227     * If a function is passed as argument, it will be called everytime this item
10228     * is selected, i.e., the user clicks over an unselected item.
10229     * If always select is enabled it will call this function every time
10230     * user clicks over an item (already selected or not).
10231     * If such function isn't needed, just passing
10232     * @c NULL as @p func is enough. The same should be done for @p data.
10233     *
10234     * @see elm_list_item_append() for a simple code example.
10235     * @see elm_list_always_select_mode_set()
10236     * @see elm_list_item_del()
10237     * @see elm_list_item_del_cb_set()
10238     * @see elm_list_clear()
10239     * @see elm_icon_add()
10240     *
10241     * @ingroup List
10242     */
10243    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);
10244
10245    /**
10246     * Insert a new item into the list object before item @p before.
10247     *
10248     * @param obj The list object.
10249     * @param before The list item to insert before.
10250     * @param label The label of the list item.
10251     * @param icon The icon object to use for the left side of the item. An
10252     * icon can be any Evas object, but usually it is an icon created
10253     * with elm_icon_add().
10254     * @param end The icon object to use for the right side of the item. An
10255     * icon can be any Evas object.
10256     * @param func The function to call when the item is clicked.
10257     * @param data The data to associate with the item for related callbacks.
10258     *
10259     * @return The created item or @c NULL upon failure.
10260     *
10261     * A new item will be created and added to the list. Its position in
10262     * this list will be just before item @p before.
10263     *
10264     * Items created with this method can be deleted with
10265     * elm_list_item_del().
10266     *
10267     * Associated @p data can be properly freed when item is deleted if a
10268     * callback function is set with elm_list_item_del_cb_set().
10269     *
10270     * If a function is passed as argument, it will be called everytime this item
10271     * is selected, i.e., the user clicks over an unselected item.
10272     * If always select is enabled it will call this function every time
10273     * user clicks over an item (already selected or not).
10274     * If such function isn't needed, just passing
10275     * @c NULL as @p func is enough. The same should be done for @p data.
10276     *
10277     * @see elm_list_item_append() for a simple code example.
10278     * @see elm_list_always_select_mode_set()
10279     * @see elm_list_item_del()
10280     * @see elm_list_item_del_cb_set()
10281     * @see elm_list_clear()
10282     * @see elm_icon_add()
10283     *
10284     * @ingroup List
10285     */
10286    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);
10287
10288    /**
10289     * Insert a new item into the list object after item @p after.
10290     *
10291     * @param obj The list object.
10292     * @param after The list item to insert after.
10293     * @param label The label of the list item.
10294     * @param icon The icon object to use for the left side of the item. An
10295     * icon can be any Evas object, but usually it is an icon created
10296     * with elm_icon_add().
10297     * @param end The icon object to use for the right side of the item. An
10298     * icon can be any Evas object.
10299     * @param func The function to call when the item is clicked.
10300     * @param data The data to associate with the item for related callbacks.
10301     *
10302     * @return The created item or @c NULL upon failure.
10303     *
10304     * A new item will be created and added to the list. Its position in
10305     * this list will be just after item @p after.
10306     *
10307     * Items created with this method can be deleted with
10308     * elm_list_item_del().
10309     *
10310     * Associated @p data can be properly freed when item is deleted if a
10311     * callback function is set with elm_list_item_del_cb_set().
10312     *
10313     * If a function is passed as argument, it will be called everytime this item
10314     * is selected, i.e., the user clicks over an unselected item.
10315     * If always select is enabled it will call this function every time
10316     * user clicks over an item (already selected or not).
10317     * If such function isn't needed, just passing
10318     * @c NULL as @p func is enough. The same should be done for @p data.
10319     *
10320     * @see elm_list_item_append() for a simple code example.
10321     * @see elm_list_always_select_mode_set()
10322     * @see elm_list_item_del()
10323     * @see elm_list_item_del_cb_set()
10324     * @see elm_list_clear()
10325     * @see elm_icon_add()
10326     *
10327     * @ingroup List
10328     */
10329    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);
10330
10331    /**
10332     * Insert a new item into the sorted list object.
10333     *
10334     * @param obj The list object.
10335     * @param label The label of the list item.
10336     * @param icon The icon object to use for the left side of the item. An
10337     * icon can be any Evas object, but usually it is an icon created
10338     * with elm_icon_add().
10339     * @param end The icon object to use for the right side of the item. An
10340     * icon can be any Evas object.
10341     * @param func The function to call when the item is clicked.
10342     * @param data The data to associate with the item for related callbacks.
10343     * @param cmp_func The comparing function to be used to sort list
10344     * items <b>by #Elm_List_Item item handles</b>. This function will
10345     * receive two items and compare them, returning a non-negative integer
10346     * if the second item should be place after the first, or negative value
10347     * if should be placed before.
10348     *
10349     * @return The created item or @c NULL upon failure.
10350     *
10351     * @note This function inserts values into a list object assuming it was
10352     * sorted and the result will be sorted.
10353     *
10354     * A new item will be created and added to the list. Its position in
10355     * this list will be found comparing the new item with previously inserted
10356     * items using function @p cmp_func.
10357     *
10358     * Items created with this method can be deleted with
10359     * elm_list_item_del().
10360     *
10361     * Associated @p data can be properly freed when item is deleted if a
10362     * callback function is set with elm_list_item_del_cb_set().
10363     *
10364     * If a function is passed as argument, it will be called everytime this item
10365     * is selected, i.e., the user clicks over an unselected item.
10366     * If always select is enabled it will call this function every time
10367     * user clicks over an item (already selected or not).
10368     * If such function isn't needed, just passing
10369     * @c NULL as @p func is enough. The same should be done for @p data.
10370     *
10371     * @see elm_list_item_append() for a simple code example.
10372     * @see elm_list_always_select_mode_set()
10373     * @see elm_list_item_del()
10374     * @see elm_list_item_del_cb_set()
10375     * @see elm_list_clear()
10376     * @see elm_icon_add()
10377     *
10378     * @ingroup List
10379     */
10380    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);
10381
10382    /**
10383     * Remove all list's items.
10384     *
10385     * @param obj The list object
10386     *
10387     * @see elm_list_item_del()
10388     * @see elm_list_item_append()
10389     *
10390     * @ingroup List
10391     */
10392    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10393
10394    /**
10395     * Get a list of all the list items.
10396     *
10397     * @param obj The list object
10398     * @return An @c Eina_List of list items, #Elm_List_Item,
10399     * or @c NULL on failure.
10400     *
10401     * @see elm_list_item_append()
10402     * @see elm_list_item_del()
10403     * @see elm_list_clear()
10404     *
10405     * @ingroup List
10406     */
10407    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10408
10409    /**
10410     * Get the selected item.
10411     *
10412     * @param obj The list object.
10413     * @return The selected list item.
10414     *
10415     * The selected item can be unselected with function
10416     * elm_list_item_selected_set().
10417     *
10418     * The selected item always will be highlighted on list.
10419     *
10420     * @see elm_list_selected_items_get()
10421     *
10422     * @ingroup List
10423     */
10424    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10425
10426    /**
10427     * Return a list of the currently selected list items.
10428     *
10429     * @param obj The list object.
10430     * @return An @c Eina_List of list items, #Elm_List_Item,
10431     * or @c NULL on failure.
10432     *
10433     * Multiple items can be selected if multi select is enabled. It can be
10434     * done with elm_list_multi_select_set().
10435     *
10436     * @see elm_list_selected_item_get()
10437     * @see elm_list_multi_select_set()
10438     *
10439     * @ingroup List
10440     */
10441    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10442
10443    /**
10444     * Set the selected state of an item.
10445     *
10446     * @param item The list item
10447     * @param selected The selected state
10448     *
10449     * This sets the selected state of the given item @p it.
10450     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
10451     *
10452     * If a new item is selected the previosly selected will be unselected,
10453     * unless multiple selection is enabled with elm_list_multi_select_set().
10454     * Previoulsy selected item can be get with function
10455     * elm_list_selected_item_get().
10456     *
10457     * Selected items will be highlighted.
10458     *
10459     * @see elm_list_item_selected_get()
10460     * @see elm_list_selected_item_get()
10461     * @see elm_list_multi_select_set()
10462     *
10463     * @ingroup List
10464     */
10465    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
10466
10467    /*
10468     * Get whether the @p item is selected or not.
10469     *
10470     * @param item The list item.
10471     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
10472     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
10473     *
10474     * @see elm_list_selected_item_set() for details.
10475     * @see elm_list_item_selected_get()
10476     *
10477     * @ingroup List
10478     */
10479    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10480
10481    /**
10482     * Set or unset item as a separator.
10483     *
10484     * @param it The list item.
10485     * @param setting @c EINA_TRUE to set item @p it as separator or
10486     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
10487     *
10488     * Items aren't set as separator by default.
10489     *
10490     * If set as separator it will display separator theme, so won't display
10491     * icons or label.
10492     *
10493     * @see elm_list_item_separator_get()
10494     *
10495     * @ingroup List
10496     */
10497    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
10498
10499    /**
10500     * Get a value whether item is a separator or not.
10501     *
10502     * @see elm_list_item_separator_set() for details.
10503     *
10504     * @param it The list item.
10505     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
10506     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
10507     *
10508     * @ingroup List
10509     */
10510    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10511
10512    /**
10513     * Show @p item in the list view.
10514     *
10515     * @param item The list item to be shown.
10516     *
10517     * It won't animate list until item is visible. If such behavior is wanted,
10518     * use elm_list_bring_in() intead.
10519     *
10520     * @ingroup List
10521     */
10522    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
10523
10524    /**
10525     * Bring in the given item to list view.
10526     *
10527     * @param item The item.
10528     *
10529     * This causes list to jump to the given item @p item and show it
10530     * (by scrolling), if it is not fully visible.
10531     *
10532     * This may use animation to do so and take a period of time.
10533     *
10534     * If animation isn't wanted, elm_list_item_show() can be used.
10535     *
10536     * @ingroup List
10537     */
10538    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
10539
10540    /**
10541     * Delete them item from the list.
10542     *
10543     * @param item The item of list to be deleted.
10544     *
10545     * If deleting all list items is required, elm_list_clear()
10546     * should be used instead of getting items list and deleting each one.
10547     *
10548     * @see elm_list_clear()
10549     * @see elm_list_item_append()
10550     * @see elm_list_item_del_cb_set()
10551     *
10552     * @ingroup List
10553     */
10554    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
10555
10556    /**
10557     * Set the function called when a list item is freed.
10558     *
10559     * @param item The item to set the callback on
10560     * @param func The function called
10561     *
10562     * If there is a @p func, then it will be called prior item's memory release.
10563     * That will be called with the following arguments:
10564     * @li item's data;
10565     * @li item's Evas object;
10566     * @li item itself;
10567     *
10568     * This way, a data associated to a list item could be properly freed.
10569     *
10570     * @ingroup List
10571     */
10572    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10573
10574    /**
10575     * Get the data associated to the item.
10576     *
10577     * @param item The list item
10578     * @return The data associated to @p item
10579     *
10580     * The return value is a pointer to data associated to @p item when it was
10581     * created, with function elm_list_item_append() or similar. If no data
10582     * was passed as argument, it will return @c NULL.
10583     *
10584     * @see elm_list_item_append()
10585     *
10586     * @ingroup List
10587     */
10588    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10589
10590    /**
10591     * Get the left side icon associated to the item.
10592     *
10593     * @param item The list item
10594     * @return The left side icon associated to @p item
10595     *
10596     * The return value is a pointer to the icon associated to @p item when
10597     * it was
10598     * created, with function elm_list_item_append() or similar, or later
10599     * with function elm_list_item_icon_set(). If no icon
10600     * was passed as argument, it will return @c NULL.
10601     *
10602     * @see elm_list_item_append()
10603     * @see elm_list_item_icon_set()
10604     *
10605     * @ingroup List
10606     */
10607    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10608
10609    /**
10610     * Set the left side icon associated to the item.
10611     *
10612     * @param item The list item
10613     * @param icon The left side icon object to associate with @p item
10614     *
10615     * The icon object to use at left side of the item. An
10616     * icon can be any Evas object, but usually it is an icon created
10617     * with elm_icon_add().
10618     *
10619     * Once the icon object is set, a previously set one will be deleted.
10620     * @warning Setting the same icon for two items will cause the icon to
10621     * dissapear from the first item.
10622     *
10623     * If an icon was passed as argument on item creation, with function
10624     * elm_list_item_append() or similar, it will be already
10625     * associated to the item.
10626     *
10627     * @see elm_list_item_append()
10628     * @see elm_list_item_icon_get()
10629     *
10630     * @ingroup List
10631     */
10632    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
10633
10634    /**
10635     * Get the right side icon associated to the item.
10636     *
10637     * @param item The list item
10638     * @return The right side icon associated to @p item
10639     *
10640     * The return value is a pointer to the icon associated to @p item when
10641     * it was
10642     * created, with function elm_list_item_append() or similar, or later
10643     * with function elm_list_item_icon_set(). If no icon
10644     * was passed as argument, it will return @c NULL.
10645     *
10646     * @see elm_list_item_append()
10647     * @see elm_list_item_icon_set()
10648     *
10649     * @ingroup List
10650     */
10651    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10652
10653    /**
10654     * Set the right side icon associated to the item.
10655     *
10656     * @param item The list item
10657     * @param end The right side icon object to associate with @p item
10658     *
10659     * The icon object to use at right side of the item. An
10660     * icon can be any Evas object, but usually it is an icon created
10661     * with elm_icon_add().
10662     *
10663     * Once the icon object is set, a previously set one will be deleted.
10664     * @warning Setting the same icon for two items will cause the icon to
10665     * dissapear from the first item.
10666     *
10667     * If an icon was passed as argument on item creation, with function
10668     * elm_list_item_append() or similar, it will be already
10669     * associated to the item.
10670     *
10671     * @see elm_list_item_append()
10672     * @see elm_list_item_end_get()
10673     *
10674     * @ingroup List
10675     */
10676    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
10677
10678    /**
10679     * Gets the base object of the item.
10680     *
10681     * @param item The list item
10682     * @return The base object associated with @p item
10683     *
10684     * Base object is the @c Evas_Object that represents that item.
10685     *
10686     * @ingroup List
10687     */
10688    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10689
10690    /**
10691     * Get the label of item.
10692     *
10693     * @param item The item of list.
10694     * @return The label of item.
10695     *
10696     * The return value is a pointer to the label associated to @p item when
10697     * it was created, with function elm_list_item_append(), or later
10698     * with function elm_list_item_label_set. If no label
10699     * was passed as argument, it will return @c NULL.
10700     *
10701     * @see elm_list_item_label_set() for more details.
10702     * @see elm_list_item_append()
10703     *
10704     * @ingroup List
10705     */
10706    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10707
10708    /**
10709     * Set the label of item.
10710     *
10711     * @param item The item of list.
10712     * @param text The label of item.
10713     *
10714     * The label to be displayed by the item.
10715     * Label will be placed between left and right side icons (if set).
10716     *
10717     * If a label was passed as argument on item creation, with function
10718     * elm_list_item_append() or similar, it will be already
10719     * displayed by the item.
10720     *
10721     * @see elm_list_item_label_get()
10722     * @see elm_list_item_append()
10723     *
10724     * @ingroup List
10725     */
10726    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
10727
10728
10729    /**
10730     * Get the item before @p it in list.
10731     *
10732     * @param it The list item.
10733     * @return The item before @p it, or @c NULL if none or on failure.
10734     *
10735     * @note If it is the first item, @c NULL will be returned.
10736     *
10737     * @see elm_list_item_append()
10738     * @see elm_list_items_get()
10739     *
10740     * @ingroup List
10741     */
10742    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10743
10744    /**
10745     * Get the item after @p it in list.
10746     *
10747     * @param it The list item.
10748     * @return The item after @p it, or @c NULL if none or on failure.
10749     *
10750     * @note If it is the last item, @c NULL will be returned.
10751     *
10752     * @see elm_list_item_append()
10753     * @see elm_list_items_get()
10754     *
10755     * @ingroup List
10756     */
10757    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10758
10759    /**
10760     * Sets the disabled/enabled state of a list item.
10761     *
10762     * @param it The item.
10763     * @param disabled The disabled state.
10764     *
10765     * A disabled item cannot be selected or unselected. It will also
10766     * change its appearance (generally greyed out). This sets the
10767     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
10768     * enabled).
10769     *
10770     * @ingroup List
10771     */
10772    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10773
10774    /**
10775     * Get a value whether list item is disabled or not.
10776     *
10777     * @param it The item.
10778     * @return The disabled state.
10779     *
10780     * @see elm_list_item_disabled_set() for more details.
10781     *
10782     * @ingroup List
10783     */
10784    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10785
10786    /**
10787     * Set the text to be shown in a given list item's tooltips.
10788     *
10789     * @param item Target item.
10790     * @param text The text to set in the content.
10791     *
10792     * Setup the text as tooltip to object. The item can have only one tooltip,
10793     * so any previous tooltip data - set with this function or
10794     * elm_list_item_tooltip_content_cb_set() - is removed.
10795     *
10796     * @see elm_object_tooltip_text_set() for more details.
10797     *
10798     * @ingroup List
10799     */
10800    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
10801
10802
10803    /**
10804     * @brief Disable size restrictions on an object's tooltip
10805     * @param item The tooltip's anchor object
10806     * @param disable If EINA_TRUE, size restrictions are disabled
10807     * @return EINA_FALSE on failure, EINA_TRUE on success
10808     *
10809     * This function allows a tooltip to expand beyond its parant window's canvas.
10810     * It will instead be limited only by the size of the display.
10811     */
10812    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
10813    /**
10814     * @brief Retrieve size restriction state of an object's tooltip
10815     * @param obj The tooltip's anchor object
10816     * @return If EINA_TRUE, size restrictions are disabled
10817     *
10818     * This function returns whether a tooltip is allowed to expand beyond
10819     * its parant window's canvas.
10820     * It will instead be limited only by the size of the display.
10821     */
10822    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10823
10824    /**
10825     * Set the content to be shown in the tooltip item.
10826     *
10827     * Setup the tooltip to item. The item can have only one tooltip,
10828     * so any previous tooltip data is removed. @p func(with @p data) will
10829     * be called every time that need show the tooltip and it should
10830     * return a valid Evas_Object. This object is then managed fully by
10831     * tooltip system and is deleted when the tooltip is gone.
10832     *
10833     * @param item the list item being attached a tooltip.
10834     * @param func the function used to create the tooltip contents.
10835     * @param data what to provide to @a func as callback data/context.
10836     * @param del_cb called when data is not needed anymore, either when
10837     *        another callback replaces @a func, the tooltip is unset with
10838     *        elm_list_item_tooltip_unset() or the owner @a item
10839     *        dies. This callback receives as the first parameter the
10840     *        given @a data, and @c event_info is the item.
10841     *
10842     * @see elm_object_tooltip_content_cb_set() for more details.
10843     *
10844     * @ingroup List
10845     */
10846    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);
10847
10848    /**
10849     * Unset tooltip from item.
10850     *
10851     * @param item list item to remove previously set tooltip.
10852     *
10853     * Remove tooltip from item. The callback provided as del_cb to
10854     * elm_list_item_tooltip_content_cb_set() will be called to notify
10855     * it is not used anymore.
10856     *
10857     * @see elm_object_tooltip_unset() for more details.
10858     * @see elm_list_item_tooltip_content_cb_set()
10859     *
10860     * @ingroup List
10861     */
10862    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
10863
10864    /**
10865     * Sets a different style for this item tooltip.
10866     *
10867     * @note before you set a style you should define a tooltip with
10868     *       elm_list_item_tooltip_content_cb_set() or
10869     *       elm_list_item_tooltip_text_set()
10870     *
10871     * @param item list item with tooltip already set.
10872     * @param style the theme style to use (default, transparent, ...)
10873     *
10874     * @see elm_object_tooltip_style_set() for more details.
10875     *
10876     * @ingroup List
10877     */
10878    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
10879
10880    /**
10881     * Get the style for this item tooltip.
10882     *
10883     * @param item list item with tooltip already set.
10884     * @return style the theme style in use, defaults to "default". If the
10885     *         object does not have a tooltip set, then NULL is returned.
10886     *
10887     * @see elm_object_tooltip_style_get() for more details.
10888     * @see elm_list_item_tooltip_style_set()
10889     *
10890     * @ingroup List
10891     */
10892    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10893
10894    /**
10895     * Set the type of mouse pointer/cursor decoration to be shown,
10896     * when the mouse pointer is over the given list widget item
10897     *
10898     * @param item list item to customize cursor on
10899     * @param cursor the cursor type's name
10900     *
10901     * This function works analogously as elm_object_cursor_set(), but
10902     * here the cursor's changing area is restricted to the item's
10903     * area, and not the whole widget's. Note that that item cursors
10904     * have precedence over widget cursors, so that a mouse over an
10905     * item with custom cursor set will always show @b that cursor.
10906     *
10907     * If this function is called twice for an object, a previously set
10908     * cursor will be unset on the second call.
10909     *
10910     * @see elm_object_cursor_set()
10911     * @see elm_list_item_cursor_get()
10912     * @see elm_list_item_cursor_unset()
10913     *
10914     * @ingroup List
10915     */
10916    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
10917
10918    /*
10919     * Get the type of mouse pointer/cursor decoration set to be shown,
10920     * when the mouse pointer is over the given list widget item
10921     *
10922     * @param item list item with custom cursor set
10923     * @return the cursor type's name or @c NULL, if no custom cursors
10924     * were set to @p item (and on errors)
10925     *
10926     * @see elm_object_cursor_get()
10927     * @see elm_list_item_cursor_set()
10928     * @see elm_list_item_cursor_unset()
10929     *
10930     * @ingroup List
10931     */
10932    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10933
10934    /**
10935     * Unset any custom mouse pointer/cursor decoration set to be
10936     * shown, when the mouse pointer is over the given list widget
10937     * item, thus making it show the @b default cursor again.
10938     *
10939     * @param item a list item
10940     *
10941     * Use this call to undo any custom settings on this item's cursor
10942     * decoration, bringing it back to defaults (no custom style set).
10943     *
10944     * @see elm_object_cursor_unset()
10945     * @see elm_list_item_cursor_set()
10946     *
10947     * @ingroup List
10948     */
10949    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
10950
10951    /**
10952     * Set a different @b style for a given custom cursor set for a
10953     * list item.
10954     *
10955     * @param item list item with custom cursor set
10956     * @param style the <b>theme style</b> to use (e.g. @c "default",
10957     * @c "transparent", etc)
10958     *
10959     * This function only makes sense when one is using custom mouse
10960     * cursor decorations <b>defined in a theme file</b>, which can have,
10961     * given a cursor name/type, <b>alternate styles</b> on it. It
10962     * works analogously as elm_object_cursor_style_set(), but here
10963     * applyed only to list item objects.
10964     *
10965     * @warning Before you set a cursor style you should have definen a
10966     *       custom cursor previously on the item, with
10967     *       elm_list_item_cursor_set()
10968     *
10969     * @see elm_list_item_cursor_engine_only_set()
10970     * @see elm_list_item_cursor_style_get()
10971     *
10972     * @ingroup List
10973     */
10974    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
10975
10976    /**
10977     * Get the current @b style set for a given list item's custom
10978     * cursor
10979     *
10980     * @param item list item with custom cursor set.
10981     * @return style the cursor style in use. If the object does not
10982     *         have a cursor set, then @c NULL is returned.
10983     *
10984     * @see elm_list_item_cursor_style_set() for more details
10985     *
10986     * @ingroup List
10987     */
10988    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10989
10990    /**
10991     * Set if the (custom)cursor for a given list item should be
10992     * searched in its theme, also, or should only rely on the
10993     * rendering engine.
10994     *
10995     * @param item item with custom (custom) cursor already set on
10996     * @param engine_only Use @c EINA_TRUE to have cursors looked for
10997     * only on those provided by the rendering engine, @c EINA_FALSE to
10998     * have them searched on the widget's theme, as well.
10999     *
11000     * @note This call is of use only if you've set a custom cursor
11001     * for list items, with elm_list_item_cursor_set().
11002     *
11003     * @note By default, cursors will only be looked for between those
11004     * provided by the rendering engine.
11005     *
11006     * @ingroup List
11007     */
11008    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11009
11010    /**
11011     * Get if the (custom) cursor for a given list item is being
11012     * searched in its theme, also, or is only relying on the rendering
11013     * engine.
11014     *
11015     * @param item a list item
11016     * @return @c EINA_TRUE, if cursors are being looked for only on
11017     * those provided by the rendering engine, @c EINA_FALSE if they
11018     * are being searched on the widget's theme, as well.
11019     *
11020     * @see elm_list_item_cursor_engine_only_set(), for more details
11021     *
11022     * @ingroup List
11023     */
11024    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
11025
11026    /**
11027     * @}
11028     */
11029
11030    /**
11031     * @defgroup Slider Slider
11032     * @ingroup Elementary
11033     *
11034     * @image html img/widget/slider/preview-00.png
11035     * @image latex img/widget/slider/preview-00.eps width=\textwidth
11036     *
11037     * The slider adds a dragable “slider” widget for selecting the value of
11038     * something within a range.
11039     *
11040     * A slider can be horizontal or vertical. It can contain an Icon and has a
11041     * primary label as well as a units label (that is formatted with floating
11042     * point values and thus accepts a printf-style format string, like
11043     * “%1.2f units”. There is also an indicator string that may be somewhere
11044     * else (like on the slider itself) that also accepts a format string like
11045     * units. Label, Icon Unit and Indicator strings/objects are optional.
11046     *
11047     * A slider may be inverted which means values invert, with high vales being
11048     * on the left or top and low values on the right or bottom (as opposed to
11049     * normally being low on the left or top and high on the bottom and right).
11050     *
11051     * The slider should have its minimum and maximum values set by the
11052     * application with  elm_slider_min_max_set() and value should also be set by
11053     * the application before use with  elm_slider_value_set(). The span of the
11054     * slider is its length (horizontally or vertically). This will be scaled by
11055     * the object or applications scaling factor. At any point code can query the
11056     * slider for its value with elm_slider_value_get().
11057     *
11058     * Smart callbacks one can listen to:
11059     * - "changed" - Whenever the slider value is changed by the user.
11060     * - "slider,drag,start" - dragging the slider indicator around has started.
11061     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
11062     * - "delay,changed" - A short time after the value is changed by the user.
11063     * This will be called only when the user stops dragging for
11064     * a very short period or when they release their
11065     * finger/mouse, so it avoids possibly expensive reactions to
11066     * the value change.
11067     *
11068     * Available styles for it:
11069     * - @c "default"
11070     *
11071     * Here is an example on its usage:
11072     * @li @ref slider_example
11073     */
11074
11075    /**
11076     * @addtogroup Slider
11077     * @{
11078     */
11079
11080    /**
11081     * Add a new slider widget to the given parent Elementary
11082     * (container) object.
11083     *
11084     * @param parent The parent object.
11085     * @return a new slider widget handle or @c NULL, on errors.
11086     *
11087     * This function inserts a new slider widget on the canvas.
11088     *
11089     * @ingroup Slider
11090     */
11091    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11092
11093    /**
11094     * Set the label of a given slider widget
11095     *
11096     * @param obj The progress bar object
11097     * @param label The text label string, in UTF-8
11098     *
11099     * @ingroup Slider
11100     * @deprecated use elm_object_text_set() instead.
11101     */
11102    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11103
11104    /**
11105     * Get the label of a given slider widget
11106     *
11107     * @param obj The progressbar object
11108     * @return The text label string, in UTF-8
11109     *
11110     * @ingroup Slider
11111     * @deprecated use elm_object_text_get() instead.
11112     */
11113    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11114
11115    /**
11116     * Set the icon object of the slider object.
11117     *
11118     * @param obj The slider object.
11119     * @param icon The icon object.
11120     *
11121     * On horizontal mode, icon is placed at left, and on vertical mode,
11122     * placed at top.
11123     *
11124     * @note Once the icon object is set, a previously set one will be deleted.
11125     * If you want to keep that old content object, use the
11126     * elm_slider_icon_unset() function.
11127     *
11128     * @warning If the object being set does not have minimum size hints set,
11129     * it won't get properly displayed.
11130     *
11131     * @ingroup Slider
11132     */
11133    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11134
11135    /**
11136     * Unset an icon set on a given slider widget.
11137     *
11138     * @param obj The slider object.
11139     * @return The icon object that was being used, if any was set, or
11140     * @c NULL, otherwise (and on errors).
11141     *
11142     * On horizontal mode, icon is placed at left, and on vertical mode,
11143     * placed at top.
11144     *
11145     * This call will unparent and return the icon object which was set
11146     * for this widget, previously, on success.
11147     *
11148     * @see elm_slider_icon_set() for more details
11149     * @see elm_slider_icon_get()
11150     *
11151     * @ingroup Slider
11152     */
11153    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11154
11155    /**
11156     * Retrieve the icon object set for a given slider widget.
11157     *
11158     * @param obj The slider object.
11159     * @return The icon object's handle, if @p obj had one set, or @c NULL,
11160     * otherwise (and on errors).
11161     *
11162     * On horizontal mode, icon is placed at left, and on vertical mode,
11163     * placed at top.
11164     *
11165     * @see elm_slider_icon_set() for more details
11166     * @see elm_slider_icon_unset()
11167     *
11168     * @ingroup Slider
11169     */
11170    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11171
11172    /**
11173     * Set the end object of the slider object.
11174     *
11175     * @param obj The slider object.
11176     * @param end The end object.
11177     *
11178     * On horizontal mode, end is placed at left, and on vertical mode,
11179     * placed at bottom.
11180     *
11181     * @note Once the icon object is set, a previously set one will be deleted.
11182     * If you want to keep that old content object, use the
11183     * elm_slider_end_unset() function.
11184     *
11185     * @warning If the object being set does not have minimum size hints set,
11186     * it won't get properly displayed.
11187     *
11188     * @ingroup Slider
11189     */
11190    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
11191
11192    /**
11193     * Unset an end object set on a given slider widget.
11194     *
11195     * @param obj The slider object.
11196     * @return The end object that was being used, if any was set, or
11197     * @c NULL, otherwise (and on errors).
11198     *
11199     * On horizontal mode, end is placed at left, and on vertical mode,
11200     * placed at bottom.
11201     *
11202     * This call will unparent and return the icon object which was set
11203     * for this widget, previously, on success.
11204     *
11205     * @see elm_slider_end_set() for more details.
11206     * @see elm_slider_end_get()
11207     *
11208     * @ingroup Slider
11209     */
11210    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11211
11212    /**
11213     * Retrieve the end object set for a given slider widget.
11214     *
11215     * @param obj The slider object.
11216     * @return The end object's handle, if @p obj had one set, or @c NULL,
11217     * otherwise (and on errors).
11218     *
11219     * On horizontal mode, icon is placed at right, and on vertical mode,
11220     * placed at bottom.
11221     *
11222     * @see elm_slider_end_set() for more details.
11223     * @see elm_slider_end_unset()
11224     *
11225     * @ingroup Slider
11226     */
11227    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11228
11229    /**
11230     * Set the (exact) length of the bar region of a given slider widget.
11231     *
11232     * @param obj The slider object.
11233     * @param size The length of the slider's bar region.
11234     *
11235     * This sets the minimum width (when in horizontal mode) or height
11236     * (when in vertical mode) of the actual bar area of the slider
11237     * @p obj. This in turn affects the object's minimum size. Use
11238     * this when you're not setting other size hints expanding on the
11239     * given direction (like weight and alignment hints) and you would
11240     * like it to have a specific size.
11241     *
11242     * @note Icon, end, label, indicator and unit text around @p obj
11243     * will require their
11244     * own space, which will make @p obj to require more the @p size,
11245     * actually.
11246     *
11247     * @see elm_slider_span_size_get()
11248     *
11249     * @ingroup Slider
11250     */
11251    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
11252
11253    /**
11254     * Get the length set for the bar region of a given slider widget
11255     *
11256     * @param obj The slider object.
11257     * @return The length of the slider's bar region.
11258     *
11259     * If that size was not set previously, with
11260     * elm_slider_span_size_set(), this call will return @c 0.
11261     *
11262     * @ingroup Slider
11263     */
11264    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11265
11266    /**
11267     * Set the format string for the unit label.
11268     *
11269     * @param obj The slider object.
11270     * @param format The format string for the unit display.
11271     *
11272     * Unit label is displayed all the time, if set, after slider's bar.
11273     * In horizontal mode, at right and in vertical mode, at bottom.
11274     *
11275     * If @c NULL, unit label won't be visible. If not it sets the format
11276     * string for the label text. To the label text is provided a floating point
11277     * value, so the label text can display up to 1 floating point value.
11278     * Note that this is optional.
11279     *
11280     * Use a format string such as "%1.2f meters" for example, and it will
11281     * display values like: "3.14 meters" for a value equal to 3.14159.
11282     *
11283     * Default is unit label disabled.
11284     *
11285     * @see elm_slider_indicator_format_get()
11286     *
11287     * @ingroup Slider
11288     */
11289    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
11290
11291    /**
11292     * Get the unit label format of the slider.
11293     *
11294     * @param obj The slider object.
11295     * @return The unit label format string in UTF-8.
11296     *
11297     * Unit label is displayed all the time, if set, after slider's bar.
11298     * In horizontal mode, at right and in vertical mode, at bottom.
11299     *
11300     * @see elm_slider_unit_format_set() for more
11301     * information on how this works.
11302     *
11303     * @ingroup Slider
11304     */
11305    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11306
11307    /**
11308     * Set the format string for the indicator label.
11309     *
11310     * @param obj The slider object.
11311     * @param indicator The format string for the indicator display.
11312     *
11313     * The slider may display its value somewhere else then unit label,
11314     * for example, above the slider knob that is dragged around. This function
11315     * sets the format string used for this.
11316     *
11317     * If @c NULL, indicator label won't be visible. If not it sets the format
11318     * string for the label text. To the label text is provided a floating point
11319     * value, so the label text can display up to 1 floating point value.
11320     * Note that this is optional.
11321     *
11322     * Use a format string such as "%1.2f meters" for example, and it will
11323     * display values like: "3.14 meters" for a value equal to 3.14159.
11324     *
11325     * Default is indicator label disabled.
11326     *
11327     * @see elm_slider_indicator_format_get()
11328     *
11329     * @ingroup Slider
11330     */
11331    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
11332
11333    /**
11334     * Get the indicator label format of the slider.
11335     *
11336     * @param obj The slider object.
11337     * @return The indicator label format string in UTF-8.
11338     *
11339     * The slider may display its value somewhere else then unit label,
11340     * for example, above the slider knob that is dragged around. This function
11341     * gets the format string used for this.
11342     *
11343     * @see elm_slider_indicator_format_set() for more
11344     * information on how this works.
11345     *
11346     * @ingroup Slider
11347     */
11348    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11349
11350    /**
11351     * Set the format function pointer for the indicator label
11352     *
11353     * @param obj The slider object.
11354     * @param func The indicator format function.
11355     * @param free_func The freeing function for the format string.
11356     *
11357     * Set the callback function to format the indicator string.
11358     *
11359     * @see elm_slider_indicator_format_set() for more info on how this works.
11360     *
11361     * @ingroup Slider
11362     */
11363   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);
11364
11365   /**
11366    * Set the format function pointer for the units label
11367    *
11368    * @param obj The slider object.
11369    * @param func The units format function.
11370    * @param free_func The freeing function for the format string.
11371    *
11372    * Set the callback function to format the indicator string.
11373    *
11374    * @see elm_slider_units_format_set() for more info on how this works.
11375    *
11376    * @ingroup Slider
11377    */
11378   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);
11379
11380   /**
11381    * Set the orientation of a given slider widget.
11382    *
11383    * @param obj The slider object.
11384    * @param horizontal Use @c EINA_TRUE to make @p obj to be
11385    * @b horizontal, @c EINA_FALSE to make it @b vertical.
11386    *
11387    * Use this function to change how your slider is to be
11388    * disposed: vertically or horizontally.
11389    *
11390    * By default it's displayed horizontally.
11391    *
11392    * @see elm_slider_horizontal_get()
11393    *
11394    * @ingroup Slider
11395    */
11396    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
11397
11398    /**
11399     * Retrieve the orientation of a given slider widget
11400     *
11401     * @param obj The slider object.
11402     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
11403     * @c EINA_FALSE if it's @b vertical (and on errors).
11404     *
11405     * @see elm_slider_horizontal_set() for more details.
11406     *
11407     * @ingroup Slider
11408     */
11409    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11410
11411    /**
11412     * Set the minimum and maximum values for the slider.
11413     *
11414     * @param obj The slider object.
11415     * @param min The minimum value.
11416     * @param max The maximum value.
11417     *
11418     * Define the allowed range of values to be selected by the user.
11419     *
11420     * If actual value is less than @p min, it will be updated to @p min. If it
11421     * is bigger then @p max, will be updated to @p max. Actual value can be
11422     * get with elm_slider_value_get().
11423     *
11424     * By default, min is equal to 0.0, and max is equal to 1.0.
11425     *
11426     * @warning Maximum must be greater than minimum, otherwise behavior
11427     * is undefined.
11428     *
11429     * @see elm_slider_min_max_get()
11430     *
11431     * @ingroup Slider
11432     */
11433    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
11434
11435    /**
11436     * Get the minimum and maximum values of the slider.
11437     *
11438     * @param obj The slider object.
11439     * @param min Pointer where to store the minimum value.
11440     * @param max Pointer where to store the maximum value.
11441     *
11442     * @note If only one value is needed, the other pointer can be passed
11443     * as @c NULL.
11444     *
11445     * @see elm_slider_min_max_set() for details.
11446     *
11447     * @ingroup Slider
11448     */
11449    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
11450
11451    /**
11452     * Set the value the slider displays.
11453     *
11454     * @param obj The slider object.
11455     * @param val The value to be displayed.
11456     *
11457     * Value will be presented on the unit label following format specified with
11458     * elm_slider_unit_format_set() and on indicator with
11459     * elm_slider_indicator_format_set().
11460     *
11461     * @warning The value must to be between min and max values. This values
11462     * are set by elm_slider_min_max_set().
11463     *
11464     * @see elm_slider_value_get()
11465     * @see elm_slider_unit_format_set()
11466     * @see elm_slider_indicator_format_set()
11467     * @see elm_slider_min_max_set()
11468     *
11469     * @ingroup Slider
11470     */
11471    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
11472
11473    /**
11474     * Get the value displayed by the spinner.
11475     *
11476     * @param obj The spinner object.
11477     * @return The value displayed.
11478     *
11479     * @see elm_spinner_value_set() for details.
11480     *
11481     * @ingroup Slider
11482     */
11483    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11484
11485    /**
11486     * Invert a given slider widget's displaying values order
11487     *
11488     * @param obj The slider object.
11489     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
11490     * @c EINA_FALSE to bring it back to default, non-inverted values.
11491     *
11492     * A slider may be @b inverted, in which state it gets its
11493     * values inverted, with high vales being on the left or top and
11494     * low values on the right or bottom, as opposed to normally have
11495     * the low values on the former and high values on the latter,
11496     * respectively, for horizontal and vertical modes.
11497     *
11498     * @see elm_slider_inverted_get()
11499     *
11500     * @ingroup Slider
11501     */
11502    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
11503
11504    /**
11505     * Get whether a given slider widget's displaying values are
11506     * inverted or not.
11507     *
11508     * @param obj The slider object.
11509     * @return @c EINA_TRUE, if @p obj has inverted values,
11510     * @c EINA_FALSE otherwise (and on errors).
11511     *
11512     * @see elm_slider_inverted_set() for more details.
11513     *
11514     * @ingroup Slider
11515     */
11516    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11517
11518    /**
11519     * Set whether to enlarge slider indicator (augmented knob) or not.
11520     *
11521     * @param obj The slider object.
11522     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
11523     * let the knob always at default size.
11524     *
11525     * By default, indicator will be bigger while dragged by the user.
11526     *
11527     * @warning It won't display values set with
11528     * elm_slider_indicator_format_set() if you disable indicator.
11529     *
11530     * @ingroup Slider
11531     */
11532    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
11533
11534    /**
11535     * Get whether a given slider widget's enlarging indicator or not.
11536     *
11537     * @param obj The slider object.
11538     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
11539     * @c EINA_FALSE otherwise (and on errors).
11540     *
11541     * @see elm_slider_indicator_show_set() for details.
11542     *
11543     * @ingroup Slider
11544     */
11545    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11546
11547    /**
11548     * @}
11549     */
11550
11551    /**
11552     * @addtogroup Actionslider Actionslider
11553     *
11554     * @image html img/icon/actionslider/preview-00.png
11555     * @image latex img/icon/actionslider/preview-00.png
11556     *
11557     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
11558     * properties. The indicator is the element the user drags to choose a label.
11559     * When the position is set with magnet, when released the indicator will be
11560     * moved to it if it's nearest the magnetized position.
11561     *
11562     * @note By default all positions are set as enabled.
11563     *
11564     * Signals that you can add callbacks for are:
11565     *
11566     * "selected" - when user selects an enabled position (the label is passed
11567     *              as event info)".
11568     * @n
11569     * "pos_changed" - when the indicator reaches any of the positions("left",
11570     *                 "right" or "center").
11571     *
11572     * See an example of actionslider usage @ref actionslider_example_page "here"
11573     * @{
11574     */
11575    typedef enum _Elm_Actionslider_Pos
11576      {
11577         ELM_ACTIONSLIDER_NONE = 0,
11578         ELM_ACTIONSLIDER_LEFT = 1 << 0,
11579         ELM_ACTIONSLIDER_CENTER = 1 << 1,
11580         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
11581         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
11582      } Elm_Actionslider_Pos;
11583
11584    /**
11585     * Add a new actionslider to the parent.
11586     *
11587     * @param parent The parent object
11588     * @return The new actionslider object or NULL if it cannot be created
11589     */
11590    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11591    /**
11592     * Set actionslider labels.
11593     *
11594     * @param obj The actionslider object
11595     * @param left_label The label to be set on the left.
11596     * @param center_label The label to be set on the center.
11597     * @param right_label The label to be set on the right.
11598     * @deprecated use elm_object_text_set() instead.
11599     */
11600    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);
11601    /**
11602     * Get actionslider labels.
11603     *
11604     * @param obj The actionslider object
11605     * @param left_label A char** to place the left_label of @p obj into.
11606     * @param center_label A char** to place the center_label of @p obj into.
11607     * @param right_label A char** to place the right_label of @p obj into.
11608     * @deprecated use elm_object_text_set() instead.
11609     */
11610    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);
11611    /**
11612     * Get actionslider selected label.
11613     *
11614     * @param obj The actionslider object
11615     * @return The selected label
11616     */
11617    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11618    /**
11619     * Set actionslider indicator position.
11620     *
11621     * @param obj The actionslider object.
11622     * @param pos The position of the indicator.
11623     */
11624    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
11625    /**
11626     * Get actionslider indicator position.
11627     *
11628     * @param obj The actionslider object.
11629     * @return The position of the indicator.
11630     */
11631    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11632    /**
11633     * Set actionslider magnet position. To make multiple positions magnets @c or
11634     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
11635     *
11636     * @param obj The actionslider object.
11637     * @param pos Bit mask indicating the magnet positions.
11638     */
11639    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
11640    /**
11641     * Get actionslider magnet position.
11642     *
11643     * @param obj The actionslider object.
11644     * @return The positions with magnet property.
11645     */
11646    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11647    /**
11648     * Set actionslider enabled position. To set multiple positions as enabled @c or
11649     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
11650     *
11651     * @note All the positions are enabled by default.
11652     *
11653     * @param obj The actionslider object.
11654     * @param pos Bit mask indicating the enabled positions.
11655     */
11656    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
11657    /**
11658     * Get actionslider enabled position.
11659     *
11660     * @param obj The actionslider object.
11661     * @return The enabled positions.
11662     */
11663    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11664    /**
11665     * Set the label used on the indicator.
11666     *
11667     * @param obj The actionslider object
11668     * @param label The label to be set on the indicator.
11669     * @deprecated use elm_object_text_set() instead.
11670     */
11671    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11672    /**
11673     * Get the label used on the indicator object.
11674     *
11675     * @param obj The actionslider object
11676     * @return The indicator label
11677     * @deprecated use elm_object_text_get() instead.
11678     */
11679    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11680    /**
11681     * @}
11682     */
11683
11684    /**
11685     * @defgroup Genlist Genlist
11686     *
11687     * This widget aims to have more expansive list than the simple list in
11688     * Elementary that could have more flexible items and allow many more entries
11689     * while still being fast and low on memory usage. At the same time it was
11690     * also made to be able to do tree structures. But the price to pay is more
11691     * complexity when it comes to usage. If all you want is a simple list with
11692     * icons and a single label, use the normal @ref List object.
11693     *
11694     * Genlist has a fairly large API, mostly because it's relatively complex,
11695     * trying to be both expansive, powerful and efficient. First we will begin
11696     * an overview on the theory behind genlist.
11697     *
11698     * @section Genlist_Item_Class Genlist item classes - creating items
11699     *
11700     * In order to have the ability to add and delete items on the fly, genlist
11701     * implements a class (callback) system where the application provides a
11702     * structure with information about that type of item (genlist may contain
11703     * multiple different items with different classes, states and styles).
11704     * Genlist will call the functions in this struct (methods) when an item is
11705     * "realized" (i.e., created dynamically, while the user is scrolling the
11706     * grid). All objects will simply be deleted when no longer needed with
11707     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
11708     * following members:
11709     * - @c item_style - This is a constant string and simply defines the name
11710     *   of the item style. It @b must be specified and the default should be @c
11711     *   "default".
11712     *
11713     * - @c func - A struct with pointers to functions that will be called when
11714     *   an item is going to be actually created. All of them receive a @c data
11715     *   parameter that will point to the same data passed to
11716     *   elm_genlist_item_append() and related item creation functions, and a @c
11717     *   obj parameter that points to the genlist object itself.
11718     *
11719     * The function pointers inside @c func are @c label_get, @c icon_get, @c
11720     * state_get and @c del. The 3 first functions also receive a @c part
11721     * parameter described below. A brief description of these functions follows:
11722     *
11723     * - @c label_get - The @c part parameter is the name string of one of the
11724     *   existing text parts in the Edje group implementing the item's theme.
11725     *   This function @b must return a strdup'()ed string, as the caller will
11726     *   free() it when done. See #GenlistItemLabelGetFunc.
11727     * - @c icon_get - The @c part parameter is the name string of one of the
11728     *   existing (icon) swallow parts in the Edje group implementing the item's
11729     *   theme. It must return @c NULL, when no icon is desired, or a valid
11730     *   object handle, otherwise.  The object will be deleted by the genlist on
11731     *   its deletion or when the item is "unrealized".  See
11732     *   #GenlistItemIconGetFunc.
11733     * - @c func.state_get - The @c part parameter is the name string of one of
11734     *   the state parts in the Edje group implementing the item's theme. Return
11735     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
11736     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
11737     *   and @c "elm" as "emission" and "source" arguments, respectively, when
11738     *   the state is true (the default is false), where @c XXX is the name of
11739     *   the (state) part.  See #GenlistItemStateGetFunc.
11740     * - @c func.del - This is intended for use when genlist items are deleted,
11741     *   so any data attached to the item (e.g. its data parameter on creation)
11742     *   can be deleted. See #GenlistItemDelFunc.
11743     *
11744     * available item styles:
11745     * - default
11746     * - default_style - The text part is a textblock
11747     * - double_label
11748     * - icon_top_text_bottom
11749     *
11750     * @section Genlist_Items Structure of items
11751     *
11752     * An item in a genlist can have 0 or more text labels (they can be regular
11753     * text or textblock Evas objects - that's up to the style to determine), 0
11754     * or more icons (which are simply objects swallowed into the genlist item's
11755     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
11756     * behavior left to the user to define. The Edje part names for each of
11757     * these properties will be looked up, in the theme file for the genlist,
11758     * under the Edje (string) data items named @c "labels", @c "icons" and @c
11759     * "states", respectively. For each of those properties, if more than one
11760     * part is provided, they must have names listed separated by spaces in the
11761     * data fields. For the default genlist item theme, we have @b one label
11762     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
11763     * "elm.swallow.end") and @b no state parts.
11764     *
11765     * A genlist item may be at one of several styles. Elementary provides one
11766     * by default - "default", but this can be extended by system or application
11767     * custom themes/overlays/extensions (see @ref Theme "themes" for more
11768     * details).
11769     *
11770     * @section Genlist_Manipulation Editing and Navigating
11771     *
11772     * Items can be added by several calls. All of them return a @ref
11773     * Elm_Genlist_Item handle that is an internal member inside the genlist.
11774     * They all take a data parameter that is meant to be used for a handle to
11775     * the applications internal data (eg the struct with the original item
11776     * data). The parent parameter is the parent genlist item this belongs to if
11777     * it is a tree or an indexed group, and NULL if there is no parent. The
11778     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
11779     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
11780     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
11781     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
11782     * is set then this item is group index item that is displayed at the top
11783     * until the next group comes. The func parameter is a convenience callback
11784     * that is called when the item is selected and the data parameter will be
11785     * the func_data parameter, obj be the genlist object and event_info will be
11786     * the genlist item.
11787     *
11788     * elm_genlist_item_append() adds an item to the end of the list, or if
11789     * there is a parent, to the end of all the child items of the parent.
11790     * elm_genlist_item_prepend() is the same but adds to the beginning of
11791     * the list or children list. elm_genlist_item_insert_before() inserts at
11792     * item before another item and elm_genlist_item_insert_after() inserts after
11793     * the indicated item.
11794     *
11795     * The application can clear the list with elm_genlist_clear() which deletes
11796     * all the items in the list and elm_genlist_item_del() will delete a specific
11797     * item. elm_genlist_item_subitems_clear() will clear all items that are
11798     * children of the indicated parent item.
11799     *
11800     * To help inspect list items you can jump to the item at the top of the list
11801     * with elm_genlist_first_item_get() which will return the item pointer, and
11802     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
11803     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
11804     * and previous items respectively relative to the indicated item. Using
11805     * these calls you can walk the entire item list/tree. Note that as a tree
11806     * the items are flattened in the list, so elm_genlist_item_parent_get() will
11807     * let you know which item is the parent (and thus know how to skip them if
11808     * wanted).
11809     *
11810     * @section Genlist_Muti_Selection Multi-selection
11811     *
11812     * If the application wants multiple items to be able to be selected,
11813     * elm_genlist_multi_select_set() can enable this. If the list is
11814     * single-selection only (the default), then elm_genlist_selected_item_get()
11815     * will return the selected item, if any, or NULL I none is selected. If the
11816     * list is multi-select then elm_genlist_selected_items_get() will return a
11817     * list (that is only valid as long as no items are modified (added, deleted,
11818     * selected or unselected)).
11819     *
11820     * @section Genlist_Usage_Hints Usage hints
11821     *
11822     * There are also convenience functions. elm_genlist_item_genlist_get() will
11823     * return the genlist object the item belongs to. elm_genlist_item_show()
11824     * will make the scroller scroll to show that specific item so its visible.
11825     * elm_genlist_item_data_get() returns the data pointer set by the item
11826     * creation functions.
11827     *
11828     * If an item changes (state of boolean changes, label or icons change),
11829     * then use elm_genlist_item_update() to have genlist update the item with
11830     * the new state. Genlist will re-realize the item thus call the functions
11831     * in the _Elm_Genlist_Item_Class for that item.
11832     *
11833     * To programmatically (un)select an item use elm_genlist_item_selected_set().
11834     * To get its selected state use elm_genlist_item_selected_get(). Similarly
11835     * to expand/contract an item and get its expanded state, use
11836     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
11837     * again to make an item disabled (unable to be selected and appear
11838     * differently) use elm_genlist_item_disabled_set() to set this and
11839     * elm_genlist_item_disabled_get() to get the disabled state.
11840     *
11841     * In general to indicate how the genlist should expand items horizontally to
11842     * fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are
11843     * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
11844     * mode means that if items are too wide to fit, the scroller will scroll
11845     * horizontally. Otherwise items are expanded to fill the width of the
11846     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
11847     * to the viewport width and limited to that size. This can be combined with
11848     * a different style that uses edjes' ellipsis feature (cutting text off like
11849     * this: "tex...").
11850     *
11851     * Items will only call their selection func and callback when first becoming
11852     * selected. Any further clicks will do nothing, unless you enable always
11853     * select with elm_genlist_always_select_mode_set(). This means even if
11854     * selected, every click will make the selected callbacks be called.
11855     * elm_genlist_no_select_mode_set() will turn off the ability to select
11856     * items entirely and they will neither appear selected nor call selected
11857     * callback functions.
11858     *
11859     * Remember that you can create new styles and add your own theme augmentation
11860     * per application with elm_theme_extension_add(). If you absolutely must
11861     * have a specific style that overrides any theme the user or system sets up
11862     * you can use elm_theme_overlay_add() to add such a file.
11863     *
11864     * @section Genlist_Implementation Implementation
11865     *
11866     * Evas tracks every object you create. Every time it processes an event
11867     * (mouse move, down, up etc.) it needs to walk through objects and find out
11868     * what event that affects. Even worse every time it renders display updates,
11869     * in order to just calculate what to re-draw, it needs to walk through many
11870     * many many objects. Thus, the more objects you keep active, the more
11871     * overhead Evas has in just doing its work. It is advisable to keep your
11872     * active objects to the minimum working set you need. Also remember that
11873     * object creation and deletion carries an overhead, so there is a
11874     * middle-ground, which is not easily determined. But don't keep massive lists
11875     * of objects you can't see or use. Genlist does this with list objects. It
11876     * creates and destroys them dynamically as you scroll around. It groups them
11877     * into blocks so it can determine the visibility etc. of a whole block at
11878     * once as opposed to having to walk the whole list. This 2-level list allows
11879     * for very large numbers of items to be in the list (tests have used up to
11880     * 2,000,000 items). Also genlist employs a queue for adding items. As items
11881     * may be different sizes, every item added needs to be calculated as to its
11882     * size and thus this presents a lot of overhead on populating the list, this
11883     * genlist employs a queue. Any item added is queued and spooled off over
11884     * time, actually appearing some time later, so if your list has many members
11885     * you may find it takes a while for them to all appear, with your process
11886     * consuming a lot of CPU while it is busy spooling.
11887     *
11888     * Genlist also implements a tree structure, but it does so with callbacks to
11889     * the application, with the application filling in tree structures when
11890     * requested (allowing for efficient building of a very deep tree that could
11891     * even be used for file-management). See the above smart signal callbacks for
11892     * details.
11893     *
11894     * @section Genlist_Smart_Events Genlist smart events
11895     *
11896     * Signals that you can add callbacks for are:
11897     * - @c "activated" - The user has double-clicked or pressed
11898     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
11899     *   item that was activated.
11900     * - @c "clicked,double" - The user has double-clicked an item.  The @c
11901     *   event_info parameter is the item that was double-clicked.
11902     * - @c "selected" - This is called when a user has made an item selected.
11903     *   The event_info parameter is the genlist item that was selected.
11904     * - @c "unselected" - This is called when a user has made an item
11905     *   unselected. The event_info parameter is the genlist item that was
11906     *   unselected.
11907     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
11908     *   called and the item is now meant to be expanded. The event_info
11909     *   parameter is the genlist item that was indicated to expand.  It is the
11910     *   job of this callback to then fill in the child items.
11911     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
11912     *   called and the item is now meant to be contracted. The event_info
11913     *   parameter is the genlist item that was indicated to contract. It is the
11914     *   job of this callback to then delete the child items.
11915     * - @c "expand,request" - This is called when a user has indicated they want
11916     *   to expand a tree branch item. The callback should decide if the item can
11917     *   expand (has any children) and then call elm_genlist_item_expanded_set()
11918     *   appropriately to set the state. The event_info parameter is the genlist
11919     *   item that was indicated to expand.
11920     * - @c "contract,request" - This is called when a user has indicated they
11921     *   want to contract a tree branch item. The callback should decide if the
11922     *   item can contract (has any children) and then call
11923     *   elm_genlist_item_expanded_set() appropriately to set the state. The
11924     *   event_info parameter is the genlist item that was indicated to contract.
11925     * - @c "realized" - This is called when the item in the list is created as a
11926     *   real evas object. event_info parameter is the genlist item that was
11927     *   created. The object may be deleted at any time, so it is up to the
11928     *   caller to not use the object pointer from elm_genlist_item_object_get()
11929     *   in a way where it may point to freed objects.
11930     * - @c "unrealized" - This is called just before an item is unrealized.
11931     *   After this call icon objects provided will be deleted and the item
11932     *   object itself delete or be put into a floating cache.
11933     * - @c "drag,start,up" - This is called when the item in the list has been
11934     *   dragged (not scrolled) up.
11935     * - @c "drag,start,down" - This is called when the item in the list has been
11936     *   dragged (not scrolled) down.
11937     * - @c "drag,start,left" - This is called when the item in the list has been
11938     *   dragged (not scrolled) left.
11939     * - @c "drag,start,right" - This is called when the item in the list has
11940     *   been dragged (not scrolled) right.
11941     * - @c "drag,stop" - This is called when the item in the list has stopped
11942     *   being dragged.
11943     * - @c "drag" - This is called when the item in the list is being dragged.
11944     * - @c "longpressed" - This is called when the item is pressed for a certain
11945     *   amount of time. By default it's 1 second.
11946     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
11947     *   the top edge.
11948     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
11949     *   until the bottom edge.
11950     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
11951     *   until the left edge.
11952     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
11953     *   until the right edge.
11954     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
11955     *   swiped left.
11956     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
11957     *   swiped right.
11958     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
11959     *   swiped up.
11960     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
11961     *   swiped down.
11962     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
11963     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
11964     *   multi-touch pinched in.
11965     * - @c "swipe" - This is called when the genlist is swiped.
11966     *
11967     * @section Genlist_Examples Examples
11968     *
11969     * Here is a list of examples that use the genlist, trying to show some of
11970     * its capabilities:
11971     * - @ref genlist_example_01
11972     * - @ref genlist_example_02
11973     * - @ref genlist_example_04
11974     * - @ref genlist_example_05
11975     */
11976
11977    /**
11978     * @addtogroup Genlist
11979     * @{
11980     */
11981
11982    /**
11983     * @enum _Elm_Genlist_Item_Flags
11984     * @typedef Elm_Genlist_Item_Flags
11985     *
11986     * Defines if the item is of any special type (has subitems or it's the
11987     * index of a group), or is just a simple item.
11988     *
11989     * @ingroup Genlist
11990     */
11991    typedef enum _Elm_Genlist_Item_Flags
11992      {
11993         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
11994         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
11995         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
11996      } Elm_Genlist_Item_Flags;
11997    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
11998    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
11999    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
12000    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
12001    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
12002    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
12003    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
12004    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
12005
12006    /**
12007     * @struct _Elm_Genlist_Item_Class
12008     *
12009     * Genlist item class definition structs.
12010     *
12011     * This struct contains the style and fetching functions that will define the
12012     * contents of each item.
12013     *
12014     * @see @ref Genlist_Item_Class
12015     */
12016    struct _Elm_Genlist_Item_Class
12017      {
12018         const char                *item_style; /**< style of this class. */
12019         struct
12020           {
12021              GenlistItemLabelGetFunc  label_get; /**< Label fetching class function for genlist item classes.*/
12022              GenlistItemIconGetFunc   icon_get; /**< Icon fetching class function for genlist item classes. */
12023              GenlistItemStateGetFunc  state_get; /**< State fetching class function for genlist item classes. */
12024              GenlistItemDelFunc       del; /**< Deletion class function for genlist item classes. */
12025              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
12026           } func;
12027         const char                *mode_item_style;
12028      };
12029
12030    /**
12031     * Add a new genlist widget to the given parent Elementary
12032     * (container) object
12033     *
12034     * @param parent The parent object
12035     * @return a new genlist widget handle or @c NULL, on errors
12036     *
12037     * This function inserts a new genlist widget on the canvas.
12038     *
12039     * @see elm_genlist_item_append()
12040     * @see elm_genlist_item_del()
12041     * @see elm_genlist_clear()
12042     *
12043     * @ingroup Genlist
12044     */
12045    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12046    /**
12047     * Remove all items from a given genlist widget.
12048     *
12049     * @param obj The genlist object
12050     *
12051     * This removes (and deletes) all items in @p obj, leaving it empty.
12052     *
12053     * @see elm_genlist_item_del(), to remove just one item.
12054     *
12055     * @ingroup Genlist
12056     */
12057    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12058    /**
12059     * Enable or disable multi-selection in the genlist
12060     *
12061     * @param obj The genlist object
12062     * @param multi Multi-select enable/disable. Default is disabled.
12063     *
12064     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
12065     * the list. This allows more than 1 item to be selected. To retrieve the list
12066     * of selected items, use elm_genlist_selected_items_get().
12067     *
12068     * @see elm_genlist_selected_items_get()
12069     * @see elm_genlist_multi_select_get()
12070     *
12071     * @ingroup Genlist
12072     */
12073    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12074    /**
12075     * Gets if multi-selection in genlist is enabled or disabled.
12076     *
12077     * @param obj The genlist object
12078     * @return Multi-select enabled/disabled
12079     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
12080     *
12081     * @see elm_genlist_multi_select_set()
12082     *
12083     * @ingroup Genlist
12084     */
12085    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12086    /**
12087     * This sets the horizontal stretching mode.
12088     *
12089     * @param obj The genlist object
12090     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
12091     *
12092     * This sets the mode used for sizing items horizontally. Valid modes
12093     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
12094     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
12095     * the scroller will scroll horizontally. Otherwise items are expanded
12096     * to fill the width of the viewport of the scroller. If it is
12097     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
12098     * limited to that size.
12099     *
12100     * @see elm_genlist_horizontal_mode_get()
12101     *
12102     * @ingroup Genlist
12103     */
12104    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12105    /**
12106     * Gets the horizontal stretching mode.
12107     *
12108     * @param obj The genlist object
12109     * @return The mode to use
12110     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
12111     *
12112     * @see elm_genlist_horizontal_mode_set()
12113     *
12114     * @ingroup Genlist
12115     */
12116    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12117    /**
12118     * Set the always select mode.
12119     *
12120     * @param obj The genlist object
12121     * @param always_select The always select mode (@c EINA_TRUE = on, @c
12122     * EINA_FALSE = off). Default is @c EINA_FALSE.
12123     *
12124     * Items will only call their selection func and callback when first
12125     * becoming selected. Any further clicks will do nothing, unless you
12126     * enable always select with elm_genlist_always_select_mode_set().
12127     * This means that, even if selected, every click will make the selected
12128     * callbacks be called.
12129     *
12130     * @see elm_genlist_always_select_mode_get()
12131     *
12132     * @ingroup Genlist
12133     */
12134    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12135    /**
12136     * Get the always select mode.
12137     *
12138     * @param obj The genlist object
12139     * @return The always select mode
12140     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
12141     *
12142     * @see elm_genlist_always_select_mode_set()
12143     *
12144     * @ingroup Genlist
12145     */
12146    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12147    /**
12148     * Enable/disable the no select mode.
12149     *
12150     * @param obj The genlist object
12151     * @param no_select The no select mode
12152     * (EINA_TRUE = on, EINA_FALSE = off)
12153     *
12154     * This will turn off the ability to select items entirely and they
12155     * will neither appear selected nor call selected callback functions.
12156     *
12157     * @see elm_genlist_no_select_mode_get()
12158     *
12159     * @ingroup Genlist
12160     */
12161    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12162    /**
12163     * Gets whether the no select mode is enabled.
12164     *
12165     * @param obj The genlist object
12166     * @return The no select mode
12167     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
12168     *
12169     * @see elm_genlist_no_select_mode_set()
12170     *
12171     * @ingroup Genlist
12172     */
12173    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12174    /**
12175     * Enable/disable compress mode.
12176     *
12177     * @param obj The genlist object
12178     * @param compress The compress mode
12179     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
12180     *
12181     * This will enable the compress mode where items are "compressed"
12182     * horizontally to fit the genlist scrollable viewport width. This is
12183     * special for genlist.  Do not rely on
12184     * elm_genlist_horizontal_mode_set() being set to @c ELM_LIST_COMPRESS to
12185     * work as genlist needs to handle it specially.
12186     *
12187     * @see elm_genlist_compress_mode_get()
12188     *
12189     * @ingroup Genlist
12190     */
12191    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
12192    /**
12193     * Get whether the compress mode is enabled.
12194     *
12195     * @param obj The genlist object
12196     * @return The compress mode
12197     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
12198     *
12199     * @see elm_genlist_compress_mode_set()
12200     *
12201     * @ingroup Genlist
12202     */
12203    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12204    /**
12205     * Enable/disable height-for-width mode.
12206     *
12207     * @param obj The genlist object
12208     * @param setting The height-for-width mode (@c EINA_TRUE = on,
12209     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
12210     *
12211     * With height-for-width mode the item width will be fixed (restricted
12212     * to a minimum of) to the list width when calculating its size in
12213     * order to allow the height to be calculated based on it. This allows,
12214     * for instance, text block to wrap lines if the Edje part is
12215     * configured with "text.min: 0 1".
12216     *
12217     * @note This mode will make list resize slower as it will have to
12218     *       recalculate every item height again whenever the list width
12219     *       changes!
12220     *
12221     * @note When height-for-width mode is enabled, it also enables
12222     *       compress mode (see elm_genlist_compress_mode_set()) and
12223     *       disables homogeneous (see elm_genlist_homogeneous_set()).
12224     *
12225     * @ingroup Genlist
12226     */
12227    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
12228    /**
12229     * Get whether the height-for-width mode is enabled.
12230     *
12231     * @param obj The genlist object
12232     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
12233     * off)
12234     *
12235     * @ingroup Genlist
12236     */
12237    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12238    /**
12239     * Enable/disable horizontal and vertical bouncing effect.
12240     *
12241     * @param obj The genlist object
12242     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
12243     * EINA_FALSE = off). Default is @c EINA_FALSE.
12244     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
12245     * EINA_FALSE = off). Default is @c EINA_TRUE.
12246     *
12247     * This will enable or disable the scroller bouncing effect for the
12248     * genlist. See elm_scroller_bounce_set() for details.
12249     *
12250     * @see elm_scroller_bounce_set()
12251     * @see elm_genlist_bounce_get()
12252     *
12253     * @ingroup Genlist
12254     */
12255    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12256    /**
12257     * Get whether the horizontal and vertical bouncing effect is enabled.
12258     *
12259     * @param obj The genlist object
12260     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
12261     * option is set.
12262     * @param v_bounce Pointer to a bool to receive if the bounce vertically
12263     * option is set.
12264     *
12265     * @see elm_genlist_bounce_set()
12266     *
12267     * @ingroup Genlist
12268     */
12269    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12270    /**
12271     * Enable/disable homogenous mode.
12272     *
12273     * @param obj The genlist object
12274     * @param homogeneous Assume the items within the genlist are of the
12275     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
12276     * EINA_FALSE.
12277     *
12278     * This will enable the homogeneous mode where items are of the same
12279     * height and width so that genlist may do the lazy-loading at its
12280     * maximum (which increases the performance for scrolling the list). This
12281     * implies 'compressed' mode.
12282     *
12283     * @see elm_genlist_compress_mode_set()
12284     * @see elm_genlist_homogeneous_get()
12285     *
12286     * @ingroup Genlist
12287     */
12288    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
12289    /**
12290     * Get whether the homogenous mode is enabled.
12291     *
12292     * @param obj The genlist object
12293     * @return Assume the items within the genlist are of the same height
12294     * and width (EINA_TRUE = on, EINA_FALSE = off)
12295     *
12296     * @see elm_genlist_homogeneous_set()
12297     *
12298     * @ingroup Genlist
12299     */
12300    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12301    /**
12302     * Set the maximum number of items within an item block
12303     *
12304     * @param obj The genlist object
12305     * @param n   Maximum number of items within an item block. Default is 32.
12306     *
12307     * This will configure the block count to tune to the target with
12308     * particular performance matrix.
12309     *
12310     * A block of objects will be used to reduce the number of operations due to
12311     * many objects in the screen. It can determine the visibility, or if the
12312     * object has changed, it theme needs to be updated, etc. doing this kind of
12313     * calculation to the entire block, instead of per object.
12314     *
12315     * The default value for the block count is enough for most lists, so unless
12316     * you know you will have a lot of objects visible in the screen at the same
12317     * time, don't try to change this.
12318     *
12319     * @see elm_genlist_block_count_get()
12320     * @see @ref Genlist_Implementation
12321     *
12322     * @ingroup Genlist
12323     */
12324    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
12325    /**
12326     * Get the maximum number of items within an item block
12327     *
12328     * @param obj The genlist object
12329     * @return Maximum number of items within an item block
12330     *
12331     * @see elm_genlist_block_count_set()
12332     *
12333     * @ingroup Genlist
12334     */
12335    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12336    /**
12337     * Set the timeout in seconds for the longpress event.
12338     *
12339     * @param obj The genlist object
12340     * @param timeout timeout in seconds. Default is 1.
12341     *
12342     * This option will change how long it takes to send an event "longpressed"
12343     * after the mouse down signal is sent to the list. If this event occurs, no
12344     * "clicked" event will be sent.
12345     *
12346     * @see elm_genlist_longpress_timeout_set()
12347     *
12348     * @ingroup Genlist
12349     */
12350    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
12351    /**
12352     * Get the timeout in seconds for the longpress event.
12353     *
12354     * @param obj The genlist object
12355     * @return timeout in seconds
12356     *
12357     * @see elm_genlist_longpress_timeout_get()
12358     *
12359     * @ingroup Genlist
12360     */
12361    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12362    /**
12363     * Append a new item in a given genlist widget.
12364     *
12365     * @param obj The genlist object
12366     * @param itc The item class for the item
12367     * @param data The item data
12368     * @param parent The parent item, or NULL if none
12369     * @param flags Item flags
12370     * @param func Convenience function called when the item is selected
12371     * @param func_data Data passed to @p func above.
12372     * @return A handle to the item added or @c NULL if not possible
12373     *
12374     * This adds the given item to the end of the list or the end of
12375     * the children list if the @p parent is given.
12376     *
12377     * @see elm_genlist_item_prepend()
12378     * @see elm_genlist_item_insert_before()
12379     * @see elm_genlist_item_insert_after()
12380     * @see elm_genlist_item_del()
12381     *
12382     * @ingroup Genlist
12383     */
12384    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);
12385    /**
12386     * Prepend a new item in a given genlist widget.
12387     *
12388     * @param obj The genlist object
12389     * @param itc The item class for the item
12390     * @param data The item data
12391     * @param parent The parent item, or NULL if none
12392     * @param flags Item flags
12393     * @param func Convenience function called when the item is selected
12394     * @param func_data Data passed to @p func above.
12395     * @return A handle to the item added or NULL if not possible
12396     *
12397     * This adds an item to the beginning of the list or beginning of the
12398     * children of the parent if given.
12399     *
12400     * @see elm_genlist_item_append()
12401     * @see elm_genlist_item_insert_before()
12402     * @see elm_genlist_item_insert_after()
12403     * @see elm_genlist_item_del()
12404     *
12405     * @ingroup Genlist
12406     */
12407    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);
12408    /**
12409     * Insert an item before another in a genlist widget
12410     *
12411     * @param obj The genlist object
12412     * @param itc The item class for the item
12413     * @param data The item data
12414     * @param before The item to place this new one before.
12415     * @param flags Item flags
12416     * @param func Convenience function called when the item is selected
12417     * @param func_data Data passed to @p func above.
12418     * @return A handle to the item added or @c NULL if not possible
12419     *
12420     * This inserts an item before another in the list. It will be in the
12421     * same tree level or group as the item it is inserted before.
12422     *
12423     * @see elm_genlist_item_append()
12424     * @see elm_genlist_item_prepend()
12425     * @see elm_genlist_item_insert_after()
12426     * @see elm_genlist_item_del()
12427     *
12428     * @ingroup Genlist
12429     */
12430    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);
12431    /**
12432     * Insert an item after another in a genlist widget
12433     *
12434     * @param obj The genlist object
12435     * @param itc The item class for the item
12436     * @param data The item data
12437     * @param after The item to place this new one after.
12438     * @param flags Item flags
12439     * @param func Convenience function called when the item is selected
12440     * @param func_data Data passed to @p func above.
12441     * @return A handle to the item added or @c NULL if not possible
12442     *
12443     * This inserts an item after another in the list. It will be in the
12444     * same tree level or group as the item it is inserted after.
12445     *
12446     * @see elm_genlist_item_append()
12447     * @see elm_genlist_item_prepend()
12448     * @see elm_genlist_item_insert_before()
12449     * @see elm_genlist_item_del()
12450     *
12451     * @ingroup Genlist
12452     */
12453    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);
12454    /**
12455     * Insert a new item into the sorted genlist object
12456     *
12457     * @param obj The genlist object
12458     * @param itc The item class for the item
12459     * @param data The item data
12460     * @param parent The parent item, or NULL if none
12461     * @param flags Item flags
12462     * @param comp The function called for the sort
12463     * @param func Convenience function called when item selected
12464     * @param func_data Data passed to @p func above.
12465     * @return A handle to the item added or NULL if not possible
12466     *
12467     * @ingroup Genlist
12468     */
12469    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);
12470    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);
12471    /* operations to retrieve existing items */
12472    /**
12473     * Get the selectd item in the genlist.
12474     *
12475     * @param obj The genlist object
12476     * @return The selected item, or NULL if none is selected.
12477     *
12478     * This gets the selected item in the list (if multi-selection is enabled, only
12479     * the item that was first selected in the list is returned - which is not very
12480     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
12481     * used).
12482     *
12483     * If no item is selected, NULL is returned.
12484     *
12485     * @see elm_genlist_selected_items_get()
12486     *
12487     * @ingroup Genlist
12488     */
12489    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12490    /**
12491     * Get a list of selected items in the genlist.
12492     *
12493     * @param obj The genlist object
12494     * @return The list of selected items, or NULL if none are selected.
12495     *
12496     * It returns a list of the selected items. This list pointer is only valid so
12497     * long as the selection doesn't change (no items are selected or unselected, or
12498     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
12499     * pointers. The order of the items in this list is the order which they were
12500     * selected, i.e. the first item in this list is the first item that was
12501     * selected, and so on.
12502     *
12503     * @note If not in multi-select mode, consider using function
12504     * elm_genlist_selected_item_get() instead.
12505     *
12506     * @see elm_genlist_multi_select_set()
12507     * @see elm_genlist_selected_item_get()
12508     *
12509     * @ingroup Genlist
12510     */
12511    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12512    /**
12513     * Get a list of realized items in genlist
12514     *
12515     * @param obj The genlist object
12516     * @return The list of realized items, nor NULL if none are realized.
12517     *
12518     * This returns a list of the realized items in the genlist. The list
12519     * contains Elm_Genlist_Item pointers. The list must be freed by the
12520     * caller when done with eina_list_free(). The item pointers in the
12521     * list are only valid so long as those items are not deleted or the
12522     * genlist is not deleted.
12523     *
12524     * @see elm_genlist_realized_items_update()
12525     *
12526     * @ingroup Genlist
12527     */
12528    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12529    /**
12530     * Get the item that is at the x, y canvas coords.
12531     *
12532     * @param obj The gelinst object.
12533     * @param x The input x coordinate
12534     * @param y The input y coordinate
12535     * @param posret The position relative to the item returned here
12536     * @return The item at the coordinates or NULL if none
12537     *
12538     * This returns the item at the given coordinates (which are canvas
12539     * relative, not object-relative). If an item is at that coordinate,
12540     * that item handle is returned, and if @p posret is not NULL, the
12541     * integer pointed to is set to a value of -1, 0 or 1, depending if
12542     * the coordinate is on the upper portion of that item (-1), on the
12543     * middle section (0) or on the lower part (1). If NULL is returned as
12544     * an item (no item found there), then posret may indicate -1 or 1
12545     * based if the coordinate is above or below all items respectively in
12546     * the genlist.
12547     *
12548     * @ingroup Genlist
12549     */
12550    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);
12551    /**
12552     * Get the first item in the genlist
12553     *
12554     * This returns the first item in the list.
12555     *
12556     * @param obj The genlist object
12557     * @return The first item, or NULL if none
12558     *
12559     * @ingroup Genlist
12560     */
12561    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12562    /**
12563     * Get the last item in the genlist
12564     *
12565     * This returns the last item in the list.
12566     *
12567     * @return The last item, or NULL if none
12568     *
12569     * @ingroup Genlist
12570     */
12571    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12572    /**
12573     * Set the scrollbar policy
12574     *
12575     * @param obj The genlist object
12576     * @param policy_h Horizontal scrollbar policy.
12577     * @param policy_v Vertical scrollbar policy.
12578     *
12579     * This sets the scrollbar visibility policy for the given genlist
12580     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
12581     * made visible if it is needed, and otherwise kept hidden.
12582     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
12583     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
12584     * respectively for the horizontal and vertical scrollbars. Default is
12585     * #ELM_SMART_SCROLLER_POLICY_AUTO
12586     *
12587     * @see elm_genlist_scroller_policy_get()
12588     *
12589     * @ingroup Genlist
12590     */
12591    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12592    /**
12593     * Get the scrollbar policy
12594     *
12595     * @param obj The genlist object
12596     * @param policy_h Pointer to store the horizontal scrollbar policy.
12597     * @param policy_v Pointer to store the vertical scrollbar policy.
12598     *
12599     * @see elm_genlist_scroller_policy_set()
12600     *
12601     * @ingroup Genlist
12602     */
12603    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);
12604    /**
12605     * Get the @b next item in a genlist widget's internal list of items,
12606     * given a handle to one of those items.
12607     *
12608     * @param item The genlist item to fetch next from
12609     * @return The item after @p item, or @c NULL if there's none (and
12610     * on errors)
12611     *
12612     * This returns the item placed after the @p item, on the container
12613     * genlist.
12614     *
12615     * @see elm_genlist_item_prev_get()
12616     *
12617     * @ingroup Genlist
12618     */
12619    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12620    /**
12621     * Get the @b previous item in a genlist widget's internal list of items,
12622     * given a handle to one of those items.
12623     *
12624     * @param item The genlist item to fetch previous from
12625     * @return The item before @p item, or @c NULL if there's none (and
12626     * on errors)
12627     *
12628     * This returns the item placed before the @p item, on the container
12629     * genlist.
12630     *
12631     * @see elm_genlist_item_next_get()
12632     *
12633     * @ingroup Genlist
12634     */
12635    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12636    /**
12637     * Get the genlist object's handle which contains a given genlist
12638     * item
12639     *
12640     * @param item The item to fetch the container from
12641     * @return The genlist (parent) object
12642     *
12643     * This returns the genlist object itself that an item belongs to.
12644     *
12645     * @ingroup Genlist
12646     */
12647    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12648    /**
12649     * Get the parent item of the given item
12650     *
12651     * @param it The item
12652     * @return The parent of the item or @c NULL if it has no parent.
12653     *
12654     * This returns the item that was specified as parent of the item @p it on
12655     * elm_genlist_item_append() and insertion related functions.
12656     *
12657     * @ingroup Genlist
12658     */
12659    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
12660    /**
12661     * Remove all sub-items (children) of the given item
12662     *
12663     * @param it The item
12664     *
12665     * This removes all items that are children (and their descendants) of the
12666     * given item @p it.
12667     *
12668     * @see elm_genlist_clear()
12669     * @see elm_genlist_item_del()
12670     *
12671     * @ingroup Genlist
12672     */
12673    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12674    /**
12675     * Set whether a given genlist item is selected or not
12676     *
12677     * @param it The item
12678     * @param selected Use @c EINA_TRUE, to make it selected, @c
12679     * EINA_FALSE to make it unselected
12680     *
12681     * This sets the selected state of an item. If multi selection is
12682     * not enabled on the containing genlist and @p selected is @c
12683     * EINA_TRUE, any other previously selected items will get
12684     * unselected in favor of this new one.
12685     *
12686     * @see elm_genlist_item_selected_get()
12687     *
12688     * @ingroup Genlist
12689     */
12690    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12691    /**
12692     * Get whether a given genlist item is selected or not
12693     *
12694     * @param it The item
12695     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
12696     *
12697     * @see elm_genlist_item_selected_set() for more details
12698     *
12699     * @ingroup Genlist
12700     */
12701    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12702    /**
12703     * Sets the expanded state of an item.
12704     *
12705     * @param it The item
12706     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
12707     *
12708     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
12709     * expanded or not.
12710     *
12711     * The theme will respond to this change visually, and a signal "expanded" or
12712     * "contracted" will be sent from the genlist with a pointer to the item that
12713     * has been expanded/contracted.
12714     *
12715     * Calling this function won't show or hide any child of this item (if it is
12716     * a parent). You must manually delete and create them on the callbacks fo
12717     * the "expanded" or "contracted" signals.
12718     *
12719     * @see elm_genlist_item_expanded_get()
12720     *
12721     * @ingroup Genlist
12722     */
12723    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
12724    /**
12725     * Get the expanded state of an item
12726     *
12727     * @param it The item
12728     * @return The expanded state
12729     *
12730     * This gets the expanded state of an item.
12731     *
12732     * @see elm_genlist_item_expanded_set()
12733     *
12734     * @ingroup Genlist
12735     */
12736    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12737    /**
12738     * Get the depth of expanded item
12739     *
12740     * @param it The genlist item object
12741     * @return The depth of expanded item
12742     *
12743     * @ingroup Genlist
12744     */
12745    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
12746    /**
12747     * Set whether a given genlist item is disabled or not.
12748     *
12749     * @param it The item
12750     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
12751     * to enable it back.
12752     *
12753     * A disabled item cannot be selected or unselected. It will also
12754     * change its appearance, to signal the user it's disabled.
12755     *
12756     * @see elm_genlist_item_disabled_get()
12757     *
12758     * @ingroup Genlist
12759     */
12760    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12761    /**
12762     * Get whether a given genlist item is disabled or not.
12763     *
12764     * @param it The item
12765     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
12766     * (and on errors).
12767     *
12768     * @see elm_genlist_item_disabled_set() for more details
12769     *
12770     * @ingroup Genlist
12771     */
12772    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12773    /**
12774     * Sets the display only state of an item.
12775     *
12776     * @param it The item
12777     * @param display_only @c EINA_TRUE if the item is display only, @c
12778     * EINA_FALSE otherwise.
12779     *
12780     * A display only item cannot be selected or unselected. It is for
12781     * display only and not selecting or otherwise clicking, dragging
12782     * etc. by the user, thus finger size rules will not be applied to
12783     * this item.
12784     *
12785     * It's good to set group index items to display only state.
12786     *
12787     * @see elm_genlist_item_display_only_get()
12788     *
12789     * @ingroup Genlist
12790     */
12791    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
12792    /**
12793     * Get the display only state of an item
12794     *
12795     * @param it The item
12796     * @return @c EINA_TRUE if the item is display only, @c
12797     * EINA_FALSE otherwise.
12798     *
12799     * @see elm_genlist_item_display_only_set()
12800     *
12801     * @ingroup Genlist
12802     */
12803    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
12804    /**
12805     * Show the portion of a genlist's internal list containing a given
12806     * item, immediately.
12807     *
12808     * @param it The item to display
12809     *
12810     * This causes genlist to jump to the given item @p it and show it (by
12811     * immediately scrolling to that position), if it is not fully visible.
12812     *
12813     * @see elm_genlist_item_bring_in()
12814     * @see elm_genlist_item_top_show()
12815     * @see elm_genlist_item_middle_show()
12816     *
12817     * @ingroup Genlist
12818     */
12819    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12820    /**
12821     * Animatedly bring in, to the visible are of a genlist, a given
12822     * item on it.
12823     *
12824     * @param it The item to display
12825     *
12826     * This causes genlist to jump to the given item @p it and show it (by
12827     * animatedly scrolling), if it is not fully visible. This may use animation
12828     * to do so and take a period of time
12829     *
12830     * @see elm_genlist_item_show()
12831     * @see elm_genlist_item_top_bring_in()
12832     * @see elm_genlist_item_middle_bring_in()
12833     *
12834     * @ingroup Genlist
12835     */
12836    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12837    /**
12838     * Show the portion of a genlist's internal list containing a given
12839     * item, immediately.
12840     *
12841     * @param it The item to display
12842     *
12843     * This causes genlist to jump to the given item @p it and show it (by
12844     * immediately scrolling to that position), if it is not fully visible.
12845     *
12846     * The item will be positioned at the top of the genlist viewport.
12847     *
12848     * @see elm_genlist_item_show()
12849     * @see elm_genlist_item_top_bring_in()
12850     *
12851     * @ingroup Genlist
12852     */
12853    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12854    /**
12855     * Animatedly bring in, to the visible are of a genlist, a given
12856     * item on it.
12857     *
12858     * @param it The item
12859     *
12860     * This causes genlist to jump to the given item @p it and show it (by
12861     * animatedly scrolling), if it is not fully visible. This may use animation
12862     * to do so and take a period of time
12863     *
12864     * The item will be positioned at the top of the genlist viewport.
12865     *
12866     * @see elm_genlist_item_bring_in()
12867     * @see elm_genlist_item_top_show()
12868     *
12869     * @ingroup Genlist
12870     */
12871    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12872    /**
12873     * Show the portion of a genlist's internal list containing a given
12874     * item, immediately.
12875     *
12876     * @param it The item to display
12877     *
12878     * This causes genlist to jump to the given item @p it and show it (by
12879     * immediately scrolling to that position), if it is not fully visible.
12880     *
12881     * The item will be positioned at the middle of the genlist viewport.
12882     *
12883     * @see elm_genlist_item_show()
12884     * @see elm_genlist_item_middle_bring_in()
12885     *
12886     * @ingroup Genlist
12887     */
12888    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
12889    /**
12890     * Animatedly bring in, to the visible are of a genlist, a given
12891     * item on it.
12892     *
12893     * @param it The item
12894     *
12895     * This causes genlist to jump to the given item @p it and show it (by
12896     * animatedly scrolling), if it is not fully visible. This may use animation
12897     * to do so and take a period of time
12898     *
12899     * The item will be positioned at the middle of the genlist viewport.
12900     *
12901     * @see elm_genlist_item_bring_in()
12902     * @see elm_genlist_item_middle_show()
12903     *
12904     * @ingroup Genlist
12905     */
12906    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
12907    /**
12908     * Remove a genlist item from the its parent, deleting it.
12909     *
12910     * @param item The item to be removed.
12911     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
12912     *
12913     * @see elm_genlist_clear(), to remove all items in a genlist at
12914     * once.
12915     *
12916     * @ingroup Genlist
12917     */
12918    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12919    /**
12920     * Return the data associated to a given genlist item
12921     *
12922     * @param item The genlist item.
12923     * @return the data associated to this item.
12924     *
12925     * This returns the @c data value passed on the
12926     * elm_genlist_item_append() and related item addition calls.
12927     *
12928     * @see elm_genlist_item_append()
12929     * @see elm_genlist_item_data_set()
12930     *
12931     * @ingroup Genlist
12932     */
12933    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
12934    /**
12935     * Set the data associated to a given genlist item
12936     *
12937     * @param item The genlist item
12938     * @param data The new data pointer to set on it
12939     *
12940     * This @b overrides the @c data value passed on the
12941     * elm_genlist_item_append() and related item addition calls. This
12942     * function @b won't call elm_genlist_item_update() automatically,
12943     * so you'd issue it afterwards if you want to hove the item
12944     * updated to reflect the that new data.
12945     *
12946     * @see elm_genlist_item_data_get()
12947     *
12948     * @ingroup Genlist
12949     */
12950    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
12951    /**
12952     * Tells genlist to "orphan" icons fetchs by the item class
12953     *
12954     * @param it The item
12955     *
12956     * This instructs genlist to release references to icons in the item,
12957     * meaning that they will no longer be managed by genlist and are
12958     * floating "orphans" that can be re-used elsewhere if the user wants
12959     * to.
12960     *
12961     * @ingroup Genlist
12962     */
12963    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
12964    /**
12965     * Get the real Evas object created to implement the view of a
12966     * given genlist item
12967     *
12968     * @param item The genlist item.
12969     * @return the Evas object implementing this item's view.
12970     *
12971     * This returns the actual Evas object used to implement the
12972     * specified genlist item's view. This may be @c NULL, as it may
12973     * not have been created or may have been deleted, at any time, by
12974     * the genlist. <b>Do not modify this object</b> (move, resize,
12975     * show, hide, etc.), as the genlist is controlling it. This
12976     * function is for querying, emitting custom signals or hooking
12977     * lower level callbacks for events on that object. Do not delete
12978     * this object under any circumstances.
12979     *
12980     * @see elm_genlist_item_data_get()
12981     *
12982     * @ingroup Genlist
12983     */
12984    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
12985    /**
12986     * Update the contents of an item
12987     *
12988     * @param it The item
12989     *
12990     * This updates an item by calling all the item class functions again
12991     * to get the icons, labels and states. Use this when the original
12992     * item data has changed and the changes are desired to be reflected.
12993     *
12994     * Use elm_genlist_realized_items_update() to update all already realized
12995     * items.
12996     *
12997     * @see elm_genlist_realized_items_update()
12998     *
12999     * @ingroup Genlist
13000     */
13001    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13002    /**
13003     * Update the item class of an item
13004     *
13005     * @param it The item
13006     * @parem itc The item class for the item
13007     *
13008     * This sets another class fo the item, changing the way that it is
13009     * displayed. After changing the item class, elm_genlist_item_update() is
13010     * called on the item @p it.
13011     *
13012     * @ingroup Genlist
13013     */
13014    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
13015    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
13016    /**
13017     * Set the text to be shown in a given genlist item's tooltips.
13018     *
13019     * @param item The genlist item
13020     * @param text The text to set in the content
13021     *
13022     * This call will setup the text to be used as tooltip to that item
13023     * (analogous to elm_object_tooltip_text_set(), but being item
13024     * tooltips with higher precedence than object tooltips). It can
13025     * have only one tooltip at a time, so any previous tooltip data
13026     * will get removed.
13027     *
13028     * In order to set an icon or something else as a tooltip, look at
13029     * elm_genlist_item_tooltip_content_cb_set().
13030     *
13031     * @ingroup Genlist
13032     */
13033    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
13034    /**
13035     * Set the content to be shown in a given genlist item's tooltips
13036     *
13037     * @param item The genlist item.
13038     * @param func The function returning the tooltip contents.
13039     * @param data What to provide to @a func as callback data/context.
13040     * @param del_cb Called when data is not needed anymore, either when
13041     *        another callback replaces @func, the tooltip is unset with
13042     *        elm_genlist_item_tooltip_unset() or the owner @p item
13043     *        dies. This callback receives as its first parameter the
13044     *        given @p data, being @c event_info the item handle.
13045     *
13046     * This call will setup the tooltip's contents to @p item
13047     * (analogous to elm_object_tooltip_content_cb_set(), but being
13048     * item tooltips with higher precedence than object tooltips). It
13049     * can have only one tooltip at a time, so any previous tooltip
13050     * content will get removed. @p func (with @p data) will be called
13051     * every time Elementary needs to show the tooltip and it should
13052     * return a valid Evas object, which will be fully managed by the
13053     * tooltip system, getting deleted when the tooltip is gone.
13054     *
13055     * In order to set just a text as a tooltip, look at
13056     * elm_genlist_item_tooltip_text_set().
13057     *
13058     * @ingroup Genlist
13059     */
13060    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);
13061    /**
13062     * Unset a tooltip from a given genlist item
13063     *
13064     * @param item genlist item to remove a previously set tooltip from.
13065     *
13066     * This call removes any tooltip set on @p item. The callback
13067     * provided as @c del_cb to
13068     * elm_genlist_item_tooltip_content_cb_set() will be called to
13069     * notify it is not used anymore (and have resources cleaned, if
13070     * need be).
13071     *
13072     * @see elm_genlist_item_tooltip_content_cb_set()
13073     *
13074     * @ingroup Genlist
13075     */
13076    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13077    /**
13078     * Set a different @b style for a given genlist item's tooltip.
13079     *
13080     * @param item genlist item with tooltip set
13081     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
13082     * "default", @c "transparent", etc)
13083     *
13084     * Tooltips can have <b>alternate styles</b> to be displayed on,
13085     * which are defined by the theme set on Elementary. This function
13086     * works analogously as elm_object_tooltip_style_set(), but here
13087     * applied only to genlist item objects. The default style for
13088     * tooltips is @c "default".
13089     *
13090     * @note before you set a style you should define a tooltip with
13091     *       elm_genlist_item_tooltip_content_cb_set() or
13092     *       elm_genlist_item_tooltip_text_set()
13093     *
13094     * @see elm_genlist_item_tooltip_style_get()
13095     *
13096     * @ingroup Genlist
13097     */
13098    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
13099    /**
13100     * Get the style set a given genlist item's tooltip.
13101     *
13102     * @param item genlist item with tooltip already set on.
13103     * @return style the theme style in use, which defaults to
13104     *         "default". If the object does not have a tooltip set,
13105     *         then @c NULL is returned.
13106     *
13107     * @see elm_genlist_item_tooltip_style_set() for more details
13108     *
13109     * @ingroup Genlist
13110     */
13111    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13112    /**
13113     * @brief Disable size restrictions on an object's tooltip
13114     * @param item The tooltip's anchor object
13115     * @param disable If EINA_TRUE, size restrictions are disabled
13116     * @return EINA_FALSE on failure, EINA_TRUE on success
13117     *
13118     * This function allows a tooltip to expand beyond its parant window's canvas.
13119     * It will instead be limited only by the size of the display.
13120     */
13121    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
13122    /**
13123     * @brief Retrieve size restriction state of an object's tooltip
13124     * @param item The tooltip's anchor object
13125     * @return If EINA_TRUE, size restrictions are disabled
13126     *
13127     * This function returns whether a tooltip is allowed to expand beyond
13128     * its parant window's canvas.
13129     * It will instead be limited only by the size of the display.
13130     */
13131    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
13132    /**
13133     * Set the type of mouse pointer/cursor decoration to be shown,
13134     * when the mouse pointer is over the given genlist widget item
13135     *
13136     * @param item genlist item to customize cursor on
13137     * @param cursor the cursor type's name
13138     *
13139     * This function works analogously as elm_object_cursor_set(), but
13140     * here the cursor's changing area is restricted to the item's
13141     * area, and not the whole widget's. Note that that item cursors
13142     * have precedence over widget cursors, so that a mouse over @p
13143     * item will always show cursor @p type.
13144     *
13145     * If this function is called twice for an object, a previously set
13146     * cursor will be unset on the second call.
13147     *
13148     * @see elm_object_cursor_set()
13149     * @see elm_genlist_item_cursor_get()
13150     * @see elm_genlist_item_cursor_unset()
13151     *
13152     * @ingroup Genlist
13153     */
13154    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13155    /**
13156     * Get the type of mouse pointer/cursor decoration set to be shown,
13157     * when the mouse pointer is over the given genlist widget item
13158     *
13159     * @param item genlist item with custom cursor set
13160     * @return the cursor type's name or @c NULL, if no custom cursors
13161     * were set to @p item (and on errors)
13162     *
13163     * @see elm_object_cursor_get()
13164     * @see elm_genlist_item_cursor_set() for more details
13165     * @see elm_genlist_item_cursor_unset()
13166     *
13167     * @ingroup Genlist
13168     */
13169    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13170    /**
13171     * Unset any custom mouse pointer/cursor decoration set to be
13172     * shown, when the mouse pointer is over the given genlist widget
13173     * item, thus making it show the @b default cursor again.
13174     *
13175     * @param item a genlist item
13176     *
13177     * Use this call to undo any custom settings on this item's cursor
13178     * decoration, bringing it back to defaults (no custom style set).
13179     *
13180     * @see elm_object_cursor_unset()
13181     * @see elm_genlist_item_cursor_set() for more details
13182     *
13183     * @ingroup Genlist
13184     */
13185    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13186    /**
13187     * Set a different @b style for a given custom cursor set for a
13188     * genlist item.
13189     *
13190     * @param item genlist item with custom cursor set
13191     * @param style the <b>theme style</b> to use (e.g. @c "default",
13192     * @c "transparent", etc)
13193     *
13194     * This function only makes sense when one is using custom mouse
13195     * cursor decorations <b>defined in a theme file</b> , which can
13196     * have, given a cursor name/type, <b>alternate styles</b> on
13197     * it. It works analogously as elm_object_cursor_style_set(), but
13198     * here applied only to genlist item objects.
13199     *
13200     * @warning Before you set a cursor style you should have defined a
13201     *       custom cursor previously on the item, with
13202     *       elm_genlist_item_cursor_set()
13203     *
13204     * @see elm_genlist_item_cursor_engine_only_set()
13205     * @see elm_genlist_item_cursor_style_get()
13206     *
13207     * @ingroup Genlist
13208     */
13209    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
13210    /**
13211     * Get the current @b style set for a given genlist item's custom
13212     * cursor
13213     *
13214     * @param item genlist item with custom cursor set.
13215     * @return style the cursor style in use. If the object does not
13216     *         have a cursor set, then @c NULL is returned.
13217     *
13218     * @see elm_genlist_item_cursor_style_set() for more details
13219     *
13220     * @ingroup Genlist
13221     */
13222    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13223    /**
13224     * Set if the (custom) cursor for a given genlist item should be
13225     * searched in its theme, also, or should only rely on the
13226     * rendering engine.
13227     *
13228     * @param item item with custom (custom) cursor already set on
13229     * @param engine_only Use @c EINA_TRUE to have cursors looked for
13230     * only on those provided by the rendering engine, @c EINA_FALSE to
13231     * have them searched on the widget's theme, as well.
13232     *
13233     * @note This call is of use only if you've set a custom cursor
13234     * for genlist items, with elm_genlist_item_cursor_set().
13235     *
13236     * @note By default, cursors will only be looked for between those
13237     * provided by the rendering engine.
13238     *
13239     * @ingroup Genlist
13240     */
13241    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13242    /**
13243     * Get if the (custom) cursor for a given genlist item is being
13244     * searched in its theme, also, or is only relying on the rendering
13245     * engine.
13246     *
13247     * @param item a genlist item
13248     * @return @c EINA_TRUE, if cursors are being looked for only on
13249     * those provided by the rendering engine, @c EINA_FALSE if they
13250     * are being searched on the widget's theme, as well.
13251     *
13252     * @see elm_genlist_item_cursor_engine_only_set(), for more details
13253     *
13254     * @ingroup Genlist
13255     */
13256    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13257    /**
13258     * Update the contents of all realized items.
13259     *
13260     * @param obj The genlist object.
13261     *
13262     * This updates all realized items by calling all the item class functions again
13263     * to get the icons, labels and states. Use this when the original
13264     * item data has changed and the changes are desired to be reflected.
13265     *
13266     * To update just one item, use elm_genlist_item_update().
13267     *
13268     * @see elm_genlist_realized_items_get()
13269     * @see elm_genlist_item_update()
13270     *
13271     * @ingroup Genlist
13272     */
13273    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
13274    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
13275    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13276    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13277    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
13278    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13279
13280    /**
13281     * @}
13282     */
13283
13284    /**
13285     * @defgroup Check Check
13286     *
13287     * @image html img/widget/button/preview-00.png
13288     * @image html img/widget/button/preview-01.png
13289     * @image html img/widget/button/preview-02.png
13290     *
13291     * @brief The check widget allows for toggling a value between true and
13292     * false.
13293     *
13294     * Check objects are a lot like radio objects in layout and functionality
13295     * except they do not work as a group, but independently and only toggle the
13296     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
13297     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
13298     * returns the current state. For convenience, like the radio objects, you
13299     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
13300     * for it to modify.
13301     *
13302     * Signals that you can add callbacks for are:
13303     * "changed" - This is called whenever the user changes the state of one of
13304     *             the check object(event_info is NULL).
13305     *
13306     * @ref tutorial_check should give you a firm grasp of how to use this widget.
13307     * @{
13308     */
13309    /**
13310     * @brief Add a new Check object
13311     *
13312     * @param parent The parent object
13313     * @return The new object or NULL if it cannot be created
13314     */
13315    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13316    /**
13317     * @brief Set the text label of the check object
13318     *
13319     * @param obj The check object
13320     * @param label The text label string in UTF-8
13321     *
13322     * @deprecated use elm_object_text_set() instead.
13323     */
13324    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13325    /**
13326     * @brief Get the text label of the check object
13327     *
13328     * @param obj The check object
13329     * @return The text label string in UTF-8
13330     *
13331     * @deprecated use elm_object_text_get() instead.
13332     */
13333    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13334    /**
13335     * @brief Set the icon object of the check object
13336     *
13337     * @param obj The check object
13338     * @param icon The icon object
13339     *
13340     * Once the icon object is set, a previously set one will be deleted.
13341     * If you want to keep that old content object, use the
13342     * elm_check_icon_unset() function.
13343     */
13344    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13345    /**
13346     * @brief Get the icon object of the check object
13347     *
13348     * @param obj The check object
13349     * @return The icon object
13350     */
13351    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13352    /**
13353     * @brief Unset the icon used for the check object
13354     *
13355     * @param obj The check object
13356     * @return The icon object that was being used
13357     *
13358     * Unparent and return the icon object which was set for this widget.
13359     */
13360    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13361    /**
13362     * @brief Set the on/off state of the check object
13363     *
13364     * @param obj The check object
13365     * @param state The state to use (1 == on, 0 == off)
13366     *
13367     * This sets the state of the check. If set
13368     * with elm_check_state_pointer_set() the state of that variable is also
13369     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
13370     */
13371    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
13372    /**
13373     * @brief Get the state of the check object
13374     *
13375     * @param obj The check object
13376     * @return The boolean state
13377     */
13378    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13379    /**
13380     * @brief Set a convenience pointer to a boolean to change
13381     *
13382     * @param obj The check object
13383     * @param statep Pointer to the boolean to modify
13384     *
13385     * This sets a pointer to a boolean, that, in addition to the check objects
13386     * state will also be modified directly. To stop setting the object pointed
13387     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
13388     * then when this is called, the check objects state will also be modified to
13389     * reflect the value of the boolean @p statep points to, just like calling
13390     * elm_check_state_set().
13391     */
13392    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
13393    /**
13394     * @}
13395     */
13396
13397    /**
13398     * @defgroup Radio Radio
13399     *
13400     * @image html img/widget/radio/preview-00.png
13401     * @image latex img/widget/radio/preview-00.eps
13402     *
13403     * @brief Radio is a widget that allows for 1 or more options to be displayed
13404     * and have the user choose only 1 of them.
13405     *
13406     * A radio object contains an indicator, an optional Label and an optional
13407     * icon object. While it's possible to have a group of only one radio they,
13408     * are normally used in groups of 2 or more. To add a radio to a group use
13409     * elm_radio_group_add(). The radio object(s) will select from one of a set
13410     * of integer values, so any value they are configuring needs to be mapped to
13411     * a set of integers. To configure what value that radio object represents,
13412     * use  elm_radio_state_value_set() to set the integer it represents. To set
13413     * the value the whole group(which one is currently selected) is to indicate
13414     * use elm_radio_value_set() on any group member, and to get the groups value
13415     * use elm_radio_value_get(). For convenience the radio objects are also able
13416     * to directly set an integer(int) to the value that is selected. To specify
13417     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
13418     * The radio objects will modify this directly. That implies the pointer must
13419     * point to valid memory for as long as the radio objects exist.
13420     *
13421     * Signals that you can add callbacks for are:
13422     * @li changed - This is called whenever the user changes the state of one of
13423     * the radio objects within the group of radio objects that work together.
13424     *
13425     * @ref tutorial_radio show most of this API in action.
13426     * @{
13427     */
13428    /**
13429     * @brief Add a new radio to the parent
13430     *
13431     * @param parent The parent object
13432     * @return The new object or NULL if it cannot be created
13433     */
13434    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13435    /**
13436     * @brief Set the text label of the radio object
13437     *
13438     * @param obj The radio object
13439     * @param label The text label string in UTF-8
13440     *
13441     * @deprecated use elm_object_text_set() instead.
13442     */
13443    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13444    /**
13445     * @brief Get the text label of the radio object
13446     *
13447     * @param obj The radio object
13448     * @return The text label string in UTF-8
13449     *
13450     * @deprecated use elm_object_text_set() instead.
13451     */
13452    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13453    /**
13454     * @brief Set the icon object of the radio object
13455     *
13456     * @param obj The radio object
13457     * @param icon The icon object
13458     *
13459     * Once the icon object is set, a previously set one will be deleted. If you
13460     * want to keep that old content object, use the elm_radio_icon_unset()
13461     * function.
13462     */
13463    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13464    /**
13465     * @brief Get the icon object of the radio object
13466     *
13467     * @param obj The radio object
13468     * @return The icon object
13469     *
13470     * @see elm_radio_icon_set()
13471     */
13472    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13473    /**
13474     * @brief Unset the icon used for the radio object
13475     *
13476     * @param obj The radio object
13477     * @return The icon object that was being used
13478     *
13479     * Unparent and return the icon object which was set for this widget.
13480     *
13481     * @see elm_radio_icon_set()
13482     */
13483    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13484    /**
13485     * @brief Add this radio to a group of other radio objects
13486     *
13487     * @param obj The radio object
13488     * @param group Any object whose group the @p obj is to join.
13489     *
13490     * Radio objects work in groups. Each member should have a different integer
13491     * value assigned. In order to have them work as a group, they need to know
13492     * about each other. This adds the given radio object to the group of which
13493     * the group object indicated is a member.
13494     */
13495    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
13496    /**
13497     * @brief Set the integer value that this radio object represents
13498     *
13499     * @param obj The radio object
13500     * @param value The value to use if this radio object is selected
13501     *
13502     * This sets the value of the radio.
13503     */
13504    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
13505    /**
13506     * @brief Get the integer value that this radio object represents
13507     *
13508     * @param obj The radio object
13509     * @return The value used if this radio object is selected
13510     *
13511     * This gets the value of the radio.
13512     *
13513     * @see elm_radio_value_set()
13514     */
13515    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13516    /**
13517     * @brief Set the value of the radio.
13518     *
13519     * @param obj The radio object
13520     * @param value The value to use for the group
13521     *
13522     * This sets the value of the radio group and will also set the value if
13523     * pointed to, to the value supplied, but will not call any callbacks.
13524     */
13525    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
13526    /**
13527     * @brief Get the state of the radio object
13528     *
13529     * @param obj The radio object
13530     * @return The integer state
13531     */
13532    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13533    /**
13534     * @brief Set a convenience pointer to a integer to change
13535     *
13536     * @param obj The radio object
13537     * @param valuep Pointer to the integer to modify
13538     *
13539     * This sets a pointer to a integer, that, in addition to the radio objects
13540     * state will also be modified directly. To stop setting the object pointed
13541     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
13542     * when this is called, the radio objects state will also be modified to
13543     * reflect the value of the integer valuep points to, just like calling
13544     * elm_radio_value_set().
13545     */
13546    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
13547    /**
13548     * @}
13549     */
13550
13551    /**
13552     * @defgroup Pager Pager
13553     *
13554     * @image html img/widget/pager/preview-00.png
13555     * @image latex img/widget/pager/preview-00.eps
13556     *
13557     * @brief Widget that allows flipping between 1 or more “pages” of objects.
13558     *
13559     * The flipping between “pages” of objects is animated. All content in pager
13560     * is kept in a stack, the last content to be added will be on the top of the
13561     * stack(be visible).
13562     *
13563     * Objects can be pushed or popped from the stack or deleted as normal.
13564     * Pushes and pops will animate (and a pop will delete the object once the
13565     * animation is finished). Any object already in the pager can be promoted to
13566     * the top(from its current stacking position) through the use of
13567     * elm_pager_content_promote(). Objects are pushed to the top with
13568     * elm_pager_content_push() and when the top item is no longer wanted, simply
13569     * pop it with elm_pager_content_pop() and it will also be deleted. If an
13570     * object is no longer needed and is not the top item, just delete it as
13571     * normal. You can query which objects are the top and bottom with
13572     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
13573     *
13574     * Signals that you can add callbacks for are:
13575     * "hide,finished" - when the previous page is hided
13576     *
13577     * This widget has the following styles available:
13578     * @li default
13579     * @li fade
13580     * @li fade_translucide
13581     * @li fade_invisible
13582     * @note This styles affect only the flipping animations, the appearance when
13583     * not animating is unaffected by styles.
13584     *
13585     * @ref tutorial_pager gives a good overview of the usage of the API.
13586     * @{
13587     */
13588    /**
13589     * Add a new pager to the parent
13590     *
13591     * @param parent The parent object
13592     * @return The new object or NULL if it cannot be created
13593     *
13594     * @ingroup Pager
13595     */
13596    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13597    /**
13598     * @brief Push an object to the top of the pager stack (and show it).
13599     *
13600     * @param obj The pager object
13601     * @param content The object to push
13602     *
13603     * The object pushed becomes a child of the pager, it will be controlled and
13604     * deleted when the pager is deleted.
13605     *
13606     * @note If the content is already in the stack use
13607     * elm_pager_content_promote().
13608     * @warning Using this function on @p content already in the stack results in
13609     * undefined behavior.
13610     */
13611    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13612    /**
13613     * @brief Pop the object that is on top of the stack
13614     *
13615     * @param obj The pager object
13616     *
13617     * This pops the object that is on the top(visible) of the pager, makes it
13618     * disappear, then deletes the object. The object that was underneath it on
13619     * the stack will become visible.
13620     */
13621    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
13622    /**
13623     * @brief Moves an object already in the pager stack to the top of the stack.
13624     *
13625     * @param obj The pager object
13626     * @param content The object to promote
13627     *
13628     * This will take the @p content and move it to the top of the stack as
13629     * if it had been pushed there.
13630     *
13631     * @note If the content isn't already in the stack use
13632     * elm_pager_content_push().
13633     * @warning Using this function on @p content not already in the stack
13634     * results in undefined behavior.
13635     */
13636    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13637    /**
13638     * @brief Return the object at the bottom of the pager stack
13639     *
13640     * @param obj The pager object
13641     * @return The bottom object or NULL if none
13642     */
13643    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13644    /**
13645     * @brief  Return the object at the top of the pager stack
13646     *
13647     * @param obj The pager object
13648     * @return The top object or NULL if none
13649     */
13650    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13651    /**
13652     * @}
13653     */
13654
13655    /**
13656     * @defgroup Slideshow Slideshow
13657     *
13658     * @image html img/widget/slideshow/preview-00.png
13659     * @image latex img/widget/slideshow/preview-00.eps
13660     *
13661     * This widget, as the name indicates, is a pre-made image
13662     * slideshow panel, with API functions acting on (child) image
13663     * items presentation. Between those actions, are:
13664     * - advance to next/previous image
13665     * - select the style of image transition animation
13666     * - set the exhibition time for each image
13667     * - start/stop the slideshow
13668     *
13669     * The transition animations are defined in the widget's theme,
13670     * consequently new animations can be added without having to
13671     * update the widget's code.
13672     *
13673     * @section Slideshow_Items Slideshow items
13674     *
13675     * For slideshow items, just like for @ref Genlist "genlist" ones,
13676     * the user defines a @b classes, specifying functions that will be
13677     * called on the item's creation and deletion times.
13678     *
13679     * The #Elm_Slideshow_Item_Class structure contains the following
13680     * members:
13681     *
13682     * - @c func.get - When an item is displayed, this function is
13683     *   called, and it's where one should create the item object, de
13684     *   facto. For example, the object can be a pure Evas image object
13685     *   or an Elementary @ref Photocam "photocam" widget. See
13686     *   #SlideshowItemGetFunc.
13687     * - @c func.del - When an item is no more displayed, this function
13688     *   is called, where the user must delete any data associated to
13689     *   the item. See #SlideshowItemDelFunc.
13690     *
13691     * @section Slideshow_Caching Slideshow caching
13692     *
13693     * The slideshow provides facilities to have items adjacent to the
13694     * one being displayed <b>already "realized"</b> (i.e. loaded) for
13695     * you, so that the system does not have to decode image data
13696     * anymore at the time it has to actually switch images on its
13697     * viewport. The user is able to set the numbers of items to be
13698     * cached @b before and @b after the current item, in the widget's
13699     * item list.
13700     *
13701     * Smart events one can add callbacks for are:
13702     *
13703     * - @c "changed" - when the slideshow switches its view to a new
13704     *   item
13705     *
13706     * List of examples for the slideshow widget:
13707     * @li @ref slideshow_example
13708     */
13709
13710    /**
13711     * @addtogroup Slideshow
13712     * @{
13713     */
13714
13715    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
13716    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
13717    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
13718    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
13719    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
13720
13721    /**
13722     * @struct _Elm_Slideshow_Item_Class
13723     *
13724     * Slideshow item class definition. See @ref Slideshow_Items for
13725     * field details.
13726     */
13727    struct _Elm_Slideshow_Item_Class
13728      {
13729         struct _Elm_Slideshow_Item_Class_Func
13730           {
13731              SlideshowItemGetFunc get;
13732              SlideshowItemDelFunc del;
13733           } func;
13734      }; /**< #Elm_Slideshow_Item_Class member definitions */
13735
13736    /**
13737     * Add a new slideshow widget to the given parent Elementary
13738     * (container) object
13739     *
13740     * @param parent The parent object
13741     * @return A new slideshow widget handle or @c NULL, on errors
13742     *
13743     * This function inserts a new slideshow widget on the canvas.
13744     *
13745     * @ingroup Slideshow
13746     */
13747    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13748
13749    /**
13750     * Add (append) a new item in a given slideshow widget.
13751     *
13752     * @param obj The slideshow object
13753     * @aram itc The item class for the item
13754     * @param data The item's data
13755     * @return A handle to the item added or @c NULL, on errors
13756     *
13757     * Add a new item to @p obj's internal list of items, appending it.
13758     * The item's class must contain the function really fetching the
13759     * image object to show for this item, which could be an Evas image
13760     * object or an Elementary photo, for example. The @p data
13761     * parameter is going to be passed to both class functions of the
13762     * item.
13763     *
13764     * @see #Elm_Slideshow_Item_Class
13765     * @see elm_slideshow_item_sorted_insert()
13766     *
13767     * @ingroup Slideshow
13768     */
13769    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
13770
13771    /**
13772     * Insert a new item into the given slideshow widget, using the @p func
13773     * function to sort items (by item handles).
13774     *
13775     * @param obj The slideshow object
13776     * @aram itc The item class for the item
13777     * @param data The item's data
13778     * @param func The comparing function to be used to sort slideshow
13779     * items <b>by #Elm_Slideshow_Item item handles</b>
13780     * @return Returns The slideshow item handle, on success, or
13781     * @c NULL, on errors
13782     *
13783     * Add a new item to @p obj's internal list of items, in a position
13784     * determined by the @p func comparing function. The item's class
13785     * must contain the function really fetching the image object to
13786     * show for this item, which could be an Evas image object or an
13787     * Elementary photo, for example. The @p data parameter is going to
13788     * be passed to both class functions of the item.
13789     *
13790     * @see #Elm_Slideshow_Item_Class
13791     * @see elm_slideshow_item_add()
13792     *
13793     * @ingroup Slideshow
13794     */
13795    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);
13796
13797    /**
13798     * Display a given slideshow widget's item, programmatically.
13799     *
13800     * @param obj The slideshow object
13801     * @param item The item to display on @p obj's viewport
13802     *
13803     * The change between the current item and @p item will use the
13804     * transition @p obj is set to use (@see
13805     * elm_slideshow_transition_set()).
13806     *
13807     * @ingroup Slideshow
13808     */
13809    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
13810
13811    /**
13812     * Slide to the @b next item, in a given slideshow widget
13813     *
13814     * @param obj The slideshow object
13815     *
13816     * The sliding animation @p obj is set to use will be the
13817     * transition effect used, after this call is issued.
13818     *
13819     * @note If the end of the slideshow's internal list of items is
13820     * reached, it'll wrap around to the list's beginning, again.
13821     *
13822     * @ingroup Slideshow
13823     */
13824    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
13825
13826    /**
13827     * Slide to the @b previous item, in a given slideshow widget
13828     *
13829     * @param obj The slideshow object
13830     *
13831     * The sliding animation @p obj is set to use will be the
13832     * transition effect used, after this call is issued.
13833     *
13834     * @note If the beginning of the slideshow's internal list of items
13835     * is reached, it'll wrap around to the list's end, again.
13836     *
13837     * @ingroup Slideshow
13838     */
13839    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
13840
13841    /**
13842     * Returns the list of sliding transition/effect names available, for a
13843     * given slideshow widget.
13844     *
13845     * @param obj The slideshow object
13846     * @return The list of transitions (list of @b stringshared strings
13847     * as data)
13848     *
13849     * The transitions, which come from @p obj's theme, must be an EDC
13850     * data item named @c "transitions" on the theme file, with (prefix)
13851     * names of EDC programs actually implementing them.
13852     *
13853     * The available transitions for slideshows on the default theme are:
13854     * - @c "fade" - the current item fades out, while the new one
13855     *   fades in to the slideshow's viewport.
13856     * - @c "black_fade" - the current item fades to black, and just
13857     *   then, the new item will fade in.
13858     * - @c "horizontal" - the current item slides horizontally, until
13859     *   it gets out of the slideshow's viewport, while the new item
13860     *   comes from the left to take its place.
13861     * - @c "vertical" - the current item slides vertically, until it
13862     *   gets out of the slideshow's viewport, while the new item comes
13863     *   from the bottom to take its place.
13864     * - @c "square" - the new item starts to appear from the middle of
13865     *   the current one, but with a tiny size, growing until its
13866     *   target (full) size and covering the old one.
13867     *
13868     * @warning The stringshared strings get no new references
13869     * exclusive to the user grabbing the list, here, so if you'd like
13870     * to use them out of this call's context, you'd better @c
13871     * eina_stringshare_ref() them.
13872     *
13873     * @see elm_slideshow_transition_set()
13874     *
13875     * @ingroup Slideshow
13876     */
13877    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13878
13879    /**
13880     * Set the current slide transition/effect in use for a given
13881     * slideshow widget
13882     *
13883     * @param obj The slideshow object
13884     * @param transition The new transition's name string
13885     *
13886     * If @p transition is implemented in @p obj's theme (i.e., is
13887     * contained in the list returned by
13888     * elm_slideshow_transitions_get()), this new sliding effect will
13889     * be used on the widget.
13890     *
13891     * @see elm_slideshow_transitions_get() for more details
13892     *
13893     * @ingroup Slideshow
13894     */
13895    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
13896
13897    /**
13898     * Get the current slide transition/effect in use for a given
13899     * slideshow widget
13900     *
13901     * @param obj The slideshow object
13902     * @return The current transition's name
13903     *
13904     * @see elm_slideshow_transition_set() for more details
13905     *
13906     * @ingroup Slideshow
13907     */
13908    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13909
13910    /**
13911     * Set the interval between each image transition on a given
13912     * slideshow widget, <b>and start the slideshow, itself</b>
13913     *
13914     * @param obj The slideshow object
13915     * @param timeout The new displaying timeout for images
13916     *
13917     * After this call, the slideshow widget will start cycling its
13918     * view, sequentially and automatically, with the images of the
13919     * items it has. The time between each new image displayed is going
13920     * to be @p timeout, in @b seconds. If a different timeout was set
13921     * previously and an slideshow was in progress, it will continue
13922     * with the new time between transitions, after this call.
13923     *
13924     * @note A value less than or equal to 0 on @p timeout will disable
13925     * the widget's internal timer, thus halting any slideshow which
13926     * could be happening on @p obj.
13927     *
13928     * @see elm_slideshow_timeout_get()
13929     *
13930     * @ingroup Slideshow
13931     */
13932    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
13933
13934    /**
13935     * Get the interval set for image transitions on a given slideshow
13936     * widget.
13937     *
13938     * @param obj The slideshow object
13939     * @return Returns the timeout set on it
13940     *
13941     * @see elm_slideshow_timeout_set() for more details
13942     *
13943     * @ingroup Slideshow
13944     */
13945    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13946
13947    /**
13948     * Set if, after a slideshow is started, for a given slideshow
13949     * widget, its items should be displayed cyclically or not.
13950     *
13951     * @param obj The slideshow object
13952     * @param loop Use @c EINA_TRUE to make it cycle through items or
13953     * @c EINA_FALSE for it to stop at the end of @p obj's internal
13954     * list of items
13955     *
13956     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
13957     * ignore what is set by this functions, i.e., they'll @b always
13958     * cycle through items. This affects only the "automatic"
13959     * slideshow, as set by elm_slideshow_timeout_set().
13960     *
13961     * @see elm_slideshow_loop_get()
13962     *
13963     * @ingroup Slideshow
13964     */
13965    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
13966
13967    /**
13968     * Get if, after a slideshow is started, for a given slideshow
13969     * widget, its items are to be displayed cyclically or not.
13970     *
13971     * @param obj The slideshow object
13972     * @return @c EINA_TRUE, if the items in @p obj will be cycled
13973     * through or @c EINA_FALSE, otherwise
13974     *
13975     * @see elm_slideshow_loop_set() for more details
13976     *
13977     * @ingroup Slideshow
13978     */
13979    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13980
13981    /**
13982     * Remove all items from a given slideshow widget
13983     *
13984     * @param obj The slideshow object
13985     *
13986     * This removes (and deletes) all items in @p obj, leaving it
13987     * empty.
13988     *
13989     * @see elm_slideshow_item_del(), to remove just one item.
13990     *
13991     * @ingroup Slideshow
13992     */
13993    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13994
13995    /**
13996     * Get the internal list of items in a given slideshow widget.
13997     *
13998     * @param obj The slideshow object
13999     * @return The list of items (#Elm_Slideshow_Item as data) or
14000     * @c NULL on errors.
14001     *
14002     * This list is @b not to be modified in any way and must not be
14003     * freed. Use the list members with functions like
14004     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
14005     *
14006     * @warning This list is only valid until @p obj object's internal
14007     * items list is changed. It should be fetched again with another
14008     * call to this function when changes happen.
14009     *
14010     * @ingroup Slideshow
14011     */
14012    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14013
14014    /**
14015     * Delete a given item from a slideshow widget.
14016     *
14017     * @param item The slideshow item
14018     *
14019     * @ingroup Slideshow
14020     */
14021    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
14022
14023    /**
14024     * Return the data associated with a given slideshow item
14025     *
14026     * @param item The slideshow item
14027     * @return Returns the data associated to this item
14028     *
14029     * @ingroup Slideshow
14030     */
14031    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
14032
14033    /**
14034     * Returns the currently displayed item, in a given slideshow widget
14035     *
14036     * @param obj The slideshow object
14037     * @return A handle to the item being displayed in @p obj or
14038     * @c NULL, if none is (and on errors)
14039     *
14040     * @ingroup Slideshow
14041     */
14042    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14043
14044    /**
14045     * Get the real Evas object created to implement the view of a
14046     * given slideshow item
14047     *
14048     * @param item The slideshow item.
14049     * @return the Evas object implementing this item's view.
14050     *
14051     * This returns the actual Evas object used to implement the
14052     * specified slideshow item's view. This may be @c NULL, as it may
14053     * not have been created or may have been deleted, at any time, by
14054     * the slideshow. <b>Do not modify this object</b> (move, resize,
14055     * show, hide, etc.), as the slideshow is controlling it. This
14056     * function is for querying, emitting custom signals or hooking
14057     * lower level callbacks for events on that object. Do not delete
14058     * this object under any circumstances.
14059     *
14060     * @see elm_slideshow_item_data_get()
14061     *
14062     * @ingroup Slideshow
14063     */
14064    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
14065
14066    /**
14067     * Get the the item, in a given slideshow widget, placed at
14068     * position @p nth, in its internal items list
14069     *
14070     * @param obj The slideshow object
14071     * @param nth The number of the item to grab a handle to (0 being
14072     * the first)
14073     * @return The item stored in @p obj at position @p nth or @c NULL,
14074     * if there's no item with that index (and on errors)
14075     *
14076     * @ingroup Slideshow
14077     */
14078    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
14079
14080    /**
14081     * Set the current slide layout in use for a given slideshow widget
14082     *
14083     * @param obj The slideshow object
14084     * @param layout The new layout's name string
14085     *
14086     * If @p layout is implemented in @p obj's theme (i.e., is contained
14087     * in the list returned by elm_slideshow_layouts_get()), this new
14088     * images layout will be used on the widget.
14089     *
14090     * @see elm_slideshow_layouts_get() for more details
14091     *
14092     * @ingroup Slideshow
14093     */
14094    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
14095
14096    /**
14097     * Get the current slide layout in use for a given slideshow widget
14098     *
14099     * @param obj The slideshow object
14100     * @return The current layout's name
14101     *
14102     * @see elm_slideshow_layout_set() for more details
14103     *
14104     * @ingroup Slideshow
14105     */
14106    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14107
14108    /**
14109     * Returns the list of @b layout names available, for a given
14110     * slideshow widget.
14111     *
14112     * @param obj The slideshow object
14113     * @return The list of layouts (list of @b stringshared strings
14114     * as data)
14115     *
14116     * Slideshow layouts will change how the widget is to dispose each
14117     * image item in its viewport, with regard to cropping, scaling,
14118     * etc.
14119     *
14120     * The layouts, which come from @p obj's theme, must be an EDC
14121     * data item name @c "layouts" on the theme file, with (prefix)
14122     * names of EDC programs actually implementing them.
14123     *
14124     * The available layouts for slideshows on the default theme are:
14125     * - @c "fullscreen" - item images with original aspect, scaled to
14126     *   touch top and down slideshow borders or, if the image's heigh
14127     *   is not enough, left and right slideshow borders.
14128     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
14129     *   one, but always leaving 10% of the slideshow's dimensions of
14130     *   distance between the item image's borders and the slideshow
14131     *   borders, for each axis.
14132     *
14133     * @warning The stringshared strings get no new references
14134     * exclusive to the user grabbing the list, here, so if you'd like
14135     * to use them out of this call's context, you'd better @c
14136     * eina_stringshare_ref() them.
14137     *
14138     * @see elm_slideshow_layout_set()
14139     *
14140     * @ingroup Slideshow
14141     */
14142    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14143
14144    /**
14145     * Set the number of items to cache, on a given slideshow widget,
14146     * <b>before the current item</b>
14147     *
14148     * @param obj The slideshow object
14149     * @param count Number of items to cache before the current one
14150     *
14151     * The default value for this property is @c 2. See
14152     * @ref Slideshow_Caching "slideshow caching" for more details.
14153     *
14154     * @see elm_slideshow_cache_before_get()
14155     *
14156     * @ingroup Slideshow
14157     */
14158    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
14159
14160    /**
14161     * Retrieve the number of items to cache, on a given slideshow widget,
14162     * <b>before the current item</b>
14163     *
14164     * @param obj The slideshow object
14165     * @return The number of items set to be cached before the current one
14166     *
14167     * @see elm_slideshow_cache_before_set() for more details
14168     *
14169     * @ingroup Slideshow
14170     */
14171    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14172
14173    /**
14174     * Set the number of items to cache, on a given slideshow widget,
14175     * <b>after the current item</b>
14176     *
14177     * @param obj The slideshow object
14178     * @param count Number of items to cache after the current one
14179     *
14180     * The default value for this property is @c 2. See
14181     * @ref Slideshow_Caching "slideshow caching" for more details.
14182     *
14183     * @see elm_slideshow_cache_after_get()
14184     *
14185     * @ingroup Slideshow
14186     */
14187    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
14188
14189    /**
14190     * Retrieve the number of items to cache, on a given slideshow widget,
14191     * <b>after the current item</b>
14192     *
14193     * @param obj The slideshow object
14194     * @return The number of items set to be cached after the current one
14195     *
14196     * @see elm_slideshow_cache_after_set() for more details
14197     *
14198     * @ingroup Slideshow
14199     */
14200    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14201
14202    /**
14203     * Get the number of items stored in a given slideshow widget
14204     *
14205     * @param obj The slideshow object
14206     * @return The number of items on @p obj, at the moment of this call
14207     *
14208     * @ingroup Slideshow
14209     */
14210    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14211
14212    /**
14213     * @}
14214     */
14215
14216    /**
14217     * @defgroup Fileselector File Selector
14218     *
14219     * @image html img/icon/fileselector/preview-00.png
14220     * @image latex img/icon/fileselector/preview-00.png
14221     *
14222     * A file selector is a widget that allows a user to navigate
14223     * through a file system, reporting file selections back via its
14224     * API.
14225     *
14226     * It contains shortcut buttons for home directory (@c ~) and to
14227     * jump one directory upwards (..), as well as cancel/ok buttons to
14228     * confirm/cancel a given selection. After either one of those two
14229     * former actions, the file selector will issue its @c "done" smart
14230     * callback.
14231     *
14232     * There's a text entry on it, too, showing the name of the current
14233     * selection. There's the possibility of making it editable, so it
14234     * is useful on file saving dialogs on applications, where one
14235     * gives a file name to save contents to, in a given directory in
14236     * the system. This custom file name will be reported on the @c
14237     * "done" smart callback (explained in sequence).
14238     *
14239     * Finally, it has a view to display file system items into in two
14240     * possible forms:
14241     * - list
14242     * - grid
14243     *
14244     * If Elementary is built with support of the Ethumb thumbnailing
14245     * library, the second form of view will display preview thumbnails
14246     * of files which it supports.
14247     *
14248     * Smart callbacks one can register to:
14249     *
14250     * - @c "selected" - the user has clicked on a file (when not in
14251     *      folders-only mode) or directory (when in folders-only mode)
14252     * - @c "directory,open" - the list has been populated with new
14253     *      content (@c event_info is a pointer to the directory's
14254     *      path, a @b stringshared string)
14255     * - @c "done" - the user has clicked on the "ok" or "cancel"
14256     *      buttons (@c event_info is a pointer to the selection's
14257     *      path, a @b stringshared string)
14258     *
14259     * Here is an example on its usage:
14260     * @li @ref fileselector_example
14261     */
14262
14263    /**
14264     * @addtogroup Fileselector
14265     * @{
14266     */
14267
14268    /**
14269     * Defines how a file selector widget is to layout its contents
14270     * (file system entries).
14271     */
14272    typedef enum _Elm_Fileselector_Mode
14273      {
14274         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
14275         ELM_FILESELECTOR_GRID, /**< layout as a grid */
14276         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
14277      } Elm_Fileselector_Mode;
14278
14279    /**
14280     * Add a new file selector widget to the given parent Elementary
14281     * (container) object
14282     *
14283     * @param parent The parent object
14284     * @return a new file selector widget handle or @c NULL, on errors
14285     *
14286     * This function inserts a new file selector widget on the canvas.
14287     *
14288     * @ingroup Fileselector
14289     */
14290    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14291
14292    /**
14293     * Enable/disable the file name entry box where the user can type
14294     * in a name for a file, in a given file selector widget
14295     *
14296     * @param obj The file selector object
14297     * @param is_save @c EINA_TRUE to make the file selector a "saving
14298     * dialog", @c EINA_FALSE otherwise
14299     *
14300     * Having the entry editable is useful on file saving dialogs on
14301     * applications, where one gives a file name to save contents to,
14302     * in a given directory in the system. This custom file name will
14303     * be reported on the @c "done" smart callback.
14304     *
14305     * @see elm_fileselector_is_save_get()
14306     *
14307     * @ingroup Fileselector
14308     */
14309    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
14310
14311    /**
14312     * Get whether the given file selector is in "saving dialog" mode
14313     *
14314     * @param obj The file selector object
14315     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
14316     * mode, @c EINA_FALSE otherwise (and on errors)
14317     *
14318     * @see elm_fileselector_is_save_set() for more details
14319     *
14320     * @ingroup Fileselector
14321     */
14322    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14323
14324    /**
14325     * Enable/disable folder-only view for a given file selector widget
14326     *
14327     * @param obj The file selector object
14328     * @param only @c EINA_TRUE to make @p obj only display
14329     * directories, @c EINA_FALSE to make files to be displayed in it
14330     * too
14331     *
14332     * If enabled, the widget's view will only display folder items,
14333     * naturally.
14334     *
14335     * @see elm_fileselector_folder_only_get()
14336     *
14337     * @ingroup Fileselector
14338     */
14339    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
14340
14341    /**
14342     * Get whether folder-only view is set for a given file selector
14343     * widget
14344     *
14345     * @param obj The file selector object
14346     * @return only @c EINA_TRUE if @p obj is only displaying
14347     * directories, @c EINA_FALSE if files are being displayed in it
14348     * too (and on errors)
14349     *
14350     * @see elm_fileselector_folder_only_get()
14351     *
14352     * @ingroup Fileselector
14353     */
14354    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14355
14356    /**
14357     * Enable/disable the "ok" and "cancel" buttons on a given file
14358     * selector widget
14359     *
14360     * @param obj The file selector object
14361     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
14362     *
14363     * @note A file selector without those buttons will never emit the
14364     * @c "done" smart event, and is only usable if one is just hooking
14365     * to the other two events.
14366     *
14367     * @see elm_fileselector_buttons_ok_cancel_get()
14368     *
14369     * @ingroup Fileselector
14370     */
14371    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
14372
14373    /**
14374     * Get whether the "ok" and "cancel" buttons on a given file
14375     * selector widget are being shown.
14376     *
14377     * @param obj The file selector object
14378     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
14379     * otherwise (and on errors)
14380     *
14381     * @see elm_fileselector_buttons_ok_cancel_set() for more details
14382     *
14383     * @ingroup Fileselector
14384     */
14385    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14386
14387    /**
14388     * Enable/disable a tree view in the given file selector widget,
14389     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
14390     *
14391     * @param obj The file selector object
14392     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
14393     * disable
14394     *
14395     * In a tree view, arrows are created on the sides of directories,
14396     * allowing them to expand in place.
14397     *
14398     * @note If it's in other mode, the changes made by this function
14399     * will only be visible when one switches back to "list" mode.
14400     *
14401     * @see elm_fileselector_expandable_get()
14402     *
14403     * @ingroup Fileselector
14404     */
14405    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
14406
14407    /**
14408     * Get whether tree view is enabled for the given file selector
14409     * widget
14410     *
14411     * @param obj The file selector object
14412     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
14413     * otherwise (and or errors)
14414     *
14415     * @see elm_fileselector_expandable_set() for more details
14416     *
14417     * @ingroup Fileselector
14418     */
14419    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14420
14421    /**
14422     * Set, programmatically, the @b directory that a given file
14423     * selector widget will display contents from
14424     *
14425     * @param obj The file selector object
14426     * @param path The path to display in @p obj
14427     *
14428     * This will change the @b directory that @p obj is displaying. It
14429     * will also clear the text entry area on the @p obj object, which
14430     * displays select files' names.
14431     *
14432     * @see elm_fileselector_path_get()
14433     *
14434     * @ingroup Fileselector
14435     */
14436    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
14437
14438    /**
14439     * Get the parent directory's path that a given file selector
14440     * widget is displaying
14441     *
14442     * @param obj The file selector object
14443     * @return The (full) path of the directory the file selector is
14444     * displaying, a @b stringshared string
14445     *
14446     * @see elm_fileselector_path_set()
14447     *
14448     * @ingroup Fileselector
14449     */
14450    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14451
14452    /**
14453     * Set, programmatically, the currently selected file/directory in
14454     * the given file selector widget
14455     *
14456     * @param obj The file selector object
14457     * @param path The (full) path to a file or directory
14458     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
14459     * latter case occurs if the directory or file pointed to do not
14460     * exist.
14461     *
14462     * @see elm_fileselector_selected_get()
14463     *
14464     * @ingroup Fileselector
14465     */
14466    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
14467
14468    /**
14469     * Get the currently selected item's (full) path, in the given file
14470     * selector widget
14471     *
14472     * @param obj The file selector object
14473     * @return The absolute path of the selected item, a @b
14474     * stringshared string
14475     *
14476     * @note Custom editions on @p obj object's text entry, if made,
14477     * will appear on the return string of this function, naturally.
14478     *
14479     * @see elm_fileselector_selected_set() for more details
14480     *
14481     * @ingroup Fileselector
14482     */
14483    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14484
14485    /**
14486     * Set the mode in which a given file selector widget will display
14487     * (layout) file system entries in its view
14488     *
14489     * @param obj The file selector object
14490     * @param mode The mode of the fileselector, being it one of
14491     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
14492     * first one, naturally, will display the files in a list. The
14493     * latter will make the widget to display its entries in a grid
14494     * form.
14495     *
14496     * @note By using elm_fileselector_expandable_set(), the user may
14497     * trigger a tree view for that list.
14498     *
14499     * @note If Elementary is built with support of the Ethumb
14500     * thumbnailing library, the second form of view will display
14501     * preview thumbnails of files which it supports. You must have
14502     * elm_need_ethumb() called in your Elementary for thumbnailing to
14503     * work, though.
14504     *
14505     * @see elm_fileselector_expandable_set().
14506     * @see elm_fileselector_mode_get().
14507     *
14508     * @ingroup Fileselector
14509     */
14510    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
14511
14512    /**
14513     * Get the mode in which a given file selector widget is displaying
14514     * (layouting) file system entries in its view
14515     *
14516     * @param obj The fileselector object
14517     * @return The mode in which the fileselector is at
14518     *
14519     * @see elm_fileselector_mode_set() for more details
14520     *
14521     * @ingroup Fileselector
14522     */
14523    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14524
14525    /**
14526     * @}
14527     */
14528
14529    /**
14530     * @defgroup Progressbar Progress bar
14531     *
14532     * The progress bar is a widget for visually representing the
14533     * progress status of a given job/task.
14534     *
14535     * A progress bar may be horizontal or vertical. It may display an
14536     * icon besides it, as well as primary and @b units labels. The
14537     * former is meant to label the widget as a whole, while the
14538     * latter, which is formatted with floating point values (and thus
14539     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
14540     * units"</c>), is meant to label the widget's <b>progress
14541     * value</b>. Label, icon and unit strings/objects are @b optional
14542     * for progress bars.
14543     *
14544     * A progress bar may be @b inverted, in which state it gets its
14545     * values inverted, with high values being on the left or top and
14546     * low values on the right or bottom, as opposed to normally have
14547     * the low values on the former and high values on the latter,
14548     * respectively, for horizontal and vertical modes.
14549     *
14550     * The @b span of the progress, as set by
14551     * elm_progressbar_span_size_set(), is its length (horizontally or
14552     * vertically), unless one puts size hints on the widget to expand
14553     * on desired directions, by any container. That length will be
14554     * scaled by the object or applications scaling factor. At any
14555     * point code can query the progress bar for its value with
14556     * elm_progressbar_value_get().
14557     *
14558     * Available widget styles for progress bars:
14559     * - @c "default"
14560     * - @c "wheel" (simple style, no text, no progression, only
14561     *      "pulse" effect is available)
14562     *
14563     * Here is an example on its usage:
14564     * @li @ref progressbar_example
14565     */
14566
14567    /**
14568     * Add a new progress bar widget to the given parent Elementary
14569     * (container) object
14570     *
14571     * @param parent The parent object
14572     * @return a new progress bar widget handle or @c NULL, on errors
14573     *
14574     * This function inserts a new progress bar widget on the canvas.
14575     *
14576     * @ingroup Progressbar
14577     */
14578    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14579
14580    /**
14581     * Set whether a given progress bar widget is at "pulsing mode" or
14582     * not.
14583     *
14584     * @param obj The progress bar object
14585     * @param pulse @c EINA_TRUE to put @obj in pulsing mode,
14586     * @c EINA_FALSE to put it back to its default one
14587     *
14588     * By default, progress bars will display values from the low to
14589     * high value boundaries. There are, though, contexts in which the
14590     * state of progression of a given task is @b unknown.  For those,
14591     * one can set a progress bar widget to a "pulsing state", to give
14592     * the user an idea that some computation is being held, but
14593     * without exact progress values. In the default theme it will
14594     * animate its bar with the contents filling in constantly and back
14595     * to non-filled, in a loop. To start and stop this pulsing
14596     * animation, one has to explicitly call elm_progressbar_pulse().
14597     *
14598     * @see elm_progressbar_pulse_get()
14599     * @see elm_progressbar_pulse()
14600     *
14601     * @ingroup Progressbar
14602     */
14603    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
14604
14605    /**
14606     * Get whether a given progress bar widget is at "pulsing mode" or
14607     * not.
14608     *
14609     * @param obj The progress bar object
14610     * @return @c EINA_TRUE, if @obj is in pulsing mode, @c EINA_FALSE
14611     * if it's in the default one (and on errors)
14612     *
14613     * @ingroup Progressbar
14614     */
14615    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14616
14617    /**
14618     * Start/stop a given progress bar "pulsing" animation, if its
14619     * under that mode
14620     *
14621     * @param obj The progress bar object
14622     * @param state @c EINA_TRUE, to @b start the pulsing animation,
14623     * @c EINA_FALSE to @b stop it
14624     *
14625     * @note This call won't do anything if @p obj is not under "pulsing mode".
14626     *
14627     * @see elm_progressbar_pulse_set() for more details.
14628     *
14629     * @ingroup Progressbar
14630     */
14631    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
14632
14633    /**
14634     * Set the progress value (in percentage) on a given progress bar
14635     * widget
14636     *
14637     * @param obj The progress bar object
14638     * @param val The progress value (@b must be between @c 0.0 and @c
14639     * 1.0)
14640     *
14641     * Use this call to set progress bar levels.
14642     *
14643     * @note If you passes a value out of the specified range for @p
14644     * val, it will be interpreted as the @b closest of the @b boundary
14645     * values in the range.
14646     *
14647     * @ingroup Progressbar
14648     */
14649    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
14650
14651    /**
14652     * Get the progress value (in percentage) on a given progress bar
14653     * widget
14654     *
14655     * @param obj The progress bar object
14656     * @return The value of the progressbar
14657     *
14658     * @see elm_progressbar_value_set() for more details
14659     *
14660     * @ingroup Progressbar
14661     */
14662    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14663
14664    /**
14665     * Set the label of a given progress bar widget
14666     *
14667     * @param obj The progress bar object
14668     * @param label The text label string, in UTF-8
14669     *
14670     * @ingroup Progressbar
14671     * @deprecated use elm_object_text_set() instead.
14672     */
14673    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14674
14675    /**
14676     * Get the label of a given progress bar widget
14677     *
14678     * @param obj The progressbar object
14679     * @return The text label string, in UTF-8
14680     *
14681     * @ingroup Progressbar
14682     * @deprecated use elm_object_text_set() instead.
14683     */
14684    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14685
14686    /**
14687     * Set the icon object of a given progress bar widget
14688     *
14689     * @param obj The progress bar object
14690     * @param icon The icon object
14691     *
14692     * Use this call to decorate @p obj with an icon next to it.
14693     *
14694     * @note Once the icon object is set, a previously set one will be
14695     * deleted. If you want to keep that old content object, use the
14696     * elm_progressbar_icon_unset() function.
14697     *
14698     * @see elm_progressbar_icon_get()
14699     *
14700     * @ingroup Progressbar
14701     */
14702    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14703
14704    /**
14705     * Retrieve the icon object set for a given progress bar widget
14706     *
14707     * @param obj The progress bar object
14708     * @return The icon object's handle, if @p obj had one set, or @c NULL,
14709     * otherwise (and on errors)
14710     *
14711     * @see elm_progressbar_icon_set() for more details
14712     *
14713     * @ingroup Progressbar
14714     */
14715    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14716
14717    /**
14718     * Unset an icon set on a given progress bar widget
14719     *
14720     * @param obj The progress bar object
14721     * @return The icon object that was being used, if any was set, or
14722     * @c NULL, otherwise (and on errors)
14723     *
14724     * This call will unparent and return the icon object which was set
14725     * for this widget, previously, on success.
14726     *
14727     * @see elm_progressbar_icon_set() for more details
14728     *
14729     * @ingroup Progressbar
14730     */
14731    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14732
14733    /**
14734     * Set the (exact) length of the bar region of a given progress bar
14735     * widget
14736     *
14737     * @param obj The progress bar object
14738     * @param size The length of the progress bar's bar region
14739     *
14740     * This sets the minimum width (when in horizontal mode) or height
14741     * (when in vertical mode) of the actual bar area of the progress
14742     * bar @p obj. This in turn affects the object's minimum size. Use
14743     * this when you're not setting other size hints expanding on the
14744     * given direction (like weight and alignment hints) and you would
14745     * like it to have a specific size.
14746     *
14747     * @note Icon, label and unit text around @p obj will require their
14748     * own space, which will make @p obj to require more the @p size,
14749     * actually.
14750     *
14751     * @see elm_progressbar_span_size_get()
14752     *
14753     * @ingroup Progressbar
14754     */
14755    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
14756
14757    /**
14758     * Get the length set for the bar region of a given progress bar
14759     * widget
14760     *
14761     * @param obj The progress bar object
14762     * @return The length of the progress bar's bar region
14763     *
14764     * If that size was not set previously, with
14765     * elm_progressbar_span_size_set(), this call will return @c 0.
14766     *
14767     * @ingroup Progressbar
14768     */
14769    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14770
14771    /**
14772     * Set the format string for a given progress bar widget's units
14773     * label
14774     *
14775     * @param obj The progress bar object
14776     * @param format The format string for @p obj's units label
14777     *
14778     * If @c NULL is passed on @p format, it will make @p obj's units
14779     * area to be hidden completely. If not, it'll set the <b>format
14780     * string</b> for the units label's @b text. The units label is
14781     * provided a floating point value, so the units text is up display
14782     * at most one floating point falue. Note that the units label is
14783     * optional. Use a format string such as "%1.2f meters" for
14784     * example.
14785     *
14786     * @note The default format string for a progress bar is an integer
14787     * percentage, as in @c "%.0f %%".
14788     *
14789     * @see elm_progressbar_unit_format_get()
14790     *
14791     * @ingroup Progressbar
14792     */
14793    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
14794
14795    /**
14796     * Retrieve the format string set for a given progress bar widget's
14797     * units label
14798     *
14799     * @param obj The progress bar object
14800     * @return The format set string for @p obj's units label or
14801     * @c NULL, if none was set (and on errors)
14802     *
14803     * @see elm_progressbar_unit_format_set() for more details
14804     *
14805     * @ingroup Progressbar
14806     */
14807    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14808
14809    /**
14810     * Set the orientation of a given progress bar widget
14811     *
14812     * @param obj The progress bar object
14813     * @param horizontal Use @c EINA_TRUE to make @p obj to be
14814     * @b horizontal, @c EINA_FALSE to make it @b vertical
14815     *
14816     * Use this function to change how your progress bar is to be
14817     * disposed: vertically or horizontally.
14818     *
14819     * @see elm_progressbar_horizontal_get()
14820     *
14821     * @ingroup Progressbar
14822     */
14823    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14824
14825    /**
14826     * Retrieve the orientation of a given progress bar widget
14827     *
14828     * @param obj The progress bar object
14829     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
14830     * @c EINA_FALSE if it's @b vertical (and on errors)
14831     *
14832     * @see elm_progressbar_horizontal_set() for more details
14833     *
14834     * @ingroup Progressbar
14835     */
14836    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14837
14838    /**
14839     * Invert a given progress bar widget's displaying values order
14840     *
14841     * @param obj The progress bar object
14842     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
14843     * @c EINA_FALSE to bring it back to default, non-inverted values.
14844     *
14845     * A progress bar may be @b inverted, in which state it gets its
14846     * values inverted, with high values being on the left or top and
14847     * low values on the right or bottom, as opposed to normally have
14848     * the low values on the former and high values on the latter,
14849     * respectively, for horizontal and vertical modes.
14850     *
14851     * @see elm_progressbar_inverted_get()
14852     *
14853     * @ingroup Progressbar
14854     */
14855    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
14856
14857    /**
14858     * Get whether a given progress bar widget's displaying values are
14859     * inverted or not
14860     *
14861     * @param obj The progress bar object
14862     * @return @c EINA_TRUE, if @p obj has inverted values,
14863     * @c EINA_FALSE otherwise (and on errors)
14864     *
14865     * @see elm_progressbar_inverted_set() for more details
14866     *
14867     * @ingroup Progressbar
14868     */
14869    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14870
14871    /**
14872     * @defgroup Separator Separator
14873     *
14874     * @brief Separator is a very thin object used to separate other objects.
14875     *
14876     * A separator can be vertical or horizontal.
14877     *
14878     * @ref tutorial_separator is a good example of how to use a separator.
14879     * @{
14880     */
14881    /**
14882     * @brief Add a separator object to @p parent
14883     *
14884     * @param parent The parent object
14885     *
14886     * @return The separator object, or NULL upon failure
14887     */
14888    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14889    /**
14890     * @brief Set the horizontal mode of a separator object
14891     *
14892     * @param obj The separator object
14893     * @param horizontal If true, the separator is horizontal
14894     */
14895    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14896    /**
14897     * @brief Get the horizontal mode of a separator object
14898     *
14899     * @param obj The separator object
14900     * @return If true, the separator is horizontal
14901     *
14902     * @see elm_separator_horizontal_set()
14903     */
14904    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14905    /**
14906     * @}
14907     */
14908
14909    /**
14910     * @defgroup Spinner Spinner
14911     * @ingroup Elementary
14912     *
14913     * @image html img/widget/spinner/preview-00.png
14914     * @image latex img/widget/spinner/preview-00.eps
14915     *
14916     * A spinner is a widget which allows the user to increase or decrease
14917     * numeric values using arrow buttons, or edit values directly, clicking
14918     * over it and typing the new value.
14919     *
14920     * By default the spinner will not wrap and has a label
14921     * of "%.0f" (just showing the integer value of the double).
14922     *
14923     * A spinner has a label that is formatted with floating
14924     * point values and thus accepts a printf-style format string, like
14925     * “%1.2f units”.
14926     *
14927     * It also allows specific values to be replaced by pre-defined labels.
14928     *
14929     * Smart callbacks one can register to:
14930     *
14931     * - "changed" - Whenever the spinner value is changed.
14932     * - "delay,changed" - A short time after the value is changed by the user.
14933     *    This will be called only when the user stops dragging for a very short
14934     *    period or when they release their finger/mouse, so it avoids possibly
14935     *    expensive reactions to the value change.
14936     *
14937     * Available styles for it:
14938     * - @c "default";
14939     * - @c "vertical": up/down buttons at the right side and text left aligned.
14940     *
14941     * Here is an example on its usage:
14942     * @ref spinner_example
14943     */
14944
14945    /**
14946     * @addtogroup Spinner
14947     * @{
14948     */
14949
14950    /**
14951     * Add a new spinner widget to the given parent Elementary
14952     * (container) object.
14953     *
14954     * @param parent The parent object.
14955     * @return a new spinner widget handle or @c NULL, on errors.
14956     *
14957     * This function inserts a new spinner widget on the canvas.
14958     *
14959     * @ingroup Spinner
14960     *
14961     */
14962    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14963
14964    /**
14965     * Set the format string of the displayed label.
14966     *
14967     * @param obj The spinner object.
14968     * @param fmt The format string for the label display.
14969     *
14970     * If @c NULL, this sets the format to "%.0f". If not it sets the format
14971     * string for the label text. The label text is provided a floating point
14972     * value, so the label text can display up to 1 floating point value.
14973     * Note that this is optional.
14974     *
14975     * Use a format string such as "%1.2f meters" for example, and it will
14976     * display values like: "3.14 meters" for a value equal to 3.14159.
14977     *
14978     * Default is "%0.f".
14979     *
14980     * @see elm_spinner_label_format_get()
14981     *
14982     * @ingroup Spinner
14983     */
14984    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
14985
14986    /**
14987     * Get the label format of the spinner.
14988     *
14989     * @param obj The spinner object.
14990     * @return The text label format string in UTF-8.
14991     *
14992     * @see elm_spinner_label_format_set() for details.
14993     *
14994     * @ingroup Spinner
14995     */
14996    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14997
14998    /**
14999     * Set the minimum and maximum values for the spinner.
15000     *
15001     * @param obj The spinner object.
15002     * @param min The minimum value.
15003     * @param max The maximum value.
15004     *
15005     * Define the allowed range of values to be selected by the user.
15006     *
15007     * If actual value is less than @p min, it will be updated to @p min. If it
15008     * is bigger then @p max, will be updated to @p max. Actual value can be
15009     * get with elm_spinner_value_get().
15010     *
15011     * By default, min is equal to 0, and max is equal to 100.
15012     *
15013     * @warning Maximum must be greater than minimum.
15014     *
15015     * @see elm_spinner_min_max_get()
15016     *
15017     * @ingroup Spinner
15018     */
15019    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
15020
15021    /**
15022     * Get the minimum and maximum values of the spinner.
15023     *
15024     * @param obj The spinner object.
15025     * @param min Pointer where to store the minimum value.
15026     * @param max Pointer where to store the maximum value.
15027     *
15028     * @note If only one value is needed, the other pointer can be passed
15029     * as @c NULL.
15030     *
15031     * @see elm_spinner_min_max_set() for details.
15032     *
15033     * @ingroup Spinner
15034     */
15035    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
15036
15037    /**
15038     * Set the step used to increment or decrement the spinner value.
15039     *
15040     * @param obj The spinner object.
15041     * @param step The step value.
15042     *
15043     * This value will be incremented or decremented to the displayed value.
15044     * It will be incremented while the user keep right or top arrow pressed,
15045     * and will be decremented while the user keep left or bottom arrow pressed.
15046     *
15047     * The interval to increment / decrement can be set with
15048     * elm_spinner_interval_set().
15049     *
15050     * By default step value is equal to 1.
15051     *
15052     * @see elm_spinner_step_get()
15053     *
15054     * @ingroup Spinner
15055     */
15056    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
15057
15058    /**
15059     * Get the step used to increment or decrement the spinner value.
15060     *
15061     * @param obj The spinner object.
15062     * @return The step value.
15063     *
15064     * @see elm_spinner_step_get() for more details.
15065     *
15066     * @ingroup Spinner
15067     */
15068    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15069
15070    /**
15071     * Set the value the spinner displays.
15072     *
15073     * @param obj The spinner object.
15074     * @param val The value to be displayed.
15075     *
15076     * Value will be presented on the label following format specified with
15077     * elm_spinner_format_set().
15078     *
15079     * @warning The value must to be between min and max values. This values
15080     * are set by elm_spinner_min_max_set().
15081     *
15082     * @see elm_spinner_value_get().
15083     * @see elm_spinner_format_set().
15084     * @see elm_spinner_min_max_set().
15085     *
15086     * @ingroup Spinner
15087     */
15088    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
15089
15090    /**
15091     * Get the value displayed by the spinner.
15092     *
15093     * @param obj The spinner object.
15094     * @return The value displayed.
15095     *
15096     * @see elm_spinner_value_set() for details.
15097     *
15098     * @ingroup Spinner
15099     */
15100    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15101
15102    /**
15103     * Set whether the spinner should wrap when it reaches its
15104     * minimum or maximum value.
15105     *
15106     * @param obj The spinner object.
15107     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
15108     * disable it.
15109     *
15110     * Disabled by default. If disabled, when the user tries to increment the
15111     * value,
15112     * but displayed value plus step value is bigger than maximum value,
15113     * the spinner
15114     * won't allow it. The same happens when the user tries to decrement it,
15115     * but the value less step is less than minimum value.
15116     *
15117     * When wrap is enabled, in such situations it will allow these changes,
15118     * but will get the value that would be less than minimum and subtracts
15119     * from maximum. Or add the value that would be more than maximum to
15120     * the minimum.
15121     *
15122     * E.g.:
15123     * @li min value = 10
15124     * @li max value = 50
15125     * @li step value = 20
15126     * @li displayed value = 20
15127     *
15128     * When the user decrement value (using left or bottom arrow), it will
15129     * displays @c 40, because max - (min - (displayed - step)) is
15130     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
15131     *
15132     * @see elm_spinner_wrap_get().
15133     *
15134     * @ingroup Spinner
15135     */
15136    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
15137
15138    /**
15139     * Get whether the spinner should wrap when it reaches its
15140     * minimum or maximum value.
15141     *
15142     * @param obj The spinner object
15143     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
15144     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
15145     *
15146     * @see elm_spinner_wrap_set() for details.
15147     *
15148     * @ingroup Spinner
15149     */
15150    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15151
15152    /**
15153     * Set whether the spinner can be directly edited by the user or not.
15154     *
15155     * @param obj The spinner object.
15156     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
15157     * don't allow users to edit it directly.
15158     *
15159     * Spinner objects can have edition @b disabled, in which state they will
15160     * be changed only by arrows.
15161     * Useful for contexts
15162     * where you don't want your users to interact with it writting the value.
15163     * Specially
15164     * when using special values, the user can see real value instead
15165     * of special label on edition.
15166     *
15167     * It's enabled by default.
15168     *
15169     * @see elm_spinner_editable_get()
15170     *
15171     * @ingroup Spinner
15172     */
15173    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
15174
15175    /**
15176     * Get whether the spinner can be directly edited by the user or not.
15177     *
15178     * @param obj The spinner object.
15179     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
15180     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
15181     *
15182     * @see elm_spinner_editable_set() for details.
15183     *
15184     * @ingroup Spinner
15185     */
15186    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15187
15188    /**
15189     * Set a special string to display in the place of the numerical value.
15190     *
15191     * @param obj The spinner object.
15192     * @param value The value to be replaced.
15193     * @param label The label to be used.
15194     *
15195     * It's useful for cases when a user should select an item that is
15196     * better indicated by a label than a value. For example, weekdays or months.
15197     *
15198     * E.g.:
15199     * @code
15200     * sp = elm_spinner_add(win);
15201     * elm_spinner_min_max_set(sp, 1, 3);
15202     * elm_spinner_special_value_add(sp, 1, "January");
15203     * elm_spinner_special_value_add(sp, 2, "February");
15204     * elm_spinner_special_value_add(sp, 3, "March");
15205     * evas_object_show(sp);
15206     * @endcode
15207     *
15208     * @ingroup Spinner
15209     */
15210    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
15211
15212    /**
15213     * Set the interval on time updates for an user mouse button hold
15214     * on spinner widgets' arrows.
15215     *
15216     * @param obj The spinner object.
15217     * @param interval The (first) interval value in seconds.
15218     *
15219     * This interval value is @b decreased while the user holds the
15220     * mouse pointer either incrementing or decrementing spinner's value.
15221     *
15222     * This helps the user to get to a given value distant from the
15223     * current one easier/faster, as it will start to change quicker and
15224     * quicker on mouse button holds.
15225     *
15226     * The calculation for the next change interval value, starting from
15227     * the one set with this call, is the previous interval divided by
15228     * @c 1.05, so it decreases a little bit.
15229     *
15230     * The default starting interval value for automatic changes is
15231     * @c 0.85 seconds.
15232     *
15233     * @see elm_spinner_interval_get()
15234     *
15235     * @ingroup Spinner
15236     */
15237    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
15238
15239    /**
15240     * Get the interval on time updates for an user mouse button hold
15241     * on spinner widgets' arrows.
15242     *
15243     * @param obj The spinner object.
15244     * @return The (first) interval value, in seconds, set on it.
15245     *
15246     * @see elm_spinner_interval_set() for more details.
15247     *
15248     * @ingroup Spinner
15249     */
15250    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15251
15252    /**
15253     * @}
15254     */
15255
15256    /**
15257     * @defgroup Index Index
15258     *
15259     * @image html img/widget/index/preview-00.png
15260     *
15261     * An index widget gives you an index for fast access to whichever
15262     * group of other UI items one might have. It's a list of text
15263     * items (usually letters, for alphabetically ordered access).
15264     *
15265     * Index widgets are by default hidden and just appear when the
15266     * user clicks over it's reserved area in the canvas. In its
15267     * default theme, it's an area one @ref Fingers "finger" wide on
15268     * the right side of the index widget's container.
15269     *
15270     * When items on the index are selected, smart callbacks get
15271     * called, so that its user can make other container objects to
15272     * show a given area or child object depending on the index item
15273     * selected. You'd probably be using an index together with @ref
15274     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
15275     * "general grids".
15276     *
15277     * Smart events one  can add callbacks for are:
15278     * - @c "changed" - When the selected index item changes. @c
15279     *      event_info is the selected item's data pointer.
15280     * - @c "delay,changed" - When the selected index item changes, but
15281     *      after a small idling period. @c event_info is the selected
15282     *      item's data pointer.
15283     * - @c "selected" - When the user releases a mouse button and
15284     *      selects an item. @c event_info is the selected item's data
15285     *      pointer.
15286     * - @c "level,up" - when the user moves a finger from the first
15287     *      level to the second level
15288     * - @c "level,down" - when the user moves a finger from the second
15289     *      level to the first level
15290     *
15291     * The @c "delay,changed" event is so that it'll wait a small time
15292     * before actually reporting those events and, moreover, just the
15293     * last event happening on those time frames will actually be
15294     * reported.
15295     *
15296     * Here are some examples on its usage:
15297     * @li @ref index_example_01
15298     * @li @ref index_example_02
15299     */
15300
15301    /**
15302     * @addtogroup Index
15303     * @{
15304     */
15305
15306    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
15307
15308    /**
15309     * Add a new index widget to the given parent Elementary
15310     * (container) object
15311     *
15312     * @param parent The parent object
15313     * @return a new index widget handle or @c NULL, on errors
15314     *
15315     * This function inserts a new index widget on the canvas.
15316     *
15317     * @ingroup Index
15318     */
15319    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15320
15321    /**
15322     * Set whether a given index widget is or not visible,
15323     * programatically.
15324     *
15325     * @param obj The index object
15326     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
15327     *
15328     * Not to be confused with visible as in @c evas_object_show() --
15329     * visible with regard to the widget's auto hiding feature.
15330     *
15331     * @see elm_index_active_get()
15332     *
15333     * @ingroup Index
15334     */
15335    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
15336
15337    /**
15338     * Get whether a given index widget is currently visible or not.
15339     *
15340     * @param obj The index object
15341     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
15342     *
15343     * @see elm_index_active_set() for more details
15344     *
15345     * @ingroup Index
15346     */
15347    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15348
15349    /**
15350     * Set the items level for a given index widget.
15351     *
15352     * @param obj The index object.
15353     * @param level @c 0 or @c 1, the currently implemented levels.
15354     *
15355     * @see elm_index_item_level_get()
15356     *
15357     * @ingroup Index
15358     */
15359    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
15360
15361    /**
15362     * Get the items level set for a given index widget.
15363     *
15364     * @param obj The index object.
15365     * @return @c 0 or @c 1, which are the levels @p obj might be at.
15366     *
15367     * @see elm_index_item_level_set() for more information
15368     *
15369     * @ingroup Index
15370     */
15371    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15372
15373    /**
15374     * Returns the last selected item's data, for a given index widget.
15375     *
15376     * @param obj The index object.
15377     * @return The item @b data associated to the last selected item on
15378     * @p obj (or @c NULL, on errors).
15379     *
15380     * @warning The returned value is @b not an #Elm_Index_Item item
15381     * handle, but the data associated to it (see the @c item parameter
15382     * in elm_index_item_append(), as an example).
15383     *
15384     * @ingroup Index
15385     */
15386    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
15387
15388    /**
15389     * Append a new item on a given index widget.
15390     *
15391     * @param obj The index object.
15392     * @param letter Letter under which the item should be indexed
15393     * @param item The item data to set for the index's item
15394     *
15395     * Despite the most common usage of the @p letter argument is for
15396     * single char strings, one could use arbitrary strings as index
15397     * entries.
15398     *
15399     * @c item will be the pointer returned back on @c "changed", @c
15400     * "delay,changed" and @c "selected" smart events.
15401     *
15402     * @ingroup Index
15403     */
15404    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
15405
15406    /**
15407     * Prepend a new item on a given index widget.
15408     *
15409     * @param obj The index object.
15410     * @param letter Letter under which the item should be indexed
15411     * @param item The item data to set for the index's item
15412     *
15413     * Despite the most common usage of the @p letter argument is for
15414     * single char strings, one could use arbitrary strings as index
15415     * entries.
15416     *
15417     * @c item will be the pointer returned back on @c "changed", @c
15418     * "delay,changed" and @c "selected" smart events.
15419     *
15420     * @ingroup Index
15421     */
15422    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
15423
15424    /**
15425     * Append a new item, on a given index widget, <b>after the item
15426     * having @p relative as data</b>.
15427     *
15428     * @param obj The index object.
15429     * @param letter Letter under which the item should be indexed
15430     * @param item The item data to set for the index's item
15431     * @param relative The item data of the index item to be the
15432     * predecessor of this new one
15433     *
15434     * Despite the most common usage of the @p letter argument is for
15435     * single char strings, one could use arbitrary strings as index
15436     * entries.
15437     *
15438     * @c item will be the pointer returned back on @c "changed", @c
15439     * "delay,changed" and @c "selected" smart events.
15440     *
15441     * @note If @p relative is @c NULL or if it's not found to be data
15442     * set on any previous item on @p obj, this function will behave as
15443     * elm_index_item_append().
15444     *
15445     * @ingroup Index
15446     */
15447    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
15448
15449    /**
15450     * Prepend a new item, on a given index widget, <b>after the item
15451     * having @p relative as data</b>.
15452     *
15453     * @param obj The index object.
15454     * @param letter Letter under which the item should be indexed
15455     * @param item The item data to set for the index's item
15456     * @param relative The item data of the index item to be the
15457     * successor of this new one
15458     *
15459     * Despite the most common usage of the @p letter argument is for
15460     * single char strings, one could use arbitrary strings as index
15461     * entries.
15462     *
15463     * @c item will be the pointer returned back on @c "changed", @c
15464     * "delay,changed" and @c "selected" smart events.
15465     *
15466     * @note If @p relative is @c NULL or if it's not found to be data
15467     * set on any previous item on @p obj, this function will behave as
15468     * elm_index_item_prepend().
15469     *
15470     * @ingroup Index
15471     */
15472    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
15473
15474    /**
15475     * Insert a new item into the given index widget, using @p cmp_func
15476     * function to sort items (by item handles).
15477     *
15478     * @param obj The index object.
15479     * @param letter Letter under which the item should be indexed
15480     * @param item The item data to set for the index's item
15481     * @param cmp_func The comparing function to be used to sort index
15482     * items <b>by #Elm_Index_Item item handles</b>
15483     * @param cmp_data_func A @b fallback function to be called for the
15484     * sorting of index items <b>by item data</b>). It will be used
15485     * when @p cmp_func returns @c 0 (equality), which means an index
15486     * item with provided item data already exists. To decide which
15487     * data item should be pointed to by the index item in question, @p
15488     * cmp_data_func will be used. If @p cmp_data_func returns a
15489     * non-negative value, the previous index item data will be
15490     * replaced by the given @p item pointer. If the previous data need
15491     * to be freed, it should be done by the @p cmp_data_func function,
15492     * because all references to it will be lost. If this function is
15493     * not provided (@c NULL is given), index items will be @b
15494     * duplicated, if @p cmp_func returns @c 0.
15495     *
15496     * Despite the most common usage of the @p letter argument is for
15497     * single char strings, one could use arbitrary strings as index
15498     * entries.
15499     *
15500     * @c item will be the pointer returned back on @c "changed", @c
15501     * "delay,changed" and @c "selected" smart events.
15502     *
15503     * @ingroup Index
15504     */
15505    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);
15506
15507    /**
15508     * Remove an item from a given index widget, <b>to be referenced by
15509     * it's data value</b>.
15510     *
15511     * @param obj The index object
15512     * @param item The item's data pointer for the item to be removed
15513     * from @p obj
15514     *
15515     * If a deletion callback is set, via elm_index_item_del_cb_set(),
15516     * that callback function will be called by this one.
15517     *
15518     * @warning The item to be removed from @p obj will be found via
15519     * its item data pointer, and not by an #Elm_Index_Item handle.
15520     *
15521     * @ingroup Index
15522     */
15523    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
15524
15525    /**
15526     * Find a given index widget's item, <b>using item data</b>.
15527     *
15528     * @param obj The index object
15529     * @param item The item data pointed to by the desired index item
15530     * @return The index item handle, if found, or @c NULL otherwise
15531     *
15532     * @ingroup Index
15533     */
15534    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
15535
15536    /**
15537     * Removes @b all items from a given index widget.
15538     *
15539     * @param obj The index object.
15540     *
15541     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
15542     * that callback function will be called for each item in @p obj.
15543     *
15544     * @ingroup Index
15545     */
15546    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15547
15548    /**
15549     * Go to a given items level on a index widget
15550     *
15551     * @param obj The index object
15552     * @param level The index level (one of @c 0 or @c 1)
15553     *
15554     * @ingroup Index
15555     */
15556    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
15557
15558    /**
15559     * Return the data associated with a given index widget item
15560     *
15561     * @param it The index widget item handle
15562     * @return The data associated with @p it
15563     *
15564     * @see elm_index_item_data_set()
15565     *
15566     * @ingroup Index
15567     */
15568    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
15569
15570    /**
15571     * Set the data associated with a given index widget item
15572     *
15573     * @param it The index widget item handle
15574     * @param data The new data pointer to set to @p it
15575     *
15576     * This sets new item data on @p it.
15577     *
15578     * @warning The old data pointer won't be touched by this function, so
15579     * the user had better to free that old data himself/herself.
15580     *
15581     * @ingroup Index
15582     */
15583    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
15584
15585    /**
15586     * Set the function to be called when a given index widget item is freed.
15587     *
15588     * @param it The item to set the callback on
15589     * @param func The function to call on the item's deletion
15590     *
15591     * When called, @p func will have both @c data and @c event_info
15592     * arguments with the @p it item's data value and, naturally, the
15593     * @c obj argument with a handle to the parent index widget.
15594     *
15595     * @ingroup Index
15596     */
15597    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15598
15599    /**
15600     * Get the letter (string) set on a given index widget item.
15601     *
15602     * @param it The index item handle
15603     * @return The letter string set on @p it
15604     *
15605     * @ingroup Index
15606     */
15607    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
15608
15609    /**
15610     * @}
15611     */
15612
15613    /**
15614     * @defgroup Photocam Photocam
15615     *
15616     * @image html img/widget/photocam/preview-00.png
15617     * @image latex img/widget/photocam/preview-00.eps
15618     *
15619     * This is a widget specifically for displaying high-resolution digital
15620     * camera photos giving speedy feedback (fast load), low memory footprint
15621     * and zooming and panning as well as fitting logic. It is entirely focused
15622     * on jpeg images, and takes advantage of properties of the jpeg format (via
15623     * evas loader features in the jpeg loader).
15624     *
15625     * Signals that you can add callbacks for are:
15626     * @li "clicked" - This is called when a user has clicked the photo without
15627     *                 dragging around.
15628     * @li "press" - This is called when a user has pressed down on the photo.
15629     * @li "longpressed" - This is called when a user has pressed down on the
15630     *                     photo for a long time without dragging around.
15631     * @li "clicked,double" - This is called when a user has double-clicked the
15632     *                        photo.
15633     * @li "load" - Photo load begins.
15634     * @li "loaded" - This is called when the image file load is complete for the
15635     *                first view (low resolution blurry version).
15636     * @li "load,detail" - Photo detailed data load begins.
15637     * @li "loaded,detail" - This is called when the image file load is complete
15638     *                      for the detailed image data (full resolution needed).
15639     * @li "zoom,start" - Zoom animation started.
15640     * @li "zoom,stop" - Zoom animation stopped.
15641     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
15642     * @li "scroll" - the content has been scrolled (moved)
15643     * @li "scroll,anim,start" - scrolling animation has started
15644     * @li "scroll,anim,stop" - scrolling animation has stopped
15645     * @li "scroll,drag,start" - dragging the contents around has started
15646     * @li "scroll,drag,stop" - dragging the contents around has stopped
15647     *
15648     * @ref tutorial_photocam shows the API in action.
15649     * @{
15650     */
15651    /**
15652     * @brief Types of zoom available.
15653     */
15654    typedef enum _Elm_Photocam_Zoom_Mode
15655      {
15656         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
15657         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
15658         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
15659         ELM_PHOTOCAM_ZOOM_MODE_LAST
15660      } Elm_Photocam_Zoom_Mode;
15661    /**
15662     * @brief Add a new Photocam object
15663     *
15664     * @param parent The parent object
15665     * @return The new object or NULL if it cannot be created
15666     */
15667    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15668    /**
15669     * @brief Set the photo file to be shown
15670     *
15671     * @param obj The photocam object
15672     * @param file The photo file
15673     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
15674     *
15675     * This sets (and shows) the specified file (with a relative or absolute
15676     * path) and will return a load error (same error that
15677     * evas_object_image_load_error_get() will return). The image will change and
15678     * adjust its size at this point and begin a background load process for this
15679     * photo that at some time in the future will be displayed at the full
15680     * quality needed.
15681     */
15682    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
15683    /**
15684     * @brief Returns the path of the current image file
15685     *
15686     * @param obj The photocam object
15687     * @return Returns the path
15688     *
15689     * @see elm_photocam_file_set()
15690     */
15691    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15692    /**
15693     * @brief Set the zoom level of the photo
15694     *
15695     * @param obj The photocam object
15696     * @param zoom The zoom level to set
15697     *
15698     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
15699     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
15700     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
15701     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
15702     * 16, 32, etc.).
15703     */
15704    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
15705    /**
15706     * @brief Get the zoom level of the photo
15707     *
15708     * @param obj The photocam object
15709     * @return The current zoom level
15710     *
15711     * This returns the current zoom level of the photocam object. Note that if
15712     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
15713     * (which is the default), the zoom level may be changed at any time by the
15714     * photocam object itself to account for photo size and photocam viewpoer
15715     * size.
15716     *
15717     * @see elm_photocam_zoom_set()
15718     * @see elm_photocam_zoom_mode_set()
15719     */
15720    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15721    /**
15722     * @brief Set the zoom mode
15723     *
15724     * @param obj The photocam object
15725     * @param mode The desired mode
15726     *
15727     * This sets the zoom mode to manual or one of several automatic levels.
15728     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
15729     * elm_photocam_zoom_set() and will stay at that level until changed by code
15730     * or until zoom mode is changed. This is the default mode. The Automatic
15731     * modes will allow the photocam object to automatically adjust zoom mode
15732     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
15733     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
15734     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
15735     * pixels within the frame are left unfilled.
15736     */
15737    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
15738    /**
15739     * @brief Get the zoom mode
15740     *
15741     * @param obj The photocam object
15742     * @return The current zoom mode
15743     *
15744     * This gets the current zoom mode of the photocam object.
15745     *
15746     * @see elm_photocam_zoom_mode_set()
15747     */
15748    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15749    /**
15750     * @brief Get the current image pixel width and height
15751     *
15752     * @param obj The photocam object
15753     * @param w A pointer to the width return
15754     * @param h A pointer to the height return
15755     *
15756     * This gets the current photo pixel width and height (for the original).
15757     * The size will be returned in the integers @p w and @p h that are pointed
15758     * to.
15759     */
15760    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
15761    /**
15762     * @brief Get the area of the image that is currently shown
15763     *
15764     * @param obj
15765     * @param x A pointer to the X-coordinate of region
15766     * @param y A pointer to the Y-coordinate of region
15767     * @param w A pointer to the width
15768     * @param h A pointer to the height
15769     *
15770     * @see elm_photocam_image_region_show()
15771     * @see elm_photocam_image_region_bring_in()
15772     */
15773    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
15774    /**
15775     * @brief Set the viewed portion of the image
15776     *
15777     * @param obj The photocam object
15778     * @param x X-coordinate of region in image original pixels
15779     * @param y Y-coordinate of region in image original pixels
15780     * @param w Width of region in image original pixels
15781     * @param h Height of region in image original pixels
15782     *
15783     * This shows the region of the image without using animation.
15784     */
15785    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
15786    /**
15787     * @brief Bring in the viewed portion of the image
15788     *
15789     * @param obj The photocam object
15790     * @param x X-coordinate of region in image original pixels
15791     * @param y Y-coordinate of region in image original pixels
15792     * @param w Width of region in image original pixels
15793     * @param h Height of region in image original pixels
15794     *
15795     * This shows the region of the image using animation.
15796     */
15797    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
15798    /**
15799     * @brief Set the paused state for photocam
15800     *
15801     * @param obj The photocam object
15802     * @param paused The pause state to set
15803     *
15804     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
15805     * photocam. The default is off. This will stop zooming using animation on
15806     * zoom levels changes and change instantly. This will stop any existing
15807     * animations that are running.
15808     */
15809    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
15810    /**
15811     * @brief Get the paused state for photocam
15812     *
15813     * @param obj The photocam object
15814     * @return The current paused state
15815     *
15816     * This gets the current paused state for the photocam object.
15817     *
15818     * @see elm_photocam_paused_set()
15819     */
15820    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15821    /**
15822     * @brief Get the internal low-res image used for photocam
15823     *
15824     * @param obj The photocam object
15825     * @return The internal image object handle, or NULL if none exists
15826     *
15827     * This gets the internal image object inside photocam. Do not modify it. It
15828     * is for inspection only, and hooking callbacks to. Nothing else. It may be
15829     * deleted at any time as well.
15830     */
15831    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15832    /**
15833     * @brief Set the photocam scrolling bouncing.
15834     *
15835     * @param obj The photocam object
15836     * @param h_bounce bouncing for horizontal
15837     * @param v_bounce bouncing for vertical
15838     */
15839    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15840    /**
15841     * @brief Get the photocam scrolling bouncing.
15842     *
15843     * @param obj The photocam object
15844     * @param h_bounce bouncing for horizontal
15845     * @param v_bounce bouncing for vertical
15846     *
15847     * @see elm_photocam_bounce_set()
15848     */
15849    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15850    /**
15851     * @}
15852     */
15853
15854    /* map */
15855    typedef enum _Elm_Map_Zoom_Mode
15856      {
15857         ELM_MAP_ZOOM_MODE_MANUAL,
15858         ELM_MAP_ZOOM_MODE_AUTO_FIT,
15859         ELM_MAP_ZOOM_MODE_AUTO_FILL,
15860         ELM_MAP_ZOOM_MODE_LAST
15861      } Elm_Map_Zoom_Mode;
15862
15863    typedef enum _Elm_Map_Route_Sources
15864      {
15865         ELM_MAP_ROUTE_SOURCE_YOURS,
15866         ELM_MAP_ROUTE_SOURCE_MONAV,
15867         ELM_MAP_ROUTE_SOURCE_ORS,
15868         ELM_MAP_ROUTE_SOURCE_LAST
15869      } Elm_Map_Route_Sources;
15870
15871    typedef enum _Elm_Map_Name_Sources
15872      {
15873         ELM_MAP_NAME_SOURCE_NOMINATIM,
15874         ELM_MAP_NAME_SOURCE_LAST
15875      } Elm_Map_Name_Sources;
15876
15877    typedef enum _Elm_Map_Route_Type
15878      {
15879         ELM_MAP_ROUTE_TYPE_MOTOCAR,
15880         ELM_MAP_ROUTE_TYPE_BICYCLE,
15881         ELM_MAP_ROUTE_TYPE_FOOT,
15882         ELM_MAP_ROUTE_TYPE_LAST
15883      } Elm_Map_Route_Type;
15884
15885    typedef enum _Elm_Map_Route_Method
15886      {
15887         ELM_MAP_ROUTE_METHOD_FASTEST,
15888         ELM_MAP_ROUTE_METHOD_SHORTEST,
15889         ELM_MAP_ROUTE_METHOD_LAST
15890      } Elm_Map_Route_Method;
15891
15892    typedef enum _Elm_Map_Name_Method
15893      {
15894         ELM_MAP_NAME_METHOD_SEARCH,
15895         ELM_MAP_NAME_METHOD_REVERSE,
15896         ELM_MAP_NAME_METHOD_LAST
15897      } Elm_Map_Name_Method;
15898
15899    typedef struct _Elm_Map_Marker          Elm_Map_Marker;
15900    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class;
15901    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class;
15902    typedef struct _Elm_Map_Route           Elm_Map_Route;
15903    typedef struct _Elm_Map_Name            Elm_Map_Name;
15904    typedef struct _Elm_Map_Track           Elm_Map_Track;
15905
15906    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
15907    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
15908    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
15909    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data);
15910
15911    typedef char        *(*ElmMapModuleSourceFunc) (void);
15912    typedef int          (*ElmMapModuleZoomMinFunc) (void);
15913    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
15914    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
15915    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
15916    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
15917    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
15918    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
15919    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
15920
15921    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15922    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
15923    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15924    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
15925    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15926    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
15927    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
15928    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
15929    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
15930    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15931    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
15932    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15933    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
15934    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);
15935    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);
15936    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
15937    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
15938    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);
15939    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);
15940    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
15941    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
15942    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
15943    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
15944    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
15945    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
15946    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
15947    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
15948    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15949    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
15950    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
15951    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
15952    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
15953    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
15954    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
15955    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
15956    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
15957    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
15958    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
15959    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
15960    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
15961    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15962    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
15963    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15964    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
15965    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15966    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
15967    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15968    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
15969    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15970    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
15971    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15972    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);
15973    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
15974    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
15975    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
15976    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
15977    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
15978    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
15979    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
15980    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
15981    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
15982    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
15983    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);
15984    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15985    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15986 #ifdef ELM_EMAP
15987    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
15988 #endif
15989    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
15990
15991    /* smart callbacks called:
15992     * "clicked" - when image clicked
15993     * "press" - when mouse/finger held down initially on image
15994     * "longpressed" - when mouse/finger held for long time on image
15995     * "clicked,double" - when mouse/finger double-clicked
15996     * "load,details" - when detailed image load begins
15997     * "loaded,details" - when detailed image load done
15998     * "zoom,start" - when zooming started
15999     * "zoom,stop" - when zooming stopped
16000     * "zoom,change" - when auto zoom mode changed zoom level
16001     * "scroll - the content has been scrolled (moved)
16002     * "scroll,anim,start" - scrolling animation has started
16003     * "scroll,anim,stop" - scrolling animation has stopped
16004     * "scroll,drag,start" - dragging the contents around has started
16005     * "scroll,drag,stop" - dragging the contents around has stopped
16006     */
16007
16008    /* Route */
16009    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
16010 #ifdef ELM_EMAP
16011    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
16012 #endif
16013    EAPI double elm_route_lon_min_get(Evas_Object *obj);
16014    EAPI double elm_route_lat_min_get(Evas_Object *obj);
16015    EAPI double elm_route_lon_max_get(Evas_Object *obj);
16016    EAPI double elm_route_lat_max_get(Evas_Object *obj);
16017
16018
16019    /**
16020     * @defgroup Panel Panel
16021     *
16022     * @image html img/widget/panel/preview-00.png
16023     * @image latex img/widget/panel/preview-00.eps
16024     *
16025     * @brief A panel is a type of animated container that contains subobjects.
16026     * It can be expanded or contracted by clicking the button on it's edge.
16027     *
16028     * Orientations are as follows:
16029     * @li ELM_PANEL_ORIENT_TOP
16030     * @li ELM_PANEL_ORIENT_LEFT
16031     * @li ELM_PANEL_ORIENT_RIGHT
16032     *
16033     * @ref tutorial_panel shows one way to use this widget.
16034     * @{
16035     */
16036    typedef enum _Elm_Panel_Orient
16037      {
16038         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
16039         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
16040         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
16041         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
16042      } Elm_Panel_Orient;
16043    /**
16044     * @brief Adds a panel object
16045     *
16046     * @param parent The parent object
16047     *
16048     * @return The panel object, or NULL on failure
16049     */
16050    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16051    /**
16052     * @brief Sets the orientation of the panel
16053     *
16054     * @param parent The parent object
16055     * @param orient The panel orientation. Can be one of the following:
16056     * @li ELM_PANEL_ORIENT_TOP
16057     * @li ELM_PANEL_ORIENT_LEFT
16058     * @li ELM_PANEL_ORIENT_RIGHT
16059     *
16060     * Sets from where the panel will (dis)appear.
16061     */
16062    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
16063    /**
16064     * @brief Get the orientation of the panel.
16065     *
16066     * @param obj The panel object
16067     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
16068     */
16069    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16070    /**
16071     * @brief Set the content of the panel.
16072     *
16073     * @param obj The panel object
16074     * @param content The panel content
16075     *
16076     * Once the content object is set, a previously set one will be deleted.
16077     * If you want to keep that old content object, use the
16078     * elm_panel_content_unset() function.
16079     */
16080    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16081    /**
16082     * @brief Get the content of the panel.
16083     *
16084     * @param obj The panel object
16085     * @return The content that is being used
16086     *
16087     * Return the content object which is set for this widget.
16088     *
16089     * @see elm_panel_content_set()
16090     */
16091    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16092    /**
16093     * @brief Unset the content of the panel.
16094     *
16095     * @param obj The panel object
16096     * @return The content that was being used
16097     *
16098     * Unparent and return the content object which was set for this widget.
16099     *
16100     * @see elm_panel_content_set()
16101     */
16102    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16103    /**
16104     * @brief Set the state of the panel.
16105     *
16106     * @param obj The panel object
16107     * @param hidden If true, the panel will run the animation to contract
16108     */
16109    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
16110    /**
16111     * @brief Get the state of the panel.
16112     *
16113     * @param obj The panel object
16114     * @param hidden If true, the panel is in the "hide" state
16115     */
16116    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16117    /**
16118     * @brief Toggle the hidden state of the panel from code
16119     *
16120     * @param obj The panel object
16121     */
16122    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
16123    /**
16124     * @}
16125     */
16126
16127    /**
16128     * @defgroup Panes Panes
16129     * @ingroup Elementary
16130     *
16131     * @image html img/widget/panes/preview-00.png
16132     * @image latex img/widget/panes/preview-00.eps width=\textwidth
16133     *
16134     * @image html img/panes.png
16135     * @image latex img/panes.eps width=\textwidth
16136     *
16137     * The panes adds a dragable bar between two contents. When dragged
16138     * this bar will resize contents size.
16139     *
16140     * Panes can be displayed vertically or horizontally, and contents
16141     * size proportion can be customized (homogeneous by default).
16142     *
16143     * Smart callbacks one can listen to:
16144     * - "press" - The panes has been pressed (button wasn't released yet).
16145     * - "unpressed" - The panes was released after being pressed.
16146     * - "clicked" - The panes has been clicked>
16147     * - "clicked,double" - The panes has been double clicked
16148     *
16149     * Available styles for it:
16150     * - @c "default"
16151     *
16152     * Here is an example on its usage:
16153     * @li @ref panes_example
16154     */
16155
16156    /**
16157     * @addtogroup Panes
16158     * @{
16159     */
16160
16161    /**
16162     * Add a new panes widget to the given parent Elementary
16163     * (container) object.
16164     *
16165     * @param parent The parent object.
16166     * @return a new panes widget handle or @c NULL, on errors.
16167     *
16168     * This function inserts a new panes widget on the canvas.
16169     *
16170     * @ingroup Panes
16171     */
16172    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16173
16174    /**
16175     * Set the left content of the panes widget.
16176     *
16177     * @param obj The panes object.
16178     * @param content The new left content object.
16179     *
16180     * Once the content object is set, a previously set one will be deleted.
16181     * If you want to keep that old content object, use the
16182     * elm_panes_content_left_unset() function.
16183     *
16184     * If panes is displayed vertically, left content will be displayed at
16185     * top.
16186     *
16187     * @see elm_panes_content_left_get()
16188     * @see elm_panes_content_right_set() to set content on the other side.
16189     *
16190     * @ingroup Panes
16191     */
16192    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16193
16194    /**
16195     * Set the right content of the panes widget.
16196     *
16197     * @param obj The panes object.
16198     * @param content The new right content object.
16199     *
16200     * Once the content object is set, a previously set one will be deleted.
16201     * If you want to keep that old content object, use the
16202     * elm_panes_content_right_unset() function.
16203     *
16204     * If panes is displayed vertically, left content will be displayed at
16205     * bottom.
16206     *
16207     * @see elm_panes_content_right_get()
16208     * @see elm_panes_content_left_set() to set content on the other side.
16209     *
16210     * @ingroup Panes
16211     */
16212    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16213
16214    /**
16215     * Get the left content of the panes.
16216     *
16217     * @param obj The panes object.
16218     * @return The left content object that is being used.
16219     *
16220     * Return the left content object which is set for this widget.
16221     *
16222     * @see elm_panes_content_left_set() for details.
16223     *
16224     * @ingroup Panes
16225     */
16226    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16227
16228    /**
16229     * Get the right content of the panes.
16230     *
16231     * @param obj The panes object
16232     * @return The right content object that is being used
16233     *
16234     * Return the right content object which is set for this widget.
16235     *
16236     * @see elm_panes_content_right_set() for details.
16237     *
16238     * @ingroup Panes
16239     */
16240    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16241
16242    /**
16243     * Unset the left content used for the panes.
16244     *
16245     * @param obj The panes object.
16246     * @return The left content object that was being used.
16247     *
16248     * Unparent and return the left content object which was set for this widget.
16249     *
16250     * @see elm_panes_content_left_set() for details.
16251     * @see elm_panes_content_left_get().
16252     *
16253     * @ingroup Panes
16254     */
16255    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16256
16257    /**
16258     * Unset the right content used for the panes..
16259     *
16260     * @param obj The panes object.
16261     * @return The right content object that was being used.
16262     *
16263     * Unparent and return the right content object which was set for this
16264     * widget.
16265     *
16266     * @see elm_panes_content_right_set() for details.
16267     * @see elm_panes_content_right_get().
16268     *
16269     * @ingroup Panes
16270     */
16271    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16272
16273    /**
16274     * Get the size proportion of panes widget's left side.
16275     *
16276     * @param obj The panes object.
16277     * @return float value between 0.0 and 1.0 representing size proportion
16278     * of left side.
16279     *
16280     * @see elm_panes_content_left_size_set() for more details.
16281     *
16282     * @ingroup Panes
16283     */
16284    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16285
16286    /**
16287     * Set the size proportion of panes widget's left side.
16288     *
16289     * @param obj The panes object.
16290     * @param size Value between 0.0 and 1.0 representing size proportion
16291     * of left side.
16292     *
16293     * By default it's homogeneous, i.e., both sides have the same size.
16294     *
16295     * If something different is required, it can be set with this function.
16296     * For example, if the left content should be displayed over
16297     * 75% of the panes size, @p size should be passed as @c 0.75.
16298     * This way, right content will be resized to 25% of panes size.
16299     *
16300     * If displayed vertically, left content is displayed at top, and
16301     * right content at bottom.
16302     *
16303     * @note This proportion will change when user drags the panes bar.
16304     *
16305     * @see elm_panes_content_left_size_get()
16306     *
16307     * @ingroup Panes
16308     */
16309    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
16310
16311   /**
16312    * Set the orientation of a given panes widget.
16313    *
16314    * @param obj The panes object.
16315    * @param horizontal Use @c EINA_TRUE to make @p obj to be
16316    * @b horizontal, @c EINA_FALSE to make it @b vertical.
16317    *
16318    * Use this function to change how your panes is to be
16319    * disposed: vertically or horizontally.
16320    *
16321    * By default it's displayed horizontally.
16322    *
16323    * @see elm_panes_horizontal_get()
16324    *
16325    * @ingroup Panes
16326    */
16327    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16328
16329    /**
16330     * Retrieve the orientation of a given panes widget.
16331     *
16332     * @param obj The panes object.
16333     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16334     * @c EINA_FALSE if it's @b vertical (and on errors).
16335     *
16336     * @see elm_panes_horizontal_set() for more details.
16337     *
16338     * @ingroup Panes
16339     */
16340    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16341
16342    /**
16343     * @}
16344     */
16345
16346    /**
16347     * @defgroup Flip Flip
16348     *
16349     * @image html img/widget/flip/preview-00.png
16350     * @image latex img/widget/flip/preview-00.eps
16351     *
16352     * This widget holds 2 content objects(Evas_Object): one on the front and one
16353     * on the back. It allows you to flip from front to back and vice-versa using
16354     * various animations.
16355     *
16356     * If either the front or back contents are not set the flip will treat that
16357     * as transparent. So if you wore to set the front content but not the back,
16358     * and then call elm_flip_go() you would see whatever is below the flip.
16359     *
16360     * For a list of supported animations see elm_flip_go().
16361     *
16362     * Signals that you can add callbacks for are:
16363     * "animate,begin" - when a flip animation was started
16364     * "animate,done" - when a flip animation is finished
16365     *
16366     * @ref tutorial_flip show how to use most of the API.
16367     *
16368     * @{
16369     */
16370    typedef enum _Elm_Flip_Mode
16371      {
16372         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
16373         ELM_FLIP_ROTATE_X_CENTER_AXIS,
16374         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
16375         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
16376         ELM_FLIP_CUBE_LEFT,
16377         ELM_FLIP_CUBE_RIGHT,
16378         ELM_FLIP_CUBE_UP,
16379         ELM_FLIP_CUBE_DOWN,
16380         ELM_FLIP_PAGE_LEFT,
16381         ELM_FLIP_PAGE_RIGHT,
16382         ELM_FLIP_PAGE_UP,
16383         ELM_FLIP_PAGE_DOWN
16384      } Elm_Flip_Mode;
16385    typedef enum _Elm_Flip_Interaction
16386      {
16387         ELM_FLIP_INTERACTION_NONE,
16388         ELM_FLIP_INTERACTION_ROTATE,
16389         ELM_FLIP_INTERACTION_CUBE,
16390         ELM_FLIP_INTERACTION_PAGE
16391      } Elm_Flip_Interaction;
16392    typedef enum _Elm_Flip_Direction
16393      {
16394         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
16395         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
16396         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
16397         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
16398      } Elm_Flip_Direction;
16399    /**
16400     * @brief Add a new flip to the parent
16401     *
16402     * @param parent The parent object
16403     * @return The new object or NULL if it cannot be created
16404     */
16405    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16406    /**
16407     * @brief Set the front content of the flip widget.
16408     *
16409     * @param obj The flip object
16410     * @param content The new front content object
16411     *
16412     * Once the content object is set, a previously set one will be deleted.
16413     * If you want to keep that old content object, use the
16414     * elm_flip_content_front_unset() function.
16415     */
16416    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16417    /**
16418     * @brief Set the back content of the flip widget.
16419     *
16420     * @param obj The flip object
16421     * @param content The new back content object
16422     *
16423     * Once the content object is set, a previously set one will be deleted.
16424     * If you want to keep that old content object, use the
16425     * elm_flip_content_back_unset() function.
16426     */
16427    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16428    /**
16429     * @brief Get the front content used for the flip
16430     *
16431     * @param obj The flip object
16432     * @return The front content object that is being used
16433     *
16434     * Return the front content object which is set for this widget.
16435     */
16436    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16437    /**
16438     * @brief Get the back content used for the flip
16439     *
16440     * @param obj The flip object
16441     * @return The back content object that is being used
16442     *
16443     * Return the back content object which is set for this widget.
16444     */
16445    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16446    /**
16447     * @brief Unset the front content used for the flip
16448     *
16449     * @param obj The flip object
16450     * @return The front content object that was being used
16451     *
16452     * Unparent and return the front content object which was set for this widget.
16453     */
16454    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16455    /**
16456     * @brief Unset the back content used for the flip
16457     *
16458     * @param obj The flip object
16459     * @return The back content object that was being used
16460     *
16461     * Unparent and return the back content object which was set for this widget.
16462     */
16463    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16464    /**
16465     * @brief Get flip front visibility state
16466     *
16467     * @param obj The flip objct
16468     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
16469     * showing.
16470     */
16471    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16472    /**
16473     * @brief Set flip perspective
16474     *
16475     * @param obj The flip object
16476     * @param foc The coordinate to set the focus on
16477     * @param x The X coordinate
16478     * @param y The Y coordinate
16479     *
16480     * @warning This function currently does nothing.
16481     */
16482    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16483    /**
16484     * @brief Runs the flip animation
16485     *
16486     * @param obj The flip object
16487     * @param mode The mode type
16488     *
16489     * Flips the front and back contents using the @p mode animation. This
16490     * efectively hides the currently visible content and shows the hidden one.
16491     *
16492     * There a number of possible animations to use for the flipping:
16493     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
16494     * around a horizontal axis in the middle of its height, the other content
16495     * is shown as the other side of the flip.
16496     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
16497     * around a vertical axis in the middle of its width, the other content is
16498     * shown as the other side of the flip.
16499     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
16500     * around a diagonal axis in the middle of its width, the other content is
16501     * shown as the other side of the flip.
16502     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
16503     * around a diagonal axis in the middle of its height, the other content is
16504     * shown as the other side of the flip.
16505     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
16506     * as if the flip was a cube, the other content is show as the right face of
16507     * the cube.
16508     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
16509     * right as if the flip was a cube, the other content is show as the left
16510     * face of the cube.
16511     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
16512     * flip was a cube, the other content is show as the bottom face of the cube.
16513     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
16514     * the flip was a cube, the other content is show as the upper face of the
16515     * cube.
16516     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
16517     * if the flip was a book, the other content is shown as the page below that.
16518     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
16519     * as if the flip was a book, the other content is shown as the page below
16520     * that.
16521     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
16522     * flip was a book, the other content is shown as the page below that.
16523     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
16524     * flip was a book, the other content is shown as the page below that.
16525     */
16526    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
16527    /**
16528     * @brief Set the interactive flip mode
16529     *
16530     * @param obj The flip object
16531     * @param mode The interactive flip mode to use
16532     *
16533     * This sets if the flip should be interactive (allow user to click and
16534     * drag a side of the flip to reveal the back page and cause it to flip).
16535     * By default a flip is not interactive. You may also need to set which
16536     * sides of the flip are "active" for flipping and how much space they use
16537     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
16538     * and elm_flip_interacton_direction_hitsize_set()
16539     *
16540     * The four avilable mode of interaction are:
16541     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
16542     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
16543     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
16544     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
16545     *
16546     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
16547     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
16548     * happen, those can only be acheived with elm_flip_go();
16549     */
16550    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
16551    /**
16552     * @brief Get the interactive flip mode
16553     *
16554     * @param obj The flip object
16555     * @return The interactive flip mode
16556     *
16557     * Returns the interactive flip mode set by elm_flip_interaction_set()
16558     */
16559    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
16560    /**
16561     * @brief Set which directions of the flip respond to interactive flip
16562     *
16563     * @param obj The flip object
16564     * @param dir The direction to change
16565     * @param enabled If that direction is enabled or not
16566     *
16567     * By default all directions are disabled, so you may want to enable the
16568     * desired directions for flipping if you need interactive flipping. You must
16569     * call this function once for each direction that should be enabled.
16570     *
16571     * @see elm_flip_interaction_set()
16572     */
16573    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
16574    /**
16575     * @brief Get the enabled state of that flip direction
16576     *
16577     * @param obj The flip object
16578     * @param dir The direction to check
16579     * @return If that direction is enabled or not
16580     *
16581     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
16582     *
16583     * @see elm_flip_interaction_set()
16584     */
16585    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
16586    /**
16587     * @brief Set the amount of the flip that is sensitive to interactive flip
16588     *
16589     * @param obj The flip object
16590     * @param dir The direction to modify
16591     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
16592     *
16593     * Set the amount of the flip that is sensitive to interactive flip, with 0
16594     * representing no area in the flip and 1 representing the entire flip. There
16595     * is however a consideration to be made in that the area will never be
16596     * smaller than the finger size set(as set in your Elementary configuration).
16597     *
16598     * @see elm_flip_interaction_set()
16599     */
16600    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
16601    /**
16602     * @brief Get the amount of the flip that is sensitive to interactive flip
16603     *
16604     * @param obj The flip object
16605     * @param dir The direction to check
16606     * @return The size set for that direction
16607     *
16608     * Returns the amount os sensitive area set by
16609     * elm_flip_interacton_direction_hitsize_set().
16610     */
16611    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
16612    /**
16613     * @}
16614     */
16615
16616    /* scrolledentry */
16617    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16618    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
16619    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16620    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
16621    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16622    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
16623    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16624    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
16625    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16626    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16627    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
16628    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
16629    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
16630    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16631    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
16632    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
16633    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16634    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
16635    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
16636    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
16637    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
16638    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
16639    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
16640    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
16641    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
16642    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
16643    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16644    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16645    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16646    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
16647    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16648    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
16649    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
16650    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
16651    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16652    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);
16653    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16654    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16655    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);
16656    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16657    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);
16658    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
16659    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16660    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16661    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
16662    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
16663    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16664    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16665    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
16666    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);
16667    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);
16668    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);
16669    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);
16670    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);
16671    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);
16672    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
16673    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
16674    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
16675    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
16676    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16677    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
16678    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16679
16680    /**
16681     * @defgroup Conformant Conformant
16682     * @ingroup Elementary
16683     *
16684     * @image html img/widget/conformant/preview-00.png
16685     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
16686     *
16687     * @image html img/conformant.png
16688     * @image latex img/conformant.eps width=\textwidth
16689     *
16690     * The aim is to provide a widget that can be used in elementary apps to
16691     * account for space taken up by the indicator, virtual keypad & softkey
16692     * windows when running the illume2 module of E17.
16693     *
16694     * So conformant content will be sized and positioned considering the
16695     * space required for such stuff, and when they popup, as a keyboard
16696     * shows when an entry is selected, conformant content won't change.
16697     *
16698     * Available styles for it:
16699     * - @c "default"
16700     *
16701     * See how to use this widget in this example:
16702     * @ref conformant_example
16703     */
16704
16705    /**
16706     * @addtogroup Conformant
16707     * @{
16708     */
16709
16710    /**
16711     * Add a new conformant widget to the given parent Elementary
16712     * (container) object.
16713     *
16714     * @param parent The parent object.
16715     * @return A new conformant widget handle or @c NULL, on errors.
16716     *
16717     * This function inserts a new conformant widget on the canvas.
16718     *
16719     * @ingroup Conformant
16720     */
16721    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16722
16723    /**
16724     * Set the content of the conformant widget.
16725     *
16726     * @param obj The conformant object.
16727     * @param content The content to be displayed by the conformant.
16728     *
16729     * Content will be sized and positioned considering the space required
16730     * to display a virtual keyboard. So it won't fill all the conformant
16731     * size. This way is possible to be sure that content won't resize
16732     * or be re-positioned after the keyboard is displayed.
16733     *
16734     * Once the content object is set, a previously set one will be deleted.
16735     * If you want to keep that old content object, use the
16736     * elm_conformat_content_unset() function.
16737     *
16738     * @see elm_conformant_content_unset()
16739     * @see elm_conformant_content_get()
16740     *
16741     * @ingroup Conformant
16742     */
16743    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16744
16745    /**
16746     * Get the content of the conformant widget.
16747     *
16748     * @param obj The conformant object.
16749     * @return The content that is being used.
16750     *
16751     * Return the content object which is set for this widget.
16752     * It won't be unparent from conformant. For that, use
16753     * elm_conformant_content_unset().
16754     *
16755     * @see elm_conformant_content_set() for more details.
16756     * @see elm_conformant_content_unset()
16757     *
16758     * @ingroup Conformant
16759     */
16760    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16761
16762    /**
16763     * Unset the content of the conformant widget.
16764     *
16765     * @param obj The conformant object.
16766     * @return The content that was being used.
16767     *
16768     * Unparent and return the content object which was set for this widget.
16769     *
16770     * @see elm_conformant_content_set() for more details.
16771     *
16772     * @ingroup Conformant
16773     */
16774    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16775
16776    /**
16777     * Returns the Evas_Object that represents the content area.
16778     *
16779     * @param obj The conformant object.
16780     * @return The content area of the widget.
16781     *
16782     * @ingroup Conformant
16783     */
16784    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16785
16786    /**
16787     * @}
16788     */
16789
16790    /* mapbuf */
16791    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16792    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16793    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16794    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16795    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
16796    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16797    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
16798    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16799    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
16800    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16801
16802    /**
16803     * @defgroup Flipselector Flip Selector
16804     *
16805     * @image html img/widget/flipselector/preview-00.png
16806     * @image latex img/widget/flipselector/preview-00.eps
16807     *
16808     * A flip selector is a widget to show a set of @b text items, one
16809     * at a time, with the same sheet switching style as the @ref Clock
16810     * "clock" widget, when one changes the current displaying sheet
16811     * (thus, the "flip" in the name).
16812     *
16813     * User clicks to flip sheets which are @b held for some time will
16814     * make the flip selector to flip continuosly and automatically for
16815     * the user. The interval between flips will keep growing in time,
16816     * so that it helps the user to reach an item which is distant from
16817     * the current selection.
16818     *
16819     * Smart callbacks one can register to:
16820     * - @c "selected" - when the widget's selected text item is changed
16821     * - @c "overflowed" - when the widget's current selection is changed
16822     *   from the first item in its list to the last
16823     * - @c "underflowed" - when the widget's current selection is changed
16824     *   from the last item in its list to the first
16825     *
16826     * Available styles for it:
16827     * - @c "default"
16828     *
16829     * Here is an example on its usage:
16830     * @li @ref flipselector_example
16831     */
16832
16833    /**
16834     * @addtogroup Flipselector
16835     * @{
16836     */
16837
16838    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
16839
16840    /**
16841     * Add a new flip selector widget to the given parent Elementary
16842     * (container) widget
16843     *
16844     * @param parent The parent object
16845     * @return a new flip selector widget handle or @c NULL, on errors
16846     *
16847     * This function inserts a new flip selector widget on the canvas.
16848     *
16849     * @ingroup Flipselector
16850     */
16851    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16852
16853    /**
16854     * Programmatically select the next item of a flip selector widget
16855     *
16856     * @param obj The flipselector object
16857     *
16858     * @note The selection will be animated. Also, if it reaches the
16859     * end of its list of member items, it will continue with the first
16860     * one onwards.
16861     *
16862     * @ingroup Flipselector
16863     */
16864    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16865
16866    /**
16867     * Programmatically select the previous item of a flip selector
16868     * widget
16869     *
16870     * @param obj The flipselector object
16871     *
16872     * @note The selection will be animated.  Also, if it reaches the
16873     * beginning of its list of member items, it will continue with the
16874     * last one backwards.
16875     *
16876     * @ingroup Flipselector
16877     */
16878    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
16879
16880    /**
16881     * Append a (text) item to a flip selector widget
16882     *
16883     * @param obj The flipselector object
16884     * @param label The (text) label of the new item
16885     * @param func Convenience callback function to take place when
16886     * item is selected
16887     * @param data Data passed to @p func, above
16888     * @return A handle to the item added or @c NULL, on errors
16889     *
16890     * The widget's list of labels to show will be appended with the
16891     * given value. If the user wishes so, a callback function pointer
16892     * can be passed, which will get called when this same item is
16893     * selected.
16894     *
16895     * @note The current selection @b won't be modified by appending an
16896     * element to the list.
16897     *
16898     * @note The maximum length of the text label is going to be
16899     * determined <b>by the widget's theme</b>. Strings larger than
16900     * that value are going to be @b truncated.
16901     *
16902     * @ingroup Flipselector
16903     */
16904    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
16905
16906    /**
16907     * Prepend a (text) item to a flip selector widget
16908     *
16909     * @param obj The flipselector object
16910     * @param label The (text) label of the new item
16911     * @param func Convenience callback function to take place when
16912     * item is selected
16913     * @param data Data passed to @p func, above
16914     * @return A handle to the item added or @c NULL, on errors
16915     *
16916     * The widget's list of labels to show will be prepended with the
16917     * given value. If the user wishes so, a callback function pointer
16918     * can be passed, which will get called when this same item is
16919     * selected.
16920     *
16921     * @note The current selection @b won't be modified by prepending
16922     * an element to the list.
16923     *
16924     * @note The maximum length of the text label is going to be
16925     * determined <b>by the widget's theme</b>. Strings larger than
16926     * that value are going to be @b truncated.
16927     *
16928     * @ingroup Flipselector
16929     */
16930    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
16931
16932    /**
16933     * Get the internal list of items in a given flip selector widget.
16934     *
16935     * @param obj The flipselector object
16936     * @return The list of items (#Elm_Flipselector_Item as data) or
16937     * @c NULL on errors.
16938     *
16939     * This list is @b not to be modified in any way and must not be
16940     * freed. Use the list members with functions like
16941     * elm_flipselector_item_label_set(),
16942     * elm_flipselector_item_label_get(),
16943     * elm_flipselector_item_del(),
16944     * elm_flipselector_item_selected_get(),
16945     * elm_flipselector_item_selected_set().
16946     *
16947     * @warning This list is only valid until @p obj object's internal
16948     * items list is changed. It should be fetched again with another
16949     * call to this function when changes happen.
16950     *
16951     * @ingroup Flipselector
16952     */
16953    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16954
16955    /**
16956     * Get the first item in the given flip selector widget's list of
16957     * items.
16958     *
16959     * @param obj The flipselector object
16960     * @return The first item or @c NULL, if it has no items (and on
16961     * errors)
16962     *
16963     * @see elm_flipselector_item_append()
16964     * @see elm_flipselector_last_item_get()
16965     *
16966     * @ingroup Flipselector
16967     */
16968    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16969
16970    /**
16971     * Get the last item in the given flip selector widget's list of
16972     * items.
16973     *
16974     * @param obj The flipselector object
16975     * @return The last item or @c NULL, if it has no items (and on
16976     * errors)
16977     *
16978     * @see elm_flipselector_item_prepend()
16979     * @see elm_flipselector_first_item_get()
16980     *
16981     * @ingroup Flipselector
16982     */
16983    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16984
16985    /**
16986     * Get the currently selected item in a flip selector widget.
16987     *
16988     * @param obj The flipselector object
16989     * @return The selected item or @c NULL, if the widget has no items
16990     * (and on erros)
16991     *
16992     * @ingroup Flipselector
16993     */
16994    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16995
16996    /**
16997     * Set whether a given flip selector widget's item should be the
16998     * currently selected one.
16999     *
17000     * @param item The flip selector item
17001     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
17002     *
17003     * This sets whether @p item is or not the selected (thus, under
17004     * display) one. If @p item is different than one under display,
17005     * the latter will be unselected. If the @p item is set to be
17006     * unselected, on the other hand, the @b first item in the widget's
17007     * internal members list will be the new selected one.
17008     *
17009     * @see elm_flipselector_item_selected_get()
17010     *
17011     * @ingroup Flipselector
17012     */
17013    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17014
17015    /**
17016     * Get whether a given flip selector widget's item is the currently
17017     * selected one.
17018     *
17019     * @param item The flip selector item
17020     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17021     * (or on errors).
17022     *
17023     * @see elm_flipselector_item_selected_set()
17024     *
17025     * @ingroup Flipselector
17026     */
17027    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
17028
17029    /**
17030     * Delete a given item from a flip selector widget.
17031     *
17032     * @param item The item to delete
17033     *
17034     * @ingroup Flipselector
17035     */
17036    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
17037
17038    /**
17039     * Get the label of a given flip selector widget's item.
17040     *
17041     * @param item The item to get label from
17042     * @return The text label of @p item or @c NULL, on errors
17043     *
17044     * @see elm_flipselector_item_label_set()
17045     *
17046     * @ingroup Flipselector
17047     */
17048    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
17049
17050    /**
17051     * Set the label of a given flip selector widget's item.
17052     *
17053     * @param item The item to set label on
17054     * @param label The text label string, in UTF-8 encoding
17055     *
17056     * @see elm_flipselector_item_label_get()
17057     *
17058     * @ingroup Flipselector
17059     */
17060    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
17061
17062    /**
17063     * Gets the item before @p item in a flip selector widget's
17064     * internal list of items.
17065     *
17066     * @param item The item to fetch previous from
17067     * @return The item before the @p item, in its parent's list. If
17068     *         there is no previous item for @p item or there's an
17069     *         error, @c NULL is returned.
17070     *
17071     * @see elm_flipselector_item_next_get()
17072     *
17073     * @ingroup Flipselector
17074     */
17075    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
17076
17077    /**
17078     * Gets the item after @p item in a flip selector widget's
17079     * internal list of items.
17080     *
17081     * @param item The item to fetch next from
17082     * @return The item after the @p item, in its parent's list. If
17083     *         there is no next item for @p item or there's an
17084     *         error, @c NULL is returned.
17085     *
17086     * @see elm_flipselector_item_next_get()
17087     *
17088     * @ingroup Flipselector
17089     */
17090    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
17091
17092    /**
17093     * Set the interval on time updates for an user mouse button hold
17094     * on a flip selector widget.
17095     *
17096     * @param obj The flip selector object
17097     * @param interval The (first) interval value in seconds
17098     *
17099     * This interval value is @b decreased while the user holds the
17100     * mouse pointer either flipping up or flipping doww a given flip
17101     * selector.
17102     *
17103     * This helps the user to get to a given item distant from the
17104     * current one easier/faster, as it will start to flip quicker and
17105     * quicker on mouse button holds.
17106     *
17107     * The calculation for the next flip interval value, starting from
17108     * the one set with this call, is the previous interval divided by
17109     * 1.05, so it decreases a little bit.
17110     *
17111     * The default starting interval value for automatic flips is
17112     * @b 0.85 seconds.
17113     *
17114     * @see elm_flipselector_interval_get()
17115     *
17116     * @ingroup Flipselector
17117     */
17118    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17119
17120    /**
17121     * Get the interval on time updates for an user mouse button hold
17122     * on a flip selector widget.
17123     *
17124     * @param obj The flip selector object
17125     * @return The (first) interval value, in seconds, set on it
17126     *
17127     * @see elm_flipselector_interval_set() for more details
17128     *
17129     * @ingroup Flipselector
17130     */
17131    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17132
17133    /**
17134     * @}
17135     */
17136
17137    /**
17138     * @addtogroup Animator Animator
17139     * @ingroup Elementary
17140     *
17141     * @brief Functions to ease creation of animations.
17142     *
17143     * elm_animator is designed to provide an easy way to create animations.
17144     * Creating an animation with elm_animator is as simple as setting a
17145     * duration, an operating callback and telling it to run the animation.
17146     * However that is not the full extent of elm_animator's ability, animations
17147     * can be paused and resumed, reversed and the animation need not be linear.
17148     *
17149     * To run an animation you must specify at least a duration and operation
17150     * callback, not setting any other properties will create a linear animation
17151     * that runs once and is not reversed.
17152     *
17153     * @ref elm_animator_example_page_01 "This" example should make all of that
17154     * very clear.
17155     *
17156     * @warning elm_animator is @b not a widget.
17157     * @{
17158     */
17159    /**
17160     * @brief Type of curve desired for animation.
17161     *
17162     * The speed in which an animation happens doesn't have to be linear, some
17163     * animations will look better if they're accelerating or decelerating, so
17164     * elm_animator provides four options in this regard:
17165     *
17166     * @image html elm_animator_curve_style.png
17167     * @image latex elm_animator_curve_style.eps width=\textwidth
17168     * As can be seen in the image the speed of the animation will be:
17169     * @li ELM_ANIMATOR_CURVE_LINEAR constant
17170     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
17171     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
17172     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
17173     */
17174    typedef enum
17175      {
17176         ELM_ANIMATOR_CURVE_LINEAR,
17177         ELM_ANIMATOR_CURVE_IN_OUT,
17178         ELM_ANIMATOR_CURVE_IN,
17179         ELM_ANIMATOR_CURVE_OUT
17180      } Elm_Animator_Curve_Style;
17181    typedef struct _Elm_Animator Elm_Animator;
17182   /**
17183    * Called back per loop of an elementary animators cycle
17184    * @param data user-data given to elm_animator_operation_callback_set()
17185    * @param animator the animator being run
17186    * @param double the position in the animation
17187    */
17188    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
17189   /**
17190    * Called back when an elementary animator finishes
17191    * @param data user-data given to elm_animator_completion_callback_set()
17192    */
17193    typedef void (*Elm_Animator_Completion_Cb) (void *data);
17194
17195    /**
17196     * @brief Create a new animator.
17197     *
17198     * @param[in] parent Parent object
17199     *
17200     * The @a parent argument can be set to NULL for no parent. If a parent is set
17201     * there is no need to call elm_animator_del(), when the parent is deleted it
17202     * will delete the animator.
17203     * @deprecated Use @ref Transit instead.
17204     */
17205    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
17206    /**
17207     * Deletes the animator freeing any resources it used. If the animator was
17208     * created with a NULL parent this must be called, otherwise it will be
17209     * automatically called when the parent is deleted.
17210     *
17211     * @param[in] animator Animator object
17212     * @deprecated Use @ref Transit instead.
17213     */
17214    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
17215    /**
17216     * Set the duration of the animation.
17217     *
17218     * @param[in] animator Animator object
17219     * @param[in] duration Duration in second
17220     * @deprecated Use @ref Transit instead.
17221     */
17222    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
17223    /**
17224     * @brief Set the callback function for animator operation.
17225     *
17226     * @param[in] animator Animator object
17227     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
17228     * @param[in] data Callback function user argument
17229     *
17230     * The @p func callback will be called with a frame value in range [0, 1] which
17231     * indicates how far along the animation should be. It is the job of @p func to
17232     * actually change the state of any object(or objects) that are being animated.
17233     * @deprecated Use @ref Transit instead.
17234     */
17235    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
17236    /**
17237     * Set the callback function for the when the animation ends.
17238     *
17239     * @param[in]  animator Animator object
17240     * @param[in]  func   Callback function pointe
17241     * @param[in]  data Callback function user argument
17242     *
17243     * @warning @a func will not be executed if elm_animator_stop() is called.
17244     * @deprecated Use @ref Transit instead.
17245     */
17246    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
17247    /**
17248     * @brief Stop animator.
17249     *
17250     * @param[in] animator Animator object
17251     *
17252     * If called before elm_animator_animate() it does nothing. If there is an
17253     * animation in progress the animation will be stopped(the operation callback
17254     * will not be executed again) and it can't be restarted using
17255     * elm_animator_resume().
17256     * @deprecated Use @ref Transit instead.
17257     */
17258    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
17259    /**
17260     * Set the animator repeat count.
17261     *
17262     * @param[in]  animator Animator object
17263     * @param[in]  repeat_cnt Repeat count
17264     * @deprecated Use @ref Transit instead.
17265     */
17266    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
17267    /**
17268     * @brief Start animation.
17269     *
17270     * @param[in] animator Animator object
17271     *
17272     * This function starts the animation if the nescessary properties(duration
17273     * and operation callback) have been set. Once started the animation will
17274     * run until complete or elm_animator_stop() is called.
17275     * @deprecated Use @ref Transit instead.
17276     */
17277    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
17278    /**
17279     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
17280     *
17281     * @param[in] animator Animator object
17282     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
17283     * @deprecated Use @ref Transit instead.
17284     */
17285    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
17286    /**
17287     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
17288     *
17289     * @param[in] animator Animator object
17290     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
17291     * @deprecated Use @ref Transit instead.
17292     */
17293    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
17294    /**
17295     * @brief Sets wether the animation should be automatically reversed.
17296     *
17297     * @param[in] animator Animator object
17298     * @param[in] reverse Reverse or not
17299     *
17300     * This controls wether the animation will be run on reverse imediately after
17301     * running forward. When this is set together with repetition the animation
17302     * will run in reverse once for each time it ran forward.@n
17303     * Runnin an animation in reverse is accomplished by calling the operation
17304     * callback with a frame value starting at 1 and diminshing until 0.
17305     * @deprecated Use @ref Transit instead.
17306     */
17307    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
17308    /**
17309     * Gets wether the animation will automatically reversed
17310     *
17311     * @param[in] animator Animator object
17312     * @deprecated Use @ref Transit instead.
17313     */
17314    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
17315    /**
17316     * Gets the status for the animator operation. The status of the animator @b
17317     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
17318     * only informs if the animation was started and has not ended(either normally
17319     * or through elm_animator_stop()).
17320     *
17321     * @param[in] animator Animator object
17322     * @deprecated Use @ref Transit instead.
17323     */
17324    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
17325    /**
17326     * Gets how many times the animation will be repeated
17327     *
17328     * @param[in] animator Animator object
17329     * @deprecated Use @ref Transit instead.
17330     */
17331    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
17332    /**
17333     * Pause the animator.
17334     *
17335     * @param[in]  animator Animator object
17336     *
17337     * This causes the animation to be temporarily stopped(the operation callback
17338     * will not be called). If the animation is not yet running this is a no-op.
17339     * Once an animation has been paused with this function it can be resumed
17340     * using elm_animator_resume().
17341     * @deprecated Use @ref Transit instead.
17342     */
17343    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
17344    /**
17345     * @brief Resumes the animator.
17346     *
17347     * @param[in]  animator Animator object
17348     *
17349     * Resumes an animation that was paused using elm_animator_pause(), after
17350     * calling this function calls to the operation callback will happen
17351     * normally. If an animation is stopped by means of elm_animator_stop it
17352     * @b can't be restarted with this function.@n
17353     *
17354     * @warning When an animation is resumed it doesn't start from where it was paused, it
17355     * will go to where it would have been if it had not been paused. If an
17356     * animation with a duration of 3 seconds is paused after 1 second for 1 second
17357     * it will resume as if it had ben animating for 2 seconds, the operating
17358     * callback will be called with a frame value of aproximately 2/3.
17359     * @deprecated Use @ref Transit instead.
17360     */
17361    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
17362    /**
17363     * @}
17364     */
17365
17366    /**
17367     * @defgroup Calendar Calendar
17368     * @ingroup Elementary
17369     *
17370     * @image html img/widget/calendar/preview-00.png
17371     * @image latex img/widget/calendar/preview-00.eps
17372     *
17373     * A calendar is a widget that displays a regular calendar, one
17374     * month at a time, to the user, and can allows the user to select a date.
17375     *
17376     * It has support to adding check marks (holidays and checks are supported
17377     * by default theme).
17378     *
17379     * Weekday names and the function used to format month and year to
17380     * be displayed can be set, giving more flexibility to this widget.
17381     *
17382     * Smart callbacks one can register to:
17383     * - "changed" - emitted when the user selects a day or changes the
17384     *   displayed month, what actually changes the selected day as well.
17385     *
17386     * Available styles for it:
17387     * - @c "default"
17388     *
17389     * List of examples:
17390     * @li @ref calendar_example_01
17391     * @li @ref calendar_example_02
17392     * @li @ref calendar_example_03
17393     * @li @ref calendar_example_04
17394     * @li @ref calendar_example_05
17395     * @li @ref calendar_example_06
17396     */
17397
17398    /**
17399     * @addtogroup Calendar
17400     * @{
17401     */
17402
17403    /**
17404     * @enum _Elm_Calendar_Mark_Repeat
17405     * @typedef Elm_Calendar_Mark_Repeat
17406     *
17407     * Event periodicity, used to define if a mark should be repeated
17408     * @b beyond event's day. It's set when a mark is added.
17409     *
17410     * So, for a mark added to 13th May with periodicity set to WEEKLY,
17411     * there will be marks every week after this date. Marks will be displayed
17412     * at 13th, 20th, 27th, 3rd June ...
17413     *
17414     * Values don't work as bitmaks, only one can be choosen.
17415     *
17416     * @see elm_calendar_mark_add()
17417     *
17418     * @ingroup Calendar
17419     */
17420    typedef enum _Elm_Calendar_Mark_Repeat
17421      {
17422         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
17423         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
17424         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
17425         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*/
17426         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. */
17427      } Elm_Calendar_Mark_Repeat;
17428
17429    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(). */
17430
17431    /**
17432     * Add a new calendar widget to the given parent Elementary
17433     * (container) object.
17434     *
17435     * @param parent The parent object.
17436     * @return a new calendar widget handle or @c NULL, on errors.
17437     *
17438     * This function inserts a new calendar widget on the canvas.
17439     *
17440     * @ref calendar_example_01
17441     *
17442     * @ingroup Calendar
17443     */
17444    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17445
17446    /**
17447     * Get weekdays names displayed by the calendar.
17448     *
17449     * @param obj The calendar object.
17450     * @return Array of seven strings to be used as weekday names.
17451     *
17452     * By default, weekdays abbreviations get from system are displayed:
17453     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
17454     * The first string is related to Sunday, the second to Monday...
17455     *
17456     * @see elm_calendar_weekdays_name_set()
17457     *
17458     * @ref calendar_example_05
17459     *
17460     * @ingroup Calendar
17461     */
17462    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17463
17464    /**
17465     * Set weekdays names to be displayed by the calendar.
17466     *
17467     * @param obj The calendar object.
17468     * @param weedays Array of seven strings to be used as weekday names.
17469     * @warning It must have 7 elements, or it will access invalid memory.
17470     * @warning The strings must be NULL terminated ('@\0').
17471     *
17472     * By default, weekdays abbreviations get from system are displayed:
17473     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
17474     *
17475     * The first string should be related to Sunday, the second to Monday...
17476     *
17477     * The usage should be like this:
17478     * @code
17479     *   const char *weekdays[] =
17480     *   {
17481     *      "Sunday", "Monday", "Tuesday", "Wednesday",
17482     *      "Thursday", "Friday", "Saturday"
17483     *   };
17484     *   elm_calendar_weekdays_names_set(calendar, weekdays);
17485     * @endcode
17486     *
17487     * @see elm_calendar_weekdays_name_get()
17488     *
17489     * @ref calendar_example_02
17490     *
17491     * @ingroup Calendar
17492     */
17493    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
17494
17495    /**
17496     * Set the minimum and maximum values for the year
17497     *
17498     * @param obj The calendar object
17499     * @param min The minimum year, greater than 1901;
17500     * @param max The maximum year;
17501     *
17502     * Maximum must be greater than minimum, except if you don't wan't to set
17503     * maximum year.
17504     * Default values are 1902 and -1.
17505     *
17506     * If the maximum year is a negative value, it will be limited depending
17507     * on the platform architecture (year 2037 for 32 bits);
17508     *
17509     * @see elm_calendar_min_max_year_get()
17510     *
17511     * @ref calendar_example_03
17512     *
17513     * @ingroup Calendar
17514     */
17515    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
17516
17517    /**
17518     * Get the minimum and maximum values for the year
17519     *
17520     * @param obj The calendar object.
17521     * @param min The minimum year.
17522     * @param max The maximum year.
17523     *
17524     * Default values are 1902 and -1.
17525     *
17526     * @see elm_calendar_min_max_year_get() for more details.
17527     *
17528     * @ref calendar_example_05
17529     *
17530     * @ingroup Calendar
17531     */
17532    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
17533
17534    /**
17535     * Enable or disable day selection
17536     *
17537     * @param obj The calendar object.
17538     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
17539     * disable it.
17540     *
17541     * Enabled by default. If disabled, the user still can select months,
17542     * but not days. Selected days are highlighted on calendar.
17543     * It should be used if you won't need such selection for the widget usage.
17544     *
17545     * When a day is selected, or month is changed, smart callbacks for
17546     * signal "changed" will be called.
17547     *
17548     * @see elm_calendar_day_selection_enable_get()
17549     *
17550     * @ref calendar_example_04
17551     *
17552     * @ingroup Calendar
17553     */
17554    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
17555
17556    /**
17557     * Get a value whether day selection is enabled or not.
17558     *
17559     * @see elm_calendar_day_selection_enable_set() for details.
17560     *
17561     * @param obj The calendar object.
17562     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
17563     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
17564     *
17565     * @ref calendar_example_05
17566     *
17567     * @ingroup Calendar
17568     */
17569    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17570
17571
17572    /**
17573     * Set selected date to be highlighted on calendar.
17574     *
17575     * @param obj The calendar object.
17576     * @param selected_time A @b tm struct to represent the selected date.
17577     *
17578     * Set the selected date, changing the displayed month if needed.
17579     * Selected date changes when the user goes to next/previous month or
17580     * select a day pressing over it on calendar.
17581     *
17582     * @see elm_calendar_selected_time_get()
17583     *
17584     * @ref calendar_example_04
17585     *
17586     * @ingroup Calendar
17587     */
17588    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
17589
17590    /**
17591     * Get selected date.
17592     *
17593     * @param obj The calendar object
17594     * @param selected_time A @b tm struct to point to selected date
17595     * @return EINA_FALSE means an error ocurred and returned time shouldn't
17596     * be considered.
17597     *
17598     * Get date selected by the user or set by function
17599     * elm_calendar_selected_time_set().
17600     * Selected date changes when the user goes to next/previous month or
17601     * select a day pressing over it on calendar.
17602     *
17603     * @see elm_calendar_selected_time_get()
17604     *
17605     * @ref calendar_example_05
17606     *
17607     * @ingroup Calendar
17608     */
17609    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
17610
17611    /**
17612     * Set a function to format the string that will be used to display
17613     * month and year;
17614     *
17615     * @param obj The calendar object
17616     * @param format_function Function to set the month-year string given
17617     * the selected date
17618     *
17619     * By default it uses strftime with "%B %Y" format string.
17620     * It should allocate the memory that will be used by the string,
17621     * that will be freed by the widget after usage.
17622     * A pointer to the string and a pointer to the time struct will be provided.
17623     *
17624     * Example:
17625     * @code
17626     * static char *
17627     * _format_month_year(struct tm *selected_time)
17628     * {
17629     *    char buf[32];
17630     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
17631     *    return strdup(buf);
17632     * }
17633     *
17634     * elm_calendar_format_function_set(calendar, _format_month_year);
17635     * @endcode
17636     *
17637     * @ref calendar_example_02
17638     *
17639     * @ingroup Calendar
17640     */
17641    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
17642
17643    /**
17644     * Add a new mark to the calendar
17645     *
17646     * @param obj The calendar object
17647     * @param mark_type A string used to define the type of mark. It will be
17648     * emitted to the theme, that should display a related modification on these
17649     * days representation.
17650     * @param mark_time A time struct to represent the date of inclusion of the
17651     * mark. For marks that repeats it will just be displayed after the inclusion
17652     * date in the calendar.
17653     * @param repeat Repeat the event following this periodicity. Can be a unique
17654     * mark (that don't repeat), daily, weekly, monthly or annually.
17655     * @return The created mark or @NULL upon failure.
17656     *
17657     * Add a mark that will be drawn in the calendar respecting the insertion
17658     * time and periodicity. It will emit the type as signal to the widget theme.
17659     * Default theme supports "holiday" and "checked", but it can be extended.
17660     *
17661     * It won't immediately update the calendar, drawing the marks.
17662     * For this, call elm_calendar_marks_draw(). However, when user selects
17663     * next or previous month calendar forces marks drawn.
17664     *
17665     * Marks created with this method can be deleted with
17666     * elm_calendar_mark_del().
17667     *
17668     * Example
17669     * @code
17670     * struct tm selected_time;
17671     * time_t current_time;
17672     *
17673     * current_time = time(NULL) + 5 * 84600;
17674     * localtime_r(&current_time, &selected_time);
17675     * elm_calendar_mark_add(cal, "holiday", selected_time,
17676     *     ELM_CALENDAR_ANNUALLY);
17677     *
17678     * current_time = time(NULL) + 1 * 84600;
17679     * localtime_r(&current_time, &selected_time);
17680     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
17681     *
17682     * elm_calendar_marks_draw(cal);
17683     * @endcode
17684     *
17685     * @see elm_calendar_marks_draw()
17686     * @see elm_calendar_mark_del()
17687     *
17688     * @ref calendar_example_06
17689     *
17690     * @ingroup Calendar
17691     */
17692    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);
17693
17694    /**
17695     * Delete mark from the calendar.
17696     *
17697     * @param mark The mark to be deleted.
17698     *
17699     * If deleting all calendar marks is required, elm_calendar_marks_clear()
17700     * should be used instead of getting marks list and deleting each one.
17701     *
17702     * @see elm_calendar_mark_add()
17703     *
17704     * @ref calendar_example_06
17705     *
17706     * @ingroup Calendar
17707     */
17708    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
17709
17710    /**
17711     * Remove all calendar's marks
17712     *
17713     * @param obj The calendar object.
17714     *
17715     * @see elm_calendar_mark_add()
17716     * @see elm_calendar_mark_del()
17717     *
17718     * @ingroup Calendar
17719     */
17720    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17721
17722
17723    /**
17724     * Get a list of all the calendar marks.
17725     *
17726     * @param obj The calendar object.
17727     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
17728     *
17729     * @see elm_calendar_mark_add()
17730     * @see elm_calendar_mark_del()
17731     * @see elm_calendar_marks_clear()
17732     *
17733     * @ingroup Calendar
17734     */
17735    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17736
17737    /**
17738     * Draw calendar marks.
17739     *
17740     * @param obj The calendar object.
17741     *
17742     * Should be used after adding, removing or clearing marks.
17743     * It will go through the entire marks list updating the calendar.
17744     * If lots of marks will be added, add all the marks and then call
17745     * this function.
17746     *
17747     * When the month is changed, i.e. user selects next or previous month,
17748     * marks will be drawed.
17749     *
17750     * @see elm_calendar_mark_add()
17751     * @see elm_calendar_mark_del()
17752     * @see elm_calendar_marks_clear()
17753     *
17754     * @ref calendar_example_06
17755     *
17756     * @ingroup Calendar
17757     */
17758    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
17759
17760    /**
17761     * Set a day text color to the same that represents Saturdays.
17762     *
17763     * @param obj The calendar object.
17764     * @param pos The text position. Position is the cell counter, from left
17765     * to right, up to down. It starts on 0 and ends on 41.
17766     *
17767     * @deprecated use elm_calendar_mark_add() instead like:
17768     *
17769     * @code
17770     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
17771     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
17772     * @endcode
17773     *
17774     * @see elm_calendar_mark_add()
17775     *
17776     * @ingroup Calendar
17777     */
17778    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
17779
17780    /**
17781     * Set a day text color to the same that represents Sundays.
17782     *
17783     * @param obj The calendar object.
17784     * @param pos The text position. Position is the cell counter, from left
17785     * to right, up to down. It starts on 0 and ends on 41.
17786
17787     * @deprecated use elm_calendar_mark_add() instead like:
17788     *
17789     * @code
17790     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
17791     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
17792     * @endcode
17793     *
17794     * @see elm_calendar_mark_add()
17795     *
17796     * @ingroup Calendar
17797     */
17798    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
17799
17800    /**
17801     * Set a day text color to the same that represents Weekdays.
17802     *
17803     * @param obj The calendar object
17804     * @param pos The text position. Position is the cell counter, from left
17805     * to right, up to down. It starts on 0 and ends on 41.
17806     *
17807     * @deprecated use elm_calendar_mark_add() instead like:
17808     *
17809     * @code
17810     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
17811     *
17812     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
17813     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
17814     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
17815     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
17816     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
17817     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
17818     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
17819     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
17820     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
17821     * @endcode
17822     *
17823     * @see elm_calendar_mark_add()
17824     *
17825     * @ingroup Calendar
17826     */
17827    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
17828
17829    /**
17830     * Set the interval on time updates for an user mouse button hold
17831     * on calendar widgets' month selection.
17832     *
17833     * @param obj The calendar object
17834     * @param interval The (first) interval value in seconds
17835     *
17836     * This interval value is @b decreased while the user holds the
17837     * mouse pointer either selecting next or previous month.
17838     *
17839     * This helps the user to get to a given month distant from the
17840     * current one easier/faster, as it will start to change quicker and
17841     * quicker on mouse button holds.
17842     *
17843     * The calculation for the next change interval value, starting from
17844     * the one set with this call, is the previous interval divided by
17845     * 1.05, so it decreases a little bit.
17846     *
17847     * The default starting interval value for automatic changes is
17848     * @b 0.85 seconds.
17849     *
17850     * @see elm_calendar_interval_get()
17851     *
17852     * @ingroup Calendar
17853     */
17854    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17855
17856    /**
17857     * Get the interval on time updates for an user mouse button hold
17858     * on calendar widgets' month selection.
17859     *
17860     * @param obj The calendar object
17861     * @return The (first) interval value, in seconds, set on it
17862     *
17863     * @see elm_calendar_interval_set() for more details
17864     *
17865     * @ingroup Calendar
17866     */
17867    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17868
17869    /**
17870     * @}
17871     */
17872
17873    /**
17874     * @defgroup Diskselector Diskselector
17875     * @ingroup Elementary
17876     *
17877     * @image html img/widget/diskselector/preview-00.png
17878     * @image latex img/widget/diskselector/preview-00.eps
17879     *
17880     * A diskselector is a kind of list widget. It scrolls horizontally,
17881     * and can contain label and icon objects. Three items are displayed
17882     * with the selected one in the middle.
17883     *
17884     * It can act like a circular list with round mode and labels can be
17885     * reduced for a defined length for side items.
17886     *
17887     * Smart callbacks one can listen to:
17888     * - "selected" - when item is selected, i.e. scroller stops.
17889     *
17890     * Available styles for it:
17891     * - @c "default"
17892     *
17893     * List of examples:
17894     * @li @ref diskselector_example_01
17895     * @li @ref diskselector_example_02
17896     */
17897
17898    /**
17899     * @addtogroup Diskselector
17900     * @{
17901     */
17902
17903    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(). */
17904
17905    /**
17906     * Add a new diskselector widget to the given parent Elementary
17907     * (container) object.
17908     *
17909     * @param parent The parent object.
17910     * @return a new diskselector widget handle or @c NULL, on errors.
17911     *
17912     * This function inserts a new diskselector widget on the canvas.
17913     *
17914     * @ingroup Diskselector
17915     */
17916    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17917
17918    /**
17919     * Enable or disable round mode.
17920     *
17921     * @param obj The diskselector object.
17922     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
17923     * disable it.
17924     *
17925     * Disabled by default. If round mode is enabled the items list will
17926     * work like a circle list, so when the user reaches the last item,
17927     * the first one will popup.
17928     *
17929     * @see elm_diskselector_round_get()
17930     *
17931     * @ingroup Diskselector
17932     */
17933    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
17934
17935    /**
17936     * Get a value whether round mode is enabled or not.
17937     *
17938     * @see elm_diskselector_round_set() for details.
17939     *
17940     * @param obj The diskselector object.
17941     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
17942     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17943     *
17944     * @ingroup Diskselector
17945     */
17946    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17947
17948    /**
17949     * Get the side labels max length.
17950     *
17951     * @deprecated use elm_diskselector_side_label_length_get() instead:
17952     *
17953     * @param obj The diskselector object.
17954     * @return The max length defined for side labels, or 0 if not a valid
17955     * diskselector.
17956     *
17957     * @ingroup Diskselector
17958     */
17959    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17960
17961    /**
17962     * Set the side labels max length.
17963     *
17964     * @deprecated use elm_diskselector_side_label_length_set() instead:
17965     *
17966     * @param obj The diskselector object.
17967     * @param len The max length defined for side labels.
17968     *
17969     * @ingroup Diskselector
17970     */
17971    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
17972
17973    /**
17974     * Get the side labels max length.
17975     *
17976     * @see elm_diskselector_side_label_length_set() for details.
17977     *
17978     * @param obj The diskselector object.
17979     * @return The max length defined for side labels, or 0 if not a valid
17980     * diskselector.
17981     *
17982     * @ingroup Diskselector
17983     */
17984    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17985
17986    /**
17987     * Set the side labels max length.
17988     *
17989     * @param obj The diskselector object.
17990     * @param len The max length defined for side labels.
17991     *
17992     * Length is the number of characters of items' label that will be
17993     * visible when it's set on side positions. It will just crop
17994     * the string after defined size. E.g.:
17995     *
17996     * An item with label "January" would be displayed on side position as
17997     * "Jan" if max length is set to 3, or "Janu", if this property
17998     * is set to 4.
17999     *
18000     * When it's selected, the entire label will be displayed, except for
18001     * width restrictions. In this case label will be cropped and "..."
18002     * will be concatenated.
18003     *
18004     * Default side label max length is 3.
18005     *
18006     * This property will be applyed over all items, included before or
18007     * later this function call.
18008     *
18009     * @ingroup Diskselector
18010     */
18011    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
18012
18013    /**
18014     * Set the number of items to be displayed.
18015     *
18016     * @param obj The diskselector object.
18017     * @param num The number of items the diskselector will display.
18018     *
18019     * Default value is 3, and also it's the minimun. If @p num is less
18020     * than 3, it will be set to 3.
18021     *
18022     * Also, it can be set on theme, using data item @c display_item_num
18023     * on group "elm/diskselector/item/X", where X is style set.
18024     * E.g.:
18025     *
18026     * group { name: "elm/diskselector/item/X";
18027     * data {
18028     *     item: "display_item_num" "5";
18029     *     }
18030     *
18031     * @ingroup Diskselector
18032     */
18033    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
18034
18035    /**
18036     * Set bouncing behaviour when the scrolled content reaches an edge.
18037     *
18038     * Tell the internal scroller object whether it should bounce or not
18039     * when it reaches the respective edges for each axis.
18040     *
18041     * @param obj The diskselector object.
18042     * @param h_bounce Whether to bounce or not in the horizontal axis.
18043     * @param v_bounce Whether to bounce or not in the vertical axis.
18044     *
18045     * @see elm_scroller_bounce_set()
18046     *
18047     * @ingroup Diskselector
18048     */
18049    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18050
18051    /**
18052     * Get the bouncing behaviour of the internal scroller.
18053     *
18054     * Get whether the internal scroller should bounce when the edge of each
18055     * axis is reached scrolling.
18056     *
18057     * @param obj The diskselector object.
18058     * @param h_bounce Pointer where to store the bounce state of the horizontal
18059     * axis.
18060     * @param v_bounce Pointer where to store the bounce state of the vertical
18061     * axis.
18062     *
18063     * @see elm_scroller_bounce_get()
18064     * @see elm_diskselector_bounce_set()
18065     *
18066     * @ingroup Diskselector
18067     */
18068    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18069
18070    /**
18071     * Get the scrollbar policy.
18072     *
18073     * @see elm_diskselector_scroller_policy_get() for details.
18074     *
18075     * @param obj The diskselector object.
18076     * @param policy_h Pointer where to store horizontal scrollbar policy.
18077     * @param policy_v Pointer where to store vertical scrollbar policy.
18078     *
18079     * @ingroup Diskselector
18080     */
18081    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);
18082
18083    /**
18084     * Set the scrollbar policy.
18085     *
18086     * @param obj The diskselector object.
18087     * @param policy_h Horizontal scrollbar policy.
18088     * @param policy_v Vertical scrollbar policy.
18089     *
18090     * This sets the scrollbar visibility policy for the given scroller.
18091     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
18092     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
18093     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
18094     * This applies respectively for the horizontal and vertical scrollbars.
18095     *
18096     * The both are disabled by default, i.e., are set to
18097     * #ELM_SCROLLER_POLICY_OFF.
18098     *
18099     * @ingroup Diskselector
18100     */
18101    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18102
18103    /**
18104     * Remove all diskselector's items.
18105     *
18106     * @param obj The diskselector object.
18107     *
18108     * @see elm_diskselector_item_del()
18109     * @see elm_diskselector_item_append()
18110     *
18111     * @ingroup Diskselector
18112     */
18113    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18114
18115    /**
18116     * Get a list of all the diskselector items.
18117     *
18118     * @param obj The diskselector object.
18119     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
18120     * or @c NULL on failure.
18121     *
18122     * @see elm_diskselector_item_append()
18123     * @see elm_diskselector_item_del()
18124     * @see elm_diskselector_clear()
18125     *
18126     * @ingroup Diskselector
18127     */
18128    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18129
18130    /**
18131     * Appends a new item to the diskselector object.
18132     *
18133     * @param obj The diskselector object.
18134     * @param label The label of the diskselector item.
18135     * @param icon The icon object to use at left side of the item. An
18136     * icon can be any Evas object, but usually it is an icon created
18137     * with elm_icon_add().
18138     * @param func The function to call when the item is selected.
18139     * @param data The data to associate with the item for related callbacks.
18140     *
18141     * @return The created item or @c NULL upon failure.
18142     *
18143     * A new item will be created and appended to the diskselector, i.e., will
18144     * be set as last item. Also, if there is no selected item, it will
18145     * be selected. This will always happens for the first appended item.
18146     *
18147     * If no icon is set, label will be centered on item position, otherwise
18148     * the icon will be placed at left of the label, that will be shifted
18149     * to the right.
18150     *
18151     * Items created with this method can be deleted with
18152     * elm_diskselector_item_del().
18153     *
18154     * Associated @p data can be properly freed when item is deleted if a
18155     * callback function is set with elm_diskselector_item_del_cb_set().
18156     *
18157     * If a function is passed as argument, it will be called everytime this item
18158     * is selected, i.e., the user stops the diskselector with this
18159     * item on center position. If such function isn't needed, just passing
18160     * @c NULL as @p func is enough. The same should be done for @p data.
18161     *
18162     * Simple example (with no function callback or data associated):
18163     * @code
18164     * disk = elm_diskselector_add(win);
18165     * ic = elm_icon_add(win);
18166     * elm_icon_file_set(ic, "path/to/image", NULL);
18167     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
18168     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
18169     * @endcode
18170     *
18171     * @see elm_diskselector_item_del()
18172     * @see elm_diskselector_item_del_cb_set()
18173     * @see elm_diskselector_clear()
18174     * @see elm_icon_add()
18175     *
18176     * @ingroup Diskselector
18177     */
18178    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);
18179
18180
18181    /**
18182     * Delete them item from the diskselector.
18183     *
18184     * @param it The item of diskselector to be deleted.
18185     *
18186     * If deleting all diskselector items is required, elm_diskselector_clear()
18187     * should be used instead of getting items list and deleting each one.
18188     *
18189     * @see elm_diskselector_clear()
18190     * @see elm_diskselector_item_append()
18191     * @see elm_diskselector_item_del_cb_set()
18192     *
18193     * @ingroup Diskselector
18194     */
18195    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18196
18197    /**
18198     * Set the function called when a diskselector item is freed.
18199     *
18200     * @param it The item to set the callback on
18201     * @param func The function called
18202     *
18203     * If there is a @p func, then it will be called prior item's memory release.
18204     * That will be called with the following arguments:
18205     * @li item's data;
18206     * @li item's Evas object;
18207     * @li item itself;
18208     *
18209     * This way, a data associated to a diskselector item could be properly
18210     * freed.
18211     *
18212     * @ingroup Diskselector
18213     */
18214    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18215
18216    /**
18217     * Get the data associated to the item.
18218     *
18219     * @param it The diskselector item
18220     * @return The data associated to @p it
18221     *
18222     * The return value is a pointer to data associated to @item when it was
18223     * created, with function elm_diskselector_item_append(). If no data
18224     * was passed as argument, it will return @c NULL.
18225     *
18226     * @see elm_diskselector_item_append()
18227     *
18228     * @ingroup Diskselector
18229     */
18230    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18231
18232    /**
18233     * Set the icon associated to the item.
18234     *
18235     * @param it The diskselector item
18236     * @param icon The icon object to associate with @p it
18237     *
18238     * The icon object to use at left side of the item. An
18239     * icon can be any Evas object, but usually it is an icon created
18240     * with elm_icon_add().
18241     *
18242     * Once the icon object is set, a previously set one will be deleted.
18243     * @warning Setting the same icon for two items will cause the icon to
18244     * dissapear from the first item.
18245     *
18246     * If an icon was passed as argument on item creation, with function
18247     * elm_diskselector_item_append(), it will be already
18248     * associated to the item.
18249     *
18250     * @see elm_diskselector_item_append()
18251     * @see elm_diskselector_item_icon_get()
18252     *
18253     * @ingroup Diskselector
18254     */
18255    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
18256
18257    /**
18258     * Get the icon associated to the item.
18259     *
18260     * @param it The diskselector item
18261     * @return The icon associated to @p it
18262     *
18263     * The return value is a pointer to the icon associated to @item when it was
18264     * created, with function elm_diskselector_item_append(), or later
18265     * with function elm_diskselector_item_icon_set. If no icon
18266     * was passed as argument, it will return @c NULL.
18267     *
18268     * @see elm_diskselector_item_append()
18269     * @see elm_diskselector_item_icon_set()
18270     *
18271     * @ingroup Diskselector
18272     */
18273    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18274
18275    /**
18276     * Set the label of item.
18277     *
18278     * @param it The item of diskselector.
18279     * @param label The label of item.
18280     *
18281     * The label to be displayed by the item.
18282     *
18283     * If no icon is set, label will be centered on item position, otherwise
18284     * the icon will be placed at left of the label, that will be shifted
18285     * to the right.
18286     *
18287     * An item with label "January" would be displayed on side position as
18288     * "Jan" if max length is set to 3 with function
18289     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
18290     * is set to 4.
18291     *
18292     * When this @item is selected, the entire label will be displayed,
18293     * except for width restrictions.
18294     * In this case label will be cropped and "..." will be concatenated,
18295     * but only for display purposes. It will keep the entire string, so
18296     * if diskselector is resized the remaining characters will be displayed.
18297     *
18298     * If a label was passed as argument on item creation, with function
18299     * elm_diskselector_item_append(), it will be already
18300     * displayed by the item.
18301     *
18302     * @see elm_diskselector_side_label_lenght_set()
18303     * @see elm_diskselector_item_label_get()
18304     * @see elm_diskselector_item_append()
18305     *
18306     * @ingroup Diskselector
18307     */
18308    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
18309
18310    /**
18311     * Get the label of item.
18312     *
18313     * @param it The item of diskselector.
18314     * @return The label of item.
18315     *
18316     * The return value is a pointer to the label associated to @item when it was
18317     * created, with function elm_diskselector_item_append(), or later
18318     * with function elm_diskselector_item_label_set. If no label
18319     * was passed as argument, it will return @c NULL.
18320     *
18321     * @see elm_diskselector_item_label_set() for more details.
18322     * @see elm_diskselector_item_append()
18323     *
18324     * @ingroup Diskselector
18325     */
18326    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18327
18328    /**
18329     * Get the selected item.
18330     *
18331     * @param obj The diskselector object.
18332     * @return The selected diskselector item.
18333     *
18334     * The selected item can be unselected with function
18335     * elm_diskselector_item_selected_set(), and the first item of
18336     * diskselector will be selected.
18337     *
18338     * The selected item always will be centered on diskselector, with
18339     * full label displayed, i.e., max lenght set to side labels won't
18340     * apply on the selected item. More details on
18341     * elm_diskselector_side_label_length_set().
18342     *
18343     * @ingroup Diskselector
18344     */
18345    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18346
18347    /**
18348     * Set the selected state of an item.
18349     *
18350     * @param it The diskselector item
18351     * @param selected The selected state
18352     *
18353     * This sets the selected state of the given item @p it.
18354     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
18355     *
18356     * If a new item is selected the previosly selected will be unselected.
18357     * Previoulsy selected item can be get with function
18358     * elm_diskselector_selected_item_get().
18359     *
18360     * If the item @p it is unselected, the first item of diskselector will
18361     * be selected.
18362     *
18363     * Selected items will be visible on center position of diskselector.
18364     * So if it was on another position before selected, or was invisible,
18365     * diskselector will animate items until the selected item reaches center
18366     * position.
18367     *
18368     * @see elm_diskselector_item_selected_get()
18369     * @see elm_diskselector_selected_item_get()
18370     *
18371     * @ingroup Diskselector
18372     */
18373    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18374
18375    /*
18376     * Get whether the @p item is selected or not.
18377     *
18378     * @param it The diskselector item.
18379     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
18380     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18381     *
18382     * @see elm_diskselector_selected_item_set() for details.
18383     * @see elm_diskselector_item_selected_get()
18384     *
18385     * @ingroup Diskselector
18386     */
18387    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18388
18389    /**
18390     * Get the first item of the diskselector.
18391     *
18392     * @param obj The diskselector object.
18393     * @return The first item, or @c NULL if none.
18394     *
18395     * The list of items follows append order. So it will return the first
18396     * item appended to the widget that wasn't deleted.
18397     *
18398     * @see elm_diskselector_item_append()
18399     * @see elm_diskselector_items_get()
18400     *
18401     * @ingroup Diskselector
18402     */
18403    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18404
18405    /**
18406     * Get the last item of the diskselector.
18407     *
18408     * @param obj The diskselector object.
18409     * @return The last item, or @c NULL if none.
18410     *
18411     * The list of items follows append order. So it will return last first
18412     * item appended to the widget that wasn't deleted.
18413     *
18414     * @see elm_diskselector_item_append()
18415     * @see elm_diskselector_items_get()
18416     *
18417     * @ingroup Diskselector
18418     */
18419    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18420
18421    /**
18422     * Get the item before @p item in diskselector.
18423     *
18424     * @param it The diskselector item.
18425     * @return The item before @p item, or @c NULL if none or on failure.
18426     *
18427     * The list of items follows append order. So it will return item appended
18428     * just before @item and that wasn't deleted.
18429     *
18430     * If it is the first item, @c NULL will be returned.
18431     * First item can be get by elm_diskselector_first_item_get().
18432     *
18433     * @see elm_diskselector_item_append()
18434     * @see elm_diskselector_items_get()
18435     *
18436     * @ingroup Diskselector
18437     */
18438    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18439
18440    /**
18441     * Get the item after @p item in diskselector.
18442     *
18443     * @param it The diskselector item.
18444     * @return The item after @p item, or @c NULL if none or on failure.
18445     *
18446     * The list of items follows append order. So it will return item appended
18447     * just after @item and that wasn't deleted.
18448     *
18449     * If it is the last item, @c NULL will be returned.
18450     * Last item can be get by elm_diskselector_last_item_get().
18451     *
18452     * @see elm_diskselector_item_append()
18453     * @see elm_diskselector_items_get()
18454     *
18455     * @ingroup Diskselector
18456     */
18457    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18458
18459    /**
18460     * Set the text to be shown in the diskselector item.
18461     *
18462     * @param item Target item
18463     * @param text The text to set in the content
18464     *
18465     * Setup the text as tooltip to object. The item can have only one tooltip,
18466     * so any previous tooltip data is removed.
18467     *
18468     * @see elm_object_tooltip_text_set() for more details.
18469     *
18470     * @ingroup Diskselector
18471     */
18472    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
18473
18474    /**
18475     * Set the content to be shown in the tooltip item.
18476     *
18477     * Setup the tooltip to item. The item can have only one tooltip,
18478     * so any previous tooltip data is removed. @p func(with @p data) will
18479     * be called every time that need show the tooltip and it should
18480     * return a valid Evas_Object. This object is then managed fully by
18481     * tooltip system and is deleted when the tooltip is gone.
18482     *
18483     * @param item the diskselector item being attached a tooltip.
18484     * @param func the function used to create the tooltip contents.
18485     * @param data what to provide to @a func as callback data/context.
18486     * @param del_cb called when data is not needed anymore, either when
18487     *        another callback replaces @func, the tooltip is unset with
18488     *        elm_diskselector_item_tooltip_unset() or the owner @a item
18489     *        dies. This callback receives as the first parameter the
18490     *        given @a data, and @c event_info is the item.
18491     *
18492     * @see elm_object_tooltip_content_cb_set() for more details.
18493     *
18494     * @ingroup Diskselector
18495     */
18496    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);
18497
18498    /**
18499     * Unset tooltip from item.
18500     *
18501     * @param item diskselector item to remove previously set tooltip.
18502     *
18503     * Remove tooltip from item. The callback provided as del_cb to
18504     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
18505     * it is not used anymore.
18506     *
18507     * @see elm_object_tooltip_unset() for more details.
18508     * @see elm_diskselector_item_tooltip_content_cb_set()
18509     *
18510     * @ingroup Diskselector
18511     */
18512    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18513
18514
18515    /**
18516     * Sets a different style for this item tooltip.
18517     *
18518     * @note before you set a style you should define a tooltip with
18519     *       elm_diskselector_item_tooltip_content_cb_set() or
18520     *       elm_diskselector_item_tooltip_text_set()
18521     *
18522     * @param item diskselector item with tooltip already set.
18523     * @param style the theme style to use (default, transparent, ...)
18524     *
18525     * @see elm_object_tooltip_style_set() for more details.
18526     *
18527     * @ingroup Diskselector
18528     */
18529    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
18530
18531    /**
18532     * Get the style for this item tooltip.
18533     *
18534     * @param item diskselector item with tooltip already set.
18535     * @return style the theme style in use, defaults to "default". If the
18536     *         object does not have a tooltip set, then NULL is returned.
18537     *
18538     * @see elm_object_tooltip_style_get() for more details.
18539     * @see elm_diskselector_item_tooltip_style_set()
18540     *
18541     * @ingroup Diskselector
18542     */
18543    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18544
18545    /**
18546     * Set the cursor to be shown when mouse is over the diskselector item
18547     *
18548     * @param item Target item
18549     * @param cursor the cursor name to be used.
18550     *
18551     * @see elm_object_cursor_set() for more details.
18552     *
18553     * @ingroup Diskselector
18554     */
18555    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18556
18557    /**
18558     * Get the cursor to be shown when mouse is over the diskselector item
18559     *
18560     * @param item diskselector item with cursor already set.
18561     * @return the cursor name.
18562     *
18563     * @see elm_object_cursor_get() for more details.
18564     * @see elm_diskselector_cursor_set()
18565     *
18566     * @ingroup Diskselector
18567     */
18568    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18569
18570
18571    /**
18572     * Unset the cursor to be shown when mouse is over the diskselector item
18573     *
18574     * @param item Target item
18575     *
18576     * @see elm_object_cursor_unset() for more details.
18577     * @see elm_diskselector_cursor_set()
18578     *
18579     * @ingroup Diskselector
18580     */
18581    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18582
18583    /**
18584     * Sets a different style for this item cursor.
18585     *
18586     * @note before you set a style you should define a cursor with
18587     *       elm_diskselector_item_cursor_set()
18588     *
18589     * @param item diskselector item with cursor already set.
18590     * @param style the theme style to use (default, transparent, ...)
18591     *
18592     * @see elm_object_cursor_style_set() for more details.
18593     *
18594     * @ingroup Diskselector
18595     */
18596    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
18597
18598
18599    /**
18600     * Get the style for this item cursor.
18601     *
18602     * @param item diskselector item with cursor already set.
18603     * @return style the theme style in use, defaults to "default". If the
18604     *         object does not have a cursor set, then @c NULL is returned.
18605     *
18606     * @see elm_object_cursor_style_get() for more details.
18607     * @see elm_diskselector_item_cursor_style_set()
18608     *
18609     * @ingroup Diskselector
18610     */
18611    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18612
18613
18614    /**
18615     * Set if the cursor set should be searched on the theme or should use
18616     * the provided by the engine, only.
18617     *
18618     * @note before you set if should look on theme you should define a cursor
18619     * with elm_diskselector_item_cursor_set().
18620     * By default it will only look for cursors provided by the engine.
18621     *
18622     * @param item widget item with cursor already set.
18623     * @param engine_only boolean to define if cursors set with
18624     * elm_diskselector_item_cursor_set() should be searched only
18625     * between cursors provided by the engine or searched on widget's
18626     * theme as well.
18627     *
18628     * @see elm_object_cursor_engine_only_set() for more details.
18629     *
18630     * @ingroup Diskselector
18631     */
18632    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18633
18634    /**
18635     * Get the cursor engine only usage for this item cursor.
18636     *
18637     * @param item widget item with cursor already set.
18638     * @return engine_only boolean to define it cursors should be looked only
18639     * between the provided by the engine or searched on widget's theme as well.
18640     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
18641     *
18642     * @see elm_object_cursor_engine_only_get() for more details.
18643     * @see elm_diskselector_item_cursor_engine_only_set()
18644     *
18645     * @ingroup Diskselector
18646     */
18647    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
18648
18649    /**
18650     * @}
18651     */
18652
18653    /**
18654     * @defgroup Colorselector Colorselector
18655     *
18656     * @{
18657     *
18658     * @image html img/widget/colorselector/preview-00.png
18659     *
18660     * @brief Widget for user to select a color.
18661     *
18662     * Signals that you can add callbacks for are:
18663     * "changed" - When the color value changes(event_info is NULL).
18664     *
18665     * See @ref tutorial_colorselector.
18666     */
18667    /**
18668     * @brief Add a new colorselector to the parent
18669     *
18670     * @param parent The parent object
18671     * @return The new object or NULL if it cannot be created
18672     *
18673     * @ingroup Colorselector
18674     */
18675    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18676    /**
18677     * Set a color for the colorselector
18678     *
18679     * @param obj   Colorselector object
18680     * @param r     r-value of color
18681     * @param g     g-value of color
18682     * @param b     b-value of color
18683     * @param a     a-value of color
18684     *
18685     * @ingroup Colorselector
18686     */
18687    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
18688    /**
18689     * Get a color from the colorselector
18690     *
18691     * @param obj   Colorselector object
18692     * @param r     integer pointer for r-value of color
18693     * @param g     integer pointer for g-value of color
18694     * @param b     integer pointer for b-value of color
18695     * @param a     integer pointer for a-value of color
18696     *
18697     * @ingroup Colorselector
18698     */
18699    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
18700    /**
18701     * @}
18702     */
18703
18704    /**
18705     * @defgroup Ctxpopup
18706     *
18707     * @image html img/widget/ctxpopup/preview-00.png
18708     * @image latex img/widget/ctxpopup/preview-00.eps
18709     *
18710     * @brief Context popup widet.
18711     *
18712     * A ctxpopup is a widget that, when shown, pops up a list of items.
18713     * It automatically chooses an area inside its parent object's view
18714     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
18715     * optimally fit into it. In the default theme, it will also point an
18716     * arrow to it's top left position at the time one shows it. Ctxpopup
18717     * items have a label and/or an icon. It is intended for a small
18718     * number of items (hence the use of list, not genlist).
18719     *
18720     * @note Ctxpopup is a especialization of @ref Hover.
18721     *
18722     * Signals that you can add callbacks for are:
18723     * "dismissed" - the ctxpopup was dismissed
18724     *
18725     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
18726     * @{
18727     */
18728    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
18729
18730    typedef enum _Elm_Ctxpopup_Direction
18731      {
18732         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
18733                                           area */
18734         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
18735                                            the clicked area */
18736         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
18737                                           the clicked area */
18738         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
18739                                         area */
18740      } Elm_Ctxpopup_Direction;
18741
18742    /**
18743     * @brief Add a new Ctxpopup object to the parent.
18744     *
18745     * @param parent Parent object
18746     * @return New object or @c NULL, if it cannot be created
18747     */
18748    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18749    /**
18750     * @brief Set the Ctxpopup's parent
18751     *
18752     * @param obj The ctxpopup object
18753     * @param area The parent to use
18754     *
18755     * Set the parent object.
18756     *
18757     * @note elm_ctxpopup_add() will automatically call this function
18758     * with its @c parent argument.
18759     *
18760     * @see elm_ctxpopup_add()
18761     * @see elm_hover_parent_set()
18762     */
18763    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
18764    /**
18765     * @brief Get the Ctxpopup's parent
18766     *
18767     * @param obj The ctxpopup object
18768     *
18769     * @see elm_ctxpopup_hover_parent_set() for more information
18770     */
18771    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18772    /**
18773     * @brief Clear all items in the given ctxpopup object.
18774     *
18775     * @param obj Ctxpopup object
18776     */
18777    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18778    /**
18779     * @brief Change the ctxpopup's orientation to horizontal or vertical.
18780     *
18781     * @param obj Ctxpopup object
18782     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
18783     */
18784    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18785    /**
18786     * @brief Get the value of current ctxpopup object's orientation.
18787     *
18788     * @param obj Ctxpopup object
18789     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
18790     *
18791     * @see elm_ctxpopup_horizontal_set()
18792     */
18793    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18794    /**
18795     * @brief Add a new item to a ctxpopup object.
18796     *
18797     * @param obj Ctxpopup object
18798     * @param icon Icon to be set on new item
18799     * @param label The Label of the new item
18800     * @param func Convenience function called when item selected
18801     * @param data Data passed to @p func
18802     * @return A handle to the item added or @c NULL, on errors
18803     *
18804     * @warning Ctxpopup can't hold both an item list and a content at the same
18805     * time. When an item is added, any previous content will be removed.
18806     *
18807     * @see elm_ctxpopup_content_set()
18808     */
18809    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);
18810    /**
18811     * @brief Delete the given item in a ctxpopup object.
18812     *
18813     * @param item Ctxpopup item to be deleted
18814     *
18815     * @see elm_ctxpopup_item_append()
18816     */
18817    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
18818    /**
18819     * @brief Set the ctxpopup item's state as disabled or enabled.
18820     *
18821     * @param item Ctxpopup item to be enabled/disabled
18822     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
18823     *
18824     * When disabled the item is greyed out to indicate it's state.
18825     */
18826    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18827    /**
18828     * @brief Get the ctxpopup item's disabled/enabled state.
18829     *
18830     * @param item Ctxpopup item to be enabled/disabled
18831     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
18832     *
18833     * @see elm_ctxpopup_item_disabled_set()
18834     */
18835    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
18836    /**
18837     * @brief Get the icon object for the given ctxpopup item.
18838     *
18839     * @param item Ctxpopup item
18840     * @return icon object or @c NULL, if the item does not have icon or an error
18841     * occurred
18842     *
18843     * @see elm_ctxpopup_item_append()
18844     * @see elm_ctxpopup_item_icon_set()
18845     */
18846    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
18847    /**
18848     * @brief Sets the side icon associated with the ctxpopup item
18849     *
18850     * @param item Ctxpopup item
18851     * @param icon Icon object to be set
18852     *
18853     * Once the icon object is set, a previously set one will be deleted.
18854     * @warning Setting the same icon for two items will cause the icon to
18855     * dissapear from the first item.
18856     *
18857     * @see elm_ctxpopup_item_append()
18858     */
18859    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
18860    /**
18861     * @brief Get the label for the given ctxpopup item.
18862     *
18863     * @param item Ctxpopup item
18864     * @return label string or @c NULL, if the item does not have label or an
18865     * error occured
18866     *
18867     * @see elm_ctxpopup_item_append()
18868     * @see elm_ctxpopup_item_label_set()
18869     */
18870    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
18871    /**
18872     * @brief (Re)set the label on the given ctxpopup item.
18873     *
18874     * @param item Ctxpopup item
18875     * @param label String to set as label
18876     */
18877    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
18878    /**
18879     * @brief Set an elm widget as the content of the ctxpopup.
18880     *
18881     * @param obj Ctxpopup object
18882     * @param content Content to be swallowed
18883     *
18884     * If the content object is already set, a previous one will bedeleted. If
18885     * you want to keep that old content object, use the
18886     * elm_ctxpopup_content_unset() function.
18887     *
18888     * @warning Ctxpopup can't hold both a item list and a content at the same
18889     * time. When a content is set, any previous items will be removed.
18890     */
18891    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
18892    /**
18893     * @brief Unset the ctxpopup content
18894     *
18895     * @param obj Ctxpopup object
18896     * @return The content that was being used
18897     *
18898     * Unparent and return the content object which was set for this widget.
18899     *
18900     * @see elm_ctxpopup_content_set()
18901     */
18902    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18903    /**
18904     * @brief Set the direction priority of a ctxpopup.
18905     *
18906     * @param obj Ctxpopup object
18907     * @param first 1st priority of direction
18908     * @param second 2nd priority of direction
18909     * @param third 3th priority of direction
18910     * @param fourth 4th priority of direction
18911     *
18912     * This functions gives a chance to user to set the priority of ctxpopup
18913     * showing direction. This doesn't guarantee the ctxpopup will appear in the
18914     * requested direction.
18915     *
18916     * @see Elm_Ctxpopup_Direction
18917     */
18918    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);
18919    /**
18920     * @brief Get the direction priority of a ctxpopup.
18921     *
18922     * @param obj Ctxpopup object
18923     * @param first 1st priority of direction to be returned
18924     * @param second 2nd priority of direction to be returned
18925     * @param third 3th priority of direction to be returned
18926     * @param fourth 4th priority of direction to be returned
18927     *
18928     * @see elm_ctxpopup_direction_priority_set() for more information.
18929     */
18930    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);
18931    /**
18932     * @}
18933     */
18934
18935    /* transit */
18936    /**
18937     *
18938     * @defgroup Transit Transit
18939     * @ingroup Elementary
18940     *
18941     * Transit is designed to apply various animated transition effects to @c
18942     * Evas_Object, such like translation, rotation, etc. For using these
18943     * effects, create an @ref Elm_Transit and add the desired transition effects.
18944     *
18945     * Once the effects are added into transit, they will be automatically
18946     * managed (their callback will be called until the duration is ended, and
18947     * they will be deleted on completion).
18948     *
18949     * Example:
18950     * @code
18951     * Elm_Transit *trans = elm_transit_add();
18952     * elm_transit_object_add(trans, obj);
18953     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
18954     * elm_transit_duration_set(transit, 1);
18955     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
18956     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
18957     * elm_transit_repeat_times_set(transit, 3);
18958     * @endcode
18959     *
18960     * Some transition effects are used to change the properties of objects. They
18961     * are:
18962     * @li @ref elm_transit_effect_translation_add
18963     * @li @ref elm_transit_effect_color_add
18964     * @li @ref elm_transit_effect_rotation_add
18965     * @li @ref elm_transit_effect_wipe_add
18966     * @li @ref elm_transit_effect_zoom_add
18967     * @li @ref elm_transit_effect_resizing_add
18968     *
18969     * Other transition effects are used to make one object disappear and another
18970     * object appear on its old place. These effects are:
18971     *
18972     * @li @ref elm_transit_effect_flip_add
18973     * @li @ref elm_transit_effect_resizable_flip_add
18974     * @li @ref elm_transit_effect_fade_add
18975     * @li @ref elm_transit_effect_blend_add
18976     *
18977     * It's also possible to make a transition chain with @ref
18978     * elm_transit_chain_transit_add.
18979     *
18980     * @warning We strongly recommend to use elm_transit just when edje can not do
18981     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
18982     * animations can be manipulated inside the theme.
18983     *
18984     * List of examples:
18985     * @li @ref transit_example_01_explained
18986     * @li @ref transit_example_02_explained
18987     * @li @ref transit_example_03_c
18988     * @li @ref transit_example_04_c
18989     *
18990     * @{
18991     */
18992
18993    /**
18994     * @enum Elm_Transit_Tween_Mode
18995     *
18996     * The type of acceleration used in the transition.
18997     */
18998    typedef enum
18999      {
19000         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
19001         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
19002                                              over time, then decrease again
19003                                              and stop slowly */
19004         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
19005                                              speed over time */
19006         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
19007                                             over time */
19008      } Elm_Transit_Tween_Mode;
19009
19010    /**
19011     * @enum Elm_Transit_Effect_Flip_Axis
19012     *
19013     * The axis where flip effect should be applied.
19014     */
19015    typedef enum
19016      {
19017         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
19018         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
19019      } Elm_Transit_Effect_Flip_Axis;
19020    /**
19021     * @enum Elm_Transit_Effect_Wipe_Dir
19022     *
19023     * The direction where the wipe effect should occur.
19024     */
19025    typedef enum
19026      {
19027         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
19028         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
19029         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
19030         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
19031      } Elm_Transit_Effect_Wipe_Dir;
19032    /** @enum Elm_Transit_Effect_Wipe_Type
19033     *
19034     * Whether the wipe effect should show or hide the object.
19035     */
19036    typedef enum
19037      {
19038         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
19039                                              animation */
19040         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
19041                                             animation */
19042      } Elm_Transit_Effect_Wipe_Type;
19043
19044    /**
19045     * @typedef Elm_Transit
19046     *
19047     * The Transit created with elm_transit_add(). This type has the information
19048     * about the objects which the transition will be applied, and the
19049     * transition effects that will be used. It also contains info about
19050     * duration, number of repetitions, auto-reverse, etc.
19051     */
19052    typedef struct _Elm_Transit Elm_Transit;
19053    typedef void Elm_Transit_Effect;
19054    /**
19055     * @typedef Elm_Transit_Effect_Transition_Cb
19056     *
19057     * Transition callback called for this effect on each transition iteration.
19058     */
19059    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
19060    /**
19061     * Elm_Transit_Effect_End_Cb
19062     *
19063     * Transition callback called for this effect when the transition is over.
19064     */
19065    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
19066
19067    /**
19068     * Elm_Transit_Del_Cb
19069     *
19070     * A callback called when the transit is deleted.
19071     */
19072    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
19073
19074    /**
19075     * Add new transit.
19076     *
19077     * @note Is not necessary to delete the transit object, it will be deleted at
19078     * the end of its operation.
19079     * @note The transit will start playing when the program enter in the main loop, is not
19080     * necessary to give a start to the transit.
19081     *
19082     * @return The transit object.
19083     *
19084     * @ingroup Transit
19085     */
19086    EAPI Elm_Transit                *elm_transit_add(void);
19087
19088    /**
19089     * Stops the animation and delete the @p transit object.
19090     *
19091     * Call this function if you wants to stop the animation before the duration
19092     * time. Make sure the @p transit object is still alive with
19093     * elm_transit_del_cb_set() function.
19094     * All added effects will be deleted, calling its repective data_free_cb
19095     * functions. The function setted by elm_transit_del_cb_set() will be called.
19096     *
19097     * @see elm_transit_del_cb_set()
19098     *
19099     * @param transit The transit object to be deleted.
19100     *
19101     * @ingroup Transit
19102     * @warning Just call this function if you are sure the transit is alive.
19103     */
19104    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
19105
19106    /**
19107     * Add a new effect to the transit.
19108     *
19109     * @note The cb function and the data are the key to the effect. If you try to
19110     * add an already added effect, nothing is done.
19111     * @note After the first addition of an effect in @p transit, if its
19112     * effect list become empty again, the @p transit will be killed by
19113     * elm_transit_del(transit) function.
19114     *
19115     * Exemple:
19116     * @code
19117     * Elm_Transit *transit = elm_transit_add();
19118     * elm_transit_effect_add(transit,
19119     *                        elm_transit_effect_blend_op,
19120     *                        elm_transit_effect_blend_context_new(),
19121     *                        elm_transit_effect_blend_context_free);
19122     * @endcode
19123     *
19124     * @param transit The transit object.
19125     * @param transition_cb The operation function. It is called when the
19126     * animation begins, it is the function that actually performs the animation.
19127     * It is called with the @p data, @p transit and the time progression of the
19128     * animation (a double value between 0.0 and 1.0).
19129     * @param effect The context data of the effect.
19130     * @param end_cb The function to free the context data, it will be called
19131     * at the end of the effect, it must finalize the animation and free the
19132     * @p data.
19133     *
19134     * @ingroup Transit
19135     * @warning The transit free the context data at the and of the transition with
19136     * the data_free_cb function, do not use the context data in another transit.
19137     */
19138    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);
19139
19140    /**
19141     * Delete an added effect.
19142     *
19143     * This function will remove the effect from the @p transit, calling the
19144     * data_free_cb to free the @p data.
19145     *
19146     * @see elm_transit_effect_add()
19147     *
19148     * @note If the effect is not found, nothing is done.
19149     * @note If the effect list become empty, this function will call
19150     * elm_transit_del(transit), that is, it will kill the @p transit.
19151     *
19152     * @param transit The transit object.
19153     * @param transition_cb The operation function.
19154     * @param effect The context data of the effect.
19155     *
19156     * @ingroup Transit
19157     */
19158    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);
19159
19160    /**
19161     * Add new object to apply the effects.
19162     *
19163     * @note After the first addition of an object in @p transit, if its
19164     * object list become empty again, the @p transit will be killed by
19165     * elm_transit_del(transit) function.
19166     * @note If the @p obj belongs to another transit, the @p obj will be
19167     * removed from it and it will only belong to the @p transit. If the old
19168     * transit stays without objects, it will die.
19169     * @note When you add an object into the @p transit, its state from
19170     * evas_object_pass_events_get(obj) is saved, and it is applied when the
19171     * transit ends, if you change this state whith evas_object_pass_events_set()
19172     * after add the object, this state will change again when @p transit stops to
19173     * run.
19174     *
19175     * @param transit The transit object.
19176     * @param obj Object to be animated.
19177     *
19178     * @ingroup Transit
19179     * @warning It is not allowed to add a new object after transit begins to go.
19180     */
19181    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
19182
19183    /**
19184     * Removes an added object from the transit.
19185     *
19186     * @note If the @p obj is not in the @p transit, nothing is done.
19187     * @note If the list become empty, this function will call
19188     * elm_transit_del(transit), that is, it will kill the @p transit.
19189     *
19190     * @param transit The transit object.
19191     * @param obj Object to be removed from @p transit.
19192     *
19193     * @ingroup Transit
19194     * @warning It is not allowed to remove objects after transit begins to go.
19195     */
19196    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
19197
19198    /**
19199     * Get the objects of the transit.
19200     *
19201     * @param transit The transit object.
19202     * @return a Eina_List with the objects from the transit.
19203     *
19204     * @ingroup Transit
19205     */
19206    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
19207
19208    /**
19209     * Enable/disable keeping up the objects states.
19210     * If it is not kept, the objects states will be reset when transition ends.
19211     *
19212     * @note @p transit can not be NULL.
19213     * @note One state includes geometry, color, map data.
19214     *
19215     * @param transit The transit object.
19216     * @param state_keep Keeping or Non Keeping.
19217     *
19218     * @ingroup Transit
19219     */
19220    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
19221
19222    /**
19223     * Get a value whether the objects states will be reset or not.
19224     *
19225     * @note @p transit can not be NULL
19226     *
19227     * @see elm_transit_objects_final_state_keep_set()
19228     *
19229     * @param transit The transit object.
19230     * @return EINA_TRUE means the states of the objects will be reset.
19231     * If @p transit is NULL, EINA_FALSE is returned
19232     *
19233     * @ingroup Transit
19234     */
19235    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
19236
19237    /**
19238     * Set the event enabled when transit is operating.
19239     *
19240     * If @p enabled is EINA_TRUE, the objects of the transit will receives
19241     * events from mouse and keyboard during the animation.
19242     * @note When you add an object with elm_transit_object_add(), its state from
19243     * evas_object_pass_events_get(obj) is saved, and it is applied when the
19244     * transit ends, if you change this state with evas_object_pass_events_set()
19245     * after adding the object, this state will change again when @p transit stops
19246     * to run.
19247     *
19248     * @param transit The transit object.
19249     * @param enabled Events are received when enabled is @c EINA_TRUE, and
19250     * ignored otherwise.
19251     *
19252     * @ingroup Transit
19253     */
19254    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
19255
19256    /**
19257     * Get the value of event enabled status.
19258     *
19259     * @see elm_transit_event_enabled_set()
19260     *
19261     * @param transit The Transit object
19262     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
19263     * EINA_FALSE is returned
19264     *
19265     * @ingroup Transit
19266     */
19267    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
19268
19269    /**
19270     * Set the user-callback function when the transit is deleted.
19271     *
19272     * @note Using this function twice will overwrite the first function setted.
19273     * @note the @p transit object will be deleted after call @p cb function.
19274     *
19275     * @param transit The transit object.
19276     * @param cb Callback function pointer. This function will be called before
19277     * the deletion of the transit.
19278     * @param data Callback funtion user data. It is the @p op parameter.
19279     *
19280     * @ingroup Transit
19281     */
19282    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
19283
19284    /**
19285     * Set reverse effect automatically.
19286     *
19287     * If auto reverse is setted, after running the effects with the progress
19288     * parameter from 0 to 1, it will call the effecs again with the progress
19289     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
19290     * where the duration was setted with the function elm_transit_add and
19291     * the repeat with the function elm_transit_repeat_times_set().
19292     *
19293     * @param transit The transit object.
19294     * @param reverse EINA_TRUE means the auto_reverse is on.
19295     *
19296     * @ingroup Transit
19297     */
19298    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
19299
19300    /**
19301     * Get if the auto reverse is on.
19302     *
19303     * @see elm_transit_auto_reverse_set()
19304     *
19305     * @param transit The transit object.
19306     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
19307     * EINA_FALSE is returned
19308     *
19309     * @ingroup Transit
19310     */
19311    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
19312
19313    /**
19314     * Set the transit repeat count. Effect will be repeated by repeat count.
19315     *
19316     * This function sets the number of repetition the transit will run after
19317     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
19318     * If the @p repeat is a negative number, it will repeat infinite times.
19319     *
19320     * @note If this function is called during the transit execution, the transit
19321     * will run @p repeat times, ignoring the times it already performed.
19322     *
19323     * @param transit The transit object
19324     * @param repeat Repeat count
19325     *
19326     * @ingroup Transit
19327     */
19328    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
19329
19330    /**
19331     * Get the transit repeat count.
19332     *
19333     * @see elm_transit_repeat_times_set()
19334     *
19335     * @param transit The Transit object.
19336     * @return The repeat count. If @p transit is NULL
19337     * 0 is returned
19338     *
19339     * @ingroup Transit
19340     */
19341    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
19342
19343    /**
19344     * Set the transit animation acceleration type.
19345     *
19346     * This function sets the tween mode of the transit that can be:
19347     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
19348     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
19349     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
19350     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
19351     *
19352     * @param transit The transit object.
19353     * @param tween_mode The tween type.
19354     *
19355     * @ingroup Transit
19356     */
19357    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
19358
19359    /**
19360     * Get the transit animation acceleration type.
19361     *
19362     * @note @p transit can not be NULL
19363     *
19364     * @param transit The transit object.
19365     * @return The tween type. If @p transit is NULL
19366     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
19367     *
19368     * @ingroup Transit
19369     */
19370    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
19371
19372    /**
19373     * Set the transit animation time
19374     *
19375     * @note @p transit can not be NULL
19376     *
19377     * @param transit The transit object.
19378     * @param duration The animation time.
19379     *
19380     * @ingroup Transit
19381     */
19382    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
19383
19384    /**
19385     * Get the transit animation time
19386     *
19387     * @note @p transit can not be NULL
19388     *
19389     * @param transit The transit object.
19390     *
19391     * @return The transit animation time.
19392     *
19393     * @ingroup Transit
19394     */
19395    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
19396
19397    /**
19398     * Starts the transition.
19399     * Once this API is called, the transit begins to measure the time.
19400     *
19401     * @note @p transit can not be NULL
19402     *
19403     * @param transit The transit object.
19404     *
19405     * @ingroup Transit
19406     */
19407    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
19408
19409    /**
19410     * Pause/Resume the transition.
19411     *
19412     * If you call elm_transit_go again, the transit will be started from the
19413     * beginning, and will be unpaused.
19414     *
19415     * @note @p transit can not be NULL
19416     *
19417     * @param transit The transit object.
19418     * @param paused Whether the transition should be paused or not.
19419     *
19420     * @ingroup Transit
19421     */
19422    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
19423
19424    /**
19425     * Get the value of paused status.
19426     *
19427     * @see elm_transit_paused_set()
19428     *
19429     * @note @p transit can not be NULL
19430     *
19431     * @param transit The transit object.
19432     * @return EINA_TRUE means transition is paused. If @p transit is NULL
19433     * EINA_FALSE is returned
19434     *
19435     * @ingroup Transit
19436     */
19437    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
19438
19439    /**
19440     * Get the time progression of the animation (a double value between 0.0 and 1.0).
19441     *
19442     * The value returned is a fraction (current time / total time). It
19443     * represents the progression position relative to the total.
19444     *
19445     * @note @p transit can not be NULL
19446     *
19447     * @param transit The transit object.
19448     *
19449     * @return The time progression value. If @p transit is NULL
19450     * 0 is returned
19451     *
19452     * @ingroup Transit
19453     */
19454    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
19455
19456    /**
19457     * Makes the chain relationship between two transits.
19458     *
19459     * @note @p transit can not be NULL. Transit would have multiple chain transits.
19460     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
19461     *
19462     * @param transit The transit object.
19463     * @param chain_transit The chain transit object. This transit will be operated
19464     *        after transit is done.
19465     *
19466     * This function adds @p chain_transit transition to a chain after the @p
19467     * transit, and will be started as soon as @p transit ends. See @ref
19468     * transit_example_02_explained for a full example.
19469     *
19470     * @ingroup Transit
19471     */
19472    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
19473
19474    /**
19475     * Cut off the chain relationship between two transits.
19476     *
19477     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
19478     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
19479     *
19480     * @param transit The transit object.
19481     * @param chain_transit The chain transit object.
19482     *
19483     * This function remove the @p chain_transit transition from the @p transit.
19484     *
19485     * @ingroup Transit
19486     */
19487    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
19488
19489    /**
19490     * Get the current chain transit list.
19491     *
19492     * @note @p transit can not be NULL.
19493     *
19494     * @param transit The transit object.
19495     * @return chain transit list.
19496     *
19497     * @ingroup Transit
19498     */
19499    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
19500
19501    /**
19502     * Add the Resizing Effect to Elm_Transit.
19503     *
19504     * @note This API is one of the facades. It creates resizing effect context
19505     * and add it's required APIs to elm_transit_effect_add.
19506     *
19507     * @see elm_transit_effect_add()
19508     *
19509     * @param transit Transit object.
19510     * @param from_w Object width size when effect begins.
19511     * @param from_h Object height size when effect begins.
19512     * @param to_w Object width size when effect ends.
19513     * @param to_h Object height size when effect ends.
19514     * @return Resizing effect context data.
19515     *
19516     * @ingroup Transit
19517     */
19518    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);
19519
19520    /**
19521     * Add the Translation Effect to Elm_Transit.
19522     *
19523     * @note This API is one of the facades. It creates translation effect context
19524     * and add it's required APIs to elm_transit_effect_add.
19525     *
19526     * @see elm_transit_effect_add()
19527     *
19528     * @param transit Transit object.
19529     * @param from_dx X Position variation when effect begins.
19530     * @param from_dy Y Position variation when effect begins.
19531     * @param to_dx X Position variation when effect ends.
19532     * @param to_dy Y Position variation when effect ends.
19533     * @return Translation effect context data.
19534     *
19535     * @ingroup Transit
19536     * @warning It is highly recommended just create a transit with this effect when
19537     * the window that the objects of the transit belongs has already been created.
19538     * This is because this effect needs the geometry information about the objects,
19539     * and if the window was not created yet, it can get a wrong information.
19540     */
19541    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);
19542
19543    /**
19544     * Add the Zoom Effect to Elm_Transit.
19545     *
19546     * @note This API is one of the facades. It creates zoom effect context
19547     * and add it's required APIs to elm_transit_effect_add.
19548     *
19549     * @see elm_transit_effect_add()
19550     *
19551     * @param transit Transit object.
19552     * @param from_rate Scale rate when effect begins (1 is current rate).
19553     * @param to_rate Scale rate when effect ends.
19554     * @return Zoom effect context data.
19555     *
19556     * @ingroup Transit
19557     * @warning It is highly recommended just create a transit with this effect when
19558     * the window that the objects of the transit belongs has already been created.
19559     * This is because this effect needs the geometry information about the objects,
19560     * and if the window was not created yet, it can get a wrong information.
19561     */
19562    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
19563
19564    /**
19565     * Add the Flip Effect to Elm_Transit.
19566     *
19567     * @note This API is one of the facades. It creates flip effect context
19568     * and add it's required APIs to elm_transit_effect_add.
19569     * @note This effect is applied to each pair of objects in the order they are listed
19570     * in the transit list of objects. The first object in the pair will be the
19571     * "front" object and the second will be the "back" object.
19572     *
19573     * @see elm_transit_effect_add()
19574     *
19575     * @param transit Transit object.
19576     * @param axis Flipping Axis(X or Y).
19577     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
19578     * @return Flip effect context data.
19579     *
19580     * @ingroup Transit
19581     * @warning It is highly recommended just create a transit with this effect when
19582     * the window that the objects of the transit belongs has already been created.
19583     * This is because this effect needs the geometry information about the objects,
19584     * and if the window was not created yet, it can get a wrong information.
19585     */
19586    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
19587
19588    /**
19589     * Add the Resizable Flip Effect to Elm_Transit.
19590     *
19591     * @note This API is one of the facades. It creates resizable flip effect context
19592     * and add it's required APIs to elm_transit_effect_add.
19593     * @note This effect is applied to each pair of objects in the order they are listed
19594     * in the transit list of objects. The first object in the pair will be the
19595     * "front" object and the second will be the "back" object.
19596     *
19597     * @see elm_transit_effect_add()
19598     *
19599     * @param transit Transit object.
19600     * @param axis Flipping Axis(X or Y).
19601     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
19602     * @return Resizable flip effect context data.
19603     *
19604     * @ingroup Transit
19605     * @warning It is highly recommended just create a transit with this effect when
19606     * the window that the objects of the transit belongs has already been created.
19607     * This is because this effect needs the geometry information about the objects,
19608     * and if the window was not created yet, it can get a wrong information.
19609     */
19610    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
19611
19612    /**
19613     * Add the Wipe Effect to Elm_Transit.
19614     *
19615     * @note This API is one of the facades. It creates wipe effect context
19616     * and add it's required APIs to elm_transit_effect_add.
19617     *
19618     * @see elm_transit_effect_add()
19619     *
19620     * @param transit Transit object.
19621     * @param type Wipe type. Hide or show.
19622     * @param dir Wipe Direction.
19623     * @return Wipe effect context data.
19624     *
19625     * @ingroup Transit
19626     * @warning It is highly recommended just create a transit with this effect when
19627     * the window that the objects of the transit belongs has already been created.
19628     * This is because this effect needs the geometry information about the objects,
19629     * and if the window was not created yet, it can get a wrong information.
19630     */
19631    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
19632
19633    /**
19634     * Add the Color Effect to Elm_Transit.
19635     *
19636     * @note This API is one of the facades. It creates color effect context
19637     * and add it's required APIs to elm_transit_effect_add.
19638     *
19639     * @see elm_transit_effect_add()
19640     *
19641     * @param transit        Transit object.
19642     * @param  from_r        RGB R when effect begins.
19643     * @param  from_g        RGB G when effect begins.
19644     * @param  from_b        RGB B when effect begins.
19645     * @param  from_a        RGB A when effect begins.
19646     * @param  to_r          RGB R when effect ends.
19647     * @param  to_g          RGB G when effect ends.
19648     * @param  to_b          RGB B when effect ends.
19649     * @param  to_a          RGB A when effect ends.
19650     * @return               Color effect context data.
19651     *
19652     * @ingroup Transit
19653     */
19654    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);
19655
19656    /**
19657     * Add the Fade Effect to Elm_Transit.
19658     *
19659     * @note This API is one of the facades. It creates fade effect context
19660     * and add it's required APIs to elm_transit_effect_add.
19661     * @note This effect is applied to each pair of objects in the order they are listed
19662     * in the transit list of objects. The first object in the pair will be the
19663     * "before" object and the second will be the "after" object.
19664     *
19665     * @see elm_transit_effect_add()
19666     *
19667     * @param transit Transit object.
19668     * @return Fade effect context data.
19669     *
19670     * @ingroup Transit
19671     * @warning It is highly recommended just create a transit with this effect when
19672     * the window that the objects of the transit belongs has already been created.
19673     * This is because this effect needs the color information about the objects,
19674     * and if the window was not created yet, it can get a wrong information.
19675     */
19676    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
19677
19678    /**
19679     * Add the Blend Effect to Elm_Transit.
19680     *
19681     * @note This API is one of the facades. It creates blend effect context
19682     * and add it's required APIs to elm_transit_effect_add.
19683     * @note This effect is applied to each pair of objects in the order they are listed
19684     * in the transit list of objects. The first object in the pair will be the
19685     * "before" object and the second will be the "after" object.
19686     *
19687     * @see elm_transit_effect_add()
19688     *
19689     * @param transit Transit object.
19690     * @return Blend effect context data.
19691     *
19692     * @ingroup Transit
19693     * @warning It is highly recommended just create a transit with this effect when
19694     * the window that the objects of the transit belongs has already been created.
19695     * This is because this effect needs the color information about the objects,
19696     * and if the window was not created yet, it can get a wrong information.
19697     */
19698    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
19699
19700    /**
19701     * Add the Rotation Effect to Elm_Transit.
19702     *
19703     * @note This API is one of the facades. It creates rotation effect context
19704     * and add it's required APIs to elm_transit_effect_add.
19705     *
19706     * @see elm_transit_effect_add()
19707     *
19708     * @param transit Transit object.
19709     * @param from_degree Degree when effect begins.
19710     * @param to_degree Degree when effect is ends.
19711     * @return Rotation effect context data.
19712     *
19713     * @ingroup Transit
19714     * @warning It is highly recommended just create a transit with this effect when
19715     * the window that the objects of the transit belongs has already been created.
19716     * This is because this effect needs the geometry information about the objects,
19717     * and if the window was not created yet, it can get a wrong information.
19718     */
19719    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
19720
19721    /**
19722     * Add the ImageAnimation Effect to Elm_Transit.
19723     *
19724     * @note This API is one of the facades. It creates image animation effect context
19725     * and add it's required APIs to elm_transit_effect_add.
19726     * The @p images parameter is a list images paths. This list and
19727     * its contents will be deleted at the end of the effect by
19728     * elm_transit_effect_image_animation_context_free() function.
19729     *
19730     * Example:
19731     * @code
19732     * char buf[PATH_MAX];
19733     * Eina_List *images = NULL;
19734     * Elm_Transit *transi = elm_transit_add();
19735     *
19736     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
19737     * images = eina_list_append(images, eina_stringshare_add(buf));
19738     *
19739     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
19740     * images = eina_list_append(images, eina_stringshare_add(buf));
19741     * elm_transit_effect_image_animation_add(transi, images);
19742     *
19743     * @endcode
19744     *
19745     * @see elm_transit_effect_add()
19746     *
19747     * @param transit Transit object.
19748     * @param images Eina_List of images file paths. This list and
19749     * its contents will be deleted at the end of the effect by
19750     * elm_transit_effect_image_animation_context_free() function.
19751     * @return Image Animation effect context data.
19752     *
19753     * @ingroup Transit
19754     */
19755    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
19756    /**
19757     * @}
19758     */
19759
19760   typedef struct _Elm_Store                      Elm_Store;
19761   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
19762   typedef struct _Elm_Store_Item                 Elm_Store_Item;
19763   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
19764   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
19765   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
19766   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
19767   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
19768   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
19769   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
19770   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
19771
19772   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
19773   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
19774   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
19775   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
19776
19777   typedef enum
19778     {
19779        ELM_STORE_ITEM_MAPPING_NONE = 0,
19780        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
19781        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
19782        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
19783        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
19784        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
19785        // can add more here as needed by common apps
19786        ELM_STORE_ITEM_MAPPING_LAST
19787     } Elm_Store_Item_Mapping_Type;
19788
19789   struct _Elm_Store_Item_Mapping_Icon
19790     {
19791        // FIXME: allow edje file icons
19792        int                   w, h;
19793        Elm_Icon_Lookup_Order lookup_order;
19794        Eina_Bool             standard_name : 1;
19795        Eina_Bool             no_scale : 1;
19796        Eina_Bool             smooth : 1;
19797        Eina_Bool             scale_up : 1;
19798        Eina_Bool             scale_down : 1;
19799     };
19800
19801   struct _Elm_Store_Item_Mapping_Empty
19802     {
19803        Eina_Bool             dummy;
19804     };
19805
19806   struct _Elm_Store_Item_Mapping_Photo
19807     {
19808        int                   size;
19809     };
19810
19811   struct _Elm_Store_Item_Mapping_Custom
19812     {
19813        Elm_Store_Item_Mapping_Cb func;
19814     };
19815
19816   struct _Elm_Store_Item_Mapping
19817     {
19818        Elm_Store_Item_Mapping_Type     type;
19819        const char                     *part;
19820        int                             offset;
19821        union
19822          {
19823             Elm_Store_Item_Mapping_Empty  empty;
19824             Elm_Store_Item_Mapping_Icon   icon;
19825             Elm_Store_Item_Mapping_Photo  photo;
19826             Elm_Store_Item_Mapping_Custom custom;
19827             // add more types here
19828          } details;
19829     };
19830
19831   struct _Elm_Store_Item_Info
19832     {
19833       Elm_Genlist_Item_Class       *item_class;
19834       const Elm_Store_Item_Mapping *mapping;
19835       void                         *data;
19836       char                         *sort_id;
19837     };
19838
19839   struct _Elm_Store_Item_Info_Filesystem
19840     {
19841       Elm_Store_Item_Info  base;
19842       char                *path;
19843     };
19844
19845 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
19846 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
19847
19848   EAPI void                    elm_store_free(Elm_Store *st);
19849
19850   EAPI Elm_Store              *elm_store_filesystem_new(void);
19851   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
19852   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
19853   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
19854
19855   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
19856
19857   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
19858   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
19859   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
19860   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
19861   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
19862   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
19863
19864   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
19865   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
19866   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
19867   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
19868   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
19869   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
19870   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
19871
19872    /* SegmentControl */
19873    typedef struct _Elm_Segment_Item Elm_Segment_Item;
19874    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19875    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
19876    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);
19877    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
19878    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
19879    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19880    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
19881    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
19882    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
19883    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
19884    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
19885    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
19886    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
19887    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19888    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
19889    /* smart callbacks called:
19890     * "changed" -when the user clicks on a segment item which is not previously
19891     *            selected and get selected. The event_info parameter is the
19892     *            segment item index.
19893     */
19894
19895    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
19896    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
19897    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
19898    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
19899    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
19900    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
19901    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
19902    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
19903
19904    EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
19905    EAPI void         elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
19906
19907    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
19908    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
19909    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
19910    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
19911    EAPI void elm_video_play(Evas_Object *video);
19912    EAPI void elm_video_pause(Evas_Object *video);
19913    EAPI void elm_video_stop(Evas_Object *video);
19914    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
19915    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
19916    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
19917    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
19918    EAPI double elm_video_audio_level_get(Evas_Object *video);
19919    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
19920    EAPI double elm_video_play_position_get(Evas_Object *video);
19921    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
19922    EAPI double elm_video_play_length_get(Evas_Object *video);
19923    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
19924    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
19925    EAPI const char *elm_video_title_get(Evas_Object *video);
19926
19927    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
19928    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
19929
19930   /* naviframe */
19931    typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
19932
19933    typedef enum
19934      {
19935         ELM_NAVIFRAME_PREV_BUTTON,
19936         ELM_NAVIFRAME_NEXT_BUTTON
19937      } Elm_Naviframe_Button_Type;
19938
19939    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19940    EAPI Elm_Naviframe_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);
19941    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19942    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
19943    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19944    EAPI void                elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
19945    EAPI Evas_Object        *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
19946    EAPI void                elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
19947    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
19948    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
19949    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
19950    EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19951    EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19952    EAPI void                elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
19953    EAPI Evas_Object        *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
19954    EAPI void                elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
19955    EAPI Evas_Object        *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
19956    EAPI void                elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
19957    EAPI const char         *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
19958    EAPI void                elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
19959    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
19960
19961 #ifdef __cplusplus
19962 }
19963 #endif
19964
19965 #endif