add new signal for list/genlist/gengrid: "activated"
[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 <Edje.h>
153
154 #ifdef ELM_EDBUS
155 # include <E_DBus.h>
156 #endif
157
158 #ifdef ELM_EFREET
159 # include <Efreet.h>
160 # include <Efreet_Mime.h>
161 # include <Efreet_Trash.h>
162 #endif
163
164 #ifdef ELM_ETHUMB
165 # include <Ethumb_Client.h>
166 #endif
167
168 #ifdef ELM_EMAP
169 # include <EMap.h>
170 #endif
171
172 #ifdef EAPI
173 # undef EAPI
174 #endif
175
176 #ifdef _WIN32
177 # ifdef ELEMENTARY_BUILD
178 #  ifdef DLL_EXPORT
179 #   define EAPI __declspec(dllexport)
180 #  else
181 #   define EAPI
182 #  endif /* ! DLL_EXPORT */
183 # else
184 #  define EAPI __declspec(dllimport)
185 # endif /* ! EFL_EVAS_BUILD */
186 #else
187 # ifdef __GNUC__
188 #  if __GNUC__ >= 4
189 #   define EAPI __attribute__ ((visibility("default")))
190 #  else
191 #   define EAPI
192 #  endif
193 # else
194 #  define EAPI
195 # endif
196 #endif /* ! _WIN32 */
197
198
199 /* allow usage from c++ */
200 #ifdef __cplusplus
201 extern "C" {
202 #endif
203
204 #define ELM_VERSION_MAJOR @VMAJ@
205 #define ELM_VERSION_MINOR @VMIN@
206
207    typedef struct _Elm_Version
208      {
209         int major;
210         int minor;
211         int micro;
212         int revision;
213      } Elm_Version;
214
215    EAPI extern Elm_Version *elm_version;
216
217 /* handy macros */
218 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
219 #define ELM_PI 3.14159265358979323846
220
221    /**
222     * @defgroup General General
223     *
224     * @brief General Elementary API. Functions that don't relate to
225     * Elementary objects specifically.
226     *
227     * Here are documented functions which init/shutdown the library,
228     * that apply to generic Elementary objects, that deal with
229     * configuration, et cetera.
230     *
231     * @ref general_functions_example_page "This" example contemplates
232     * some of these functions.
233     */
234
235    /**
236     * @addtogroup General
237     * @{
238     */
239
240   /**
241    * Defines couple of standard Evas_Object layers to be used
242    * with evas_object_layer_set().
243    *
244    * @note whenever extending with new values, try to keep some padding
245    *       to siblings so there is room for further extensions.
246    */
247   typedef enum _Elm_Object_Layer
248     {
249        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
250        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
251        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
252        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
253        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
254        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
255     } Elm_Object_Layer;
256
257 /**************************************************************************/
258    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
259
260    /**
261     * Emitted when any Elementary's policy value is changed.
262     */
263    EAPI extern int ELM_EVENT_POLICY_CHANGED;
264
265    /**
266     * @typedef Elm_Event_Policy_Changed
267     *
268     * Data on the event when an Elementary policy has changed
269     */
270     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
271
272    /**
273     * @struct _Elm_Event_Policy_Changed
274     *
275     * Data on the event when an Elementary policy has changed
276     */
277     struct _Elm_Event_Policy_Changed
278      {
279         unsigned int policy; /**< the policy identifier */
280         int          new_value; /**< value the policy had before the change */
281         int          old_value; /**< new value the policy got */
282     };
283
284    /**
285     * Policy identifiers.
286     */
287     typedef enum _Elm_Policy
288     {
289         ELM_POLICY_QUIT, /**< under which circunstances the application
290                           * should quit automatically. @see
291                           * Elm_Policy_Quit.
292                           */
293         ELM_POLICY_LAST
294     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
295  */
296
297    typedef enum _Elm_Policy_Quit
298      {
299         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
300                                    * automatically */
301         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
302                                             * application's last
303                                             * window is closed */
304      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
305
306    typedef enum _Elm_Focus_Direction
307      {
308         ELM_FOCUS_PREVIOUS,
309         ELM_FOCUS_NEXT
310      } Elm_Focus_Direction;
311
312    typedef enum _Elm_Text_Format
313      {
314         ELM_TEXT_FORMAT_PLAIN_UTF8,
315         ELM_TEXT_FORMAT_MARKUP_UTF8
316      } Elm_Text_Format;
317
318    /**
319     * Line wrapping types.
320     */
321    typedef enum _Elm_Wrap_Type
322      {
323         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
324         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
325         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
326         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
327         ELM_WRAP_LAST
328      } Elm_Wrap_Type;
329
330
331    /**
332     * Called back when a widget's tooltip is activated and needs content.
333     * @param data user-data given to elm_object_tooltip_content_cb_set()
334     * @param obj owner widget.
335     */
336    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
337
338    /**
339     * Called back when a widget's item tooltip is activated and needs content.
340     * @param data user-data given to elm_object_tooltip_content_cb_set()
341     * @param obj owner widget.
342     * @param item context dependent item. As an example, if tooltip was
343     *        set on Elm_List_Item, then it is of this type.
344     */
345    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
346
347    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
348
349 #ifndef ELM_LIB_QUICKLAUNCH
350 #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 */
351 #else
352 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
353 #endif
354
355 /**************************************************************************/
356    /* General calls */
357
358    /**
359     * Initialize Elementary
360     *
361     * @param[in] argc System's argument count value
362     * @param[in] argv System's pointer to array of argument strings
363     * @return The init counter value.
364     *
365     * This function initializes Elementary and increments a counter of
366     * the number of calls to it. It returs the new counter's value.
367     *
368     * @warning This call is exported only for use by the @c ELM_MAIN()
369     * macro. There is no need to use this if you use this macro (which
370     * is highly advisable). An elm_main() should contain the entry
371     * point code for your application, having the same prototype as
372     * elm_init(), and @b not being static (putting the @c EAPI symbol
373     * in front of its type declaration is advisable). The @c
374     * ELM_MAIN() call should be placed just after it.
375     *
376     * Example:
377     * @dontinclude bg_example_01.c
378     * @skip static void
379     * @until ELM_MAIN
380     *
381     * See the full @ref bg_example_01_c "example".
382     *
383     * @see elm_shutdown().
384     * @ingroup General
385     */
386    EAPI int          elm_init(int argc, char **argv);
387
388    /**
389     * Shut down Elementary
390     *
391     * @return The init counter value.
392     *
393     * This should be called at the end of your application, just
394     * before it ceases to do any more processing. This will clean up
395     * any permanent resources your application may have allocated via
396     * Elementary that would otherwise persist.
397     *
398     * @see elm_init() for an example
399     *
400     * @ingroup General
401     */
402    EAPI int          elm_shutdown(void);
403
404    /**
405     * Run Elementary's main loop
406     *
407     * This call should be issued just after all initialization is
408     * completed. This function will not return until elm_exit() is
409     * called. It will keep looping, running the main
410     * (event/processing) loop for Elementary.
411     *
412     * @see elm_init() for an example
413     *
414     * @ingroup General
415     */
416    EAPI void         elm_run(void);
417
418    /**
419     * Exit Elementary's main loop
420     *
421     * If this call is issued, it will flag the main loop to cease
422     * processing and return back to its parent function (usually your
423     * elm_main() function).
424     *
425     * @see elm_init() for an example. There, just after a request to
426     * close the window comes, the main loop will be left.
427     *
428     * @note By using the #ELM_POLICY_QUIT on your Elementary
429     * applications, you'll this function called automatically for you.
430     *
431     * @ingroup General
432     */
433    EAPI void         elm_exit(void);
434
435    /**
436     * Provide information in order to make Elementary determine the @b
437     * run time location of the software in question, so other data files
438     * such as images, sound files, executable utilities, libraries,
439     * modules and locale files can be found.
440     *
441     * @param mainfunc This is your application's main function name,
442     *        whose binary's location is to be found. Providing @c NULL
443     *        will make Elementary not to use it
444     * @param dom This will be used as the application's "domain", in the
445     *        form of a prefix to any environment variables that may
446     *        override prefix detection and the directory name, inside the
447     *        standard share or data directories, where the software's
448     *        data files will be looked for.
449     * @param checkfile This is an (optional) magic file's path to check
450     *        for existence (and it must be located in the data directory,
451     *        under the share directory provided above). Its presence will
452     *        help determine the prefix found was correct. Pass @c NULL if
453     *        the check is not to be done.
454     *
455     * This function allows one to re-locate the application somewhere
456     * else after compilation, if the developer wishes for easier
457     * distribution of pre-compiled binaries.
458     *
459     * The prefix system is designed to locate where the given software is
460     * installed (under a common path prefix) at run time and then report
461     * specific locations of this prefix and common directories inside
462     * this prefix like the binary, library, data and locale directories,
463     * through the @c elm_app_*_get() family of functions.
464     *
465     * Call elm_app_info_set() early on before you change working
466     * directory or anything about @c argv[0], so it gets accurate
467     * information.
468     *
469     * It will then try and trace back which file @p mainfunc comes from,
470     * if provided, to determine the application's prefix directory.
471     *
472     * The @p dom parameter provides a string prefix to prepend before
473     * environment variables, allowing a fallback to @b specific
474     * environment variables to locate the software. You would most
475     * probably provide a lowercase string there, because it will also
476     * serve as directory domain, explained next. For environment
477     * variables purposes, this string is made uppercase. For example if
478     * @c "myapp" is provided as the prefix, then the program would expect
479     * @c "MYAPP_PREFIX" as a master environment variable to specify the
480     * exact install prefix for the software, or more specific environment
481     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
482     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
483     * the user or scripts before launching. If not provided (@c NULL),
484     * environment variables will not be used to override compiled-in
485     * defaults or auto detections.
486     *
487     * The @p dom string also provides a subdirectory inside the system
488     * shared data directory for data files. For example, if the system
489     * directory is @c /usr/local/share, then this directory name is
490     * appended, creating @c /usr/local/share/myapp, if it @p was @c
491     * "myapp". It is expected the application installs data files in
492     * this directory.
493     *
494     * The @p checkfile is a file name or path of something inside the
495     * share or data directory to be used to test that the prefix
496     * detection worked. For example, your app will install a wallpaper
497     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
498     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
499     * checkfile string.
500     *
501     * @see elm_app_compile_bin_dir_set()
502     * @see elm_app_compile_lib_dir_set()
503     * @see elm_app_compile_data_dir_set()
504     * @see elm_app_compile_locale_set()
505     * @see elm_app_prefix_dir_get()
506     * @see elm_app_bin_dir_get()
507     * @see elm_app_lib_dir_get()
508     * @see elm_app_data_dir_get()
509     * @see elm_app_locale_dir_get()
510     */
511    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
512
513    /**
514     * Provide information on the @b fallback application's binaries
515     * directory, on scenarios where they get overriden by
516     * elm_app_info_set().
517     *
518     * @param dir The path to the default binaries directory (compile time
519     * one)
520     *
521     * @note Elementary will as well use this path to determine actual
522     * names of binaries' directory paths, maybe changing it to be @c
523     * something/local/bin instead of @c something/bin, only, for
524     * example.
525     *
526     * @warning You should call this function @b before
527     * elm_app_info_set().
528     */
529    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
530
531    /**
532     * Provide information on the @b fallback application's libraries
533     * directory, on scenarios where they get overriden by
534     * elm_app_info_set().
535     *
536     * @param dir The path to the default libraries directory (compile
537     * time one)
538     *
539     * @note Elementary will as well use this path to determine actual
540     * names of libraries' directory paths, maybe changing it to be @c
541     * something/lib32 or @c something/lib64 instead of @c something/lib,
542     * only, for example.
543     *
544     * @warning You should call this function @b before
545     * elm_app_info_set().
546     */
547    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
548
549    /**
550     * Provide information on the @b fallback application's data
551     * directory, on scenarios where they get overriden by
552     * elm_app_info_set().
553     *
554     * @param dir The path to the default data directory (compile time
555     * one)
556     *
557     * @note Elementary will as well use this path to determine actual
558     * names of data directory paths, maybe changing it to be @c
559     * something/local/share instead of @c something/share, only, for
560     * example.
561     *
562     * @warning You should call this function @b before
563     * elm_app_info_set().
564     */
565    EAPI void         elm_app_compile_data_dir_set(const char *dir);
566
567    /**
568     * Provide information on the @b fallback application's locale
569     * directory, on scenarios where they get overriden by
570     * elm_app_info_set().
571     *
572     * @param dir The path to the default locale directory (compile time
573     * one)
574     *
575     * @warning You should call this function @b before
576     * elm_app_info_set().
577     */
578    EAPI void         elm_app_compile_locale_set(const char *dir);
579
580    /**
581     * Retrieve the application's run time prefix directory, as set by
582     * elm_app_info_set() and the way (environment) the application was
583     * run from.
584     *
585     * @return The directory prefix the application is actually using
586     */
587    EAPI const char  *elm_app_prefix_dir_get(void);
588
589    /**
590     * Retrieve the application's run time binaries prefix directory, as
591     * set by elm_app_info_set() and the way (environment) the application
592     * was run from.
593     *
594     * @return The binaries directory prefix the application is actually
595     * using
596     */
597    EAPI const char  *elm_app_bin_dir_get(void);
598
599    /**
600     * Retrieve the application's run time libraries prefix directory, as
601     * set by elm_app_info_set() and the way (environment) the application
602     * was run from.
603     *
604     * @return The libraries directory prefix the application is actually
605     * using
606     */
607    EAPI const char  *elm_app_lib_dir_get(void);
608
609    /**
610     * Retrieve the application's run time data prefix directory, as
611     * set by elm_app_info_set() and the way (environment) the application
612     * was run from.
613     *
614     * @return The data directory prefix the application is actually
615     * using
616     */
617    EAPI const char  *elm_app_data_dir_get(void);
618
619    /**
620     * Retrieve the application's run time locale prefix directory, as
621     * set by elm_app_info_set() and the way (environment) the application
622     * was run from.
623     *
624     * @return The locale directory prefix the application is actually
625     * using
626     */
627    EAPI const char  *elm_app_locale_dir_get(void);
628
629    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
630    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
631    EAPI int          elm_quicklaunch_init(int argc, char **argv);
632    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
633    EAPI int          elm_quicklaunch_sub_shutdown(void);
634    EAPI int          elm_quicklaunch_shutdown(void);
635    EAPI void         elm_quicklaunch_seed(void);
636    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
637    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
638    EAPI void         elm_quicklaunch_cleanup(void);
639    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
640    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
641
642    EAPI Eina_Bool    elm_need_efreet(void);
643    EAPI Eina_Bool    elm_need_e_dbus(void);
644    EAPI Eina_Bool    elm_need_ethumb(void);
645
646    /**
647     * Set a new policy's value (for a given policy group/identifier).
648     *
649     * @param policy policy identifier, as in @ref Elm_Policy.
650     * @param value policy value, which depends on the identifier
651     *
652     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
653     *
654     * Elementary policies define applications' behavior,
655     * somehow. These behaviors are divided in policy groups (see
656     * #Elm_Policy enumeration). This call will emit the Ecore event
657     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
658     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
659     * then.
660     *
661     * @note Currently, we have only one policy identifier/group
662     * (#ELM_POLICY_QUIT), which has two possible values.
663     *
664     * @ingroup General
665     */
666    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
667
668    /**
669     * Gets the policy value set for given policy identifier.
670     *
671     * @param policy policy identifier, as in #Elm_Policy.
672     * @return The currently set policy value, for that
673     * identifier. Will be @c 0 if @p policy passed is invalid.
674     *
675     * @ingroup General
676     */
677    EAPI int          elm_policy_get(unsigned int policy);
678
679    /**
680     * Set a label of an object
681     *
682     * @param obj The Elementary object
683     * @param item The label id to set (NULL for the default label)
684     * @param label The new text of the label
685     *
686     * @note Elementary objects may have many labels (e.g. Action Slider)
687     *
688     * @ingroup General
689     */
690    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *item, const char *label);
691
692 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
693
694    /**
695     * Get a label of an object
696     *
697     * @param obj The Elementary object
698     * @param item The label id to get (NULL for the default label)
699     * @return text of the label or
700     *         NULL for any error
701     *
702     * @note Elementary objects may have many labels (e.g. Action Slider)
703     *
704     * @ingroup General
705     */
706    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *item);
707
708 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
709
710    /**
711     * @}
712     */
713
714    EAPI void         elm_all_flush(void);
715    EAPI int          elm_cache_flush_interval_get(void);
716    EAPI void         elm_cache_flush_interval_set(int size);
717    EAPI void         elm_cache_flush_interval_all_set(int size);
718    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
719    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
720    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
721    EAPI int          elm_font_cache_get(void);
722    EAPI void         elm_font_cache_set(int size);
723    EAPI void         elm_font_cache_all_set(int size);
724    EAPI int          elm_image_cache_get(void);
725    EAPI void         elm_image_cache_set(int size);
726    EAPI void         elm_image_cache_all_set(int size);
727    EAPI int          elm_edje_file_cache_get(void);
728    EAPI void         elm_edje_file_cache_set(int size);
729    EAPI void         elm_edje_file_cache_all_set(int size);
730    EAPI int          elm_edje_collection_cache_get(void);
731    EAPI void         elm_edje_collection_cache_set(int size);
732    EAPI void         elm_edje_collection_cache_all_set(int size);
733
734    /**
735     * @defgroup Scaling Selective Widget Scaling
736     *
737     * Different widgets can be scaled independently. These functions
738     * allow you to manipulate this scaling on a per-widget basis. The
739     * object and all its children get their scaling factors multiplied
740     * by the scale factor set. This is multiplicative, in that if a
741     * child also has a scale size set it is in turn multiplied by its
742     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
743     * double size, @c 0.5 is half, etc.
744     *
745     * @ref general_functions_example_page "This" example contemplates
746     * some of these functions.
747     */
748
749    /**
750     * Set the scaling factor for a given Elementary object
751     *
752     * @param obj The Elementary to operate on
753     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
754     * no scaling)
755     *
756     * @ingroup Scaling
757     */
758    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
759
760    /**
761     * Get the scaling factor for a given Elementary object
762     *
763     * @param obj The object
764     * @return The scaling factor set by elm_object_scale_set()
765     *
766     * @ingroup Scaling
767     */
768    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
769    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
770    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
771    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
772    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
773    /**
774     * Set the style to use by a widget
775     *
776     * Sets the style name that will define the appearance of a widget. Styles
777     * vary from widget to widget and may also be defined by other themes
778     * by means of extensions and overlays.
779     *
780     * @param obj The Elementary widget to style
781     * @param style The style name to use
782     *
783     * @see elm_theme_extension_add()
784     * @see elm_theme_overlay_add()
785     *
786     * @ingroup Theme
787     */
788    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
789    /**
790     * Get the style used by the widget
791     *
792     * This gets the style being used for that widget. Note that the string
793     * pointer is only valid as longas the object is valid and the style doesn't
794     * change.
795     *
796     * @param obj The Elementary widget to query for its style
797     * @return The style name used
798     *
799     * @see elm_object_style_set()
800     *
801     * @ingroup Theme
802     */
803    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
804
805    /**
806     * @defgroup Styles Styles
807     *
808     * Widgets can have different styles of look. These generic API's
809     * set styles of widgets, if they support them (and if the theme(s)
810     * do).
811     *
812     * @ref general_functions_example_page "This" example contemplates
813     * some of these functions.
814     */
815
816    /**
817     * Set the disabled state of an Elementary object.
818     *
819     * @param obj The Elementary object to operate on
820     * @param disabled The state to put in in: @c EINA_TRUE for
821     *        disabled, @c EINA_FALSE for enabled
822     *
823     * Elementary objects can be @b disabled, in which state they won't
824     * receive input and, in general, will be themed differently from
825     * their normal state, usually greyed out. Useful for contexts
826     * where you don't want your users to interact with some of the
827     * parts of you interface.
828     *
829     * This sets the state for the widget, either disabling it or
830     * enabling it back.
831     *
832     * @ingroup Styles
833     */
834    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
835
836    /**
837     * Get the disabled state of an Elementary object.
838     *
839     * @param obj The Elementary object to operate on
840     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
841     *            if it's enabled (or on errors)
842     *
843     * This gets the state of the widget, which might be enabled or disabled.
844     *
845     * @ingroup Styles
846     */
847    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
848
849    /**
850     * @defgroup WidgetNavigation Widget Tree Navigation.
851     *
852     * How to check if an Evas Object is an Elementary widget? How to
853     * get the first elementary widget that is parent of the given
854     * object?  These are all covered in widget tree navigation.
855     *
856     * @ref general_functions_example_page "This" example contemplates
857     * some of these functions.
858     */
859
860    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
861
862    /**
863     * Get the first parent of the given object that is an Elementary
864     * widget.
865     *
866     * @param obj the Elementary object to query parent from.
867     * @return the parent object that is an Elementary widget, or @c
868     *         NULL, if it was not found.
869     *
870     * Use this to query for an object's parent widget.
871     *
872     * @note Most of Elementary users wouldn't be mixing non-Elementary
873     * smart objects in the objects tree of an application, as this is
874     * an advanced usage of Elementary with Evas. So, except for the
875     * application's window, which is the root of that tree, all other
876     * objects would have valid Elementary widget parents.
877     *
878     * @ingroup WidgetNavigation
879     */
880    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
881    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
882    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
883
884    EAPI double       elm_scale_get(void);
885    EAPI void         elm_scale_set(double scale);
886    EAPI void         elm_scale_all_set(double scale);
887
888    EAPI Eina_Bool    elm_mirrored_get(void);
889    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
890
891    EAPI Eina_Bool    elm_config_save(void);
892    EAPI void         elm_config_reload(void);
893
894    EAPI const char  *elm_profile_current_get(void);
895    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
896    EAPI void         elm_profile_dir_free(const char *p_dir);
897    EAPI Eina_List   *elm_profile_list_get(void);
898    EAPI void         elm_profile_list_free(Eina_List *l);
899    EAPI void         elm_profile_set(const char *profile);
900    EAPI void         elm_profile_all_set(const char *profile);
901
902    EAPI const char  *elm_engine_current_get(void);
903    EAPI void         elm_engine_set(const char *engine);
904
905   typedef struct _Elm_Text_Class
906     {
907        const char *name;
908        const char *desc;
909     } Elm_Text_Class;
910
911   typedef struct _Elm_Font_Overlay
912     {
913        const char     *text_class;
914        const char     *font;
915        Evas_Font_Size  size;
916     } Elm_Font_Overlay;
917
918   typedef struct _Elm_Font_Properties
919     {
920        const char *name;
921        Eina_List  *styles;
922     } Elm_Font_Properties;
923
924    EAPI const Eina_List     *elm_text_classes_list_get(void);
925    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
926
927    EAPI const Eina_List     *elm_font_overlay_list_get(void);
928    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
929    EAPI void                 elm_font_overlay_unset(const char *text_class);
930    EAPI void                 elm_font_overlay_apply(void);
931    EAPI void                 elm_font_overlay_all_apply(void);
932
933    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
934    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
935    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
936    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
937    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
938    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
939
940    /**
941     * @defgroup Fingers Fingers
942     *
943     * Elementary is designed to be finger-friendly for touchscreens,
944     * and so in addition to scaling for display resolution, it can
945     * also scale based on finger "resolution" (or size). You can then
946     * customize the granularity of the areas meant to receive clicks
947     * on touchscreens.
948     *
949     * Different profiles may have pre-set values for finger sizes.
950     *
951     * @ref general_functions_example_page "This" example contemplates
952     * some of these functions.
953     */
954
955    /**
956     * Get the configured "finger size"
957     *
958     * @return The finger size
959     *
960     * This gets the globally configured finger size, <b>in pixels</b>
961     *
962     * @ingroup Fingers
963     */
964    EAPI Evas_Coord       elm_finger_size_get(void);
965    EAPI void             elm_finger_size_set(Evas_Coord size);
966    EAPI void             elm_finger_size_all_set(Evas_Coord size);
967
968    /**
969     * @defgroup Focus Focus
970     *
971     * An Elementary application has, at all times, one (and only one)
972     * @b focused object. This is what determines where the input
973     * events go to within the application's window. Also, focused
974     * objects can be decorated differently, in order to signal to the
975     * user where the input is, at a given moment.
976     *
977     * Elementary applications also have the concept of <b>focus
978     * chain</b>: one can cycle through all the windows' focusable
979     * objects by input (tab key) or programmatically. The default
980     * focus chain for an application is the one define by the order in
981     * which the widgets where added in code. One will cycle through
982     * top level widgets, and, for each one containg sub-objects, cycle
983     * through them all, before returning to the level
984     * above. Elementary also allows one to set @b custom focus chains
985     * for their applications.
986     *
987     * Besides the focused decoration a widget may exhibit, when it
988     * gets focus, Elementary has a @b global focus highlight object
989     * that can be enabled for a window. If one chooses to do so, this
990     * extra highlight effect will surround the current focused object,
991     * too.
992     *
993     * @note Some Elementary widgets are @b unfocusable, after
994     * creation, by their very nature: they are not meant to be
995     * interacted with input events, but are there just for visual
996     * purposes.
997     *
998     * @ref general_functions_example_page "This" example contemplates
999     * some of these functions.
1000     */
1001
1002    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
1003    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
1004    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
1005    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
1006
1007    /**
1008     * Get the whether an Elementary object has the focus or not.
1009     *
1010     * @param obj The Elementary object to get the information from
1011     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1012     *            not (and on errors).
1013     *
1014     * @see elm_object_focus()
1015     *
1016     * @ingroup Focus
1017     */
1018    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1019
1020    /**
1021     * Make a given Elementary object the focused one.
1022     *
1023     * @param obj The Elementary object to make focused.
1024     *
1025     * @note This object, if it can handle focus, will take the focus
1026     * away from the one who had it previously and will, for now on, be
1027     * the one receiving input events.
1028     *
1029     * @see elm_object_focus_get()
1030     *
1031     * @ingroup Focus
1032     */
1033    EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1034
1035    /**
1036     * Remove the focus from an Elementary object
1037     *
1038     * @param obj The Elementary to take focus from
1039     *
1040     * This removes the focus from @p obj, passing it back to the
1041     * previous element in the focus chain list.
1042     *
1043     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1044     *
1045     * @ingroup Focus
1046     */
1047    EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1048
1049    /**
1050     * Set the ability for an Element object to be focused
1051     *
1052     * @param obj The Elementary object to operate on
1053     * @param enable @c EINA_TRUE if the object can be focused, @c
1054     *        EINA_FALSE if not (and on errors)
1055     *
1056     * This sets whether the object @p obj is able to take focus or
1057     * not. Unfocusable objects do nothing when programmatically
1058     * focused, being the nearest focusable parent object the one
1059     * really getting focus. Also, when they receive mouse input, they
1060     * will get the event, but not take away the focus from where it
1061     * was previously.
1062     *
1063     * @ingroup Focus
1064     */
1065    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1066
1067    /**
1068     * Get whether an Elementary object is focusable or not
1069     *
1070     * @param obj The Elementary object to operate on
1071     * @return @c EINA_TRUE if the object is allowed to be focused, @c
1072     *             EINA_FALSE if not (and on errors)
1073     *
1074     * @note Objects which are meant to be interacted with by input
1075     * events are created able to be focused, by default. All the
1076     * others are not.
1077     *
1078     * @ingroup Focus
1079     */
1080    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1081
1082    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1083    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1084    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1085    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1086    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1087    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1088    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1089
1090    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
1091    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1092    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1093    EAPI double           elm_scroll_bounce_friction_get(void);
1094    EAPI void             elm_scroll_bounce_friction_set(double friction);
1095    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
1096    EAPI double           elm_scroll_page_scroll_friction_get(void);
1097    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
1098    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
1099    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
1100    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
1101    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
1102    EAPI double           elm_scroll_zoom_friction_get(void);
1103    EAPI void             elm_scroll_zoom_friction_set(double friction);
1104    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
1105    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
1106    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1107    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1108    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
1109    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1110    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1111    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
1112    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1113    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1114    EAPI double           elm_scroll_thumbscroll_friction_get(void);
1115    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
1116    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
1117    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
1118    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
1119    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
1120
1121    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1122    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1123    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1124    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1125    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1126    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1127    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1128    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1129
1130    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1131    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);
1132    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);
1133
1134    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1135    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1136
1137    /**
1138     * Adjust size of an element for finger usage.
1139     *
1140     * @param times_w How many fingers should fit horizontally
1141     * @param w Pointer to the width size to adjust
1142     * @param times_h How many fingers should fit vertically
1143     * @param h Pointer to the height size to adjust
1144     *
1145     * This takes width and height sizes (in pixels) as input and a
1146     * size multiple (which is how many fingers you want to place
1147     * within the area, being "finger" the size set by
1148     * elm_finger_size_set()), and adjusts the size to be large enough
1149     * to accommodate the resulting size -- if it doesn't already
1150     * accommodate it. On return the @p w and @p h sizes pointed to by
1151     * these parameters will be modified, on those conditions.
1152     *
1153     * @note This is kind of a low level Elementary call, most useful
1154     * on size evaluation times for widgets. An external user wouldn't
1155     * be calling, most of the time.
1156     *
1157     * @ingroup Fingers
1158     */
1159    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1160
1161    EAPI double           elm_longpress_timeout_get(void);
1162    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
1163
1164    /* debug
1165     * don't use it unless you are sure
1166     */
1167    EAPI void             elm_object_tree_dump(const Evas_Object *top);
1168    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1169
1170
1171    /* theme */
1172    /**
1173     * @defgroup Theme Theme
1174     *
1175     * Elementary uses Edje to theme its widgets, naturally. But for the most
1176     * part this is hidden behind a simpler interface that lets the user set
1177     * extensions and choose the style of widgets in a much easier way.
1178     *
1179     * Instead of thinking in terms of paths to Edje files and their groups
1180     * each time you want to change the appearance of a widget, Elementary
1181     * works so you can add any theme file with extensions or replace the
1182     * main theme at one point in the application, and then just set the style
1183     * of widgets with elm_object_style_set() and related functions. Elementary
1184     * will then look in its list of themes for a matching group and apply it,
1185     * and when the theme changes midway through the application, all widgets
1186     * will be updated accordingly.
1187     *
1188     * There are three concepts you need to know to understand how Elementary
1189     * theming works: default theme, extensions and overlays.
1190     *
1191     * Default theme, obviously enough, is the one that provides the default
1192     * look of all widgets. End users can change the theme used by Elementary
1193     * by setting the @c ELM_THEME environment variable before running an
1194     * application, or globally for all programs using the @c elementary_config
1195     * utility. Applications can change the default theme using elm_theme_set(),
1196     * but this can go against the user wishes, so it's not an adviced practice.
1197     *
1198     * Ideally, applications should find everything they need in the already
1199     * provided theme, but there may be occasions when that's not enough and
1200     * custom styles are required to correctly express the idea. For this
1201     * cases, Elementary has extensions.
1202     *
1203     * Extensions allow the application developer to write styles of its own
1204     * to apply to some widgets. This requires knowledge of how each widget
1205     * is themed, as extensions will always replace the entire group used by
1206     * the widget, so important signals and parts need to be there for the
1207     * object to behave properly (see documentation of Edje for details).
1208     * Once the theme for the extension is done, the application needs to add
1209     * it to the list of themes Elementary will look into, using
1210     * elm_theme_extension_add(), and set the style of the desired widgets as
1211     * he would normally with elm_object_style_set().
1212     *
1213     * Overlays, on the other hand, can replace the look of all widgets by
1214     * overriding the default style. Like extensions, it's up to the application
1215     * developer to write the theme for the widgets it wants, the difference
1216     * being that when looking for the theme, Elementary will check first the
1217     * list of overlays, then the set theme and lastly the list of extensions,
1218     * so with overlays it's possible to replace the default view and every
1219     * widget will be affected. This is very much alike to setting the whole
1220     * theme for the application and will probably clash with the end user
1221     * options, not to mention the risk of ending up with not matching styles
1222     * across the program. Unless there's a very special reason to use them,
1223     * overlays should be avoided for the resons exposed before.
1224     *
1225     * All these theme lists are handled by ::Elm_Theme instances. Elementary
1226     * keeps one default internally and every function that receives one of
1227     * these can be called with NULL to refer to this default (except for
1228     * elm_theme_free()). It's possible to create a new instance of a
1229     * ::Elm_Theme to set other theme for a specific widget (and all of its
1230     * children), but this is as discouraged, if not even more so, than using
1231     * overlays. Don't use this unless you really know what you are doing.
1232     *
1233     * But to be less negative about things, you can look at the following
1234     * examples:
1235     * @li @ref theme_example_01 "Using extensions"
1236     * @li @ref theme_example_02 "Using overlays"
1237     *
1238     * @{
1239     */
1240    /**
1241     * @typedef Elm_Theme
1242     *
1243     * Opaque handler for the list of themes Elementary looks for when
1244     * rendering widgets.
1245     *
1246     * Stay out of this unless you really know what you are doing. For most
1247     * cases, sticking to the default is all a developer needs.
1248     */
1249    typedef struct _Elm_Theme Elm_Theme;
1250
1251    /**
1252     * Create a new specific theme
1253     *
1254     * This creates an empty specific theme that only uses the default theme. A
1255     * specific theme has its own private set of extensions and overlays too
1256     * (which are empty by default). Specific themes do not fall back to themes
1257     * of parent objects. They are not intended for this use. Use styles, overlays
1258     * and extensions when needed, but avoid specific themes unless there is no
1259     * other way (example: you want to have a preview of a new theme you are
1260     * selecting in a "theme selector" window. The preview is inside a scroller
1261     * and should display what the theme you selected will look like, but not
1262     * actually apply it yet. The child of the scroller will have a specific
1263     * theme set to show this preview before the user decides to apply it to all
1264     * applications).
1265     */
1266    EAPI Elm_Theme       *elm_theme_new(void);
1267    /**
1268     * Free a specific theme
1269     *
1270     * @param th The theme to free
1271     *
1272     * This frees a theme created with elm_theme_new().
1273     */
1274    EAPI void             elm_theme_free(Elm_Theme *th);
1275    /**
1276     * Copy the theme fom the source to the destination theme
1277     *
1278     * @param th The source theme to copy from
1279     * @param thdst The destination theme to copy data to
1280     *
1281     * This makes a one-time static copy of all the theme config, extensions
1282     * and overlays from @p th to @p thdst. If @p th references a theme, then
1283     * @p thdst is also set to reference it, with all the theme settings,
1284     * overlays and extensions that @p th had.
1285     */
1286    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1287    /**
1288     * Tell the source theme to reference the ref theme
1289     *
1290     * @param th The theme that will do the referencing
1291     * @param thref The theme that is the reference source
1292     *
1293     * This clears @p th to be empty and then sets it to refer to @p thref
1294     * so @p th acts as an override to @p thref, but where its overrides
1295     * don't apply, it will fall through to @pthref for configuration.
1296     */
1297    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1298    /**
1299     * Return the theme referred to
1300     *
1301     * @param th The theme to get the reference from
1302     * @return The referenced theme handle
1303     *
1304     * This gets the theme set as the reference theme by elm_theme_ref_set().
1305     * If no theme is set as a reference, NULL is returned.
1306     */
1307    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
1308    /**
1309     * Return the default theme
1310     *
1311     * @return The default theme handle
1312     *
1313     * This returns the internal default theme setup handle that all widgets
1314     * use implicitly unless a specific theme is set. This is also often use
1315     * as a shorthand of NULL.
1316     */
1317    EAPI Elm_Theme       *elm_theme_default_get(void);
1318    /**
1319     * Prepends a theme overlay to the list of overlays
1320     *
1321     * @param th The theme to add to, or if NULL, the default theme
1322     * @param item The Edje file path to be used
1323     *
1324     * Use this if your application needs to provide some custom overlay theme
1325     * (An Edje file that replaces some default styles of widgets) where adding
1326     * new styles, or changing system theme configuration is not possible. Do
1327     * NOT use this instead of a proper system theme configuration. Use proper
1328     * configuration files, profiles, environment variables etc. to set a theme
1329     * so that the theme can be altered by simple confiugration by a user. Using
1330     * this call to achieve that effect is abusing the API and will create lots
1331     * of trouble.
1332     *
1333     * @see elm_theme_extension_add()
1334     */
1335    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
1336    /**
1337     * Delete a theme overlay from the list of overlays
1338     *
1339     * @param th The theme to delete from, or if NULL, the default theme
1340     * @param item The name of the theme overlay
1341     *
1342     * @see elm_theme_overlay_add()
1343     */
1344    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
1345    /**
1346     * Appends a theme extension to the list of extensions.
1347     *
1348     * @param th The theme to add to, or if NULL, the default theme
1349     * @param item The Edje file path to be used
1350     *
1351     * This is intended when an application needs more styles of widgets or new
1352     * widget themes that the default does not provide (or may not provide). The
1353     * application has "extended" usage by coming up with new custom style names
1354     * for widgets for specific uses, but as these are not "standard", they are
1355     * not guaranteed to be provided by a default theme. This means the
1356     * application is required to provide these extra elements itself in specific
1357     * Edje files. This call adds one of those Edje files to the theme search
1358     * path to be search after the default theme. The use of this call is
1359     * encouraged when default styles do not meet the needs of the application.
1360     * Use this call instead of elm_theme_overlay_add() for almost all cases.
1361     *
1362     * @see elm_object_style_set()
1363     */
1364    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
1365    /**
1366     * Deletes a theme extension from the list of extensions.
1367     *
1368     * @param th The theme to delete from, or if NULL, the default theme
1369     * @param item The name of the theme extension
1370     *
1371     * @see elm_theme_extension_add()
1372     */
1373    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
1374    /**
1375     * Set the theme search order for the given theme
1376     *
1377     * @param th The theme to set the search order, or if NULL, the default theme
1378     * @param theme Theme search string
1379     *
1380     * This sets the search string for the theme in path-notation from first
1381     * theme to search, to last, delimited by the : character. Example:
1382     *
1383     * "shiny:/path/to/file.edj:default"
1384     *
1385     * See the ELM_THEME environment variable for more information.
1386     *
1387     * @see elm_theme_get()
1388     * @see elm_theme_list_get()
1389     */
1390    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
1391    /**
1392     * Return the theme search order
1393     *
1394     * @param th The theme to get the search order, or if NULL, the default theme
1395     * @return The internal search order path
1396     *
1397     * This function returns a colon separated string of theme elements as
1398     * returned by elm_theme_list_get().
1399     *
1400     * @see elm_theme_set()
1401     * @see elm_theme_list_get()
1402     */
1403    EAPI const char      *elm_theme_get(Elm_Theme *th);
1404    /**
1405     * Return a list of theme elements to be used in a theme.
1406     *
1407     * @param th Theme to get the list of theme elements from.
1408     * @return The internal list of theme elements
1409     *
1410     * This returns the internal list of theme elements (will only be valid as
1411     * long as the theme is not modified by elm_theme_set() or theme is not
1412     * freed by elm_theme_free(). This is a list of strings which must not be
1413     * altered as they are also internal. If @p th is NULL, then the default
1414     * theme element list is returned.
1415     *
1416     * A theme element can consist of a full or relative path to a .edj file,
1417     * or a name, without extension, for a theme to be searched in the known
1418     * theme paths for Elemementary.
1419     *
1420     * @see elm_theme_set()
1421     * @see elm_theme_get()
1422     */
1423    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1424    /**
1425     * Return the full patrh for a theme element
1426     *
1427     * @param f The theme element name
1428     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1429     * @return The full path to the file found.
1430     *
1431     * This returns a string you should free with free() on success, NULL on
1432     * failure. This will search for the given theme element, and if it is a
1433     * full or relative path element or a simple searchable name. The returned
1434     * path is the full path to the file, if searched, and the file exists, or it
1435     * is simply the full path given in the element or a resolved path if
1436     * relative to home. The @p in_search_path boolean pointed to is set to
1437     * EINA_TRUE if the file was a searchable file andis in the search path,
1438     * and EINA_FALSE otherwise.
1439     */
1440    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1441    /**
1442     * Flush the current theme.
1443     *
1444     * @param th Theme to flush
1445     *
1446     * This flushes caches that let elementary know where to find theme elements
1447     * in the given theme. If @p th is NULL, then the default theme is flushed.
1448     * Call this function if source theme data has changed in such a way as to
1449     * make any caches Elementary kept invalid.
1450     */
1451    EAPI void             elm_theme_flush(Elm_Theme *th);
1452    /**
1453     * This flushes all themes (default and specific ones).
1454     *
1455     * This will flush all themes in the current application context, by calling
1456     * elm_theme_flush() on each of them.
1457     */
1458    EAPI void             elm_theme_full_flush(void);
1459    /**
1460     * Set the theme for all elementary using applications on the current display
1461     *
1462     * @param theme The name of the theme to use. Format same as the ELM_THEME
1463     * environment variable.
1464     */
1465    EAPI void             elm_theme_all_set(const char *theme);
1466    /**
1467     * Return a list of theme elements in the theme search path
1468     *
1469     * @return A list of strings that are the theme element names.
1470     *
1471     * This lists all available theme files in the standard Elementary search path
1472     * for theme elements, and returns them in alphabetical order as theme
1473     * element names in a list of strings. Free this with
1474     * elm_theme_name_available_list_free() when you are done with the list.
1475     */
1476    EAPI Eina_List       *elm_theme_name_available_list_new(void);
1477    /**
1478     * Free the list returned by elm_theme_name_available_list_new()
1479     *
1480     * This frees the list of themes returned by
1481     * elm_theme_name_available_list_new(). Once freed the list should no longer
1482     * be used. a new list mys be created.
1483     */
1484    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
1485    /**
1486     * Set a specific theme to be used for this object and its children
1487     *
1488     * @param obj The object to set the theme on
1489     * @param th The theme to set
1490     *
1491     * This sets a specific theme that will be used for the given object and any
1492     * child objects it has. If @p th is NULL then the theme to be used is
1493     * cleared and the object will inherit its theme from its parent (which
1494     * ultimately will use the default theme if no specific themes are set).
1495     *
1496     * Use special themes with great care as this will annoy users and make
1497     * configuration difficult. Avoid any custom themes at all if it can be
1498     * helped.
1499     */
1500    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1501    /**
1502     * Get the specific theme to be used
1503     *
1504     * @param obj The object to get the specific theme from
1505     * @return The specifc theme set.
1506     *
1507     * This will return a specific theme set, or NULL if no specific theme is
1508     * set on that object. It will not return inherited themes from parents, only
1509     * the specific theme set for that specific object. See elm_object_theme_set()
1510     * for more information.
1511     */
1512    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1513    /**
1514     * @}
1515     */
1516
1517    /* win */
1518    typedef enum _Elm_Win_Type
1519      {
1520         ELM_WIN_BASIC,
1521         ELM_WIN_DIALOG_BASIC,
1522         ELM_WIN_DESKTOP,
1523         ELM_WIN_DOCK,
1524         ELM_WIN_TOOLBAR,
1525         ELM_WIN_MENU,
1526         ELM_WIN_UTILITY,
1527         ELM_WIN_SPLASH,
1528         ELM_WIN_DROPDOWN_MENU,
1529         ELM_WIN_POPUP_MENU,
1530         ELM_WIN_TOOLTIP,
1531         ELM_WIN_NOTIFICATION,
1532         ELM_WIN_COMBO,
1533         ELM_WIN_DND,
1534         ELM_WIN_INLINED_IMAGE,
1535      } Elm_Win_Type;
1536
1537    typedef enum _Elm_Win_Keyboard_Mode
1538      {
1539         ELM_WIN_KEYBOARD_UNKNOWN,
1540         ELM_WIN_KEYBOARD_OFF,
1541         ELM_WIN_KEYBOARD_ON,
1542         ELM_WIN_KEYBOARD_ALPHA,
1543         ELM_WIN_KEYBOARD_NUMERIC,
1544         ELM_WIN_KEYBOARD_PIN,
1545         ELM_WIN_KEYBOARD_PHONE_NUMBER,
1546         ELM_WIN_KEYBOARD_HEX,
1547         ELM_WIN_KEYBOARD_TERMINAL,
1548         ELM_WIN_KEYBOARD_PASSWORD,
1549         ELM_WIN_KEYBOARD_IP,
1550         ELM_WIN_KEYBOARD_HOST,
1551         ELM_WIN_KEYBOARD_FILE,
1552         ELM_WIN_KEYBOARD_URL,
1553         ELM_WIN_KEYBOARD_KEYPAD,
1554         ELM_WIN_KEYBOARD_J2ME
1555      } Elm_Win_Keyboard_Mode;
1556
1557    typedef enum _Elm_Illume_Command
1558      {
1559         ELM_ILLUME_COMMAND_FOCUS_BACK,
1560         ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1561         ELM_ILLUME_COMMAND_FOCUS_HOME,
1562         ELM_ILLUME_COMMAND_CLOSE
1563      } Elm_Illume_Command;
1564
1565    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1566    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1567    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1568    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1569    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1570    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1571    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1572    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1573    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1574    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1575    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1576    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1577    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1578    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1580    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1581    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1582    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1583    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1584    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1585    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1586    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1587    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1588    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1589    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1590    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1591    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1592    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1593    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1594    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1595    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1596    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1597    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1598    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1599    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1600    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1601    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1602    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1603    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1604    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1605    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1606    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1607    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1608    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1609    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1610    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1611    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1612    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1613    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1614    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1615    /*...
1616     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1617     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1618     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1619     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1620     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1621     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1622     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1623     *
1624     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1625     * (blank mouse, private mouse obj, defaultmouse)
1626     *
1627     */
1628    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1629    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1630    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1631    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1632
1633    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1634
1635    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1636    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1637    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1638    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1639    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1640    /* available styles:
1641     * default
1642     * minimal
1643     * minimal_vertical
1644     */
1645    /* X specific calls - won't work on non-x engines (return 0) */
1646    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1647    /* smart callbacks called:
1648     * "delete,request" - the user requested to delete the window
1649     * "focus,in" - window got focus
1650     * "focus,out" - window lost focus
1651     * "moved" - window that holds the canvas was moved
1652     */
1653
1654    /**
1655     * @defgroup Bg Bg
1656     *
1657     * @image html img/icon/bg/preview-00.png
1658     * @image latex img/icon/bg/preview-00.png
1659     *
1660     * @brief Background object, used for setting a solid color, image or Edje
1661     * group as background to a window or any container object.
1662     *
1663     * The bg object is used for setting a solid background to a window or
1664     * packing into any container object. It works just like an image, but has
1665     * some properties useful to a background, like setting it to tiled,
1666     * centered, scaled or stretched.
1667     *
1668     * Here is some sample code using it:
1669     * @li @ref bg_01_example_page
1670     * @li @ref bg_02_example_page
1671     * @li @ref bg_03_example_page
1672     */
1673
1674    /* bg */
1675    typedef enum _Elm_Bg_Option
1676      {
1677         ELM_BG_OPTION_CENTER,  /**< center the background */
1678         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
1679         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1680         ELM_BG_OPTION_TILE     /**< tile background at its original size */
1681      } Elm_Bg_Option;
1682
1683    /**
1684     * Add a new background to the parent
1685     *
1686     * @param parent The parent object
1687     * @return The new object or NULL if it cannot be created
1688     *
1689     * @ingroup Bg
1690     */
1691    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1692
1693    /**
1694     * Set the file (image or edje) used for the background
1695     *
1696     * @param obj The bg object
1697     * @param file The file path
1698     * @param group Optional key (group in Edje) within the file
1699     *
1700     * This sets the image file used in the background object. The image (or edje)
1701     * will be stretched (retaining aspect if its an image file) to completely fill
1702     * the bg object. This may mean some parts are not visible.
1703     *
1704     * @note  Once the image of @p obj is set, a previously set one will be deleted,
1705     * even if @p file is NULL.
1706     *
1707     * @ingroup Bg
1708     */
1709    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1710
1711    /**
1712     * Get the file (image or edje) used for the background
1713     *
1714     * @param obj The bg object
1715     * @param file The file path
1716     * @param group Optional key (group in Edje) within the file
1717     *
1718     * @ingroup Bg
1719     */
1720    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1721
1722    /**
1723     * Set the option used for the background image
1724     *
1725     * @param obj The bg object
1726     * @param option The desired background option (TILE, SCALE)
1727     *
1728     * This sets the option used for manipulating the display of the background
1729     * image. The image can be tiled or scaled.
1730     *
1731     * @ingroup Bg
1732     */
1733    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1734
1735    /**
1736     * Get the option used for the background image
1737     *
1738     * @param obj The bg object
1739     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1740     *
1741     * @ingroup Bg
1742     */
1743    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1744    /**
1745     * Set the option used for the background color
1746     *
1747     * @param obj The bg object
1748     * @param r
1749     * @param g
1750     * @param b
1751     *
1752     * This sets the color used for the background rectangle. Its range goes
1753     * from 0 to 255.
1754     *
1755     * @ingroup Bg
1756     */
1757    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1758    /**
1759     * Get the option used for the background color
1760     *
1761     * @param obj The bg object
1762     * @param r
1763     * @param g
1764     * @param b
1765     *
1766     * @ingroup Bg
1767     */
1768    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1769
1770    /**
1771     * Set the overlay object used for the background object.
1772     *
1773     * @param obj The bg object
1774     * @param overlay The overlay object
1775     *
1776     * This provides a way for elm_bg to have an 'overlay' that will be on top
1777     * of the bg. Once the over object is set, a previously set one will be
1778     * deleted, even if you set the new one to NULL. If you want to keep that
1779     * old content object, use the elm_bg_overlay_unset() function.
1780     *
1781     * @ingroup Bg
1782     */
1783
1784    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1785
1786    /**
1787     * Get the overlay object used for the background object.
1788     *
1789     * @param obj The bg object
1790     * @return The content that is being used
1791     *
1792     * Return the content object which is set for this widget
1793     *
1794     * @ingroup Bg
1795     */
1796    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1797
1798    /**
1799     * Get the overlay object used for the background object.
1800     *
1801     * @param obj The bg object
1802     * @return The content that was being used
1803     *
1804     * Unparent and return the overlay object which was set for this widget
1805     *
1806     * @ingroup Bg
1807     */
1808    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1809
1810    /**
1811     * Set the size of the pixmap representation of the image.
1812     *
1813     * This option just makes sense if an image is going to be set in the bg.
1814     *
1815     * @param obj The bg object
1816     * @param w The new width of the image pixmap representation.
1817     * @param h The new height of the image pixmap representation.
1818     *
1819     * This function sets a new size for pixmap representation of the given bg
1820     * image. It allows the image to be loaded already in the specified size,
1821     * reducing the memory usage and load time when loading a big image with load
1822     * size set to a smaller size.
1823     *
1824     * NOTE: this is just a hint, the real size of the pixmap may differ
1825     * depending on the type of image being loaded, being bigger than requested.
1826     *
1827     * @ingroup Bg
1828     */
1829    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1830    /* smart callbacks called:
1831     */
1832
1833    /**
1834     * @defgroup Icon Icon
1835     *
1836     * @image html img/icon/button/preview-00.png
1837     * @image latex img/icon/button/preview-00.png
1838     *
1839     * An object that provides standard icon images (delete, edit, arrows, etc.)
1840     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
1841     *
1842     * The icon image requested can be in the elementary theme, or in the
1843     * freedesktop.org paths. It's possible to set the order of preference from
1844     * where the image will be used.
1845     *
1846     * This API is very similar to @ref Image, but with ready to use images.
1847     *
1848     * Default images provided by the theme are described below.
1849     *
1850     * The first list contains icons that were first intended to be used in
1851     * toolbars, but can be used in many other places too:
1852     * @li home
1853     * @li close
1854     * @li apps
1855     * @li arrow_up
1856     * @li arrow_down
1857     * @li arrow_left
1858     * @li arrow_right
1859     * @li chat
1860     * @li clock
1861     * @li delete
1862     * @li edit
1863     * @li refresh
1864     * @li folder
1865     * @li file
1866     *
1867     * Now some icons that were designed to be used in menus (but again, you can
1868     * use them anywhere else):
1869     * @li menu/home
1870     * @li menu/close
1871     * @li menu/apps
1872     * @li menu/arrow_up
1873     * @li menu/arrow_down
1874     * @li menu/arrow_left
1875     * @li menu/arrow_right
1876     * @li menu/chat
1877     * @li menu/clock
1878     * @li menu/delete
1879     * @li menu/edit
1880     * @li menu/refresh
1881     * @li menu/folder
1882     * @li menu/file
1883     *
1884     * And here we have some media player specific icons:
1885     * @li media_player/forward
1886     * @li media_player/info
1887     * @li media_player/next
1888     * @li media_player/pause
1889     * @li media_player/play
1890     * @li media_player/prev
1891     * @li media_player/rewind
1892     * @li media_player/stop
1893     *
1894     * Signals that you can add callbacks for are:
1895     *
1896     * "clicked" - This is called when a user has clicked the icon
1897     *
1898     * An example of usage for this API follows:
1899     * @li @ref tutorial_icon
1900     */
1901
1902    /**
1903     * @addtogroup Icon
1904     * @{
1905     */
1906
1907    typedef enum _Elm_Icon_Type
1908      {
1909         ELM_ICON_NONE,
1910         ELM_ICON_FILE,
1911         ELM_ICON_STANDARD
1912      } Elm_Icon_Type;
1913    /**
1914     * @enum _Elm_Icon_Lookup_Order
1915     * @typedef Elm_Icon_Lookup_Order
1916     *
1917     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
1918     * theme, FDO paths, or both?
1919     *
1920     * @ingroup Icon
1921     */
1922    typedef enum _Elm_Icon_Lookup_Order
1923      {
1924         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
1925         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
1926         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
1927         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
1928      } Elm_Icon_Lookup_Order;
1929
1930    /**
1931     * Add a new icon object to the parent.
1932     *
1933     * @param parent The parent object
1934     * @return The new object or NULL if it cannot be created
1935     *
1936     * @see elm_icon_file_set()
1937     *
1938     * @ingroup Icon
1939     */
1940    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1941    /**
1942     * Set the file that will be used as icon.
1943     *
1944     * @param obj The icon object
1945     * @param file The path to file that will be used as icon image
1946     * @param group The group that the icon belongs to in edje file
1947     *
1948     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1949     *
1950     * @note The icon image set by this function can be changed by
1951     * elm_icon_standard_set().
1952     *
1953     * @see elm_icon_file_get()
1954     *
1955     * @ingroup Icon
1956     */
1957    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1958    /**
1959     * Set a location in memory to be used as an icon
1960     *
1961     * @param obj The icon object
1962     * @param img The binary data that will be used as an image
1963     * @param size The size of binary data @p img
1964     * @param format Optional format of @p img to pass to the image loader
1965     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
1966     *
1967     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1968     *
1969     * @note The icon image set by this function can be changed by
1970     * elm_icon_standard_set().
1971     *
1972     * @ingroup Icon
1973     */
1974    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);
1975    /**
1976     * Get the file that will be used as icon.
1977     *
1978     * @param obj The icon object
1979     * @param file The path to file that will be used as icon icon image
1980     * @param group The group that the icon belongs to in edje file
1981     *
1982     * @see elm_icon_file_set()
1983     *
1984     * @ingroup Icon
1985     */
1986    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1987    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1988    /**
1989     * Set the icon by icon standards names.
1990     *
1991     * @param obj The icon object
1992     * @param name The icon name
1993     *
1994     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1995     *
1996     * For example, freedesktop.org defines standard icon names such as "home",
1997     * "network", etc. There can be different icon sets to match those icon
1998     * keys. The @p name given as parameter is one of these "keys", and will be
1999     * used to look in the freedesktop.org paths and elementary theme. One can
2000     * change the lookup order with elm_icon_order_lookup_set().
2001     *
2002     * If name is not found in any of the expected locations and it is the
2003     * absolute path of an image file, this image will be used.
2004     *
2005     * @note The icon image set by this function can be changed by
2006     * elm_icon_file_set().
2007     *
2008     * @see elm_icon_standard_get()
2009     * @see elm_icon_file_set()
2010     *
2011     * @ingroup Icon
2012     */
2013    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2014    /**
2015     * Get the icon name set by icon standard names.
2016     *
2017     * @param obj The icon object
2018     * @return The icon name
2019     *
2020     * If the icon image was set using elm_icon_file_set() instead of
2021     * elm_icon_standard_set(), then this function will return @c NULL.
2022     *
2023     * @see elm_icon_standard_set()
2024     *
2025     * @ingroup Icon
2026     */
2027    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2028    /**
2029     * Set the smooth effect for an icon object.
2030     *
2031     * @param obj The icon object
2032     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2033     * otherwise. Default is @c EINA_TRUE.
2034     *
2035     * Set the scaling algorithm to be used when scaling the icon image. Smooth
2036     * scaling provides a better resulting image, but is slower.
2037     *
2038     * The smooth scaling should be disabled when making animations that change
2039     * the icon size, since they will be faster. Animations that don't require
2040     * resizing of the icon can keep the smooth scaling enabled (even if the icon
2041     * is already scaled, since the scaled icon image will be cached).
2042     *
2043     * @see elm_icon_smooth_get()
2044     *
2045     * @ingroup Icon
2046     */
2047    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2048    /**
2049     * Get the smooth effect for an icon object.
2050     *
2051     * @param obj The icon object
2052     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2053     *
2054     * @see elm_icon_smooth_set()
2055     *
2056     * @ingroup Icon
2057     */
2058    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2059    /**
2060     * Disable scaling of this object.
2061     *
2062     * @param obj The icon object.
2063     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2064     * otherwise. Default is @c EINA_FALSE.
2065     *
2066     * This function disables scaling of the icon object through the function
2067     * elm_object_scale_set(). However, this does not affect the object
2068     * size/resize in any way. For that effect, take a look at
2069     * elm_icon_scale_set().
2070     *
2071     * @see elm_icon_no_scale_get()
2072     * @see elm_icon_scale_set()
2073     * @see elm_object_scale_set()
2074     *
2075     * @ingroup Icon
2076     */
2077    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2078    /**
2079     * Get whether scaling is disabled on the object.
2080     *
2081     * @param obj The icon object
2082     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2083     *
2084     * @see elm_icon_no_scale_set()
2085     *
2086     * @ingroup Icon
2087     */
2088    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2089    /**
2090     * Set if the object is (up/down) resizeable.
2091     *
2092     * @param obj The icon object
2093     * @param scale_up A bool to set if the object is resizeable up. Default is
2094     * @c EINA_TRUE.
2095     * @param scale_down A bool to set if the object is resizeable down. Default
2096     * is @c EINA_TRUE.
2097     *
2098     * This function limits the icon object resize ability. If @p scale_up is set to
2099     * @c EINA_FALSE, the object can't have its height or width resized to a value
2100     * higher than the original icon size. Same is valid for @p scale_down.
2101     *
2102     * @see elm_icon_scale_get()
2103     *
2104     * @ingroup Icon
2105     */
2106    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2107    /**
2108     * Get if the object is (up/down) resizeable.
2109     *
2110     * @param obj The icon object
2111     * @param scale_up A bool to set if the object is resizeable up
2112     * @param scale_down A bool to set if the object is resizeable down
2113     *
2114     * @see elm_icon_scale_set()
2115     *
2116     * @ingroup Icon
2117     */
2118    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2119    /**
2120     * Set if the icon fill the entire object area.
2121     *
2122     * @param obj The icon object
2123     * @param fill_outside @c EINA_TRUE if the object is filled outside,
2124     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2125     *
2126     * When the icon object is resized to a different aspect ratio from the
2127     * original icon image, the icon image will still keep its aspect. This flag
2128     * tells how the image should fill the object's area. They are: keep the
2129     * entire icon inside the limits of height and width of the object (@p
2130     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
2131     * of the object, and the icon will fill the entire object (@p fill_outside
2132     * is @c EINA_TRUE).
2133     *
2134     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
2135     * retain property to false. Thus, the icon image will always keep its
2136     * original aspect ratio.
2137     *
2138     * @see elm_icon_fill_outside_get()
2139     * @see elm_image_fill_outside_set()
2140     *
2141     * @ingroup Icon
2142     */
2143    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2144    /**
2145     * Get if the object is filled outside.
2146     *
2147     * @param obj The icon object
2148     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2149     *
2150     * @see elm_icon_fill_outside_set()
2151     *
2152     * @ingroup Icon
2153     */
2154    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2155    /**
2156     * Set the prescale size for the icon.
2157     *
2158     * @param obj The icon object
2159     * @param size The prescale size. This value is used for both width and
2160     * height.
2161     *
2162     * This function sets a new size for pixmap representation of the given
2163     * icon. It allows the icon to be loaded already in the specified size,
2164     * reducing the memory usage and load time when loading a big icon with load
2165     * size set to a smaller size.
2166     *
2167     * It's equivalent to the elm_bg_load_size_set() function for bg.
2168     *
2169     * @note this is just a hint, the real size of the pixmap may differ
2170     * depending on the type of icon being loaded, being bigger than requested.
2171     *
2172     * @see elm_icon_prescale_get()
2173     * @see elm_bg_load_size_set()
2174     *
2175     * @ingroup Icon
2176     */
2177    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2178    /**
2179     * Get the prescale size for the icon.
2180     *
2181     * @param obj The icon object
2182     * @return The prescale size
2183     *
2184     * @see elm_icon_prescale_set()
2185     *
2186     * @ingroup Icon
2187     */
2188    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2189    /**
2190     * Sets the icon lookup order used by elm_icon_standard_set().
2191     *
2192     * @param obj The icon object
2193     * @param order The icon lookup order (can be one of
2194     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
2195     * or ELM_ICON_LOOKUP_THEME)
2196     *
2197     * @see elm_icon_order_lookup_get()
2198     * @see Elm_Icon_Lookup_Order
2199     *
2200     * @ingroup Icon
2201     */
2202    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2203    /**
2204     * Gets the icon lookup order.
2205     *
2206     * @param obj The icon object
2207     * @return The icon lookup order
2208     *
2209     * @see elm_icon_order_lookup_set()
2210     * @see Elm_Icon_Lookup_Order
2211     *
2212     * @ingroup Icon
2213     */
2214    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2215
2216    /**
2217     * @}
2218     */
2219
2220    /**
2221     * @defgroup Image Image
2222     *
2223     * @image html img/image/button/preview-00.png
2224     * @image latex img/image/button/preview-00.png
2225     *
2226     * An object that allows one to load an image file to it. It can be used
2227     * anywhere like any other elementary widget.
2228     *
2229     * This widget provides most of the functionality provided from @ref Bg or @ref
2230     * Icon, but with a slightly different API (use the one that fits better your
2231     * needs).
2232     *
2233     * The features not provided by those two other image widgets are:
2234     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
2235     * @li change the object orientation with elm_image_orient_set();
2236     * @li and turning the image editable with elm_image_editable_set().
2237     *
2238     * Signals that you can add callbacks for are:
2239     *
2240     * @li @c "clicked" - This is called when a user has clicked the image
2241     *
2242     * An example of usage for this API follows:
2243     * @li @ref tutorial_image
2244     */
2245
2246    /**
2247     * @addtogroup Image
2248     * @{
2249     */
2250
2251    /**
2252     * @enum _Elm_Image_Orient
2253     * @typedef Elm_Image_Orient
2254     *
2255     * Possible orientation options for elm_image_orient_set().
2256     *
2257     * @image html elm_image_orient_set.png
2258     * @image latex elm_image_orient_set.eps width=\textwidth
2259     *
2260     * @ingroup Image
2261     */
2262    typedef enum _Elm_Image_Orient
2263      {
2264         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
2265         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
2266         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
2267         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
2268         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
2269         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
2270         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
2271         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
2272      } Elm_Image_Orient;
2273
2274    /**
2275     * Add a new image to the parent.
2276     *
2277     * @param parent The parent object
2278     * @return The new object or NULL if it cannot be created
2279     *
2280     * @see elm_image_file_set()
2281     *
2282     * @ingroup Image
2283     */
2284    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2285    /**
2286     * Set the file that will be used as image.
2287     *
2288     * @param obj The image object
2289     * @param file The path to file that will be used as image
2290     * @param group The group that the image belongs in edje file (if it's an
2291     * edje image)
2292     *
2293     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2294     *
2295     * @see elm_image_file_get()
2296     *
2297     * @ingroup Image
2298     */
2299    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2300    /**
2301     * Get the file that will be used as image.
2302     *
2303     * @param obj The image object
2304     * @param file The path to file
2305     * @param group The group that the image belongs in edje file
2306     *
2307     * @see elm_image_file_set()
2308     *
2309     * @ingroup Image
2310     */
2311    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2312    /**
2313     * Set the smooth effect for an image.
2314     *
2315     * @param obj The image object
2316     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2317     * otherwise. Default is @c EINA_TRUE.
2318     *
2319     * Set the scaling algorithm to be used when scaling the image. Smooth
2320     * scaling provides a better resulting image, but is slower.
2321     *
2322     * The smooth scaling should be disabled when making animations that change
2323     * the image size, since it will be faster. Animations that don't require
2324     * resizing of the image can keep the smooth scaling enabled (even if the
2325     * image is already scaled, since the scaled image will be cached).
2326     *
2327     * @see elm_image_smooth_get()
2328     *
2329     * @ingroup Image
2330     */
2331    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2332    /**
2333     * Get the smooth effect for an image.
2334     *
2335     * @param obj The image object
2336     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2337     *
2338     * @see elm_image_smooth_get()
2339     *
2340     * @ingroup Image
2341     */
2342    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2343    /**
2344     * Gets the current size of the image.
2345     *
2346     * @param obj The image object.
2347     * @param w Pointer to store width, or NULL.
2348     * @param h Pointer to store height, or NULL.
2349     *
2350     * This is the real size of the image, not the size of the object.
2351     *
2352     * On error, neither w or h will be written.
2353     *
2354     * @ingroup Image
2355     */
2356    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2357    /**
2358     * Disable scaling of this object.
2359     *
2360     * @param obj The image object.
2361     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2362     * otherwise. Default is @c EINA_FALSE.
2363     *
2364     * This function disables scaling of the elm_image widget through the
2365     * function elm_object_scale_set(). However, this does not affect the widget
2366     * size/resize in any way. For that effect, take a look at
2367     * elm_image_scale_set().
2368     *
2369     * @see elm_image_no_scale_get()
2370     * @see elm_image_scale_set()
2371     * @see elm_object_scale_set()
2372     *
2373     * @ingroup Image
2374     */
2375    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2376    /**
2377     * Get whether scaling is disabled on the object.
2378     *
2379     * @param obj The image object
2380     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2381     *
2382     * @see elm_image_no_scale_set()
2383     *
2384     * @ingroup Image
2385     */
2386    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2387    /**
2388     * Set if the object is (up/down) resizeable.
2389     *
2390     * @param obj The image object
2391     * @param scale_up A bool to set if the object is resizeable up. Default is
2392     * @c EINA_TRUE.
2393     * @param scale_down A bool to set if the object is resizeable down. Default
2394     * is @c EINA_TRUE.
2395     *
2396     * This function limits the image resize ability. If @p scale_up is set to
2397     * @c EINA_FALSE, the object can't have its height or width resized to a value
2398     * higher than the original image size. Same is valid for @p scale_down.
2399     *
2400     * @see elm_image_scale_get()
2401     *
2402     * @ingroup Image
2403     */
2404    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2405    /**
2406     * Get if the object is (up/down) resizeable.
2407     *
2408     * @param obj The image object
2409     * @param scale_up A bool to set if the object is resizeable up
2410     * @param scale_down A bool to set if the object is resizeable down
2411     *
2412     * @see elm_image_scale_set()
2413     *
2414     * @ingroup Image
2415     */
2416    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2417    /**
2418     * Set if the image fill the entire object area when keeping the aspect ratio.
2419     *
2420     * @param obj The image object
2421     * @param fill_outside @c EINA_TRUE if the object is filled outside,
2422     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2423     *
2424     * When the image should keep its aspect ratio even if resized to another
2425     * aspect ratio, there are two possibilities to resize it: keep the entire
2426     * image inside the limits of height and width of the object (@p fill_outside
2427     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
2428     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
2429     *
2430     * @note This option will have no effect if
2431     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
2432     *
2433     * @see elm_image_fill_outside_get()
2434     * @see elm_image_aspect_ratio_retained_set()
2435     *
2436     * @ingroup Image
2437     */
2438    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2439    /**
2440     * Get if the object is filled outside
2441     *
2442     * @param obj The image object
2443     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2444     *
2445     * @see elm_image_fill_outside_set()
2446     *
2447     * @ingroup Image
2448     */
2449    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2450    /**
2451     * Set the prescale size for the image
2452     *
2453     * @param obj The image object
2454     * @param size The prescale size. This value is used for both width and
2455     * height.
2456     *
2457     * This function sets a new size for pixmap representation of the given
2458     * image. It allows the image to be loaded already in the specified size,
2459     * reducing the memory usage and load time when loading a big image with load
2460     * size set to a smaller size.
2461     *
2462     * It's equivalent to the elm_bg_load_size_set() function for bg.
2463     *
2464     * @note this is just a hint, the real size of the pixmap may differ
2465     * depending on the type of image being loaded, being bigger than requested.
2466     *
2467     * @see elm_image_prescale_get()
2468     * @see elm_bg_load_size_set()
2469     *
2470     * @ingroup Image
2471     */
2472    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2473    /**
2474     * Get the prescale size for the image
2475     *
2476     * @param obj The image object
2477     * @return The prescale size
2478     *
2479     * @see elm_image_prescale_set()
2480     *
2481     * @ingroup Image
2482     */
2483    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2484    /**
2485     * Set the image orientation.
2486     *
2487     * @param obj The image object
2488     * @param orient The image orientation
2489     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2490     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2491     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2492     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
2493     *  Default is #ELM_IMAGE_ORIENT_NONE.
2494     *
2495     * This function allows to rotate or flip the given image.
2496     *
2497     * @see elm_image_orient_get()
2498     * @see @ref Elm_Image_Orient
2499     *
2500     * @ingroup Image
2501     */
2502    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2503    /**
2504     * Get the image orientation.
2505     *
2506     * @param obj The image object
2507     * @return The image orientation
2508     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2509     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2510     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2511     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
2512     *
2513     * @see elm_image_orient_set()
2514     * @see @ref Elm_Image_Orient
2515     *
2516     * @ingroup Image
2517     */
2518    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2519    /**
2520     * Make the image 'editable'.
2521     *
2522     * @param obj Image object.
2523     * @param set Turn on or off editability. Default is @c EINA_FALSE.
2524     *
2525     * This means the image is a valid drag target for drag and drop, and can be
2526     * cut or pasted too.
2527     *
2528     * @ingroup Image
2529     */
2530    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2531    /**
2532     * Make the image 'editable'.
2533     *
2534     * @param obj Image object.
2535     * @return Editability.
2536     *
2537     * This means the image is a valid drag target for drag and drop, and can be
2538     * cut or pasted too.
2539     *
2540     * @ingroup Image
2541     */
2542    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2543    /**
2544     * Get the basic Evas_Image object from this object (widget).
2545     *
2546     * @param obj The image object to get the inlined image from
2547     * @return The inlined image object, or NULL if none exists
2548     *
2549     * This function allows one to get the underlying @c Evas_Object of type
2550     * Image from this elementary widget. It can be useful to do things like get
2551     * the pixel data, save the image to a file, etc.
2552     *
2553     * @note Be careful to not manipulate it, as it is under control of
2554     * elementary.
2555     *
2556     * @ingroup Image
2557     */
2558    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2559    /**
2560     * Set whether the original aspect ratio of the image should be kept on resize.
2561     *
2562     * @param obj The image object.
2563     * @param retained @c EINA_TRUE if the image should retain the aspect,
2564     * @c EINA_FALSE otherwise.
2565     *
2566     * The original aspect ratio (width / height) of the image is usually
2567     * distorted to match the object's size. Enabling this option will retain
2568     * this original aspect, and the way that the image is fit into the object's
2569     * area depends on the option set by elm_image_fill_outside_set().
2570     *
2571     * @see elm_image_aspect_ratio_retained_get()
2572     * @see elm_image_fill_outside_set()
2573     *
2574     * @ingroup Image
2575     */
2576    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2577    /**
2578     * Get if the object retains the original aspect ratio.
2579     *
2580     * @param obj The image object.
2581     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
2582     * otherwise.
2583     *
2584     * @ingroup Image
2585     */
2586    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2587
2588    /* smart callbacks called:
2589     * "clicked" - the user clicked the image
2590     */
2591
2592    /**
2593     * @}
2594     */
2595
2596    /* glview */
2597    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
2598
2599    typedef enum _Elm_GLView_Mode
2600      {
2601         ELM_GLVIEW_ALPHA   = 1,
2602         ELM_GLVIEW_DEPTH   = 2,
2603         ELM_GLVIEW_STENCIL = 4
2604      } Elm_GLView_Mode;
2605
2606    /**
2607     * Defines a policy for the glview resizing.
2608     *
2609     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2610     */
2611    typedef enum _Elm_GLView_Resize_Policy
2612      {
2613         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
2614         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
2615      } Elm_GLView_Resize_Policy;
2616
2617    typedef enum _Elm_GLView_Render_Policy
2618      {
2619         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
2620         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
2621      } Elm_GLView_Render_Policy;
2622
2623
2624    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2625    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2626    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2627    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2628    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2629    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2630    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2631    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2632    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2633    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2634    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2635    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2636
2637    /* box */
2638    /**
2639     * @defgroup Box Box
2640     *
2641     * A box arranges objects in a linear fashion, governed by a layout function
2642     * that defines the details of this arrangement.
2643     *
2644     * By default, the box will use an internal function to set the layout to
2645     * a single row, either vertical or horizontal. This layout is affected
2646     * by a number of parameters, such as the homogeneous flag set by
2647     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2648     * elm_box_align_set() and the hints set to each object in the box.
2649     *
2650     * For this default layout, it's possible to change the orientation with
2651     * elm_box_horizontal_set(). The box will start in the vertical orientation,
2652     * placing its elements ordered from top to bottom. When horizontal is set,
2653     * the order will go from left to right. If the box is set to be
2654     * homogeneous, every object in it will be assigned the same space, that
2655     * of the largest object. Padding can be used to set some spacing between
2656     * the cell given to each object. The alignment of the box, set with
2657     * elm_box_align_set(), determines how the bounding box of all the elements
2658     * will be placed within the space given to the box widget itself.
2659     *
2660     * The size hints of each object also affect how they are placed and sized
2661     * within the box. evas_object_size_hint_min_set() will give the minimum
2662     * size the object can have, and the box will use it as the basis for all
2663     * latter calculations. Elementary widgets set their own minimum size as
2664     * needed, so there's rarely any need to use it manually.
2665     *
2666     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2667     * used to tell whether the object will be allocated the minimum size it
2668     * needs or if the space given to it should be expanded. It's important
2669     * to realize that expanding the size given to the object is not the same
2670     * thing as resizing the object. It could very well end being a small
2671     * widget floating in a much larger empty space. If not set, the weight
2672     * for objects will normally be 0.0 for both axis, meaning the widget will
2673     * not be expanded. To take as much space possible, set the weight to
2674     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2675     *
2676     * Besides how much space each object is allocated, it's possible to control
2677     * how the widget will be placed within that space using
2678     * evas_object_size_hint_align_set(). By default, this value will be 0.5
2679     * for both axis, meaning the object will be centered, but any value from
2680     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2681     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2682     * is -1.0, means the object will be resized to fill the entire space it
2683     * was allocated.
2684     *
2685     * In addition, customized functions to define the layout can be set, which
2686     * allow the application developer to organize the objects within the box
2687     * in any number of ways.
2688     *
2689     * The special elm_box_layout_transition() function can be used
2690     * to switch from one layout to another, animating the motion of the
2691     * children of the box.
2692     *
2693     * @note Objects should not be added to box objects using _add() calls.
2694     *
2695     * Some examples on how to use boxes follow:
2696     * @li @ref box_example_01
2697     * @li @ref box_example_02
2698     *
2699     * @{
2700     */
2701    /**
2702     * @typedef Elm_Box_Transition
2703     *
2704     * Opaque handler containing the parameters to perform an animated
2705     * transition of the layout the box uses.
2706     *
2707     * @see elm_box_transition_new()
2708     * @see elm_box_layout_set()
2709     * @see elm_box_layout_transition()
2710     */
2711    typedef struct _Elm_Box_Transition Elm_Box_Transition;
2712
2713    /**
2714     * Add a new box to the parent
2715     *
2716     * By default, the box will be in vertical mode and non-homogeneous.
2717     *
2718     * @param parent The parent object
2719     * @return The new object or NULL if it cannot be created
2720     */
2721    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2722    /**
2723     * Set the horizontal orientation
2724     *
2725     * By default, box object arranges their contents vertically from top to
2726     * bottom.
2727     * By calling this function with @p horizontal as EINA_TRUE, the box will
2728     * become horizontal, arranging contents from left to right.
2729     *
2730     * @note This flag is ignored if a custom layout function is set.
2731     *
2732     * @param obj The box object
2733     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2734     * EINA_FALSE = vertical)
2735     */
2736    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2737    /**
2738     * Get the horizontal orientation
2739     *
2740     * @param obj The box object
2741     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
2742     */
2743    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2744    /**
2745     * Set the box to arrange its children homogeneously
2746     *
2747     * If enabled, homogeneous layout makes all items the same size, according
2748     * to the size of the largest of its children.
2749     *
2750     * @note This flag is ignored if a custom layout function is set.
2751     *
2752     * @param obj The box object
2753     * @param homogeneous The homogeneous flag
2754     */
2755    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2756    /**
2757     * Get whether the box is using homogeneous mode or not
2758     *
2759     * @param obj The box object
2760     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2761     */
2762    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2763    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2764    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2765    /**
2766     * Add an object to the beginning of the pack list
2767     *
2768     * Pack @p subobj into the box @p obj, placing it first in the list of
2769     * children objects. The actual position the object will get on screen
2770     * depends on the layout used. If no custom layout is set, it will be at
2771     * the top or left, depending if the box is vertical or horizontal,
2772     * respectively.
2773     *
2774     * @param obj The box object
2775     * @param subobj The object to add to the box
2776     *
2777     * @see elm_box_pack_end()
2778     * @see elm_box_pack_before()
2779     * @see elm_box_pack_after()
2780     * @see elm_box_unpack()
2781     * @see elm_box_unpack_all()
2782     * @see elm_box_clear()
2783     */
2784    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2785    /**
2786     * Add an object at the end of the pack list
2787     *
2788     * Pack @p subobj into the box @p obj, placing it last in the list of
2789     * children objects. The actual position the object will get on screen
2790     * depends on the layout used. If no custom layout is set, it will be at
2791     * the bottom or right, depending if the box is vertical or horizontal,
2792     * respectively.
2793     *
2794     * @param obj The box object
2795     * @param subobj The object to add to the box
2796     *
2797     * @see elm_box_pack_start()
2798     * @see elm_box_pack_before()
2799     * @see elm_box_pack_after()
2800     * @see elm_box_unpack()
2801     * @see elm_box_unpack_all()
2802     * @see elm_box_clear()
2803     */
2804    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2805    /**
2806     * Adds an object to the box before the indicated object
2807     *
2808     * This will add the @p subobj to the box indicated before the object
2809     * indicated with @p before. If @p before is not already in the box, results
2810     * are undefined. Before means either to the left of the indicated object or
2811     * above it depending on orientation.
2812     *
2813     * @param obj The box object
2814     * @param subobj The object to add to the box
2815     * @param before The object before which to add it
2816     *
2817     * @see elm_box_pack_start()
2818     * @see elm_box_pack_end()
2819     * @see elm_box_pack_after()
2820     * @see elm_box_unpack()
2821     * @see elm_box_unpack_all()
2822     * @see elm_box_clear()
2823     */
2824    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2825    /**
2826     * Adds an object to the box after the indicated object
2827     *
2828     * This will add the @p subobj to the box indicated after the object
2829     * indicated with @p after. If @p after is not already in the box, results
2830     * are undefined. After means either to the right of the indicated object or
2831     * below it depending on orientation.
2832     *
2833     * @param obj The box object
2834     * @param subobj The object to add to the box
2835     * @param after The object after which to add it
2836     *
2837     * @see elm_box_pack_start()
2838     * @see elm_box_pack_end()
2839     * @see elm_box_pack_before()
2840     * @see elm_box_unpack()
2841     * @see elm_box_unpack_all()
2842     * @see elm_box_clear()
2843     */
2844    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2845    /**
2846     * Clear the box of all children
2847     *
2848     * Remove all the elements contained by the box, deleting the respective
2849     * objects.
2850     *
2851     * @param obj The box object
2852     *
2853     * @see elm_box_unpack()
2854     * @see elm_box_unpack_all()
2855     */
2856    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2857    /**
2858     * Unpack a box item
2859     *
2860     * Remove the object given by @p subobj from the box @p obj without
2861     * deleting it.
2862     *
2863     * @param obj The box object
2864     *
2865     * @see elm_box_unpack_all()
2866     * @see elm_box_clear()
2867     */
2868    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2869    /**
2870     * Remove all items from the box, without deleting them
2871     *
2872     * Clear the box from all children, but don't delete the respective objects.
2873     * If no other references of the box children exist, the objects will never
2874     * be deleted, and thus the application will leak the memory. Make sure
2875     * when using this function that you hold a reference to all the objects
2876     * in the box @p obj.
2877     *
2878     * @param obj The box object
2879     *
2880     * @see elm_box_clear()
2881     * @see elm_box_unpack()
2882     */
2883    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2884    /**
2885     * Retrieve a list of the objects packed into the box
2886     *
2887     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2888     * The order of the list corresponds to the packing order the box uses.
2889     *
2890     * You must free this list with eina_list_free() once you are done with it.
2891     *
2892     * @param obj The box object
2893     */
2894    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2895    /**
2896     * Set the space (padding) between the box's elements.
2897     *
2898     * Extra space in pixels that will be added between a box child and its
2899     * neighbors after its containing cell has been calculated. This padding
2900     * is set for all elements in the box, besides any possible padding that
2901     * individual elements may have through their size hints.
2902     *
2903     * @param obj The box object
2904     * @param horizontal The horizontal space between elements
2905     * @param vertical The vertical space between elements
2906     */
2907    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2908    /**
2909     * Get the space (padding) between the box's elements.
2910     *
2911     * @param obj The box object
2912     * @param horizontal The horizontal space between elements
2913     * @param vertical The vertical space between elements
2914     *
2915     * @see elm_box_padding_set()
2916     */
2917    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2918    /**
2919     * Set the alignment of the whole bouding box of contents.
2920     *
2921     * Sets how the bounding box containing all the elements of the box, after
2922     * their sizes and position has been calculated, will be aligned within
2923     * the space given for the whole box widget.
2924     *
2925     * @param obj The box object
2926     * @param horizontal The horizontal alignment of elements
2927     * @param vertical The vertical alignment of elements
2928     */
2929    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2930    /**
2931     * Get the alignment of the whole bouding box of contents.
2932     *
2933     * @param obj The box object
2934     * @param horizontal The horizontal alignment of elements
2935     * @param vertical The vertical alignment of elements
2936     *
2937     * @see elm_box_align_set()
2938     */
2939    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2940
2941    /**
2942     * Set the layout defining function to be used by the box
2943     *
2944     * Whenever anything changes that requires the box in @p obj to recalculate
2945     * the size and position of its elements, the function @p cb will be called
2946     * to determine what the layout of the children will be.
2947     *
2948     * Once a custom function is set, everything about the children layout
2949     * is defined by it. The flags set by elm_box_horizontal_set() and
2950     * elm_box_homogeneous_set() no longer have any meaning, and the values
2951     * given by elm_box_padding_set() and elm_box_align_set() are up to this
2952     * layout function to decide if they are used and how. These last two
2953     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2954     * passed to @p cb. The @c Evas_Object the function receives is not the
2955     * Elementary widget, but the internal Evas Box it uses, so none of the
2956     * functions described here can be used on it.
2957     *
2958     * Any of the layout functions in @c Evas can be used here, as well as the
2959     * special elm_box_layout_transition().
2960     *
2961     * The final @p data argument received by @p cb is the same @p data passed
2962     * here, and the @p free_data function will be called to free it
2963     * whenever the box is destroyed or another layout function is set.
2964     *
2965     * Setting @p cb to NULL will revert back to the default layout function.
2966     *
2967     * @param obj The box object
2968     * @param cb The callback function used for layout
2969     * @param data Data that will be passed to layout function
2970     * @param free_data Function called to free @p data
2971     *
2972     * @see elm_box_layout_transition()
2973     */
2974    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);
2975    /**
2976     * Special layout function that animates the transition from one layout to another
2977     *
2978     * Normally, when switching the layout function for a box, this will be
2979     * reflected immediately on screen on the next render, but it's also
2980     * possible to do this through an animated transition.
2981     *
2982     * This is done by creating an ::Elm_Box_Transition and setting the box
2983     * layout to this function.
2984     *
2985     * For example:
2986     * @code
2987     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2988     *                            evas_object_box_layout_vertical, // start
2989     *                            NULL, // data for initial layout
2990     *                            NULL, // free function for initial data
2991     *                            evas_object_box_layout_horizontal, // end
2992     *                            NULL, // data for final layout
2993     *                            NULL, // free function for final data
2994     *                            anim_end, // will be called when animation ends
2995     *                            NULL); // data for anim_end function\
2996     * elm_box_layout_set(box, elm_box_layout_transition, t,
2997     *                    elm_box_transition_free);
2998     * @endcode
2999     *
3000     * @note This function can only be used with elm_box_layout_set(). Calling
3001     * it directly will not have the expected results.
3002     *
3003     * @see elm_box_transition_new
3004     * @see elm_box_transition_free
3005     * @see elm_box_layout_set
3006     */
3007    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3008    /**
3009     * Create a new ::Elm_Box_Transition to animate the switch of layouts
3010     *
3011     * If you want to animate the change from one layout to another, you need
3012     * to set the layout function of the box to elm_box_layout_transition(),
3013     * passing as user data to it an instance of ::Elm_Box_Transition with the
3014     * necessary information to perform this animation. The free function to
3015     * set for the layout is elm_box_transition_free().
3016     *
3017     * The parameters to create an ::Elm_Box_Transition sum up to how long
3018     * will it be, in seconds, a layout function to describe the initial point,
3019     * another for the final position of the children and one function to be
3020     * called when the whole animation ends. This last function is useful to
3021     * set the definitive layout for the box, usually the same as the end
3022     * layout for the animation, but could be used to start another transition.
3023     *
3024     * @param start_layout The layout function that will be used to start the animation
3025     * @param start_layout_data The data to be passed the @p start_layout function
3026     * @param start_layout_free_data Function to free @p start_layout_data
3027     * @param end_layout The layout function that will be used to end the animation
3028     * @param end_layout_free_data The data to be passed the @p end_layout function
3029     * @param end_layout_free_data Function to free @p end_layout_data
3030     * @param transition_end_cb Callback function called when animation ends
3031     * @param transition_end_data Data to be passed to @p transition_end_cb
3032     * @return An instance of ::Elm_Box_Transition
3033     *
3034     * @see elm_box_transition_new
3035     * @see elm_box_layout_transition
3036     */
3037    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);
3038    /**
3039     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3040     *
3041     * This function is mostly useful as the @c free_data parameter in
3042     * elm_box_layout_set() when elm_box_layout_transition().
3043     *
3044     * @param data The Elm_Box_Transition instance to be freed.
3045     *
3046     * @see elm_box_transition_new
3047     * @see elm_box_layout_transition
3048     */
3049    EAPI void                elm_box_transition_free(void *data);
3050    /**
3051     * @}
3052     */
3053
3054    /* button */
3055    /**
3056     * @defgroup Button Button
3057     *
3058     * @image html img/widget/button/preview-00.png
3059     * @image html img/widget/button/preview-01.png
3060     * @image html img/widget/button/preview-02.png
3061     *
3062     * This is a push-button. Press it and run some function. It can contain
3063     * a simple label and icon object and it also has an autorepeat feature.
3064     *
3065     * This widgets emits the following signals:
3066     * @li "clicked": the user clicked the button (press/release).
3067     * @li "repeated": the user pressed the button without releasing it.
3068     * @li "pressed": button was pressed.
3069     * @li "unpressed": button was released after being pressed.
3070     * In all three cases, the @c event parameter of the callback will be
3071     * @c NULL.
3072     *
3073     * Also, defined in the default theme, the button has the following styles
3074     * available:
3075     * @li default: a normal button.
3076     * @li anchor: Like default, but the button fades away when the mouse is not
3077     * over it, leaving only the text or icon.
3078     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
3079     * continuous look across its options.
3080     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
3081     *
3082     * Follow through a complete example @ref button_example_01 "here".
3083     * @{
3084     */
3085    /**
3086     * Add a new button to the parent's canvas
3087     *
3088     * @param parent The parent object
3089     * @return The new object or NULL if it cannot be created
3090     */
3091    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3092    /**
3093     * Set the label used in the button
3094     *
3095     * The passed @p label can be NULL to clean any existing text in it and
3096     * leave the button as an icon only object.
3097     *
3098     * @param obj The button object
3099     * @param label The text will be written on the button
3100     * @deprecated use elm_object_text_set() instead.
3101     */
3102    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3103    /**
3104     * Get the label set for the button
3105     *
3106     * The string returned is an internal pointer and should not be freed or
3107     * altered. It will also become invalid when the button is destroyed.
3108     * The string returned, if not NULL, is a stringshare, so if you need to
3109     * keep it around even after the button is destroyed, you can use
3110     * eina_stringshare_ref().
3111     *
3112     * @param obj The button object
3113     * @return The text set to the label, or NULL if nothing is set
3114     * @deprecated use elm_object_text_set() instead.
3115     */
3116    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3117    /**
3118     * Set the icon used for the button
3119     *
3120     * Setting a new icon will delete any other that was previously set, making
3121     * any reference to them invalid. If you need to maintain the previous
3122     * object alive, unset it first with elm_button_icon_unset().
3123     *
3124     * @param obj The button object
3125     * @param icon The icon object for the button
3126     */
3127    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3128    /**
3129     * Get the icon used for the button
3130     *
3131     * Return the icon object which is set for this widget. If the button is
3132     * destroyed or another icon is set, the returned object will be deleted
3133     * and any reference to it will be invalid.
3134     *
3135     * @param obj The button object
3136     * @return The icon object that is being used
3137     *
3138     * @see elm_button_icon_unset()
3139     */
3140    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3141    /**
3142     * Remove the icon set without deleting it and return the object
3143     *
3144     * This function drops the reference the button holds of the icon object
3145     * and returns this last object. It is used in case you want to remove any
3146     * icon, or set another one, without deleting the actual object. The button
3147     * will be left without an icon set.
3148     *
3149     * @param obj The button object
3150     * @return The icon object that was being used
3151     */
3152    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3153    /**
3154     * Turn on/off the autorepeat event generated when the button is kept pressed
3155     *
3156     * When off, no autorepeat is performed and buttons emit a normal @c clicked
3157     * signal when they are clicked.
3158     *
3159     * When on, keeping a button pressed will continuously emit a @c repeated
3160     * signal until the button is released. The time it takes until it starts
3161     * emitting the signal is given by
3162     * elm_button_autorepeat_initial_timeout_set(), and the time between each
3163     * new emission by elm_button_autorepeat_gap_timeout_set().
3164     *
3165     * @param obj The button object
3166     * @param on  A bool to turn on/off the event
3167     */
3168    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
3169    /**
3170     * Get whether the autorepeat feature is enabled
3171     *
3172     * @param obj The button object
3173     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
3174     *
3175     * @see elm_button_autorepeat_set()
3176     */
3177    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3178    /**
3179     * Set the initial timeout before the autorepeat event is generated
3180     *
3181     * Sets the timeout, in seconds, since the button is pressed until the
3182     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
3183     * won't be any delay and the even will be fired the moment the button is
3184     * pressed.
3185     *
3186     * @param obj The button object
3187     * @param t   Timeout in seconds
3188     *
3189     * @see elm_button_autorepeat_set()
3190     * @see elm_button_autorepeat_gap_timeout_set()
3191     */
3192    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3193    /**
3194     * Get the initial timeout before the autorepeat event is generated
3195     *
3196     * @param obj The button object
3197     * @return Timeout in seconds
3198     *
3199     * @see elm_button_autorepeat_initial_timeout_set()
3200     */
3201    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3202    /**
3203     * Set the interval between each generated autorepeat event
3204     *
3205     * After the first @c repeated event is fired, all subsequent ones will
3206     * follow after a delay of @p t seconds for each.
3207     *
3208     * @param obj The button object
3209     * @param t   Interval in seconds
3210     *
3211     * @see elm_button_autorepeat_initial_timeout_set()
3212     */
3213    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3214    /**
3215     * Get the interval between each generated autorepeat event
3216     *
3217     * @param obj The button object
3218     * @return Interval in seconds
3219     */
3220    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3221    /**
3222     * @}
3223     */
3224
3225    /**
3226     * @defgroup File_Selector_Button File Selector Button
3227     *
3228     * @image html img/widget/fileselector_button/preview-00.png
3229     * @image html img/widget/fileselector_button/preview-01.png
3230     * @image html img/widget/fileselector_button/preview-02.png
3231     *
3232     * This is a button that, when clicked, creates an Elementary
3233     * window (or inner window) <b> with a @ref Fileselector "file
3234     * selector widget" within</b>. When a file is chosen, the (inner)
3235     * window is closed and the button emits a signal having the
3236     * selected file as it's @c event_info.
3237     *
3238     * This widget encapsulates operations on its internal file
3239     * selector on its own API. There is less control over its file
3240     * selector than that one would have instatiating one directly.
3241     *
3242     * The following styles are available for this button:
3243     * @li @c "default"
3244     * @li @c "anchor"
3245     * @li @c "hoversel_vertical"
3246     * @li @c "hoversel_vertical_entry"
3247     *
3248     * Smart callbacks one can register to:
3249     * - @c "file,chosen" - the user has selected a path, whose string
3250     *   pointer comes as the @c event_info data (a stringshared
3251     *   string)
3252     *
3253     * Here is an example on its usage:
3254     * @li @ref fileselector_button_example
3255     *
3256     * @see @ref File_Selector_Entry for a similar widget.
3257     * @{
3258     */
3259
3260    /**
3261     * Add a new file selector button widget to the given parent
3262     * Elementary (container) object
3263     *
3264     * @param parent The parent object
3265     * @return a new file selector button widget handle or @c NULL, on
3266     * errors
3267     */
3268    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3269
3270    /**
3271     * Set the label for a given file selector button widget
3272     *
3273     * @param obj The file selector button widget
3274     * @param label The text label to be displayed on @p obj
3275     *
3276     * @deprecated use elm_object_text_set() instead.
3277     */
3278    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3279
3280    /**
3281     * Get the label set for a given file selector button widget
3282     *
3283     * @param obj The file selector button widget
3284     * @return The button label
3285     *
3286     * @deprecated use elm_object_text_set() instead.
3287     */
3288    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3289
3290    /**
3291     * Set the icon on a given file selector button widget
3292     *
3293     * @param obj The file selector button widget
3294     * @param icon The icon object for the button
3295     *
3296     * Once the icon object is set, a previously set one will be
3297     * deleted. If you want to keep the latter, use the
3298     * elm_fileselector_button_icon_unset() function.
3299     *
3300     * @see elm_fileselector_button_icon_get()
3301     */
3302    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3303
3304    /**
3305     * Get the icon set for a given file selector button widget
3306     *
3307     * @param obj The file selector button widget
3308     * @return The icon object currently set on @p obj or @c NULL, if
3309     * none is
3310     *
3311     * @see elm_fileselector_button_icon_set()
3312     */
3313    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3314
3315    /**
3316     * Unset the icon used in a given file selector button widget
3317     *
3318     * @param obj The file selector button widget
3319     * @return The icon object that was being used on @p obj or @c
3320     * NULL, on errors
3321     *
3322     * Unparent and return the icon object which was set for this
3323     * widget.
3324     *
3325     * @see elm_fileselector_button_icon_set()
3326     */
3327    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3328
3329    /**
3330     * Set the title for a given file selector button widget's window
3331     *
3332     * @param obj The file selector button widget
3333     * @param title The title string
3334     *
3335     * This will change the window's title, when the file selector pops
3336     * out after a click on the button. Those windows have the default
3337     * (unlocalized) value of @c "Select a file" as titles.
3338     *
3339     * @note It will only take any effect if the file selector
3340     * button widget is @b not under "inwin mode".
3341     *
3342     * @see elm_fileselector_button_window_title_get()
3343     */
3344    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3345
3346    /**
3347     * Get the title set for a given file selector button widget's
3348     * window
3349     *
3350     * @param obj The file selector button widget
3351     * @return Title of the file selector button's window
3352     *
3353     * @see elm_fileselector_button_window_title_get() for more details
3354     */
3355    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3356
3357    /**
3358     * Set the size of a given file selector button widget's window,
3359     * holding the file selector itself.
3360     *
3361     * @param obj The file selector button widget
3362     * @param width The window's width
3363     * @param height The window's height
3364     *
3365     * @note it will only take any effect if the file selector button
3366     * widget is @b not under "inwin mode". The default size for the
3367     * window (when applicable) is 400x400 pixels.
3368     *
3369     * @see elm_fileselector_button_window_size_get()
3370     */
3371    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3372
3373    /**
3374     * Get the size of a given file selector button widget's window,
3375     * holding the file selector itself.
3376     *
3377     * @param obj The file selector button widget
3378     * @param width Pointer into which to store the width value
3379     * @param height Pointer into which to store the height value
3380     *
3381     * @note Use @c NULL pointers on the size values you're not
3382     * interested in: they'll be ignored by the function.
3383     *
3384     * @see elm_fileselector_button_window_size_set(), for more details
3385     */
3386    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3387
3388    /**
3389     * Set the initial file system path for a given file selector
3390     * button widget
3391     *
3392     * @param obj The file selector button widget
3393     * @param path The path string
3394     *
3395     * It must be a <b>directory</b> path, which will have the contents
3396     * displayed initially in the file selector's view, when invoked
3397     * from @p obj. The default initial path is the @c "HOME"
3398     * environment variable's value.
3399     *
3400     * @see elm_fileselector_button_path_get()
3401     */
3402    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3403
3404    /**
3405     * Get the initial file system path set for a given file selector
3406     * button widget
3407     *
3408     * @param obj The file selector button widget
3409     * @return path The path string
3410     *
3411     * @see elm_fileselector_button_path_set() for more details
3412     */
3413    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3414
3415    /**
3416     * Enable/disable a tree view in the given file selector button
3417     * widget's internal file selector
3418     *
3419     * @param obj The file selector button widget
3420     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3421     * disable
3422     *
3423     * This has the same effect as elm_fileselector_expandable_set(),
3424     * but now applied to a file selector button's internal file
3425     * selector.
3426     *
3427     * @note There's no way to put a file selector button's internal
3428     * file selector in "grid mode", as one may do with "pure" file
3429     * selectors.
3430     *
3431     * @see elm_fileselector_expandable_get()
3432     */
3433    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3434
3435    /**
3436     * Get whether tree view is enabled for the given file selector
3437     * button widget's internal file selector
3438     *
3439     * @param obj The file selector button widget
3440     * @return @c EINA_TRUE if @p obj widget's internal file selector
3441     * is in tree view, @c EINA_FALSE otherwise (and or errors)
3442     *
3443     * @see elm_fileselector_expandable_set() for more details
3444     */
3445    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3446
3447    /**
3448     * Set whether a given file selector button widget's internal file
3449     * selector is to display folders only or the directory contents,
3450     * as well.
3451     *
3452     * @param obj The file selector button widget
3453     * @param only @c EINA_TRUE to make @p obj widget's internal file
3454     * selector only display directories, @c EINA_FALSE to make files
3455     * to be displayed in it too
3456     *
3457     * This has the same effect as elm_fileselector_folder_only_set(),
3458     * but now applied to a file selector button's internal file
3459     * selector.
3460     *
3461     * @see elm_fileselector_folder_only_get()
3462     */
3463    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3464
3465    /**
3466     * Get whether a given file selector button widget's internal file
3467     * selector is displaying folders only or the directory contents,
3468     * as well.
3469     *
3470     * @param obj The file selector button widget
3471     * @return @c EINA_TRUE if @p obj widget's internal file
3472     * selector is only displaying directories, @c EINA_FALSE if files
3473     * are being displayed in it too (and on errors)
3474     *
3475     * @see elm_fileselector_button_folder_only_set() for more details
3476     */
3477    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3478
3479    /**
3480     * Enable/disable the file name entry box where the user can type
3481     * in a name for a file, in a given file selector button widget's
3482     * internal file selector.
3483     *
3484     * @param obj The file selector button widget
3485     * @param is_save @c EINA_TRUE to make @p obj widget's internal
3486     * file selector a "saving dialog", @c EINA_FALSE otherwise
3487     *
3488     * This has the same effect as elm_fileselector_is_save_set(),
3489     * but now applied to a file selector button's internal file
3490     * selector.
3491     *
3492     * @see elm_fileselector_is_save_get()
3493     */
3494    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3495
3496    /**
3497     * Get whether the given file selector button widget's internal
3498     * file selector is in "saving dialog" mode
3499     *
3500     * @param obj The file selector button widget
3501     * @return @c EINA_TRUE, if @p obj widget's internal file selector
3502     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
3503     * errors)
3504     *
3505     * @see elm_fileselector_button_is_save_set() for more details
3506     */
3507    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3508
3509    /**
3510     * Set whether a given file selector button widget's internal file
3511     * selector will raise an Elementary "inner window", instead of a
3512     * dedicated Elementary window. By default, it won't.
3513     *
3514     * @param obj The file selector button widget
3515     * @param value @c EINA_TRUE to make it use an inner window, @c
3516     * EINA_TRUE to make it use a dedicated window
3517     *
3518     * @see elm_win_inwin_add() for more information on inner windows
3519     * @see elm_fileselector_button_inwin_mode_get()
3520     */
3521    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3522
3523    /**
3524     * Get whether a given file selector button widget's internal file
3525     * selector will raise an Elementary "inner window", instead of a
3526     * dedicated Elementary window.
3527     *
3528     * @param obj The file selector button widget
3529     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
3530     * if it will use a dedicated window
3531     *
3532     * @see elm_fileselector_button_inwin_mode_set() for more details
3533     */
3534    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3535
3536    /**
3537     * @}
3538     */
3539
3540     /**
3541     * @defgroup File_Selector_Entry File Selector Entry
3542     *
3543     * @image html img/widget/fileselector_entry/preview-00.png
3544     * @image latex img/widget/fileselector_entry/preview-00.eps
3545     *
3546     * This is an entry made to be filled with or display a <b>file
3547     * system path string</b>. Besides the entry itself, the widget has
3548     * a @ref File_Selector_Button "file selector button" on its side,
3549     * which will raise an internal @ref Fileselector "file selector widget",
3550     * when clicked, for path selection aided by file system
3551     * navigation.
3552     *
3553     * This file selector may appear in an Elementary window or in an
3554     * inner window. When a file is chosen from it, the (inner) window
3555     * is closed and the selected file's path string is exposed both as
3556     * an smart event and as the new text on the entry.
3557     *
3558     * This widget encapsulates operations on its internal file
3559     * selector on its own API. There is less control over its file
3560     * selector than that one would have instatiating one directly.
3561     *
3562     * Smart callbacks one can register to:
3563     * - @c "changed" - The text within the entry was changed
3564     * - @c "activated" - The entry has had editing finished and
3565     *   changes are to be "committed"
3566     * - @c "press" - The entry has been clicked
3567     * - @c "longpressed" - The entry has been clicked (and held) for a
3568     *   couple seconds
3569     * - @c "clicked" - The entry has been clicked
3570     * - @c "clicked,double" - The entry has been double clicked
3571     * - @c "focused" - The entry has received focus
3572     * - @c "unfocused" - The entry has lost focus
3573     * - @c "selection,paste" - A paste action has occurred on the
3574     *   entry
3575     * - @c "selection,copy" - A copy action has occurred on the entry
3576     * - @c "selection,cut" - A cut action has occurred on the entry
3577     * - @c "unpressed" - The file selector entry's button was released
3578     *   after being pressed.
3579     * - @c "file,chosen" - The user has selected a path via the file
3580     *   selector entry's internal file selector, whose string pointer
3581     *   comes as the @c event_info data (a stringshared string)
3582     *
3583     * Here is an example on its usage:
3584     * @li @ref fileselector_entry_example
3585     *
3586     * @see @ref File_Selector_Button for a similar widget.
3587     * @{
3588     */
3589
3590    /**
3591     * Add a new file selector entry widget to the given parent
3592     * Elementary (container) object
3593     *
3594     * @param parent The parent object
3595     * @return a new file selector entry widget handle or @c NULL, on
3596     * errors
3597     */
3598    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3599
3600    /**
3601     * Set the label for a given file selector entry widget's button
3602     *
3603     * @param obj The file selector entry widget
3604     * @param label The text label to be displayed on @p obj widget's
3605     * button
3606     *
3607     * @deprecated use elm_object_text_set() instead.
3608     */
3609    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3610
3611    /**
3612     * Get the label set for a given file selector entry widget's button
3613     *
3614     * @param obj The file selector entry widget
3615     * @return The widget button's label
3616     *
3617     * @deprecated use elm_object_text_set() instead.
3618     */
3619    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3620
3621    /**
3622     * Set the icon on a given file selector entry widget's button
3623     *
3624     * @param obj The file selector entry widget
3625     * @param icon The icon object for the entry's button
3626     *
3627     * Once the icon object is set, a previously set one will be
3628     * deleted. If you want to keep the latter, use the
3629     * elm_fileselector_entry_button_icon_unset() function.
3630     *
3631     * @see elm_fileselector_entry_button_icon_get()
3632     */
3633    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3634
3635    /**
3636     * Get the icon set for a given file selector entry widget's button
3637     *
3638     * @param obj The file selector entry widget
3639     * @return The icon object currently set on @p obj widget's button
3640     * or @c NULL, if none is
3641     *
3642     * @see elm_fileselector_entry_button_icon_set()
3643     */
3644    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3645
3646    /**
3647     * Unset the icon used in a given file selector entry widget's
3648     * button
3649     *
3650     * @param obj The file selector entry widget
3651     * @return The icon object that was being used on @p obj widget's
3652     * button or @c NULL, on errors
3653     *
3654     * Unparent and return the icon object which was set for this
3655     * widget's button.
3656     *
3657     * @see elm_fileselector_entry_button_icon_set()
3658     */
3659    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3660
3661    /**
3662     * Set the title for a given file selector entry widget's window
3663     *
3664     * @param obj The file selector entry widget
3665     * @param title The title string
3666     *
3667     * This will change the window's title, when the file selector pops
3668     * out after a click on the entry's button. Those windows have the
3669     * default (unlocalized) value of @c "Select a file" as titles.
3670     *
3671     * @note It will only take any effect if the file selector
3672     * entry widget is @b not under "inwin mode".
3673     *
3674     * @see elm_fileselector_entry_window_title_get()
3675     */
3676    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3677
3678    /**
3679     * Get the title set for a given file selector entry widget's
3680     * window
3681     *
3682     * @param obj The file selector entry widget
3683     * @return Title of the file selector entry's window
3684     *
3685     * @see elm_fileselector_entry_window_title_get() for more details
3686     */
3687    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3688
3689    /**
3690     * Set the size of a given file selector entry widget's window,
3691     * holding the file selector itself.
3692     *
3693     * @param obj The file selector entry widget
3694     * @param width The window's width
3695     * @param height The window's height
3696     *
3697     * @note it will only take any effect if the file selector entry
3698     * widget is @b not under "inwin mode". The default size for the
3699     * window (when applicable) is 400x400 pixels.
3700     *
3701     * @see elm_fileselector_entry_window_size_get()
3702     */
3703    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3704
3705    /**
3706     * Get the size of a given file selector entry widget's window,
3707     * holding the file selector itself.
3708     *
3709     * @param obj The file selector entry widget
3710     * @param width Pointer into which to store the width value
3711     * @param height Pointer into which to store the height value
3712     *
3713     * @note Use @c NULL pointers on the size values you're not
3714     * interested in: they'll be ignored by the function.
3715     *
3716     * @see elm_fileselector_entry_window_size_set(), for more details
3717     */
3718    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3719
3720    /**
3721     * Set the initial file system path and the entry's path string for
3722     * a given file selector entry widget
3723     *
3724     * @param obj The file selector entry widget
3725     * @param path The path string
3726     *
3727     * It must be a <b>directory</b> path, which will have the contents
3728     * displayed initially in the file selector's view, when invoked
3729     * from @p obj. The default initial path is the @c "HOME"
3730     * environment variable's value.
3731     *
3732     * @see elm_fileselector_entry_path_get()
3733     */
3734    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3735
3736    /**
3737     * Get the entry's path string for a given file selector entry
3738     * widget
3739     *
3740     * @param obj The file selector entry widget
3741     * @return path The path string
3742     *
3743     * @see elm_fileselector_entry_path_set() for more details
3744     */
3745    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3746
3747    /**
3748     * Enable/disable a tree view in the given file selector entry
3749     * widget's internal file selector
3750     *
3751     * @param obj The file selector entry widget
3752     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3753     * disable
3754     *
3755     * This has the same effect as elm_fileselector_expandable_set(),
3756     * but now applied to a file selector entry's internal file
3757     * selector.
3758     *
3759     * @note There's no way to put a file selector entry's internal
3760     * file selector in "grid mode", as one may do with "pure" file
3761     * selectors.
3762     *
3763     * @see elm_fileselector_expandable_get()
3764     */
3765    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3766
3767    /**
3768     * Get whether tree view is enabled for the given file selector
3769     * entry widget's internal file selector
3770     *
3771     * @param obj The file selector entry widget
3772     * @return @c EINA_TRUE if @p obj widget's internal file selector
3773     * is in tree view, @c EINA_FALSE otherwise (and or errors)
3774     *
3775     * @see elm_fileselector_expandable_set() for more details
3776     */
3777    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3778
3779    /**
3780     * Set whether a given file selector entry widget's internal file
3781     * selector is to display folders only or the directory contents,
3782     * as well.
3783     *
3784     * @param obj The file selector entry widget
3785     * @param only @c EINA_TRUE to make @p obj widget's internal file
3786     * selector only display directories, @c EINA_FALSE to make files
3787     * to be displayed in it too
3788     *
3789     * This has the same effect as elm_fileselector_folder_only_set(),
3790     * but now applied to a file selector entry's internal file
3791     * selector.
3792     *
3793     * @see elm_fileselector_folder_only_get()
3794     */
3795    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3796
3797    /**
3798     * Get whether a given file selector entry widget's internal file
3799     * selector is displaying folders only or the directory contents,
3800     * as well.
3801     *
3802     * @param obj The file selector entry widget
3803     * @return @c EINA_TRUE if @p obj widget's internal file
3804     * selector is only displaying directories, @c EINA_FALSE if files
3805     * are being displayed in it too (and on errors)
3806     *
3807     * @see elm_fileselector_entry_folder_only_set() for more details
3808     */
3809    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3810
3811    /**
3812     * Enable/disable the file name entry box where the user can type
3813     * in a name for a file, in a given file selector entry widget's
3814     * internal file selector.
3815     *
3816     * @param obj The file selector entry widget
3817     * @param is_save @c EINA_TRUE to make @p obj widget's internal
3818     * file selector a "saving dialog", @c EINA_FALSE otherwise
3819     *
3820     * This has the same effect as elm_fileselector_is_save_set(),
3821     * but now applied to a file selector entry's internal file
3822     * selector.
3823     *
3824     * @see elm_fileselector_is_save_get()
3825     */
3826    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3827
3828    /**
3829     * Get whether the given file selector entry widget's internal
3830     * file selector is in "saving dialog" mode
3831     *
3832     * @param obj The file selector entry widget
3833     * @return @c EINA_TRUE, if @p obj widget's internal file selector
3834     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
3835     * errors)
3836     *
3837     * @see elm_fileselector_entry_is_save_set() for more details
3838     */
3839    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3840
3841    /**
3842     * Set whether a given file selector entry widget's internal file
3843     * selector will raise an Elementary "inner window", instead of a
3844     * dedicated Elementary window. By default, it won't.
3845     *
3846     * @param obj The file selector entry widget
3847     * @param value @c EINA_TRUE to make it use an inner window, @c
3848     * EINA_TRUE to make it use a dedicated window
3849     *
3850     * @see elm_win_inwin_add() for more information on inner windows
3851     * @see elm_fileselector_entry_inwin_mode_get()
3852     */
3853    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3854
3855    /**
3856     * Get whether a given file selector entry widget's internal file
3857     * selector will raise an Elementary "inner window", instead of a
3858     * dedicated Elementary window.
3859     *
3860     * @param obj The file selector entry widget
3861     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
3862     * if it will use a dedicated window
3863     *
3864     * @see elm_fileselector_entry_inwin_mode_set() for more details
3865     */
3866    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3867
3868    /**
3869     * Set the initial file system path for a given file selector entry
3870     * widget
3871     *
3872     * @param obj The file selector entry widget
3873     * @param path The path string
3874     *
3875     * It must be a <b>directory</b> path, which will have the contents
3876     * displayed initially in the file selector's view, when invoked
3877     * from @p obj. The default initial path is the @c "HOME"
3878     * environment variable's value.
3879     *
3880     * @see elm_fileselector_entry_path_get()
3881     */
3882    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3883
3884    /**
3885     * Get the parent directory's path to the latest file selection on
3886     * a given filer selector entry widget
3887     *
3888     * @param obj The file selector object
3889     * @return The (full) path of the directory of the last selection
3890     * on @p obj widget, a @b stringshared string
3891     *
3892     * @see elm_fileselector_entry_path_set()
3893     */
3894    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3895
3896    /**
3897     * @}
3898     */
3899
3900    /* scroller policy */
3901    typedef enum _Elm_Scroller_Policy
3902      {
3903         ELM_SCROLLER_POLICY_AUTO = 0,
3904         ELM_SCROLLER_POLICY_ON,
3905         ELM_SCROLLER_POLICY_OFF,
3906         ELM_SCROLLER_POLICY_LAST
3907      } Elm_Scroller_Policy;
3908
3909    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3910    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
3911    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3912    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3913    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
3914    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
3915    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);
3916    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3917    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
3918    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);
3919    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3920    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3921    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3922    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3923    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3924    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);
3925    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
3926    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
3927    /* smart callbacks called:
3928     * "edge,left" - the left edge of the content has been reached
3929     * "edge,right" - the right edge of the content has been reached
3930     * "edge,top" - the top edge of the content has been reached
3931     * "edge,bottom" - the bottom edge of the content has been reached
3932     * "scroll" - the content has been scrolled (moved)
3933     * "scroll,anim,start" - scrolling animation has started
3934     * "scroll,anim,stop" - scrolling animation has stopped
3935     * "scroll,drag,start" - dragging the contents around has started
3936     * "scroll,drag,stop" - dragging the contents around has stopped
3937     */
3938
3939    /**
3940     * @defgroup Label Label
3941     *
3942     * @image html img/widget/label/preview-00.png
3943     * @image latex img/widget/label/preview-00.eps
3944     *
3945     * @brief Widget to display text, with simple html-like markup.
3946     *
3947     * The Label widget @b doesn't allow text to overflow its boundaries, if the
3948     * text doesn't fit the geometry of the label it will be ellipsized or be
3949     * cut. Elementary provides several themes for this widget:
3950     * @li default - No animation
3951     * @li marker - Centers the text in the label and make it bold by default
3952     * @li slide_long - The entire text appears from the right of the screen and
3953     * slides until it disappears in the left of the screen(reappering on the
3954     * right again).
3955     * @li slide_short - The text appears in the left of the label and slides to
3956     * the right to show the overflow. When all of the text has been shown the
3957     * position is reset.
3958     * @li slide_bounce - The text appears in the left of the label and slides to
3959     * the right to show the overflow. When all of the text has been shown the
3960     * animation reverses, moving the text to the left.
3961     *
3962     * Custom themes can of course invent new markup tags and style them any way
3963     * they like.
3964     *
3965     * See @ref tutorial_label for a demonstration of how to use a label widget.
3966     * @{
3967     */
3968    /**
3969     * @brief Add a new label to the parent
3970     *
3971     * @param parent The parent object
3972     * @return The new object or NULL if it cannot be created
3973     */
3974    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3975    /**
3976     * @brief Set the label on the label object
3977     *
3978     * @param obj The label object
3979     * @param label The label will be used on the label object
3980     * @deprecated See elm_object_text_set()
3981     */
3982    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 */
3983    /**
3984     * @brief Get the label used on the label object
3985     *
3986     * @param obj The label object
3987     * @return The string inside the label
3988     * @deprecated See elm_object_text_get()
3989     */
3990    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
3991    /**
3992     * @brief Set the wrapping behavior of the label
3993     *
3994     * @param obj The label object
3995     * @param wrap To wrap text or not
3996     *
3997     * By default no wrapping is done. Possible values for @p wrap are:
3998     * @li ELM_WRAP_NONE - No wrapping
3999     * @li ELM_WRAP_CHAR - wrap between characters
4000     * @li ELM_WRAP_WORD - wrap between words
4001     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
4002     */
4003    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
4004    /**
4005     * @brief Get the wrapping behavior of the label
4006     *
4007     * @param obj The label object
4008     * @return Wrap type
4009     *
4010     * @see elm_label_line_wrap_set()
4011     */
4012    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4013    /**
4014     * @brief Set wrap width of the label
4015     *
4016     * @param obj The label object
4017     * @param w The wrap width in pixels at a minimum where words need to wrap
4018     *
4019     * This function sets the maximum width size hint of the label.
4020     *
4021     * @warning This is only relevant if the label is inside a container.
4022     */
4023    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
4024    /**
4025     * @brief Get wrap width of the label
4026     *
4027     * @param obj The label object
4028     * @return The wrap width in pixels at a minimum where words need to wrap
4029     *
4030     * @see elm_label_wrap_width_set()
4031     */
4032    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4033    /**
4034     * @brief Set wrap height of the label
4035     *
4036     * @param obj The label object
4037     * @param h The wrap height in pixels at a minimum where words need to wrap
4038     *
4039     * This function sets the maximum height size hint of the label.
4040     *
4041     * @warning This is only relevant if the label is inside a container.
4042     */
4043    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
4044    /**
4045     * @brief get wrap width of the label
4046     *
4047     * @param obj The label object
4048     * @return The wrap height in pixels at a minimum where words need to wrap
4049     */
4050    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4051    /**
4052     * @brief Set the font size on the label object.
4053     *
4054     * @param obj The label object
4055     * @param size font size
4056     *
4057     * @warning NEVER use this. It is for hyper-special cases only. use styles
4058     * instead. e.g. "big", "medium", "small" - or better name them by use:
4059     * "title", "footnote", "quote" etc.
4060     */
4061    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
4062    /**
4063     * @brief Set the text color on the label object
4064     *
4065     * @param obj The label object
4066     * @param r Red property background color of The label object
4067     * @param g Green property background color of The label object
4068     * @param b Blue property background color of The label object
4069     * @param a Alpha property background color of The label object
4070     *
4071     * @warning NEVER use this. It is for hyper-special cases only. use styles
4072     * instead. e.g. "big", "medium", "small" - or better name them by use:
4073     * "title", "footnote", "quote" etc.
4074     */
4075    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);
4076    /**
4077     * @brief Set the text align on the label object
4078     *
4079     * @param obj The label object
4080     * @param align align mode ("left", "center", "right")
4081     *
4082     * @warning NEVER use this. It is for hyper-special cases only. use styles
4083     * instead. e.g. "big", "medium", "small" - or better name them by use:
4084     * "title", "footnote", "quote" etc.
4085     */
4086    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
4087    /**
4088     * @brief Set background color of the label
4089     *
4090     * @param obj The label object
4091     * @param r Red property background color of The label object
4092     * @param g Green property background color of The label object
4093     * @param b Blue property background color of The label object
4094     * @param a Alpha property background alpha of The label object
4095     *
4096     * @warning NEVER use this. It is for hyper-special cases only. use styles
4097     * instead. e.g. "big", "medium", "small" - or better name them by use:
4098     * "title", "footnote", "quote" etc.
4099     */
4100    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);
4101    /**
4102     * @brief Set the ellipsis behavior of the label
4103     *
4104     * @param obj The label object
4105     * @param ellipsis To ellipsis text or not
4106     *
4107     * If set to true and the text doesn't fit in the label an ellipsis("...")
4108     * will be shown at the end of the widget.
4109     *
4110     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
4111     * choosen wrap method was ELM_WRAP_WORD.
4112     */
4113    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
4114    /**
4115     * @brief Set the text slide of the label
4116     *
4117     * @param obj The label object
4118     * @param slide To start slide or stop
4119     *
4120     * If set to true the text of the label will slide throught the length of
4121     * label.
4122     *
4123     * @warning This must be called before elm_label_slide_set().
4124     * @warning This only work with the themes "slide_short", "slide_long" and
4125     * "slide_bounce".
4126     */
4127    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
4128    /**
4129     * @brief Get the text slide mode of the label
4130     *
4131     * @param obj The label object
4132     * @return slide slide mode value
4133     *
4134     * @see elm_label_slide_set()
4135     */
4136    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4137    /**
4138     * @brief Set the slide duration(speed) of the label
4139     *
4140     * @param obj The label object
4141     * @return The duration in seconds in moving text from slide begin position
4142     * to slide end position
4143     */
4144    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
4145    /**
4146     * @brief Get the slide duration(speed) of the label
4147     *
4148     * @param obj The label object
4149     * @return The duration time in moving text from slide begin position to slide end position
4150     *
4151     * @see elm_label_slide_duration_set()
4152     */
4153    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4154    /**
4155     * @}
4156     */
4157
4158    /**
4159     * @defgroup Toggle
4160     *
4161     * @image html img/widget/toggle/preview-00.png
4162     * @image latex img/widget/toggle/preview-00.eps
4163     *
4164     * @brief A toggle is a slider which can be used to toggle between
4165     * two values.  It has two states: on and off.
4166     *
4167     * Signals that you can add callbacks for are:
4168     * @li "changed" - Whenever the toggle value has been changed.  Is not called
4169     *                 until the toggle is released by the cursor (assuming it
4170     *                 has been triggered by the cursor in the first place).
4171     *
4172     * @ref tutorial_toggle show how to use a toggle.
4173     * @{
4174     */
4175    /**
4176     * @brief Add a toggle to @p parent.
4177     *
4178     * @param parent The parent object
4179     *
4180     * @return The toggle object
4181     */
4182    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4183    /**
4184     * @brief Sets the label to be displayed with the toggle.
4185     *
4186     * @param obj The toggle object
4187     * @param label The label to be displayed
4188     *
4189     * @deprecated use elm_object_text_set() instead.
4190     */
4191    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4192    /**
4193     * @brief Gets the label of the toggle
4194     *
4195     * @param obj  toggle object
4196     * @return The label of the toggle
4197     *
4198     * @deprecated use elm_object_text_get() instead.
4199     */
4200    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4201    /**
4202     * @brief Set the icon used for the toggle
4203     *
4204     * @param obj The toggle object
4205     * @param icon The icon object for the button
4206     *
4207     * Once the icon object is set, a previously set one will be deleted
4208     * If you want to keep that old content object, use the
4209     * elm_toggle_icon_unset() function.
4210     */
4211    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4212    /**
4213     * @brief Get the icon used for the toggle
4214     *
4215     * @param obj The toggle object
4216     * @return The icon object that is being used
4217     *
4218     * Return the icon object which is set for this widget.
4219     *
4220     * @see elm_toggle_icon_set()
4221     */
4222    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4223    /**
4224     * @brief Unset the icon used for the toggle
4225     *
4226     * @param obj The toggle object
4227     * @return The icon object that was being used
4228     *
4229     * Unparent and return the icon object which was set for this widget.
4230     *
4231     * @see elm_toggle_icon_set()
4232     */
4233    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4234    /**
4235     * @brief Sets the labels to be associated with the on and off states of the toggle.
4236     *
4237     * @param obj The toggle object
4238     * @param onlabel The label displayed when the toggle is in the "on" state
4239     * @param offlabel The label displayed when the toggle is in the "off" state
4240     */
4241    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
4242    /**
4243     * @brief Gets the labels associated with the on and off states of the toggle.
4244     *
4245     * @param obj The toggle object
4246     * @param onlabel A char** to place the onlabel of @p obj into
4247     * @param offlabel A char** to place the offlabel of @p obj into
4248     */
4249    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
4250    /**
4251     * @brief Sets the state of the toggle to @p state.
4252     *
4253     * @param obj The toggle object
4254     * @param state The state of @p obj
4255     */
4256    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
4257    /**
4258     * @brief Gets the state of the toggle to @p state.
4259     *
4260     * @param obj The toggle object
4261     * @return The state of @p obj
4262     */
4263    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4264    /**
4265     * @brief Sets the state pointer of the toggle to @p statep.
4266     *
4267     * @param obj The toggle object
4268     * @param statep The state pointer of @p obj
4269     */
4270    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
4271    /**
4272     * @}
4273     */
4274
4275    /**
4276     * @page tutorial_frame Frame example
4277     * @dontinclude frame_example_01.c
4278     *
4279     * In this example we are going to create 4 Frames with different styles and
4280     * add a rectangle of different color in each.
4281     *
4282     * We start we the usual setup code:
4283     * @until show(bg)
4284     *
4285     * And then create one rectangle:
4286     * @until show
4287     *
4288     * To add it in our first frame, which since it doesn't have it's style
4289     * specifically set uses the default style:
4290     * @until show
4291     *
4292     * And then create another rectangle:
4293     * @until show
4294     *
4295     * To add it in our second frame, which uses the "pad_small" style, note that
4296     * even tough we are setting a text for this frame it won't be show, only the
4297     * default style shows the Frame's title:
4298     * @until show
4299     * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
4300     * very similar, their only difference is the size of the empty area around
4301     * the content of the frame.
4302     *
4303     * And then create yet another rectangle:
4304     * @until show
4305     *
4306     * To add it in our third frame, which uses the "outdent_top" style, note
4307     * that even tough we are setting a text for this frame it won't be show,
4308     * only the default style shows the Frame's title:
4309     * @until show
4310     *
4311     * And then create one last rectangle:
4312     * @until show
4313     *
4314     * To add it in our fourth and final frame, which uses the "outdent_bottom"
4315     * style, note that even tough we are setting a text for this frame it won't
4316     * be show, only the default style shows the Frame's title:
4317     * @until show
4318     *
4319     * And now we are left with just some more setup code:
4320     * @until ELM_MAIN()
4321     *
4322     * Our example will look like this:
4323     *
4324     * @image html screenshots/frame_example_01.png
4325     * @image latex screenshots/frame_example_01.eps width=\textwidth
4326     *
4327     * @example frame_example_01.c
4328     */
4329    /**
4330     * @defgroup Frame Frame
4331     *
4332     * @image html img/widget/frame/preview-00.png
4333     * @image latex img/widget/frame/preview-00.eps
4334     *
4335     * @brief Frame is a widget that holds some content and has a title.
4336     *
4337     * The default look is a frame with a title, but Frame supports multple
4338     * styles:
4339     * @li default
4340     * @li pad_small
4341     * @li pad_medium
4342     * @li pad_large
4343     * @li pad_huge
4344     * @li outdent_top
4345     * @li outdent_bottom
4346     *
4347     * Of all this styles only default shows the title. Frame emits no signals.
4348     *
4349     * For a detailed example see the @ref tutorial_frame.
4350     *
4351     * @{
4352     */
4353    /**
4354     * @brief Add a new frame to the parent
4355     *
4356     * @param parent The parent object
4357     * @return The new object or NULL if it cannot be created
4358     */
4359    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4360    /**
4361     * @brief Set the frame label
4362     *
4363     * @param obj The frame object
4364     * @param label The label of this frame object
4365     *
4366     * @deprecated use elm_object_text_set() instead.
4367     */
4368    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4369    /**
4370     * @brief Get the frame label
4371     *
4372     * @param obj The frame object
4373     *
4374     * @return The label of this frame objet or NULL if unable to get frame
4375     *
4376     * @deprecated use elm_object_text_get() instead.
4377     */
4378    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4379    /**
4380     * @brief Set the content of the frame widget
4381     *
4382     * Once the content object is set, a previously set one will be deleted.
4383     * If you want to keep that old content object, use the
4384     * elm_frame_content_unset() function.
4385     *
4386     * @param obj The frame object
4387     * @param content The content will be filled in this frame object
4388     */
4389    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4390    /**
4391     * @brief Get the content of the frame widget
4392     *
4393     * Return the content object which is set for this widget
4394     *
4395     * @param obj The frame object
4396     * @return The content that is being used
4397     */
4398    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4399    /**
4400     * @brief Unset the content of the frame widget
4401     *
4402     * Unparent and return the content object which was set for this widget
4403     *
4404     * @param obj The frame object
4405     * @return The content that was being used
4406     */
4407    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4408    /**
4409     * @}
4410     */
4411
4412    /* table */
4413    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4414    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4415    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4416    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4417    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4418    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
4419    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
4420    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4421    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4422    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
4423    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4424    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4425
4426    /**
4427     * @defgroup Gengrid Gengrid (Generic grid)
4428     *
4429     * This widget aims to position objects in a grid layout while
4430     * actually creating and rendering only the visible ones, using the
4431     * same idea as the @ref Genlist "genlist": the user defines a @b
4432     * class for each item, specifying functions that will be called at
4433     * object creation, deletion, etc. When those items are selected by
4434     * the user, a callback function is issued. Users may interact with
4435     * a gengrid via the mouse (by clicking on items to select them and
4436     * clicking on the grid's viewport and swiping to pan the whole
4437     * view) or via the keyboard, navigating through item with the
4438     * arrow keys.
4439     *
4440     * @section Gengrid_Layouts Gengrid layouts
4441     *
4442     * Gengrids may layout its items in one of two possible layouts:
4443     * - horizontal or
4444     * - vertical.
4445     *
4446     * When in "horizontal mode", items will be placed in @b columns,
4447     * from top to bottom and, when the space for a column is filled,
4448     * another one is started on the right, thus expanding the grid
4449     * horizontally, making for horizontal scrolling. When in "vertical
4450     * mode" , though, items will be placed in @b rows, from left to
4451     * right and, when the space for a row is filled, another one is
4452     * started below, thus expanding the grid vertically (and making
4453     * for vertical scrolling).
4454     *
4455     * @section Gengrid_Items Gengrid items
4456     *
4457     * An item in a gengrid can have 0 or more text labels (they can be
4458     * regular text or textblock Evas objects - that's up to the style
4459     * to determine), 0 or more icons (which are simply objects
4460     * swallowed into the gengrid item's theming Edje object) and 0 or
4461     * more <b>boolean states</b>, which have the behavior left to the
4462     * user to define. The Edje part names for each of these properties
4463     * will be looked up, in the theme file for the gengrid, under the
4464     * Edje (string) data items named @c "labels", @c "icons" and @c
4465     * "states", respectively. For each of those properties, if more
4466     * than one part is provided, they must have names listed separated
4467     * by spaces in the data fields. For the default gengrid item
4468     * theme, we have @b one label part (@c "elm.text"), @b two icon
4469     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
4470     * no state parts.
4471     *
4472     * A gengrid item may be at one of several styles. Elementary
4473     * provides one by default - "default", but this can be extended by
4474     * system or application custom themes/overlays/extensions (see
4475     * @ref Theme "themes" for more details).
4476     *
4477     * @section Gengrid_Item_Class Gengrid item classes
4478     *
4479     * In order to have the ability to add and delete items on the fly,
4480     * gengrid implements a class (callback) system where the
4481     * application provides a structure with information about that
4482     * type of item (gengrid may contain multiple different items with
4483     * different classes, states and styles). Gengrid will call the
4484     * functions in this struct (methods) when an item is "realized"
4485     * (i.e., created dynamically, while the user is scrolling the
4486     * grid). All objects will simply be deleted when no longer needed
4487     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
4488     * contains the following members:
4489     * - @c item_style - This is a constant string and simply defines
4490     * the name of the item style. It @b must be specified and the
4491     * default should be @c "default".
4492     * - @c func.label_get - This function is called when an item
4493     * object is actually created. The @c data parameter will point to
4494     * the same data passed to elm_gengrid_item_append() and related
4495     * item creation functions. The @c obj parameter is the gengrid
4496     * object itself, while the @c part one is the name string of one
4497     * of the existing text parts in the Edje group implementing the
4498     * item's theme. This function @b must return a strdup'()ed string,
4499     * as the caller will free() it when done. See
4500     * #GridItemLabelGetFunc.
4501     * - @c func.icon_get - This function is called when an item object
4502     * is actually created. The @c data parameter will point to the
4503     * same data passed to elm_gengrid_item_append() and related item
4504     * creation functions. The @c obj parameter is the gengrid object
4505     * itself, while the @c part one is the name string of one of the
4506     * existing (icon) swallow parts in the Edje group implementing the
4507     * item's theme. It must return @c NULL, when no icon is desired,
4508     * or a valid object handle, otherwise. The object will be deleted
4509     * by the gengrid on its deletion or when the item is "unrealized".
4510     * See #GridItemIconGetFunc.
4511     * - @c func.state_get - This function is called when an item
4512     * object is actually created. The @c data parameter will point to
4513     * the same data passed to elm_gengrid_item_append() and related
4514     * item creation functions. The @c obj parameter is the gengrid
4515     * object itself, while the @c part one is the name string of one
4516     * of the state parts in the Edje group implementing the item's
4517     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
4518     * true/on. Gengrids will emit a signal to its theming Edje object
4519     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
4520     * "source" arguments, respectively, when the state is true (the
4521     * default is false), where @c XXX is the name of the (state) part.
4522     * See #GridItemStateGetFunc.
4523     * - @c func.del - This is called when elm_gengrid_item_del() is
4524     * called on an item or elm_gengrid_clear() is called on the
4525     * gengrid. This is intended for use when gengrid items are
4526     * deleted, so any data attached to the item (e.g. its data
4527     * parameter on creation) can be deleted. See #GridItemDelFunc.
4528     *
4529     * @section Gengrid_Usage_Hints Usage hints
4530     *
4531     * If the user wants to have multiple items selected at the same
4532     * time, elm_gengrid_multi_select_set() will permit it. If the
4533     * gengrid is single-selection only (the default), then
4534     * elm_gengrid_select_item_get() will return the selected item or
4535     * @c NULL, if none is selected. If the gengrid is under
4536     * multi-selection, then elm_gengrid_selected_items_get() will
4537     * return a list (that is only valid as long as no items are
4538     * modified (added, deleted, selected or unselected) of child items
4539     * on a gengrid.
4540     *
4541     * If an item changes (internal (boolean) state, label or icon
4542     * changes), then use elm_gengrid_item_update() to have gengrid
4543     * update the item with the new state. A gengrid will re-"realize"
4544     * the item, thus calling the functions in the
4545     * #Elm_Gengrid_Item_Class set for that item.
4546     *
4547     * To programmatically (un)select an item, use
4548     * elm_gengrid_item_selected_set(). To get its selected state use
4549     * elm_gengrid_item_selected_get(). To make an item disabled
4550     * (unable to be selected and appear differently) use
4551     * elm_gengrid_item_disabled_set() to set this and
4552     * elm_gengrid_item_disabled_get() to get the disabled state.
4553     *
4554     * Grid cells will only have their selection smart callbacks called
4555     * when firstly getting selected. Any further clicks will do
4556     * nothing, unless you enable the "always select mode", with
4557     * elm_gengrid_always_select_mode_set(), thus making every click to
4558     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
4559     * turn off the ability to select items entirely in the widget and
4560     * they will neither appear selected nor call the selection smart
4561     * callbacks.
4562     *
4563     * Remember that you can create new styles and add your own theme
4564     * augmentation per application with elm_theme_extension_add(). If
4565     * you absolutely must have a specific style that overrides any
4566     * theme the user or system sets up you can use
4567     * elm_theme_overlay_add() to add such a file.
4568     *
4569     * @section Gengrid_Smart_Events Gengrid smart events
4570     *
4571     * Smart events that you can add callbacks for are:
4572     * - @c "activated" - The user has double-clicked or pressed
4573     *   (enter|return|spacebar) on an item. The @c event_info parameter
4574     *   is the gengrid item that was activated.
4575     * - @c "clicked,double" - The user has double-clicked an item.
4576     *   The @c event_info parameter is the gengrid item that was double-clicked.
4577     * - @c "selected" - The user has made an item selected. The
4578     *   @c event_info parameter is the gengrid item that was selected.
4579     * - @c "unselected" - The user has made an item unselected. The
4580     *   @c event_info parameter is the gengrid item that was unselected.
4581     * - @c "realized" - This is called when the item in the gengrid
4582     *   has its implementing Evas object instantiated, de facto. @c
4583     *   event_info is the gengrid item that was created. The object
4584     *   may be deleted at any time, so it is highly advised to the
4585     *   caller @b not to use the object pointer returned from
4586     *   elm_gengrid_item_object_get(), because it may point to freed
4587     *   objects.
4588     * - @c "unrealized" - This is called when the implementing Evas
4589     *   object for this item is deleted. @c event_info is the gengrid
4590     *   item that was deleted.
4591     * - @c "changed" - Called when an item is added, removed, resized
4592     *   or moved and when the gengrid is resized or gets "horizontal"
4593     *   property changes.
4594     * - @c "drag,start,up" - Called when the item in the gengrid has
4595     *   been dragged (not scrolled) up.
4596     * - @c "drag,start,down" - Called when the item in the gengrid has
4597     *   been dragged (not scrolled) down.
4598     * - @c "drag,start,left" - Called when the item in the gengrid has
4599     *   been dragged (not scrolled) left.
4600     * - @c "drag,start,right" - Called when the item in the gengrid has
4601     *   been dragged (not scrolled) right.
4602     * - @c "drag,stop" - Called when the item in the gengrid has
4603     *   stopped being dragged.
4604     * - @c "drag" - Called when the item in the gengrid is being
4605     *   dragged.
4606     * - @c "scroll" - called when the content has been scrolled
4607     *   (moved).
4608     * - @c "scroll,drag,start" - called when dragging the content has
4609     *   started.
4610     * - @c "scroll,drag,stop" - called when dragging the content has
4611     *   stopped.
4612     *
4613     * List of gendrid examples:
4614     * @li @ref gengrid_example
4615     */
4616
4617    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
4618    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
4619    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
4620    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
4621    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
4622    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
4623    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
4624
4625    /**
4626     * @struct _Elm_Gengrid_Item_Class
4627     *
4628     * Gengrid item class definition. See @ref Gengrid_Item_Class for
4629     * field details.
4630     */
4631    struct _Elm_Gengrid_Item_Class
4632      {
4633         const char             *item_style;
4634         struct _Elm_Gengrid_Item_Class_Func
4635           {
4636              GridItemLabelGetFunc  label_get;
4637              GridItemIconGetFunc   icon_get;
4638              GridItemStateGetFunc  state_get;
4639              GridItemDelFunc       del;
4640           } func;
4641      }; /**< #Elm_Gengrid_Item_Class member definitions */
4642
4643    /**
4644     * Add a new gengrid widget to the given parent Elementary
4645     * (container) object
4646     *
4647     * @param parent The parent object
4648     * @return a new gengrid widget handle or @c NULL, on errors
4649     *
4650     * This function inserts a new gengrid widget on the canvas.
4651     *
4652     * @see elm_gengrid_item_size_set()
4653     * @see elm_gengrid_horizontal_set()
4654     * @see elm_gengrid_item_append()
4655     * @see elm_gengrid_item_del()
4656     * @see elm_gengrid_clear()
4657     *
4658     * @ingroup Gengrid
4659     */
4660    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4661
4662    /**
4663     * Set the size for the items of a given gengrid widget
4664     *
4665     * @param obj The gengrid object.
4666     * @param w The items' width.
4667     * @param h The items' height;
4668     *
4669     * A gengrid, after creation, has still no information on the size
4670     * to give to each of its cells. So, you most probably will end up
4671     * with squares one @ref Fingers "finger" wide, the default
4672     * size. Use this function to force a custom size for you items,
4673     * making them as big as you wish.
4674     *
4675     * @see elm_gengrid_item_size_get()
4676     *
4677     * @ingroup Gengrid
4678     */
4679    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4680
4681    /**
4682     * Get the size set for the items of a given gengrid widget
4683     *
4684     * @param obj The gengrid object.
4685     * @param w Pointer to a variable where to store the items' width.
4686     * @param h Pointer to a variable where to store the items' height.
4687     *
4688     * @note Use @c NULL pointers on the size values you're not
4689     * interested in: they'll be ignored by the function.
4690     *
4691     * @see elm_gengrid_item_size_get() for more details
4692     *
4693     * @ingroup Gengrid
4694     */
4695    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
4696
4697    /**
4698     * Set the items grid's alignment within a given gengrid widget
4699     *
4700     * @param obj The gengrid object.
4701     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
4702     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
4703     *
4704     * This sets the alignment of the whole grid of items of a gengrid
4705     * within its given viewport. By default, those values are both
4706     * 0.5, meaning that the gengrid will have its items grid placed
4707     * exactly in the middle of its viewport.
4708     *
4709     * @note If given alignment values are out of the cited ranges,
4710     * they'll be changed to the nearest boundary values on the valid
4711     * ranges.
4712     *
4713     * @see elm_gengrid_align_get()
4714     *
4715     * @ingroup Gengrid
4716     */
4717    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
4718
4719    /**
4720     * Get the items grid's alignment values within a given gengrid
4721     * widget
4722     *
4723     * @param obj The gengrid object.
4724     * @param align_x Pointer to a variable where to store the
4725     * horizontal alignment.
4726     * @param align_y Pointer to a variable where to store the vertical
4727     * alignment.
4728     *
4729     * @note Use @c NULL pointers on the alignment values you're not
4730     * interested in: they'll be ignored by the function.
4731     *
4732     * @see elm_gengrid_align_set() for more details
4733     *
4734     * @ingroup Gengrid
4735     */
4736    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
4737
4738    /**
4739     * Set whether a given gengrid widget is or not able have items
4740     * @b reordered
4741     *
4742     * @param obj The gengrid object
4743     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
4744     * @c EINA_FALSE to turn it off
4745     *
4746     * If a gengrid is set to allow reordering, a click held for more
4747     * than 0.5 over a given item will highlight it specially,
4748     * signalling the gengrid has entered the reordering state. From
4749     * that time on, the user will be able to, while still holding the
4750     * mouse button down, move the item freely in the gengrid's
4751     * viewport, replacing to said item to the locations it goes to.
4752     * The replacements will be animated and, whenever the user
4753     * releases the mouse button, the item being replaced gets a new
4754     * definitive place in the grid.
4755     *
4756     * @see elm_gengrid_reorder_mode_get()
4757     *
4758     * @ingroup Gengrid
4759     */
4760    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
4761
4762    /**
4763     * Get whether a given gengrid widget is or not able have items
4764     * @b reordered
4765     *
4766     * @param obj The gengrid object
4767     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
4768     * off
4769     *
4770     * @see elm_gengrid_reorder_mode_set() for more details
4771     *
4772     * @ingroup Gengrid
4773     */
4774    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4775
4776    /**
4777     * Append a new item in a given gengrid widget.
4778     *
4779     * @param obj The gengrid object.
4780     * @param gic The item class for the item.
4781     * @param data The item data.
4782     * @param func Convenience function called when the item is
4783     * selected.
4784     * @param func_data Data to be passed to @p func.
4785     * @return A handle to the item added or @c NULL, on errors.
4786     *
4787     * This adds an item to the beginning of the gengrid.
4788     *
4789     * @see elm_gengrid_item_prepend()
4790     * @see elm_gengrid_item_insert_before()
4791     * @see elm_gengrid_item_insert_after()
4792     * @see elm_gengrid_item_del()
4793     *
4794     * @ingroup Gengrid
4795     */
4796    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);
4797
4798    /**
4799     * Prepend a new item in a given gengrid widget.
4800     *
4801     * @param obj The gengrid object.
4802     * @param gic The item class for the item.
4803     * @param data The item data.
4804     * @param func Convenience function called when the item is
4805     * selected.
4806     * @param func_data Data to be passed to @p func.
4807     * @return A handle to the item added or @c NULL, on errors.
4808     *
4809     * This adds an item to the end of the gengrid.
4810     *
4811     * @see elm_gengrid_item_append()
4812     * @see elm_gengrid_item_insert_before()
4813     * @see elm_gengrid_item_insert_after()
4814     * @see elm_gengrid_item_del()
4815     *
4816     * @ingroup Gengrid
4817     */
4818    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);
4819
4820    /**
4821     * Insert an item before another in a gengrid widget
4822     *
4823     * @param obj The gengrid object.
4824     * @param gic The item class for the item.
4825     * @param data The item data.
4826     * @param relative The item to place this new one before.
4827     * @param func Convenience function called when the item is
4828     * selected.
4829     * @param func_data Data to be passed to @p func.
4830     * @return A handle to the item added or @c NULL, on errors.
4831     *
4832     * This inserts an item before another in the gengrid.
4833     *
4834     * @see elm_gengrid_item_append()
4835     * @see elm_gengrid_item_prepend()
4836     * @see elm_gengrid_item_insert_after()
4837     * @see elm_gengrid_item_del()
4838     *
4839     * @ingroup Gengrid
4840     */
4841    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);
4842
4843    /**
4844     * Insert an item after another in a gengrid widget
4845     *
4846     * @param obj The gengrid object.
4847     * @param gic The item class for the item.
4848     * @param data The item data.
4849     * @param relative The item to place this new one after.
4850     * @param func Convenience function called when the item is
4851     * selected.
4852     * @param func_data Data to be passed to @p func.
4853     * @return A handle to the item added or @c NULL, on errors.
4854     *
4855     * This inserts an item after another in the gengrid.
4856     *
4857     * @see elm_gengrid_item_append()
4858     * @see elm_gengrid_item_prepend()
4859     * @see elm_gengrid_item_insert_after()
4860     * @see elm_gengrid_item_del()
4861     *
4862     * @ingroup Gengrid
4863     */
4864    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);
4865
4866    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);
4867
4868    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);
4869
4870    /**
4871     * Set whether items on a given gengrid widget are to get their
4872     * selection callbacks issued for @b every subsequent selection
4873     * click on them or just for the first click.
4874     *
4875     * @param obj The gengrid object
4876     * @param always_select @c EINA_TRUE to make items "always
4877     * selected", @c EINA_FALSE, otherwise
4878     *
4879     * By default, grid items will only call their selection callback
4880     * function when firstly getting selected, any subsequent further
4881     * clicks will do nothing. With this call, you make those
4882     * subsequent clicks also to issue the selection callbacks.
4883     *
4884     * @note <b>Double clicks</b> will @b always be reported on items.
4885     *
4886     * @see elm_gengrid_always_select_mode_get()
4887     *
4888     * @ingroup Gengrid
4889     */
4890    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4891
4892    /**
4893     * Get whether items on a given gengrid widget have their selection
4894     * callbacks issued for @b every subsequent selection click on them
4895     * or just for the first click.
4896     *
4897     * @param obj The gengrid object.
4898     * @return @c EINA_TRUE if the gengrid items are "always selected",
4899     * @c EINA_FALSE, otherwise
4900     *
4901     * @see elm_gengrid_always_select_mode_set() for more details
4902     *
4903     * @ingroup Gengrid
4904     */
4905    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4906
4907    /**
4908     * Set whether items on a given gengrid widget can be selected or not.
4909     *
4910     * @param obj The gengrid object
4911     * @param no_select @c EINA_TRUE to make items selectable,
4912     * @c EINA_FALSE otherwise
4913     *
4914     * This will make items in @obj selectable or not. In the latter
4915     * case, any user interacion on the gendrid items will neither make
4916     * them appear selected nor them call their selection callback
4917     * functions.
4918     *
4919     * @see elm_gengrid_no_select_mode_get()
4920     *
4921     * @ingroup Gengrid
4922     */
4923    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4924
4925    /**
4926     * Get whether items on a given gengrid widget can be selected or
4927     * not.
4928     *
4929     * @param obj The gengrid object
4930     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
4931     * otherwise
4932     *
4933     * @see elm_gengrid_no_select_mode_set() for more details
4934     *
4935     * @ingroup Gengrid
4936     */
4937    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4938
4939    /**
4940     * Enable or disable multi-selection in a given gengrid widget
4941     *
4942     * @param obj The gengrid object.
4943     * @param multi @c EINA_TRUE, to enable multi-selection,
4944     * @c EINA_FALSE to disable it.
4945     *
4946     * Multi-selection is the ability for one to have @b more than one
4947     * item selected, on a given gengrid, simultaneously. When it is
4948     * enabled, a sequence of clicks on different items will make them
4949     * all selected, progressively. A click on an already selected item
4950     * will unselect it. If interecting via the keyboard,
4951     * multi-selection is enabled while holding the "Shift" key.
4952     *
4953     * @note By default, multi-selection is @b disabled on gengrids
4954     *
4955     * @see elm_gengrid_multi_select_get()
4956     *
4957     * @ingroup Gengrid
4958     */
4959    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4960
4961    /**
4962     * Get whether multi-selection is enabled or disabled for a given
4963     * gengrid widget
4964     *
4965     * @param obj The gengrid object.
4966     * @return @c EINA_TRUE, if multi-selection is enabled, @c
4967     * EINA_FALSE otherwise
4968     *
4969     * @see elm_gengrid_multi_select_set() for more details
4970     *
4971     * @ingroup Gengrid
4972     */
4973    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4974
4975    /**
4976     * Enable or disable bouncing effect for a given gengrid widget
4977     *
4978     * @param obj The gengrid object
4979     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
4980     * @c EINA_FALSE to disable it
4981     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
4982     * @c EINA_FALSE to disable it
4983     *
4984     * The bouncing effect occurs whenever one reaches the gengrid's
4985     * edge's while panning it -- it will scroll past its limits a
4986     * little bit and return to the edge again, in a animated for,
4987     * automatically.
4988     *
4989     * @note By default, gengrids have bouncing enabled on both axis
4990     *
4991     * @see elm_gengrid_bounce_get()
4992     *
4993     * @ingroup Gengrid
4994     */
4995    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4996
4997    /**
4998     * Get whether bouncing effects are enabled or disabled, for a
4999     * given gengrid widget, on each axis
5000     *
5001     * @param obj The gengrid object
5002     * @param h_bounce Pointer to a variable where to store the
5003     * horizontal bouncing flag.
5004     * @param v_bounce Pointer to a variable where to store the
5005     * vertical bouncing flag.
5006     *
5007     * @see elm_gengrid_bounce_set() for more details
5008     *
5009     * @ingroup Gengrid
5010     */
5011    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5012
5013    /**
5014     * Set a given gengrid widget's scrolling page size, relative to
5015     * its viewport size.
5016     *
5017     * @param obj The gengrid object
5018     * @param h_pagerel The horizontal page (relative) size
5019     * @param v_pagerel The vertical page (relative) size
5020     *
5021     * The gengrid's scroller is capable of binding scrolling by the
5022     * user to "pages". It means that, while scrolling and, specially
5023     * after releasing the mouse button, the grid will @b snap to the
5024     * nearest displaying page's area. When page sizes are set, the
5025     * grid's continuous content area is split into (equal) page sized
5026     * pieces.
5027     *
5028     * This function sets the size of a page <b>relatively to the
5029     * viewport dimensions</b> of the gengrid, for each axis. A value
5030     * @c 1.0 means "the exact viewport's size", in that axis, while @c
5031     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
5032     * a viewport". Sane usable values are, than, between @c 0.0 and @c
5033     * 1.0. Values beyond those will make it behave behave
5034     * inconsistently. If you only want one axis to snap to pages, use
5035     * the value @c 0.0 for the other one.
5036     *
5037     * There is a function setting page size values in @b absolute
5038     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
5039     * is mutually exclusive to this one.
5040     *
5041     * @see elm_gengrid_page_relative_get()
5042     *
5043     * @ingroup Gengrid
5044     */
5045    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5046
5047    /**
5048     * Get a given gengrid widget's scrolling page size, relative to
5049     * its viewport size.
5050     *
5051     * @param obj The gengrid object
5052     * @param h_pagerel Pointer to a variable where to store the
5053     * horizontal page (relative) size
5054     * @param v_pagerel Pointer to a variable where to store the
5055     * vertical page (relative) size
5056     *
5057     * @see elm_gengrid_page_relative_set() for more details
5058     *
5059     * @ingroup Gengrid
5060     */
5061    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
5062
5063    /**
5064     * Set a given gengrid widget's scrolling page size
5065     *
5066     * @param obj The gengrid object
5067     * @param h_pagerel The horizontal page size, in pixels
5068     * @param v_pagerel The vertical page size, in pixels
5069     *
5070     * The gengrid's scroller is capable of binding scrolling by the
5071     * user to "pages". It means that, while scrolling and, specially
5072     * after releasing the mouse button, the grid will @b snap to the
5073     * nearest displaying page's area. When page sizes are set, the
5074     * grid's continuous content area is split into (equal) page sized
5075     * pieces.
5076     *
5077     * This function sets the size of a page of the gengrid, in pixels,
5078     * for each axis. Sane usable values are, between @c 0 and the
5079     * dimensions of @p obj, for each axis. Values beyond those will
5080     * make it behave behave inconsistently. If you only want one axis
5081     * to snap to pages, use the value @c 0 for the other one.
5082     *
5083     * There is a function setting page size values in @b relative
5084     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
5085     * use is mutually exclusive to this one.
5086     *
5087     * @ingroup Gengrid
5088     */
5089    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5090
5091    /**
5092     * Set for what direction a given gengrid widget will expand while
5093     * placing its items.
5094     *
5095     * @param obj The gengrid object.
5096     * @param setting @c EINA_TRUE to make the gengrid expand
5097     * horizontally, @c EINA_FALSE to expand vertically.
5098     *
5099     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
5100     * in @b columns, from top to bottom and, when the space for a
5101     * column is filled, another one is started on the right, thus
5102     * expanding the grid horizontally. When in "vertical mode"
5103     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
5104     * to right and, when the space for a row is filled, another one is
5105     * started below, thus expanding the grid vertically.
5106     *
5107     * @see elm_gengrid_horizontal_get()
5108     *
5109     * @ingroup Gengrid
5110     */
5111    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
5112
5113    /**
5114     * Get for what direction a given gengrid widget will expand while
5115     * placing its items.
5116     *
5117     * @param obj The gengrid object.
5118     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
5119     * @c EINA_FALSE if it's set to expand vertically.
5120     *
5121     * @see elm_gengrid_horizontal_set() for more detais
5122     *
5123     * @ingroup Gengrid
5124     */
5125    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5126
5127    /**
5128     * Get the first item in a given gengrid widget
5129     *
5130     * @param obj The gengrid object
5131     * @return The first item's handle or @c NULL, if there are no
5132     * items in @p obj (and on errors)
5133     *
5134     * This returns the first item in the @p obj's internal list of
5135     * items.
5136     *
5137     * @see elm_gengrid_last_item_get()
5138     *
5139     * @ingroup Gengrid
5140     */
5141    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142
5143    /**
5144     * Get the last item in a given gengrid widget
5145     *
5146     * @param obj The gengrid object
5147     * @return The last item's handle or @c NULL, if there are no
5148     * items in @p obj (and on errors)
5149     *
5150     * This returns the last item in the @p obj's internal list of
5151     * items.
5152     *
5153     * @see elm_gengrid_first_item_get()
5154     *
5155     * @ingroup Gengrid
5156     */
5157    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5158
5159    /**
5160     * Get the @b next item in a gengrid widget's internal list of items,
5161     * given a handle to one of those items.
5162     *
5163     * @param item The gengrid item to fetch next from
5164     * @return The item after @p item, or @c NULL if there's none (and
5165     * on errors)
5166     *
5167     * This returns the item placed after the @p item, on the container
5168     * gengrid.
5169     *
5170     * @see elm_gengrid_item_prev_get()
5171     *
5172     * @ingroup Gengrid
5173     */
5174    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5175
5176    /**
5177     * Get the @b previous item in a gengrid widget's internal list of items,
5178     * given a handle to one of those items.
5179     *
5180     * @param item The gengrid item to fetch previous from
5181     * @return The item before @p item, or @c NULL if there's none (and
5182     * on errors)
5183     *
5184     * This returns the item placed before the @p item, on the container
5185     * gengrid.
5186     *
5187     * @see elm_gengrid_item_next_get()
5188     *
5189     * @ingroup Gengrid
5190     */
5191    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5192
5193    /**
5194     * Get the gengrid object's handle which contains a given gengrid
5195     * item
5196     *
5197     * @param item The item to fetch the container from
5198     * @return The gengrid (parent) object
5199     *
5200     * This returns the gengrid object itself that an item belongs to.
5201     *
5202     * @ingroup Gengrid
5203     */
5204    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5205
5206    /**
5207     * Remove a gengrid item from the its parent, deleting it.
5208     *
5209     * @param item The item to be removed.
5210     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
5211     *
5212     * @see elm_gengrid_clear(), to remove all items in a gengrid at
5213     * once.
5214     *
5215     * @ingroup Gengrid
5216     */
5217    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5218
5219    /**
5220     * Update the contents of a given gengrid item
5221     *
5222     * @param item The gengrid item
5223     *
5224     * This updates an item by calling all the item class functions
5225     * again to get the icons, labels and states. Use this when the
5226     * original item data has changed and you want thta changes to be
5227     * reflected.
5228     *
5229     * @ingroup Gengrid
5230     */
5231    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5232    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5233    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
5234
5235    /**
5236     * Return the data associated to a given gengrid item
5237     *
5238     * @param item The gengrid item.
5239     * @return the data associated to this item.
5240     *
5241     * This returns the @c data value passed on the
5242     * elm_gengrid_item_append() and related item addition calls.
5243     *
5244     * @see elm_gengrid_item_append()
5245     * @see elm_gengrid_item_data_set()
5246     *
5247     * @ingroup Gengrid
5248     */
5249    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5250
5251    /**
5252     * Set the data associated to a given gengrid item
5253     *
5254     * @param item The gengrid item
5255     * @param data The new data pointer to set on it
5256     *
5257     * This @b overrides the @c data value passed on the
5258     * elm_gengrid_item_append() and related item addition calls. This
5259     * function @b won't call elm_gengrid_item_update() automatically,
5260     * so you'd issue it afterwards if you want to hove the item
5261     * updated to reflect the that new data.
5262     *
5263     * @see elm_gengrid_item_data_get()
5264     *
5265     * @ingroup Gengrid
5266     */
5267    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
5268
5269    /**
5270     * Get a given gengrid item's position, relative to the whole
5271     * gengrid's grid area.
5272     *
5273     * @param item The Gengrid item.
5274     * @param x Pointer to variable where to store the item's <b>row
5275     * number</b>.
5276     * @param y Pointer to variable where to store the item's <b>column
5277     * number</b>.
5278     *
5279     * This returns the "logical" position of the item whithin the
5280     * gengrid. For example, @c (0, 1) would stand for first row,
5281     * second column.
5282     *
5283     * @ingroup Gengrid
5284     */
5285    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
5286
5287    /**
5288     * Set whether a given gengrid item is selected or not
5289     *
5290     * @param item The gengrid item
5291     * @param selected Use @c EINA_TRUE, to make it selected, @c
5292     * EINA_FALSE to make it unselected
5293     *
5294     * This sets the selected state of an item. If multi selection is
5295     * not enabled on the containing gengrid and @p selected is @c
5296     * EINA_TRUE, any other previously selected items will get
5297     * unselected in favor of this new one.
5298     *
5299     * @see elm_gengrid_item_selected_get()
5300     *
5301     * @ingroup Gengrid
5302     */
5303    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5304
5305    /**
5306     * Get whether a given gengrid item is selected or not
5307     *
5308     * @param item The gengrid item
5309     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
5310     *
5311     * @see elm_gengrid_item_selected_set() for more details
5312     *
5313     * @ingroup Gengrid
5314     */
5315    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5316
5317    /**
5318     * Get the real Evas object created to implement the view of a
5319     * given gengrid item
5320     *
5321     * @param item The gengrid item.
5322     * @return the Evas object implementing this item's view.
5323     *
5324     * This returns the actual Evas object used to implement the
5325     * specified gengrid item's view. This may be @c NULL, as it may
5326     * not have been created or may have been deleted, at any time, by
5327     * the gengrid. <b>Do not modify this object</b> (move, resize,
5328     * show, hide, etc.), as the gengrid is controlling it. This
5329     * function is for querying, emitting custom signals or hooking
5330     * lower level callbacks for events on that object. Do not delete
5331     * this object under any circumstances.
5332     *
5333     * @see elm_gengrid_item_data_get()
5334     *
5335     * @ingroup Gengrid
5336     */
5337    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5338
5339    /**
5340     * Show the portion of a gengrid's internal grid containing a given
5341     * item, @b immediately.
5342     *
5343     * @param item The item to display
5344     *
5345     * This causes gengrid to @b redraw its viewport's contents to the
5346     * region contining the given @p item item, if it is not fully
5347     * visible.
5348     *
5349     * @see elm_gengrid_item_bring_in()
5350     *
5351     * @ingroup Gengrid
5352     */
5353    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5354
5355    /**
5356     * Animatedly bring in, to the visible are of a gengrid, a given
5357     * item on it.
5358     *
5359     * @param item The gengrid item to display
5360     *
5361     * This causes gengrig to jump to the given @p item item and show
5362     * it (by scrolling), if it is not fully visible. This will use
5363     * animation to do so and take a period of time to complete.
5364     *
5365     * @see elm_gengrid_item_show()
5366     *
5367     * @ingroup Gengrid
5368     */
5369    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5370
5371    /**
5372     * Set whether a given gengrid item is disabled or not.
5373     *
5374     * @param item The gengrid item
5375     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
5376     * to enable it back.
5377     *
5378     * A disabled item cannot be selected or unselected. It will also
5379     * change its appearance, to signal the user it's disabled.
5380     *
5381     * @see elm_gengrid_item_disabled_get()
5382     *
5383     * @ingroup Gengrid
5384     */
5385    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5386
5387    /**
5388     * Get whether a given gengrid item is disabled or not.
5389     *
5390     * @param item The gengrid item
5391     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
5392     * (and on errors).
5393     *
5394     * @see elm_gengrid_item_disabled_set() for more details
5395     *
5396     * @ingroup Gengrid
5397     */
5398    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5399
5400    /**
5401     * Set the text to be shown in a given gengrid item's tooltips.
5402     *
5403     * @param item The gengrid item
5404     * @param text The text to set in the content
5405     *
5406     * This call will setup the text to be used as tooltip to that item
5407     * (analogous to elm_object_tooltip_text_set(), but being item
5408     * tooltips with higher precedence than object tooltips). It can
5409     * have only one tooltip at a time, so any previous tooltip data
5410     * will get removed.
5411     *
5412     * @ingroup Gengrid
5413     */
5414    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
5415
5416    /**
5417     * Set the content to be shown in a given gengrid item's tooltips
5418     *
5419     * @param item The gengrid item.
5420     * @param func The function returning the tooltip contents.
5421     * @param data What to provide to @a func as callback data/context.
5422     * @param del_cb Called when data is not needed anymore, either when
5423     *        another callback replaces @func, the tooltip is unset with
5424     *        elm_gengrid_item_tooltip_unset() or the owner @p item
5425     *        dies. This callback receives as its first parameter the
5426     *        given @p data, being @c event_info the item handle.
5427     *
5428     * This call will setup the tooltip's contents to @p item
5429     * (analogous to elm_object_tooltip_content_cb_set(), but being
5430     * item tooltips with higher precedence than object tooltips). It
5431     * can have only one tooltip at a time, so any previous tooltip
5432     * content will get removed. @p func (with @p data) will be called
5433     * every time Elementary needs to show the tooltip and it should
5434     * return a valid Evas object, which will be fully managed by the
5435     * tooltip system, getting deleted when the tooltip is gone.
5436     *
5437     * @ingroup Gengrid
5438     */
5439    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);
5440
5441    /**
5442     * Unset a tooltip from a given gengrid item
5443     *
5444     * @param item gengrid item to remove a previously set tooltip from.
5445     *
5446     * This call removes any tooltip set on @p item. The callback
5447     * provided as @c del_cb to
5448     * elm_gengrid_item_tooltip_content_cb_set() will be called to
5449     * notify it is not used anymore (and have resources cleaned, if
5450     * need be).
5451     *
5452     * @see elm_gengrid_item_tooltip_content_cb_set()
5453     *
5454     * @ingroup Gengrid
5455     */
5456    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5457
5458    /**
5459     * Set a different @b style for a given gengrid item's tooltip.
5460     *
5461     * @param item gengrid item with tooltip set
5462     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
5463     * "default", @c "transparent", etc)
5464     *
5465     * Tooltips can have <b>alternate styles</b> to be displayed on,
5466     * which are defined by the theme set on Elementary. This function
5467     * works analogously as elm_object_tooltip_style_set(), but here
5468     * applied only to gengrid item objects. The default style for
5469     * tooltips is @c "default".
5470     *
5471     * @note before you set a style you should define a tooltip with
5472     *       elm_gengrid_item_tooltip_content_cb_set() or
5473     *       elm_gengrid_item_tooltip_text_set()
5474     *
5475     * @see elm_gengrid_item_tooltip_style_get()
5476     *
5477     * @ingroup Gengrid
5478     */
5479    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
5480
5481    /**
5482     * Get the style set a given gengrid item's tooltip.
5483     *
5484     * @param item gengrid item with tooltip already set on.
5485     * @return style the theme style in use, which defaults to
5486     *         "default". If the object does not have a tooltip set,
5487     *         then @c NULL is returned.
5488     *
5489     * @see elm_gengrid_item_tooltip_style_set() for more details
5490     *
5491     * @ingroup Gengrid
5492     */
5493    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5494
5495    /**
5496     * Set the type of mouse pointer/cursor decoration to be shown,
5497     * when the mouse pointer is over the given gengrid widget item
5498     *
5499     * @param item gengrid item to customize cursor on
5500     * @param cursor the cursor type's name
5501     *
5502     * This function works analogously as elm_object_cursor_set(), but
5503     * here the cursor's changing area is restricted to the item's
5504     * area, and not the whole widget's. Note that that item cursors
5505     * have precedence over widget cursors, so that a mouse over @p
5506     * item will always show cursor @p type.
5507     *
5508     * If this function is called twice for an object, a previously set
5509     * cursor will be unset on the second call.
5510     *
5511     * @see elm_object_cursor_set()
5512     * @see elm_gengrid_item_cursor_get()
5513     * @see elm_gengrid_item_cursor_unset()
5514     *
5515     * @ingroup Gengrid
5516     */
5517    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5518
5519    /**
5520     * Get the type of mouse pointer/cursor decoration set to be shown,
5521     * when the mouse pointer is over the given gengrid widget item
5522     *
5523     * @param item gengrid item with custom cursor set
5524     * @return the cursor type's name or @c NULL, if no custom cursors
5525     * were set to @p item (and on errors)
5526     *
5527     * @see elm_object_cursor_get()
5528     * @see elm_gengrid_item_cursor_set() for more details
5529     * @see elm_gengrid_item_cursor_unset()
5530     *
5531     * @ingroup Gengrid
5532     */
5533    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5534
5535    /**
5536     * Unset any custom mouse pointer/cursor decoration set to be
5537     * shown, when the mouse pointer is over the given gengrid widget
5538     * item, thus making it show the @b default cursor again.
5539     *
5540     * @param item a gengrid item
5541     *
5542     * Use this call to undo any custom settings on this item's cursor
5543     * decoration, bringing it back to defaults (no custom style set).
5544     *
5545     * @see elm_object_cursor_unset()
5546     * @see elm_gengrid_item_cursor_set() for more details
5547     *
5548     * @ingroup Gengrid
5549     */
5550    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5551
5552    /**
5553     * Set a different @b style for a given custom cursor set for a
5554     * gengrid item.
5555     *
5556     * @param item gengrid item with custom cursor set
5557     * @param style the <b>theme style</b> to use (e.g. @c "default",
5558     * @c "transparent", etc)
5559     *
5560     * This function only makes sense when one is using custom mouse
5561     * cursor decorations <b>defined in a theme file</b> , which can
5562     * have, given a cursor name/type, <b>alternate styles</b> on
5563     * it. It works analogously as elm_object_cursor_style_set(), but
5564     * here applied only to gengrid item objects.
5565     *
5566     * @warning Before you set a cursor style you should have defined a
5567     *       custom cursor previously on the item, with
5568     *       elm_gengrid_item_cursor_set()
5569     *
5570     * @see elm_gengrid_item_cursor_engine_only_set()
5571     * @see elm_gengrid_item_cursor_style_get()
5572     *
5573     * @ingroup Gengrid
5574     */
5575    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
5576
5577    /**
5578     * Get the current @b style set for a given gengrid item's custom
5579     * cursor
5580     *
5581     * @param item gengrid item with custom cursor set.
5582     * @return style the cursor style in use. If the object does not
5583     *         have a cursor set, then @c NULL is returned.
5584     *
5585     * @see elm_gengrid_item_cursor_style_set() for more details
5586     *
5587     * @ingroup Gengrid
5588     */
5589    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5590
5591    /**
5592     * Set if the (custom) cursor for a given gengrid item should be
5593     * searched in its theme, also, or should only rely on the
5594     * rendering engine.
5595     *
5596     * @param item item with custom (custom) cursor already set on
5597     * @param engine_only Use @c EINA_TRUE to have cursors looked for
5598     * only on those provided by the rendering engine, @c EINA_FALSE to
5599     * have them searched on the widget's theme, as well.
5600     *
5601     * @note This call is of use only if you've set a custom cursor
5602     * for gengrid items, with elm_gengrid_item_cursor_set().
5603     *
5604     * @note By default, cursors will only be looked for between those
5605     * provided by the rendering engine.
5606     *
5607     * @ingroup Gengrid
5608     */
5609    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5610
5611    /**
5612     * Get if the (custom) cursor for a given gengrid item is being
5613     * searched in its theme, also, or is only relying on the rendering
5614     * engine.
5615     *
5616     * @param item a gengrid item
5617     * @return @c EINA_TRUE, if cursors are being looked for only on
5618     * those provided by the rendering engine, @c EINA_FALSE if they
5619     * are being searched on the widget's theme, as well.
5620     *
5621     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
5622     *
5623     * @ingroup Gengrid
5624     */
5625    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5626
5627    /**
5628     * Remove all items from a given gengrid widget
5629     *
5630     * @param obj The gengrid object.
5631     *
5632     * This removes (and deletes) all items in @p obj, leaving it
5633     * empty.
5634     *
5635     * @see elm_gengrid_item_del(), to remove just one item.
5636     *
5637     * @ingroup Gengrid
5638     */
5639    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5640
5641    /**
5642     * Get the selected item in a given gengrid widget
5643     *
5644     * @param obj The gengrid object.
5645     * @return The selected item's handleor @c NULL, if none is
5646     * selected at the moment (and on errors)
5647     *
5648     * This returns the selected item in @p obj. If multi selection is
5649     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
5650     * the first item in the list is selected, which might not be very
5651     * useful. For that case, see elm_gengrid_selected_items_get().
5652     *
5653     * @ingroup Gengrid
5654     */
5655    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5656
5657    /**
5658     * Get <b>a list</b> of selected items in a given gengrid
5659     *
5660     * @param obj The gengrid object.
5661     * @return The list of selected items or @c NULL, if none is
5662     * selected at the moment (and on errors)
5663     *
5664     * This returns a list of the selected items, in the order that
5665     * they appear in the grid. This list is only valid as long as no
5666     * more items are selected or unselected (or unselected implictly
5667     * by deletion). The list contains #Elm_Gengrid_Item pointers as
5668     * data, naturally.
5669     *
5670     * @see @elm_gengrid_selected_item_get()
5671     *
5672     * @ingroup Gengrid
5673     */
5674    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5675
5676    /**
5677     * @defgroup Clock Clock
5678     *
5679     * @image html img/widget/clock/preview-00.png
5680     * @image latex img/widget/clock/preview-00.eps
5681     *
5682     * This is a @b digital clock widget. In its default theme, it has a
5683     * vintage "flipping numbers clock" appearance, which will animate
5684     * sheets of individual algarisms individually as time goes by.
5685     *
5686     * A newly created clock will fetch system's time (already
5687     * considering local time adjustments) to start with, and will tick
5688     * accondingly. It may or may not show seconds.
5689     *
5690     * Clocks have an @b edition mode. When in it, the sheets will
5691     * display extra arrow indications on the top and bottom and the
5692     * user may click on them to raise or lower the time values. After
5693     * it's told to exit edition mode, it will keep ticking with that
5694     * new time set (it keeps the difference from local time).
5695     *
5696     * Also, when under edition mode, user clicks on the cited arrows
5697     * which are @b held for some time will make the clock to flip the
5698     * sheet, thus editing the time, continuosly and automatically for
5699     * the user. The interval between sheet flips will keep growing in
5700     * time, so that it helps the user to reach a time which is distant
5701     * from the one set.
5702     *
5703     * The time display is, by default, in military mode (24h), but an
5704     * am/pm indicator may be optionally shown, too, when it will
5705     * switch to 12h.
5706     *
5707     * Smart callbacks one can register to:
5708     * - "changed" - the clock's user changed the time
5709     *
5710     * Here is an example on its usage:
5711     * @li @ref clock_example
5712     */
5713
5714    /**
5715     * @addtogroup Clock
5716     * @{
5717     */
5718
5719    /**
5720     * Identifiers for which clock digits should be editable, when a
5721     * clock widget is in edition mode. Values may be ORed together to
5722     * make a mask, naturally.
5723     *
5724     * @see elm_clock_edit_set()
5725     * @see elm_clock_digit_edit_set()
5726     */
5727    typedef enum _Elm_Clock_Digedit
5728      {
5729         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
5730         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
5731         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
5732         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
5733         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
5734         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
5735         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
5736         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
5737      } Elm_Clock_Digedit;
5738
5739    /**
5740     * Add a new clock widget to the given parent Elementary
5741     * (container) object
5742     *
5743     * @param parent The parent object
5744     * @return a new clock widget handle or @c NULL, on errors
5745     *
5746     * This function inserts a new clock widget on the canvas.
5747     *
5748     * @ingroup Clock
5749     */
5750    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5751
5752    /**
5753     * Set a clock widget's time, programmatically
5754     *
5755     * @param obj The clock widget object
5756     * @param hrs The hours to set
5757     * @param min The minutes to set
5758     * @param sec The secondes to set
5759     *
5760     * This function updates the time that is showed by the clock
5761     * widget.
5762     *
5763     *  Values @b must be set within the following ranges:
5764     * - 0 - 23, for hours
5765     * - 0 - 59, for minutes
5766     * - 0 - 59, for seconds,
5767     *
5768     * even if the clock is not in "military" mode.
5769     *
5770     * @warning The behavior for values set out of those ranges is @b
5771     * indefined.
5772     *
5773     * @ingroup Clock
5774     */
5775    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
5776
5777    /**
5778     * Get a clock widget's time values
5779     *
5780     * @param obj The clock object
5781     * @param[out] hrs Pointer to the variable to get the hours value
5782     * @param[out] min Pointer to the variable to get the minutes value
5783     * @param[out] sec Pointer to the variable to get the seconds value
5784     *
5785     * This function gets the time set for @p obj, returning
5786     * it on the variables passed as the arguments to function
5787     *
5788     * @note Use @c NULL pointers on the time values you're not
5789     * interested in: they'll be ignored by the function.
5790     *
5791     * @ingroup Clock
5792     */
5793    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
5794
5795    /**
5796     * Set whether a given clock widget is under <b>edition mode</b> or
5797     * under (default) displaying-only mode.
5798     *
5799     * @param obj The clock object
5800     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
5801     * put it back to "displaying only" mode
5802     *
5803     * This function makes a clock's time to be editable or not <b>by
5804     * user interaction</b>. When in edition mode, clocks @b stop
5805     * ticking, until one brings them back to canonical mode. The
5806     * elm_clock_digit_edit_set() function will influence which digits
5807     * of the clock will be editable. By default, all of them will be
5808     * (#ELM_CLOCK_NONE).
5809     *
5810     * @note am/pm sheets, if being shown, will @b always be editable
5811     * under edition mode.
5812     *
5813     * @see elm_clock_edit_get()
5814     *
5815     * @ingroup Clock
5816     */
5817    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
5818
5819    /**
5820     * Retrieve whether a given clock widget is under <b>edition
5821     * mode</b> or under (default) displaying-only mode.
5822     *
5823     * @param obj The clock object
5824     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
5825     * otherwise
5826     *
5827     * This function retrieves whether the clock's time can be edited
5828     * or not by user interaction.
5829     *
5830     * @see elm_clock_edit_set() for more details
5831     *
5832     * @ingroup Clock
5833     */
5834    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5835
5836    /**
5837     * Set what digits of the given clock widget should be editable
5838     * when in edition mode.
5839     *
5840     * @param obj The clock object
5841     * @param digedit Bit mask indicating the digits to be editable
5842     * (values in #Elm_Clock_Digedit).
5843     *
5844     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
5845     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
5846     * EINA_FALSE).
5847     *
5848     * @see elm_clock_digit_edit_get()
5849     *
5850     * @ingroup Clock
5851     */
5852    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
5853
5854    /**
5855     * Retrieve what digits of the given clock widget should be
5856     * editable when in edition mode.
5857     *
5858     * @param obj The clock object
5859     * @return Bit mask indicating the digits to be editable
5860     * (values in #Elm_Clock_Digedit).
5861     *
5862     * @see elm_clock_digit_edit_set() for more details
5863     *
5864     * @ingroup Clock
5865     */
5866    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5867
5868    /**
5869     * Set if the given clock widget must show hours in military or
5870     * am/pm mode
5871     *
5872     * @param obj The clock object
5873     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
5874     * to military mode
5875     *
5876     * This function sets if the clock must show hours in military or
5877     * am/pm mode. In some countries like Brazil the military mode
5878     * (00-24h-format) is used, in opposition to the USA, where the
5879     * am/pm mode is more commonly used.
5880     *
5881     * @see elm_clock_show_am_pm_get()
5882     *
5883     * @ingroup Clock
5884     */
5885    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
5886
5887    /**
5888     * Get if the given clock widget shows hours in military or am/pm
5889     * mode
5890     *
5891     * @param obj The clock object
5892     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
5893     * military
5894     *
5895     * This function gets if the clock shows hours in military or am/pm
5896     * mode.
5897     *
5898     * @see elm_clock_show_am_pm_set() for more details
5899     *
5900     * @ingroup Clock
5901     */
5902    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5903
5904    /**
5905     * Set if the given clock widget must show time with seconds or not
5906     *
5907     * @param obj The clock object
5908     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
5909     *
5910     * This function sets if the given clock must show or not elapsed
5911     * seconds. By default, they are @b not shown.
5912     *
5913     * @see elm_clock_show_seconds_get()
5914     *
5915     * @ingroup Clock
5916     */
5917    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
5918
5919    /**
5920     * Get whether the given clock widget is showing time with seconds
5921     * or not
5922     *
5923     * @param obj The clock object
5924     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
5925     *
5926     * This function gets whether @p obj is showing or not the elapsed
5927     * seconds.
5928     *
5929     * @see elm_clock_show_seconds_set()
5930     *
5931     * @ingroup Clock
5932     */
5933    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5934
5935    /**
5936     * Set the interval on time updates for an user mouse button hold
5937     * on clock widgets' time edition.
5938     *
5939     * @param obj The clock object
5940     * @param interval The (first) interval value in seconds
5941     *
5942     * This interval value is @b decreased while the user holds the
5943     * mouse pointer either incrementing or decrementing a given the
5944     * clock digit's value.
5945     *
5946     * This helps the user to get to a given time distant from the
5947     * current one easier/faster, as it will start to flip quicker and
5948     * quicker on mouse button holds.
5949     *
5950     * The calculation for the next flip interval value, starting from
5951     * the one set with this call, is the previous interval divided by
5952     * 1.05, so it decreases a little bit.
5953     *
5954     * The default starting interval value for automatic flips is
5955     * @b 0.85 seconds.
5956     *
5957     * @see elm_clock_interval_get()
5958     *
5959     * @ingroup Clock
5960     */
5961    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5962
5963    /**
5964     * Get the interval on time updates for an user mouse button hold
5965     * on clock widgets' time edition.
5966     *
5967     * @param obj The clock object
5968     * @return The (first) interval value, in seconds, set on it
5969     *
5970     * @see elm_clock_interval_set() for more details
5971     *
5972     * @ingroup Clock
5973     */
5974    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5975
5976    /**
5977     * @}
5978     */
5979
5980    /**
5981     * @defgroup Layout Layout
5982     *
5983     * @image html img/widget/layout/preview-00.png
5984     * @image latex img/widget/layout/preview-00.eps width=\textwidth
5985     *
5986     * @image html img/layout-predefined.png
5987     * @image latex img/layout-predefined.eps width=\textwidth
5988     *
5989     * This is a container widget that takes a standard Edje design file and
5990     * wraps it very thinly in a widget.
5991     *
5992     * An Edje design (theme) file has a very wide range of possibilities to
5993     * describe the behavior of elements added to the Layout. Check out the Edje
5994     * documentation and the EDC reference to get more information about what can
5995     * be done with Edje.
5996     *
5997     * Just like @ref List, @ref Box, and other container widgets, any
5998     * object added to the Layout will become its child, meaning that it will be
5999     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
6000     *
6001     * The Layout widget can contain as many Contents, Boxes or Tables as
6002     * described in its theme file. For instance, objects can be added to
6003     * different Tables by specifying the respective Table part names. The same
6004     * is valid for Content and Box.
6005     *
6006     * The objects added as child of the Layout will behave as described in the
6007     * part description where they were added. There are 3 possible types of
6008     * parts where a child can be added:
6009     *
6010     * @section secContent Content (SWALLOW part)
6011     *
6012     * Only one object can be added to the @c SWALLOW part (but you still can
6013     * have many @c SWALLOW parts and one object on each of them). Use the @c
6014     * elm_layout_content_* set of functions to set, retrieve and unset objects
6015     * as content of the @c SWALLOW. After being set to this part, the object
6016     * size, position, visibility, clipping and other description properties
6017     * will be totally controled by the description of the given part (inside
6018     * the Edje theme file).
6019     *
6020     * One can use @c evas_object_size_hint_* functions on the child to have some
6021     * kind of control over its behavior, but the resulting behavior will still
6022     * depend heavily on the @c SWALLOW part description.
6023     *
6024     * The Edje theme also can change the part description, based on signals or
6025     * scripts running inside the theme. This change can also be animated. All of
6026     * this will affect the child object set as content accordingly. The object
6027     * size will be changed if the part size is changed, it will animate move if
6028     * the part is moving, and so on.
6029     *
6030     * The following picture demonstrates a Layout widget with a child object
6031     * added to its @c SWALLOW:
6032     *
6033     * @image html layout_swallow.png
6034     * @image latex layout_swallow.png width=\textwidth
6035     *
6036     * @section secBox Box (BOX part)
6037     *
6038     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
6039     * allows one to add objects to the box and have them distributed along its
6040     * area, accordingly to the specified @a layout property (now by @a layout we
6041     * mean the chosen layouting design of the Box, not the Layout widget
6042     * itself).
6043     *
6044     * A similar effect for having a box with its position, size and other things
6045     * controled by the Layout theme would be to create an Elementary @ref Box
6046     * widget and add it as a Content in the @c SWALLOW part.
6047     *
6048     * The main difference of using the Layout Box is that its behavior, the box
6049     * properties like layouting format, padding, align, etc. will be all
6050     * controled by the theme. This means, for example, that a signal could be
6051     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
6052     * handled the signal by changing the box padding, or align, or both. Using
6053     * the Elementary @ref Box widget is not necessarily harder or easier, it
6054     * just depends on the circunstances and requirements.
6055     *
6056     * The Layout Box can be used through the @c elm_layout_box_* set of
6057     * functions.
6058     *
6059     * The following picture demonstrates a Layout widget with many child objects
6060     * added to its @c BOX part:
6061     *
6062     * @image html layout_box.png
6063     * @image latex layout_box.png width=\textwidth
6064     *
6065     * @section secTable Table (TABLE part)
6066     *
6067     * Just like the @ref secBox, the Layout Table is very similar to the
6068     * Elementary @ref Table widget. It allows one to add objects to the Table
6069     * specifying the row and column where the object should be added, and any
6070     * column or row span if necessary.
6071     *
6072     * Again, we could have this design by adding a @ref Table widget to the @c
6073     * SWALLOW part using elm_layout_content_set(). The same difference happens
6074     * here when choosing to use the Layout Table (a @c TABLE part) instead of
6075     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
6076     *
6077     * The Layout Table can be used through the @c elm_layout_table_* set of
6078     * functions.
6079     *
6080     * The following picture demonstrates a Layout widget with many child objects
6081     * added to its @c TABLE part:
6082     *
6083     * @image html layout_table.png
6084     * @image latex layout_table.png width=\textwidth
6085     *
6086     * @section secPredef Predefined Layouts
6087     *
6088     * Another interesting thing about the Layout widget is that it offers some
6089     * predefined themes that come with the default Elementary theme. These
6090     * themes can be set by the call elm_layout_theme_set(), and provide some
6091     * basic functionality depending on the theme used.
6092     *
6093     * Most of them already send some signals, some already provide a toolbar or
6094     * back and next buttons.
6095     *
6096     * These are available predefined theme layouts. All of them have class = @c
6097     * layout, group = @c application, and style = one of the following options:
6098     *
6099     * @li @c toolbar-content - application with toolbar and main content area
6100     * @li @c toolbar-content-back - application with toolbar and main content
6101     * area with a back button and title area
6102     * @li @c toolbar-content-back-next - application with toolbar and main
6103     * content area with a back and next buttons and title area
6104     * @li @c content-back - application with a main content area with a back
6105     * button and title area
6106     * @li @c content-back-next - application with a main content area with a
6107     * back and next buttons and title area
6108     * @li @c toolbar-vbox - application with toolbar and main content area as a
6109     * vertical box
6110     * @li @c toolbar-table - application with toolbar and main content area as a
6111     * table
6112     *
6113     * @section secExamples Examples
6114     *
6115     * Some examples of the Layout widget can be found here:
6116     * @li @ref layout_example_01
6117     * @li @ref layout_example_02
6118     * @li @ref layout_example_03
6119     * @li @ref layout_example_edc
6120     *
6121     */
6122
6123    /**
6124     * Add a new layout to the parent
6125     *
6126     * @param parent The parent object
6127     * @return The new object or NULL if it cannot be created
6128     *
6129     * @see elm_layout_file_set()
6130     * @see elm_layout_theme_set()
6131     *
6132     * @ingroup Layout
6133     */
6134    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6135    /**
6136     * Set the file that will be used as layout
6137     *
6138     * @param obj The layout object
6139     * @param file The path to file (edj) that will be used as layout
6140     * @param group The group that the layout belongs in edje file
6141     *
6142     * @return (1 = success, 0 = error)
6143     *
6144     * @ingroup Layout
6145     */
6146    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
6147    /**
6148     * Set the edje group from the elementary theme that will be used as layout
6149     *
6150     * @param obj The layout object
6151     * @param clas the clas of the group
6152     * @param group the group
6153     * @param style the style to used
6154     *
6155     * @return (1 = success, 0 = error)
6156     *
6157     * @ingroup Layout
6158     */
6159    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
6160    /**
6161     * Set the layout content.
6162     *
6163     * @param obj The layout object
6164     * @param swallow The swallow part name in the edje file
6165     * @param content The child that will be added in this layout object
6166     *
6167     * Once the content object is set, a previously set one will be deleted.
6168     * If you want to keep that old content object, use the
6169     * elm_layout_content_unset() function.
6170     *
6171     * @note In an Edje theme, the part used as a content container is called @c
6172     * SWALLOW. This is why the parameter name is called @p swallow, but it is
6173     * expected to be a part name just like the second parameter of
6174     * elm_layout_box_append().
6175     *
6176     * @see elm_layout_box_append()
6177     * @see elm_layout_content_get()
6178     * @see elm_layout_content_unset()
6179     * @see @ref secBox
6180     *
6181     * @ingroup Layout
6182     */
6183    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
6184    /**
6185     * Get the child object in the given content part.
6186     *
6187     * @param obj The layout object
6188     * @param swallow The SWALLOW part to get its content
6189     *
6190     * @return The swallowed object or NULL if none or an error occurred
6191     *
6192     * @see elm_layout_content_set()
6193     *
6194     * @ingroup Layout
6195     */
6196    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6197    /**
6198     * Unset the layout content.
6199     *
6200     * @param obj The layout object
6201     * @param swallow The swallow part name in the edje file
6202     * @return The content that was being used
6203     *
6204     * Unparent and return the content object which was set for this part.
6205     *
6206     * @see elm_layout_content_set()
6207     *
6208     * @ingroup Layout
6209     */
6210    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6211    /**
6212     * Set the text of the given part
6213     *
6214     * @param obj The layout object
6215     * @param part The TEXT part where to set the text
6216     * @param text The text to set
6217     *
6218     * @ingroup Layout
6219     * @deprecated use elm_object_text_* instead.
6220     */
6221    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
6222    /**
6223     * Get the text set in the given part
6224     *
6225     * @param obj The layout object
6226     * @param part The TEXT part to retrieve the text off
6227     *
6228     * @return The text set in @p part
6229     *
6230     * @ingroup Layout
6231     * @deprecated use elm_object_text_* instead.
6232     */
6233    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
6234    /**
6235     * Append child to layout box part.
6236     *
6237     * @param obj the layout object
6238     * @param part the box part to which the object will be appended.
6239     * @param child the child object to append to box.
6240     *
6241     * Once the object is appended, it will become child of the layout. Its
6242     * lifetime will be bound to the layout, whenever the layout dies the child
6243     * will be deleted automatically. One should use elm_layout_box_remove() to
6244     * make this layout forget about the object.
6245     *
6246     * @see elm_layout_box_prepend()
6247     * @see elm_layout_box_insert_before()
6248     * @see elm_layout_box_insert_at()
6249     * @see elm_layout_box_remove()
6250     *
6251     * @ingroup Layout
6252     */
6253    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
6254    /**
6255     * Prepend child to layout box part.
6256     *
6257     * @param obj the layout object
6258     * @param part the box part to prepend.
6259     * @param child the child object to prepend to box.
6260     *
6261     * Once the object is prepended, it will become child of the layout. Its
6262     * lifetime will be bound to the layout, whenever the layout dies the child
6263     * will be deleted automatically. One should use elm_layout_box_remove() to
6264     * make this layout forget about the object.
6265     *
6266     * @see elm_layout_box_append()
6267     * @see elm_layout_box_insert_before()
6268     * @see elm_layout_box_insert_at()
6269     * @see elm_layout_box_remove()
6270     *
6271     * @ingroup Layout
6272     */
6273    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
6274    /**
6275     * Insert child to layout box part before a reference object.
6276     *
6277     * @param obj the layout object
6278     * @param part the box part to insert.
6279     * @param child the child object to insert into box.
6280     * @param reference another reference object to insert before in box.
6281     *
6282     * Once the object is inserted, it will become child of the layout. Its
6283     * lifetime will be bound to the layout, whenever the layout dies the child
6284     * will be deleted automatically. One should use elm_layout_box_remove() to
6285     * make this layout forget about the object.
6286     *
6287     * @see elm_layout_box_append()
6288     * @see elm_layout_box_prepend()
6289     * @see elm_layout_box_insert_before()
6290     * @see elm_layout_box_remove()
6291     *
6292     * @ingroup Layout
6293     */
6294    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
6295    /**
6296     * Insert child to layout box part at a given position.
6297     *
6298     * @param obj the layout object
6299     * @param part the box part to insert.
6300     * @param child the child object to insert into box.
6301     * @param pos the numeric position >=0 to insert the child.
6302     *
6303     * Once the object is inserted, it will become child of the layout. Its
6304     * lifetime will be bound to the layout, whenever the layout dies the child
6305     * will be deleted automatically. One should use elm_layout_box_remove() to
6306     * make this layout forget about the object.
6307     *
6308     * @see elm_layout_box_append()
6309     * @see elm_layout_box_prepend()
6310     * @see elm_layout_box_insert_before()
6311     * @see elm_layout_box_remove()
6312     *
6313     * @ingroup Layout
6314     */
6315    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
6316    /**
6317     * Remove a child of the given part box.
6318     *
6319     * @param obj The layout object
6320     * @param part The box part name to remove child.
6321     * @param child The object to remove from box.
6322     * @return The object that was being used, or NULL if not found.
6323     *
6324     * The object will be removed from the box part and its lifetime will
6325     * not be handled by the layout anymore. This is equivalent to
6326     * elm_layout_content_unset() for box.
6327     *
6328     * @see elm_layout_box_append()
6329     * @see elm_layout_box_remove_all()
6330     *
6331     * @ingroup Layout
6332     */
6333    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
6334    /**
6335     * Remove all child of the given part box.
6336     *
6337     * @param obj The layout object
6338     * @param part The box part name to remove child.
6339     * @param clear If EINA_TRUE, then all objects will be deleted as
6340     *        well, otherwise they will just be removed and will be
6341     *        dangling on the canvas.
6342     *
6343     * The objects will be removed from the box part and their lifetime will
6344     * not be handled by the layout anymore. This is equivalent to
6345     * elm_layout_box_remove() for all box children.
6346     *
6347     * @see elm_layout_box_append()
6348     * @see elm_layout_box_remove()
6349     *
6350     * @ingroup Layout
6351     */
6352    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
6353    /**
6354     * Insert child to layout table part.
6355     *
6356     * @param obj the layout object
6357     * @param part the box part to pack child.
6358     * @param child_obj the child object to pack into table.
6359     * @param col the column to which the child should be added. (>= 0)
6360     * @param row the row to which the child should be added. (>= 0)
6361     * @param colspan how many columns should be used to store this object. (>=
6362     *        1)
6363     * @param rowspan how many rows should be used to store this object. (>= 1)
6364     *
6365     * Once the object is inserted, it will become child of the table. Its
6366     * lifetime will be bound to the layout, and whenever the layout dies the
6367     * child will be deleted automatically. One should use
6368     * elm_layout_table_remove() to make this layout forget about the object.
6369     *
6370     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
6371     * more space than a single cell. For instance, the following code:
6372     * @code
6373     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
6374     * @endcode
6375     *
6376     * Would result in an object being added like the following picture:
6377     *
6378     * @image html layout_colspan.png
6379     * @image latex layout_colspan.eps width=\textwidth
6380     *
6381     * @see elm_layout_table_unpack()
6382     * @see elm_layout_table_clear()
6383     *
6384     * @ingroup Layout
6385     */
6386    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);
6387    /**
6388     * Unpack (remove) a child of the given part table.
6389     *
6390     * @param obj The layout object
6391     * @param part The table part name to remove child.
6392     * @param child_obj The object to remove from table.
6393     * @return The object that was being used, or NULL if not found.
6394     *
6395     * The object will be unpacked from the table part and its lifetime
6396     * will not be handled by the layout anymore. This is equivalent to
6397     * elm_layout_content_unset() for table.
6398     *
6399     * @see elm_layout_table_pack()
6400     * @see elm_layout_table_clear()
6401     *
6402     * @ingroup Layout
6403     */
6404    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
6405    /**
6406     * Remove all child of the given part table.
6407     *
6408     * @param obj The layout object
6409     * @param part The table part name to remove child.
6410     * @param clear If EINA_TRUE, then all objects will be deleted as
6411     *        well, otherwise they will just be removed and will be
6412     *        dangling on the canvas.
6413     *
6414     * The objects will be removed from the table part and their lifetime will
6415     * not be handled by the layout anymore. This is equivalent to
6416     * elm_layout_table_unpack() for all table children.
6417     *
6418     * @see elm_layout_table_pack()
6419     * @see elm_layout_table_unpack()
6420     *
6421     * @ingroup Layout
6422     */
6423    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
6424    /**
6425     * Get the edje layout
6426     *
6427     * @param obj The layout object
6428     *
6429     * @return A Evas_Object with the edje layout settings loaded
6430     * with function elm_layout_file_set
6431     *
6432     * This returns the edje object. It is not expected to be used to then
6433     * swallow objects via edje_object_part_swallow() for example. Use
6434     * elm_layout_content_set() instead so child object handling and sizing is
6435     * done properly.
6436     *
6437     * @note This function should only be used if you really need to call some
6438     * low level Edje function on this edje object. All the common stuff (setting
6439     * text, emitting signals, hooking callbacks to signals, etc.) can be done
6440     * with proper elementary functions.
6441     *
6442     * @see elm_object_signal_callback_add()
6443     * @see elm_object_signal_emit()
6444     * @see elm_object_text_part_set()
6445     * @see elm_layout_content_set()
6446     * @see elm_layout_box_append()
6447     * @see elm_layout_table_pack()
6448     * @see elm_layout_data_get()
6449     *
6450     * @ingroup Layout
6451     */
6452    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6453    /**
6454     * Get the edje data from the given layout
6455     *
6456     * @param obj The layout object
6457     * @param key The data key
6458     *
6459     * @return The edje data string
6460     *
6461     * This function fetches data specified inside the edje theme of this layout.
6462     * This function return NULL if data is not found.
6463     *
6464     * In EDC this comes from a data block within the group block that @p
6465     * obj was loaded from. E.g.
6466     *
6467     * @code
6468     * collections {
6469     *   group {
6470     *     name: "a_group";
6471     *     data {
6472     *       item: "key1" "value1";
6473     *       item: "key2" "value2";
6474     *     }
6475     *   }
6476     * }
6477     * @endcode
6478     *
6479     * @ingroup Layout
6480     */
6481    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
6482    /**
6483     * Eval sizing
6484     *
6485     * @param obj The layout object
6486     *
6487     * Manually forces a sizing re-evaluation. This is useful when the minimum
6488     * size required by the edje theme of this layout has changed. The change on
6489     * the minimum size required by the edje theme is not immediately reported to
6490     * the elementary layout, so one needs to call this function in order to tell
6491     * the widget (layout) that it needs to reevaluate its own size.
6492     *
6493     * The minimum size of the theme is calculated based on minimum size of
6494     * parts, the size of elements inside containers like box and table, etc. All
6495     * of this can change due to state changes, and that's when this function
6496     * should be called.
6497     *
6498     * Also note that a standard signal of "size,eval" "elm" emitted from the
6499     * edje object will cause this to happen too.
6500     *
6501     * @ingroup Layout
6502     */
6503    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
6504    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
6505    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6506    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6507    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
6508    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6509    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);
6510    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6511 /**
6512  * @def elm_layout_icon_set
6513  * Convienience macro to set the icon object in a layout that follows the
6514  * Elementary naming convention for its parts.
6515  *
6516  * @ingroup Layout
6517  */
6518 #define elm_layout_icon_set(_ly, _obj) \
6519   do { \
6520     const char *sig; \
6521     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
6522     if ((_obj)) sig = "elm,state,icon,visible"; \
6523     else sig = "elm,state,icon,hidden"; \
6524     elm_object_signal_emit((_ly), sig, "elm"); \
6525   } while (0)
6526
6527 /**
6528  * @def elm_layout_icon_get
6529  * Convienience macro to get the icon object from a layout that follows the
6530  * Elementary naming convention for its parts.
6531  *
6532  * @ingroup Layout
6533  */
6534 #define elm_layout_icon_get(_ly) \
6535   elm_layout_content_get((_ly), "elm.swallow.icon")
6536
6537 /**
6538  * @def elm_layout_end_set
6539  * Convienience macro to set the end object in a layout that follows the
6540  * Elementary naming convention for its parts.
6541  *
6542  * @ingroup Layout
6543  */
6544 #define elm_layout_end_set(_ly, _obj) \
6545   do { \
6546     const char *sig; \
6547     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
6548     if ((_obj)) sig = "elm,state,end,visible"; \
6549     else sig = "elm,state,end,hidden"; \
6550     elm_object_signal_emit((_ly), sig, "elm"); \
6551   } while (0)
6552
6553 /**
6554  * @def elm_layout_end_get
6555  * Convienience macro to get the end object in a layout that follows the
6556  * Elementary naming convention for its parts.
6557  *
6558  * @ingroup Layout
6559  */
6560 #define elm_layout_end_get(_ly) \
6561   elm_layout_content_get((_ly), "elm.swallow.end")
6562
6563 /**
6564  * @def elm_layout_label_set
6565  * Convienience macro to set the label in a layout that follows the
6566  * Elementary naming convention for its parts.
6567  *
6568  * @ingroup Layout
6569  * @deprecate use elm_object_text_* instead.
6570  */
6571 #define elm_layout_label_set(_ly, _txt) \
6572   elm_layout_text_set((_ly), "elm.text", (_txt))
6573
6574 /**
6575  * @def elm_layout_label_get
6576  * Convienience macro to get the label in a layout that follows the
6577  * Elementary naming convention for its parts.
6578  *
6579  * @ingroup Layout
6580  * @deprecate use elm_object_text_* instead.
6581  */
6582 #define elm_layout_label_get(_ly) \
6583   elm_layout_text_get((_ly), "elm.text")
6584
6585    /* smart callbacks called:
6586     * "theme,changed" - when elm theme is changed.
6587     */
6588
6589    /* notify */
6590    typedef enum _Elm_Notify_Orient
6591      {
6592         ELM_NOTIFY_ORIENT_TOP,
6593         ELM_NOTIFY_ORIENT_CENTER,
6594         ELM_NOTIFY_ORIENT_BOTTOM,
6595         ELM_NOTIFY_ORIENT_LEFT,
6596         ELM_NOTIFY_ORIENT_RIGHT,
6597         ELM_NOTIFY_ORIENT_TOP_LEFT,
6598         ELM_NOTIFY_ORIENT_TOP_RIGHT,
6599         ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
6600         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
6601         ELM_NOTIFY_ORIENT_LAST
6602      } Elm_Notify_Orient;
6603    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6604    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6605    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6606    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6607    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6608    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6609    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
6610    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6611    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
6612    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6613    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
6614    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6615    /* smart callbacks called:
6616     * "timeout" - when timeout happens on notify and it's hidden
6617     * "block,clicked" - when it's hidden by a click outside of the notify's view
6618     */
6619
6620    /**
6621     * @defgroup Hover Hover
6622     *
6623     * @image html img/widget/hover/preview-00.png
6624     * @image latex img/widget/hover/preview-00.eps
6625     *
6626     * A Hover object will hover over its @p parent object at the @p target
6627     * location. Anything in the background will be given a darker coloring to
6628     * indicate that the hover object is on top (at the default theme). When the
6629     * hover is clicked it is dismissed(hidden), if the contents of the hover are
6630     * clicked that @b doesn't cause the hover to be dismissed.
6631     *
6632     * @note The hover object will take up the entire space of @p target
6633     * object.
6634     *
6635     * Elementary has the following styles for the hover widget:
6636     * @li default
6637     * @li popout
6638     * @li menu
6639     * @li hoversel_vertical
6640     *
6641     * The following are the available position for content:
6642     * @li left
6643     * @li top-left
6644     * @li top
6645     * @li top-right
6646     * @li right
6647     * @li bottom-right
6648     * @li bottom
6649     * @li bottom-left
6650     * @li middle
6651     * @li smart
6652     *
6653     * Signals that you can add callbacks for are:
6654     * @li "clicked" - the user clicked the empty space in the hover to dismiss
6655     * @li "smart,changed" - a content object placed under the "smart"
6656     *                   policy was replaced to a new slot direction.
6657     *
6658     * See @ref tutorial_hover for more information.
6659     *
6660     * @{
6661     */
6662    typedef enum _Elm_Hover_Axis
6663      {
6664         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
6665         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
6666         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
6667         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
6668      } Elm_Hover_Axis;
6669    /**
6670     * @brief Adds a hover object to @p parent
6671     *
6672     * @param parent The parent object
6673     * @return The hover object or NULL if one could not be created
6674     */
6675    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6676    /**
6677     * @brief Sets the target object for the hover.
6678     *
6679     * @param obj The hover object
6680     * @param target The object to center the hover onto. The hover
6681     *
6682     * This function will cause the hover to be centered on the target object.
6683     */
6684    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
6685    /**
6686     * @brief Gets the target object for the hover.
6687     *
6688     * @param obj The hover object
6689     * @param parent The object to locate the hover over.
6690     *
6691     * @see elm_hover_target_set()
6692     */
6693    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6694    /**
6695     * @brief Sets the parent object for the hover.
6696     *
6697     * @param obj The hover object
6698     * @param parent The object to locate the hover over.
6699     *
6700     * This function will cause the hover to take up the entire space that the
6701     * parent object fills.
6702     */
6703    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6704    /**
6705     * @brief Gets the parent object for the hover.
6706     *
6707     * @param obj The hover object
6708     * @return The parent object to locate the hover over.
6709     *
6710     * @see elm_hover_parent_set()
6711     */
6712    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6713    /**
6714     * @brief Sets the content of the hover object and the direction in which it
6715     * will pop out.
6716     *
6717     * @param obj The hover object
6718     * @param swallow The direction that the object will be displayed
6719     * at. Accepted values are "left", "top-left", "top", "top-right",
6720     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
6721     * "smart".
6722     * @param content The content to place at @p swallow
6723     *
6724     * Once the content object is set for a given direction, a previously
6725     * set one (on the same direction) will be deleted. If you want to
6726     * keep that old content object, use the elm_hover_content_unset()
6727     * function.
6728     *
6729     * All directions may have contents at the same time, except for
6730     * "smart". This is a special placement hint and its use case
6731     * independs of the calculations coming from
6732     * elm_hover_best_content_location_get(). Its use is for cases when
6733     * one desires only one hover content, but with a dinamic special
6734     * placement within the hover area. The content's geometry, whenever
6735     * it changes, will be used to decide on a best location not
6736     * extrapolating the hover's parent object view to show it in (still
6737     * being the hover's target determinant of its medium part -- move and
6738     * resize it to simulate finger sizes, for example). If one of the
6739     * directions other than "smart" are used, a previously content set
6740     * using it will be deleted, and vice-versa.
6741     */
6742    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
6743    /**
6744     * @brief Get the content of the hover object, in a given direction.
6745     *
6746     * Return the content object which was set for this widget in the
6747     * @p swallow direction.
6748     *
6749     * @param obj The hover object
6750     * @param swallow The direction that the object was display at.
6751     * @return The content that was being used
6752     *
6753     * @see elm_hover_content_set()
6754     */
6755    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6756    /**
6757     * @brief Unset the content of the hover object, in a given direction.
6758     *
6759     * Unparent and return the content object set at @p swallow direction.
6760     *
6761     * @param obj The hover object
6762     * @param swallow The direction that the object was display at.
6763     * @return The content that was being used.
6764     *
6765     * @see elm_hover_content_set()
6766     */
6767    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6768    /**
6769     * @brief Returns the best swallow location for content in the hover.
6770     *
6771     * @param obj The hover object
6772     * @param pref_axis The preferred orientation axis for the hover object to use
6773     * @return The edje location to place content into the hover or @c
6774     *         NULL, on errors.
6775     *
6776     * Best is defined here as the location at which there is the most available
6777     * space.
6778     *
6779     * @p pref_axis may be one of
6780     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
6781     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
6782     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
6783     * - @c ELM_HOVER_AXIS_BOTH -- both
6784     *
6785     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
6786     * nescessarily be along the horizontal axis("left" or "right"). If
6787     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
6788     * be along the vertical axis("top" or "bottom"). Chossing
6789     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
6790     * returned position may be in either axis.
6791     *
6792     * @see elm_hover_content_set()
6793     */
6794    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
6795    /**
6796     * @}
6797     */
6798
6799    /* entry */
6800    /**
6801     * @defgroup Entry Entry
6802     *
6803     * @image html img/widget/entry/preview-00.png
6804     * @image latex img/widget/entry/preview-00.eps width=\textwidth
6805     * @image html img/widget/entry/preview-01.png
6806     * @image latex img/widget/entry/preview-01.eps width=\textwidth
6807     * @image html img/widget/entry/preview-02.png
6808     * @image latex img/widget/entry/preview-02.eps width=\textwidth
6809     * @image html img/widget/entry/preview-03.png
6810     * @image latex img/widget/entry/preview-03.eps width=\textwidth
6811     *
6812     * An entry is a convenience widget which shows a box that the user can
6813     * enter text into. Entries by default don't scroll, so they grow to
6814     * accomodate the entire text, resizing the parent window as needed. This
6815     * can be changed with the elm_entry_scrollable_set() function.
6816     *
6817     * They can also be single line or multi line (the default) and when set
6818     * to multi line mode they support text wrapping in any of the modes
6819     * indicated by #Elm_Wrap_Type.
6820     *
6821     * Other features include password mode, filtering of inserted text with
6822     * elm_entry_text_filter_append() and related functions, inline "items" and
6823     * formatted markup text.
6824     *
6825     * @section entry-markup Formatted text
6826     *
6827     * The markup tags supported by the Entry are defined by the theme, but
6828     * even when writing new themes or extensions it's a good idea to stick to
6829     * a sane default, to maintain coherency and avoid application breakages.
6830     * Currently defined by the default theme are the following tags:
6831     * @li \<br\>: Inserts a line break.
6832     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
6833     * breaks.
6834     * @li \<tab\>: Inserts a tab.
6835     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
6836     * enclosed text.
6837     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
6838     * @li \<link\>...\</link\>: Underlines the enclosed text.
6839     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
6840     *
6841     * @section entry-special Special markups
6842     *
6843     * Besides those used to format text, entries support two special markup
6844     * tags used to insert clickable portions of text or items inlined within
6845     * the text.
6846     *
6847     * @subsection entry-anchors Anchors
6848     *
6849     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
6850     * \</a\> tags and an event will be generated when this text is clicked,
6851     * like this:
6852     *
6853     * @code
6854     * This text is outside <a href=anc-01>but this one is an anchor</a>
6855     * @endcode
6856     *
6857     * The @c href attribute in the opening tag gives the name that will be
6858     * used to identify the anchor and it can be any valid utf8 string.
6859     *
6860     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
6861     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
6862     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
6863     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
6864     * an anchor.
6865     *
6866     * @subsection entry-items Items
6867     *
6868     * Inlined in the text, any other @c Evas_Object can be inserted by using
6869     * \<item\> tags this way:
6870     *
6871     * @code
6872     * <item size=16x16 vsize=full href=emoticon/haha></item>
6873     * @endcode
6874     *
6875     * Just like with anchors, the @c href identifies each item, but these need,
6876     * in addition, to indicate their size, which is done using any one of
6877     * @c size, @c absize or @c relsize attributes. These attributes take their
6878     * value in the WxH format, where W is the width and H the height of the
6879     * item.
6880     *
6881     * @li absize: Absolute pixel size for the item. Whatever value is set will
6882     * be the item's size regardless of any scale value the object may have
6883     * been set to. The final line height will be adjusted to fit larger items.
6884     * @li size: Similar to @c absize, but it's adjusted to the scale value set
6885     * for the object.
6886     * @li relsize: Size is adjusted for the item to fit within the current
6887     * line height.
6888     *
6889     * Besides their size, items are specificed a @c vsize value that affects
6890     * how their final size and position are calculated. The possible values
6891     * are:
6892     * @li ascent: Item will be placed within the line's baseline and its
6893     * ascent. That is, the height between the line where all characters are
6894     * positioned and the highest point in the line. For @c size and @c absize
6895     * items, the descent value will be added to the total line height to make
6896     * them fit. @c relsize items will be adjusted to fit within this space.
6897     * @li full: Items will be placed between the descent and ascent, or the
6898     * lowest point in the line and its highest.
6899     *
6900     * After the size for an item is calculated, the entry will request an
6901     * object to place in its space. For this, the functions set with
6902     * elm_entry_item_provider_append() and related functions will be called
6903     * in order until one of them returns a @c non-NULL value. If no providers
6904     * are available, or all of them return @c NULL, then the entry falls back
6905     * to one of the internal defaults, provided the name matches with one of
6906     * them.
6907     *
6908     * All of the following are currently supported:
6909     *
6910     * - emoticon/angry
6911     * - emoticon/angry-shout
6912     * - emoticon/crazy-laugh
6913     * - emoticon/evil-laugh
6914     * - emoticon/evil
6915     * - emoticon/goggle-smile
6916     * - emoticon/grumpy
6917     * - emoticon/grumpy-smile
6918     * - emoticon/guilty
6919     * - emoticon/guilty-smile
6920     * - emoticon/haha
6921     * - emoticon/half-smile
6922     * - emoticon/happy-panting
6923     * - emoticon/happy
6924     * - emoticon/indifferent
6925     * - emoticon/kiss
6926     * - emoticon/knowing-grin
6927     * - emoticon/laugh
6928     * - emoticon/little-bit-sorry
6929     * - emoticon/love-lots
6930     * - emoticon/love
6931     * - emoticon/minimal-smile
6932     * - emoticon/not-happy
6933     * - emoticon/not-impressed
6934     * - emoticon/omg
6935     * - emoticon/opensmile
6936     * - emoticon/smile
6937     * - emoticon/sorry
6938     * - emoticon/squint-laugh
6939     * - emoticon/surprised
6940     * - emoticon/suspicious
6941     * - emoticon/tongue-dangling
6942     * - emoticon/tongue-poke
6943     * - emoticon/uh
6944     * - emoticon/unhappy
6945     * - emoticon/very-sorry
6946     * - emoticon/what
6947     * - emoticon/wink
6948     * - emoticon/worried
6949     * - emoticon/wtf
6950     *
6951     * Alternatively, an item may reference an image by its path, using
6952     * the URI form @c file:///path/to/an/image.png and the entry will then
6953     * use that image for the item.
6954     *
6955     * @section entry-files Loading and saving files
6956     *
6957     * Entries have convinience functions to load text from a file and save
6958     * changes back to it after a short delay. The automatic saving is enabled
6959     * by default, but can be disabled with elm_entry_autosave_set() and files
6960     * can be loaded directly as plain text or have any markup in them
6961     * recognized. See elm_entry_file_set() for more details.
6962     *
6963     * @section entry-signals Emitted signals
6964     *
6965     * This widget emits the following signals:
6966     *
6967     * @li "changed": The text within the entry was changed.
6968     * @li "activated": The enter key was pressed on a single line entry.
6969     * @li "press": A mouse button has been pressed on the entry.
6970     * @li "longpressed": A mouse button has been pressed and held for a couple
6971     * seconds.
6972     * @li "clicked": The entry has been clicked (mouse press and release).
6973     * @li "clicked,double": The entry has been double clicked.
6974     * @li "clicked,triple": The entry has been triple clicked.
6975     * @li "focused": The entry has received focus.
6976     * @li "unfocused": The entry has lost focus.
6977     * @li "selection,paste": A paste of the clipboard contents was requested.
6978     * @li "selection,copy": A copy of the selected text into the clipboard was
6979     * requested.
6980     * @li "selection,cut": A cut of the selected text into the clipboard was
6981     * requested.
6982     * @li "selection,start": A selection has begun and no previous selection
6983     * existed.
6984     * @li "selection,changed": The current selection has changed.
6985     * @li "selection,cleared": The current selection has been cleared.
6986     * @li "cursor,changed": The cursor has changed position.
6987     * @li "anchor,clicked": An anchor has been clicked. The event_info
6988     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6989     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
6990     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6991     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
6992     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6993     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
6994     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6995     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
6996     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6997     * @li "preedit,changed": The preedit string has changed.
6998     *
6999     * @{
7000     */
7001    /**
7002     * @typedef Elm_Entry_Anchor_Info
7003     *
7004     * The info sent in the callback for the "anchor,clicked" signals emitted
7005     * by entries.
7006     */
7007    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
7008    /**
7009     * @struct _Elm_Entry_Anchor_Info
7010     *
7011     * The info sent in the callback for the "anchor,clicked" signals emitted
7012     * by entries.
7013     */
7014    struct _Elm_Entry_Anchor_Info
7015      {
7016         const char *name; /**< The name of the anchor, as stated in its href */
7017         int         button; /**< The mouse button used to click on it */
7018         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
7019                     y, /**< Anchor geometry, relative to canvas */
7020                     w, /**< Anchor geometry, relative to canvas */
7021                     h; /**< Anchor geometry, relative to canvas */
7022      };
7023    /**
7024     * @typedef Elm_Entry_Filter_Cb
7025     * This callback type is used by entry filters to modify text.
7026     * @param data The data specified as the last param when adding the filter
7027     * @param entry The entry object
7028     * @param text A pointer to the location of the text being filtered. This data can be modified,
7029     * but any additional allocations must be managed by the user.
7030     * @see elm_entry_text_filter_append
7031     * @see elm_entry_text_filter_prepend
7032     */
7033    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
7034
7035    /**
7036     * This adds an entry to @p parent object.
7037     *
7038     * By default, entries are:
7039     * @li not scrolled
7040     * @li multi-line
7041     * @li word wrapped
7042     * @li autosave is enabled
7043     *
7044     * @param parent The parent object
7045     * @return The new object or NULL if it cannot be created
7046     */
7047    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7048    /**
7049     * Sets the entry to single line mode.
7050     *
7051     * In single line mode, entries don't ever wrap when the text reaches the
7052     * edge, and instead they keep growing horizontally. Pressing the @c Enter
7053     * key will generate an @c "activate" event instead of adding a new line.
7054     *
7055     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
7056     * and pressing enter will break the text into a different line
7057     * without generating any events.
7058     *
7059     * @param obj The entry object
7060     * @param single_line If true, the text in the entry
7061     * will be on a single line.
7062     */
7063    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
7064    /**
7065     * Gets whether the entry is set to be single line.
7066     *
7067     * @param obj The entry object
7068     * @return single_line If true, the text in the entry is set to display
7069     * on a single line.
7070     *
7071     * @see elm_entry_single_line_set()
7072     */
7073    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7074    /**
7075     * Sets the entry to password mode.
7076     *
7077     * In password mode, entries are implicitly single line and the display of
7078     * any text in them is replaced with asterisks (*).
7079     *
7080     * @param obj The entry object
7081     * @param password If true, password mode is enabled.
7082     */
7083    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
7084    /**
7085     * Gets whether the entry is set to password mode.
7086     *
7087     * @param obj The entry object
7088     * @return If true, the entry is set to display all characters
7089     * as asterisks (*).
7090     *
7091     * @see elm_entry_password_set()
7092     */
7093    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7094    /**
7095     * This sets the text displayed within the entry to @p entry.
7096     *
7097     * @param obj The entry object
7098     * @param entry The text to be displayed
7099     *
7100     * @deprecated Use elm_object_text_set() instead.
7101     */
7102    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
7103    /**
7104     * This returns the text currently shown in object @p entry.
7105     * See also elm_entry_entry_set().
7106     *
7107     * @param obj The entry object
7108     * @return The currently displayed text or NULL on failure
7109     *
7110     * @deprecated Use elm_object_text_get() instead.
7111     */
7112    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7113    /**
7114     * Appends @p entry to the text of the entry.
7115     *
7116     * Adds the text in @p entry to the end of any text already present in the
7117     * widget.
7118     *
7119     * The appended text is subject to any filters set for the widget.
7120     *
7121     * @param obj The entry object
7122     * @param entry The text to be displayed
7123     *
7124     * @see elm_entry_text_filter_append()
7125     */
7126    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
7127    /**
7128     * Gets whether the entry is empty.
7129     *
7130     * Empty means no text at all. If there are any markup tags, like an item
7131     * tag for which no provider finds anything, and no text is displayed, this
7132     * function still returns EINA_FALSE.
7133     *
7134     * @param obj The entry object
7135     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
7136     */
7137    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7138    /**
7139     * Gets any selected text within the entry.
7140     *
7141     * If there's any selected text in the entry, this function returns it as
7142     * a string in markup format. NULL is returned if no selection exists or
7143     * if an error occurred.
7144     *
7145     * The returned value points to an internal string and should not be freed
7146     * or modified in any way. If the @p entry object is deleted or its
7147     * contents are changed, the returned pointer should be considered invalid.
7148     *
7149     * @param obj The entry object
7150     * @return The selected text within the entry or NULL on failure
7151     */
7152    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7153    /**
7154     * Inserts the given text into the entry at the current cursor position.
7155     *
7156     * This inserts text at the cursor position as if it was typed
7157     * by the user (note that this also allows markup which a user
7158     * can't just "type" as it would be converted to escaped text, so this
7159     * call can be used to insert things like emoticon items or bold push/pop
7160     * tags, other font and color change tags etc.)
7161     *
7162     * If any selection exists, it will be replaced by the inserted text.
7163     *
7164     * The inserted text is subject to any filters set for the widget.
7165     *
7166     * @param obj The entry object
7167     * @param entry The text to insert
7168     *
7169     * @see elm_entry_text_filter_append()
7170     */
7171    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
7172    /**
7173     * Set the line wrap type to use on multi-line entries.
7174     *
7175     * Sets the wrap type used by the entry to any of the specified in
7176     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
7177     * line (without inserting a line break or paragraph separator) when it
7178     * reaches the far edge of the widget.
7179     *
7180     * Note that this only makes sense for multi-line entries. A widget set
7181     * to be single line will never wrap.
7182     *
7183     * @param obj The entry object
7184     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
7185     */
7186    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7187    /**
7188     * Gets the wrap mode the entry was set to use.
7189     *
7190     * @param obj The entry object
7191     * @return Wrap type
7192     *
7193     * @see also elm_entry_line_wrap_set()
7194     */
7195    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7196    /**
7197     * Sets if the entry is to be editable or not.
7198     *
7199     * By default, entries are editable and when focused, any text input by the
7200     * user will be inserted at the current cursor position. But calling this
7201     * function with @p editable as EINA_FALSE will prevent the user from
7202     * inputting text into the entry.
7203     *
7204     * The only way to change the text of a non-editable entry is to use
7205     * elm_object_text_set(), elm_entry_entry_insert() and other related
7206     * functions.
7207     *
7208     * @param obj The entry object
7209     * @param editable If EINA_TRUE, user input will be inserted in the entry,
7210     * if not, the entry is read-only and no user input is allowed.
7211     */
7212    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
7213    /**
7214     * Gets whether the entry is editable or not.
7215     *
7216     * @param obj The entry object
7217     * @return If true, the entry is editable by the user.
7218     * If false, it is not editable by the user
7219     *
7220     * @see elm_entry_editable_set()
7221     */
7222    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7223    /**
7224     * This drops any existing text selection within the entry.
7225     *
7226     * @param obj The entry object
7227     */
7228    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
7229    /**
7230     * This selects all text within the entry.
7231     *
7232     * @param obj The entry object
7233     */
7234    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
7235    /**
7236     * This moves the cursor one place to the right within the entry.
7237     *
7238     * @param obj The entry object
7239     * @return EINA_TRUE upon success, EINA_FALSE upon failure
7240     */
7241    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
7242    /**
7243     * This moves the cursor one place to the left within the entry.
7244     *
7245     * @param obj The entry object
7246     * @return EINA_TRUE upon success, EINA_FALSE upon failure
7247     */
7248    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
7249    /**
7250     * This moves the cursor one line up within the entry.
7251     *
7252     * @param obj The entry object
7253     * @return EINA_TRUE upon success, EINA_FALSE upon failure
7254     */
7255    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
7256    /**
7257     * This moves the cursor one line down within the entry.
7258     *
7259     * @param obj The entry object
7260     * @return EINA_TRUE upon success, EINA_FALSE upon failure
7261     */
7262    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
7263    /**
7264     * This moves the cursor to the beginning of the entry.
7265     *
7266     * @param obj The entry object
7267     */
7268    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7269    /**
7270     * This moves the cursor to the end of the entry.
7271     *
7272     * @param obj The entry object
7273     */
7274    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7275    /**
7276     * This moves the cursor to the beginning of the current line.
7277     *
7278     * @param obj The entry object
7279     */
7280    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7281    /**
7282     * This moves the cursor to the end of the current line.
7283     *
7284     * @param obj The entry object
7285     */
7286    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7287    /**
7288     * This begins a selection within the entry as though
7289     * the user were holding down the mouse button to make a selection.
7290     *
7291     * @param obj The entry object
7292     */
7293    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
7294    /**
7295     * This ends a selection within the entry as though
7296     * the user had just released the mouse button while making a selection.
7297     *
7298     * @param obj The entry object
7299     */
7300    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
7301    /**
7302     * TODO: fill this in
7303     *
7304     * @param obj The entry object
7305     * @return TODO: fill this in
7306     */
7307    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7308    /**
7309     * This returns whether the cursor is visible.
7310     *
7311     * @param obj The entry object
7312     * @return If true, the cursor is visible.
7313     */
7314    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7315    /**
7316     * TODO: fill this in
7317     *
7318     * @param obj The entry object
7319     * @return TODO: fill this in
7320     */
7321    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7322    /**
7323     * This function returns the geometry of the cursor.
7324     *
7325     * It's useful if you want to draw something on the cursor (or where it is),
7326     * or for example in the case of scrolled entry where you want to show the
7327     * cursor.
7328     *
7329     * @param obj The entry object
7330     * @param x returned geometry
7331     * @param y returned geometry
7332     * @param w returned geometry
7333     * @param h returned geometry
7334     * @return EINA_TRUE upon success, EINA_FALSE upon failure
7335     */
7336    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);
7337    /**
7338     * Sets the cursor position in the entry to the given value
7339     *
7340     * @param obj The entry object
7341     * @param pos The position of the cursor
7342     */
7343    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7344    /**
7345     * Retrieves the current position of the cursor in the entry
7346     *
7347     * @param obj The entry object
7348     * @return The cursor position
7349     */
7350    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7351    /**
7352     * This executes a "cut" action on the selected text in the entry.
7353     *
7354     * @param obj The entry object
7355     */
7356    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
7357    /**
7358     * This executes a "copy" action on the selected text in the entry.
7359     *
7360     * @param obj The entry object
7361     */
7362    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
7363    /**
7364     * This executes a "paste" action in the entry.
7365     *
7366     * @param obj The entry object
7367     */
7368    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
7369    /**
7370     * This clears and frees the items in a entry's contextual (longpress)
7371     * menu.
7372     *
7373     * @param obj The entry object
7374     *
7375     * @see elm_entry_context_menu_item_add()
7376     */
7377    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7378    /**
7379     * This adds an item to the entry's contextual menu.
7380     *
7381     * A longpress on an entry will make the contextual menu show up, if this
7382     * hasn't been disabled with elm_entry_context_menu_disabled_set().
7383     * By default, this menu provides a few options like enabling selection mode,
7384     * which is useful on embedded devices that need to be explicit about it,
7385     * and when a selection exists it also shows the copy and cut actions.
7386     *
7387     * With this function, developers can add other options to this menu to
7388     * perform any action they deem necessary.
7389     *
7390     * @param obj The entry object
7391     * @param label The item's text label
7392     * @param icon_file The item's icon file
7393     * @param icon_type The item's icon type
7394     * @param func The callback to execute when the item is clicked
7395     * @param data The data to associate with the item for related functions
7396     */
7397    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);
7398    /**
7399     * This disables the entry's contextual (longpress) menu.
7400     *
7401     * @param obj The entry object
7402     * @param disabled If true, the menu is disabled
7403     */
7404    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7405    /**
7406     * This returns whether the entry's contextual (longpress) menu is
7407     * disabled.
7408     *
7409     * @param obj The entry object
7410     * @return If true, the menu is disabled
7411     */
7412    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7413    /**
7414     * This appends a custom item provider to the list for that entry
7415     *
7416     * This appends the given callback. The list is walked from beginning to end
7417     * with each function called given the item href string in the text. If the
7418     * function returns an object handle other than NULL (it should create an
7419     * object to do this), then this object is used to replace that item. If
7420     * not the next provider is called until one provides an item object, or the
7421     * default provider in entry does.
7422     *
7423     * @param obj The entry object
7424     * @param func The function called to provide the item object
7425     * @param data The data passed to @p func
7426     *
7427     * @see @ref entry-items
7428     */
7429    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);
7430    /**
7431     * This prepends a custom item provider to the list for that entry
7432     *
7433     * This prepends the given callback. See elm_entry_item_provider_append() for
7434     * more information
7435     *
7436     * @param obj The entry object
7437     * @param func The function called to provide the item object
7438     * @param data The data passed to @p func
7439     */
7440    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);
7441    /**
7442     * This removes a custom item provider to the list for that entry
7443     *
7444     * This removes the given callback. See elm_entry_item_provider_append() for
7445     * more information
7446     *
7447     * @param obj The entry object
7448     * @param func The function called to provide the item object
7449     * @param data The data passed to @p func
7450     */
7451    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);
7452    /**
7453     * Append a filter function for text inserted in the entry
7454     *
7455     * Append the given callback to the list. This functions will be called
7456     * whenever any text is inserted into the entry, with the text to be inserted
7457     * as a parameter. The callback function is free to alter the text in any way
7458     * it wants, but it must remember to free the given pointer and update it.
7459     * If the new text is to be discarded, the function can free it and set its
7460     * text parameter to NULL. This will also prevent any following filters from
7461     * being called.
7462     *
7463     * @param obj The entry object
7464     * @param func The function to use as text filter
7465     * @param data User data to pass to @p func
7466     */
7467    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
7468    /**
7469     * Prepend a filter function for text insdrted in the entry
7470     *
7471     * Prepend the given callback to the list. See elm_entry_text_filter_append()
7472     * for more information
7473     *
7474     * @param obj The entry object
7475     * @param func The function to use as text filter
7476     * @param data User data to pass to @p func
7477     */
7478    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
7479    /**
7480     * Remove a filter from the list
7481     *
7482     * Removes the given callback from the filter list. See
7483     * elm_entry_text_filter_append() for more information.
7484     *
7485     * @param obj The entry object
7486     * @param func The filter function to remove
7487     * @param data The user data passed when adding the function
7488     */
7489    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
7490    /**
7491     * This converts a markup (HTML-like) string into UTF-8.
7492     *
7493     * The returned string is a malloc'ed buffer and it should be freed when
7494     * not needed anymore.
7495     *
7496     * @param s The string (in markup) to be converted
7497     * @return The converted string (in UTF-8). It should be freed.
7498     */
7499    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
7500    /**
7501     * This converts a UTF-8 string into markup (HTML-like).
7502     *
7503     * The returned string is a malloc'ed buffer and it should be freed when
7504     * not needed anymore.
7505     *
7506     * @param s The string (in UTF-8) to be converted
7507     * @return The converted string (in markup). It should be freed.
7508     */
7509    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
7510    /**
7511     * This sets the file (and implicitly loads it) for the text to display and
7512     * then edit. All changes are written back to the file after a short delay if
7513     * the entry object is set to autosave (which is the default).
7514     *
7515     * If the entry had any other file set previously, any changes made to it
7516     * will be saved if the autosave feature is enabled, otherwise, the file
7517     * will be silently discarded and any non-saved changes will be lost.
7518     *
7519     * @param obj The entry object
7520     * @param file The path to the file to load and save
7521     * @param format The file format
7522     */
7523    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
7524    /**
7525     * Gets the file being edited by the entry.
7526     *
7527     * This function can be used to retrieve any file set on the entry for
7528     * edition, along with the format used to load and save it.
7529     *
7530     * @param obj The entry object
7531     * @param file The path to the file to load and save
7532     * @param format The file format
7533     */
7534    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
7535    /**
7536     * This function writes any changes made to the file set with
7537     * elm_entry_file_set()
7538     *
7539     * @param obj The entry object
7540     */
7541    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
7542    /**
7543     * This sets the entry object to 'autosave' the loaded text file or not.
7544     *
7545     * @param obj The entry object
7546     * @param autosave Autosave the loaded file or not
7547     *
7548     * @see elm_entry_file_set()
7549     */
7550    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
7551    /**
7552     * This gets the entry object's 'autosave' status.
7553     *
7554     * @param obj The entry object
7555     * @return Autosave the loaded file or not
7556     *
7557     * @see elm_entry_file_set()
7558     */
7559    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7560    /**
7561     * Control pasting of text and images for the widget.
7562     *
7563     * Normally the entry allows both text and images to be pasted.  By setting
7564     * textonly to be true, this prevents images from being pasted.
7565     *
7566     * Note this only changes the behaviour of text.
7567     *
7568     * @param obj The entry object
7569     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
7570     * text+image+other.
7571     */
7572    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
7573    /**
7574     * Getting elm_entry text paste/drop mode.
7575     *
7576     * In textonly mode, only text may be pasted or dropped into the widget.
7577     *
7578     * @param obj The entry object
7579     * @return If the widget only accepts text from pastes.
7580     */
7581    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7582    /**
7583     * Enable or disable scrolling in entry
7584     *
7585     * Normally the entry is not scrollable unless you enable it with this call.
7586     *
7587     * @param obj The entry object
7588     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
7589     */
7590    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
7591    /**
7592     * Get the scrollable state of the entry
7593     *
7594     * Normally the entry is not scrollable. This gets the scrollable state
7595     * of the entry. See elm_entry_scrollable_set() for more information.
7596     *
7597     * @param obj The entry object
7598     * @return The scrollable state
7599     */
7600    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
7601    /**
7602     * This sets a widget to be displayed to the left of a scrolled entry.
7603     *
7604     * @param obj The scrolled entry object
7605     * @param icon The widget to display on the left side of the scrolled
7606     * entry.
7607     *
7608     * @note A previously set widget will be destroyed.
7609     * @note If the object being set does not have minimum size hints set,
7610     * it won't get properly displayed.
7611     *
7612     * @see elm_entry_end_set()
7613     */
7614    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
7615    /**
7616     * Gets the leftmost widget of the scrolled entry. This object is
7617     * owned by the scrolled entry and should not be modified.
7618     *
7619     * @param obj The scrolled entry object
7620     * @return the left widget inside the scroller
7621     */
7622    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
7623    /**
7624     * Unset the leftmost widget of the scrolled entry, unparenting and
7625     * returning it.
7626     *
7627     * @param obj The scrolled entry object
7628     * @return the previously set icon sub-object of this entry, on
7629     * success.
7630     *
7631     * @see elm_entry_icon_set()
7632     */
7633    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
7634    /**
7635     * Sets the visibility of the left-side widget of the scrolled entry,
7636     * set by @elm_entry_icon_set().
7637     *
7638     * @param obj The scrolled entry object
7639     * @param setting EINA_TRUE if the object should be displayed,
7640     * EINA_FALSE if not.
7641     */
7642    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
7643    /**
7644     * This sets a widget to be displayed to the end of a scrolled entry.
7645     *
7646     * @param obj The scrolled entry object
7647     * @param end The widget to display on the right side of the scrolled
7648     * entry.
7649     *
7650     * @note A previously set widget will be destroyed.
7651     * @note If the object being set does not have minimum size hints set,
7652     * it won't get properly displayed.
7653     *
7654     * @see elm_entry_icon_set
7655     */
7656    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
7657    /**
7658     * Gets the endmost widget of the scrolled entry. This object is owned
7659     * by the scrolled entry and should not be modified.
7660     *
7661     * @param obj The scrolled entry object
7662     * @return the right widget inside the scroller
7663     */
7664    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
7665    /**
7666     * Unset the endmost widget of the scrolled entry, unparenting and
7667     * returning it.
7668     *
7669     * @param obj The scrolled entry object
7670     * @return the previously set icon sub-object of this entry, on
7671     * success.
7672     *
7673     * @see elm_entry_icon_set()
7674     */
7675    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
7676    /**
7677     * Sets the visibility of the end widget of the scrolled entry, set by
7678     * @elm_entry_end_set().
7679     *
7680     * @param obj The scrolled entry object
7681     * @param setting EINA_TRUE if the object should be displayed,
7682     * EINA_FALSE if not.
7683     */
7684    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
7685    /**
7686     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
7687     * them).
7688     *
7689     * Setting an entry to single-line mode with elm_entry_single_line_set()
7690     * will automatically disable the display of scrollbars when the entry
7691     * moves inside its scroller.
7692     *
7693     * @param obj The scrolled entry object
7694     * @param h The horizontal scrollbar policy to apply
7695     * @param v The vertical scrollbar policy to apply
7696     */
7697    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
7698    /**
7699     * This enables/disables bouncing within the entry.
7700     *
7701     * This function sets whether the entry will bounce when scrolling reaches
7702     * the end of the contained entry.
7703     *
7704     * @param obj The scrolled entry object
7705     * @param h The horizontal bounce state
7706     * @param v The vertical bounce state
7707     */
7708    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7709    /**
7710     * Get the bounce mode
7711     *
7712     * @param obj The Entry object
7713     * @param h_bounce Allow bounce horizontally
7714     * @param v_bounce Allow bounce vertically
7715     */
7716    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7717
7718    /* pre-made filters for entries */
7719    /**
7720     * @typedef Elm_Entry_Filter_Limit_Size
7721     *
7722     * Data for the elm_entry_filter_limit_size() entry filter.
7723     */
7724    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
7725    /**
7726     * @struct _Elm_Entry_Filter_Limit_Size
7727     *
7728     * Data for the elm_entry_filter_limit_size() entry filter.
7729     */
7730    struct _Elm_Entry_Filter_Limit_Size
7731      {
7732         int max_char_count; /**< The maximum number of characters allowed. */
7733         int max_byte_count; /**< The maximum number of bytes allowed*/
7734      };
7735    /**
7736     * Filter inserted text based on user defined character and byte limits
7737     *
7738     * Add this filter to an entry to limit the characters that it will accept
7739     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
7740     * The funtion works on the UTF-8 representation of the string, converting
7741     * it from the set markup, thus not accounting for any format in it.
7742     *
7743     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
7744     * it as data when setting the filter. In it, it's possible to set limits
7745     * by character count or bytes (any of them is disabled if 0), and both can
7746     * be set at the same time. In that case, it first checks for characters,
7747     * then bytes.
7748     *
7749     * The function will cut the inserted text in order to allow only the first
7750     * number of characters that are still allowed. The cut is made in
7751     * characters, even when limiting by bytes, in order to always contain
7752     * valid ones and avoid half unicode characters making it in.
7753     *
7754     * This filter, like any others, does not apply when setting the entry text
7755     * directly with elm_object_text_set() (or the deprecated
7756     * elm_entry_entry_set()).
7757     */
7758    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
7759    /**
7760     * @typedef Elm_Entry_Filter_Accept_Set
7761     *
7762     * Data for the elm_entry_filter_accept_set() entry filter.
7763     */
7764    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
7765    /**
7766     * @struct _Elm_Entry_Filter_Accept_Set
7767     *
7768     * Data for the elm_entry_filter_accept_set() entry filter.
7769     */
7770    struct _Elm_Entry_Filter_Accept_Set
7771      {
7772         const char *accepted; /**< Set of characters accepted in the entry. */
7773         const char *rejected; /**< Set of characters rejected from the entry. */
7774      };
7775    /**
7776     * Filter inserted text based on accepted or rejected sets of characters
7777     *
7778     * Add this filter to an entry to restrict the set of accepted characters
7779     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
7780     * This structure contains both accepted and rejected sets, but they are
7781     * mutually exclusive.
7782     *
7783     * The @c accepted set takes preference, so if it is set, the filter will
7784     * only work based on the accepted characters, ignoring anything in the
7785     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
7786     *
7787     * In both cases, the function filters by matching utf8 characters to the
7788     * raw markup text, so it can be used to remove formatting tags.
7789     *
7790     * This filter, like any others, does not apply when setting the entry text
7791     * directly with elm_object_text_set() (or the deprecated
7792     * elm_entry_entry_set()).
7793     */
7794    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
7795    /**
7796     * @}
7797     */
7798
7799    /* composite widgets - these basically put together basic widgets above
7800     * in convenient packages that do more than basic stuff */
7801
7802    /* anchorview */
7803    /**
7804     * @defgroup Anchorview Anchorview
7805     *
7806     * @image html img/widget/anchorview/preview-00.png
7807     * @image latex img/widget/anchorview/preview-00.eps
7808     *
7809     * Anchorview is for displaying text that contains markup with anchors
7810     * like <c>\<a href=1234\>something\</\></c> in it.
7811     *
7812     * Besides being styled differently, the anchorview widget provides the
7813     * necessary functionality so that clicking on these anchors brings up a
7814     * popup with user defined content such as "call", "add to contacts" or
7815     * "open web page". This popup is provided using the @ref Hover widget.
7816     *
7817     * This widget is very similar to @ref Anchorblock, so refer to that
7818     * widget for an example. The only difference Anchorview has is that the
7819     * widget is already provided with scrolling functionality, so if the
7820     * text set to it is too large to fit in the given space, it will scroll,
7821     * whereas the @ref Anchorblock widget will keep growing to ensure all the
7822     * text can be displayed.
7823     *
7824     * This widget emits the following signals:
7825     * @li "anchor,clicked": will be called when an anchor is clicked. The
7826     * @p event_info parameter on the callback will be a pointer of type
7827     * ::Elm_Entry_Anchorview_Info.
7828     *
7829     * See @ref Anchorblock for an example on how to use both of them.
7830     *
7831     * @see Anchorblock
7832     * @see Entry
7833     * @see Hover
7834     *
7835     * @{
7836     */
7837    /**
7838     * @typedef Elm_Entry_Anchorview_Info
7839     *
7840     * The info sent in the callback for "anchor,clicked" signals emitted by
7841     * the Anchorview widget.
7842     */
7843    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
7844    /**
7845     * @struct _Elm_Entry_Anchorview_Info
7846     *
7847     * The info sent in the callback for "anchor,clicked" signals emitted by
7848     * the Anchorview widget.
7849     */
7850    struct _Elm_Entry_Anchorview_Info
7851      {
7852         const char     *name; /**< Name of the anchor, as indicated in its href
7853                                    attribute */
7854         int             button; /**< The mouse button used to click on it */
7855         Evas_Object    *hover; /**< The hover object to use for the popup */
7856         struct {
7857              Evas_Coord    x, y, w, h;
7858         } anchor, /**< Geometry selection of text used as anchor */
7859           hover_parent; /**< Geometry of the object used as parent by the
7860                              hover */
7861         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
7862                                              for content on the left side of
7863                                              the hover. Before calling the
7864                                              callback, the widget will make the
7865                                              necessary calculations to check
7866                                              which sides are fit to be set with
7867                                              content, based on the position the
7868                                              hover is activated and its distance
7869                                              to the edges of its parent object
7870                                              */
7871         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
7872                                               the right side of the hover.
7873                                               See @ref hover_left */
7874         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
7875                                             of the hover. See @ref hover_left */
7876         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
7877                                                below the hover. See @ref
7878                                                hover_left */
7879      };
7880    /**
7881     * Add a new Anchorview object
7882     *
7883     * @param parent The parent object
7884     * @return The new object or NULL if it cannot be created
7885     */
7886    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7887    /**
7888     * Set the text to show in the anchorview
7889     *
7890     * Sets the text of the anchorview to @p text. This text can include markup
7891     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
7892     * text that will be specially styled and react to click events, ended with
7893     * either of \</a\> or \</\>. When clicked, the anchor will emit an
7894     * "anchor,clicked" signal that you can attach a callback to with
7895     * evas_object_smart_callback_add(). The name of the anchor given in the
7896     * event info struct will be the one set in the href attribute, in this
7897     * case, anchorname.
7898     *
7899     * Other markup can be used to style the text in different ways, but it's
7900     * up to the style defined in the theme which tags do what.
7901     * @deprecated use elm_object_text_set() instead.
7902     */
7903    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
7904    /**
7905     * Get the markup text set for the anchorview
7906     *
7907     * Retrieves the text set on the anchorview, with markup tags included.
7908     *
7909     * @param obj The anchorview object
7910     * @return The markup text set or @c NULL if nothing was set or an error
7911     * occurred
7912     * @deprecated use elm_object_text_set() instead.
7913     */
7914    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7915    /**
7916     * Set the parent of the hover popup
7917     *
7918     * Sets the parent object to use by the hover created by the anchorview
7919     * when an anchor is clicked. See @ref Hover for more details on this.
7920     * If no parent is set, the same anchorview object will be used.
7921     *
7922     * @param obj The anchorview object
7923     * @param parent The object to use as parent for the hover
7924     */
7925    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7926    /**
7927     * Get the parent of the hover popup
7928     *
7929     * Get the object used as parent for the hover created by the anchorview
7930     * widget. See @ref Hover for more details on this.
7931     *
7932     * @param obj The anchorview object
7933     * @return The object used as parent for the hover, NULL if none is set.
7934     */
7935    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7936    /**
7937     * Set the style that the hover should use
7938     *
7939     * When creating the popup hover, anchorview will request that it's
7940     * themed according to @p style.
7941     *
7942     * @param obj The anchorview object
7943     * @param style The style to use for the underlying hover
7944     *
7945     * @see elm_object_style_set()
7946     */
7947    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
7948    /**
7949     * Get the style that the hover should use
7950     *
7951     * Get the style the hover created by anchorview will use.
7952     *
7953     * @param obj The anchorview object
7954     * @return The style to use by the hover. NULL means the default is used.
7955     *
7956     * @see elm_object_style_set()
7957     */
7958    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7959    /**
7960     * Ends the hover popup in the anchorview
7961     *
7962     * When an anchor is clicked, the anchorview widget will create a hover
7963     * object to use as a popup with user provided content. This function
7964     * terminates this popup, returning the anchorview to its normal state.
7965     *
7966     * @param obj The anchorview object
7967     */
7968    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
7969    /**
7970     * Set bouncing behaviour when the scrolled content reaches an edge
7971     *
7972     * Tell the internal scroller object whether it should bounce or not
7973     * when it reaches the respective edges for each axis.
7974     *
7975     * @param obj The anchorview object
7976     * @param h_bounce Whether to bounce or not in the horizontal axis
7977     * @param v_bounce Whether to bounce or not in the vertical axis
7978     *
7979     * @see elm_scroller_bounce_set()
7980     */
7981    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7982    /**
7983     * Get the set bouncing behaviour of the internal scroller
7984     *
7985     * Get whether the internal scroller should bounce when the edge of each
7986     * axis is reached scrolling.
7987     *
7988     * @param obj The anchorview object
7989     * @param h_bounce Pointer where to store the bounce state of the horizontal
7990     *                 axis
7991     * @param v_bounce Pointer where to store the bounce state of the vertical
7992     *                 axis
7993     *
7994     * @see elm_scroller_bounce_get()
7995     */
7996    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7997    /**
7998     * Appends a custom item provider to the given anchorview
7999     *
8000     * Appends the given function to the list of items providers. This list is
8001     * called, one function at a time, with the given @p data pointer, the
8002     * anchorview object and, in the @p item parameter, the item name as
8003     * referenced in its href string. Following functions in the list will be
8004     * called in order until one of them returns something different to NULL,
8005     * which should be an Evas_Object which will be used in place of the item
8006     * element.
8007     *
8008     * Items in the markup text take the form \<item relsize=16x16 vsize=full
8009     * href=item/name\>\</item\>
8010     *
8011     * @param obj The anchorview object
8012     * @param func The function to add to the list of providers
8013     * @param data User data that will be passed to the callback function
8014     *
8015     * @see elm_entry_item_provider_append()
8016     */
8017    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);
8018    /**
8019     * Prepend a custom item provider to the given anchorview
8020     *
8021     * Like elm_anchorview_item_provider_append(), but it adds the function
8022     * @p func to the beginning of the list, instead of the end.
8023     *
8024     * @param obj The anchorview object
8025     * @param func The function to add to the list of providers
8026     * @param data User data that will be passed to the callback function
8027     */
8028    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);
8029    /**
8030     * Remove a custom item provider from the list of the given anchorview
8031     *
8032     * Removes the function and data pairing that matches @p func and @p data.
8033     * That is, unless the same function and same user data are given, the
8034     * function will not be removed from the list. This allows us to add the
8035     * same callback several times, with different @p data pointers and be
8036     * able to remove them later without conflicts.
8037     *
8038     * @param obj The anchorview object
8039     * @param func The function to remove from the list
8040     * @param data The data matching the function to remove from the list
8041     */
8042    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);
8043    /**
8044     * @}
8045     */
8046
8047    /* anchorblock */
8048    /**
8049     * @defgroup Anchorblock Anchorblock
8050     *
8051     * @image html img/widget/anchorblock/preview-00.png
8052     * @image latex img/widget/anchorblock/preview-00.eps
8053     *
8054     * Anchorblock is for displaying text that contains markup with anchors
8055     * like <c>\<a href=1234\>something\</\></c> in it.
8056     *
8057     * Besides being styled differently, the anchorblock widget provides the
8058     * necessary functionality so that clicking on these anchors brings up a
8059     * popup with user defined content such as "call", "add to contacts" or
8060     * "open web page". This popup is provided using the @ref Hover widget.
8061     *
8062     * This widget emits the following signals:
8063     * @li "anchor,clicked": will be called when an anchor is clicked. The
8064     * @p event_info parameter on the callback will be a pointer of type
8065     * ::Elm_Entry_Anchorblock_Info.
8066     *
8067     * @see Anchorview
8068     * @see Entry
8069     * @see Hover
8070     *
8071     * Since examples are usually better than plain words, we might as well
8072     * try @ref tutorial_anchorblock_example "one".
8073     */
8074    /**
8075     * @page tutorial_anchorblock_example Anchorblock/Anchorview example
8076     * This example will show both Anchorblock and @ref Anchorview,
8077     * since both are very similar and it's easier to show them once and side
8078     * by side, so the difference is more clear.
8079     *
8080     * We'll show the relevant snippets of the code here, but the full example
8081     * can be found here... sorry, @ref anchorblock_example_01.c "here".
8082     *
8083     * As for the actual example, it's just a simple window with an anchorblock
8084     * and an anchorview, both containing the same text. After including
8085     * Elementary.h and declaring some functions we'll need, we jump to our
8086     * elm_main (see ELM_MAIN) and create our window.
8087     * @dontinclude anchorblock_example_01.c
8088     * @skip int
8089     * @until const char
8090     * @until ;
8091     *
8092     * With the needed variables declared, we'll create the window and a box to
8093     * hold our widgets, but we don't need to go through that here.
8094     *
8095     * In order to make clear where the anchorblock ends and the anchorview
8096     * begins, they'll be each inside a @ref Frame. After creating the frame,
8097     * the anchorblock follows.
8098     * @skip elm_frame_add
8099     * @until elm_frame_content_set
8100     *
8101     * Nothing out of the ordinary there. What's worth mentioning is the call
8102     * to elm_anchorblock_hover_parent_set(). We are telling our widget that
8103     * when an anchor is clicked, the hover for the popup will cover the entire
8104     * window. This affects the area that will be obscured by the hover and
8105     * where clicking will dismiss it, as well as the calculations it does to
8106     * inform the best locations where to insert the popups content.
8107     * Other than that, the code is pretty standard. We also need to set our
8108     * callback for when an anchor is clicked, since it's our task to populate
8109     * the popup. There's no default for it.
8110     *
8111     * The anchorview is no different, we only change a few things so it looks
8112     * different.
8113     * @until elm_frame_content_set
8114     *
8115     * Then we run, so stuff works and close our main function in the usual way.
8116     * @until ELM_MAIN
8117     *
8118     * Now, a little note. Normally you would use either one of anchorblock or
8119     * anchorview, set your one callback to clicks and do your stuff in there.
8120     * In this example, however, there are a few tricks to make it easier to
8121     * show both widgets in one go (and to save me some typing). So we have
8122     * two callbacks, one per widget, that will call a common function to do
8123     * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
8124     * anchorview too, since both are equal, and passing a callback to use
8125     * for our buttons to end the hover, because each widget has a different
8126     * function for it.
8127     * @until _anchorview_clicked_cb
8128     * @until }
8129     *
8130     * The meat of our popup is in the following function. We check what kind
8131     * of menu we need to show, based on the name set to the anchor in the
8132     * markup text. If there's no type (something went wrong, no valid contact
8133     * in the address list) we are just putting a button that does nothing, but
8134     * it's perfectly reasonable to just end the hover and call it quits.
8135     *
8136     * Our popup will consist of one main button in the middle of our hover,
8137     * and possibly a secondary button and a list of other options. We'll create
8138     * first our main button and check what kind of popup we need afterwards.
8139     * @skip static void
8140     * @skip static void
8141     * @until eina_stringshare_add
8142     * @until }
8143     *
8144     * Each button has two callbacks, one is our hack to close the hover
8145     * properly based on which widget it belongs to, the other a simple
8146     * printf that will show the action with the anchors own data. This is
8147     * not how you would usually do it. Instead, the common case is to have
8148     * one callback for the button that will know which function to call to end
8149     * things, but since we are doing it this way it's worth noting that
8150     * smart callbacks will be called in reverse in respect to the order they
8151     * were added, and since our @c btn_end_cb will close the hover, and thus
8152     * delete our buttons, the other callback wouldn't be called if we had
8153     * added it before.
8154     *
8155     * After our telephone popup, there are a few others that are practically
8156     * the same, so they won't be shown here.
8157     *
8158     * Once we are done with that, it's time to place our actions into our
8159     * hover. Main button goes in the middle without much questioning, and then
8160     * we see if we have a secondary button and a box of extra options.
8161     * Because I said so, secondary button goes on either side and box of
8162     * options either on top or below the main one, but to choose which
8163     * exactly, we use the hints our callback info has, which saves us from
8164     * having to do the math and see which side has more space available, with
8165     * a little special case where we delete our extra stuff if there's nowhere
8166     * to place it.
8167     * @skip url:
8168     * @skip }
8169     * @skip evas_object_smart
8170     * @until evas_object_del(box)
8171     * @until }
8172     * @until }
8173     *
8174     * The example will look like this:
8175     *
8176     * @image html screenshots/anchorblock_01.png
8177     * @image latex screenshots/anchorblock_01.eps width=\textwidth
8178     *
8179     * @example anchorblock_example_01.c
8180     */
8181    /**
8182     * @addtogroup Anchorblock
8183     * @{
8184     */
8185    /**
8186     * @typedef Elm_Entry_Anchorblock_Info
8187     *
8188     * The info sent in the callback for "anchor,clicked" signals emitted by
8189     * the Anchorblock widget.
8190     */
8191    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
8192    /**
8193     * @struct _Elm_Entry_Anchorblock_Info
8194     *
8195     * The info sent in the callback for "anchor,clicked" signals emitted by
8196     * the Anchorblock widget.
8197     */
8198    struct _Elm_Entry_Anchorblock_Info
8199      {
8200         const char     *name; /**< Name of the anchor, as indicated in its href
8201                                    attribute */
8202         int             button; /**< The mouse button used to click on it */
8203         Evas_Object    *hover; /**< The hover object to use for the popup */
8204         struct {
8205              Evas_Coord    x, y, w, h;
8206         } anchor, /**< Geometry selection of text used as anchor */
8207           hover_parent; /**< Geometry of the object used as parent by the
8208                              hover */
8209         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
8210                                              for content on the left side of
8211                                              the hover. Before calling the
8212                                              callback, the widget will make the
8213                                              necessary calculations to check
8214                                              which sides are fit to be set with
8215                                              content, based on the position the
8216                                              hover is activated and its distance
8217                                              to the edges of its parent object
8218                                              */
8219         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
8220                                               the right side of the hover.
8221                                               See @ref hover_left */
8222         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
8223                                             of the hover. See @ref hover_left */
8224         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
8225                                                below the hover. See @ref
8226                                                hover_left */
8227      };
8228    /**
8229     * Add a new Anchorblock object
8230     *
8231     * @param parent The parent object
8232     * @return The new object or NULL if it cannot be created
8233     */
8234    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8235    /**
8236     * Set the text to show in the anchorblock
8237     *
8238     * Sets the text of the anchorblock to @p text. This text can include markup
8239     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
8240     * of text that will be specially styled and react to click events, ended
8241     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
8242     * "anchor,clicked" signal that you can attach a callback to with
8243     * evas_object_smart_callback_add(). The name of the anchor given in the
8244     * event info struct will be the one set in the href attribute, in this
8245     * case, anchorname.
8246     *
8247     * Other markup can be used to style the text in different ways, but it's
8248     * up to the style defined in the theme which tags do what.
8249     * @deprecated use elm_object_text_set() instead.
8250     */
8251    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
8252    /**
8253     * Get the markup text set for the anchorblock
8254     *
8255     * Retrieves the text set on the anchorblock, with markup tags included.
8256     *
8257     * @param obj The anchorblock object
8258     * @return The markup text set or @c NULL if nothing was set or an error
8259     * occurred
8260     * @deprecated use elm_object_text_set() instead.
8261     */
8262    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8263    /**
8264     * Set the parent of the hover popup
8265     *
8266     * Sets the parent object to use by the hover created by the anchorblock
8267     * when an anchor is clicked. See @ref Hover for more details on this.
8268     *
8269     * @param obj The anchorblock object
8270     * @param parent The object to use as parent for the hover
8271     */
8272    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8273    /**
8274     * Get the parent of the hover popup
8275     *
8276     * Get the object used as parent for the hover created by the anchorblock
8277     * widget. See @ref Hover for more details on this.
8278     * If no parent is set, the same anchorblock object will be used.
8279     *
8280     * @param obj The anchorblock object
8281     * @return The object used as parent for the hover, NULL if none is set.
8282     */
8283    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8284    /**
8285     * Set the style that the hover should use
8286     *
8287     * When creating the popup hover, anchorblock will request that it's
8288     * themed according to @p style.
8289     *
8290     * @param obj The anchorblock object
8291     * @param style The style to use for the underlying hover
8292     *
8293     * @see elm_object_style_set()
8294     */
8295    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
8296    /**
8297     * Get the style that the hover should use
8298     *
8299     * Get the style the hover created by anchorblock will use.
8300     *
8301     * @param obj The anchorblock object
8302     * @return The style to use by the hover. NULL means the default is used.
8303     *
8304     * @see elm_object_style_set()
8305     */
8306    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8307    /**
8308     * Ends the hover popup in the anchorblock
8309     *
8310     * When an anchor is clicked, the anchorblock widget will create a hover
8311     * object to use as a popup with user provided content. This function
8312     * terminates this popup, returning the anchorblock to its normal state.
8313     *
8314     * @param obj The anchorblock object
8315     */
8316    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8317    /**
8318     * Appends a custom item provider to the given anchorblock
8319     *
8320     * Appends the given function to the list of items providers. This list is
8321     * called, one function at a time, with the given @p data pointer, the
8322     * anchorblock object and, in the @p item parameter, the item name as
8323     * referenced in its href string. Following functions in the list will be
8324     * called in order until one of them returns something different to NULL,
8325     * which should be an Evas_Object which will be used in place of the item
8326     * element.
8327     *
8328     * Items in the markup text take the form \<item relsize=16x16 vsize=full
8329     * href=item/name\>\</item\>
8330     *
8331     * @param obj The anchorblock object
8332     * @param func The function to add to the list of providers
8333     * @param data User data that will be passed to the callback function
8334     *
8335     * @see elm_entry_item_provider_append()
8336     */
8337    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);
8338    /**
8339     * Prepend a custom item provider to the given anchorblock
8340     *
8341     * Like elm_anchorblock_item_provider_append(), but it adds the function
8342     * @p func to the beginning of the list, instead of the end.
8343     *
8344     * @param obj The anchorblock object
8345     * @param func The function to add to the list of providers
8346     * @param data User data that will be passed to the callback function
8347     */
8348    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);
8349    /**
8350     * Remove a custom item provider from the list of the given anchorblock
8351     *
8352     * Removes the function and data pairing that matches @p func and @p data.
8353     * That is, unless the same function and same user data are given, the
8354     * function will not be removed from the list. This allows us to add the
8355     * same callback several times, with different @p data pointers and be
8356     * able to remove them later without conflicts.
8357     *
8358     * @param obj The anchorblock object
8359     * @param func The function to remove from the list
8360     * @param data The data matching the function to remove from the list
8361     */
8362    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);
8363    /**
8364     * @}
8365     */
8366
8367    /**
8368     * @defgroup Bubble Bubble
8369     *
8370     * @image html img/widget/bubble/preview-00.png
8371     * @image html img/widget/bubble/preview-01.png
8372     * @image html img/widget/bubble/preview-02.png
8373     *
8374     * @brief The Bubble is a widget to show text similarly to how speech is
8375     * represented in comics.
8376     *
8377     * The bubble widget contains 5 important visual elements:
8378     * @li The frame is a rectangle with rounded rectangles and an "arrow".
8379     * @li The @p icon is an image to which the frame's arrow points to.
8380     * @li The @p label is a text which appears to the right of the icon if the
8381     * corner is "top_left" or "bottom_left" and is right aligned to the frame
8382     * otherwise.
8383     * @li The @p info is a text which appears to the right of the label. Info's
8384     * font is of a ligther color than label.
8385     * @li The @p content is an evas object that is shown inside the frame.
8386     *
8387     * The position of the arrow, icon, label and info depends on which corner is
8388     * selected. The four available corners are:
8389     * @li "top_left" - Default
8390     * @li "top_right"
8391     * @li "bottom_left"
8392     * @li "bottom_right"
8393     *
8394     * Signals that you can add callbacks for are:
8395     * @li "clicked" - This is called when a user has clicked the bubble.
8396     *
8397     * For an example of using a buble see @ref bubble_01_example_page "this".
8398     *
8399     * @{
8400     */
8401    /**
8402     * Add a new bubble to the parent
8403     *
8404     * @param parent The parent object
8405     * @return The new object or NULL if it cannot be created
8406     *
8407     * This function adds a text bubble to the given parent evas object.
8408     */
8409    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8410    /**
8411     * Set the label of the bubble
8412     *
8413     * @param obj The bubble object
8414     * @param label The string to set in the label
8415     *
8416     * This function sets the title of the bubble. Where this appears depends on
8417     * the selected corner.
8418     * @deprecated use elm_object_text_set() instead.
8419     */
8420    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8421    /**
8422     * Get the label of the bubble
8423     *
8424     * @param obj The bubble object
8425     * @return The string of set in the label
8426     *
8427     * This function gets the title of the bubble.
8428     * @deprecated use elm_object_text_set() instead.
8429     */
8430    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8431    /**
8432     * Set the info of the bubble
8433     *
8434     * @param obj The bubble object
8435     * @param info The given info about the bubble
8436     *
8437     * This function sets the info of the bubble. Where this appears depends on
8438     * the selected corner.
8439     * @deprecated use elm_object_text_set() instead.
8440     */
8441    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
8442    /**
8443     * Get the info of the bubble
8444     *
8445     * @param obj The bubble object
8446     *
8447     * @return The "info" string of the bubble
8448     *
8449     * This function gets the info text.
8450     * @deprecated use elm_object_text_set() instead.
8451     */
8452    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8453    /**
8454     * Set the content to be shown in the bubble
8455     *
8456     * Once the content object is set, a previously set one will be deleted.
8457     * If you want to keep the old content object, use the
8458     * elm_bubble_content_unset() function.
8459     *
8460     * @param obj The bubble object
8461     * @param content The given content of the bubble
8462     *
8463     * This function sets the content shown on the middle of the bubble.
8464     */
8465    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8466    /**
8467     * Get the content shown in the bubble
8468     *
8469     * Return the content object which is set for this widget.
8470     *
8471     * @param obj The bubble object
8472     * @return The content that is being used
8473     */
8474    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8475    /**
8476     * Unset the content shown in the bubble
8477     *
8478     * Unparent and return the content object which was set for this widget.
8479     *
8480     * @param obj The bubble object
8481     * @return The content that was being used
8482     */
8483    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8484    /**
8485     * Set the icon of the bubble
8486     *
8487     * Once the icon object is set, a previously set one will be deleted.
8488     * If you want to keep the old content object, use the
8489     * elm_icon_content_unset() function.
8490     *
8491     * @param obj The bubble object
8492     * @param icon The given icon for the bubble
8493     */
8494    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8495    /**
8496     * Get the icon of the bubble
8497     *
8498     * @param obj The bubble object
8499     * @return The icon for the bubble
8500     *
8501     * This function gets the icon shown on the top left of bubble.
8502     */
8503    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8504    /**
8505     * Unset the icon of the bubble
8506     *
8507     * Unparent and return the icon object which was set for this widget.
8508     *
8509     * @param obj The bubble object
8510     * @return The icon that was being used
8511     */
8512    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8513    /**
8514     * Set the corner of the bubble
8515     *
8516     * @param obj The bubble object.
8517     * @param corner The given corner for the bubble.
8518     *
8519     * This function sets the corner of the bubble. The corner will be used to
8520     * determine where the arrow in the frame points to and where label, icon and
8521     * info arre shown.
8522     *
8523     * Possible values for corner are:
8524     * @li "top_left" - Default
8525     * @li "top_right"
8526     * @li "bottom_left"
8527     * @li "bottom_right"
8528     */
8529    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
8530    /**
8531     * Get the corner of the bubble
8532     *
8533     * @param obj The bubble object.
8534     * @return The given corner for the bubble.
8535     *
8536     * This function gets the selected corner of the bubble.
8537     */
8538    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8539    /**
8540     * @}
8541     */
8542
8543    /* photo */
8544    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8545    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
8546    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
8547    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
8548    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
8549    /* smart callbacks called:
8550     * "clicked" - the user clicked the icon
8551     * "drag,start" - Someone started dragging the image out of the object
8552     * "drag,end" - Dragged item was dropped (somewhere)
8553     */
8554
8555    /* gesture layer */
8556    /** @defgroup Elm_Gesture_Layer Gesture Layer */
8557    /**
8558     * @enum _Elm_Gesture_Types
8559     * Enum of supported gesture types.
8560     * @ingroup Elm_Gesture_Layer
8561     */
8562    typedef enum _Elm_Gesture_Types
8563      {
8564         ELM_GESTURE_FIRST = 0,
8565
8566         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
8567         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
8568         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
8569
8570         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
8571
8572         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
8573         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
8574
8575         ELM_GESTURE_ZOOM, /**< Zoom */
8576         ELM_GESTURE_ROTATE, /**< Rotate */
8577
8578         ELM_GESTURE_LAST
8579      } Elm_Gesture_Types;
8580
8581    /**
8582     * @enum _Elm_Gesture_State
8583     * Enum of gesture states.
8584     * @ingroup Elm_Gesture_Layer
8585     */
8586    typedef enum _Elm_Gesture_State
8587      {
8588         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
8589         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
8590         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
8591         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
8592         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
8593      } Elm_Gesture_State;
8594
8595    /**
8596     * @struct _Elm_Gesture_Taps_Info
8597     * Struct holds taps info for user
8598     * @ingroup Elm_Gesture_Layer
8599     */
8600    struct _Elm_Gesture_Taps_Info
8601      {
8602         Evas_Coord x, y;         /**< Holds center point between fingers */
8603         unsigned int n;          /**< Number of fingers tapped           */
8604         unsigned int timestamp;  /**< event timestamp       */
8605      };
8606
8607    /**
8608     * @typedef Elm_Gesture_Taps_Info
8609     * holds taps info for user
8610     * @ingroup Elm_Gesture_Layer
8611     */
8612    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
8613
8614    /**
8615     * @struct _Elm_Gesture_Momentum_Info
8616     * Struct holds momentum info for user
8617     * x1 and y1 are not necessarily in sync
8618     * x1 holds x value of x direction starting point
8619     * and same holds for y1.
8620     * This is noticeable when doing V-shape movement
8621     * @ingroup Elm_Gesture_Layer
8622     */
8623    struct _Elm_Gesture_Momentum_Info
8624      {  /* Report line ends, timestamps, and momentum computed        */
8625         Evas_Coord x1; /**< Final-swipe direction starting point on X */
8626         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
8627         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
8628         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
8629
8630         unsigned int tx; /**< Timestamp of start of final x-swipe */
8631         unsigned int ty; /**< Timestamp of start of final y-swipe */
8632
8633         Evas_Coord mx; /**< Momentum on X */
8634         Evas_Coord my; /**< Momentum on Y */
8635      };
8636
8637    /**
8638     * @typedef Elm_Gesture_Momentum_Info
8639     * holds momentum info for user
8640     * @ingroup Elm_Gesture_Layer
8641     */
8642     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
8643
8644    /**
8645     * @struct _Elm_Gesture_Line_Info
8646     * Struct holds line info for user
8647     * @ingroup Elm_Gesture_Layer
8648     */
8649    struct _Elm_Gesture_Line_Info
8650      {  /* Report line ends, timestamps, and momentum computed      */
8651         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
8652         unsigned int n;            /**< Number of fingers (lines)   */
8653         /* FIXME should be radians, bot degrees */
8654         double angle;              /**< Angle (direction) of lines  */
8655      };
8656
8657    /**
8658     * @typedef _Elm_Gesture_Line_Info
8659     * Holds line info for user
8660     * @ingroup Elm_Gesture_Layer
8661     */
8662     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
8663
8664    /**
8665     * @struct _Elm_Gesture_Zoom_Info
8666     * Struct holds zoom info for user
8667     * @ingroup Elm_Gesture_Layer
8668     */
8669    struct _Elm_Gesture_Zoom_Info
8670      {
8671         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
8672         Evas_Coord radius; /**< Holds radius between fingers reported to user */
8673         double zoom;            /**< Zoom value: 1.0 means no zoom             */
8674         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
8675      };
8676
8677    /**
8678     * @typedef Elm_Gesture_Zoom_Info
8679     * Holds zoom info for user
8680     * @ingroup Elm_Gesture_Layer
8681     */
8682    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
8683
8684    /**
8685     * @struct _Elm_Gesture_Rotate_Info
8686     * Struct holds rotation info for user
8687     * @ingroup Elm_Gesture_Layer
8688     */
8689    struct _Elm_Gesture_Rotate_Info
8690      {
8691         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
8692         Evas_Coord radius; /**< Holds radius between fingers reported to user */
8693         double base_angle; /**< Holds start-angle */
8694         double angle;      /**< Rotation value: 0.0 means no rotation         */
8695         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
8696      };
8697
8698    /**
8699     * @typedef Elm_Gesture_Rotate_Info
8700     * Holds rotation info for user
8701     * @ingroup Elm_Gesture_Layer
8702     */
8703    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
8704
8705    /**
8706     * @typedef Elm_Gesture_Event_Cb
8707     * User callback used to stream gesture info from gesture layer
8708     * @param data user data
8709     * @param event_info gesture report info
8710     * Returns a flag field to be applied on the causing event.
8711     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
8712     * upon the event, in an irreversible way.
8713     *
8714     * @ingroup Elm_Gesture_Layer
8715     */
8716    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
8717
8718    /**
8719     * Use function to set callbacks to be notified about
8720     * change of state of gesture.
8721     * When a user registers a callback with this function
8722     * this means this gesture has to be tested.
8723     *
8724     * When ALL callbacks for a gesture are set to NULL
8725     * it means user isn't interested in gesture-state
8726     * and it will not be tested.
8727     *
8728     * @param obj Pointer to gesture-layer.
8729     * @param idx The gesture you would like to track its state.
8730     * @param cb callback function pointer.
8731     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
8732     * @param data user info to be sent to callback (usually, Smart Data)
8733     *
8734     * @ingroup Elm_Gesture_Layer
8735     */
8736    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);
8737
8738    /**
8739     * Call this function to get repeat-events settings.
8740     *
8741     * @param obj Pointer to gesture-layer.
8742     *
8743     * @return repeat events settings.
8744     * @see elm_gesture_layer_hold_events_set()
8745     * @ingroup Elm_Gesture_Layer
8746     */
8747    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8748
8749    /**
8750     * This function called in order to make gesture-layer repeat events.
8751     * Set this of you like to get the raw events only if gestures were not detected.
8752     * Clear this if you like gesture layer to fwd events as testing gestures.
8753     *
8754     * @param obj Pointer to gesture-layer.
8755     * @param r Repeat: TRUE/FALSE
8756     *
8757     * @ingroup Elm_Gesture_Layer
8758     */
8759    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
8760
8761    /**
8762     * This function sets step-value for zoom action.
8763     * Set step to any positive value.
8764     * Cancel step setting by setting to 0.0
8765     *
8766     * @param obj Pointer to gesture-layer.
8767     * @param s new zoom step value.
8768     *
8769     * @ingroup Elm_Gesture_Layer
8770     */
8771    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
8772
8773    /**
8774     * This function sets step-value for rotate action.
8775     * Set step to any positive value.
8776     * Cancel step setting by setting to 0.0
8777     *
8778     * @param obj Pointer to gesture-layer.
8779     * @param s new roatate step value.
8780     *
8781     * @ingroup Elm_Gesture_Layer
8782     */
8783    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
8784
8785    /**
8786     * This function called to attach gesture-layer to an Evas_Object.
8787     * @param obj Pointer to gesture-layer.
8788     * @param t Pointer to underlying object (AKA Target)
8789     *
8790     * @return TRUE, FALSE on success, failure.
8791     *
8792     * @ingroup Elm_Gesture_Layer
8793     */
8794    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
8795
8796    /**
8797     * Call this function to construct a new gesture-layer object.
8798     * This does not activate the gesture layer. You have to
8799     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
8800     *
8801     * @param parent the parent object.
8802     *
8803     * @return Pointer to new gesture-layer object.
8804     *
8805     * @ingroup Elm_Gesture_Layer
8806     */
8807    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8808
8809    /* thumb */
8810    typedef enum _Elm_Thumb_Animation_Setting
8811      {
8812         ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
8813         ELM_THUMB_ANIMATION_LOOP,      /* Keep playing animation until stop is requested */
8814         ELM_THUMB_ANIMATION_STOP,
8815         ELM_THUMB_ANIMATION_LAST
8816      } Elm_Thumb_Animation_Setting;
8817
8818    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8819    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
8820    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
8821    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
8822    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
8823    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
8824    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8825    EAPI void                        *elm_thumb_ethumb_client_get(void);
8826    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
8827    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
8828    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8829    /* available styles:
8830     * default
8831     * noframe
8832     */
8833    /* smart callbacks called:
8834     * "clicked" - This is called when a user has clicked the thumb without dragging around.
8835     * "clicked,double" - This is called when a user has double-clicked the thumb.
8836     * "press" - This is called when a user has pressed down the thumb.
8837     * "generate,start" - The thumbnail generation started.
8838     * "generate,stop" - The generation process stopped.
8839     * "generate,error" - The generation failed.
8840     * "load,error" - The thumbnail image loading failed.
8841     */
8842
8843    /**
8844     * @defgroup Hoversel
8845     *
8846     * @image html img/widget/hoversel/preview-00.png
8847     * @image latex img/widget/hoversel/preview-00.eps
8848     *
8849     * A hoversel is a button that pops up a list of items (automatically
8850     * choosing the direction to display) that have a label and, optionally, an
8851     * icon to select from. It is a convenience widget to avoid the need to do
8852     * all the piecing together yourself. It is intended for a small number of
8853     * items in the hoversel menu (no more than 8), though is capable of many
8854     * more.
8855     *
8856     * Signals that you can add callbacks for are:
8857     * "clicked" - the user clicked the hoversel button and popped up the sel
8858     * "selected" - an item in the hoversel list is selected. event_info is the item
8859     * "dismissed" - the hover is dismissed
8860     *
8861     * See @ref tutorial_hoversel for an example.
8862     * @{
8863     */
8864    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
8865    /**
8866     * @brief Add a new Hoversel object
8867     *
8868     * @param parent The parent object
8869     * @return The new object or NULL if it cannot be created
8870     */
8871    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8872    /**
8873     * @brief This sets the hoversel to expand horizontally.
8874     *
8875     * @param obj The hoversel object
8876     * @param horizontal If true, the hover will expand horizontally to the
8877     * right.
8878     *
8879     * @note The initial button will display horizontally regardless of this
8880     * setting.
8881     */
8882    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
8883    /**
8884     * @brief This returns whether the hoversel is set to expand horizontally.
8885     *
8886     * @param obj The hoversel object
8887     * @return If true, the hover will expand horizontally to the right.
8888     *
8889     * @see elm_hoversel_horizontal_set()
8890     */
8891    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8892    /**
8893     * @brief Set the Hover parent
8894     *
8895     * @param obj The hoversel object
8896     * @param parent The parent to use
8897     *
8898     * Sets the hover parent object, the area that will be darkened when the
8899     * hoversel is clicked. Should probably be the window that the hoversel is
8900     * in. See @ref Hover objects for more information.
8901     */
8902    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8903    /**
8904     * @brief Get the Hover parent
8905     *
8906     * @param obj The hoversel object
8907     * @return The used parent
8908     *
8909     * Gets the hover parent object.
8910     *
8911     * @see elm_hoversel_hover_parent_set()
8912     */
8913    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8914    /**
8915     * @brief Set the hoversel button label
8916     *
8917     * @param obj The hoversel object
8918     * @param label The label text.
8919     *
8920     * This sets the label of the button that is always visible (before it is
8921     * clicked and expanded).
8922     *
8923     * @deprecated elm_object_text_set()
8924     */
8925    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8926    /**
8927     * @brief Get the hoversel button label
8928     *
8929     * @param obj The hoversel object
8930     * @return The label text.
8931     *
8932     * @deprecated elm_object_text_get()
8933     */
8934    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8935    /**
8936     * @brief Set the icon of the hoversel button
8937     *
8938     * @param obj The hoversel object
8939     * @param icon The icon object
8940     *
8941     * Sets the icon of the button that is always visible (before it is clicked
8942     * and expanded).  Once the icon object is set, a previously set one will be
8943     * deleted, if you want to keep that old content object, use the
8944     * elm_hoversel_icon_unset() function.
8945     *
8946     * @see elm_button_icon_set()
8947     */
8948    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8949    /**
8950     * @brief Get the icon of the hoversel button
8951     *
8952     * @param obj The hoversel object
8953     * @return The icon object
8954     *
8955     * Get the icon of the button that is always visible (before it is clicked
8956     * and expanded). Also see elm_button_icon_get().
8957     *
8958     * @see elm_hoversel_icon_set()
8959     */
8960    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8961    /**
8962     * @brief Get and unparent the icon of the hoversel button
8963     *
8964     * @param obj The hoversel object
8965     * @return The icon object that was being used
8966     *
8967     * Unparent and return the icon of the button that is always visible
8968     * (before it is clicked and expanded).
8969     *
8970     * @see elm_hoversel_icon_set()
8971     * @see elm_button_icon_unset()
8972     */
8973    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8974    /**
8975     * @brief This triggers the hoversel popup from code, the same as if the user
8976     * had clicked the button.
8977     *
8978     * @param obj The hoversel object
8979     */
8980    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8981    /**
8982     * @brief This dismisses the hoversel popup as if the user had clicked
8983     * outside the hover.
8984     *
8985     * @param obj The hoversel object
8986     */
8987    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8988    /**
8989     * @brief Returns whether the hoversel is expanded.
8990     *
8991     * @param obj The hoversel object
8992     * @return  This will return EINA_TRUE if the hoversel is expanded or
8993     * EINA_FALSE if it is not expanded.
8994     */
8995    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8996    /**
8997     * @brief This will remove all the children items from the hoversel.
8998     *
8999     * @param obj The hoversel object
9000     *
9001     * @warning Should @b not be called while the hoversel is active; use
9002     * elm_hoversel_expanded_get() to check first.
9003     *
9004     * @see elm_hoversel_item_del_cb_set()
9005     * @see elm_hoversel_item_del()
9006     */
9007    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9008    /**
9009     * @brief Get the list of items within the given hoversel.
9010     *
9011     * @param obj The hoversel object
9012     * @return Returns a list of Elm_Hoversel_Item*
9013     *
9014     * @see elm_hoversel_item_add()
9015     */
9016    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9017    /**
9018     * @brief Add an item to the hoversel button
9019     *
9020     * @param obj The hoversel object
9021     * @param label The text label to use for the item (NULL if not desired)
9022     * @param icon_file An image file path on disk to use for the icon or standard
9023     * icon name (NULL if not desired)
9024     * @param icon_type The icon type if relevant
9025     * @param func Convenience function to call when this item is selected
9026     * @param data Data to pass to item-related functions
9027     * @return A handle to the item added.
9028     *
9029     * This adds an item to the hoversel to show when it is clicked. Note: if you
9030     * need to use an icon from an edje file then use
9031     * elm_hoversel_item_icon_set() right after the this function, and set
9032     * icon_file to NULL here.
9033     *
9034     * For more information on what @p icon_file and @p icon_type are see the
9035     * @ref Icon "icon documentation".
9036     */
9037    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);
9038    /**
9039     * @brief Delete an item from the hoversel
9040     *
9041     * @param item The item to delete
9042     *
9043     * This deletes the item from the hoversel (should not be called while the
9044     * hoversel is active; use elm_hoversel_expanded_get() to check first).
9045     *
9046     * @see elm_hoversel_item_add()
9047     * @see elm_hoversel_item_del_cb_set()
9048     */
9049    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
9050    /**
9051     * @brief Set the function to be called when an item from the hoversel is
9052     * freed.
9053     *
9054     * @param item The item to set the callback on
9055     * @param func The function called
9056     *
9057     * That function will receive these parameters:
9058     * @li void *item_data
9059     * @li Evas_Object *the_item_object
9060     * @li Elm_Hoversel_Item *the_object_struct
9061     *
9062     * @see elm_hoversel_item_add()
9063     */
9064    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9065    /**
9066     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
9067     * that will be passed to associated function callbacks.
9068     *
9069     * @param item The item to get the data from
9070     * @return The data pointer set with elm_hoversel_item_add()
9071     *
9072     * @see elm_hoversel_item_add()
9073     */
9074    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
9075    /**
9076     * @brief This returns the label text of the given hoversel item.
9077     *
9078     * @param item The item to get the label
9079     * @return The label text of the hoversel item
9080     *
9081     * @see elm_hoversel_item_add()
9082     */
9083    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
9084    /**
9085     * @brief This sets the icon for the given hoversel item.
9086     *
9087     * @param item The item to set the icon
9088     * @param icon_file An image file path on disk to use for the icon or standard
9089     * icon name
9090     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
9091     * to NULL if the icon is not an edje file
9092     * @param icon_type The icon type
9093     *
9094     * The icon can be loaded from the standard set, from an image file, or from
9095     * an edje file.
9096     *
9097     * @see elm_hoversel_item_add()
9098     */
9099    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);
9100    /**
9101     * @brief Get the icon object of the hoversel item
9102     *
9103     * @param item The item to get the icon from
9104     * @param icon_file The image file path on disk used for the icon or standard
9105     * icon name
9106     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
9107     * if the icon is not an edje file
9108     * @param icon_type The icon type
9109     *
9110     * @see elm_hoversel_item_icon_set()
9111     * @see elm_hoversel_item_add()
9112     */
9113    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);
9114    /**
9115     * @}
9116     */
9117
9118    /* toolbar */
9119    typedef enum _Elm_Toolbar_Shrink_Mode
9120      {
9121         ELM_TOOLBAR_SHRINK_NONE,   /**< set toolbar minimun size to fit all the items */
9122         ELM_TOOLBAR_SHRINK_HIDE,   /**< hide excess items */
9123         ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
9124         ELM_TOOLBAR_SHRINK_MENU    /**< inserts a button to pop up a menu with excess items */
9125      } Elm_Toolbar_Shrink_Mode;
9126
9127    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
9128    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
9129
9130    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9131    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
9132    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9133    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
9134    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9135    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
9136    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9137    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);
9138    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);
9139    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);
9140    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);
9141    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9142    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9143    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9144    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9145    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9146    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
9147    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9148    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9149    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9150    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
9151    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9152    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
9153    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9154    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9155    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9156    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9157    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
9158    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9159    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9160    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9161    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9162    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
9163    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9164    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
9165    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9166    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
9167    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9168    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
9169    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9170    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9171    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9172    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
9173    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9174    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
9175    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9176    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);
9177    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
9178    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
9179    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9180    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9181    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9182    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9183    EAPI void                    elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
9184    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);
9185    EAPI void                    elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9186    EAPI void                    elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
9187    EAPI const char             *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9188    EAPI void                    elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9189    EAPI const char             *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9190    EAPI void                    elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9191    EAPI void                    elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
9192    EAPI const char             *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9193    EAPI void                    elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9194    EAPI Eina_Bool               elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9195    /* smart callbacks called:
9196     * "clicked" - when the user clicks on a toolbar item and becomes selected
9197     */
9198    /* available styles:
9199     * default
9200     * transparent (no background or shadow, just show the provided content)
9201     */
9202
9203    /* tooltip */
9204    EAPI double       elm_tooltip_delay_get(void);
9205    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
9206    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
9207    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
9208    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
9209    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);
9210    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9211    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9212    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9213    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
9214    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9215    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9216    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9217    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9218    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9219    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9220
9221    /* cursors */
9222    EAPI int          elm_cursor_engine_only_get(void);
9223    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
9224
9225    /* menu */
9226    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
9227    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9228    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9229    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9230    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
9231    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
9232    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9233    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9234    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);
9235    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);
9236    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
9237    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9238    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
9239    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9240    EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9241    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9242    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9243    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9244    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9245    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
9246    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9247    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9248    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9249    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9250    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
9251    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9252    EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
9253    EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
9254    EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
9255    EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9256    EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9257
9258    /* smart callbacks called:
9259     * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
9260     */
9261
9262    /**
9263     * @defgroup List List
9264     * @ingroup Elementary
9265     *
9266     * @image html img/widget/list/preview-00.png
9267     * @image latex img/widget/list/preview-00.eps width=\textwidth
9268     *
9269     * @image html img/list.png
9270     * @image latex img/list.eps width=\textwidth
9271     *
9272     * A list widget is a container whose children are displayed vertically or
9273     * horizontally, in order, and can be selected.
9274     * The list can accept only one or multiple items selection. Also has many
9275     * modes of items displaying.
9276     *
9277     * A list is a very simple type of list widget.  For more robust
9278     * lists, @ref Genlist should probably be used.
9279     *
9280     * Smart callbacks one can listen to:
9281     * - @c "activated" - The user has double-clicked or pressed
9282     *   (enter|return|spacebar) on an item. The @c event_info parameter
9283     *   is the item that was activated.
9284     * - @c "clicked,double" - The user has double-clicked an item.
9285     *   The @c event_info parameter is the item that was double-clicked.
9286     * - "selected" - when the user selected an item
9287     * - "unselected" - when the user unselected an item
9288     * - "longpressed" - an item in the list is long-pressed
9289     * - "scroll,edge,top" - the list is scrolled until the top edge
9290     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
9291     * - "scroll,edge,left" - the list is scrolled until the left edge
9292     * - "scroll,edge,right" - the list is scrolled until the right edge
9293     *
9294     * Available styles for it:
9295     * - @c "default"
9296     *
9297     * List of examples:
9298     * @li @ref list_example_01
9299     * @li @ref list_example_02
9300     * @li @ref list_example_03
9301     */
9302
9303    /**
9304     * @addtogroup List
9305     * @{
9306     */
9307
9308    /**
9309     * @enum _Elm_List_Mode
9310     * @typedef Elm_List_Mode
9311     *
9312     * Set list's resize behavior, transverse axis scroll and
9313     * items cropping. See each mode's description for more details.
9314     *
9315     * @note Default value is #ELM_LIST_SCROLL.
9316     *
9317     * Values <b> don't </b> work as bitmaks, only one can be choosen.
9318     *
9319     * @see elm_list_mode_set()
9320     * @see elm_list_mode_get()
9321     *
9322     * @ingroup List
9323     */
9324    typedef enum _Elm_List_Mode
9325      {
9326         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. */
9327         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). */
9328         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. */
9329         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. */
9330         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
9331      } Elm_List_Mode;
9332
9333    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().  */
9334
9335    /**
9336     * Add a new list widget to the given parent Elementary
9337     * (container) object.
9338     *
9339     * @param parent The parent object.
9340     * @return a new list widget handle or @c NULL, on errors.
9341     *
9342     * This function inserts a new list widget on the canvas.
9343     *
9344     * @ingroup List
9345     */
9346    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9347
9348    /**
9349     * Starts the list.
9350     *
9351     * @param obj The list object
9352     *
9353     * @note Call before running show() on the list object.
9354     * @warning If not called, it won't display the list properly.
9355     *
9356     * @code
9357     * li = elm_list_add(win);
9358     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
9359     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
9360     * elm_list_go(li);
9361     * evas_object_show(li);
9362     * @endcode
9363     *
9364     * @ingroup List
9365     */
9366    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
9367
9368    /**
9369     * Enable or disable multiple items selection on the list object.
9370     *
9371     * @param obj The list object
9372     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
9373     * disable it.
9374     *
9375     * Disabled by default. If disabled, the user can select a single item of
9376     * the list each time. Selected items are highlighted on list.
9377     * If enabled, many items can be selected.
9378     *
9379     * If a selected item is selected again, it will be unselected.
9380     *
9381     * @see elm_list_multi_select_get()
9382     *
9383     * @ingroup List
9384     */
9385    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9386
9387    /**
9388     * Get a value whether multiple items selection is enabled or not.
9389     *
9390     * @see elm_list_multi_select_set() for details.
9391     *
9392     * @param obj The list object.
9393     * @return @c EINA_TRUE means multiple items selection is enabled.
9394     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
9395     * @c EINA_FALSE is returned.
9396     *
9397     * @ingroup List
9398     */
9399    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9400
9401    /**
9402     * Set which mode to use for the list object.
9403     *
9404     * @param obj The list object
9405     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
9406     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
9407     *
9408     * Set list's resize behavior, transverse axis scroll and
9409     * items cropping. See each mode's description for more details.
9410     *
9411     * @note Default value is #ELM_LIST_SCROLL.
9412     *
9413     * Only one can be set, if a previous one was set, it will be changed
9414     * by the new mode set. Bitmask won't work as well.
9415     *
9416     * @see elm_list_mode_get()
9417     *
9418     * @ingroup List
9419     */
9420    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
9421
9422    /**
9423     * Get the mode the list is at.
9424     *
9425     * @param obj The list object
9426     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
9427     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
9428     *
9429     * @note see elm_list_mode_set() for more information.
9430     *
9431     * @ingroup List
9432     */
9433    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9434
9435    /**
9436     * Enable or disable horizontal mode on the list object.
9437     *
9438     * @param obj The list object.
9439     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
9440     * disable it, i.e., to enable vertical mode.
9441     *
9442     * @note Vertical mode is set by default.
9443     *
9444     * On horizontal mode items are displayed on list from left to right,
9445     * instead of from top to bottom. Also, the list will scroll horizontally.
9446     * Each item will presents left icon on top and right icon, or end, at
9447     * the bottom.
9448     *
9449     * @see elm_list_horizontal_get()
9450     *
9451     * @ingroup List
9452     */
9453    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
9454
9455    /**
9456     * Get a value whether horizontal mode is enabled or not.
9457     *
9458     * @param obj The list object.
9459     * @return @c EINA_TRUE means horizontal mode selection is enabled.
9460     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
9461     * @c EINA_FALSE is returned.
9462     *
9463     * @see elm_list_horizontal_set() for details.
9464     *
9465     * @ingroup List
9466     */
9467    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9468
9469    /**
9470     * Enable or disable always select mode on the list object.
9471     *
9472     * @param obj The list object
9473     * @param always_select @c EINA_TRUE to enable always select mode or
9474     * @c EINA_FALSE to disable it.
9475     *
9476     * @note Always select mode is disabled by default.
9477     *
9478     * Default behavior of list items is to only call its callback function
9479     * the first time it's pressed, i.e., when it is selected. If a selected
9480     * item is pressed again, and multi-select is disabled, it won't call
9481     * this function (if multi-select is enabled it will unselect the item).
9482     *
9483     * If always select is enabled, it will call the callback function
9484     * everytime a item is pressed, so it will call when the item is selected,
9485     * and again when a selected item is pressed.
9486     *
9487     * @see elm_list_always_select_mode_get()
9488     * @see elm_list_multi_select_set()
9489     *
9490     * @ingroup List
9491     */
9492    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
9493
9494    /**
9495     * Get a value whether always select mode is enabled or not, meaning that
9496     * an item will always call its callback function, even if already selected.
9497     *
9498     * @param obj The list object
9499     * @return @c EINA_TRUE means horizontal mode selection is enabled.
9500     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
9501     * @c EINA_FALSE is returned.
9502     *
9503     * @see elm_list_always_select_mode_set() for details.
9504     *
9505     * @ingroup List
9506     */
9507    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9508
9509    /**
9510     * Set bouncing behaviour when the scrolled content reaches an edge.
9511     *
9512     * Tell the internal scroller object whether it should bounce or not
9513     * when it reaches the respective edges for each axis.
9514     *
9515     * @param obj The list object
9516     * @param h_bounce Whether to bounce or not in the horizontal axis.
9517     * @param v_bounce Whether to bounce or not in the vertical axis.
9518     *
9519     * @see elm_scroller_bounce_set()
9520     *
9521     * @ingroup List
9522     */
9523    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9524
9525    /**
9526     * Get the bouncing behaviour of the internal scroller.
9527     *
9528     * Get whether the internal scroller should bounce when the edge of each
9529     * axis is reached scrolling.
9530     *
9531     * @param obj The list object.
9532     * @param h_bounce Pointer where to store the bounce state of the horizontal
9533     * axis.
9534     * @param v_bounce Pointer where to store the bounce state of the vertical
9535     * axis.
9536     *
9537     * @see elm_scroller_bounce_get()
9538     * @see elm_list_bounce_set()
9539     *
9540     * @ingroup List
9541     */
9542    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9543
9544    /**
9545     * Set the scrollbar policy.
9546     *
9547     * @param obj The list object
9548     * @param policy_h Horizontal scrollbar policy.
9549     * @param policy_v Vertical scrollbar policy.
9550     *
9551     * This sets the scrollbar visibility policy for the given scroller.
9552     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
9553     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
9554     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
9555     * This applies respectively for the horizontal and vertical scrollbars.
9556     *
9557     * The both are disabled by default, i.e., are set to
9558     * #ELM_SCROLLER_POLICY_OFF.
9559     *
9560     * @ingroup List
9561     */
9562    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
9563
9564    /**
9565     * Get the scrollbar policy.
9566     *
9567     * @see elm_list_scroller_policy_get() for details.
9568     *
9569     * @param obj The list object.
9570     * @param policy_h Pointer where to store horizontal scrollbar policy.
9571     * @param policy_v Pointer where to store vertical scrollbar policy.
9572     *
9573     * @ingroup List
9574     */
9575    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);
9576
9577    /**
9578     * Append a new item to the list object.
9579     *
9580     * @param obj The list object.
9581     * @param label The label of the list item.
9582     * @param icon The icon object to use for the left side of the item. An
9583     * icon can be any Evas object, but usually it is an icon created
9584     * with elm_icon_add().
9585     * @param end The icon object to use for the right side of the item. An
9586     * icon can be any Evas object.
9587     * @param func The function to call when the item is clicked.
9588     * @param data The data to associate with the item for related callbacks.
9589     *
9590     * @return The created item or @c NULL upon failure.
9591     *
9592     * A new item will be created and appended to the list, i.e., will
9593     * be set as @b last item.
9594     *
9595     * Items created with this method can be deleted with
9596     * elm_list_item_del().
9597     *
9598     * Associated @p data can be properly freed when item is deleted if a
9599     * callback function is set with elm_list_item_del_cb_set().
9600     *
9601     * If a function is passed as argument, it will be called everytime this item
9602     * is selected, i.e., the user clicks over an unselected item.
9603     * If always select is enabled it will call this function every time
9604     * user clicks over an item (already selected or not).
9605     * If such function isn't needed, just passing
9606     * @c NULL as @p func is enough. The same should be done for @p data.
9607     *
9608     * Simple example (with no function callback or data associated):
9609     * @code
9610     * li = elm_list_add(win);
9611     * ic = elm_icon_add(win);
9612     * elm_icon_file_set(ic, "path/to/image", NULL);
9613     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
9614     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
9615     * elm_list_go(li);
9616     * evas_object_show(li);
9617     * @endcode
9618     *
9619     * @see elm_list_always_select_mode_set()
9620     * @see elm_list_item_del()
9621     * @see elm_list_item_del_cb_set()
9622     * @see elm_list_clear()
9623     * @see elm_icon_add()
9624     *
9625     * @ingroup List
9626     */
9627    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);
9628
9629    /**
9630     * Prepend a new item to the list object.
9631     *
9632     * @param obj The list object.
9633     * @param label The label of the list item.
9634     * @param icon The icon object to use for the left side of the item. An
9635     * icon can be any Evas object, but usually it is an icon created
9636     * with elm_icon_add().
9637     * @param end The icon object to use for the right side of the item. An
9638     * icon can be any Evas object.
9639     * @param func The function to call when the item is clicked.
9640     * @param data The data to associate with the item for related callbacks.
9641     *
9642     * @return The created item or @c NULL upon failure.
9643     *
9644     * A new item will be created and prepended to the list, i.e., will
9645     * be set as @b first item.
9646     *
9647     * Items created with this method can be deleted with
9648     * elm_list_item_del().
9649     *
9650     * Associated @p data can be properly freed when item is deleted if a
9651     * callback function is set with elm_list_item_del_cb_set().
9652     *
9653     * If a function is passed as argument, it will be called everytime this item
9654     * is selected, i.e., the user clicks over an unselected item.
9655     * If always select is enabled it will call this function every time
9656     * user clicks over an item (already selected or not).
9657     * If such function isn't needed, just passing
9658     * @c NULL as @p func is enough. The same should be done for @p data.
9659     *
9660     * @see elm_list_item_append() for a simple code example.
9661     * @see elm_list_always_select_mode_set()
9662     * @see elm_list_item_del()
9663     * @see elm_list_item_del_cb_set()
9664     * @see elm_list_clear()
9665     * @see elm_icon_add()
9666     *
9667     * @ingroup List
9668     */
9669    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);
9670
9671    /**
9672     * Insert a new item into the list object before item @p before.
9673     *
9674     * @param obj The list object.
9675     * @param before The list item to insert before.
9676     * @param label The label of the list item.
9677     * @param icon The icon object to use for the left side of the item. An
9678     * icon can be any Evas object, but usually it is an icon created
9679     * with elm_icon_add().
9680     * @param end The icon object to use for the right side of the item. An
9681     * icon can be any Evas object.
9682     * @param func The function to call when the item is clicked.
9683     * @param data The data to associate with the item for related callbacks.
9684     *
9685     * @return The created item or @c NULL upon failure.
9686     *
9687     * A new item will be created and added to the list. Its position in
9688     * this list will be just before item @p before.
9689     *
9690     * Items created with this method can be deleted with
9691     * elm_list_item_del().
9692     *
9693     * Associated @p data can be properly freed when item is deleted if a
9694     * callback function is set with elm_list_item_del_cb_set().
9695     *
9696     * If a function is passed as argument, it will be called everytime this item
9697     * is selected, i.e., the user clicks over an unselected item.
9698     * If always select is enabled it will call this function every time
9699     * user clicks over an item (already selected or not).
9700     * If such function isn't needed, just passing
9701     * @c NULL as @p func is enough. The same should be done for @p data.
9702     *
9703     * @see elm_list_item_append() for a simple code example.
9704     * @see elm_list_always_select_mode_set()
9705     * @see elm_list_item_del()
9706     * @see elm_list_item_del_cb_set()
9707     * @see elm_list_clear()
9708     * @see elm_icon_add()
9709     *
9710     * @ingroup List
9711     */
9712    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);
9713
9714    /**
9715     * Insert a new item into the list object after item @p after.
9716     *
9717     * @param obj The list object.
9718     * @param after The list item to insert after.
9719     * @param label The label of the list item.
9720     * @param icon The icon object to use for the left side of the item. An
9721     * icon can be any Evas object, but usually it is an icon created
9722     * with elm_icon_add().
9723     * @param end The icon object to use for the right side of the item. An
9724     * icon can be any Evas object.
9725     * @param func The function to call when the item is clicked.
9726     * @param data The data to associate with the item for related callbacks.
9727     *
9728     * @return The created item or @c NULL upon failure.
9729     *
9730     * A new item will be created and added to the list. Its position in
9731     * this list will be just after item @p after.
9732     *
9733     * Items created with this method can be deleted with
9734     * elm_list_item_del().
9735     *
9736     * Associated @p data can be properly freed when item is deleted if a
9737     * callback function is set with elm_list_item_del_cb_set().
9738     *
9739     * If a function is passed as argument, it will be called everytime this item
9740     * is selected, i.e., the user clicks over an unselected item.
9741     * If always select is enabled it will call this function every time
9742     * user clicks over an item (already selected or not).
9743     * If such function isn't needed, just passing
9744     * @c NULL as @p func is enough. The same should be done for @p data.
9745     *
9746     * @see elm_list_item_append() for a simple code example.
9747     * @see elm_list_always_select_mode_set()
9748     * @see elm_list_item_del()
9749     * @see elm_list_item_del_cb_set()
9750     * @see elm_list_clear()
9751     * @see elm_icon_add()
9752     *
9753     * @ingroup List
9754     */
9755    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);
9756
9757    /**
9758     * Insert a new item into the sorted list object.
9759     *
9760     * @param obj The list object.
9761     * @param label The label of the list item.
9762     * @param icon The icon object to use for the left side of the item. An
9763     * icon can be any Evas object, but usually it is an icon created
9764     * with elm_icon_add().
9765     * @param end The icon object to use for the right side of the item. An
9766     * icon can be any Evas object.
9767     * @param func The function to call when the item is clicked.
9768     * @param data The data to associate with the item for related callbacks.
9769     * @param cmp_func The comparing function to be used to sort list
9770     * items <b>by #Elm_List_Item item handles</b>. This function will
9771     * receive two items and compare them, returning a non-negative integer
9772     * if the second item should be place after the first, or negative value
9773     * if should be placed before.
9774     *
9775     * @return The created item or @c NULL upon failure.
9776     *
9777     * @note This function inserts values into a list object assuming it was
9778     * sorted and the result will be sorted.
9779     *
9780     * A new item will be created and added to the list. Its position in
9781     * this list will be found comparing the new item with previously inserted
9782     * items using function @p cmp_func.
9783     *
9784     * Items created with this method can be deleted with
9785     * elm_list_item_del().
9786     *
9787     * Associated @p data can be properly freed when item is deleted if a
9788     * callback function is set with elm_list_item_del_cb_set().
9789     *
9790     * If a function is passed as argument, it will be called everytime this item
9791     * is selected, i.e., the user clicks over an unselected item.
9792     * If always select is enabled it will call this function every time
9793     * user clicks over an item (already selected or not).
9794     * If such function isn't needed, just passing
9795     * @c NULL as @p func is enough. The same should be done for @p data.
9796     *
9797     * @see elm_list_item_append() for a simple code example.
9798     * @see elm_list_always_select_mode_set()
9799     * @see elm_list_item_del()
9800     * @see elm_list_item_del_cb_set()
9801     * @see elm_list_clear()
9802     * @see elm_icon_add()
9803     *
9804     * @ingroup List
9805     */
9806    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);
9807
9808    /**
9809     * Remove all list's items.
9810     *
9811     * @param obj The list object
9812     *
9813     * @see elm_list_item_del()
9814     * @see elm_list_item_append()
9815     *
9816     * @ingroup List
9817     */
9818    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9819
9820    /**
9821     * Get a list of all the list items.
9822     *
9823     * @param obj The list object
9824     * @return An @c Eina_List of list items, #Elm_List_Item,
9825     * or @c NULL on failure.
9826     *
9827     * @see elm_list_item_append()
9828     * @see elm_list_item_del()
9829     * @see elm_list_clear()
9830     *
9831     * @ingroup List
9832     */
9833    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9834
9835    /**
9836     * Get the selected item.
9837     *
9838     * @param obj The list object.
9839     * @return The selected list item.
9840     *
9841     * The selected item can be unselected with function
9842     * elm_list_item_selected_set().
9843     *
9844     * The selected item always will be highlighted on list.
9845     *
9846     * @see elm_list_selected_items_get()
9847     *
9848     * @ingroup List
9849     */
9850    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9851
9852    /**
9853     * Return a list of the currently selected list items.
9854     *
9855     * @param obj The list object.
9856     * @return An @c Eina_List of list items, #Elm_List_Item,
9857     * or @c NULL on failure.
9858     *
9859     * Multiple items can be selected if multi select is enabled. It can be
9860     * done with elm_list_multi_select_set().
9861     *
9862     * @see elm_list_selected_item_get()
9863     * @see elm_list_multi_select_set()
9864     *
9865     * @ingroup List
9866     */
9867    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9868
9869    /**
9870     * Set the selected state of an item.
9871     *
9872     * @param item The list item
9873     * @param selected The selected state
9874     *
9875     * This sets the selected state of the given item @p it.
9876     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
9877     *
9878     * If a new item is selected the previosly selected will be unselected,
9879     * unless multiple selection is enabled with elm_list_multi_select_set().
9880     * Previoulsy selected item can be get with function
9881     * elm_list_selected_item_get().
9882     *
9883     * Selected items will be highlighted.
9884     *
9885     * @see elm_list_item_selected_get()
9886     * @see elm_list_selected_item_get()
9887     * @see elm_list_multi_select_set()
9888     *
9889     * @ingroup List
9890     */
9891    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9892
9893    /*
9894     * Get whether the @p item is selected or not.
9895     *
9896     * @param item The list item.
9897     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
9898     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
9899     *
9900     * @see elm_list_selected_item_set() for details.
9901     * @see elm_list_item_selected_get()
9902     *
9903     * @ingroup List
9904     */
9905    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
9906
9907    /**
9908     * Set or unset item as a separator.
9909     *
9910     * @param it The list item.
9911     * @param setting @c EINA_TRUE to set item @p it as separator or
9912     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
9913     *
9914     * Items aren't set as separator by default.
9915     *
9916     * If set as separator it will display separator theme, so won't display
9917     * icons or label.
9918     *
9919     * @see elm_list_item_separator_get()
9920     *
9921     * @ingroup List
9922     */
9923    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
9924
9925    /**
9926     * Get a value whether item is a separator or not.
9927     *
9928     * @see elm_list_item_separator_set() for details.
9929     *
9930     * @param it The list item.
9931     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
9932     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
9933     *
9934     * @ingroup List
9935     */
9936    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
9937
9938    /**
9939     * Show @p item in the list view.
9940     *
9941     * @param item The list item to be shown.
9942     *
9943     * It won't animate list until item is visible. If such behavior is wanted,
9944     * use elm_list_bring_in() intead.
9945     *
9946     * @ingroup List
9947     */
9948    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
9949
9950    /**
9951     * Bring in the given item to list view.
9952     *
9953     * @param item The item.
9954     *
9955     * This causes list to jump to the given item @p item and show it
9956     * (by scrolling), if it is not fully visible.
9957     *
9958     * This may use animation to do so and take a period of time.
9959     *
9960     * If animation isn't wanted, elm_list_item_show() can be used.
9961     *
9962     * @ingroup List
9963     */
9964    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
9965
9966    /**
9967     * Delete them item from the list.
9968     *
9969     * @param item The item of list to be deleted.
9970     *
9971     * If deleting all list items is required, elm_list_clear()
9972     * should be used instead of getting items list and deleting each one.
9973     *
9974     * @see elm_list_clear()
9975     * @see elm_list_item_append()
9976     * @see elm_list_item_del_cb_set()
9977     *
9978     * @ingroup List
9979     */
9980    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
9981
9982    /**
9983     * Set the function called when a list item is freed.
9984     *
9985     * @param item The item to set the callback on
9986     * @param func The function called
9987     *
9988     * If there is a @p func, then it will be called prior item's memory release.
9989     * That will be called with the following arguments:
9990     * @li item's data;
9991     * @li item's Evas object;
9992     * @li item itself;
9993     *
9994     * This way, a data associated to a list item could be properly freed.
9995     *
9996     * @ingroup List
9997     */
9998    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9999
10000    /**
10001     * Get the data associated to the item.
10002     *
10003     * @param item The list item
10004     * @return The data associated to @p item
10005     *
10006     * The return value is a pointer to data associated to @p item when it was
10007     * created, with function elm_list_item_append() or similar. If no data
10008     * was passed as argument, it will return @c NULL.
10009     *
10010     * @see elm_list_item_append()
10011     *
10012     * @ingroup List
10013     */
10014    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10015
10016    /**
10017     * Get the left side icon associated to the item.
10018     *
10019     * @param item The list item
10020     * @return The left side icon associated to @p item
10021     *
10022     * The return value is a pointer to the icon associated to @p item when
10023     * it was
10024     * created, with function elm_list_item_append() or similar, or later
10025     * with function elm_list_item_icon_set(). If no icon
10026     * was passed as argument, it will return @c NULL.
10027     *
10028     * @see elm_list_item_append()
10029     * @see elm_list_item_icon_set()
10030     *
10031     * @ingroup List
10032     */
10033    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10034
10035    /**
10036     * Set the left side icon associated to the item.
10037     *
10038     * @param item The list item
10039     * @param icon The left side icon object to associate with @p item
10040     *
10041     * The icon object to use at left side of the item. An
10042     * icon can be any Evas object, but usually it is an icon created
10043     * with elm_icon_add().
10044     *
10045     * Once the icon object is set, a previously set one will be deleted.
10046     * @warning Setting the same icon for two items will cause the icon to
10047     * dissapear from the first item.
10048     *
10049     * If an icon was passed as argument on item creation, with function
10050     * elm_list_item_append() or similar, it will be already
10051     * associated to the item.
10052     *
10053     * @see elm_list_item_append()
10054     * @see elm_list_item_icon_get()
10055     *
10056     * @ingroup List
10057     */
10058    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
10059
10060    /**
10061     * Get the right side icon associated to the item.
10062     *
10063     * @param item The list item
10064     * @return The right side icon associated to @p item
10065     *
10066     * The return value is a pointer to the icon associated to @p item when
10067     * it was
10068     * created, with function elm_list_item_append() or similar, or later
10069     * with function elm_list_item_icon_set(). If no icon
10070     * was passed as argument, it will return @c NULL.
10071     *
10072     * @see elm_list_item_append()
10073     * @see elm_list_item_icon_set()
10074     *
10075     * @ingroup List
10076     */
10077    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10078
10079    /**
10080     * Set the right side icon associated to the item.
10081     *
10082     * @param item The list item
10083     * @param end The right side icon object to associate with @p item
10084     *
10085     * The icon object to use at right side of the item. An
10086     * icon can be any Evas object, but usually it is an icon created
10087     * with elm_icon_add().
10088     *
10089     * Once the icon object is set, a previously set one will be deleted.
10090     * @warning Setting the same icon for two items will cause the icon to
10091     * dissapear from the first item.
10092     *
10093     * If an icon was passed as argument on item creation, with function
10094     * elm_list_item_append() or similar, it will be already
10095     * associated to the item.
10096     *
10097     * @see elm_list_item_append()
10098     * @see elm_list_item_end_get()
10099     *
10100     * @ingroup List
10101     */
10102    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
10103
10104    /**
10105     * Gets the base object of the item.
10106     *
10107     * @param item The list item
10108     * @return The base object associated with @p item
10109     *
10110     * Base object is the @c Evas_Object that represents that item.
10111     *
10112     * @ingroup List
10113     */
10114    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10115
10116    /**
10117     * Get the label of item.
10118     *
10119     * @param item The item of list.
10120     * @return The label of item.
10121     *
10122     * The return value is a pointer to the label associated to @p item when
10123     * it was created, with function elm_list_item_append(), or later
10124     * with function elm_list_item_label_set. If no label
10125     * was passed as argument, it will return @c NULL.
10126     *
10127     * @see elm_list_item_label_set() for more details.
10128     * @see elm_list_item_append()
10129     *
10130     * @ingroup List
10131     */
10132    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10133
10134    /**
10135     * Set the label of item.
10136     *
10137     * @param item The item of list.
10138     * @param text The label of item.
10139     *
10140     * The label to be displayed by the item.
10141     * Label will be placed between left and right side icons (if set).
10142     *
10143     * If a label was passed as argument on item creation, with function
10144     * elm_list_item_append() or similar, it will be already
10145     * displayed by the item.
10146     *
10147     * @see elm_list_item_label_get()
10148     * @see elm_list_item_append()
10149     *
10150     * @ingroup List
10151     */
10152    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
10153
10154
10155    /**
10156     * Get the item before @p it in list.
10157     *
10158     * @param it The list item.
10159     * @return The item before @p it, or @c NULL if none or on failure.
10160     *
10161     * @note If it is the first item, @c NULL will be returned.
10162     *
10163     * @see elm_list_item_append()
10164     * @see elm_list_items_get()
10165     *
10166     * @ingroup List
10167     */
10168    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10169
10170    /**
10171     * Get the item after @p it in list.
10172     *
10173     * @param it The list item.
10174     * @return The item after @p it, or @c NULL if none or on failure.
10175     *
10176     * @note If it is the last item, @c NULL will be returned.
10177     *
10178     * @see elm_list_item_append()
10179     * @see elm_list_items_get()
10180     *
10181     * @ingroup List
10182     */
10183    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10184
10185    /**
10186     * Sets the disabled/enabled state of a list item.
10187     *
10188     * @param it The item.
10189     * @param disabled The disabled state.
10190     *
10191     * A disabled item cannot be selected or unselected. It will also
10192     * change its appearance (generally greyed out). This sets the
10193     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
10194     * enabled).
10195     *
10196     * @ingroup List
10197     */
10198    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10199
10200    /**
10201     * Get a value whether list item is disabled or not.
10202     *
10203     * @param it The item.
10204     * @return The disabled state.
10205     *
10206     * @see elm_list_item_disabled_set() for more details.
10207     *
10208     * @ingroup List
10209     */
10210    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10211
10212    /**
10213     * Set the text to be shown in a given list item's tooltips.
10214     *
10215     * @param item Target item.
10216     * @param text The text to set in the content.
10217     *
10218     * Setup the text as tooltip to object. The item can have only one tooltip,
10219     * so any previous tooltip data - set with this function or
10220     * elm_list_item_tooltip_content_cb_set() - is removed.
10221     *
10222     * @see elm_object_tooltip_text_set() for more details.
10223     *
10224     * @ingroup List
10225     */
10226    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
10227
10228    /**
10229     * Set the content to be shown in the tooltip item.
10230     *
10231     * Setup the tooltip to item. The item can have only one tooltip,
10232     * so any previous tooltip data is removed. @p func(with @p data) will
10233     * be called every time that need show the tooltip and it should
10234     * return a valid Evas_Object. This object is then managed fully by
10235     * tooltip system and is deleted when the tooltip is gone.
10236     *
10237     * @param item the list item being attached a tooltip.
10238     * @param func the function used to create the tooltip contents.
10239     * @param data what to provide to @a func as callback data/context.
10240     * @param del_cb called when data is not needed anymore, either when
10241     *        another callback replaces @a func, the tooltip is unset with
10242     *        elm_list_item_tooltip_unset() or the owner @a item
10243     *        dies. This callback receives as the first parameter the
10244     *        given @a data, and @c event_info is the item.
10245     *
10246     * @see elm_object_tooltip_content_cb_set() for more details.
10247     *
10248     * @ingroup List
10249     */
10250    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);
10251
10252    /**
10253     * Unset tooltip from item.
10254     *
10255     * @param item list item to remove previously set tooltip.
10256     *
10257     * Remove tooltip from item. The callback provided as del_cb to
10258     * elm_list_item_tooltip_content_cb_set() will be called to notify
10259     * it is not used anymore.
10260     *
10261     * @see elm_object_tooltip_unset() for more details.
10262     * @see elm_list_item_tooltip_content_cb_set()
10263     *
10264     * @ingroup List
10265     */
10266    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
10267
10268    /**
10269     * Sets a different style for this item tooltip.
10270     *
10271     * @note before you set a style you should define a tooltip with
10272     *       elm_list_item_tooltip_content_cb_set() or
10273     *       elm_list_item_tooltip_text_set()
10274     *
10275     * @param item list item with tooltip already set.
10276     * @param style the theme style to use (default, transparent, ...)
10277     *
10278     * @see elm_object_tooltip_style_set() for more details.
10279     *
10280     * @ingroup List
10281     */
10282    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
10283
10284    /**
10285     * Get the style for this item tooltip.
10286     *
10287     * @param item list item with tooltip already set.
10288     * @return style the theme style in use, defaults to "default". If the
10289     *         object does not have a tooltip set, then NULL is returned.
10290     *
10291     * @see elm_object_tooltip_style_get() for more details.
10292     * @see elm_list_item_tooltip_style_set()
10293     *
10294     * @ingroup List
10295     */
10296    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10297
10298    /**
10299     * Set the type of mouse pointer/cursor decoration to be shown,
10300     * when the mouse pointer is over the given list widget item
10301     *
10302     * @param item list item to customize cursor on
10303     * @param cursor the cursor type's name
10304     *
10305     * This function works analogously as elm_object_cursor_set(), but
10306     * here the cursor's changing area is restricted to the item's
10307     * area, and not the whole widget's. Note that that item cursors
10308     * have precedence over widget cursors, so that a mouse over an
10309     * item with custom cursor set will always show @b that cursor.
10310     *
10311     * If this function is called twice for an object, a previously set
10312     * cursor will be unset on the second call.
10313     *
10314     * @see elm_object_cursor_set()
10315     * @see elm_list_item_cursor_get()
10316     * @see elm_list_item_cursor_unset()
10317     *
10318     * @ingroup List
10319     */
10320    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
10321
10322    /*
10323     * Get the type of mouse pointer/cursor decoration set to be shown,
10324     * when the mouse pointer is over the given list widget item
10325     *
10326     * @param item list item with custom cursor set
10327     * @return the cursor type's name or @c NULL, if no custom cursors
10328     * were set to @p item (and on errors)
10329     *
10330     * @see elm_object_cursor_get()
10331     * @see elm_list_item_cursor_set()
10332     * @see elm_list_item_cursor_unset()
10333     *
10334     * @ingroup List
10335     */
10336    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10337
10338    /**
10339     * Unset any custom mouse pointer/cursor decoration set to be
10340     * shown, when the mouse pointer is over the given list widget
10341     * item, thus making it show the @b default cursor again.
10342     *
10343     * @param item a list item
10344     *
10345     * Use this call to undo any custom settings on this item's cursor
10346     * decoration, bringing it back to defaults (no custom style set).
10347     *
10348     * @see elm_object_cursor_unset()
10349     * @see elm_list_item_cursor_set()
10350     *
10351     * @ingroup List
10352     */
10353    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
10354
10355    /**
10356     * Set a different @b style for a given custom cursor set for a
10357     * list item.
10358     *
10359     * @param item list item with custom cursor set
10360     * @param style the <b>theme style</b> to use (e.g. @c "default",
10361     * @c "transparent", etc)
10362     *
10363     * This function only makes sense when one is using custom mouse
10364     * cursor decorations <b>defined in a theme file</b>, which can have,
10365     * given a cursor name/type, <b>alternate styles</b> on it. It
10366     * works analogously as elm_object_cursor_style_set(), but here
10367     * applyed only to list item objects.
10368     *
10369     * @warning Before you set a cursor style you should have definen a
10370     *       custom cursor previously on the item, with
10371     *       elm_list_item_cursor_set()
10372     *
10373     * @see elm_list_item_cursor_engine_only_set()
10374     * @see elm_list_item_cursor_style_get()
10375     *
10376     * @ingroup List
10377     */
10378    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
10379
10380    /**
10381     * Get the current @b style set for a given list item's custom
10382     * cursor
10383     *
10384     * @param item list item with custom cursor set.
10385     * @return style the cursor style in use. If the object does not
10386     *         have a cursor set, then @c NULL is returned.
10387     *
10388     * @see elm_list_item_cursor_style_set() for more details
10389     *
10390     * @ingroup List
10391     */
10392    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10393
10394    /**
10395     * Set if the (custom)cursor for a given list item should be
10396     * searched in its theme, also, or should only rely on the
10397     * rendering engine.
10398     *
10399     * @param item item with custom (custom) cursor already set on
10400     * @param engine_only Use @c EINA_TRUE to have cursors looked for
10401     * only on those provided by the rendering engine, @c EINA_FALSE to
10402     * have them searched on the widget's theme, as well.
10403     *
10404     * @note This call is of use only if you've set a custom cursor
10405     * for list items, with elm_list_item_cursor_set().
10406     *
10407     * @note By default, cursors will only be looked for between those
10408     * provided by the rendering engine.
10409     *
10410     * @ingroup List
10411     */
10412    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10413
10414    /**
10415     * Get if the (custom) cursor for a given list item is being
10416     * searched in its theme, also, or is only relying on the rendering
10417     * engine.
10418     *
10419     * @param item a list item
10420     * @return @c EINA_TRUE, if cursors are being looked for only on
10421     * those provided by the rendering engine, @c EINA_FALSE if they
10422     * are being searched on the widget's theme, as well.
10423     *
10424     * @see elm_list_item_cursor_engine_only_set(), for more details
10425     *
10426     * @ingroup List
10427     */
10428    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10429
10430    /**
10431     * @}
10432     */
10433
10434    /* slider */
10435    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10436    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10437    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10438    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10439    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10440    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10441    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
10442    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10443    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10444    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
10445    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10446    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
10447    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10448    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
10449    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10450   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);
10451   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);
10452    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10453    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10454    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
10455    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
10456    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
10457    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10458    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
10459    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10460    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
10461    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10462    /* smart callbacks called:
10463     * "changed" - Whenever the slider value is changed by the user.
10464     * "slider,drag,start" - dragging the slider indicator around has started
10465     * "slider,drag,stop" - dragging the slider indicator around has stopped
10466     * "delay,changed" - A short time after the value is changed by the user.
10467     *                   This will be called only when the user stops dragging for a very short
10468     *                   period or when they release their finger/mouse, so it avoids possibly
10469     *                   expensive reactions to the value change.
10470     */
10471
10472    /**
10473     * @addtogroup Actionslider Actionslider
10474     *
10475     * @image html img/icon/actionslider/preview-00.png
10476     * @image latex img/icon/actionslider/preview-00.png
10477     *
10478     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
10479     * properties. The indicator is the element the user drags to choose a label.
10480     * When the position is set with magnet, when released the indicator will be
10481     * moved to it if it's nearest the magnetized position.
10482     *
10483     * @note By default all positions are set as enabled.
10484     *
10485     * Signals that you can add callbacks for are:
10486     *
10487     * "selected" - when user selects an enabled position (the label is passed
10488     *              as event info)".
10489     * @n
10490     * "pos_changed" - when the indicator reaches any of the positions("left",
10491     *                 "right" or "center").
10492     *
10493     * See an example of actionslider usage @ref actionslider_example_page "here"
10494     * @{
10495     */
10496    typedef enum _Elm_Actionslider_Pos
10497      {
10498         ELM_ACTIONSLIDER_NONE = 0,
10499         ELM_ACTIONSLIDER_LEFT = 1 << 0,
10500         ELM_ACTIONSLIDER_CENTER = 1 << 1,
10501         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
10502         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
10503      } Elm_Actionslider_Pos;
10504
10505    /**
10506     * Add a new actionslider to the parent.
10507     *
10508     * @param parent The parent object
10509     * @return The new actionslider object or NULL if it cannot be created
10510     */
10511    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10512    /**
10513     * Set actionslider labels.
10514     *
10515     * @param obj The actionslider object
10516     * @param left_label The label to be set on the left.
10517     * @param center_label The label to be set on the center.
10518     * @param right_label The label to be set on the right.
10519     * @deprecated use elm_object_text_set() instead.
10520     */
10521    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);
10522    /**
10523     * Get actionslider labels.
10524     *
10525     * @param obj The actionslider object
10526     * @param left_label A char** to place the left_label of @p obj into.
10527     * @param center_label A char** to place the center_label of @p obj into.
10528     * @param right_label A char** to place the right_label of @p obj into.
10529     * @deprecated use elm_object_text_set() instead.
10530     */
10531    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);
10532    /**
10533     * Get actionslider selected label.
10534     *
10535     * @param obj The actionslider object
10536     * @return The selected label
10537     */
10538    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10539    /**
10540     * Set actionslider indicator position.
10541     *
10542     * @param obj The actionslider object.
10543     * @param pos The position of the indicator.
10544     */
10545    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
10546    /**
10547     * Get actionslider indicator position.
10548     *
10549     * @param obj The actionslider object.
10550     * @return The position of the indicator.
10551     */
10552    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10553    /**
10554     * Set actionslider magnet position. To make multiple positions magnets @c or
10555     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
10556     *
10557     * @param obj The actionslider object.
10558     * @param pos Bit mask indicating the magnet positions.
10559     */
10560    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
10561    /**
10562     * Get actionslider magnet position.
10563     *
10564     * @param obj The actionslider object.
10565     * @return The positions with magnet property.
10566     */
10567    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10568    /**
10569     * Set actionslider enabled position. To set multiple positions as enabled @c or
10570     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
10571     *
10572     * @note All the positions are enabled by default.
10573     *
10574     * @param obj The actionslider object.
10575     * @param pos Bit mask indicating the enabled positions.
10576     */
10577    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
10578    /**
10579     * Get actionslider enabled position.
10580     *
10581     * @param obj The actionslider object.
10582     * @return The enabled positions.
10583     */
10584    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10585    /**
10586     * Set the label used on the indicator.
10587     *
10588     * @param obj The actionslider object
10589     * @param label The label to be set on the indicator.
10590     * @deprecated use elm_object_text_set() instead.
10591     */
10592    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10593    /**
10594     * Get the label used on the indicator object.
10595     *
10596     * @param obj The actionslider object
10597     * @return The indicator label
10598     * @deprecated use elm_object_text_set() instead.
10599     */
10600    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10601    /**
10602     * @}
10603     */
10604
10605    /* genlist */
10606    typedef enum _Elm_Genlist_Item_Flags
10607      {
10608         ELM_GENLIST_ITEM_NONE = 0,
10609         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
10610         ELM_GENLIST_ITEM_GROUP = (1 << 1)
10611      } Elm_Genlist_Item_Flags;
10612    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
10613    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
10614    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
10615    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
10616    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
10617    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
10618    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
10619    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
10620
10621    struct _Elm_Genlist_Item_Class
10622      {
10623         const char                *item_style;
10624         struct
10625           {
10626              GenlistItemLabelGetFunc  label_get;
10627              GenlistItemIconGetFunc   icon_get;
10628              GenlistItemStateGetFunc  state_get;
10629              GenlistItemDelFunc       del;
10630              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
10631           } func;
10632         const char                *mode_item_style;
10633      };
10634
10635    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10636    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10637    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
10638    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10639    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
10640    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10641    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
10642    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10643    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10644    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10645    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
10646    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10647    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
10648    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10649    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
10650    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
10651    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
10652    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10653    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
10654    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10655    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10656    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10657    /* operations to add items */
10658    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);
10659    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);
10660    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);
10661    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);
10662    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);
10663    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);
10664    /* operations to retrieve existing items */
10665    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10666    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10667    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10668    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);
10669    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10670    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10671    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
10672    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);
10673    /* available item styles:
10674     * default
10675     * default_style - The text part is a textblock
10676     * double_label
10677     * icon_top_text_bottom
10678     */
10679    /* Genlist Item operation */
10680    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10681    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10682    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10683    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10684    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10685    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
10686    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10687    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
10688    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10689    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10690    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10691    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10692    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
10693    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10694    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10695    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10696    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10697    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10698    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10699    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10700    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10701    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10702    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
10703    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10704    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10705    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10706    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
10707    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10708    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
10709    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);
10710    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10711    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
10712    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10713    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
10714    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10715    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10716    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
10717    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10718    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10719    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10720    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
10721    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
10722    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10723    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10724    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
10725    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10726    /* Signals that you can add callbacks for are:
10727     * - @c "activated" - The user has double-clicked or pressed
10728     *   (enter|return|spacebar) on an item. The @c event_info parameter
10729     *   is the item that was activated.
10730     * - @c "clicked,double" - The user has double-clicked an item.
10731     *   The @c event_info parameter is the item that was double-clicked.
10732     * "selected" - This is called when a user has made an item selected. The
10733     *              event_info parameter is the genlist item that was selected.
10734     * "unselected" - This is called when a user has made an item unselected. The
10735     *                 event_info parameter is the genlist item that was
10736     *                 unselected.
10737     * "expanded" - This is called when elm_genlist_item_expanded_set() is called
10738     *              and the item is now meant to be expanded. The event_info
10739     *              parameter is the genlist item that was indicated to expand.
10740     *              It is the job of this callback to then fill in the child
10741     *              items.
10742     * "contracted" - This is called when elm_genlist_item_expanded_set() is
10743     *                called and the item is now meant to be contracted. The
10744     *                event_info parameter is the genlist item that was indicated
10745     *                to contract. It is the job of this callback to then delete
10746     *                the child items.
10747     * "expand,request" - This is called when a user has indicated they want to
10748     *                    expand a tree branch item. The callback should decide
10749     *                    if the item can expand (has any children) and then call
10750     *                    elm_genlist_item_expanded_set() appropriately to set
10751     *                    the state. The event_info parameter is the genlist item
10752     *                    that was indicated to expand.
10753     * "contract,request" - This is called when a user has indicated they want to
10754     *                      contract a tree branch item. The callback should
10755     *                      decide if the item can contract (has any children)
10756     *                      and then call elm_genlist_item_expanded_set()
10757     *                      appropriately to set the state. The event_info
10758     *                      parameter is the genlist item that was indicated to
10759     *                      contract.
10760     * "realized" - This is called when the item in the list is created as a real
10761     *              evas object. event_info parameter is the genlist item that
10762     *              was created. The object may be deleted at any time, so it is
10763     *              up to the caller to not use the object pointer from
10764     *              elm_genlist_item_object_get() in a way where it may point to
10765     *              freed objects.
10766     * "unrealized" - This is called just before an item is unrealized. After
10767     *                this call icon objects provided will be deleted and the
10768     *                item object itself delete or be put into a floating cache.
10769     * "drag,start,up" - This is called when the item in the list has been
10770     *                   dragged (not scrolled) up.
10771     * "drag,start,down" - This is called when the item in the list has been
10772     *                     dragged (not scrolled) down.
10773     * "drag,start,left" - This is called when the item in the list has been
10774     *                     dragged (not scrolled) left.
10775     * "drag,start,right" - This is called when the item in the list has been
10776     *                      dragged (not scrolled) right.
10777     * "drag,stop" - This is called when the item in the list has stopped being
10778     *               dragged.
10779     * "drag" - This is called when the item in the list is being dragged.
10780     * "longpressed" - This is called when the item is pressed for a certain
10781     *                 amount of time. By default it's 1 second.
10782     * "scroll,edge,top" - This is called when the genlist is scrolled until the
10783     *                     top edge.
10784     * "scroll,edge,bottom" - This is called when the genlist is scrolled until
10785     *                        the bottom edge.
10786     * "scroll,edge,left" - This is called when the genlist is scrolled until the
10787     *                      left edge.
10788     * "scroll,edge,right" - This is called when the genlist is scrolled until
10789     *                       the right edge.
10790     * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
10791     *                       left.
10792     * "multi,swipe,right" - This is called when the genlist is multi-touch
10793     *                       swiped right.
10794     * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
10795     *                    up.
10796     * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
10797     *                      down.
10798     * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
10799     *                     out.
10800     * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
10801     *                    in.
10802     * "swipe" - This is called when the genlist is swiped.
10803     */
10804
10805    /**
10806     * @page tutorial_check Check example
10807     * @dontinclude check_example_01.c
10808     *
10809     * This example will show 2 checkboxes, one with just a label and the second
10810     * one with both a label and an icon. This example also ilustrates how to
10811     * have the checkbox change the value of a variable and how to react to those
10812     * changes.
10813     *
10814     * We will start with the usual setup code:
10815     * @until show(bg)
10816     *
10817     * And now we create our first checkbox, set its label, tell it to change
10818     * the value of @p value when the checkbox stats is changed and ask to be
10819     * notified of state changes:
10820     * @until show
10821     *
10822     * For our second checkbox we are going to set an icon so we need to create
10823     * and icon:
10824     * @until show
10825     * @note For simplicity we are using a rectangle as icon, but any evas object
10826     * can be used.
10827     *
10828     * And for our second checkbox we set the label, icon and state to true:
10829     * @until show
10830     *
10831     * We now do some more setup:
10832     * @until ELM_MAIN
10833     *
10834     * And finally implement the callback that will be called when the first
10835     * checkbox's state changes. This callback will use @p data to print a
10836     * message:
10837     * @until }
10838     * @note This work because @p data is @p value(from the main function) and @p
10839     * value is changed when the checkbox is changed.
10840     *
10841     * Our example will look like this:
10842     *
10843     * @image html screenshots/check_example_01.png
10844     * @image latex screenshots/check_example_01.eps width=\textwidth
10845     *
10846     * @example check_example_01.c
10847     */
10848    /**
10849     * @defgroup Check Check
10850     *
10851     * @image html img/widget/button/preview-00.png
10852     * @image html img/widget/button/preview-01.png
10853     * @image html img/widget/button/preview-02.png
10854     *
10855     * @brief The check widget allows for toggling a value between true and
10856     * false.
10857     *
10858     * Check objects are a lot like radio objects in layout and functionality
10859     * except they do not work as a group, but independently and only toggle the
10860     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
10861     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
10862     * returns the current state. For convenience, like the radio objects, you
10863     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
10864     * for it to modify.
10865     *
10866     * Signals that you can add callbacks for are:
10867     * "changed" - This is called whenever the user changes the state of one of
10868     *             the check object(event_info is NULL).
10869     *
10870     * @ref tutorial_check should give you a firm grasp of how to use this widget.
10871     * @{
10872     */
10873    /**
10874     * @brief Add a new Check object
10875     *
10876     * @param parent The parent object
10877     * @return The new object or NULL if it cannot be created
10878     */
10879    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10880    /**
10881     * @brief Set the text label of the check object
10882     *
10883     * @param obj The check object
10884     * @param label The text label string in UTF-8
10885     *
10886     * @deprecated use elm_object_text_set() instead.
10887     */
10888    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10889    /**
10890     * @brief Get the text label of the check object
10891     *
10892     * @param obj The check object
10893     * @return The text label string in UTF-8
10894     *
10895     * @deprecated use elm_object_text_get() instead.
10896     */
10897    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10898    /**
10899     * @brief Set the icon object of the check object
10900     *
10901     * @param obj The check object
10902     * @param icon The icon object
10903     *
10904     * Once the icon object is set, a previously set one will be deleted.
10905     * If you want to keep that old content object, use the
10906     * elm_check_icon_unset() function.
10907     */
10908    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10909    /**
10910     * @brief Get the icon object of the check object
10911     *
10912     * @param obj The check object
10913     * @return The icon object
10914     */
10915    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10916    /**
10917     * @brief Unset the icon used for the check object
10918     *
10919     * @param obj The check object
10920     * @return The icon object that was being used
10921     *
10922     * Unparent and return the icon object which was set for this widget.
10923     */
10924    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10925    /**
10926     * @brief Set the on/off state of the check object
10927     *
10928     * @param obj The check object
10929     * @param state The state to use (1 == on, 0 == off)
10930     *
10931     * This sets the state of the check. If set
10932     * with elm_check_state_pointer_set() the state of that variable is also
10933     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
10934     */
10935    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
10936    /**
10937     * @brief Get the state of the check object
10938     *
10939     * @param obj The check object
10940     * @return The boolean state
10941     */
10942    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10943    /**
10944     * @brief Set a convenience pointer to a boolean to change
10945     *
10946     * @param obj The check object
10947     * @param statep Pointer to the boolean to modify
10948     *
10949     * This sets a pointer to a boolean, that, in addition to the check objects
10950     * state will also be modified directly. To stop setting the object pointed
10951     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
10952     * then when this is called, the check objects state will also be modified to
10953     * reflect the value of the boolean @p statep points to, just like calling
10954     * elm_check_state_set().
10955     */
10956    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
10957    /**
10958     * @}
10959     */
10960
10961    /**
10962     * @defgroup Radio Radio
10963     *
10964     * @image html img/widget/radio/preview-00.png
10965     * @image latex img/widget/radio/preview-00.eps
10966     *
10967     * @brief Radio is a widget that allows for 1 or more options to be displayed
10968     * and have the user choose only 1 of them.
10969     *
10970     * A radio object contains an indicator, an optional Label and an optional
10971     * icon object. While it's possible to have a group of only one radio they,
10972     * are normally used in groups of 2 or more. To add a radio to a group use
10973     * elm_radio_group_add(). The radio object(s) will select from one of a set
10974     * of integer values, so any value they are configuring needs to be mapped to
10975     * a set of integers. To configure what value that radio object represents,
10976     * use  elm_radio_state_value_set() to set the integer it represents. To set
10977     * the value the whole group(which one is currently selected) is to indicate
10978     * use elm_radio_value_set() on any group member, and to get the groups value
10979     * use elm_radio_value_get(). For convenience the radio objects are also able
10980     * to directly set an integer(int) to the value that is selected. To specify
10981     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
10982     * The radio objects will modify this directly. That implies the pointer must
10983     * point to valid memory for as long as the radio objects exist.
10984     *
10985     * Signals that you can add callbacks for are:
10986     * @li changed - This is called whenever the user changes the state of one of
10987     * the radio objects within the group of radio objects that work together.
10988     *
10989     * @ref tutorial_radio show most of this API in action.
10990     * @{
10991     */
10992    /**
10993     * @brief Add a new radio to the parent
10994     *
10995     * @param parent The parent object
10996     * @return The new object or NULL if it cannot be created
10997     */
10998    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10999    /**
11000     * @brief Set the text label of the radio object
11001     *
11002     * @param obj The radio object
11003     * @param label The text label string in UTF-8
11004     *
11005     * @deprecated use elm_object_text_set() instead.
11006     */
11007    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11008    /**
11009     * @brief Get the text label of the radio object
11010     *
11011     * @param obj The radio object
11012     * @return The text label string in UTF-8
11013     *
11014     * @deprecated use elm_object_text_set() instead.
11015     */
11016    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11017    /**
11018     * @brief Set the icon object of the radio object
11019     *
11020     * @param obj The radio object
11021     * @param icon The icon object
11022     *
11023     * Once the icon object is set, a previously set one will be deleted. If you
11024     * want to keep that old content object, use the elm_radio_icon_unset()
11025     * function.
11026     */
11027    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11028    /**
11029     * @brief Get the icon object of the radio object
11030     *
11031     * @param obj The radio object
11032     * @return The icon object
11033     *
11034     * @see elm_radio_icon_set()
11035     */
11036    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11037    /**
11038     * @brief Unset the icon used for the radio object
11039     *
11040     * @param obj The radio object
11041     * @return The icon object that was being used
11042     *
11043     * Unparent and return the icon object which was set for this widget.
11044     *
11045     * @see elm_radio_icon_set()
11046     */
11047    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11048    /**
11049     * @brief Add this radio to a group of other radio objects
11050     *
11051     * @param obj The radio object
11052     * @param group Any object whose group the @p obj is to join.
11053     *
11054     * Radio objects work in groups. Each member should have a different integer
11055     * value assigned. In order to have them work as a group, they need to know
11056     * about each other. This adds the given radio object to the group of which
11057     * the group object indicated is a member.
11058     */
11059    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
11060    /**
11061     * @brief Set the integer value that this radio object represents
11062     *
11063     * @param obj The radio object
11064     * @param value The value to use if this radio object is selected
11065     *
11066     * This sets the value of the radio.
11067     */
11068    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
11069    /**
11070     * @brief Get the integer value that this radio object represents
11071     *
11072     * @param obj The radio object
11073     * @return The value used if this radio object is selected
11074     *
11075     * This gets the value of the radio.
11076     *
11077     * @see elm_radio_value_set()
11078     */
11079    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11080    /**
11081     * @brief Set the value of the radio.
11082     *
11083     * @param obj The radio object
11084     * @param value The value to use for the group
11085     *
11086     * This sets the value of the radio group and will also set the value if
11087     * pointed to, to the value supplied, but will not call any callbacks.
11088     */
11089    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
11090    /**
11091     * @brief Get the state of the radio object
11092     *
11093     * @param obj The radio object
11094     * @return The integer state
11095     */
11096    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11097    /**
11098     * @brief Set a convenience pointer to a integer to change
11099     *
11100     * @param obj The radio object
11101     * @param valuep Pointer to the integer to modify
11102     *
11103     * This sets a pointer to a integer, that, in addition to the radio objects
11104     * state will also be modified directly. To stop setting the object pointed
11105     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
11106     * when this is called, the radio objects state will also be modified to
11107     * reflect the value of the integer valuep points to, just like calling
11108     * elm_radio_value_set().
11109     */
11110    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
11111    /**
11112     * @}
11113     */
11114
11115    /**
11116     * @defgroup Pager Pager
11117     *
11118     * @image html img/widget/pager/preview-00.png
11119     * @image latex img/widget/pager/preview-00.eps
11120     *
11121     * @brief Widget that allows flipping between 1 or more “pages” of objects.
11122     *
11123     * The flipping between “pages” of objects is animated. All content in pager
11124     * is kept in a stack, the last content to be added will be on the top of the
11125     * stack(be visible).
11126     *
11127     * Objects can be pushed or popped from the stack or deleted as normal.
11128     * Pushes and pops will animate (and a pop will delete the object once the
11129     * animation is finished). Any object already in the pager can be promoted to
11130     * the top(from its current stacking position) through the use of
11131     * elm_pager_content_promote(). Objects are pushed to the top with
11132     * elm_pager_content_push() and when the top item is no longer wanted, simply
11133     * pop it with elm_pager_content_pop() and it will also be deleted. If an
11134     * object is no longer needed and is not the top item, just delete it as
11135     * normal. You can query which objects are the top and bottom with
11136     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
11137     *
11138     * Signals that you can add callbacks for are:
11139     * "hide,finished" - when the previous page is hided
11140     *
11141     * This widget has the following styles available:
11142     * @li default
11143     * @li fade
11144     * @li fade_translucide
11145     * @li fade_invisible
11146     * @note This styles affect only the flipping animations, the appearance when
11147     * not animating is unaffected by styles.
11148     *
11149     * @ref tutorial_pager gives a good overview of the usage of the API.
11150     * @{
11151     */
11152    /**
11153     * Add a new pager to the parent
11154     *
11155     * @param parent The parent object
11156     * @return The new object or NULL if it cannot be created
11157     *
11158     * @ingroup Pager
11159     */
11160    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11161    /**
11162     * @brief Push an object to the top of the pager stack (and show it).
11163     *
11164     * @param obj The pager object
11165     * @param content The object to push
11166     *
11167     * The object pushed becomes a child of the pager, it will be controlled and
11168     * deleted when the pager is deleted.
11169     *
11170     * @note If the content is already in the stack use
11171     * elm_pager_content_promote().
11172     * @warning Using this function on @p content already in the stack results in
11173     * undefined behavior.
11174     */
11175    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11176    /**
11177     * @brief Pop the object that is on top of the stack
11178     *
11179     * @param obj The pager object
11180     *
11181     * This pops the object that is on the top(visible) of the pager, makes it
11182     * disappear, then deletes the object. The object that was underneath it on
11183     * the stack will become visible.
11184     */
11185    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
11186    /**
11187     * @brief Moves an object already in the pager stack to the top of the stack.
11188     *
11189     * @param obj The pager object
11190     * @param content The object to promote
11191     *
11192     * This will take the @p content and move it to the top of the stack as
11193     * if it had been pushed there.
11194     *
11195     * @note If the content isn't already in the stack use
11196     * elm_pager_content_push().
11197     * @warning Using this function on @p content not already in the stack
11198     * results in undefined behavior.
11199     */
11200    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11201    /**
11202     * @brief Return the object at the bottom of the pager stack
11203     *
11204     * @param obj The pager object
11205     * @return The bottom object or NULL if none
11206     */
11207    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11208    /**
11209     * @brief  Return the object at the top of the pager stack
11210     *
11211     * @param obj The pager object
11212     * @return The top object or NULL if none
11213     */
11214    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11215    /**
11216     * @}
11217     */
11218
11219    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
11220    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
11221    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
11222    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
11223    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
11224
11225    struct _Elm_Slideshow_Item_Class
11226      {
11227         struct _Elm_Slideshow_Item_Class_Func
11228           {
11229              SlideshowItemGetFunc get;
11230              SlideshowItemDelFunc del;
11231           } func;
11232      };
11233
11234    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11235    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
11236    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);
11237    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
11238    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11239    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
11240    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11241    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
11242    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11243    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
11244    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11245    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
11246    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11247    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11248    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11249    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
11250    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
11251    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11252    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
11253    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
11254    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11255    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
11256    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11257    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
11258    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11259    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
11260    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11261    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11262    /* smart callbacks called:
11263     * "changed" - when the slideshow switch to another item
11264     */
11265
11266    /**
11267     * @defgroup Fileselector File Selector
11268     *
11269     * @image html img/icon/fileselector/preview-00.png
11270     * @image latex img/icon/fileselector/preview-00.png
11271     *
11272     * A file selector is a widget that allows a user to navigate
11273     * through a file system, reporting file selections back via its
11274     * API.
11275     *
11276     * It contains shortcut buttons for home directory (@c ~) and to
11277     * jump one directory upwards (..), as well as cancel/ok buttons to
11278     * confirm/cancel a given selection. After either one of those two
11279     * former actions, the file selector will issue its @c "done" smart
11280     * callback.
11281     *
11282     * There's a text entry on it, too, showing the name of the current
11283     * selection. There's the possibility of making it editable, so it
11284     * is useful on file saving dialogs on applications, where one
11285     * gives a file name to save contents to, in a given directory in
11286     * the system. This custom file name will be reported on the @c
11287     * "done" smart callback (explained in sequence).
11288     *
11289     * Finally, it has a view to display file system items into in two
11290     * possible forms:
11291     * - list
11292     * - grid
11293     *
11294     * If Elementary is built with support of the Ethumb thumbnailing
11295     * library, the second form of view will display preview thumbnails
11296     * of files which it supports.
11297     *
11298     * Smart callbacks one can register to:
11299     *
11300     * - @c "selected" - the user has clicked on a file (when not in
11301     *      folders-only mode) or directory (when in folders-only mode)
11302     * - @c "directory,open" - the list has been populated with new
11303     *      content (@c event_info is a pointer to the directory's
11304     *      path, a @b stringshared string)
11305     * - @c "done" - the user has clicked on the "ok" or "cancel"
11306     *      buttons (@c event_info is a pointer to the selection's
11307     *      path, a @b stringshared string)
11308     *
11309     * Here is an example on its usage:
11310     * @li @ref fileselector_example
11311     */
11312
11313    /**
11314     * @addtogroup Fileselector
11315     * @{
11316     */
11317
11318    /**
11319     * Defines how a file selector widget is to layout its contents
11320     * (file system entries).
11321     */
11322    typedef enum _Elm_Fileselector_Mode
11323      {
11324         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
11325         ELM_FILESELECTOR_GRID, /**< layout as a grid */
11326         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
11327      } Elm_Fileselector_Mode;
11328
11329    /**
11330     * Add a new file selector widget to the given parent Elementary
11331     * (container) object
11332     *
11333     * @param parent The parent object
11334     * @return a new file selector widget handle or @c NULL, on errors
11335     *
11336     * This function inserts a new file selector widget on the canvas.
11337     *
11338     * @ingroup Fileselector
11339     */
11340    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11341
11342    /**
11343     * Enable/disable the file name entry box where the user can type
11344     * in a name for a file, in a given file selector widget
11345     *
11346     * @param obj The file selector object
11347     * @param is_save @c EINA_TRUE to make the file selector a "saving
11348     * dialog", @c EINA_FALSE otherwise
11349     *
11350     * Having the entry editable is useful on file saving dialogs on
11351     * applications, where one gives a file name to save contents to,
11352     * in a given directory in the system. This custom file name will
11353     * be reported on the @c "done" smart callback.
11354     *
11355     * @see elm_fileselector_is_save_get()
11356     *
11357     * @ingroup Fileselector
11358     */
11359    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
11360
11361    /**
11362     * Get whether the given file selector is in "saving dialog" mode
11363     *
11364     * @param obj The file selector object
11365     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
11366     * mode, @c EINA_FALSE otherwise (and on errors)
11367     *
11368     * @see elm_fileselector_is_save_set() for more details
11369     *
11370     * @ingroup Fileselector
11371     */
11372    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11373
11374    /**
11375     * Enable/disable folder-only view for a given file selector widget
11376     *
11377     * @param obj The file selector object
11378     * @param only @c EINA_TRUE to make @p obj only display
11379     * directories, @c EINA_FALSE to make files to be displayed in it
11380     * too
11381     *
11382     * If enabled, the widget's view will only display folder items,
11383     * naturally.
11384     *
11385     * @see elm_fileselector_folder_only_get()
11386     *
11387     * @ingroup Fileselector
11388     */
11389    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
11390
11391    /**
11392     * Get whether folder-only view is set for a given file selector
11393     * widget
11394     *
11395     * @param obj The file selector object
11396     * @return only @c EINA_TRUE if @p obj is only displaying
11397     * directories, @c EINA_FALSE if files are being displayed in it
11398     * too (and on errors)
11399     *
11400     * @see elm_fileselector_folder_only_get()
11401     *
11402     * @ingroup Fileselector
11403     */
11404    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11405
11406    /**
11407     * Enable/disable the "ok" and "cancel" buttons on a given file
11408     * selector widget
11409     *
11410     * @param obj The file selector object
11411     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
11412     *
11413     * @note A file selector without those buttons will never emit the
11414     * @c "done" smart event, and is only usable if one is just hooking
11415     * to the other two events.
11416     *
11417     * @see elm_fileselector_buttons_ok_cancel_get()
11418     *
11419     * @ingroup Fileselector
11420     */
11421    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
11422
11423    /**
11424     * Get whether the "ok" and "cancel" buttons on a given file
11425     * selector widget are being shown.
11426     *
11427     * @param obj The file selector object
11428     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
11429     * otherwise (and on errors)
11430     *
11431     * @see elm_fileselector_buttons_ok_cancel_set() for more details
11432     *
11433     * @ingroup Fileselector
11434     */
11435    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11436
11437    /**
11438     * Enable/disable a tree view in the given file selector widget,
11439     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
11440     *
11441     * @param obj The file selector object
11442     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
11443     * disable
11444     *
11445     * In a tree view, arrows are created on the sides of directories,
11446     * allowing them to expand in place.
11447     *
11448     * @note If it's in other mode, the changes made by this function
11449     * will only be visible when one switches back to "list" mode.
11450     *
11451     * @see elm_fileselector_expandable_get()
11452     *
11453     * @ingroup Fileselector
11454     */
11455    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
11456
11457    /**
11458     * Get whether tree view is enabled for the given file selector
11459     * widget
11460     *
11461     * @param obj The file selector object
11462     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
11463     * otherwise (and or errors)
11464     *
11465     * @see elm_fileselector_expandable_set() for more details
11466     *
11467     * @ingroup Fileselector
11468     */
11469    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11470
11471    /**
11472     * Set, programmatically, the @b directory that a given file
11473     * selector widget will display contents from
11474     *
11475     * @param obj The file selector object
11476     * @param path The path to display in @p obj
11477     *
11478     * This will change the @b directory that @p obj is displaying. It
11479     * will also clear the text entry area on the @p obj object, which
11480     * displays select files' names.
11481     *
11482     * @see elm_fileselector_path_get()
11483     *
11484     * @ingroup Fileselector
11485     */
11486    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
11487
11488    /**
11489     * Get the parent directory's path that a given file selector
11490     * widget is displaying
11491     *
11492     * @param obj The file selector object
11493     * @return The (full) path of the directory the file selector is
11494     * displaying, a @b stringshared string
11495     *
11496     * @see elm_fileselector_path_set()
11497     *
11498     * @ingroup Fileselector
11499     */
11500    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11501
11502    /**
11503     * Set, programmatically, the currently selected file/directory in
11504     * the given file selector widget
11505     *
11506     * @param obj The file selector object
11507     * @param path The (full) path to a file or directory
11508     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
11509     * latter case occurs if the directory or file pointed to do not
11510     * exist.
11511     *
11512     * @see elm_fileselector_selected_get()
11513     *
11514     * @ingroup Fileselector
11515     */
11516    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
11517
11518    /**
11519     * Get the currently selected item's (full) path, in the given file
11520     * selector widget
11521     *
11522     * @param obj The file selector object
11523     * @return The absolute path of the selected item, a @b
11524     * stringshared string
11525     *
11526     * @note Custom editions on @p obj object's text entry, if made,
11527     * will appear on the return string of this function, naturally.
11528     *
11529     * @see elm_fileselector_selected_set() for more details
11530     *
11531     * @ingroup Fileselector
11532     */
11533    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11534
11535    /**
11536     * Set the mode in which a given file selector widget will display
11537     * (layout) file system entries in its view
11538     *
11539     * @param obj The file selector object
11540     * @param mode The mode of the fileselector, being it one of
11541     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
11542     * first one, naturally, will display the files in a list. The
11543     * latter will make the widget to display its entries in a grid
11544     * form.
11545     *
11546     * @note By using elm_fileselector_expandable_set(), the user may
11547     * trigger a tree view for that list.
11548     *
11549     * @note If Elementary is built with support of the Ethumb
11550     * thumbnailing library, the second form of view will display
11551     * preview thumbnails of files which it supports. You must have
11552     * elm_need_ethumb() called in your Elementary for thumbnailing to
11553     * work, though.
11554     *
11555     * @see elm_fileselector_expandable_set().
11556     * @see elm_fileselector_mode_get().
11557     *
11558     * @ingroup Fileselector
11559     */
11560    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
11561
11562    /**
11563     * Get the mode in which a given file selector widget is displaying
11564     * (layouting) file system entries in its view
11565     *
11566     * @param obj The fileselector object
11567     * @return The mode in which the fileselector is at
11568     *
11569     * @see elm_fileselector_mode_set() for more details
11570     *
11571     * @ingroup Fileselector
11572     */
11573    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11574
11575    /**
11576     * @}
11577     */
11578
11579    /* progressbar */
11580    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11581    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
11582    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11583    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
11584    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
11585    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11586    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11587    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11588    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11589    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11590    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11591    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
11592    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11593    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
11594    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11595    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
11596    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11597    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
11598    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11599    /* smart callbacks called:
11600     */
11601    /* available item styles:
11602     * default
11603     * wheel (simple style, no text, no progression, only pulse is available)
11604     */
11605
11606    /**
11607     * @defgroup Separator Separator
11608     *
11609     * @brief Separator is a very thin object used to separate other objects.
11610     *
11611     * A separator can be vertical or horizontal.
11612     *
11613     * @ref tutorial_separator is a good example of how to use a separator.
11614     * @{
11615     */
11616    /**
11617     * @brief Add a separator object to @p parent
11618     *
11619     * @param parent The parent object
11620     *
11621     * @return The separator object, or NULL upon failure
11622     */
11623    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11624    /**
11625     * @brief Set the horizontal mode of a separator object
11626     *
11627     * @param obj The separator object
11628     * @param horizontal If true, the separator is horizontal
11629     */
11630    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
11631    /**
11632     * @brief Get the horizontal mode of a separator object
11633     *
11634     * @param obj The separator object
11635     * @return If true, the separator is horizontal
11636     *
11637     * @see elm_separator_horizontal_set()
11638     */
11639    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11640    /**
11641     * @}
11642     */
11643
11644    /* spinner */
11645    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11646    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
11647    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11648    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
11649    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
11650    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
11651    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11652    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
11653    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11654    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11655    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11656    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11657    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11658    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
11659    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
11660    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11661    /* smart callbacks called:
11662     * "changed" - when the spinner value changes
11663     * "delay,changed" - when the spinner value changed, but a small time after a change (use this if you only want to respond to a change once the spinner is held still for a short while).
11664     */
11665    /* available item styles:
11666     * default
11667     * vertical (two up/down buttons at the right side and text left aligned)
11668     */
11669
11670    /**
11671     * @defgroup Index Index
11672     *
11673     * @image html img/widget/index/preview-00.png
11674     *
11675     * An index widget gives you an index for fast access to whichever
11676     * group of other UI items one might have. It's a list of text
11677     * items (usually letters, for alphabetically ordered access).
11678     *
11679     * Index widgets are by default hidden and just appear when the
11680     * user clicks over it's reserved area in the canvas. In its
11681     * default theme, it's an area one @ref Fingers "finger" wide on
11682     * the right side of the index widget's container.
11683     *
11684     * When items on the index are selected, smart callbacks get
11685     * called, so that its user can make other container objects to
11686     * show a given area or child object depending on the index item
11687     * selected. You'd probably be using an index together with @ref
11688     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
11689     * "general grids".
11690     *
11691     * Smart events one  can add callbacks for are:
11692     * - @c "changed" - When the selected index item changes. @c
11693     *      event_info is the selected item's data pointer.
11694     * - @c "delay,changed" - When the selected index item changes, but
11695     *      after a small idling period. @c event_info is the selected
11696     *      item's data pointer.
11697     * - @c "selected" - When the user releases a mouse button and
11698     *      selects an item. @c event_info is the selected item's data
11699     *      pointer.
11700     * - @c "level,up" - when the user moves a finger from the first
11701     *      level to the second level
11702     * - @c "level,down" - when the user moves a finger from the second
11703     *      level to the first level
11704     *
11705     * The @c "delay,changed" event is so that it'll wait a small time
11706     * before actually reporting those events and, moreover, just the
11707     * last event happening on those time frames will actually be
11708     * reported.
11709     *
11710     * Here are some examples on its usage:
11711     * @li @ref index_example_01
11712     * @li @ref index_example_02
11713     */
11714
11715    /**
11716     * @addtogroup Index
11717     * @{
11718     */
11719
11720    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
11721
11722    /**
11723     * Add a new index widget to the given parent Elementary
11724     * (container) object
11725     *
11726     * @param parent The parent object
11727     * @return a new index widget handle or @c NULL, on errors
11728     *
11729     * This function inserts a new index widget on the canvas.
11730     *
11731     * @ingroup Index
11732     */
11733    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11734
11735    /**
11736     * Set whether a given index widget is or not visible,
11737     * programatically.
11738     *
11739     * @param obj The index object
11740     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
11741     *
11742     * Not to be confused with visible as in @c evas_object_show() --
11743     * visible with regard to the widget's auto hiding feature.
11744     *
11745     * @see elm_index_active_get()
11746     *
11747     * @ingroup Index
11748     */
11749    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
11750
11751    /**
11752     * Get whether a given index widget is currently visible or not.
11753     *
11754     * @param obj The index object
11755     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
11756     *
11757     * @see elm_index_active_set() for more details
11758     *
11759     * @ingroup Index
11760     */
11761    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11762
11763    /**
11764     * Set the items level for a given index widget.
11765     *
11766     * @param obj The index object.
11767     * @param level @c 0 or @c 1, the currently implemented levels.
11768     *
11769     * @see elm_index_item_level_get()
11770     *
11771     * @ingroup Index
11772     */
11773    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
11774
11775    /**
11776     * Get the items level set for a given index widget.
11777     *
11778     * @param obj The index object.
11779     * @return @c 0 or @c 1, which are the levels @p obj might be at.
11780     *
11781     * @see elm_index_item_level_set() for more information
11782     *
11783     * @ingroup Index
11784     */
11785    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11786
11787    /**
11788     * Returns the last selected item's data, for a given index widget.
11789     *
11790     * @param obj The index object.
11791     * @return The item @b data associated to the last selected item on
11792     * @p obj (or @c NULL, on errors).
11793     *
11794     * @warning The returned value is @b not an #Elm_Index_Item item
11795     * handle, but the data associated to it (see the @c item parameter
11796     * in elm_index_item_append(), as an example).
11797     *
11798     * @ingroup Index
11799     */
11800    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
11801
11802    /**
11803     * Append a new item on a given index widget.
11804     *
11805     * @param obj The index object.
11806     * @param letter Letter under which the item should be indexed
11807     * @param item The item data to set for the index's item
11808     *
11809     * Despite the most common usage of the @p letter argument is for
11810     * single char strings, one could use arbitrary strings as index
11811     * entries.
11812     *
11813     * @c item will be the pointer returned back on @c "changed", @c
11814     * "delay,changed" and @c "selected" smart events.
11815     *
11816     * @ingroup Index
11817     */
11818    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
11819
11820    /**
11821     * Prepend a new item on a given index widget.
11822     *
11823     * @param obj The index object.
11824     * @param letter Letter under which the item should be indexed
11825     * @param item The item data to set for the index's item
11826     *
11827     * Despite the most common usage of the @p letter argument is for
11828     * single char strings, one could use arbitrary strings as index
11829     * entries.
11830     *
11831     * @c item will be the pointer returned back on @c "changed", @c
11832     * "delay,changed" and @c "selected" smart events.
11833     *
11834     * @ingroup Index
11835     */
11836    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
11837
11838    /**
11839     * Append a new item, on a given index widget, <b>after the item
11840     * having @p relative as data</b>.
11841     *
11842     * @param obj The index object.
11843     * @param letter Letter under which the item should be indexed
11844     * @param item The item data to set for the index's item
11845     * @param relative The item data of the index item to be the
11846     * predecessor of this new one
11847     *
11848     * Despite the most common usage of the @p letter argument is for
11849     * single char strings, one could use arbitrary strings as index
11850     * entries.
11851     *
11852     * @c item will be the pointer returned back on @c "changed", @c
11853     * "delay,changed" and @c "selected" smart events.
11854     *
11855     * @note If @p relative is @c NULL or if it's not found to be data
11856     * set on any previous item on @p obj, this function will behave as
11857     * elm_index_item_append().
11858     *
11859     * @ingroup Index
11860     */
11861    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
11862
11863    /**
11864     * Prepend a new item, on a given index widget, <b>after the item
11865     * having @p relative as data</b>.
11866     *
11867     * @param obj The index object.
11868     * @param letter Letter under which the item should be indexed
11869     * @param item The item data to set for the index's item
11870     * @param relative The item data of the index item to be the
11871     * successor of this new one
11872     *
11873     * Despite the most common usage of the @p letter argument is for
11874     * single char strings, one could use arbitrary strings as index
11875     * entries.
11876     *
11877     * @c item will be the pointer returned back on @c "changed", @c
11878     * "delay,changed" and @c "selected" smart events.
11879     *
11880     * @note If @p relative is @c NULL or if it's not found to be data
11881     * set on any previous item on @p obj, this function will behave as
11882     * elm_index_item_prepend().
11883     *
11884     * @ingroup Index
11885     */
11886    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
11887
11888    /**
11889     * Insert a new item into the given index widget, using @p cmp_func
11890     * function to sort items (by item data).
11891     *
11892     * @param obj The index object.
11893     * @param letter Letter under which the item should be indexed
11894     * @param item The item data to set for the index's item
11895     * @param cmp_func The comparing function to be used to sort index
11896     * items <b>by #Elm_Index_Item item handles</b>
11897     * @param cmp_data_func A @b fallback function to be called for the
11898     * sorting of index items <b>by item data</b>). It will be used
11899     * when @p cmp_func returns @c 0 (equality), which means an index
11900     * item with provided item data already exists. To decide which
11901     * data item should be pointed to by the index item in question, @p
11902     * cmp_data_func will be used. If @p cmp_data_func returns a
11903     * non-negative value, the previous index item data will be
11904     * replaced by the given @p item pointer. If the previous data need
11905     * to be freed, it should be done by the @p cmp_data_func function,
11906     * because all references to it will be lost. If this function is
11907     * not provided (@c NULL is given), index items will be @b
11908     * duplicated, if @p cmp_func returns @c 0.
11909     *
11910     * Despite the most common usage of the @p letter argument is for
11911     * single char strings, one could use arbitrary strings as index
11912     * entries.
11913     *
11914     * @c item will be the pointer returned back on @c "changed", @c
11915     * "delay,changed" and @c "selected" smart events.
11916     *
11917     * @ingroup Index
11918     */
11919    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);
11920
11921    /**
11922     * Remove an item from a given index widget, <b>to be referenced by
11923     * it's data value</b>.
11924     *
11925     * @param obj The index object
11926     * @param item The item's data pointer for the item to be removed
11927     * from @p obj
11928     *
11929     * If a deletion callback is set, via elm_index_item_del_cb_set(),
11930     * that callback function will be called by this one.
11931     *
11932     * @warning The item to be removed from @p obj will be found via
11933     * its item data pointer, and not by an #Elm_Index_Item handle.
11934     *
11935     * @ingroup Index
11936     */
11937    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
11938
11939    /**
11940     * Find a given index widget's item, <b>using item data</b>.
11941     *
11942     * @param obj The index object
11943     * @param item The item data pointed to by the desired index item
11944     * @return The index item handle, if found, or @c NULL otherwise
11945     *
11946     * @ingroup Index
11947     */
11948    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
11949
11950    /**
11951     * Removes @b all items from a given index widget.
11952     *
11953     * @param obj The index object.
11954     *
11955     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
11956     * that callback function will be called for each item in @p obj.
11957     *
11958     * @ingroup Index
11959     */
11960    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11961
11962    /**
11963     * Go to a given items level on a index widget
11964     *
11965     * @param obj The index object
11966     * @param level The index level (one of @c 0 or @c 1)
11967     *
11968     * @ingroup Index
11969     */
11970    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
11971
11972    /**
11973     * Return the data associated with a given index widget item
11974     *
11975     * @param it The index widget item handle
11976     * @return The data associated with @p it
11977     *
11978     * @see elm_index_item_data_set()
11979     *
11980     * @ingroup Index
11981     */
11982    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
11983
11984    /**
11985     * Set the data associated with a given index widget item
11986     *
11987     * @param it The index widget item handle
11988     * @param data The new data pointer to set to @p it
11989     *
11990     * This sets new item data on @p it.
11991     *
11992     * @warning The old data pointer won't be touched by this function, so
11993     * the user had better to free that old data himself/herself.
11994     *
11995     * @ingroup Index
11996     */
11997    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
11998
11999    /**
12000     * Set the function to be called when a given index widget item is freed.
12001     *
12002     * @param it The item to set the callback on
12003     * @param func The function to call on the item's deletion
12004     *
12005     * When called, @p func will have both @c data and @c event_info
12006     * arguments with the @p it item's data value and, naturally, the
12007     * @c obj argument with a handle to the parent index widget.
12008     *
12009     * @ingroup Index
12010     */
12011    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12012
12013    /**
12014     * Get the letter (string) set on a given index widget item.
12015     *
12016     * @param it The index item handle
12017     * @return The letter string set on @p it
12018     *
12019     * @ingroup Index
12020     */
12021    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
12022
12023    /**
12024     * @}
12025     */
12026
12027    /* photocam */
12028    typedef enum _Elm_Photocam_Zoom_Mode
12029      {
12030         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
12031         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
12032         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
12033         ELM_PHOTOCAM_ZOOM_MODE_LAST
12034      } Elm_Photocam_Zoom_Mode;
12035
12036    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12037    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12038    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12039    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
12040    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12041    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
12042    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12043    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
12044    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
12045    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
12046    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
12047    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
12048    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12049    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12050    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12051    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12052    /* smart callbacks called:
12053     * "clicked" - when image clicked
12054     * "press" - when mouse/finger held down initially on image
12055     * "longpressed" - when mouse/finger held for long time on image
12056     * "clicked,double" - when mouse/finger double-clicked
12057     * "load" - when photo load begins
12058     * "loaded" - when photo load done
12059     * "load,detail" - when detailed image load begins
12060     * "loaded,detail" - when detailed image load done
12061     * "zoom,start" - when zooming started
12062     * "zoom,stop" - when zooming stopped
12063     * "zoom,change" - when auto zoom mode changed zoom level
12064     * "scroll - the content has been scrolled (moved)
12065     * "scroll,anim,start" - scrolling animation has started
12066     * "scroll,anim,stop" - scrolling animation has stopped
12067     * "scroll,drag,start" - dragging the contents around has started
12068     * "scroll,drag,stop" - dragging the contents around has stopped
12069     */
12070
12071    /* map */
12072    typedef enum _Elm_Map_Zoom_Mode
12073      {
12074         ELM_MAP_ZOOM_MODE_MANUAL,
12075         ELM_MAP_ZOOM_MODE_AUTO_FIT,
12076         ELM_MAP_ZOOM_MODE_AUTO_FILL,
12077         ELM_MAP_ZOOM_MODE_LAST
12078      } Elm_Map_Zoom_Mode;
12079
12080    typedef enum _Elm_Map_Route_Sources
12081      {
12082         ELM_MAP_ROUTE_SOURCE_YOURS,
12083         ELM_MAP_ROUTE_SOURCE_MONAV,
12084         ELM_MAP_ROUTE_SOURCE_ORS,
12085         ELM_MAP_ROUTE_SOURCE_LAST
12086      } Elm_Map_Route_Sources;
12087
12088    typedef enum _Elm_Map_Name_Sources
12089      {
12090         ELM_MAP_NAME_SOURCE_NOMINATIM,
12091         ELM_MAP_NAME_SOURCE_LAST
12092      } Elm_Map_Name_Sources;
12093
12094    typedef enum _Elm_Map_Route_Type
12095      {
12096         ELM_MAP_ROUTE_TYPE_MOTOCAR,
12097         ELM_MAP_ROUTE_TYPE_BICYCLE,
12098         ELM_MAP_ROUTE_TYPE_FOOT,
12099         ELM_MAP_ROUTE_TYPE_LAST
12100      } Elm_Map_Route_Type;
12101
12102    typedef enum _Elm_Map_Route_Method
12103      {
12104         ELM_MAP_ROUTE_METHOD_FASTEST,
12105         ELM_MAP_ROUTE_METHOD_SHORTEST,
12106         ELM_MAP_ROUTE_METHOD_LAST
12107      } Elm_Map_Route_Method;
12108
12109    typedef enum _Elm_Map_Name_Method
12110      {
12111         ELM_MAP_NAME_METHOD_SEARCH,
12112         ELM_MAP_NAME_METHOD_REVERSE,
12113         ELM_MAP_NAME_METHOD_LAST
12114      } Elm_Map_Name_Method;
12115
12116    typedef struct _Elm_Map_Marker          Elm_Map_Marker;
12117    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class;
12118    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class;
12119    typedef struct _Elm_Map_Route           Elm_Map_Route;
12120    typedef struct _Elm_Map_Name            Elm_Map_Name;
12121    typedef struct _Elm_Map_Track           Elm_Map_Track;
12122
12123    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
12124    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
12125    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
12126    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data);
12127
12128    typedef char        *(*ElmMapModuleSourceFunc) (void);
12129    typedef int          (*ElmMapModuleZoomMinFunc) (void);
12130    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
12131    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
12132    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
12133    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
12134    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
12135    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
12136    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
12137
12138    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12139    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
12140    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12141    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
12142    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12143    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
12144    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
12145    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
12146    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
12147    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12148    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
12149    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12150    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
12151    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);
12152    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);
12153    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
12154    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
12155    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);
12156    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);
12157    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
12158    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12159    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
12160    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12161    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12162    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
12163    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12164    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12165    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12166    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
12167    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
12168    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
12169    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
12170    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
12171    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
12172    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
12173    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
12174    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
12175    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
12176    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
12177    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
12178    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12179    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
12180    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12181    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
12182    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12183    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
12184    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12185    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
12186    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12187    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
12188    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12189    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);
12190    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
12191    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
12192    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
12193    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
12194    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
12195    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
12196    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
12197    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
12198    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
12199    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
12200    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);
12201    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12202    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12203 #ifdef ELM_EMAP
12204    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
12205 #endif
12206    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
12207
12208    /* smart callbacks called:
12209     * "clicked" - when image clicked
12210     * "press" - when mouse/finger held down initially on image
12211     * "longpressed" - when mouse/finger held for long time on image
12212     * "clicked,double" - when mouse/finger double-clicked
12213     * "load,details" - when detailed image load begins
12214     * "loaded,details" - when detailed image load done
12215     * "zoom,start" - when zooming started
12216     * "zoom,stop" - when zooming stopped
12217     * "zoom,change" - when auto zoom mode changed zoom level
12218     * "scroll - the content has been scrolled (moved)
12219     * "scroll,anim,start" - scrolling animation has started
12220     * "scroll,anim,stop" - scrolling animation has stopped
12221     * "scroll,drag,start" - dragging the contents around has started
12222     * "scroll,drag,stop" - dragging the contents around has stopped
12223     */
12224
12225    /* Route */
12226    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
12227 #ifdef ELM_EMAP
12228    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
12229 #endif
12230    EAPI double elm_route_lon_min_get(Evas_Object *obj);
12231    EAPI double elm_route_lat_min_get(Evas_Object *obj);
12232    EAPI double elm_route_lon_max_get(Evas_Object *obj);
12233    EAPI double elm_route_lat_max_get(Evas_Object *obj);
12234
12235
12236    /**
12237     * @defgroup Panel Panel
12238     *
12239     * @image html img/widget/panel/preview-00.png
12240     * @image latex img/widget/panel/preview-00.eps
12241     *
12242     * @brief A panel is a type of animated container that contains subobjects.
12243     * It can be expanded or contracted by clicking the button on it's edge.
12244     *
12245     * Orientations are as follows:
12246     * @li ELM_PANEL_ORIENT_TOP
12247     * @li ELM_PANEL_ORIENT_LEFT
12248     * @li ELM_PANEL_ORIENT_RIGHT
12249     *
12250     * @ref tutorial_panel shows one way to use this widget.
12251     * @{
12252     */
12253    typedef enum _Elm_Panel_Orient
12254      {
12255         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
12256         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
12257         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
12258         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
12259      } Elm_Panel_Orient;
12260    /**
12261     * @brief Adds a panel object
12262     *
12263     * @param parent The parent object
12264     *
12265     * @return The panel object, or NULL on failure
12266     */
12267    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12268    /**
12269     * @brief Sets the orientation of the panel
12270     *
12271     * @param parent The parent object
12272     * @param orient The panel orientation. Can be one of the following:
12273     * @li ELM_PANEL_ORIENT_TOP
12274     * @li ELM_PANEL_ORIENT_LEFT
12275     * @li ELM_PANEL_ORIENT_RIGHT
12276     *
12277     * Sets from where the panel will (dis)appear.
12278     */
12279    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
12280    /**
12281     * @brief Get the orientation of the panel.
12282     *
12283     * @param obj The panel object
12284     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
12285     */
12286    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12287    /**
12288     * @brief Set the content of the panel.
12289     *
12290     * @param obj The panel object
12291     * @param content The panel content
12292     *
12293     * Once the content object is set, a previously set one will be deleted.
12294     * If you want to keep that old content object, use the
12295     * elm_panel_content_unset() function.
12296     */
12297    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12298    /**
12299     * @brief Get the content of the panel.
12300     *
12301     * @param obj The panel object
12302     * @return The content that is being used
12303     *
12304     * Return the content object which is set for this widget.
12305     *
12306     * @see elm_panel_content_set()
12307     */
12308    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12309    /**
12310     * @brief Unset the content of the panel.
12311     *
12312     * @param obj The panel object
12313     * @return The content that was being used
12314     *
12315     * Unparent and return the content object which was set for this widget.
12316     *
12317     * @see elm_panel_content_set()
12318     */
12319    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12320    /**
12321     * @brief Set the state of the panel.
12322     *
12323     * @param obj The panel object
12324     * @param hidden If true, the panel will run the animation to contract
12325     */
12326    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
12327    /**
12328     * @brief Get the state of the panel.
12329     *
12330     * @param obj The panel object
12331     * @param hidden If true, the panel is in the "hide" state
12332     */
12333    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12334    /**
12335     * @brief Toggle the hidden state of the panel from code
12336     *
12337     * @param obj The panel object
12338     */
12339    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
12340    /**
12341     * @}
12342     */
12343
12344    /* panes */
12345    /**
12346     * TODO
12347     *
12348     * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
12349     * Add events (move, start ...)
12350     */
12351    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12352    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12353    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12354    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12355    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12356    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12357    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12358    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12359    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
12360    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12361    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12362
12363    /**
12364     * @defgroup Flip Flip
12365     *
12366     * @image html img/widget/flip/preview-00.png
12367     * @image latex img/widget/flip/preview-00.eps
12368     *
12369     * This widget holds 2 content objects(Evas_Object): one on the front and one
12370     * on the back. It allows you to flip from front to back and vice-versa using
12371     * various animations.
12372     *
12373     * If either the front or back contents are not set the flip will treat that
12374     * as transparent. So if you wore to set the front content but not the back,
12375     * and then call elm_flip_go() you would see whatever is below the flip.
12376     *
12377     * For a list of supported animations see elm_flip_go().
12378     *
12379     * Signals that you can add callbacks for are:
12380     * "animate,begin" - when a flip animation was started
12381     * "animate,done" - when a flip animation is finished
12382     *
12383     * @ref tutorial_flip show how to use most of the API.
12384     *
12385     * @{
12386     */
12387    typedef enum _Elm_Flip_Mode
12388      {
12389         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
12390         ELM_FLIP_ROTATE_X_CENTER_AXIS,
12391         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
12392         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
12393         ELM_FLIP_CUBE_LEFT,
12394         ELM_FLIP_CUBE_RIGHT,
12395         ELM_FLIP_CUBE_UP,
12396         ELM_FLIP_CUBE_DOWN,
12397         ELM_FLIP_PAGE_LEFT,
12398         ELM_FLIP_PAGE_RIGHT,
12399         ELM_FLIP_PAGE_UP,
12400         ELM_FLIP_PAGE_DOWN
12401      } Elm_Flip_Mode;
12402    typedef enum _Elm_Flip_Interaction
12403      {
12404         ELM_FLIP_INTERACTION_NONE,
12405         ELM_FLIP_INTERACTION_ROTATE,
12406         ELM_FLIP_INTERACTION_CUBE,
12407         ELM_FLIP_INTERACTION_PAGE
12408      } Elm_Flip_Interaction;
12409    typedef enum _Elm_Flip_Direction
12410      {
12411         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
12412         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
12413         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
12414         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
12415      } Elm_Flip_Direction;
12416    /**
12417     * @brief Add a new flip to the parent
12418     *
12419     * @param parent The parent object
12420     * @return The new object or NULL if it cannot be created
12421     */
12422    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12423    /**
12424     * @brief Set the front content of the flip widget.
12425     *
12426     * @param obj The flip object
12427     * @param content The new front content object
12428     *
12429     * Once the content object is set, a previously set one will be deleted.
12430     * If you want to keep that old content object, use the
12431     * elm_flip_content_front_unset() function.
12432     */
12433    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12434    /**
12435     * @brief Set the back content of the flip widget.
12436     *
12437     * @param obj The flip object
12438     * @param content The new back content object
12439     *
12440     * Once the content object is set, a previously set one will be deleted.
12441     * If you want to keep that old content object, use the
12442     * elm_flip_content_back_unset() function.
12443     */
12444    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12445    /**
12446     * @brief Get the front content used for the flip
12447     *
12448     * @param obj The flip object
12449     * @return The front content object that is being used
12450     *
12451     * Return the front content object which is set for this widget.
12452     */
12453    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12454    /**
12455     * @brief Get the back content used for the flip
12456     *
12457     * @param obj The flip object
12458     * @return The back content object that is being used
12459     *
12460     * Return the back content object which is set for this widget.
12461     */
12462    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12463    /**
12464     * @brief Unset the front content used for the flip
12465     *
12466     * @param obj The flip object
12467     * @return The front content object that was being used
12468     *
12469     * Unparent and return the front content object which was set for this widget.
12470     */
12471    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12472    /**
12473     * @brief Unset the back content used for the flip
12474     *
12475     * @param obj The flip object
12476     * @return The back content object that was being used
12477     *
12478     * Unparent and return the back content object which was set for this widget.
12479     */
12480    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12481    /**
12482     * @brief Get flip front visibility state
12483     *
12484     * @param obj The flip objct
12485     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
12486     * showing.
12487     */
12488    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12489    /**
12490     * @brief Set flip perspective
12491     *
12492     * @param obj The flip object
12493     * @param foc The coordinate to set the focus on
12494     * @param x The X coordinate
12495     * @param y The Y coordinate
12496     *
12497     * @warning This function currently does nothing.
12498     */
12499    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12500    /**
12501     * @brief Runs the flip animation
12502     *
12503     * @param obj The flip object
12504     * @param mode The mode type
12505     *
12506     * Flips the front and back contents using the @p mode animation. This
12507     * efectively hides the currently visible content and shows the hidden one.
12508     *
12509     * There a number of possible animations to use for the flipping:
12510     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
12511     * around a horizontal axis in the middle of its height, the other content
12512     * is shown as the other side of the flip.
12513     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
12514     * around a vertical axis in the middle of its width, the other content is
12515     * shown as the other side of the flip.
12516     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
12517     * around a diagonal axis in the middle of its width, the other content is
12518     * shown as the other side of the flip.
12519     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
12520     * around a diagonal axis in the middle of its height, the other content is
12521     * shown as the other side of the flip.
12522     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
12523     * as if the flip was a cube, the other content is show as the right face of
12524     * the cube.
12525     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
12526     * right as if the flip was a cube, the other content is show as the left
12527     * face of the cube.
12528     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
12529     * flip was a cube, the other content is show as the bottom face of the cube.
12530     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
12531     * the flip was a cube, the other content is show as the upper face of the
12532     * cube.
12533     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
12534     * if the flip was a book, the other content is shown as the page below that.
12535     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
12536     * as if the flip was a book, the other content is shown as the page below
12537     * that.
12538     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
12539     * flip was a book, the other content is shown as the page below that.
12540     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
12541     * flip was a book, the other content is shown as the page below that.
12542     */
12543    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
12544    /**
12545     * @brief Set the interactive flip mode
12546     *
12547     * @param obj The flip object
12548     * @param mode The interactive flip mode to use
12549     *
12550     * This sets if the flip should be interactive (allow user to click and
12551     * drag a side of the flip to reveal the back page and cause it to flip).
12552     * By default a flip is not interactive. You may also need to set which
12553     * sides of the flip are "active" for flipping and how much space they use
12554     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
12555     * and elm_flip_interacton_direction_hitsize_set()
12556     *
12557     * The four avilable mode of interaction are:
12558     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
12559     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
12560     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
12561     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
12562     *
12563     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
12564     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
12565     * happen, those can only be acheived with elm_flip_go();
12566     */
12567    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
12568    /**
12569     * @brief Get the interactive flip mode
12570     *
12571     * @param obj The flip object
12572     * @return The interactive flip mode
12573     *
12574     * Returns the interactive flip mode set by elm_flip_interaction_set()
12575     */
12576    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
12577    /**
12578     * @brief Set which directions of the flip respond to interactive flip
12579     *
12580     * @param obj The flip object
12581     * @param dir The direction to change
12582     * @param enabled If that direction is enabled or not
12583     *
12584     * By default all directions are disabled, so you may want to enable the
12585     * desired directions for flipping if you need interactive flipping. You must
12586     * call this function once for each direction that should be enabled.
12587     *
12588     * @see elm_flip_interaction_set()
12589     */
12590    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
12591    /**
12592     * @brief Get the enabled state of that flip direction
12593     *
12594     * @param obj The flip object
12595     * @param dir The direction to check
12596     * @return If that direction is enabled or not
12597     *
12598     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
12599     *
12600     * @see elm_flip_interaction_set()
12601     */
12602    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
12603    /**
12604     * @brief Set the amount of the flip that is sensitive to interactive flip
12605     *
12606     * @param obj The flip object
12607     * @param dir The direction to modify
12608     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
12609     *
12610     * Set the amount of the flip that is sensitive to interactive flip, with 0
12611     * representing no area in the flip and 1 representing the entire flip. There
12612     * is however a consideration to be made in that the area will never be
12613     * smaller than the finger size set(as set in your Elementary configuration).
12614     *
12615     * @see elm_flip_interaction_set()
12616     */
12617    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
12618    /**
12619     * @brief Get the amount of the flip that is sensitive to interactive flip
12620     *
12621     * @param obj The flip object
12622     * @param dir The direction to check
12623     * @return The size set for that direction
12624     *
12625     * Returns the amount os sensitive area set by
12626     * elm_flip_interacton_direction_hitsize_set().
12627     */
12628    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
12629    /**
12630     * @}
12631     */
12632
12633    /* scrolledentry */
12634    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12635    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
12636    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12637    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
12638    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12639    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
12640    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12641    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
12642    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12643    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12644    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
12645    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
12646    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
12647    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12648    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
12649    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
12650    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12651    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12652    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
12653    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
12654    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12655    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12656    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12657    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12658    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12659    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12660    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12661    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12662    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12663    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
12664    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12665    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
12666    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
12667    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
12668    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12669    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);
12670    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12671    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12672    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);
12673    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12674    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);
12675    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
12676    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12677    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12678    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
12679    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
12680    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12681    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12682    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
12683    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);
12684    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);
12685    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);
12686    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);
12687    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);
12688    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);
12689    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12690    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12691    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12692    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12693    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12694    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12695    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12696
12697    /**
12698     * @defgroup Conformant Conformant
12699     * @ingroup Elementary
12700     *
12701     * @image html img/widget/conformant/preview-00.png
12702     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
12703     *
12704     * @image html img/conformant.png
12705     * @image latex img/conformant.eps width=\textwidth
12706     *
12707     * The aim is to provide a widget that can be used in elementary apps to
12708     * account for space taken up by the indicator, virtual keypad & softkey
12709     * windows when running the illume2 module of E17.
12710     *
12711     * So conformant content will be sized and positioned considering the
12712     * space required for such stuff, and when they popup, as a keyboard
12713     * shows when an entry is selected, conformant content won't change.
12714     *
12715     * Available styles for it:
12716     * - @c "default"
12717     *
12718     * See how to use this widget in this example:
12719     * @ref conformant_example
12720     */
12721
12722    /**
12723     * @addtogroup Conformant
12724     * @{
12725     */
12726
12727    /**
12728     * Add a new conformant widget to the given parent Elementary
12729     * (container) object.
12730     *
12731     * @param parent The parent object.
12732     * @return A new conformant widget handle or @c NULL, on errors.
12733     *
12734     * This function inserts a new conformant widget on the canvas.
12735     *
12736     * @ingroup Conformant
12737     */
12738    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12739
12740    /**
12741     * Set the content of the conformant widget.
12742     *
12743     * @param obj The conformant object.
12744     * @param content The content to be displayed by the conformant.
12745     *
12746     * Content will be sized and positioned considering the space required
12747     * to display a virtual keyboard. So it won't fill all the conformant
12748     * size. This way is possible to be sure that content won't resize
12749     * or be re-positioned after the keyboard is displayed.
12750     *
12751     * Once the content object is set, a previously set one will be deleted.
12752     * If you want to keep that old content object, use the
12753     * elm_conformat_content_unset() function.
12754     *
12755     * @see elm_conformant_content_unset()
12756     * @see elm_conformant_content_get()
12757     *
12758     * @ingroup Conformant
12759     */
12760    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12761
12762    /**
12763     * Get the content of the conformant widget.
12764     *
12765     * @param obj The conformant object.
12766     * @return The content that is being used.
12767     *
12768     * Return the content object which is set for this widget.
12769     * It won't be unparent from conformant. For that, use
12770     * elm_conformant_content_unset().
12771     *
12772     * @see elm_conformant_content_set() for more details.
12773     * @see elm_conformant_content_unset()
12774     *
12775     * @ingroup Conformant
12776     */
12777    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12778
12779    /**
12780     * Unset the content of the conformant widget.
12781     *
12782     * @param obj The conformant object.
12783     * @return The content that was being used.
12784     *
12785     * Unparent and return the content object which was set for this widget.
12786     *
12787     * @see elm_conformant_content_set() for more details.
12788     *
12789     * @ingroup Conformant
12790     */
12791    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12792
12793    /**
12794     * Returns the Evas_Object that represents the content area.
12795     *
12796     * @param obj The conformant object.
12797     * @return The content area of the widget.
12798     *
12799     * @ingroup Conformant
12800     */
12801    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12802
12803    /**
12804     * @}
12805     */
12806
12807    /* mapbuf */
12808    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12809    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12810    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12811    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12812    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12813    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12814    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
12815    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12816    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
12817    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12818
12819    /**
12820     * @defgroup Flipselector Flip Selector
12821     *
12822     * @image html img/widget/flipselector/preview-00.png
12823     * @image latex img/widget/flipselector/preview-00.eps
12824     *
12825     * A flip selector is a widget to show a set of @b text items, one
12826     * at a time, with the same sheet switching style as the @ref Clock
12827     * "clock" widget, when one changes the current displaying sheet
12828     * (thus, the "flip" in the name).
12829     *
12830     * User clicks to flip sheets which are @b held for some time will
12831     * make the flip selector to flip continuosly and automatically for
12832     * the user. The interval between flips will keep growing in time,
12833     * so that it helps the user to reach an item which is distant from
12834     * the current selection.
12835     *
12836     * Smart callbacks one can register to:
12837     * - @c "selected" - when the widget's selected text item is changed
12838     * - @c "overflowed" - when the widget's current selection is changed
12839     *   from the first item in its list to the last
12840     * - @c "underflowed" - when the widget's current selection is changed
12841     *   from the last item in its list to the first
12842     *
12843     * Available styles for it:
12844     * - @c "default"
12845     *
12846     * Here is an example on its usage:
12847     * @li @ref flipselector_example
12848     */
12849
12850    /**
12851     * @addtogroup Flipselector
12852     * @{
12853     */
12854
12855    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
12856
12857    /**
12858     * Add a new flip selector widget to the given parent Elementary
12859     * (container) widget
12860     *
12861     * @param parent The parent object
12862     * @return a new flip selector widget handle or @c NULL, on errors
12863     *
12864     * This function inserts a new flip selector widget on the canvas.
12865     *
12866     * @ingroup Flipselector
12867     */
12868    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12869
12870    /**
12871     * Programmatically select the next item of a flip selector widget
12872     *
12873     * @param obj The flipselector object
12874     *
12875     * @note The selection will be animated. Also, if it reaches the
12876     * end of its list of member items, it will continue with the first
12877     * one onwards.
12878     *
12879     * @ingroup Flipselector
12880     */
12881    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12882
12883    /**
12884     * Programmatically select the previous item of a flip selector
12885     * widget
12886     *
12887     * @param obj The flipselector object
12888     *
12889     * @note The selection will be animated.  Also, if it reaches the
12890     * beginning of its list of member items, it will continue with the
12891     * last one backwards.
12892     *
12893     * @ingroup Flipselector
12894     */
12895    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12896
12897    /**
12898     * Append a (text) item to a flip selector widget
12899     *
12900     * @param obj The flipselector object
12901     * @param label The (text) label of the new item
12902     * @param func Convenience callback function to take place when
12903     * item is selected
12904     * @param data Data passed to @p func, above
12905     * @return A handle to the item added or @c NULL, on errors
12906     *
12907     * The widget's list of labels to show will be appended with the
12908     * given value. If the user wishes so, a callback function pointer
12909     * can be passed, which will get called when this same item is
12910     * selected.
12911     *
12912     * @note The current selection @b won't be modified by appending an
12913     * element to the list.
12914     *
12915     * @note The maximum length of the text label is going to be
12916     * determined <b>by the widget's theme</b>. Strings larger than
12917     * that value are going to be @b truncated.
12918     *
12919     * @ingroup Flipselector
12920     */
12921    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
12922
12923    /**
12924     * Prepend a (text) item to a flip selector widget
12925     *
12926     * @param obj The flipselector object
12927     * @param label The (text) label of the new item
12928     * @param func Convenience callback function to take place when
12929     * item is selected
12930     * @param data Data passed to @p func, above
12931     * @return A handle to the item added or @c NULL, on errors
12932     *
12933     * The widget's list of labels to show will be prepended with the
12934     * given value. If the user wishes so, a callback function pointer
12935     * can be passed, which will get called when this same item is
12936     * selected.
12937     *
12938     * @note The current selection @b won't be modified by prepending
12939     * an element to the list.
12940     *
12941     * @note The maximum length of the text label is going to be
12942     * determined <b>by the widget's theme</b>. Strings larger than
12943     * that value are going to be @b truncated.
12944     *
12945     * @ingroup Flipselector
12946     */
12947    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
12948
12949    /**
12950     * Get the internal list of items in a given flip selector widget.
12951     *
12952     * @param obj The flipselector object
12953     * @return The list of items (#Elm_Flipselector_Item as data) or @c
12954     * NULL on errors.
12955     *
12956     * This list is @b not to be modified in any way and must not be
12957     * freed. Use the list members with functions like
12958     * elm_flipselector_item_label_set(),
12959     * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
12960     * elm_flipselector_item_del(),
12961     * elm_flipselector_item_selected_get(),
12962     * elm_flipselector_item_selected_set().
12963     *
12964     * @warning This list is only valid until @p obj object's internal
12965     * items list is changed. It should be fetched again with another
12966     * call to this function when changes happen.
12967     *
12968     * @ingroup Flipselector
12969     */
12970    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12971
12972    /**
12973     * Get the first item in the given flip selector widget's list of
12974     * items.
12975     *
12976     * @param obj The flipselector object
12977     * @return The first item or @c NULL, if it has no items (and on
12978     * errors)
12979     *
12980     * @see elm_flipselector_item_append()
12981     * @see elm_flipselector_last_item_get()
12982     *
12983     * @ingroup Flipselector
12984     */
12985    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12986
12987    /**
12988     * Get the last item in the given flip selector widget's list of
12989     * items.
12990     *
12991     * @param obj The flipselector object
12992     * @return The last item or @c NULL, if it has no items (and on
12993     * errors)
12994     *
12995     * @see elm_flipselector_item_prepend()
12996     * @see elm_flipselector_first_item_get()
12997     *
12998     * @ingroup Flipselector
12999     */
13000    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13001
13002    /**
13003     * Get the currently selected item in a flip selector widget.
13004     *
13005     * @param obj The flipselector object
13006     * @return The selected item or @c NULL, if the widget has no items
13007     * (and on erros)
13008     *
13009     * @ingroup Flipselector
13010     */
13011    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13012
13013    /**
13014     * Set whether a given flip selector widget's item should be the
13015     * currently selected one.
13016     *
13017     * @param item The flip selector item
13018     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
13019     *
13020     * This sets whether @p item is or not the selected (thus, under
13021     * display) one. If @p item is different than one under display,
13022     * the latter will be unselected. If the @p item is set to be
13023     * unselected, on the other hand, the @b first item in the widget's
13024     * internal members list will be the new selected one.
13025     *
13026     * @see elm_flipselector_item_selected_get()
13027     *
13028     * @ingroup Flipselector
13029     */
13030    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13031
13032    /**
13033     * Get whether a given flip selector widget's item is the currently
13034     * selected one.
13035     *
13036     * @param item The flip selector item
13037     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
13038     * (or on errors).
13039     *
13040     * @see elm_flipselector_item_selected_set()
13041     *
13042     * @ingroup Flipselector
13043     */
13044    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13045
13046    /**
13047     * Delete a given item from a flip selector widget.
13048     *
13049     * @param item The item to delete
13050     *
13051     * @ingroup Flipselector
13052     */
13053    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13054
13055    /**
13056     * Get the label of a given flip selector widget's item.
13057     *
13058     * @param item The item to get label from
13059     * @return The text label of @p item or @c NULL, on errors
13060     *
13061     * @see elm_flipselector_item_label_set()
13062     *
13063     * @ingroup Flipselector
13064     */
13065    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13066
13067    /**
13068     * Set the label of a given flip selector widget's item.
13069     *
13070     * @param item The item to set label on
13071     * @param label The text label string, in UTF-8 encoding
13072     *
13073     * @see elm_flipselector_item_label_get()
13074     *
13075     * @ingroup Flipselector
13076     */
13077    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
13078
13079    /**
13080     * Gets the item before @p item in a flip selector widget's
13081     * internal list of items.
13082     *
13083     * @param item The item to fetch previous from
13084     * @return The item before the @p item, in its parent's list. If
13085     *         there is no previous item for @p item or there's an
13086     *         error, @c NULL is returned.
13087     *
13088     * @see elm_flipselector_item_next_get()
13089     *
13090     * @ingroup Flipselector
13091     */
13092    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13093
13094    /**
13095     * Gets the item after @p item in a flip selector widget's
13096     * internal list of items.
13097     *
13098     * @param item The item to fetch next from
13099     * @return The item after the @p item, in its parent's list. If
13100     *         there is no next item for @p item or there's an
13101     *         error, @c NULL is returned.
13102     *
13103     * @see elm_flipselector_item_next_get()
13104     *
13105     * @ingroup Flipselector
13106     */
13107    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13108
13109    /**
13110     * Set the interval on time updates for an user mouse button hold
13111     * on a flip selector widget.
13112     *
13113     * @param obj The flip selector object
13114     * @param interval The (first) interval value in seconds
13115     *
13116     * This interval value is @b decreased while the user holds the
13117     * mouse pointer either flipping up or flipping doww a given flip
13118     * selector.
13119     *
13120     * This helps the user to get to a given item distant from the
13121     * current one easier/faster, as it will start to flip quicker and
13122     * quicker on mouse button holds.
13123     *
13124     * The calculation for the next flip interval value, starting from
13125     * the one set with this call, is the previous interval divided by
13126     * 1.05, so it decreases a little bit.
13127     *
13128     * The default starting interval value for automatic flips is
13129     * @b 0.85 seconds.
13130     *
13131     * @see elm_flipselector_interval_get()
13132     *
13133     * @ingroup Flipselector
13134     */
13135    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
13136
13137    /**
13138     * Get the interval on time updates for an user mouse button hold
13139     * on a flip selector widget.
13140     *
13141     * @param obj The flip selector object
13142     * @return The (first) interval value, in seconds, set on it
13143     *
13144     * @see elm_flipselector_interval_set() for more details
13145     *
13146     * @ingroup Flipselector
13147     */
13148    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13149
13150    /**
13151     * @}
13152     */
13153
13154    /**
13155     * @addtogroup Animator Animator
13156     * @ingroup Elementary
13157     *
13158     * @brief Functions to ease creation of animations.
13159     *
13160     * elm_animator is designed to provide an easy way to create animations.
13161     * Creating an animation with elm_animator is as simple as setting a
13162     * duration, an operating callback and telling it to run the animation.
13163     * However that is not the full extent of elm_animator's ability, animations
13164     * can be paused and resumed, reversed and the animation need not be linear.
13165     *
13166     * To run an animation you must specify at least a duration and operation
13167     * callback, not setting any other properties will create a linear animation
13168     * that runs once and is not reversed.
13169     *
13170     * @ref elm_animator_example_page_01 "This" example should make all of that
13171     * very clear.
13172     *
13173     * @warning elm_animator is @b not a widget.
13174     * @{
13175     */
13176    /**
13177     * @brief Type of curve desired for animation.
13178     *
13179     * The speed in which an animation happens doesn't have to be linear, some
13180     * animations will look better if they're accelerating or decelerating, so
13181     * elm_animator provides four options in this regard:
13182     *
13183     * @image html elm_animator_curve_style.png
13184     * @image latex elm_animator_curve_style.eps width=\textwidth
13185     * As can be seen in the image the speed of the animation will be:
13186     * @li ELM_ANIMATOR_CURVE_LINEAR constant
13187     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
13188     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
13189     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
13190     */
13191    typedef enum
13192      {
13193         ELM_ANIMATOR_CURVE_LINEAR,
13194         ELM_ANIMATOR_CURVE_IN_OUT,
13195         ELM_ANIMATOR_CURVE_IN,
13196         ELM_ANIMATOR_CURVE_OUT
13197      } Elm_Animator_Curve_Style;
13198    typedef struct _Elm_Animator Elm_Animator;
13199   /**
13200    * Called back per loop of an elementary animators cycle
13201    * @param data user-data given to elm_animator_operation_callback_set()
13202    * @param animator the animator being run
13203    * @param double the position in the animation
13204    */
13205    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
13206   /**
13207    * Called back when an elementary animator finishes
13208    * @param data user-data given to elm_animator_completion_callback_set()
13209    */
13210    typedef void (*Elm_Animator_Completion_Cb) (void *data);
13211
13212    /**
13213     * @brief Create a new animator.
13214     *
13215     * @param[in] parent Parent object
13216     *
13217     * The @a parent argument can be set to NULL for no parent. If a parent is set
13218     * there is no need to call elm_animator_del(), when the parent is deleted it
13219     * will delete the animator.
13220     * @deprecated Use @ref Transit instead.
13221     */
13222    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
13223    /**
13224     * Deletes the animator freeing any resources it used. If the animator was
13225     * created with a NULL parent this must be called, otherwise it will be
13226     * automatically called when the parent is deleted.
13227     *
13228     * @param[in] animator Animator object
13229     * @deprecated Use @ref Transit instead.
13230     */
13231    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13232    /**
13233     * Set the duration of the animation.
13234     *
13235     * @param[in] animator Animator object
13236     * @param[in] duration Duration in second
13237     * @deprecated Use @ref Transit instead.
13238     */
13239    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
13240    /**
13241     * @brief Set the callback function for animator operation.
13242     *
13243     * @param[in] animator Animator object
13244     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
13245     * @param[in] data Callback function user argument
13246     *
13247     * The @p func callback will be called with a frame value in range [0, 1] which
13248     * indicates how far along the animation should be. It is the job of @p func to
13249     * actually change the state of any object(or objects) that are being animated.
13250     * @deprecated Use @ref Transit instead.
13251     */
13252    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
13253    /**
13254     * Set the callback function for the when the animation ends.
13255     *
13256     * @param[in]  animator Animator object
13257     * @param[in]  func   Callback function pointe
13258     * @param[in]  data Callback function user argument
13259     *
13260     * @warning @a func will not be executed if elm_animator_stop() is called.
13261     * @deprecated Use @ref Transit instead.
13262     */
13263    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
13264    /**
13265     * @brief Stop animator.
13266     *
13267     * @param[in] animator Animator object
13268     *
13269     * If called before elm_animator_animate() it does nothing. If there is an
13270     * animation in progress the animation will be stopped(the operation callback
13271     * will not be executed again) and it can't be restarted using
13272     * elm_animator_resume().
13273     * @deprecated Use @ref Transit instead.
13274     */
13275    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13276    /**
13277     * Set the animator repeat count.
13278     *
13279     * @param[in]  animator Animator object
13280     * @param[in]  repeat_cnt Repeat count
13281     * @deprecated Use @ref Transit instead.
13282     */
13283    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
13284    /**
13285     * @brief Start animation.
13286     *
13287     * @param[in] animator Animator object
13288     *
13289     * This function starts the animation if the nescessary properties(duration
13290     * and operation callback) have been set. Once started the animation will
13291     * run until complete or elm_animator_stop() is called.
13292     * @deprecated Use @ref Transit instead.
13293     */
13294    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13295    /**
13296     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
13297     *
13298     * @param[in] animator Animator object
13299     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
13300     * @deprecated Use @ref Transit instead.
13301     */
13302    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
13303    /**
13304     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
13305     *
13306     * @param[in] animator Animator object
13307     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
13308     * @deprecated Use @ref Transit instead.
13309     */
13310    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
13311    /**
13312     * @brief Sets wether the animation should be automatically reversed.
13313     *
13314     * @param[in] animator Animator object
13315     * @param[in] reverse Reverse or not
13316     *
13317     * This controls wether the animation will be run on reverse imediately after
13318     * running forward. When this is set together with repetition the animation
13319     * will run in reverse once for each time it ran forward.@n
13320     * Runnin an animation in reverse is accomplished by calling the operation
13321     * callback with a frame value starting at 1 and diminshing until 0.
13322     * @deprecated Use @ref Transit instead.
13323     */
13324    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
13325    /**
13326     * Gets wether the animation will automatically reversed
13327     *
13328     * @param[in] animator Animator object
13329     * @deprecated Use @ref Transit instead.
13330     */
13331    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
13332    /**
13333     * Gets the status for the animator operation. The status of the animator @b
13334     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
13335     * only informs if the animation was started and has not ended(either normally
13336     * or through elm_animator_stop()).
13337     *
13338     * @param[in] animator Animator object
13339     * @deprecated Use @ref Transit instead.
13340     */
13341    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
13342    /**
13343     * Gets how many times the animation will be repeated
13344     *
13345     * @param[in] animator Animator object
13346     * @deprecated Use @ref Transit instead.
13347     */
13348    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
13349    /**
13350     * Pause the animator.
13351     *
13352     * @param[in]  animator Animator object
13353     *
13354     * This causes the animation to be temporarily stopped(the operation callback
13355     * will not be called). If the animation is not yet running this is a no-op.
13356     * Once an animation has been paused with this function it can be resumed
13357     * using elm_animator_resume().
13358     * @deprecated Use @ref Transit instead.
13359     */
13360    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13361    /**
13362     * @brief Resumes the animator.
13363     *
13364     * @param[in]  animator Animator object
13365     *
13366     * Resumes an animation that was paused using elm_animator_pause(), after
13367     * calling this function calls to the operation callback will happen
13368     * normally. If an animation is stopped by means of elm_animator_stop it
13369     * @b can't be restarted with this function.@n
13370     *
13371     * @warning When an animation is resumed it doesn't start from where it was paused, it
13372     * will go to where it would have been if it had not been paused. If an
13373     * animation with a duration of 3 seconds is paused after 1 second for 1 second
13374     * it will resume as if it had ben animating for 2 seconds, the operating
13375     * callback will be called with a frame value of aproximately 2/3.
13376     * @deprecated Use @ref Transit instead.
13377     */
13378    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13379    /**
13380     * @}
13381     */
13382
13383    /**
13384     * @defgroup Calendar Calendar
13385     * @ingroup Elementary
13386     *
13387     * @image html img/widget/calendar/preview-00.png
13388     * @image latex img/widget/calendar/preview-00.eps
13389     *
13390     * A calendar is a widget that displays a regular calendar, one
13391     * month at a time, to the user, and can allows the user to select a date.
13392     *
13393     * It has support to adding check marks (holidays and checks are supported
13394     * by default theme).
13395     *
13396     * Weekday names and the function used to format month and year to
13397     * be displayed can be set, giving more flexibility to this widget.
13398     *
13399     * Smart callbacks one can register to:
13400     * - "changed" - emitted when the user selects a day or changes the
13401     *   displayed month, what actually changes the selected day as well.
13402     *
13403     * Available styles for it:
13404     * - @c "default"
13405     *
13406     * List of examples:
13407     * @li @ref calendar_example_01
13408     * @li @ref calendar_example_02
13409     * @li @ref calendar_example_03
13410     * @li @ref calendar_example_04
13411     * @li @ref calendar_example_05
13412     * @li @ref calendar_example_06
13413     */
13414
13415    /**
13416     * @addtogroup Calendar
13417     * @{
13418     */
13419
13420    /**
13421     * @enum _Elm_Calendar_Mark_Repeat
13422     * @typedef Elm_Calendar_Mark_Repeat
13423     *
13424     * Event periodicity, used to define if a mark should be repeated
13425     * @b beyond event's day. It's set when a mark is added.
13426     *
13427     * So, for a mark added to 13th May with periodicity set to WEEKLY,
13428     * there will be marks every week after this date. Marks will be displayed
13429     * at 13th, 20th, 27th, 3rd June ...
13430     *
13431     * Values don't work as bitmaks, only one can be choosen.
13432     *
13433     * @see elm_calendar_mark_add()
13434     *
13435     * @ingroup Calendar
13436     */
13437    typedef enum _Elm_Calendar_Mark_Repeat
13438      {
13439         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
13440         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
13441         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
13442         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*/
13443         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. */
13444      } Elm_Calendar_Mark_Repeat;
13445
13446    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(). */
13447
13448    /**
13449     * Add a new calendar widget to the given parent Elementary
13450     * (container) object.
13451     *
13452     * @param parent The parent object.
13453     * @return a new calendar widget handle or @c NULL, on errors.
13454     *
13455     * This function inserts a new calendar widget on the canvas.
13456     *
13457     * @ref calendar_example_01
13458     *
13459     * @ingroup Calendar
13460     */
13461    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13462
13463    /**
13464     * Get weekdays names displayed by the calendar.
13465     *
13466     * @param obj The calendar object.
13467     * @return Array of seven strings to be used as weekday names.
13468     *
13469     * By default, weekdays abbreviations get from system are displayed:
13470     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
13471     * The first string is related to Sunday, the second to Monday...
13472     *
13473     * @see elm_calendar_weekdays_name_set()
13474     *
13475     * @ref calendar_example_05
13476     *
13477     * @ingroup Calendar
13478     */
13479    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13480
13481    /**
13482     * Set weekdays names to be displayed by the calendar.
13483     *
13484     * @param obj The calendar object.
13485     * @param weedays Array of seven strings to be used as weekday names.
13486     * @warning It must have 7 elements, or it will access invalid memory.
13487     * @warning The strings must be NULL terminated ('@\0').
13488     *
13489     * By default, weekdays abbreviations get from system are displayed:
13490     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
13491     *
13492     * The first string should be related to Sunday, the second to Monday...
13493     *
13494     * The usage should be like this:
13495     * @code
13496     *   const char *weekdays[] =
13497     *   {
13498     *      "Sunday", "Monday", "Tuesday", "Wednesday",
13499     *      "Thursday", "Friday", "Saturday"
13500     *   };
13501     *   elm_calendar_weekdays_names_set(calendar, weekdays);
13502     * @endcode
13503     *
13504     * @see elm_calendar_weekdays_name_get()
13505     *
13506     * @ref calendar_example_02
13507     *
13508     * @ingroup Calendar
13509     */
13510    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
13511
13512    /**
13513     * Set the minimum and maximum values for the year
13514     *
13515     * @param obj The calendar object
13516     * @param min The minimum year, greater than 1901;
13517     * @param max The maximum year;
13518     *
13519     * Maximum must be greater than minimum, except if you don't wan't to set
13520     * maximum year.
13521     * Default values are 1902 and -1.
13522     *
13523     * If the maximum year is a negative value, it will be limited depending
13524     * on the platform architecture (year 2037 for 32 bits);
13525     *
13526     * @see elm_calendar_min_max_year_get()
13527     *
13528     * @ref calendar_example_03
13529     *
13530     * @ingroup Calendar
13531     */
13532    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
13533
13534    /**
13535     * Get the minimum and maximum values for the year
13536     *
13537     * @param obj The calendar object.
13538     * @param min The minimum year.
13539     * @param max The maximum year.
13540     *
13541     * Default values are 1902 and -1.
13542     *
13543     * @see elm_calendar_min_max_year_get() for more details.
13544     *
13545     * @ref calendar_example_05
13546     *
13547     * @ingroup Calendar
13548     */
13549    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
13550
13551    /**
13552     * Enable or disable day selection
13553     *
13554     * @param obj The calendar object.
13555     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
13556     * disable it.
13557     *
13558     * Enabled by default. If disabled, the user still can select months,
13559     * but not days. Selected days are highlighted on calendar.
13560     * It should be used if you won't need such selection for the widget usage.
13561     *
13562     * When a day is selected, or month is changed, smart callbacks for
13563     * signal "changed" will be called.
13564     *
13565     * @see elm_calendar_day_selection_enable_get()
13566     *
13567     * @ref calendar_example_04
13568     *
13569     * @ingroup Calendar
13570     */
13571    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
13572
13573    /**
13574     * Get a value whether day selection is enabled or not.
13575     *
13576     * @see elm_calendar_day_selection_enable_set() for details.
13577     *
13578     * @param obj The calendar object.
13579     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
13580     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
13581     *
13582     * @ref calendar_example_05
13583     *
13584     * @ingroup Calendar
13585     */
13586    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13587
13588
13589    /**
13590     * Set selected date to be highlighted on calendar.
13591     *
13592     * @param obj The calendar object.
13593     * @param selected_time A @b tm struct to represent the selected date.
13594     *
13595     * Set the selected date, changing the displayed month if needed.
13596     * Selected date changes when the user goes to next/previous month or
13597     * select a day pressing over it on calendar.
13598     *
13599     * @see elm_calendar_selected_time_get()
13600     *
13601     * @ref calendar_example_04
13602     *
13603     * @ingroup Calendar
13604     */
13605    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
13606
13607    /**
13608     * Get selected date.
13609     *
13610     * @param obj The calendar object
13611     * @param selected_time A @b tm struct to point to selected date
13612     * @return EINA_FALSE means an error ocurred and returned time shouldn't
13613     * be considered.
13614     *
13615     * Get date selected by the user or set by function
13616     * elm_calendar_selected_time_set().
13617     * Selected date changes when the user goes to next/previous month or
13618     * select a day pressing over it on calendar.
13619     *
13620     * @see elm_calendar_selected_time_get()
13621     *
13622     * @ref calendar_example_05
13623     *
13624     * @ingroup Calendar
13625     */
13626    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
13627
13628    /**
13629     * Set a function to format the string that will be used to display
13630     * month and year;
13631     *
13632     * @param obj The calendar object
13633     * @param format_function Function to set the month-year string given
13634     * the selected date
13635     *
13636     * By default it uses strftime with "%B %Y" format string.
13637     * It should allocate the memory that will be used by the string,
13638     * that will be freed by the widget after usage.
13639     * A pointer to the string and a pointer to the time struct will be provided.
13640     *
13641     * Example:
13642     * @code
13643     * static char *
13644     * _format_month_year(struct tm *selected_time)
13645     * {
13646     *    char buf[32];
13647     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
13648     *    return strdup(buf);
13649     * }
13650     *
13651     * elm_calendar_format_function_set(calendar, _format_month_year);
13652     * @endcode
13653     *
13654     * @ref calendar_example_02
13655     *
13656     * @ingroup Calendar
13657     */
13658    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
13659
13660    /**
13661     * Add a new mark to the calendar
13662     *
13663     * @param obj The calendar object
13664     * @param mark_type A string used to define the type of mark. It will be
13665     * emitted to the theme, that should display a related modification on these
13666     * days representation.
13667     * @param mark_time A time struct to represent the date of inclusion of the
13668     * mark. For marks that repeats it will just be displayed after the inclusion
13669     * date in the calendar.
13670     * @param repeat Repeat the event following this periodicity. Can be a unique
13671     * mark (that don't repeat), daily, weekly, monthly or annually.
13672     * @return The created mark or @NULL upon failure.
13673     *
13674     * Add a mark that will be drawn in the calendar respecting the insertion
13675     * time and periodicity. It will emit the type as signal to the widget theme.
13676     * Default theme supports "holiday" and "checked", but it can be extended.
13677     *
13678     * It won't immediately update the calendar, drawing the marks.
13679     * For this, call elm_calendar_marks_draw(). However, when user selects
13680     * next or previous month calendar forces marks drawn.
13681     *
13682     * Marks created with this method can be deleted with
13683     * elm_calendar_mark_del().
13684     *
13685     * Example
13686     * @code
13687     * struct tm selected_time;
13688     * time_t current_time;
13689     *
13690     * current_time = time(NULL) + 5 * 84600;
13691     * localtime_r(&current_time, &selected_time);
13692     * elm_calendar_mark_add(cal, "holiday", selected_time,
13693     *     ELM_CALENDAR_ANNUALLY);
13694     *
13695     * current_time = time(NULL) + 1 * 84600;
13696     * localtime_r(&current_time, &selected_time);
13697     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
13698     *
13699     * elm_calendar_marks_draw(cal);
13700     * @endcode
13701     *
13702     * @see elm_calendar_marks_draw()
13703     * @see elm_calendar_mark_del()
13704     *
13705     * @ref calendar_example_06
13706     *
13707     * @ingroup Calendar
13708     */
13709    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);
13710
13711    /**
13712     * Delete mark from the calendar.
13713     *
13714     * @param mark The mark to be deleted.
13715     *
13716     * If deleting all calendar marks is required, elm_calendar_marks_clear()
13717     * should be used instead of getting marks list and deleting each one.
13718     *
13719     * @see elm_calendar_mark_add()
13720     *
13721     * @ref calendar_example_06
13722     *
13723     * @ingroup Calendar
13724     */
13725    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
13726
13727    /**
13728     * Remove all calendar's marks
13729     *
13730     * @param obj The calendar object.
13731     *
13732     * @see elm_calendar_mark_add()
13733     * @see elm_calendar_mark_del()
13734     *
13735     * @ingroup Calendar
13736     */
13737    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13738
13739
13740    /**
13741     * Get a list of all the calendar marks.
13742     *
13743     * @param obj The calendar object.
13744     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
13745     *
13746     * @see elm_calendar_mark_add()
13747     * @see elm_calendar_mark_del()
13748     * @see elm_calendar_marks_clear()
13749     *
13750     * @ingroup Calendar
13751     */
13752    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13753
13754    /**
13755     * Draw calendar marks.
13756     *
13757     * @param obj The calendar object.
13758     *
13759     * Should be used after adding, removing or clearing marks.
13760     * It will go through the entire marks list updating the calendar.
13761     * If lots of marks will be added, add all the marks and then call
13762     * this function.
13763     *
13764     * When the month is changed, i.e. user selects next or previous month,
13765     * marks will be drawed.
13766     *
13767     * @see elm_calendar_mark_add()
13768     * @see elm_calendar_mark_del()
13769     * @see elm_calendar_marks_clear()
13770     *
13771     * @ref calendar_example_06
13772     *
13773     * @ingroup Calendar
13774     */
13775    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
13776
13777    /**
13778     * Set a day text color to the same that represents Saturdays.
13779     *
13780     * @param obj The calendar object.
13781     * @param pos The text position. Position is the cell counter, from left
13782     * to right, up to down. It starts on 0 and ends on 41.
13783     *
13784     * @deprecated use elm_calendar_mark_add() instead like:
13785     *
13786     * @code
13787     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
13788     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
13789     * @endcode
13790     *
13791     * @see elm_calendar_mark_add()
13792     *
13793     * @ingroup Calendar
13794     */
13795    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
13796
13797    /**
13798     * Set a day text color to the same that represents Sundays.
13799     *
13800     * @param obj The calendar object.
13801     * @param pos The text position. Position is the cell counter, from left
13802     * to right, up to down. It starts on 0 and ends on 41.
13803
13804     * @deprecated use elm_calendar_mark_add() instead like:
13805     *
13806     * @code
13807     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
13808     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
13809     * @endcode
13810     *
13811     * @see elm_calendar_mark_add()
13812     *
13813     * @ingroup Calendar
13814     */
13815    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
13816
13817    /**
13818     * Set a day text color to the same that represents Weekdays.
13819     *
13820     * @param obj The calendar object
13821     * @param pos The text position. Position is the cell counter, from left
13822     * to right, up to down. It starts on 0 and ends on 41.
13823     *
13824     * @deprecated use elm_calendar_mark_add() instead like:
13825     *
13826     * @code
13827     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
13828     *
13829     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
13830     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
13831     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
13832     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
13833     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
13834     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
13835     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
13836     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
13837     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
13838     * @endcode
13839     *
13840     * @see elm_calendar_mark_add()
13841     *
13842     * @ingroup Calendar
13843     */
13844    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
13845
13846    /**
13847     * Set the interval on time updates for an user mouse button hold
13848     * on calendar widgets' month selection.
13849     *
13850     * @param obj The calendar object
13851     * @param interval The (first) interval value in seconds
13852     *
13853     * This interval value is @b decreased while the user holds the
13854     * mouse pointer either selecting next or previous month.
13855     *
13856     * This helps the user to get to a given month distant from the
13857     * current one easier/faster, as it will start to change quicker and
13858     * quicker on mouse button holds.
13859     *
13860     * The calculation for the next change interval value, starting from
13861     * the one set with this call, is the previous interval divided by
13862     * 1.05, so it decreases a little bit.
13863     *
13864     * The default starting interval value for automatic changes is
13865     * @b 0.85 seconds.
13866     *
13867     * @see elm_calendar_interval_get()
13868     *
13869     * @ingroup Calendar
13870     */
13871    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
13872
13873    /**
13874     * Get the interval on time updates for an user mouse button hold
13875     * on calendar widgets' month selection.
13876     *
13877     * @param obj The calendar object
13878     * @return The (first) interval value, in seconds, set on it
13879     *
13880     * @see elm_calendar_interval_set() for more details
13881     *
13882     * @ingroup Calendar
13883     */
13884    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13885
13886    /**
13887     * @}
13888     */
13889
13890    /**
13891     * @defgroup Diskselector Diskselector
13892     * @ingroup Elementary
13893     *
13894     * @image html img/widget/diskselector/preview-00.png
13895     * @image latex img/widget/diskselector/preview-00.eps
13896     *
13897     * A diskselector is a kind of list widget. It scrolls horizontally,
13898     * and can contain label and icon objects. Three items are displayed
13899     * with the selected one in the middle.
13900     *
13901     * It can act like a circular list with round mode and labels can be
13902     * reduced for a defined length for side items.
13903     *
13904     * Smart callbacks one can listen to:
13905     * - "selected" - when item is selected, i.e. scroller stops.
13906     *
13907     * Available styles for it:
13908     * - @c "default"
13909     *
13910     * List of examples:
13911     * @li @ref diskselector_example_01
13912     * @li @ref diskselector_example_02
13913     */
13914
13915    /**
13916     * @addtogroup Diskselector
13917     * @{
13918     */
13919
13920    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(). */
13921
13922    /**
13923     * Add a new diskselector widget to the given parent Elementary
13924     * (container) object.
13925     *
13926     * @param parent The parent object.
13927     * @return a new diskselector widget handle or @c NULL, on errors.
13928     *
13929     * This function inserts a new diskselector widget on the canvas.
13930     *
13931     * @ingroup Diskselector
13932     */
13933    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13934
13935    /**
13936     * Enable or disable round mode.
13937     *
13938     * @param obj The diskselector object.
13939     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
13940     * disable it.
13941     *
13942     * Disabled by default. If round mode is enabled the items list will
13943     * work like a circle list, so when the user reaches the last item,
13944     * the first one will popup.
13945     *
13946     * @see elm_diskselector_round_get()
13947     *
13948     * @ingroup Diskselector
13949     */
13950    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
13951
13952    /**
13953     * Get a value whether round mode is enabled or not.
13954     *
13955     * @see elm_diskselector_round_set() for details.
13956     *
13957     * @param obj The diskselector object.
13958     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
13959     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
13960     *
13961     * @ingroup Diskselector
13962     */
13963    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13964
13965    /**
13966     * Get the side labels max length.
13967     *
13968     * @deprecated use elm_diskselector_side_label_length_get() instead:
13969     *
13970     * @param obj The diskselector object.
13971     * @return The max length defined for side labels, or 0 if not a valid
13972     * diskselector.
13973     *
13974     * @ingroup Diskselector
13975     */
13976    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13977
13978    /**
13979     * Set the side labels max length.
13980     *
13981     * @deprecated use elm_diskselector_side_label_length_set() instead:
13982     *
13983     * @param obj The diskselector object.
13984     * @param len The max length defined for side labels.
13985     *
13986     * @ingroup Diskselector
13987     */
13988    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
13989
13990    /**
13991     * Get the side labels max length.
13992     *
13993     * @see elm_diskselector_side_label_length_set() for details.
13994     *
13995     * @param obj The diskselector object.
13996     * @return The max length defined for side labels, or 0 if not a valid
13997     * diskselector.
13998     *
13999     * @ingroup Diskselector
14000     */
14001    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14002
14003    /**
14004     * Set the side labels max length.
14005     *
14006     * @param obj The diskselector object.
14007     * @param len The max length defined for side labels.
14008     *
14009     * Length is the number of characters of items' label that will be
14010     * visible when it's set on side positions. It will just crop
14011     * the string after defined size. E.g.:
14012     *
14013     * An item with label "January" would be displayed on side position as
14014     * "Jan" if max length is set to 3, or "Janu", if this property
14015     * is set to 4.
14016     *
14017     * When it's selected, the entire label will be displayed, except for
14018     * width restrictions. In this case label will be cropped and "..."
14019     * will be concatenated.
14020     *
14021     * Default side label max length is 3.
14022     *
14023     * This property will be applyed over all items, included before or
14024     * later this function call.
14025     *
14026     * @ingroup Diskselector
14027     */
14028    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
14029
14030    /**
14031     * Set the number of items to be displayed.
14032     *
14033     * @param obj The diskselector object.
14034     * @param num The number of items the diskselector will display.
14035     *
14036     * Default value is 3, and also it's the minimun. If @p num is less
14037     * than 3, it will be set to 3.
14038     *
14039     * Also, it can be set on theme, using data item @c display_item_num
14040     * on group "elm/diskselector/item/X", where X is style set.
14041     * E.g.:
14042     *
14043     * group { name: "elm/diskselector/item/X";
14044     * data {
14045     *     item: "display_item_num" "5";
14046     *     }
14047     *
14048     * @ingroup Diskselector
14049     */
14050    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
14051
14052    /**
14053     * Set bouncing behaviour when the scrolled content reaches an edge.
14054     *
14055     * Tell the internal scroller object whether it should bounce or not
14056     * when it reaches the respective edges for each axis.
14057     *
14058     * @param obj The diskselector object.
14059     * @param h_bounce Whether to bounce or not in the horizontal axis.
14060     * @param v_bounce Whether to bounce or not in the vertical axis.
14061     *
14062     * @see elm_scroller_bounce_set()
14063     *
14064     * @ingroup Diskselector
14065     */
14066    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14067
14068    /**
14069     * Get the bouncing behaviour of the internal scroller.
14070     *
14071     * Get whether the internal scroller should bounce when the edge of each
14072     * axis is reached scrolling.
14073     *
14074     * @param obj The diskselector object.
14075     * @param h_bounce Pointer where to store the bounce state of the horizontal
14076     * axis.
14077     * @param v_bounce Pointer where to store the bounce state of the vertical
14078     * axis.
14079     *
14080     * @see elm_scroller_bounce_get()
14081     * @see elm_diskselector_bounce_set()
14082     *
14083     * @ingroup Diskselector
14084     */
14085    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14086
14087    /**
14088     * Get the scrollbar policy.
14089     *
14090     * @see elm_diskselector_scroller_policy_get() for details.
14091     *
14092     * @param obj The diskselector object.
14093     * @param policy_h Pointer where to store horizontal scrollbar policy.
14094     * @param policy_v Pointer where to store vertical scrollbar policy.
14095     *
14096     * @ingroup Diskselector
14097     */
14098    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);
14099
14100    /**
14101     * Set the scrollbar policy.
14102     *
14103     * @param obj The diskselector object.
14104     * @param policy_h Horizontal scrollbar policy.
14105     * @param policy_v Vertical scrollbar policy.
14106     *
14107     * This sets the scrollbar visibility policy for the given scroller.
14108     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14109     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14110     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14111     * This applies respectively for the horizontal and vertical scrollbars.
14112     *
14113     * The both are disabled by default, i.e., are set to
14114     * #ELM_SCROLLER_POLICY_OFF.
14115     *
14116     * @ingroup Diskselector
14117     */
14118    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14119
14120    /**
14121     * Remove all diskselector's items.
14122     *
14123     * @param obj The diskselector object.
14124     *
14125     * @see elm_diskselector_item_del()
14126     * @see elm_diskselector_item_append()
14127     *
14128     * @ingroup Diskselector
14129     */
14130    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14131
14132    /**
14133     * Get a list of all the diskselector items.
14134     *
14135     * @param obj The diskselector object.
14136     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
14137     * or @c NULL on failure.
14138     *
14139     * @see elm_diskselector_item_append()
14140     * @see elm_diskselector_item_del()
14141     * @see elm_diskselector_clear()
14142     *
14143     * @ingroup Diskselector
14144     */
14145    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14146
14147    /**
14148     * Appends a new item to the diskselector object.
14149     *
14150     * @param obj The diskselector object.
14151     * @param label The label of the diskselector item.
14152     * @param icon The icon object to use at left side of the item. An
14153     * icon can be any Evas object, but usually it is an icon created
14154     * with elm_icon_add().
14155     * @param func The function to call when the item is selected.
14156     * @param data The data to associate with the item for related callbacks.
14157     *
14158     * @return The created item or @c NULL upon failure.
14159     *
14160     * A new item will be created and appended to the diskselector, i.e., will
14161     * be set as last item. Also, if there is no selected item, it will
14162     * be selected. This will always happens for the first appended item.
14163     *
14164     * If no icon is set, label will be centered on item position, otherwise
14165     * the icon will be placed at left of the label, that will be shifted
14166     * to the right.
14167     *
14168     * Items created with this method can be deleted with
14169     * elm_diskselector_item_del().
14170     *
14171     * Associated @p data can be properly freed when item is deleted if a
14172     * callback function is set with elm_diskselector_item_del_cb_set().
14173     *
14174     * If a function is passed as argument, it will be called everytime this item
14175     * is selected, i.e., the user stops the diskselector with this
14176     * item on center position. If such function isn't needed, just passing
14177     * @c NULL as @p func is enough. The same should be done for @p data.
14178     *
14179     * Simple example (with no function callback or data associated):
14180     * @code
14181     * disk = elm_diskselector_add(win);
14182     * ic = elm_icon_add(win);
14183     * elm_icon_file_set(ic, "path/to/image", NULL);
14184     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14185     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
14186     * @endcode
14187     *
14188     * @see elm_diskselector_item_del()
14189     * @see elm_diskselector_item_del_cb_set()
14190     * @see elm_diskselector_clear()
14191     * @see elm_icon_add()
14192     *
14193     * @ingroup Diskselector
14194     */
14195    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);
14196
14197
14198    /**
14199     * Delete them item from the diskselector.
14200     *
14201     * @param it The item of diskselector to be deleted.
14202     *
14203     * If deleting all diskselector items is required, elm_diskselector_clear()
14204     * should be used instead of getting items list and deleting each one.
14205     *
14206     * @see elm_diskselector_clear()
14207     * @see elm_diskselector_item_append()
14208     * @see elm_diskselector_item_del_cb_set()
14209     *
14210     * @ingroup Diskselector
14211     */
14212    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14213
14214    /**
14215     * Set the function called when a diskselector item is freed.
14216     *
14217     * @param it The item to set the callback on
14218     * @param func The function called
14219     *
14220     * If there is a @p func, then it will be called prior item's memory release.
14221     * That will be called with the following arguments:
14222     * @li item's data;
14223     * @li item's Evas object;
14224     * @li item itself;
14225     *
14226     * This way, a data associated to a diskselector item could be properly
14227     * freed.
14228     *
14229     * @ingroup Diskselector
14230     */
14231    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14232
14233    /**
14234     * Get the data associated to the item.
14235     *
14236     * @param it The diskselector item
14237     * @return The data associated to @p it
14238     *
14239     * The return value is a pointer to data associated to @item when it was
14240     * created, with function elm_diskselector_item_append(). If no data
14241     * was passed as argument, it will return @c NULL.
14242     *
14243     * @see elm_diskselector_item_append()
14244     *
14245     * @ingroup Diskselector
14246     */
14247    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14248
14249    /**
14250     * Set the icon associated to the item.
14251     *
14252     * @param it The diskselector item
14253     * @param icon The icon object to associate with @p it
14254     *
14255     * The icon object to use at left side of the item. An
14256     * icon can be any Evas object, but usually it is an icon created
14257     * with elm_icon_add().
14258     *
14259     * Once the icon object is set, a previously set one will be deleted.
14260     * @warning Setting the same icon for two items will cause the icon to
14261     * dissapear from the first item.
14262     *
14263     * If an icon was passed as argument on item creation, with function
14264     * elm_diskselector_item_append(), it will be already
14265     * associated to the item.
14266     *
14267     * @see elm_diskselector_item_append()
14268     * @see elm_diskselector_item_icon_get()
14269     *
14270     * @ingroup Diskselector
14271     */
14272    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
14273
14274    /**
14275     * Get the icon associated to the item.
14276     *
14277     * @param it The diskselector item
14278     * @return The icon associated to @p it
14279     *
14280     * The return value is a pointer to the icon associated to @item when it was
14281     * created, with function elm_diskselector_item_append(), or later
14282     * with function elm_diskselector_item_icon_set. If no icon
14283     * was passed as argument, it will return @c NULL.
14284     *
14285     * @see elm_diskselector_item_append()
14286     * @see elm_diskselector_item_icon_set()
14287     *
14288     * @ingroup Diskselector
14289     */
14290    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14291
14292    /**
14293     * Set the label of item.
14294     *
14295     * @param it The item of diskselector.
14296     * @param label The label of item.
14297     *
14298     * The label to be displayed by the item.
14299     *
14300     * If no icon is set, label will be centered on item position, otherwise
14301     * the icon will be placed at left of the label, that will be shifted
14302     * to the right.
14303     *
14304     * An item with label "January" would be displayed on side position as
14305     * "Jan" if max length is set to 3 with function
14306     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
14307     * is set to 4.
14308     *
14309     * When this @item is selected, the entire label will be displayed,
14310     * except for width restrictions.
14311     * In this case label will be cropped and "..." will be concatenated,
14312     * but only for display purposes. It will keep the entire string, so
14313     * if diskselector is resized the remaining characters will be displayed.
14314     *
14315     * If a label was passed as argument on item creation, with function
14316     * elm_diskselector_item_append(), it will be already
14317     * displayed by the item.
14318     *
14319     * @see elm_diskselector_side_label_lenght_set()
14320     * @see elm_diskselector_item_label_get()
14321     * @see elm_diskselector_item_append()
14322     *
14323     * @ingroup Diskselector
14324     */
14325    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
14326
14327    /**
14328     * Get the label of item.
14329     *
14330     * @param it The item of diskselector.
14331     * @return The label of item.
14332     *
14333     * The return value is a pointer to the label associated to @item when it was
14334     * created, with function elm_diskselector_item_append(), or later
14335     * with function elm_diskselector_item_label_set. If no label
14336     * was passed as argument, it will return @c NULL.
14337     *
14338     * @see elm_diskselector_item_label_set() for more details.
14339     * @see elm_diskselector_item_append()
14340     *
14341     * @ingroup Diskselector
14342     */
14343    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14344
14345    /**
14346     * Get the selected item.
14347     *
14348     * @param obj The diskselector object.
14349     * @return The selected diskselector item.
14350     *
14351     * The selected item can be unselected with function
14352     * elm_diskselector_item_selected_set(), and the first item of
14353     * diskselector will be selected.
14354     *
14355     * The selected item always will be centered on diskselector, with
14356     * full label displayed, i.e., max lenght set to side labels won't
14357     * apply on the selected item. More details on
14358     * elm_diskselector_side_label_length_set().
14359     *
14360     * @ingroup Diskselector
14361     */
14362    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14363
14364    /**
14365     * Set the selected state of an item.
14366     *
14367     * @param it The diskselector item
14368     * @param selected The selected state
14369     *
14370     * This sets the selected state of the given item @p it.
14371     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14372     *
14373     * If a new item is selected the previosly selected will be unselected.
14374     * Previoulsy selected item can be get with function
14375     * elm_diskselector_selected_item_get().
14376     *
14377     * If the item @p it is unselected, the first item of diskselector will
14378     * be selected.
14379     *
14380     * Selected items will be visible on center position of diskselector.
14381     * So if it was on another position before selected, or was invisible,
14382     * diskselector will animate items until the selected item reaches center
14383     * position.
14384     *
14385     * @see elm_diskselector_item_selected_get()
14386     * @see elm_diskselector_selected_item_get()
14387     *
14388     * @ingroup Diskselector
14389     */
14390    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14391
14392    /*
14393     * Get whether the @p item is selected or not.
14394     *
14395     * @param it The diskselector item.
14396     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14397     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14398     *
14399     * @see elm_diskselector_selected_item_set() for details.
14400     * @see elm_diskselector_item_selected_get()
14401     *
14402     * @ingroup Diskselector
14403     */
14404    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14405
14406    /**
14407     * Get the first item of the diskselector.
14408     *
14409     * @param obj The diskselector object.
14410     * @return The first item, or @c NULL if none.
14411     *
14412     * The list of items follows append order. So it will return the first
14413     * item appended to the widget that wasn't deleted.
14414     *
14415     * @see elm_diskselector_item_append()
14416     * @see elm_diskselector_items_get()
14417     *
14418     * @ingroup Diskselector
14419     */
14420    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14421
14422    /**
14423     * Get the last item of the diskselector.
14424     *
14425     * @param obj The diskselector object.
14426     * @return The last item, or @c NULL if none.
14427     *
14428     * The list of items follows append order. So it will return last first
14429     * item appended to the widget that wasn't deleted.
14430     *
14431     * @see elm_diskselector_item_append()
14432     * @see elm_diskselector_items_get()
14433     *
14434     * @ingroup Diskselector
14435     */
14436    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14437
14438    /**
14439     * Get the item before @p item in diskselector.
14440     *
14441     * @param it The diskselector item.
14442     * @return The item before @p item, or @c NULL if none or on failure.
14443     *
14444     * The list of items follows append order. So it will return item appended
14445     * just before @item and that wasn't deleted.
14446     *
14447     * If it is the first item, @c NULL will be returned.
14448     * First item can be get by elm_diskselector_first_item_get().
14449     *
14450     * @see elm_diskselector_item_append()
14451     * @see elm_diskselector_items_get()
14452     *
14453     * @ingroup Diskselector
14454     */
14455    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14456
14457    /**
14458     * Get the item after @p item in diskselector.
14459     *
14460     * @param it The diskselector item.
14461     * @return The item after @p item, or @c NULL if none or on failure.
14462     *
14463     * The list of items follows append order. So it will return item appended
14464     * just after @item and that wasn't deleted.
14465     *
14466     * If it is the last item, @c NULL will be returned.
14467     * Last item can be get by elm_diskselector_last_item_get().
14468     *
14469     * @see elm_diskselector_item_append()
14470     * @see elm_diskselector_items_get()
14471     *
14472     * @ingroup Diskselector
14473     */
14474    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14475
14476    /**
14477     * Set the text to be shown in the diskselector item.
14478     *
14479     * @param item Target item
14480     * @param text The text to set in the content
14481     *
14482     * Setup the text as tooltip to object. The item can have only one tooltip,
14483     * so any previous tooltip data is removed.
14484     *
14485     * @see elm_object_tooltip_text_set() for more details.
14486     *
14487     * @ingroup Diskselector
14488     */
14489    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
14490
14491    /**
14492     * Set the content to be shown in the tooltip item.
14493     *
14494     * Setup the tooltip to item. The item can have only one tooltip,
14495     * so any previous tooltip data is removed. @p func(with @p data) will
14496     * be called every time that need show the tooltip and it should
14497     * return a valid Evas_Object. This object is then managed fully by
14498     * tooltip system and is deleted when the tooltip is gone.
14499     *
14500     * @param item the diskselector item being attached a tooltip.
14501     * @param func the function used to create the tooltip contents.
14502     * @param data what to provide to @a func as callback data/context.
14503     * @param del_cb called when data is not needed anymore, either when
14504     *        another callback replaces @func, the tooltip is unset with
14505     *        elm_diskselector_item_tooltip_unset() or the owner @a item
14506     *        dies. This callback receives as the first parameter the
14507     *        given @a data, and @c event_info is the item.
14508     *
14509     * @see elm_object_tooltip_content_cb_set() for more details.
14510     *
14511     * @ingroup Diskselector
14512     */
14513    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);
14514
14515    /**
14516     * Unset tooltip from item.
14517     *
14518     * @param item diskselector item to remove previously set tooltip.
14519     *
14520     * Remove tooltip from item. The callback provided as del_cb to
14521     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
14522     * it is not used anymore.
14523     *
14524     * @see elm_object_tooltip_unset() for more details.
14525     * @see elm_diskselector_item_tooltip_content_cb_set()
14526     *
14527     * @ingroup Diskselector
14528     */
14529    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14530
14531
14532    /**
14533     * Sets a different style for this item tooltip.
14534     *
14535     * @note before you set a style you should define a tooltip with
14536     *       elm_diskselector_item_tooltip_content_cb_set() or
14537     *       elm_diskselector_item_tooltip_text_set()
14538     *
14539     * @param item diskselector item with tooltip already set.
14540     * @param style the theme style to use (default, transparent, ...)
14541     *
14542     * @see elm_object_tooltip_style_set() for more details.
14543     *
14544     * @ingroup Diskselector
14545     */
14546    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
14547
14548    /**
14549     * Get the style for this item tooltip.
14550     *
14551     * @param item diskselector item with tooltip already set.
14552     * @return style the theme style in use, defaults to "default". If the
14553     *         object does not have a tooltip set, then NULL is returned.
14554     *
14555     * @see elm_object_tooltip_style_get() for more details.
14556     * @see elm_diskselector_item_tooltip_style_set()
14557     *
14558     * @ingroup Diskselector
14559     */
14560    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14561
14562    /**
14563     * Set the cursor to be shown when mouse is over the diskselector item
14564     *
14565     * @param item Target item
14566     * @param cursor the cursor name to be used.
14567     *
14568     * @see elm_object_cursor_set() for more details.
14569     *
14570     * @ingroup Diskselector
14571     */
14572    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14573
14574    /**
14575     * Get the cursor to be shown when mouse is over the diskselector item
14576     *
14577     * @param item diskselector item with cursor already set.
14578     * @return the cursor name.
14579     *
14580     * @see elm_object_cursor_get() for more details.
14581     * @see elm_diskselector_cursor_set()
14582     *
14583     * @ingroup Diskselector
14584     */
14585    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14586
14587
14588    /**
14589     * Unset the cursor to be shown when mouse is over the diskselector item
14590     *
14591     * @param item Target item
14592     *
14593     * @see elm_object_cursor_unset() for more details.
14594     * @see elm_diskselector_cursor_set()
14595     *
14596     * @ingroup Diskselector
14597     */
14598    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14599
14600    /**
14601     * Sets a different style for this item cursor.
14602     *
14603     * @note before you set a style you should define a cursor with
14604     *       elm_diskselector_item_cursor_set()
14605     *
14606     * @param item diskselector item with cursor already set.
14607     * @param style the theme style to use (default, transparent, ...)
14608     *
14609     * @see elm_object_cursor_style_set() for more details.
14610     *
14611     * @ingroup Diskselector
14612     */
14613    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
14614
14615
14616    /**
14617     * Get the style for this item cursor.
14618     *
14619     * @param item diskselector item with cursor already set.
14620     * @return style the theme style in use, defaults to "default". If the
14621     *         object does not have a cursor set, then @c NULL is returned.
14622     *
14623     * @see elm_object_cursor_style_get() for more details.
14624     * @see elm_diskselector_item_cursor_style_set()
14625     *
14626     * @ingroup Diskselector
14627     */
14628    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14629
14630
14631    /**
14632     * Set if the cursor set should be searched on the theme or should use
14633     * the provided by the engine, only.
14634     *
14635     * @note before you set if should look on theme you should define a cursor
14636     * with elm_diskselector_item_cursor_set().
14637     * By default it will only look for cursors provided by the engine.
14638     *
14639     * @param item widget item with cursor already set.
14640     * @param engine_only boolean to define if cursors set with
14641     * elm_diskselector_item_cursor_set() should be searched only
14642     * between cursors provided by the engine or searched on widget's
14643     * theme as well.
14644     *
14645     * @see elm_object_cursor_engine_only_set() for more details.
14646     *
14647     * @ingroup Diskselector
14648     */
14649    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14650
14651    /**
14652     * Get the cursor engine only usage for this item cursor.
14653     *
14654     * @param item widget item with cursor already set.
14655     * @return engine_only boolean to define it cursors should be looked only
14656     * between the provided by the engine or searched on widget's theme as well.
14657     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
14658     *
14659     * @see elm_object_cursor_engine_only_get() for more details.
14660     * @see elm_diskselector_item_cursor_engine_only_set()
14661     *
14662     * @ingroup Diskselector
14663     */
14664    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14665
14666    /**
14667     * @}
14668     */
14669
14670    /**
14671     * @page tutorial_colorselector Color selector example
14672     * @dontinclude colorselector_example_01.c
14673     *
14674     * This example shows how to change the color of a rectangle using a color
14675     * selector. We aren't going to explain a lot of the code since it's the
14676     * usual setup code:
14677     * @until show(rect)
14678     *
14679     * Now that we have a window with background and a rectangle we can create
14680     * our color_selector and set it's initial color to fully opaque blue:
14681     * @until show
14682     *
14683     * Next we tell ask to be notified whenever the color changes:
14684     * @until changed
14685     *
14686     * We follow that we some more run of the mill setup code:
14687     * @until ELM_MAIN()
14688     *
14689     * And now get to the callback that sets the color of the rectangle:
14690     * @until }
14691     *
14692     * This example will look like this:
14693     *
14694     * @image html screenshots/colorselector_example_01.png
14695     * @image latex screenshots/colorselector_example_01.eps width=\textwidth
14696     *
14697     * @example colorselector_example_01.c
14698     */
14699    /**
14700     * @defgroup Colorselector Colorselector
14701     *
14702     * @{
14703     *
14704     * @image html img/widget/colorselector/preview-00.png
14705     *
14706     * @brief Widget for user to select a color.
14707     *
14708     * Signals that you can add callbacks for are:
14709     * "changed" - When the color value changes(event_info is NULL).
14710     *
14711     * See @ref tutorial_colorselector.
14712     */
14713    /**
14714     * @brief Add a new colorselector to the parent
14715     *
14716     * @param parent The parent object
14717     * @return The new object or NULL if it cannot be created
14718     *
14719     * @ingroup Colorselector
14720     */
14721    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14722    /**
14723     * Set a color for the colorselector
14724     *
14725     * @param obj   Colorselector object
14726     * @param r     r-value of color
14727     * @param g     g-value of color
14728     * @param b     b-value of color
14729     * @param a     a-value of color
14730     *
14731     * @ingroup Colorselector
14732     */
14733    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
14734    /**
14735     * Get a color from the colorselector
14736     *
14737     * @param obj   Colorselector object
14738     * @param r     integer pointer for r-value of color
14739     * @param g     integer pointer for g-value of color
14740     * @param b     integer pointer for b-value of color
14741     * @param a     integer pointer for a-value of color
14742     *
14743     * @ingroup Colorselector
14744     */
14745    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
14746    /**
14747     * @}
14748     */
14749
14750    /**
14751     * @defgroup Ctxpopup
14752     *
14753     * @image html img/widget/ctxpopup/preview-00.png
14754     * @image latex img/widget/ctxpopup/preview-00.eps
14755     *
14756     * @brief Context popup widet.
14757     *
14758     * A ctxpopup is a widget that, when shown, pops up a list of items.
14759     * It automatically chooses an area inside its parent object's view
14760     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
14761     * optimally fit into it. In the default theme, it will also point an
14762     * arrow to it's top left position at the time one shows it. Ctxpopup
14763     * items have a label and/or an icon. It is intended for a small
14764     * number of items (hence the use of list, not genlist).
14765     *
14766     * @note Ctxpopup is a especialization of @ref Hover.
14767     *
14768     * Signals that you can add callbacks for are:
14769     * "dismissed" - the ctxpopup was dismissed
14770     *
14771     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
14772     * @{
14773     */
14774    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
14775
14776    typedef enum _Elm_Ctxpopup_Direction
14777      {
14778         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
14779                                           area */
14780         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
14781                                            the clicked area */
14782         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
14783                                           the clicked area */
14784         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
14785                                         area */
14786      } Elm_Ctxpopup_Direction;
14787
14788    /**
14789     * @brief Add a new Ctxpopup object to the parent.
14790     *
14791     * @param parent Parent object
14792     * @return New object or @c NULL, if it cannot be created
14793     */
14794    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14795    /**
14796     * @brief Set the Ctxpopup's parent
14797     *
14798     * @param obj The ctxpopup object
14799     * @param area The parent to use
14800     *
14801     * Set the parent object.
14802     *
14803     * @note elm_ctxpopup_add() will automatically call this function
14804     * with its @c parent argument.
14805     *
14806     * @see elm_ctxpopup_add()
14807     * @see elm_hover_parent_set()
14808     */
14809    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
14810    /**
14811     * @brief Get the Ctxpopup's parent
14812     *
14813     * @param obj The ctxpopup object
14814     *
14815     * @see elm_ctxpopup_hover_parent_set() for more information
14816     */
14817    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14818    /**
14819     * @brief Clear all items in the given ctxpopup object.
14820     *
14821     * @param obj Ctxpopup object
14822     */
14823    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14824    /**
14825     * @brief Change the ctxpopup's orientation to horizontal or vertical.
14826     *
14827     * @param obj Ctxpopup object
14828     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
14829     */
14830    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14831    /**
14832     * @brief Get the value of current ctxpopup object's orientation.
14833     *
14834     * @param obj Ctxpopup object
14835     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
14836     *
14837     * @see elm_ctxpopup_horizontal_set()
14838     */
14839    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14840    /**
14841     * @brief Add a new item to a ctxpopup object.
14842     *
14843     * @param obj Ctxpopup object
14844     * @param icon Icon to be set on new item
14845     * @param label The Label of the new item
14846     * @param func Convenience function called when item selected
14847     * @param data Data passed to @p func
14848     * @return A handle to the item added or @c NULL, on errors
14849     *
14850     * @warning Ctxpopup can't hold both an item list and a content at the same
14851     * time. When an item is added, any previous content will be removed.
14852     *
14853     * @see elm_ctxpopup_content_set()
14854     */
14855    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);
14856    /**
14857     * @brief Delete the given item in a ctxpopup object.
14858     *
14859     * @param item Ctxpopup item to be deleted
14860     *
14861     * @see elm_ctxpopup_item_append()
14862     */
14863    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14864    /**
14865     * @brief Set the ctxpopup item's state as disabled or enabled.
14866     *
14867     * @param item Ctxpopup item to be enabled/disabled
14868     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
14869     *
14870     * When disabled the item is greyed out to indicate it's state.
14871     */
14872    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14873    /**
14874     * @brief Get the ctxpopup item's disabled/enabled state.
14875     *
14876     * @param item Ctxpopup item to be enabled/disabled
14877     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
14878     *
14879     * @see elm_ctxpopup_item_disabled_set()
14880     */
14881    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14882    /**
14883     * @brief Get the icon object for the given ctxpopup item.
14884     *
14885     * @param item Ctxpopup item
14886     * @return icon object or @c NULL, if the item does not have icon or an error
14887     * occurred
14888     *
14889     * @see elm_ctxpopup_item_append()
14890     * @see elm_ctxpopup_item_icon_set()
14891     */
14892    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14893    /**
14894     * @brief Sets the side icon associated with the ctxpopup item
14895     *
14896     * @param item Ctxpopup item
14897     * @param icon Icon object to be set
14898     *
14899     * Once the icon object is set, a previously set one will be deleted.
14900     * @warning Setting the same icon for two items will cause the icon to
14901     * dissapear from the first item.
14902     *
14903     * @see elm_ctxpopup_item_append()
14904     */
14905    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
14906    /**
14907     * @brief Get the label for the given ctxpopup item.
14908     *
14909     * @param item Ctxpopup item
14910     * @return label string or @c NULL, if the item does not have label or an
14911     * error occured
14912     *
14913     * @see elm_ctxpopup_item_append()
14914     * @see elm_ctxpopup_item_label_set()
14915     */
14916    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14917    /**
14918     * @brief (Re)set the label on the given ctxpopup item.
14919     *
14920     * @param item Ctxpopup item
14921     * @param label String to set as label
14922     */
14923    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
14924    /**
14925     * @brief Set an elm widget as the content of the ctxpopup.
14926     *
14927     * @param obj Ctxpopup object
14928     * @param content Content to be swallowed
14929     *
14930     * If the content object is already set, a previous one will bedeleted. If
14931     * you want to keep that old content object, use the
14932     * elm_ctxpopup_content_unset() function.
14933     *
14934     * @warning Ctxpopup can't hold both a item list and a content at the same
14935     * time. When a content is set, any previous items will be removed.
14936     */
14937    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
14938    /**
14939     * @brief Unset the ctxpopup content
14940     *
14941     * @param obj Ctxpopup object
14942     * @return The content that was being used
14943     *
14944     * Unparent and return the content object which was set for this widget.
14945     *
14946     * @see elm_ctxpopup_content_set()
14947     */
14948    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14949    /**
14950     * @brief Set the direction priority of a ctxpopup.
14951     *
14952     * @param obj Ctxpopup object
14953     * @param first 1st priority of direction
14954     * @param second 2nd priority of direction
14955     * @param third 3th priority of direction
14956     * @param fourth 4th priority of direction
14957     *
14958     * This functions gives a chance to user to set the priority of ctxpopup
14959     * showing direction. This doesn't guarantee the ctxpopup will appear in the
14960     * requested direction.
14961     *
14962     * @see Elm_Ctxpopup_Direction
14963     */
14964    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);
14965    /**
14966     * @brief Get the direction priority of a ctxpopup.
14967     *
14968     * @param obj Ctxpopup object
14969     * @param first 1st priority of direction to be returned
14970     * @param second 2nd priority of direction to be returned
14971     * @param third 3th priority of direction to be returned
14972     * @param fourth 4th priority of direction to be returned
14973     *
14974     * @see elm_ctxpopup_direction_priority_set() for more information.
14975     */
14976    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);
14977    /**
14978     * @}
14979     */
14980
14981    /* transit */
14982    /**
14983     *
14984     * @defgroup Transit Transit
14985     * @ingroup Elementary
14986     *
14987     * Transit is designed to apply various animated transition effects to @c
14988     * Evas_Object, such like translation, rotation, etc. For using these
14989     * effects, create an @ref Elm_Transit and add the desired transition effects.
14990     *
14991     * Once the effects are added into transit, they will be automatically
14992     * managed (their callback will be called until the duration is ended, and
14993     * they will be deleted on completion).
14994     *
14995     * Example:
14996     * @code
14997     * Elm_Transit *trans = elm_transit_add();
14998     * elm_transit_object_add(trans, obj);
14999     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
15000     * elm_transit_duration_set(transit, 1);
15001     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
15002     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
15003     * elm_transit_repeat_times_set(transit, 3);
15004     * @endcode
15005     *
15006     * Some transition effects are used to change the properties of objects. They
15007     * are:
15008     * @li @ref elm_transit_effect_translation_add
15009     * @li @ref elm_transit_effect_color_add
15010     * @li @ref elm_transit_effect_rotation_add
15011     * @li @ref elm_transit_effect_wipe_add
15012     * @li @ref elm_transit_effect_zoom_add
15013     * @li @ref elm_transit_effect_resizing_add
15014     *
15015     * Other transition effects are used to make one object disappear and another
15016     * object appear on its old place. These effects are:
15017     *
15018     * @li @ref elm_transit_effect_flip_add
15019     * @li @ref elm_transit_effect_resizable_flip_add
15020     * @li @ref elm_transit_effect_fade_add
15021     * @li @ref elm_transit_effect_blend_add
15022     *
15023     * It's also possible to make a transition chain with @ref
15024     * elm_transit_chain_transit_add.
15025     *
15026     * @warning We strongly recommend to use elm_transit just when edje can not do
15027     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
15028     * animations can be manipulated inside the theme.
15029     *
15030     * List of examples:
15031     * @li @ref transit_example_01_explained
15032     * @li @ref transit_example_02_explained
15033     * @li @ref transit_example_03_c
15034     * @li @ref transit_example_04_c
15035     *
15036     * @{
15037     */
15038
15039    /**
15040     * @enum Elm_Transit_Tween_Mode
15041     *
15042     * The type of acceleration used in the transition.
15043     */
15044    typedef enum
15045      {
15046         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
15047         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
15048                                              over time, then decrease again
15049                                              and stop slowly */
15050         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
15051                                              speed over time */
15052         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
15053                                             over time */
15054      } Elm_Transit_Tween_Mode;
15055
15056    /**
15057     * @enum Elm_Transit_Effect_Flip_Axis
15058     *
15059     * The axis where flip effect should be applied.
15060     */
15061    typedef enum
15062      {
15063         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
15064         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
15065      } Elm_Transit_Effect_Flip_Axis;
15066    /**
15067     * @enum Elm_Transit_Effect_Wipe_Dir
15068     *
15069     * The direction where the wipe effect should occur.
15070     */
15071    typedef enum
15072      {
15073         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
15074         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
15075         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
15076         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
15077      } Elm_Transit_Effect_Wipe_Dir;
15078    /** @enum Elm_Transit_Effect_Wipe_Type
15079     *
15080     * Whether the wipe effect should show or hide the object.
15081     */
15082    typedef enum
15083      {
15084         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
15085                                              animation */
15086         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
15087                                             animation */
15088      } Elm_Transit_Effect_Wipe_Type;
15089
15090    /**
15091     * @typedef Elm_Transit
15092     *
15093     * The Transit created with elm_transit_add(). This type has the information
15094     * about the objects which the transition will be applied, and the
15095     * transition effects that will be used. It also contains info about
15096     * duration, number of repetitions, auto-reverse, etc.
15097     */
15098    typedef struct _Elm_Transit Elm_Transit;
15099    typedef void Elm_Transit_Effect;
15100    /**
15101     * @typedef Elm_Transit_Effect_Transition_Cb
15102     *
15103     * Transition callback called for this effect on each transition iteration.
15104     */
15105    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
15106    /**
15107     * Elm_Transit_Effect_End_Cb
15108     *
15109     * Transition callback called for this effect when the transition is over.
15110     */
15111    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
15112
15113    /**
15114     * Elm_Transit_Del_Cb
15115     *
15116     * A callback called when the transit is deleted.
15117     */
15118    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
15119
15120    /**
15121     * Add new transit.
15122     *
15123     * @note Is not necessary to delete the transit object, it will be deleted at
15124     * the end of its operation.
15125     * @note The transit will start playing when the program enter in the main loop, is not
15126     * necessary to give a start to the transit.
15127     *
15128     * @return The transit object.
15129     *
15130     * @ingroup Transit
15131     */
15132    EAPI Elm_Transit                *elm_transit_add(void);
15133
15134    /**
15135     * Stops the animation and delete the @p transit object.
15136     *
15137     * Call this function if you wants to stop the animation before the duration
15138     * time. Make sure the @p transit object is still alive with
15139     * elm_transit_del_cb_set() function.
15140     * All added effects will be deleted, calling its repective data_free_cb
15141     * functions. The function setted by elm_transit_del_cb_set() will be called.
15142     *
15143     * @see elm_transit_del_cb_set()
15144     *
15145     * @param transit The transit object to be deleted.
15146     *
15147     * @ingroup Transit
15148     * @warning Just call this function if you are sure the transit is alive.
15149     */
15150    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
15151
15152    /**
15153     * Add a new effect to the transit.
15154     *
15155     * @note The cb function and the data are the key to the effect. If you try to
15156     * add an already added effect, nothing is done.
15157     * @note After the first addition of an effect in @p transit, if its
15158     * effect list become empty again, the @p transit will be killed by
15159     * elm_transit_del(transit) function.
15160     *
15161     * Exemple:
15162     * @code
15163     * Elm_Transit *transit = elm_transit_add();
15164     * elm_transit_effect_add(transit,
15165     *                        elm_transit_effect_blend_op,
15166     *                        elm_transit_effect_blend_context_new(),
15167     *                        elm_transit_effect_blend_context_free);
15168     * @endcode
15169     *
15170     * @param transit The transit object.
15171     * @param transition_cb The operation function. It is called when the
15172     * animation begins, it is the function that actually performs the animation.
15173     * It is called with the @p data, @p transit and the time progression of the
15174     * animation (a double value between 0.0 and 1.0).
15175     * @param effect The context data of the effect.
15176     * @param end_cb The function to free the context data, it will be called
15177     * at the end of the effect, it must finalize the animation and free the
15178     * @p data.
15179     *
15180     * @ingroup Transit
15181     * @warning The transit free the context data at the and of the transition with
15182     * the data_free_cb function, do not use the context data in another transit.
15183     */
15184    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);
15185
15186    /**
15187     * Delete an added effect.
15188     *
15189     * This function will remove the effect from the @p transit, calling the
15190     * data_free_cb to free the @p data.
15191     *
15192     * @see elm_transit_effect_add()
15193     *
15194     * @note If the effect is not found, nothing is done.
15195     * @note If the effect list become empty, this function will call
15196     * elm_transit_del(transit), that is, it will kill the @p transit.
15197     *
15198     * @param transit The transit object.
15199     * @param transition_cb The operation function.
15200     * @param effect The context data of the effect.
15201     *
15202     * @ingroup Transit
15203     */
15204    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);
15205
15206    /**
15207     * Add new object to apply the effects.
15208     *
15209     * @note After the first addition of an object in @p transit, if its
15210     * object list become empty again, the @p transit will be killed by
15211     * elm_transit_del(transit) function.
15212     * @note If the @p obj belongs to another transit, the @p obj will be
15213     * removed from it and it will only belong to the @p transit. If the old
15214     * transit stays without objects, it will die.
15215     * @note When you add an object into the @p transit, its state from
15216     * evas_object_pass_events_get(obj) is saved, and it is applied when the
15217     * transit ends, if you change this state whith evas_object_pass_events_set()
15218     * after add the object, this state will change again when @p transit stops to
15219     * run.
15220     *
15221     * @param transit The transit object.
15222     * @param obj Object to be animated.
15223     *
15224     * @ingroup Transit
15225     * @warning It is not allowed to add a new object after transit begins to go.
15226     */
15227    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
15228
15229    /**
15230     * Removes an added object from the transit.
15231     *
15232     * @note If the @p obj is not in the @p transit, nothing is done.
15233     * @note If the list become empty, this function will call
15234     * elm_transit_del(transit), that is, it will kill the @p transit.
15235     *
15236     * @param transit The transit object.
15237     * @param obj Object to be removed from @p transit.
15238     *
15239     * @ingroup Transit
15240     * @warning It is not allowed to remove objects after transit begins to go.
15241     */
15242    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
15243
15244    /**
15245     * Get the objects of the transit.
15246     *
15247     * @param transit The transit object.
15248     * @return a Eina_List with the objects from the transit.
15249     *
15250     * @ingroup Transit
15251     */
15252    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15253
15254    /**
15255     * Enable/disable keeping up the objects states.
15256     * If it is not kept, the objects states will be reset when transition ends.
15257     *
15258     * @note @p transit can not be NULL.
15259     * @note One state includes geometry, color, map data.
15260     *
15261     * @param transit The transit object.
15262     * @param state_keep Keeping or Non Keeping.
15263     *
15264     * @ingroup Transit
15265     */
15266    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
15267
15268    /**
15269     * Get a value whether the objects states will be reset or not.
15270     *
15271     * @note @p transit can not be NULL
15272     *
15273     * @see elm_transit_objects_final_state_keep_set()
15274     *
15275     * @param transit The transit object.
15276     * @return EINA_TRUE means the states of the objects will be reset.
15277     * If @p transit is NULL, EINA_FALSE is returned
15278     *
15279     * @ingroup Transit
15280     */
15281    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15282
15283    /**
15284     * Set the event enabled when transit is operating.
15285     *
15286     * If @p enabled is EINA_TRUE, the objects of the transit will receives
15287     * events from mouse and keyboard during the animation.
15288     * @note When you add an object with elm_transit_object_add(), its state from
15289     * evas_object_pass_events_get(obj) is saved, and it is applied when the
15290     * transit ends, if you change this state with evas_object_pass_events_set()
15291     * after adding the object, this state will change again when @p transit stops
15292     * to run.
15293     *
15294     * @param transit The transit object.
15295     * @param enabled Events are received when enabled is @c EINA_TRUE, and
15296     * ignored otherwise.
15297     *
15298     * @ingroup Transit
15299     */
15300    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
15301
15302    /**
15303     * Get the value of event enabled status.
15304     *
15305     * @see elm_transit_event_enabled_set()
15306     *
15307     * @param transit The Transit object
15308     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
15309     * EINA_FALSE is returned
15310     *
15311     * @ingroup Transit
15312     */
15313    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15314
15315    /**
15316     * Set the user-callback function when the transit is deleted.
15317     *
15318     * @note Using this function twice will overwrite the first function setted.
15319     * @note the @p transit object will be deleted after call @p cb function.
15320     *
15321     * @param transit The transit object.
15322     * @param cb Callback function pointer. This function will be called before
15323     * the deletion of the transit.
15324     * @param data Callback funtion user data. It is the @p op parameter.
15325     *
15326     * @ingroup Transit
15327     */
15328    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
15329
15330    /**
15331     * Set reverse effect automatically.
15332     *
15333     * If auto reverse is setted, after running the effects with the progress
15334     * parameter from 0 to 1, it will call the effecs again with the progress
15335     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
15336     * where the duration was setted with the function elm_transit_add and
15337     * the repeat with the function elm_transit_repeat_times_set().
15338     *
15339     * @param transit The transit object.
15340     * @param reverse EINA_TRUE means the auto_reverse is on.
15341     *
15342     * @ingroup Transit
15343     */
15344    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
15345
15346    /**
15347     * Get if the auto reverse is on.
15348     *
15349     * @see elm_transit_auto_reverse_set()
15350     *
15351     * @param transit The transit object.
15352     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
15353     * EINA_FALSE is returned
15354     *
15355     * @ingroup Transit
15356     */
15357    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15358
15359    /**
15360     * Set the transit repeat count. Effect will be repeated by repeat count.
15361     *
15362     * This function sets the number of repetition the transit will run after
15363     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
15364     * If the @p repeat is a negative number, it will repeat infinite times.
15365     *
15366     * @note If this function is called during the transit execution, the transit
15367     * will run @p repeat times, ignoring the times it already performed.
15368     *
15369     * @param transit The transit object
15370     * @param repeat Repeat count
15371     *
15372     * @ingroup Transit
15373     */
15374    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
15375
15376    /**
15377     * Get the transit repeat count.
15378     *
15379     * @see elm_transit_repeat_times_set()
15380     *
15381     * @param transit The Transit object.
15382     * @return The repeat count. If @p transit is NULL
15383     * 0 is returned
15384     *
15385     * @ingroup Transit
15386     */
15387    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15388
15389    /**
15390     * Set the transit animation acceleration type.
15391     *
15392     * This function sets the tween mode of the transit that can be:
15393     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
15394     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
15395     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
15396     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
15397     *
15398     * @param transit The transit object.
15399     * @param tween_mode The tween type.
15400     *
15401     * @ingroup Transit
15402     */
15403    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
15404
15405    /**
15406     * Get the transit animation acceleration type.
15407     *
15408     * @note @p transit can not be NULL
15409     *
15410     * @param transit The transit object.
15411     * @return The tween type. If @p transit is NULL
15412     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
15413     *
15414     * @ingroup Transit
15415     */
15416    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15417
15418    /**
15419     * Set the transit animation time
15420     *
15421     * @note @p transit can not be NULL
15422     *
15423     * @param transit The transit object.
15424     * @param duration The animation time.
15425     *
15426     * @ingroup Transit
15427     */
15428    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
15429
15430    /**
15431     * Get the transit animation time
15432     *
15433     * @note @p transit can not be NULL
15434     *
15435     * @param transit The transit object.
15436     *
15437     * @return The transit animation time.
15438     *
15439     * @ingroup Transit
15440     */
15441    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15442
15443    /**
15444     * Starts the transition.
15445     * Once this API is called, the transit begins to measure the time.
15446     *
15447     * @note @p transit can not be NULL
15448     *
15449     * @param transit The transit object.
15450     *
15451     * @ingroup Transit
15452     */
15453    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
15454
15455    /**
15456     * Pause/Resume the transition.
15457     *
15458     * If you call elm_transit_go again, the transit will be started from the
15459     * beginning, and will be unpaused.
15460     *
15461     * @note @p transit can not be NULL
15462     *
15463     * @param transit The transit object.
15464     * @param paused Whether the transition should be paused or not.
15465     *
15466     * @ingroup Transit
15467     */
15468    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
15469
15470    /**
15471     * Get the value of paused status.
15472     *
15473     * @see elm_transit_paused_set()
15474     *
15475     * @note @p transit can not be NULL
15476     *
15477     * @param transit The transit object.
15478     * @return EINA_TRUE means transition is paused. If @p transit is NULL
15479     * EINA_FALSE is returned
15480     *
15481     * @ingroup Transit
15482     */
15483    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15484
15485    /**
15486     * Get the time progression of the animation (a double value between 0.0 and 1.0).
15487     *
15488     * The value returned is a fraction (current time / total time). It
15489     * represents the progression position relative to the total.
15490     *
15491     * @note @p transit can not be NULL
15492     *
15493     * @param transit The transit object.
15494     *
15495     * @return The time progression value. If @p transit is NULL
15496     * 0 is returned
15497     *
15498     * @ingroup Transit
15499     */
15500    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15501
15502    /**
15503     * Makes the chain relationship between two transits.
15504     *
15505     * @note @p transit can not be NULL. Transit would have multiple chain transits.
15506     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
15507     *
15508     * @param transit The transit object.
15509     * @param chain_transit The chain transit object. This transit will be operated
15510     *        after transit is done.
15511     *
15512     * This function adds @p chain_transit transition to a chain after the @p
15513     * transit, and will be started as soon as @p transit ends. See @ref
15514     * transit_example_02_explained for a full example.
15515     *
15516     * @ingroup Transit
15517     */
15518    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
15519
15520    /**
15521     * Cut off the chain relationship between two transits.
15522     *
15523     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
15524     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
15525     *
15526     * @param transit The transit object.
15527     * @param chain_transit The chain transit object.
15528     *
15529     * This function remove the @p chain_transit transition from the @p transit.
15530     *
15531     * @ingroup Transit
15532     */
15533    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
15534
15535    /**
15536     * Get the current chain transit list.
15537     *
15538     * @note @p transit can not be NULL.
15539     *
15540     * @param transit The transit object.
15541     * @return chain transit list.
15542     *
15543     * @ingroup Transit
15544     */
15545    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
15546
15547    /**
15548     * Add the Resizing Effect to Elm_Transit.
15549     *
15550     * @note This API is one of the facades. It creates resizing effect context
15551     * and add it's required APIs to elm_transit_effect_add.
15552     *
15553     * @see elm_transit_effect_add()
15554     *
15555     * @param transit Transit object.
15556     * @param from_w Object width size when effect begins.
15557     * @param from_h Object height size when effect begins.
15558     * @param to_w Object width size when effect ends.
15559     * @param to_h Object height size when effect ends.
15560     * @return Resizing effect context data.
15561     *
15562     * @ingroup Transit
15563     */
15564    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);
15565
15566    /**
15567     * Add the Translation Effect to Elm_Transit.
15568     *
15569     * @note This API is one of the facades. It creates translation effect context
15570     * and add it's required APIs to elm_transit_effect_add.
15571     *
15572     * @see elm_transit_effect_add()
15573     *
15574     * @param transit Transit object.
15575     * @param from_dx X Position variation when effect begins.
15576     * @param from_dy Y Position variation when effect begins.
15577     * @param to_dx X Position variation when effect ends.
15578     * @param to_dy Y Position variation when effect ends.
15579     * @return Translation effect context data.
15580     *
15581     * @ingroup Transit
15582     * @warning It is highly recommended just create a transit with this effect when
15583     * the window that the objects of the transit belongs has already been created.
15584     * This is because this effect needs the geometry information about the objects,
15585     * and if the window was not created yet, it can get a wrong information.
15586     */
15587    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);
15588
15589    /**
15590     * Add the Zoom Effect to Elm_Transit.
15591     *
15592     * @note This API is one of the facades. It creates zoom effect context
15593     * and add it's required APIs to elm_transit_effect_add.
15594     *
15595     * @see elm_transit_effect_add()
15596     *
15597     * @param transit Transit object.
15598     * @param from_rate Scale rate when effect begins (1 is current rate).
15599     * @param to_rate Scale rate when effect ends.
15600     * @return Zoom effect context data.
15601     *
15602     * @ingroup Transit
15603     * @warning It is highly recommended just create a transit with this effect when
15604     * the window that the objects of the transit belongs has already been created.
15605     * This is because this effect needs the geometry information about the objects,
15606     * and if the window was not created yet, it can get a wrong information.
15607     */
15608    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
15609
15610    /**
15611     * Add the Flip Effect to Elm_Transit.
15612     *
15613     * @note This API is one of the facades. It creates flip effect context
15614     * and add it's required APIs to elm_transit_effect_add.
15615     * @note This effect is applied to each pair of objects in the order they are listed
15616     * in the transit list of objects. The first object in the pair will be the
15617     * "front" object and the second will be the "back" object.
15618     *
15619     * @see elm_transit_effect_add()
15620     *
15621     * @param transit Transit object.
15622     * @param axis Flipping Axis(X or Y).
15623     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
15624     * @return Flip effect context data.
15625     *
15626     * @ingroup Transit
15627     * @warning It is highly recommended just create a transit with this effect when
15628     * the window that the objects of the transit belongs has already been created.
15629     * This is because this effect needs the geometry information about the objects,
15630     * and if the window was not created yet, it can get a wrong information.
15631     */
15632    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
15633
15634    /**
15635     * Add the Resizable Flip Effect to Elm_Transit.
15636     *
15637     * @note This API is one of the facades. It creates resizable flip effect context
15638     * and add it's required APIs to elm_transit_effect_add.
15639     * @note This effect is applied to each pair of objects in the order they are listed
15640     * in the transit list of objects. The first object in the pair will be the
15641     * "front" object and the second will be the "back" object.
15642     *
15643     * @see elm_transit_effect_add()
15644     *
15645     * @param transit Transit object.
15646     * @param axis Flipping Axis(X or Y).
15647     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
15648     * @return Resizable flip effect context data.
15649     *
15650     * @ingroup Transit
15651     * @warning It is highly recommended just create a transit with this effect when
15652     * the window that the objects of the transit belongs has already been created.
15653     * This is because this effect needs the geometry information about the objects,
15654     * and if the window was not created yet, it can get a wrong information.
15655     */
15656    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
15657
15658    /**
15659     * Add the Wipe Effect to Elm_Transit.
15660     *
15661     * @note This API is one of the facades. It creates wipe effect context
15662     * and add it's required APIs to elm_transit_effect_add.
15663     *
15664     * @see elm_transit_effect_add()
15665     *
15666     * @param transit Transit object.
15667     * @param type Wipe type. Hide or show.
15668     * @param dir Wipe Direction.
15669     * @return Wipe effect context data.
15670     *
15671     * @ingroup Transit
15672     * @warning It is highly recommended just create a transit with this effect when
15673     * the window that the objects of the transit belongs has already been created.
15674     * This is because this effect needs the geometry information about the objects,
15675     * and if the window was not created yet, it can get a wrong information.
15676     */
15677    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
15678
15679    /**
15680     * Add the Color Effect to Elm_Transit.
15681     *
15682     * @note This API is one of the facades. It creates color effect context
15683     * and add it's required APIs to elm_transit_effect_add.
15684     *
15685     * @see elm_transit_effect_add()
15686     *
15687     * @param transit        Transit object.
15688     * @param  from_r        RGB R when effect begins.
15689     * @param  from_g        RGB G when effect begins.
15690     * @param  from_b        RGB B when effect begins.
15691     * @param  from_a        RGB A when effect begins.
15692     * @param  to_r          RGB R when effect ends.
15693     * @param  to_g          RGB G when effect ends.
15694     * @param  to_b          RGB B when effect ends.
15695     * @param  to_a          RGB A when effect ends.
15696     * @return               Color effect context data.
15697     *
15698     * @ingroup Transit
15699     */
15700    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);
15701
15702    /**
15703     * Add the Fade Effect to Elm_Transit.
15704     *
15705     * @note This API is one of the facades. It creates fade effect context
15706     * and add it's required APIs to elm_transit_effect_add.
15707     * @note This effect is applied to each pair of objects in the order they are listed
15708     * in the transit list of objects. The first object in the pair will be the
15709     * "before" object and the second will be the "after" object.
15710     *
15711     * @see elm_transit_effect_add()
15712     *
15713     * @param transit Transit object.
15714     * @return Fade effect context data.
15715     *
15716     * @ingroup Transit
15717     * @warning It is highly recommended just create a transit with this effect when
15718     * the window that the objects of the transit belongs has already been created.
15719     * This is because this effect needs the color information about the objects,
15720     * and if the window was not created yet, it can get a wrong information.
15721     */
15722    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
15723
15724    /**
15725     * Add the Blend Effect to Elm_Transit.
15726     *
15727     * @note This API is one of the facades. It creates blend effect context
15728     * and add it's required APIs to elm_transit_effect_add.
15729     * @note This effect is applied to each pair of objects in the order they are listed
15730     * in the transit list of objects. The first object in the pair will be the
15731     * "before" object and the second will be the "after" object.
15732     *
15733     * @see elm_transit_effect_add()
15734     *
15735     * @param transit Transit object.
15736     * @return Blend effect context data.
15737     *
15738     * @ingroup Transit
15739     * @warning It is highly recommended just create a transit with this effect when
15740     * the window that the objects of the transit belongs has already been created.
15741     * This is because this effect needs the color information about the objects,
15742     * and if the window was not created yet, it can get a wrong information.
15743     */
15744    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
15745
15746    /**
15747     * Add the Rotation Effect to Elm_Transit.
15748     *
15749     * @note This API is one of the facades. It creates rotation effect context
15750     * and add it's required APIs to elm_transit_effect_add.
15751     *
15752     * @see elm_transit_effect_add()
15753     *
15754     * @param transit Transit object.
15755     * @param from_degree Degree when effect begins.
15756     * @param to_degree Degree when effect is ends.
15757     * @return Rotation effect context data.
15758     *
15759     * @ingroup Transit
15760     * @warning It is highly recommended just create a transit with this effect when
15761     * the window that the objects of the transit belongs has already been created.
15762     * This is because this effect needs the geometry information about the objects,
15763     * and if the window was not created yet, it can get a wrong information.
15764     */
15765    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
15766
15767    /**
15768     * Add the ImageAnimation Effect to Elm_Transit.
15769     *
15770     * @note This API is one of the facades. It creates image animation effect context
15771     * and add it's required APIs to elm_transit_effect_add.
15772     * The @p images parameter is a list images paths. This list and
15773     * its contents will be deleted at the end of the effect by
15774     * elm_transit_effect_image_animation_context_free() function.
15775     *
15776     * Example:
15777     * @code
15778     * char buf[PATH_MAX];
15779     * Eina_List *images = NULL;
15780     * Elm_Transit *transi = elm_transit_add();
15781     *
15782     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
15783     * images = eina_list_append(images, eina_stringshare_add(buf));
15784     *
15785     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
15786     * images = eina_list_append(images, eina_stringshare_add(buf));
15787     * elm_transit_effect_image_animation_add(transi, images);
15788     *
15789     * @endcode
15790     *
15791     * @see elm_transit_effect_add()
15792     *
15793     * @param transit Transit object.
15794     * @param images Eina_List of images file paths. This list and
15795     * its contents will be deleted at the end of the effect by
15796     * elm_transit_effect_image_animation_context_free() function.
15797     * @return Image Animation effect context data.
15798     *
15799     * @ingroup Transit
15800     */
15801    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
15802    /**
15803     * @}
15804     */
15805
15806   typedef struct _Elm_Store                      Elm_Store;
15807   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
15808   typedef struct _Elm_Store_Item                 Elm_Store_Item;
15809   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
15810   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
15811   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
15812   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
15813   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
15814   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
15815   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
15816   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
15817
15818   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
15819   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
15820   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
15821   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
15822
15823   typedef enum
15824     {
15825        ELM_STORE_ITEM_MAPPING_NONE = 0,
15826        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
15827        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
15828        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
15829        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
15830        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
15831        // can add more here as needed by common apps
15832        ELM_STORE_ITEM_MAPPING_LAST
15833     } Elm_Store_Item_Mapping_Type;
15834
15835   struct _Elm_Store_Item_Mapping_Icon
15836     {
15837        // FIXME: allow edje file icons
15838        int                   w, h;
15839        Elm_Icon_Lookup_Order lookup_order;
15840        Eina_Bool             standard_name : 1;
15841        Eina_Bool             no_scale : 1;
15842        Eina_Bool             smooth : 1;
15843        Eina_Bool             scale_up : 1;
15844        Eina_Bool             scale_down : 1;
15845     };
15846
15847   struct _Elm_Store_Item_Mapping_Empty
15848     {
15849        Eina_Bool             dummy;
15850     };
15851
15852   struct _Elm_Store_Item_Mapping_Photo
15853     {
15854        int                   size;
15855     };
15856
15857   struct _Elm_Store_Item_Mapping_Custom
15858     {
15859        Elm_Store_Item_Mapping_Cb func;
15860     };
15861
15862   struct _Elm_Store_Item_Mapping
15863     {
15864        Elm_Store_Item_Mapping_Type     type;
15865        const char                     *part;
15866        int                             offset;
15867        union
15868          {
15869             Elm_Store_Item_Mapping_Empty  empty;
15870             Elm_Store_Item_Mapping_Icon   icon;
15871             Elm_Store_Item_Mapping_Photo  photo;
15872             Elm_Store_Item_Mapping_Custom custom;
15873             // add more types here
15874          } details;
15875     };
15876
15877   struct _Elm_Store_Item_Info
15878     {
15879       Elm_Genlist_Item_Class       *item_class;
15880       const Elm_Store_Item_Mapping *mapping;
15881       void                         *data;
15882       char                         *sort_id;
15883     };
15884
15885   struct _Elm_Store_Item_Info_Filesystem
15886     {
15887       Elm_Store_Item_Info  base;
15888       char                *path;
15889     };
15890
15891 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
15892 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
15893
15894   EAPI void                    elm_store_free(Elm_Store *st);
15895
15896   EAPI Elm_Store              *elm_store_filesystem_new(void);
15897   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
15898   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15899   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15900
15901   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
15902
15903   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
15904   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15905   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15906   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15907   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
15908   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15909
15910   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15911   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
15912   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15913   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
15914   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15915   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15916   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15917
15918    /* SegmentControl */
15919    typedef struct _Elm_Segment_Item Elm_Segment_Item;
15920    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15921    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
15922    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);
15923    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
15924    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15925    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15926    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15927    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15928    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
15929    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15930    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
15931    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
15932    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
15933    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15934    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
15935    /* smart callbacks called:
15936     * "changed" -when the user clicks on a segment item which is not previously
15937     *            selected and get selected. The event_info parameter is the
15938     *            segment item index.
15939     */
15940
15941    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
15942    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
15943    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
15944    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
15945    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
15946    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
15947    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
15948    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
15949
15950    EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
15951    EAPI void         elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
15952
15953    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
15954    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
15955    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
15956    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
15957    EAPI void elm_video_play(Evas_Object *video);
15958    EAPI void elm_video_pause(Evas_Object *video);
15959    EAPI void elm_video_stop(Evas_Object *video);
15960    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
15961    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
15962    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
15963    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
15964    EAPI double elm_video_audio_level_get(Evas_Object *video);
15965    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
15966    EAPI double elm_video_play_position_get(Evas_Object *video);
15967    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
15968    EAPI double elm_video_play_length_get(Evas_Object *video);
15969    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
15970    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
15971    EAPI const char *elm_video_title_get(Evas_Object *video);
15972
15973    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
15974    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
15975
15976   /* naviframe */
15977    typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
15978
15979    typedef enum
15980      {
15981         ELM_NAVIFRAME_PREV_BUTTON,
15982         ELM_NAVIFRAME_NEXT_BUTTON
15983      } Elm_Naviframe_Button_Type;
15984
15985    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15986    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);
15987    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
15988    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
15989    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15990    EAPI void                elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
15991    EAPI Evas_Object        *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
15992    EAPI void                elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
15993    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
15994    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
15995    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
15996    EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15997    EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15998    EAPI void                elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
15999    EAPI Evas_Object        *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
16000    EAPI void                elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
16001    EAPI Evas_Object        *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
16002    EAPI void                elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
16003    EAPI const char         *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
16004    EAPI void                elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
16005    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
16006
16007 #ifdef __cplusplus
16008 }
16009 #endif
16010
16011 #endif